Service - Task

Class: VMware.Hv.Task
See also: TaskId, TaskInfo
Since: Horizon View 6.0

Service Description

The task management service.

Methods

Methods defined in this Service
Task_Cancel, Task_Get

Task_Cancel

Cancels the specified task.

Privileges

Privilege	Description
ADMINISTRATOR	Administrator privilege is required to cancel a task.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Task used to make the method call.
id	TaskId	The ID of the task to cancel.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidRequest	Thrown if the task is not cancellable.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Task_Cancel" type="vdi:Task_CancelRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Task_CancelResponse">
            <complexType/>
         </element>

Task_Get

Gets info on the requested task.

Privileges

Privilege	Description
ADMINISTRATOR_VIEW	Administrator (read-only) privilege is required to retrieve information about a task.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the Task used to make the method call.
id	TaskId	The ID of the task.

Return Value

Type	Description
TaskInfo	A TaskInfo object containing the current state of the task.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Task_Get" type="vdi:Task_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Task_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:TaskInfo"/>
               </sequence>
            </complexType>
         </element>