Service - Monitoring

Class
VMware.Hv.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

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

NameTypeDescription
_thisManagedObjectReference A reference to the Monitoring used to make the method call.
idsDesktopId[]

list of desktops.

Return Value

Type Description
DesktopCounter[]The desktops counter.

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



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

NameTypeDescription
_thisManagedObjectReference A reference to the Monitoring used to make the method call.
idGlobalEntitlementId

unique identifier for global entitlement

Return Value

Type Description
GECounterThe global entitlement counter.

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



Monitoring_GetHealthCounters

Gets the health status related information for all the components.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Monitoring used to make the method call.

Return Value

Type Description
HealthCounter[]The component's health counters.

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



Monitoring_GetSystemStatusCounter

Gets the system status counter of all the categories.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Monitoring used to make the method call.

Return Value

Type Description
SystemStatusCounterThe system status counter.

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



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:

Privileges

Privilege Description
FEDERATED_SESSIONS_VIEW Global session read is required to read the information related to pods.

Parameters

NameTypeDescription
_thisManagedObjectReference 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
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.
InvalidStateThrown if the Pod Federation has not been initialized.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition