Class: DRtask

Last published : Oct 01, 2026
DR task
Related information
XenServer 9 Management API

Fields for class: DRtask

Field Type Qualifier Description
introduced_SRs SR ref set RO/runtime All SRs introduced by this appliance
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: DRtask

RPC name: create

Overview:
Create a disaster recovery task which will query the supplied list of devices
Signature:
DR_task ref create (session ref session_ref, string type, (string -> string) map device_config, string set whitelist)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string type The SR driver type of the SRs to introduce
(string -> string) map device_config The device configuration of the SRs to introduce
string set whitelist The devices to use for disaster recovery
Minimum Role: pool-operator
Return Type: DR_task ref
The reference of the created DRtask

RPC name: destroy

Overview:
Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required
Signature:
void destroy (session ref session_ref, DR_task ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
DR_task ref self The disaster recovery task to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

Overview:
Return a list of all the DRtasks known to the system.
Signature:
DR_task ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: DR_task ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of DRtask references to DRtask records for all DRtasks known to the system.
Signature:
(DR_task ref -> DR_task record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (DR_task ref -> DR_task record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the DRtask instance with the specified UUID.
Signature:
DR_task ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: DR_task ref
reference to the object

RPC name: getintroducedSRs

Overview:
Get the introducedSRs field of the given DRtask.
Signature:
SR ref set get_introduced_SRs (session ref session_ref, DR_task ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
DR_task ref self reference to the object
Minimum Role: read-only
Return Type: SR ref set
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given DRtask.
Signature:
DR_task record get_record (session ref session_ref, DR_task ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
DR_task ref self reference to the object
Minimum Role: read-only
Return Type: DR_task record
all fields from the object

RPC name: getuuid

Overview:
Get the uuid field of the given DRtask.
Signature:
string get_uuid (session ref session_ref, DR_task ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
DR_task ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field