Class: DR_task
DR task
| Published in: | XenServer 6.0 (boston) | DR task |
Fields
SR ref set
introduced_SRs
[RO/runtime]
All SRs introduced by this appliance
| Published in: | XenServer 4.0 (rio) | All SRs introduced by this appliance |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
Messages
DR_task ref
create
(session ref, string, (string → string) map, string set)
Create a disaster recovery task which will query the supplied list of devices
| Parameters: | session ref session_id | 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 |
| Result: | The reference of the created DR_task |
| Published in: | XenServer 6.0 (boston) | Create a disaster recovery task which will query the supplied list of devices |
void
destroy
(session ref, DR_task ref)
Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required
| Parameters: | session ref session_id | Reference to a valid session |
| DR_task ref self | The disaster recovery task to destroy |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required |
DR_task ref set
get_all
(session ref)
Return a list of all the DR_tasks known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 6.0 (boston) | DR task |
(DR_task ref → DR_task record) map
get_all_records
(session ref)
Return a map of DR_task references to DR_task records for all DR_tasks known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 6.0 (boston) | DR task |
DR_task ref
get_by_uuid
(session ref, string)
Get a reference to the DR_task instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 6.0 (boston) | DR task |
SR ref set
get_introduced_SRs
(session ref, DR_task ref)
Get the introduced_SRs field of the given DR_task.
| Parameters: | session ref session_id | Reference to a valid session |
| DR_task ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | All SRs introduced by this appliance |
DR_task record
get_record
(session ref, DR_task ref)
Get a record containing the current state of the given DR_task.
| Parameters: | session ref session_id | Reference to a valid session |
| DR_task ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 6.0 (boston) | DR task |
string
get_uuid
(session ref, DR_task ref)
Get the uuid field of the given DR_task.
| Parameters: | session ref session_id | Reference to a valid session |
| DR_task ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |