Service - Monitoring
Java Class
com.omnissa.vdi.vlsi.binding.vdi.health.Monitoring
See also
DesktopCounter, DesktopId, GECounter, GlobalEntitlementId, HealthCounter, PodSessionCounter, SystemStatusCounter
Since
Horizon 7.9
Service Description¶
Service for retrieving the monitoring information.
Methods
Methods defined in this Service: Monitoring_GetDesktopCounters, Monitoring_GetGECounter, Monitoring_GetHealthCounters, Monitoring_GetSystemStatusCounter, Monitoring_ListPodSessionCounters
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Monitoring used to make the method call. |
| ids | DesktopId[] | list of desktops. |
Return Value
| Type | Description |
|---|---|
| DesktopCounter[] | The desktops 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Monitoring used to make the method call. |
| id | GlobalEntitlementId | unique identifier for global entitlement |
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
Gets the health status related information for all the components.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Monitoring used to make the method call. |
Return Value
| Type | Description |
|---|---|
| HealthCounter[] | The component's health counters. |
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
Gets the system status counter of all the categories.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Monitoring used to make the method call. |
Return Value
| Type | Description |
|---|---|
| SystemStatusCounter | The system status 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
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: 1 2
Privileges
| Privilege | Description |
|---|---|
| FEDERATED_SESSIONS_VIEW | Global session read is required to read the information related to pods. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the Monitoring used to make the method call. |
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
-
For those pods running on older version(before 7.12.0), the values for numHostedSessions and numBrokeredSessions will not be set. ↩
-
When there is at least one Pod running on older version(before 7.12.0), numBrokeredSessions for all the pods will not be set. ↩