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

NameTypeDescription
_thisManagedObjectReference A reference to the Task used to make the method call.
idTaskId

The ID of the task to cancel.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if the task is not cancellable.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the Task used to make the method call.
idTaskId

The ID of the task.

Return Value

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

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition