Double-Take SOAP SDK 8.2

Double-Take SOAP SDK 8.2

Double-Take Cmdlets Summary

Add-DtPhysicalRule

Add-DtUvraPhysicalRule

Checkpoint-DtConnection

Checkpoint-DtConnectionSourceQueue

Close-DtWorkload

Confirm-DtJobOptions

Disconnect-DtServer

Edit-DtJob

Get-DtAccessLevel

Get-DtActivationStatus

Get-DtAllFailoverReports

Get-DtBandwidthLimit

Get-DtConnectionIds

Get-DtDiagnostics

Get-DtDnsOptions

Get-DtEmailNotificationOptions

Get-DtEventLogEntry

Get-DtHvSystemState

Get-DtImages

Get-DtJob

Get-DtJobActionStatus

Get-DtLatestFailoverReport

Get-DtLogicalItem

Get-DtLogMessage

Get-DtOnlineActivationRequest

Get-DtOption

Get-DtPathBlocking

Get-DtPhysicalItem

Get-DtProductInfo

Get-DtQualificationResults

Get-DtRecommendedFailbackOptions

Get-DtRecommendedFailoverOptions

Get-DtRecommendedJobOptions

Get-DtRecommendedPathTransform

Get-DtRecommendedRestoreOptions

Get-DtRepairJobOptionsStatus

Get-DtScriptCredentials

Get-DtServerInfo

Get-DtSnapshot

Get-DtSourceQueueSnapshot

Get-DtSourceQueueSnapshots

Get-DtUvraRecommendedFailoverOptions

Get-DtUvraRecommendedRemoveOptions

Get-DtVerificationStatus

Get-DtWorkload

Get-DtWorkloadPhysicalItem

Get-DtWorkloadType

Install-DoubleTake

Install-DtVmwareCertificate

Invoke-DtAddShares

Invoke-DtQueueTask

Invoke-DtRemoveShares

Merge-DtConsoleServerData

New-DtFilesAndFoldersJob

New-DtJob

New-DtServer

New-DtTaskParameters

New-DtUri

New-DtUvraServer

New-DtWorkload

Remove-DtJob

Remove-DtPhysicalRule

Remove-DtSnapshot

Remove-DtSourceQueueSnapshot

Repair-DtJobOptions

Request-DtOnlineActivation

Request-DtOnlineDeactivation

Restart-DtReplicationService

Resume-DtJob

Resume-DtMirror

Resume-DtTarget

Save-DtConsoleServerData

Save-DtJobDiagnostics

Set-DtActivationCode

Set-DtBandwidthLimit

Set-DtEmailNotificationOptions

Set-DtJobCredentials

Set-DtLogicalItemSelection

Set-DtOption

Set-DtPathBlocking

Set-DtScriptCredentials

Set-DtServerCredential

Set-DtVmwareCertificatePolicy

Start-DtJob

Start-DtJobFailback

Start-DtJobFailover

Start-DtJobRestore

Start-DtJobReverse

Start-DtMirror

Start-DtOrphansProcessing

Start-DtReplication

Start-DtVerify

Stop-DtJob

Stop-DtMirror

Stop-DtReplication

Stop-DtReplicationService

Suspend-DtJob

Suspend-DtMirror

Suspend-DtTarget

Test-DtActiveDirectoryCredentials

Test-DtEmailNotification

Test-DtScript

Test-DtScriptCredentials

Test-DtVmwareCertificatePolicy

Undo-DtJobFailover

Uninstall-DoubleTake

Update-DtShares

Wait-DtConfirmJobOptions

Wait-DtMirrorComplete

Click or drag to resize

New-DtWorkload

This cmdlet creates a Double-Take workload on the specified server. For this cmdlet, the -ServiceHost should be your source server.

Syntax

New-DtWorkload [-WorkloadTypeName] <String> [-ImageId] <Guid> [-SnapshotId] <Guid> [-ServiceHost] <Server> [<CommonParameters>]

New-DtWorkload [-Workload] <Workload> [-ImageId] <Guid> [-SnapshotId] <Guid> [-ServiceHost] <Server> [<CommonParameters>]

Parameters

-WorkloadTypeName<String>

Specify a supported workload type from the Get-DtWorkloadType cmdlet.

Required?	true
Position?	named
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Workload<Workload>

Specify a supported workload type from the Get-DtWorkloadType cmdlet.

Required?	true
Position?	named
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ImageId<Guid>

Specify the image GUID returned from the Get-DtImages cmdlet.

Required?	false
Position?	named
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SnapshotId<Guid>

Specify the snapshot GUID returned from the Get-DtSnapshot cmdlet.

Required?	false
Position?	named
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ServiceHost<Server>

Specify the server object returned from the New-DtServer cmdlet.

Required?	true
Position?	1
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Examples

------------------EXAMPLE------------------

A server object is created for the server alpha using the domain\administrator and password credentials. It assigns the server object to the variable called DtServerObjectAlpha. The script then creates a workload on the server for a files and folders job, returning a global unique ID for the workload, and assigns that ID to the variable DtWorkloadGuid. The connections for the server object are then closed.

$DtServerObjectAlpha= New-DtServer -Name alpha -UserName domain\administrator -Password password

$DtWorkloadGuid = New-DtWorkload -ServiceHost $DtServerObjectAlpha -WorkloadTypeName FilesAndFolders

Disconnect-DtServer -ServiceHost $DtServerObjectAlpha