Cmdlets > Remove-DtJob

Remove-DtJob

Deletes the job

Syntax

Remove-DtJob [-ServiceHost] <Server> [-JobId] <Guid> [[-DeleteOptions] <DeleteOptions>] [<CommonParameters>]

Remove-DtJob [-ServiceHost] <Server> [[-DeleteOptions] <DeleteOptions>] -JobInfo <JobInfo> [<CommonParameters>]

Detailed Description

This cmdlet deletes the specified job from the specified server. A running job will be stopped before it is deleted.

Parameters

Name	Type	Description	Required	Pipeline Input
Service Host	Server	Specify the server object returned from the New-DtServer cmdlet. For this cmdlet, the -ServiceHost should be your target server.	true	false
JobId	Guid	Specify the job GUID returned from the New-DtJob cmdlet or the Id within the job information returned from the Get-DtJob cmdlet.	true	false
Delete Options	Delete Options	Specify the delete options available in DoubleTake.Jobs.Contract.DeleteOptions. Use the Windows PowerShell New-Object cmdlet to create this object.	false	false
JobInfo	JobInfo	Specify the job information returned from the Get-DtJob cmdlet. The job information can be piped from the Get-DtJob cmdlet and used in this cmdlet.	true	true

Outputs

ActivityToken

Examples

$DtServerObjectBeta = New-DtServer -Name beta -UserName domain\administrator -Password password

$DtJobForAlpha = Get-DtJob -ServiceHost $DtServerObjectBeta | Where-Object { $_.Statistics.CoreConnectionDetails.SourceMachineName -eq $DtServerObjectAlpha}

$DtDeleteOptions = New-Object DoubleTake.Jobs.Contract.DeleteOptions

$DtDeleteOptions.DiscardTargetQueue = $true

Remove-DtJob -ServiceHost $DtServerObjectBeta -JobId $DtJobForAlpha.Id -DeleteOptions $DtDeleteOptions

Disconnect-DtServer -ServiceHost $DtServerObjectBeta

A server object is created for the server beta using the domain\administrator and password credentials. It assigns the server object to the variable called DtServerObjectBeta. The job(s) are retrieved from DtServerObjectBeta, but only the job information where the source machine name is equivalent to the name stored in the variable DtServerObjectAlpha is retrieved. That information is then stored in the variable DtJobForAlpha. The delete options are stored in DtDeleteOptions, then the specific delete option DiscardTargetQueue is set to true. Finally the job is removed using the delete options. The connections for the server object are then closed.