Service - DesktopTask
Java Class
com.omnissa.vdi.vlsi.binding.vdi.task.DesktopTask
See also
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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DesktopTask used to make the method call. |
| id | DesktopTaskId | unique id of desktopTask |
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. |
| 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DesktopTask used to make the method call. |
| id | DesktopTaskId | unique id of desktopTask |
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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DesktopTask used to make the method call. |
| id | DesktopId | 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 |
|---|---|
| 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DesktopTask used to make the method call. |
| id | DesktopTaskId | unique id of desktopTask |
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. |
| 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DesktopTask used to make the method call. |
| id | DesktopTaskId | unique id of desktopTask |
| resumeTaskSpec | ResumeTaskSpec | ResumeTaskSpec object for additional params 1 |
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. |
| 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
-
This parameter need not be set. ↩