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
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.
|
UDD_MANAGEMENT |
Persistent disk management privilege is
required to cancel the task related to attach, detach or
replace operation.
|
MACHINE_MANAGEMENT |
Machine management privilege is required
along with UDD_MANAGEMENT to cancel the task related to attach
and primary disk detach operation.
|
Parameters
Return Value
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
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
Return Value
Type
|
Description
|
DesktopTaskInfo | DesktopTaskInfo 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
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
Return Value
Type
|
Description
|
DesktopTaskInfo[] | Array of DesktopTaskInfo objects containing the current states of the tasks on a desktop. |
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
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.
|
UDD_MANAGEMENT |
Persistent disk management privilege is
required to pause the task related to attach, detach or
replace operation.
|
MACHINE_MANAGEMENT |
Machine management privilege is required
along with UDD_MANAGEMENT to pause the task related to attach
and primary disk detach operation.
|
Parameters
Return Value
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
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.
|
UDD_MANAGEMENT |
Persistent disk management privilege is
required to resume the task related to attach, detach or
replace operation.
|
MACHINE_MANAGEMENT |
Machine management privilege is required
along with UDD_MANAGEMENT to resume the task related to attach
and primary disk detach operation.
|
Parameters
Return Value
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
© 2020 VMware, Inc. All rights reserved.
Revision Oct-2020 Version 7.13.0