Service -
Monitoring
- Class
- VMware.Hv.Monitoring
- See also
-
APIMetricsInfo, DesktopCounter, DesktopId, GECounter, GlobalEntitlementId, HealthCounter, PodSessionCounter, SystemStatusCounter
- Since
- Horizon 7.9
Service Description
Service for retrieving the monitoring information.
Methods
Monitoring_GetAPIMetrics
Retrieves information about the services and their counts called from this
connection server.
Parameters
Return Value
Type
|
Description
|
APIMetricsInfo | The number of times the APIs have been called in the connection server since the service start. |
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
Monitoring_GetDesktopCounters
Gets the counter for the list of desktops (except RDS desktops).
Privileges
Privilege
|
Description
|
POOL_VIEW |
Desktop read privilege with the corresponding access
group permission is required to read desktops.
|
Parameters
Return Value
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
Monitoring_GetGECounter
Gets the counter for the given global entitlement.
Privileges
Privilege
|
Description
|
FEDERATED_LDAP_VIEW |
Global LDAP read is required to read a
global entitlement.
|
POOL_VIEW |
privilege is required to read the local desktop(s)
in a global entitlement.
|
Parameters
Return Value
Type
|
Description
|
GECounter | The global entitlement counter. |
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
Monitoring_GetHealthCounters
Gets the health status related information for all the components.
Parameters
Return Value
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
Monitoring_GetSystemStatusCounter
Gets the system status counter of all the categories.
Parameters
Return Value
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
Monitoring_ListPodSessionCounters
Lists the global session counts related to all Pods in the Pod
Federation. This considers the sessions launched using Desktop or
Application that are part of Global Entitlement and Global Application
Entitlement. Following conditions apply:
- For those pods running on older version(before 7.12.0), the values
for numHostedSessions and
numBrokeredSessions will not be set.
- When there is atleast one Pod running on older version(before
7.12.0), numBrokeredSessions for the all the pods will not be set.
Privileges
Privilege
|
Description
|
FEDERATED_SESSIONS_VIEW |
Global session read is required to
read the information related to pods.
|
Parameters
Return Value
Type
|
Description
|
PodSessionCounter[] | The global session counts for all the Pods in Pod Federation. |
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. |
InvalidState | Thrown if the Pod Federation has not been initialized. |
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
© 2023 VMware, Inc. All rights reserved.
Revision Mar-2023 Version 8.9.0