Service - GlobalSessionQueryService

Class: VMware.Hv.GlobalSessionQueryService
See also: DesktopId, GlobalEntitlementId, GlobalSessionPodSessionCounter, GlobalSessionQueryServiceCountSpec, GlobalSessionQueryServiceQuerySpec, PodId, QueryId, QueryResults, UserOrGroupId
Since: Horizon View 6.0

Service Description

Service that supports a pre-defined set of global session queries.

Methods

Methods defined in this Service
GlobalSessionQueryService_Delete, GlobalSessionQueryService_GetCount, GlobalSessionQueryService_GetCountWithSpec, GlobalSessionQueryService_GetNext, GlobalSessionQueryService_QueryByBrokeringPod, GlobalSessionQueryService_QueryByDesktop, GlobalSessionQueryService_QueryByPod, GlobalSessionQueryService_QueryByUser, GlobalSessionQueryService_QueryWithSpec

GlobalSessionQueryService_Delete

Deletes the server-side state associated with query. To be used after queryByuser, queryByPod, queryByBrokeringPod, queryByDesktop and queryBySpec.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
id	QueryId	from a result set.

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

GlobalSessionQueryService_GetCount

Deprecated. use #getCountWithSpec(CountSpec) instead

Returns global session count for combination of parameters. All criteria are optional, though at least one must be specified.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to return a count of query results.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
user	UserOrGroupId	unique identifier for user or group Optional parameter. If not specifing any value, this should be set to null.
pod	PodId	unique identifier for pod Optional parameter. If not specifing any value, this should be set to null.
brokeringPod	PodId	unique identifier for brokering pod Optional parameter. If not specifing any value, this should be set to null.
globalEntitlement	GlobalEntitlementId	unique identifier for global entitlement Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
GlobalSessionPodSessionCounter[]	PodSessionCounter with session counts broken down by pods

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="GlobalSessionQueryService_GetCount" type="vdi:GlobalSessionQueryService_GetCountRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_GetCountResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalSessionPodSessionCounter" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_GetCountWithSpec

Returns global session count for combination of parameters. All criteria are optional, though at least one must be specified.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to return a count of query results.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
countSpec	GlobalSessionQueryServiceCountSpec

Return Value

Type	Description
GlobalSessionPodSessionCounter[]	PodSessionCounter with session counts broken down by pods

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.
InvalidRequest	Thrown if both globalEntitlement and globalApplicationEntitlement are set to non null values. If any two or more fields of user, pod, brokeringPod, desktop, clientName are set to non null values.
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="GlobalSessionQueryService_GetCountWithSpec" type="vdi:GlobalSessionQueryService_GetCountWithSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_GetCountWithSpecResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:GlobalSessionPodSessionCounter" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_GetNext

Gets next page from query. To be used with queryByUser, queryByPod, queryByBrokeringPod, queryByDesktop and queryBySpec.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
id	QueryId	from a result set.

Return Value

Type	Description
QueryResults	next page of results.

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="GlobalSessionQueryService_GetNext" type="vdi:GlobalSessionQueryService_GetNextRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_GetNextResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:QueryResults"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_QueryByBrokeringPod

Deprecated. use #queryWithSpec(QuerySpec) instead

Queries global sessions by brokering pod. Create a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted. Server side state will also time out eventually.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to query by brokering pod.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
pod	PodId	unique identifier for brokering pod
globalEntitlement	GlobalEntitlementId	unique identifier for global entitlement Optional parameter. If not specifing any value, this should be set to null.
sortBy	xsd:string	Member name to sort results by. Optional parameter. If not specifing any value, this should be set to null.
sortDescending	xsd:boolean	Sort order: false (ascending) by default. Optional parameter. If not specifing any value, this should be set to null.
maxPageSize	xsd:int	Maximum page size to return (the server may use a smaller size). Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
QueryResults	one page of results.

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="GlobalSessionQueryService_QueryByBrokeringPod" type="vdi:GlobalSessionQueryService_QueryByBrokeringPodRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_QueryByBrokeringPodResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:QueryResults"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_QueryByDesktop

