task :: XAPI Toolstack Developer Documentation

Class: task

A long-running asynchronous task

Enums

task_allowed_operations

task_status_type

Fields

enum task_allowed_operations set allowed_operations [RO/runtime]

string backtrace [RO/runtime]

datetime created [RO/runtime]

(string → enum task_allowed_operations) map current_operations [RO/runtime]

string set error_info [RO/runtime]

datetime finished [RO/runtime]

string name_description [RO/runtime]

string name_label [RO/runtime]

(string → string) map other_config [RW]

float progress [RO/runtime]

host ref resident_on [RO/runtime]

string result [RO/runtime]

enum task_status_type status [RO/runtime]

task ref subtask_of [RO/runtime]

task ref set subtasks [RO/runtime]

string type [RO/runtime]

string uuid [RO/runtime]

Messages

void add_to_other_config (session ref, task ref, string, string)

void cancel (session ref, task ref)

task ref create (session ref, string, string)

void destroy (session ref, task ref)

task ref set get_all (session ref)

(task ref → task record) map get_all_records (session ref)

enum task_allowed_operations set get_allowed_operations (session ref, task ref)

string get_backtrace (session ref, task ref)

task ref set get_by_name_label (session ref, string)

task ref get_by_uuid (session ref, string)

datetime get_created (session ref, task ref)

(string → enum task_allowed_operations) map get_current_operations (session ref, task ref)

string set get_error_info (session ref, task ref)

datetime get_finished (session ref, task ref)

string get_name_description (session ref, task ref)

string get_name_label (session ref, task ref)

(string → string) map get_other_config (session ref, task ref)

float get_progress (session ref, task ref)

task record get_record (session ref, task ref)

host ref get_resident_on (session ref, task ref)

string get_result (session ref, task ref)

enum task_status_type get_status (session ref, task ref)

task ref get_subtask_of (session ref, task ref)

task ref set get_subtasks (session ref, task ref)

string get_type (session ref, task ref)

string get_uuid (session ref, task ref)

void remove_from_other_config (session ref, task ref, string)

void set_error_info (session ref, task ref, string set)

void set_other_config (session ref, task ref, (string → string) map)

void set_progress (session ref, task ref, float)

void set_result (session ref, task ref, string)

void set_status (session ref, task ref, enum task_status_type)

Values:	cancel	refers to the operation "cancel"
	destroy	refers to the operation "destroy"

Values:	pending	task is in progress
	success	task was completed successfully
	failure	task has failed
	cancelling	task is being cancelled
	cancelled	task has been cancelled

Default value:	{}
Published in:	XenServer 4.0 (rio)	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.

Default value:	"()"
Published in:	XenServer 7.0 (dundee)	Function call trace for debugging.

Default value:	{}
Published in:	XenServer 4.0 (rio)	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

Default value:	{}
Published in:	XenServer 4.1 (miami)	additional configuration

Default value:	Null
Published in:	XenServer 5.0 (orlando)	Ref pointing to the task this is a substask of.

Parameters:	session ref session_id	Reference to a valid session
	task ref self	reference to the object
	string key	Key to add
	string value	Value to add
Minimum role:	pool-operator
Published in:	XenServer 4.1 (miami)	additional configuration

Parameters:	session ref session_id	Reference to a valid session
	task ref task	The task
Minimum role:	read-only
Errors:	OPERATION_NOT_ALLOWED	You attempted an operation that was not allowed.
Published in:	XenServer 4.0 (rio)	Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time.

Class: task

Enums

Fields

Messages Hide implicit

Messages