New-XenDRTask

Last published : Nov 12, 2026
Creates a new DRTask object.
Related information
DRTask cmdlets

Syntax

New-XenDRTask -HashTable <hashtable> [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenDRTask -Record <DR_task> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenDRTask [-PassThru] [-Type <string>] [-DeviceConfig <hashtable>]
    [-Whitelist <string[]>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new DRTask object.
DR\_task.create: Create a disaster recovery task which will query the supplied list of devices.
DRTask: DR task.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-DeviceConfig

The device configuration of the SRs to introduce
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-HashTable

A hashtable of field names to values, from which to create the DRTask.
Attribute Value
Type hashtable
Required True
Position Named
Accepts pipeline input False

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Record

An existing DRTask record whose fields are used to create the new object.
Attribute Value
Type DR_task
Required True
Position Named
Accepts pipeline input False

-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

-Type

The SR driver type of the SRs to introduce
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

-Whitelist

The devices to use for disaster recovery
Attribute Value
Type string[]
Required False
Position Named
Accepts pipeline input False

Inputs

  • None

Outputs

  • DR_task
  • Task
  • void

Examples

Example 1: Create a DRTask

PS> New-XenDRTask -Type "value" -DeviceConfig @{ "key" = "value" } -Whitelist "tag1" -PassThru
New-XenDRTask takes the arguments of the create call rather than a record of fields, and needs all of them. -PassThru returns the new DRTask.

Example 2: Create a DRTask and wait for the task

PS> New-XenDRTask -Type "value" -DeviceConfig @{ "key" = "value" } -Whitelist "tag1" -Async -PassThru |
    Wait-XenTask -ShowProgress
-Async hands the work to the server and returns the Task that represents it, which pipes into Wait-XenTask.

Example 3: See what would be created

PS> New-XenDRTask -Type "value" -DeviceConfig @{ "key" = "value" } -Whitelist "tag1" -WhatIf
Reports what would be created without creating it. Every cmdlet that changes the server takes -WhatIf and -Confirm.