Develop for XenServer

Class: DR_task

DR task

Fields for class: DR_task

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: DR_task

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)
<!--NeedCopy-->

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 DR_task

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)
<!--NeedCopy-->

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: get_all

Overview:

Return a list of all the DR_tasks known to the system.

Signature:

DR_task ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

Overview:

Return a map of DR_task references to DR_task records for all DR_tasks known to the system.

Signature:

(DR_task ref -> DR_task record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

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: get_by_uuid

Overview:

Get a reference to the DR_task instance with the specified UUID.

Signature:

DR_task ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_introduced_SRs

Overview:

Get the introduced_SRs field of the given DR_task.

Signature:

SR ref set get_introduced_SRs (session ref session_ref, DR_task ref self)
<!--NeedCopy-->

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: get_record

Overview:

Get a record containing the current state of the given DR_task.

Signature:

DR_task record get_record (session ref session_ref, DR_task ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given DR_task.

Signature:

string get_uuid (session ref session_ref, DR_task ref self)
<!--NeedCopy-->

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

Class: DR_task