Service - DesktopTask

Class
VMware.Hv.DesktopTask
See also
DesktopId, DesktopTaskId, DesktopTaskInfo, ResumeTaskSpec
Since
Horizon 7.4


Service Description

Interface for managing desktop related tasks

Methods

Methods defined in this Service
DesktopTask_Cancel, DesktopTask_Get, DesktopTask_List, DesktopTask_Pause, DesktopTask_Resume

DesktopTask_Cancel

Cancels the specified task on a desktop. Requires one or more of the listed privileges based on the task.

Privileges

Privilege Description
POOL_SVI_IMAGE_MANAGEMENT Manage maintenance operations on Automated Desktops & Farms privilege with the corresponding access group permission is required to cancel the task related to rebalance, refresh, resync, push image or checkpoint operation.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DesktopTask used to make the method call.
idDesktopTaskId

unique id of desktopTask

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.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



DesktopTask_Get

Gets info on the specified task on a desktop.

Privileges

Privilege Description
POOL_VIEW Desktop read privilege with the corresponding access group permission is required to read a desktop.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DesktopTask used to make the method call.
idDesktopTaskId

unique id of desktopTask

Return Value

Type Description
DesktopTaskInfoDesktopTaskInfo 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



DesktopTask_List

Lists info for all tasks on a desktop.

Privileges

Privilege Description
POOL_VIEW Desktop read privilege with the corresponding access group permission is required to read a desktop.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DesktopTask used to make the method call.
idDesktopId

unique identifier for a desktop entry.

Return Value

Type Description
DesktopTaskInfo[]Array of DesktopTaskInfo objects containing the current states of the tasks on a desktop.

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



DesktopTask_Pause

Pauses the specified task on a desktop. Requires one or more of the listed privileges based on the task.

Privileges

Privilege Description
POOL_SVI_IMAGE_MANAGEMENT Manage maintenance operations on Automated Desktops & Farms privilege with the corresponding access group permission is required to pause the task related to rebalance, refresh, resync, push image or checkpoint operation.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DesktopTask used to make the method call.
idDesktopTaskId

unique id of desktopTask

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.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



DesktopTask_Resume

Resumes the specified task on a desktop. Requires one or more of the listed privileges based on the task.

Privileges

Privilege Description
POOL_SVI_IMAGE_MANAGEMENT Manage maintenance operations on Automated Desktops & Farms privilege with the corresponding access group permission is required to resume the task related to rebalance, refresh, resync, push image or checkpoint operation.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DesktopTask used to make the method call.
idDesktopTaskId

unique id of desktopTask
resumeTaskSpecResumeTaskSpec

ResumeTaskSpec object for additional params
  • Optional parameter. If not specifing any value, this should be set to null.

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.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition