Citrix Systems 6 manual Task Commands, Task Parameters

Force an SR scan, syncing the xapi database with VDIs present in the underlying storage substrate.

Task Commands

Commands for working with long-running asynchronous tasks. These are tasks such as starting, stopping, and suspending a Virtual Machine, which are typically made up of a set of other atomic subtasks that together accomplish the requested operation.

The task objects can be listed with the standard object listing command (xe task-list), and the parameters manipulated with the standard parameter commands. See the section called “Low-level Parameter Commands” for details.

Task Parameters

Tasks have the following parameters:

Parameter Name	Description	Type
uuid	the unique identifier/object reference for	read only
	the Task
name-label	the name of the Task	read only
name-description	the description string of the Task	read only
resident-on	the unique identifier/object reference of the	read only
	host on which the task is running
status	current status of the Task	read only
progress	if the Task is still pending, this field contains	read only
	the estimated percentage complete, from 0.
	to 1. If the Task has completed, successfully
	or unsuccessfully, this should be 1.
type	if the Task has successfully completed, this	read only
	parameter contains the type of the encoded
	result, that is, the name of the class whose
	reference is in the result field; otherwise,
	this parameter's value is undefined
result	if the Task has completed successfully, this	read only
	field contains the result value, either Void
	or an object reference; otherwise, this
	parameter's value is undefined
error_info	if the Task has failed, this parameter	read only
	contains the set of associated error
	strings; otherwise, this parameter's value is
	undefined
allowed_operations	list of the operations allowed in this state	read only
created	time the task has been created	read only
finished	time task finished (i.e. succeeded or failed).	read only
	If task-status is pending, then the value of
	this field has no meaning
subtask_of	contains the UUID of the tasks this task is a	read only
	sub-task of

150