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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
idQueryId

from a result set.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
userUserOrGroupId

unique identifier for user or group
  • Optional parameter. If not specifing any value, this should be set to null.
podPodId

unique identifier for pod
  • Optional parameter. If not specifing any value, this should be set to null.
brokeringPodPodId

unique identifier for brokering pod
  • Optional parameter. If not specifing any value, this should be set to null.
globalEntitlementGlobalEntitlementId

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
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
countSpecGlobalSessionQueryServiceCountSpec



Return Value

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

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestThrown if both globalEntitlement and globalApplicationEntitlement are set to non null values.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



GlobalSessionQueryService_GetNext

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
idQueryId

from a result set.

Return Value

Type Description
QueryResultsnext page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
podPodId

unique identifier for brokering pod
globalEntitlementGlobalEntitlementId

unique identifier for global entitlement
  • Optional parameter. If not specifing any value, this should be set to null.
sortByxsd:string

Member name to sort results by.
  • Optional parameter. If not specifing any value, this should be set to null.
sortDescendingxsd:boolean

Sort order: false (ascending) by default.
  • Optional parameter. If not specifing any value, this should be set to null.
maxPageSizexsd: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
QueryResultsone page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
desktopDesktopId

unique identifier for desktop
globalEntitlementGlobalEntitlementId

unique identifier for global entitlement
  • Optional parameter. If not specifing any value, this should be set to null.
sortByxsd:string

Member name to sort results by.
  • Optional parameter. If not specifing any value, this should be set to null.
sortDescendingxsd:boolean

Sort order: false (ascending) by default.
  • Optional parameter. If not specifing any value, this should be set to null.
maxPageSizexsd: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
QueryResultsone page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
podPodId

unique identifier for pod
globalEntitlementGlobalEntitlementId

unique identifier for global entitlement
  • Optional parameter. If not specifing any value, this should be set to null.
sortByxsd:string

Member name to sort results by.
  • Optional parameter. If not specifing any value, this should be set to null.
sortDescendingxsd:boolean

Sort order: false (ascending) by default.
  • Optional parameter. If not specifing any value, this should be set to null.
maxPageSizexsd: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
QueryResultsone page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
userUserOrGroupId

unique identifier for user
globalEntitlementGlobalEntitlementId

unique identifier for global entitlement
  • Optional parameter. If not specifing any value, this should be set to null.
sortByxsd:string

Member name to sort results by.
  • Optional parameter. If not specifing any value, this should be set to null.
sortDescendingxsd:boolean

Sort order: false (ascending) by default.
  • Optional parameter. If not specifing any value, this should be set to null.
maxPageSizexsd: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
QueryResultsone page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



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

NameTypeDescription
_thisManagedObjectReference A reference to the GlobalSessionQueryService used to make the method call.
querySpecGlobalSessionQueryServiceQuerySpec

querySpec to filter the results

Return Value

Type Description
QueryResultsone page of results.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidRequestthrown if both globalEntitlement and globalApplicationEntitlement are set to non null values.
If any two or more fields of user, pod, brokeringPod, desktop are set to non null values
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition