Parameter Name

Description

Type

 

 

 

name-description

the description string of the Task

read only

 

 

 

resident-on

the unique identifier/object reference of

read only

 

the host on which the task is running

 

 

 

 

status

current status of the Task

read only

 

 

 

progress

if the Task is still pending, this field

read only

 

contains 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,

read only

 

this 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,

read only

 

this 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

read only

 

failed). 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

read only

 

a sub-task of

 

 

 

 

subtasks

contains the UUID(s) of all the subtasks

read only

 

of this task

 

 

 

 

task-cancel

task-cancel [uuid=<task_uuid>]

Direct the specified Task to cancel and return.

Template commands

Commands for working with VM templates.

177

Page 197
Image 197
Citrix Systems 5.6 manual Template commands, Task-cancel uuid=taskuuid