Cmdlets > Get-DtWorkload

Get-DtWorkload

Returns the workload definition

Syntax

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

Detailed Description

This cmdlet returns an object that represents the workload definition, including the workload type name, any physical rules, and any logical rules. This object is used in job cmdlets.

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

Workload

Examples

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

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

$DtWorkload = Get-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 full sever job, returning a global unique ID for the workload, and assigns that ID to the variable DtWorkloadGuid. The workload definition for the workload type and the server is then stored in the DtWorkload variable. The connections for the server object are then closed.