When using the Double-Take Console to create a job, the Set Options page filters the job options in order to display only those that are specific to the type of job you are creating. This filtering also applies to server configurations within a job type. For example, a files and folders job from a standalone source to a standalone target will have different job options displayed in the console than a file and folders job from a clustered source to a clustered target.
There is no such filtering available in the JobOptions class because the class must include all possible configurations for all possible job types. This makes the JobOptions class large and potentially confusing.
The sections below correspond to the accordion sections available on the Set Options page in the console. These sections will help you identify a JobOptions class for a particular job option. First, expand the section below that corresponds to the console accordion that has the option you want to set. Then, locate the field name from the console accordion in the left column of the table and the corresponding JobOptions class to use in the right column of the table. Keep in mind these caveats about console options compared to JobOptions classes.
Set Options Field | Equivalent JobOptions Class |
---|---|
Do not limit bandwidth | JobOptions.BandwidthOptions.Mode |
Use a fixed limit | JobOptions.BandwidthOptions.Mode |
Use a fixed limit, Preset bandwidth |
JobOptions.BandwidthOptions.Specification.Key JobOptions.BandwidthOptions.Specification.Type JobOptions.BandwidthOptions.Specification.Value |
Use a fixed limit, Bandwidth | JobOptions.BandwidthOptions.Limit |
Use scheduled limits | JobOptions.BandwidthOptions.Mode |
Use scheduled limits, New (or Edit), Daytime entry | JobOptions.BandwidthOptions.Entries.EntryType |
Use scheduled limits, New (or Edit), Overnight entry | JobOptions.BandwidthOptions.Entries.EntryType |
Use scheduled limits, New (or Edit), Day | JobOptions.BandwidthOptions.Entries .DaysOfWeek |
Use scheduled limits, New (or Edit), Start time | JobOptions.BandwidthOptions.Entries.StartTime |
Use scheduled limits, New (or Edit), End time | JobOptions.BandwidthOptions.Entries.EndTime |
Use scheduled limits, New (or Edit), Preset bandwidth |
JobOptions.BandwidthOptions.Specification.Key JobOptions.BandwidthOptions.Specification.Type JobOptions.BandwidthOptions.Specification.Value |
Use scheduled limits, New (or Edit), Bandwidth | JobOptions.BandwidthOptions.Entries.Limit |
Set Options Field | Equivalent JobOptions Class |
---|---|
Enable compression |
JobOptions.CoreConnectionOptions.ConnectionStartParameters. JobOptions.CoreConnectionOptions.ConnectionStartParameters. |
This job options accordion section is only for agentless vSphere jobs, however, that job type is not currently supported with scripting.
Set Options Field | Equivalent JobOptions Class |
---|---|
Domain User name |
JobOptions.ApplicationOptions.ExchangeCredentials |
Set Options Field | Equivalent JobOptions Class |
---|---|
Apply source network configuration to the target |
JobOptions.CoreMonitorOptions.ShouldPerformLanFailover (for files and folders jobs) JobOptions.SystemStateOptions.IsWanFailover (for full server jobs) |
Failover server name | JobOptions.CoreMonitorOptions.MonitorConfiguration.ItemsToFailover |
Add these addresses to the selected target adapter after failover |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ItemsToFailover |
Retain target network configuration |
JobOptions.CoreMonitorOptions.ShouldPerformLanFailover (for files and folders and application jobs) JobOptions.SystemStateOptions.IsWanFailover (for full server jobs) JobOptions.VRAOptions.IsWanFailoverEnabled (for virtual guest jobs) JobOptions.DTHVOptions.IsWanFailoverEnabled (for virtual host jobs) |
Failover server name |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ItemsToFailover |
Update DNS server | JobOptions.DnsOptions.Enabled |
Credentials for | JobOptions.CoreMonitorOptions.MonitorConfiguration. ActiveDirectoryCredentials |
These DNS servers will be updated during failover | JobOptions.DnsOptions.Domains.DnsServers |
Update these source DNS entries with the corresponding target IP address | JobOptions.DnsOptions.Domains.IpAddresMappings |
Update TTL |
JobOptions.DnsOptions.Domains.ShouldUpdateTtl JobOptions.DnsOptions.Domains.IpAddressMappings.ShouldUpdateTtl JobOptions.DnsOptions.Domains.TtlValue JobOptions.DnsOptions.Domains.IpAddressMappings.TtlValue Set both pairs of values to the same value. Both locations of ShouldUpdateTtl and both locations of TtlValue should be the same value. If they are different, the DNS update will fail. |
Set Options Field | Equivalent JobOptions Class |
---|---|
Monitor for failover |
JobOptions.FailoverMonitoringEnabled |
Total time to failure |
JobOptions.CoreMonitorOptions.TotalTimeAllowed JobOptions.CoreMonitorOptions.UseTotalTimeAllowed |
Consecutive failures |
JobOptions.CoreMonitorOptions.UseTotalTimeAllowed JobOptions.CoreMonitorOptions.MonitorConfiguration.Addresses. |
Monitor on this interval |
JobOptions.CoreMonitorOptions.MonitorConfiguration.Addresses.PingInterval |
Network monitoring | JobOptions.CoreMonitorOptions.MonitorConfiguration.Addresses.PingMethods |
Monitor these addresses | JobOptions.CoreMonitorOptions.MonitorConfiguration.Addresses.Address |
Monitoring method | JobOptions.CoreMonitorOptions.MonitorConfiguration.Addresses.PingMethods |
Failover trigger |
JobOptions.CoreMonitorOptions.MonitorConfiguration.Trigger |
Service monitoring |
JobOptions.MonitoringOptions.ServiceMonitoringEnabled |
Services to monitor | JobOptions.ApplicationOptions.MonitoredServices |
Attempt to restart this service after each failure |
JobOptions.MonitoringOptions.ServiceMonitoringOptions.StartService |
Custom script monitoring | JobOptions.CoreMonitorOptions.MonitorConfiguration.Addresses.PingMethods |
Script file |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ScriptMonitorName |
Wait for user to initiate failover |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ProcessingOptions. |
Set Options Field | Equivalent JobOptions Class |
---|---|
Wait for user to initiate failover |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ProcessingOptions. |
Shutdown source server |
JobOptions.FullServerFailoverOptions.ShutdownSourceServer (for full server jobs) JobOptions.VRAOptions.WorkloadCustomizationOptions. |
Failover shares |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ItemsToFailover.Shares |
Failover host name |
JobOptions.CoreMonitorOptions.MonitorConfiguration.ActiveDirectoryOptions |
Failback host name | JobOptions.CoreMonitorOptions.MonitorConfiguration.ActiveDirectoryOptions |
Active Directory Credentials | JobOptions.CoreMonitorOptions.MonitorConfiguration. ActiveDirectoryCredentials |
Scripts | JobOptions.CoreMonitorOptions.MonitorConfiguration.Scripts |
Power on replica virtual machine after failover | JobOptions.VRAOptions.WorkloadCustomizationOptions. PowerupReplicaAfterFailover |
Set Options Field | Equivalent JobOptions Class |
---|---|
Services to stop on source and start on target during failover and start on source and stop on target during failback | JobOptions.SystemStateOptions.ServicesToStopOptions |
Set Options Field | Equivalent JobOptions Class |
---|---|
Job name | JobOptions.Name |
Set Options Field | Equivalent JobOptions Class |
---|---|
Image name | JobOptions.ImageProtectionOptions.ImageName |
Virtual Disk |
JobOptions.ImageProtectionOptions.VhdInfo.UseExistingVhd |
Virtual Disk Path | JobOptions.ImageProtectionOptions.VhdInfo.FilePath |
Disk Name | JobOptions.ImageProtectionOptions.VhdInfo.FilePath |
Set Options Field | Equivalent JobOptions Class |
---|---|
Choose a comparison method and whether to mirror the entire file or only the bytes that differ in each file |
JobOptions.CoreConnectionOptions.ConnectionStartParameters. JobOptions.CoreConnectionOptions.ConnectionStartParameters. |
Enable scheduled verification |
JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. Verify.IsEnabled |
Verify on this interval | JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. Verify.Interval |
Begin immediately | JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. Verify.StartTime |
Begin at this time | JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. Verify.StartTime |
Report only | JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. Verify.Criteria |
Report and mirror files |
JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. JobOptions.CoreConnectionOptions.ConnectionStartParameters.Schedule. |
Calculate size of protected data upon connection | JobOptions.CoreConnectionOptions.ConnectionStartParameters. MirrorParameters.MirrorOperationOptions |
Delete orphaned files |
JobOptions.CoreConnectionOptions.ConnectionStartParameters. |
Set Options Field | Equivalent JobOptions Class |
---|---|
Map source network adapter to target network adapters | JobOptions.SystemStateOptions.NicMappings |
Set Options Field | Equivalent JobOptions Class |
---|---|
Send data to the target server using this route | JobOptions.CoreConnectionOptions.TargetAddress |
Set Options Field | Equivalent JobOptions Class |
---|---|
Mappings | JobOptions.CoreConnectionOptions.PathTransformations |
Bock target paths upon connection | JobOptions.CoreConnectionOptions.ConnectionStartParameters. IsPathBlockingEnabled |
Set Options Field | Equivalent JobOptions Class |
---|---|
Apply source network configuration to the target |
JobOptions.SystemStateOptions.IsWanFailover |
Retain target network configuration |
JobOptions.SystemStateOptions.IsWanFailover |
Update DNS server | JobOptions.DnsOptions.Enabled |
Credentials for | JobOptions.CoreMonitorOptions.MonitorConfiguration.ActiveDirectoryCredentials |
These DNS servers will be updated during failover | JobOptions.DnsOptions.Domains.DnsServerDetail |
Update these source DNS entries with the corresponding target IP address | JobOptions.DnsOptions.Domains.IpAddresMappings |
Update TTL |
JobOptions.DnsOptions.Domains.ShouldUpdateTtl JobOptions.DnsOptions.Domains.IpAddressMappings.ShouldUpdateTtl JobOptions.DnsOptions.Domains.TtlValue JobOptions.DnsOptions.Domains.IpAddressMappings.TtlValue Set both pairs of values to the same value. Both locations of ShouldUpdateTtl and both locations of TtlValue should be the same value. If they are different, the DNS update will fail. |
Set Options Field | Equivalent JobOptions Class |
---|---|
Wait for user to initiate recovery | JobOptions.ImageRecoveryOptions.UserInitiatedCutover |
Shutdown source server | JobOptions.ImageRecoveryOptions.ShutdownSourceServer |
This job options accordion section is only for agentless vSphere jobs, however, that job type is not currently supported with scripting.
This job options accordion section is only for agentless vSphere jobs, however, that job type is not currently supported with scripting.
Set Options Field | Equivalent JobOptions Class |
---|---|
Replica virtual machine display name | JobOptions.VRAOptions.ReplicaApplianceInfo.DisplayName |
Number of processors | JobOptions.VRAOptions.ReplicaVmInfo.CPUs |
Amount of memory | JobOptions.VRAOptions.ReplicaVmInfo.Memory |
Network adapter type on the replica | JobOptions.VRAOptions.Volumes.DiskProvisioningType |
Map source virtual switches to target virtual switches |
JobOptions.VRAOptions.VirtualSwitchMapping.TargetVirtualSwitch (for virtual guest jobs) JobOptions.DTHVOptions.VirtualSwitchMapping.TargetVirtualSwitch (for virtual host jobs) |
Map source VLAN ID to target VLAN ID |
JobOptions.DTHVOptions.VLanMapping.TargetSwitchPort |
Power on replica virtual machine after failover | JobOptions.VRAOptions.WorkloadCustomizationOptions. PowerupReplicaAfterFailover |
Set Options Field | Equivalent JobOptions Class |
---|---|
Select the datastore on the target ESX server that will hold the replica virtual machine | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Select the volume and folder on the target server that will hold the replica virtual machine | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Full path where the replica virtual machine will be stored | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Local File Volume | None. This is an interface control only so the console can display the appropriate fields depending on the selected option. |
SMB Share | None. This is an interface control only so the console can display the appropriate fields depending on the selected option. |
File server name | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Share name | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Folder | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Set Options Field | Equivalent JobOptions Class |
---|---|
Provide Credentials |
These credentials are not in the JobOptions class. You will need to use the Windows PowerShell New-Object cmdlet to create a credentials object from DoubleTake.Jobs.Contract.JobCredentials. |
Use advanced settings for replica virtual machine network configuration | JobOptions.VRAOptions.IsWanFailoverEnabled |
Advanced Network | None. If the Replica IP addresses, Replica Default Gateways, and Replica DNS Server addresses field are populated, this option is considered enabled. If any of those three fields are not populated, this option is considered disabled. |
Replica IP addresses | JobOptions.VRAOptions.ReplicaNetworkInterfaceInfo.IPAddresses |
Replica Default Gateways | JobOptions.VRAOptions.ReplicaNetworkInterfaceInfo.Gateways |
Replica DNS Server addresses | JobOptions.VRAOptions.ReplicaNetworkInterfaceInfo.DnsServers |
Set Options Field | Equivalent JobOptions Class |
---|---|
Target Volume |
JobOptions.VRAOptions.Volumes.VirtualDiskPath (for virtual guest jobs) JobOptions.DTHVOptions.TargetVM.Path (for virtual host jobs) JobOptions.DTHVOptions.TargetVM.VirtualHardDiskPath (for virtual host jobs) |
Target Path |
JobOptions.VRAOptions.Volumes.VirtualDiskPath (for virtual guest jobs) JobOptions.DTHVOptions.TargetVM.Path (for virtual host jobs) JobOptions.DTHVOptions.TargetVM.VirtualHardDiskPath (for virtual host jobs) |
Replica Disk Format | JobOptions.VRAOptions.Volumes.DiskProvisioningType |
Provide Credentials |
These credentials are not in the JobOptions class. You will need to create a server object using New-DtServer with the Role option set to ReverseVimServerRole and then include that server object with the OtherServers option in your cmdlets. |
Set Options Field | Equivalent JobOptions Class |
---|---|
Replica Disk Size | JobOptions.VRAOptions.Volumes.DesiredSize |
Replica Disk Format | JobOptions.VRAOptions.Volumes.DiskProvisioningType |
Storage Controller | JobOptions.VRAOptions.Volumes.DiskControllerType |
Target Volume |
JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Virtual Disk | None. This is an interface control only so the console can display the appropriate fields depending on the selected option. |
Pre-Existing Disk Path | JobOptions.VRAOptions.Volumes.PreexistingDiskPath |
Volume Group Properties, Virtual Disk | None. This is an interface control only so the console can display the appropriate fields depending on the selected option. |
Volume Group Properties, Datastore |
JobOptions.VRAOptions.LvmOptions.VolumeGroup.LogicalVolume. JobOptions.VRAOptions.LvmOptions.VolumeGroup.PhysicalVolume. |
Volume Group Properties, Pre-existing disk path |
JobOptions.VRAOptions.LvmOptions.VolumeGroup.PreexistingDisksPath |
Volume Group Properties, Replica disk format |
JobOptions.VRAOptions.LvmOptions.VolumeGroup.PhysicalVolume. |
Volume Group Properties, Physical volume maximum size | JobOptions.VRAOptions.LvmOptions.VolumeGroup.MaxPhysicalVolumeSize |
Volume Group Properties, Volume Group Size |
JobOptions.VRAOptions.LvmOptions.VolumeGroup.SourceVolumeGroupSize |
Logical Volume Properties, Replica Volume Size | JobOptions.VRAOptions.LvmOptions.VolumeGroup.LogicalVolume.DesiredSize |
Partition Properties, Virtual disk | None. This is an interface control only so the console can display the appropriate fields depending on the selected option. |
Partition Properties, Datastore | JobOptions.VRAOptions.Volumes.VirtualDiskPath |
Partition Properties, Pre-existing disk path | JobOptions.VRAOptions.Volumes.PreexistingDiskPath |
Partition Properties, Replica disk format | JobOptions.VRAOptions.Volumes.DiskProvisioningType |
Partition Properties, Replica volume size | JobOptions.VRAOptions.Volumes.DesiredSize |
Set Options Field | Equivalent JobOptions Class |
---|---|
Select the virtual recovery appliance on the source ESX server that will be used when reversing the protection | JobOptions.VRAOptions.SourceApplianceInfo |
Provide Credentials |
These credentials are not in the JobOptions class. You will need to create a server object using New-DtServer with the Role option set to ReverseHelperRole and then include that server object with the OtherServers option in your cmdlets. |
Send data to the source route when reversing the protection | JobOptions.VRAOptions.ReverseRoute |
Set Options Field | Equivalent JobOptions Class |
---|---|
Send data to the source server when reversing the protection using this route | JobOptions.VRAOptions.ReverseRoute |
Set Options Field | Equivalent JobOptions Class |
---|---|
Enable reverse protection | JobOptions.FullServerFailoverOptions.CreateBackupConnection |
Select a reserved IP address on the source | JobOptions.SystemStateOptions.SourceReservedAddress |
Select a reserved IP address on the target | JobOptions.SystemStateOptions.TargetReservedAddress |
Disable reverse protection | JobOptions.FullServerFailoverOptions.CreateBackupConnection |
Send data to the target server using this route | JobOptions.CoreConnectionOptions.TargetAddress |
Set Options Field | Equivalent JobOptions Class |
---|---|
Script file |
JobOptions.CoreConnectionOptions.ConnectionStartParameters.ScriptPoints. JobOptions.CoreConnectionOptions.ConnectionStartParameters.ScriptPoints. |
Arguments | JobOptions.CoreConnectionOptions.ConnectionStartParameters.ScriptPoints. Arguments |
Allow script to interact with desktop | JobOptions.CoreConnectionOptions.ConnectionStartParameters.ScriptPoints. InteractionMode |
Delay until script completes | JobOptions.CoreConnectionOptions.ConnectionStartParameters.ScriptPoints. ExecutionMode |
Set Options Field | Equivalent JobOptions Class |
---|---|
Enable scheduled snapshots |
JobOptions.CoreConnectionOptions.ConnectionStartParameters. SnapshotSchedule.IsEnabled |
Take snapshots on this interval | JobOptions.CoreConnectionOptions.ConnectionStartParameters. SnapshotSchedule.Interval |
Begin immediately | JobOptions.CoreConnectionOptions.ConnectionStartParameters. SnapshotSchedule.StartTime |
Begin at this time | JobOptions.CoreConnectionOptions.ConnectionStartParameters. SnapshotSchedule.StartTime |
Set Options Field | Equivalent JobOptions Class |
---|---|
Select additional folders from the source server to be staged | JobOptions.FullServerFailoverOptions.AdditionalStagingFolders |
Alternate Staging Volume |
JobOptions.SystemStateOptions.AlternateVolumeMapping JobOptions.SystemStateOptions.AlternatveVolumeStaging |
Set Options Field | Equivalent JobOptions Class |
---|---|
Block target paths upon connection | JobOptions.CoreConnectionOptions.ConnectionStartParameters. IsPathBlockingEnabled |
Set Options Field | Equivalent JobOptions Class |
---|---|
Target route | JobOptions.CoreConnectionOptions.TargetAddress |
Set Options Field | Equivalent JobOptions Class |
---|---|
Services to leave running on the target during protection | JobOptions.TargetServicesOptions.FailoverServices |
Set Options Field | Equivalent JobOptions Class |
---|---|
Post-failover script, Script file | JobOptions.ApplicationOptions.TestPostFailoverScript |
Post-failover script, Arguments | JobOptions.ApplicationOptions.TestPostFailoverScriptArguments |
Pre-failback script, Script file | JobOptions.ApplicationOptions.TestPreFailbackScript |
Pre-failback script, Arguments | JobOptions.ApplicationOptions.TestPreFailbackScriptArguments |
This job options accordion section is only for agentless vSphere jobs, however, that job type is not currently supported with scripting.
This job options accordion section is only for agentless vSphere jobs, however, that job type is not currently supported with scripting.