Cmdlets > Edit-DtJob

Edit-DtJob

Edits a job

Syntax

Edit-DtJob [-ServiceHost] <Server> [-JobId] <Guid> [-JobOptions] <JobOptions> [<CommonParameters>]

 

Edit-DtJob [-ServiceHost] <Server> [-JobOptions] <JobOptions> -JobInfo <JobInfo> [<CommonParameters>]

 

Detailed Description

This cmdlet allows you to edit an existing job that is stopped or running, using a JobOptions object that has been modified with your edited job settings.

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
JobOptions JobOptions

Specify the JobOptions returned from the Get-DtRecommendedJobOptions cmdlet.

true 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.Specify multiple job information objects in an array using the format @($JobInfo1, $JobInfo2).

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}

$DtJobForAlpha.Options.CoreMonitorOptions.TotalTimeAllowed="00:10:00"

Edit-DtJob -ServiceHost $DtServerObjectBeta -JobId $DtJobForAlpha.Id -JobOptions $DtJobForAlpha.Options

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. A job option is changed. In this case, the total time before failover is triggered is set to 10 minutes. Finally, the job options are used to edit the specified job. The connections for the server object are then closed.