Deprecated. use #queryWithSpec(QuerySpec) instead

Queries global sessions by desktop and GE for local pod. Create a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted. Server side state will also time out eventually.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to query by desktop.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
desktop	DesktopId	unique identifier for desktop
globalEntitlement	GlobalEntitlementId	unique identifier for global entitlement Optional parameter. If not specifing any value, this should be set to null.
sortBy	xsd:string	Member name to sort results by. Optional parameter. If not specifing any value, this should be set to null.
sortDescending	xsd:boolean	Sort order: false (ascending) by default. Optional parameter. If not specifing any value, this should be set to null.
maxPageSize	xsd:int	Maximum page size to return (the server may use a smaller size). Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
QueryResults	one page of results.

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="GlobalSessionQueryService_QueryByDesktop" type="vdi:GlobalSessionQueryService_QueryByDesktopRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_QueryByDesktopResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:QueryResults"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_QueryByPod

Deprecated. use #queryWithSpec(QuerySpec) instead

Queries sessions by resource/destination pod. Create a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted. Server side state will also time out eventually.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to query by resource/destination pod.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
pod	PodId	unique identifier for pod
globalEntitlement	GlobalEntitlementId	unique identifier for global entitlement Optional parameter. If not specifing any value, this should be set to null.
sortBy	xsd:string	Member name to sort results by. Optional parameter. If not specifing any value, this should be set to null.
sortDescending	xsd:boolean	Sort order: false (ascending) by default. Optional parameter. If not specifing any value, this should be set to null.
maxPageSize	xsd:int	Maximum page size to return (the server may use a smaller size). Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
QueryResults	one page of results.

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="GlobalSessionQueryService_QueryByPod" type="vdi:GlobalSessionQueryService_QueryByPodRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_QueryByPodResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:QueryResults"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_QueryByUser

Deprecated. use #queryWithSpec(QuerySpec) instead

Queries global sessions by user. Create a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted. Server side state will also time out eventually.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to query by user.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
user	UserOrGroupId	unique identifier for user
globalEntitlement	GlobalEntitlementId	unique identifier for global entitlement Optional parameter. If not specifing any value, this should be set to null.
sortBy	xsd:string	Member name to sort results by. Optional parameter. If not specifing any value, this should be set to null.
sortDescending	xsd:boolean	Sort order: false (ascending) by default. Optional parameter. If not specifing any value, this should be set to null.
maxPageSize	xsd:int	Maximum page size to return (the server may use a smaller size). Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
QueryResults	one page of results.

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="GlobalSessionQueryService_QueryByUser" type="vdi:GlobalSessionQueryService_QueryByUserRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_QueryByUserResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:QueryResults"/>
               </sequence>
            </complexType>
         </element>

GlobalSessionQueryService_QueryWithSpec

Queries global sessions based on QuerySpec . Creates a cursor for iterating though query results efficiently, and return the first set of results. Creates server-side state which should be explicitly deleted. Server side state will also time out eventually.

Privileges

Privilege	Description
FEDERATED_SESSIONS_VIEW	Global session read is required to query by user.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GlobalSessionQueryService used to make the method call.
querySpec	GlobalSessionQueryServiceQuerySpec	querySpec to filter the results

Return Value

Type	Description
QueryResults	one page of results.

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.
InvalidRequest	Thrown if both globalEntitlement and globalApplicationEntitlement are set to non null values. If any two or more fields of user, pod, brokeringPod, desktop, clientName are set to non null values.
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="GlobalSessionQueryService_QueryWithSpec" type="vdi:GlobalSessionQueryService_QueryWithSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="GlobalSessionQueryService_QueryWithSpecResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:QueryResults" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>