Service - WS1Assist

Class: VMware.Hv.WS1Assist
See also: SessionId, WS1AssistAgentId, WS1AssistAgentStatus, WS1AssistSessionSpec
Since: Horizon 8.2

Service Description

The service for fetching Workspace ONE Assist status or agent ID for a session.

Methods

Methods defined in this Service
WS1Assist_GetWS1AgentAssistStatus, WS1Assist_GetWS1AssistAgentId

WS1Assist_GetWS1AgentAssistStatus

Get the Workspace ONE Assist status from a session.

Privileges

Privilege	Description
MACHINE_VIEW	Machine read with the corresponding access group permission is sufficient to get a session's Workspace ONE Assist status.
POOL_VIEW	Desktop read with the corresponding access group permission is sufficient to get a session's Workspace ONE Assist status.
FEDERATED_SESSIONS_VIEW	Global session read is sufficient to get a session's Workspace ONE Assist status.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the WS1Assist used to make the method call.
id	SessionId	SessionID .

Return Value

Type	Description
WS1AssistAgentStatus	WS1AssistAgentStatus for the session.

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="WS1Assist_GetWS1AgentAssistStatus" type="vdi:WS1Assist_GetWS1AgentAssistStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="WS1Assist_GetWS1AgentAssistStatusResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:WS1AssistAgentStatus"/>
               </sequence>
            </complexType>
         </element>

WS1Assist_GetWS1AssistAgentId

Get the Workspace ONE Assist agent ID from a session.

Privileges

Privilege	Description
REMOTE_ASSISTANCE	privilege is required to get a Workspace ONE Assist token.
MACHINE_MANAGEMENT	is sufficient to get Workspace ONE Assist token.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the WS1Assist used to make the method call.
ws1AssistSessionSpec	WS1AssistSessionSpec

Return Value

Type	Description
WS1AssistAgentId	WS1AssistAgentId for the session

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.

Events

Event	Description
HELPDESK_GET_WS1_ASSIST_AGENT_ID	For local sessions, if a Workspace ONE Assist agent ID is successfully obtained.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="WS1Assist_GetWS1AssistAgentId" type="vdi:WS1Assist_GetWS1AssistAgentIdRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="WS1Assist_GetWS1AssistAgentIdResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:WS1AssistAgentId" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>