Cmdlets > Close-DtWorkload

Close-DtWorkload

Closes the workload

Syntax

Close-DtWorkload [-ServiceHost] <Server> [-WorkloadId] <Guid> [<CommonParameters>]

Detailed Description

This cmdlet closes the workload creation process on the specified server and removes all resources associated with the workload creation process.

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 source server.	true	false
WorkloadId	Guid	Specify the workload GUID returned from the New-DtWorkload cmdlet using the workload type name parameter.	true	false

Outputs

None

Examples

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

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

Close-DtWorkload -ServiceHost $DtServerObjectAlpha -WorkloadId $DtWorkloadGuid

Disconnect-DtServer -ServiceHost $DtServerObjectAlpha

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 workload is then closed on the server. The connections for the server object are then closed.