Table of Contents

Class BackupExecBackupDefinition

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a Backup Exec backup definition.

public class BackupExecBackupDefinition : GlobalSerializableClassicBase, IComparable<BackupExecBackupDefinition>
Inheritance
BackupExecBackupDefinition
Implements

Constructors

BackupExecBackupDefinition()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.BackupExecBackupDefinition class.

public BackupExecBackupDefinition()

Properties

ActiveDirectory

Gets or sets the Active Directory settings to use for the backup.

public BackupExecActiveDirectorySettings ActiveDirectory { get; set; }

Property Value

BackupExecActiveDirectorySettings

AdditionalBackups

Gets or sets the additional backups performed following the initial full backup.

public BackupExecBackupTaskCollection AdditionalBackups { get; set; }

Property Value

BackupExecBackupTaskCollection

AdvancedOpenFile

Gets or sets the advanced open file settings.

public BackupExecAdvancedOpenFileSettings AdvancedOpenFile { get; set; }

Property Value

BackupExecAdvancedOpenFileSettings

AllowAnyNetworkForAgentAccess

Gets or sets whether to allow any network for agent access.

public BooleanOption AllowAnyNetworkForAgentAccess { get; set; }

Property Value

BooleanOption

Description

Gets or sets the description of the backup definition.

public string Description { get; set; }

Property Value

string

DuplicationTasks

Gets or sets the duplication tasks performed by this definition.

public BackupExecDuplicationTaskCollection DuplicationTasks { get; set; }

Property Value

BackupExecDuplicationTaskCollection

EnableTestRun

Gets or sets whether to enable a test run for the backup definition.

public BooleanOption EnableTestRun { get; set; }

Property Value

BooleanOption

Exchange

Gets or sets the Microsoft Exchange backup settings.

public BackupExecMicrosoftExchangeSettings Exchange { get; set; }

Property Value

BackupExecMicrosoftExchangeSettings

FileSettings

Gets or sets the file and folder settings to use for the backup.

public BackupExecFileSettings FileSettings { get; set; }

Property Value

BackupExecFileSettings

Id

Gets or sets the unique identifier of the backup definition in GUID format.

public string Id { get; set; }

Property Value

string

InitialFullBackup

Gets or sets the initial full backup task performed by this definition.

public BackupExecBackupTask InitialFullBackup { get; set; }

Property Value

BackupExecBackupTask

Linux

Gets or sets the Linux and Macintosh settings to use for this backup definition.

public BackupExecLinuxSettings Linux { get; set; }

Property Value

BackupExecLinuxSettings

Name

Gets or sets the name of the backup definition.

public string Name { get; set; }

Property Value

string

NetworkInterface

Gets or sets the network interface to use for this backup definition. When String.Empty any network interface can be used.

public string NetworkInterface { get; set; }

Property Value

string

NetworkProtocol

Gets or sets the network protocol to use.

public BackupExecBackupDefinitionNetworkProtocol NetworkProtocol { get; set; }

Property Value

BackupExecBackupDefinitionNetworkProtocol

NetworkProtocolString

Gets the network protocol to use.

public string NetworkProtocolString { get; set; }

Property Value

string

NetworkSubnet

Gets or sets the network subnet to use for this backup definition. This setting only applies when a network interface has been specified. When String.Empty any network subnet can be used.

public string NetworkSubnet { get; set; }

Property Value

string

OffHost

Gets or sets the offhost backup settings.

public BackupExecOffHostBackupSettings OffHost { get; set; }

Property Value

BackupExecOffHostBackupSettings

Oracle

Gets or sets the settings to use for Oracle backup.

public BackupExecOracleSettings Oracle { get; set; }

Property Value

BackupExecOracleSettings

Priority

Gets or sets the priority of this backup definition.

public BackupExecBackupDefinitionPriority Priority { get; set; }

Property Value

BackupExecBackupDefinitionPriority

PriorityString

Gets the priority of this backup definition as a human readable string.

public string PriorityString { get; set; }

Property Value

string

SelectionLists

Gets or sets the selection lists assigned to this definition.

public BackupExecSelectionListCollection SelectionLists { get; set; }

Property Value

BackupExecSelectionListCollection

SharePoint

Gets or sets the Microsoft SharePoint settings to use for the backup definition.

public BackupExecSharePointSettings SharePoint { get; set; }

Property Value

BackupExecSharePointSettings

TestRunScheduleString

Gets or sets the schedule to use for the test run as a human readable string - for example "Friday every 1 week(s) at 23:00 effective on 26/11/2015".

public string TestRunScheduleString { get; set; }

Property Value

string

VirtualMachines

Gets or sets the settings to use for backing up virtual machines for this definition.

public BackupExecVirtualMachineSettings VirtualMachines { get; set; }

Property Value

BackupExecVirtualMachineSettings

Methods

CompareTo(BackupExecBackupDefinition)

Compares two CENTREL.XIA.Configuration.Types.BackupExecBackupDefinition objects to allow sorting alphabetically by name.

public int CompareTo(BackupExecBackupDefinition other)

Parameters

other BackupExecBackupDefinition

The CENTREL.XIA.Configuration.Types.BackupExecBackupDefinition to compare to.

Returns

int

The sort order of the two items.

FindBackupTaskById(string)

Returns the backup task with the specified identifier, or null if no task with that name is found.

public BackupExecBackupTask FindBackupTaskById(string id)

Parameters

id string

The unique identifier of the backup task to locate in GUID format.

Returns

BackupExecBackupTask

The BackupExecBackupTask with the specified identifier.

FindDuplicationTaskById(string)

Returns the duplication task with the specified identifier, or null if no task with that name is found.

public BackupExecDuplicationTask FindDuplicationTaskById(string id)

Parameters

id string

The unique identifier of the duplication task to locate in GUID format.

Returns

BackupExecDuplicationTask

The BackupExecDuplicationTask with the specified identifier.

FromXml(string)

Returns a CENTREL.XIA.Configuration.Types.BackupExecBackupDefinition class from the specified XML.

public static BackupExecBackupDefinition FromXml(string xml)

Parameters

xml string

The XML representation of the object.

Returns

BackupExecBackupDefinition

A CENTREL.XIA.Configuration.Types.BackupExecBackupDefinition class.