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_MANAGEMENT	Desktop management privilege with the corresponding access group permission is required to cancel push image task.
POOL_SVI_IMAGE_MANAGEMENT	Manage Composer Desktop Images privilege with the corresponding access group permission is required to cancel the task related to rebalance, refresh, resync 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_Cancel" type="vdi:DesktopTask_CancelRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_CancelResponse">
            <complexType/>
         </element>

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_Get" type="vdi:DesktopTask_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DesktopTaskInfo"/>
               </sequence>
            </complexType>
         </element>

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_List" type="vdi:DesktopTask_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DesktopTaskInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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_MANAGEMENT	Desktop management privilege with the corresponding access group permission is required to pause push image task.
POOL_SVI_IMAGE_MANAGEMENT	Manage Composer Desktop Images privilege with the corresponding access group permission is required to pause the task related to rebalance, refresh, resync 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_Pause" type="vdi:DesktopTask_PauseRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_PauseResponse">
            <complexType/>
         </element>

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_MANAGEMENT	Desktop management privilege with the corresponding access group permission is required to resume push image task.
POOL_SVI_IMAGE_MANAGEMENT	Manage Composer Desktop Images privilege with the corresponding access group permission is required to resume the task related to rebalance, refresh, resync 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.

DesktopTaskId

unique id of desktopTask

resumeTaskSpec

ResumeTaskSpec

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
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="DesktopTask_Resume" type="vdi:DesktopTask_ResumeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="DesktopTask_ResumeResponse">
            <complexType/>
         </element>