Get-XenDRTask

Last published : Nov 12, 2026
Gets the DRTask objects in the pool.
Related information
DRTask cmdlets

Syntax

Get-XenDRTask [[-Ref] <XenRef[DR_task]>] [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]
Get-XenDRTask [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
    [<CommonParameters>]

Description

Retrieves the DRTask objects in the pool. With no parameters the cmdlet returns the whole collection; use -Uuid or -Ref to select one.
DRTask: DR task.

Parameters

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The DRTask object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[DR_task]
Required False
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the DRTask to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

Inputs

  • XenRef[DR_task]
  • guid

Outputs

  • DR_task[]

Examples

Example 1: List every DRTask

PS> Get-XenDRTask
Retrieves every DRTask object in the pool. With no parameters the cmdlet fetches the whole collection.

Example 2: Retrieve one DRTask by uuid

PS> Get-XenDRTask -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single DRTask. -Uuid is the way to be sure of exactly one object.

Example 3: Retrieve one DRTask by reference

PS> Get-XenDRTask -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Retrieves a single DRTask. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.