Service - Performance

Class
VMware.Hv.Performance
See also
DisplayProtocolPerformanceData, HistoricalPerformanceData, PerformanceInfo, ProcessFilter, ProcessPerformanceData, RemoteApplicationStatistics, SessionId
Since
Horizon 7.2


Service Description

The service for fetching performance information.

Methods

Methods defined in this Service
Performance_Get, Performance_GetDisplayProtocolPerformanceData, Performance_GetHistoricalPerformanceData, Performance_GetProcessPerformanceData, Performance_GetRemoteApplicationPerformanceData, Performance_GetRemoteApplicationStatistics

Performance_Get

Deprecated. New code should use #getProcessPerformanceData(SessionId) or #getDisplayProtocolPerformanceData(SessionId) if you just want to retrieve the latest performance data.

Retrieves performance data from the given time point to current time. When firstly calling this method, the timestamp should be set to 0, the agent will return one or more performance data with a timestamp indicating the time when the last performance data was obtained. From that time, the agent will collect the performance data periodically(1 second) and keep them in memory. When getting another request, the agent will check the parameter timestamp, it will return all the performance data from the timestamp to current time. If the timestamp is not set, the agent will return all the performance data it has collected. The agent will stop the collection if there are no requests received after a long period(default is 2 minutes).

Privileges

Privilege Description
MACHINE_VIEW Machine read with the corresponding access group permission is sufficient to get a session's performance information.
POOL_VIEW Desktop read with the corresponding access group permission is sufficient to get a session's performance information.
FEDERATED_SESSIONS_VIEW Global session read is sufficient to get a session's performance information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Performance used to make the method call.
idSessionId

SessionID to get the performance data for.
timestampxsd:long

The time point after which performance data should be obtained.
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
PerformanceInfoperformance data collected since the given time stamp.

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



Performance_GetDisplayProtocolPerformanceData

Retrieves performance data of the current session display protocol (PCoIP or BLAST).

Privileges

Privilege Description
MACHINE_VIEW Machine read with the corresponding access group permission is sufficient to get a session's protocol performance information.
POOL_VIEW Desktop read with the corresponding access group permission is sufficient to get a session's protocol performance information.
FEDERATED_SESSIONS_VIEW Global session read is sufficient to get a session's protocol performance information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Performance used to make the method call.
idSessionId

SessionID to get the protocol performance data for.

Return Value

Type Description
DisplayProtocolPerformanceDataProtocol performance data collected.

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



Performance_GetHistoricalPerformanceData

Retrieves historical performance data of the specific session in latest 15 minutes. The sampling period is 5 seconds. So it returns 180 samples in this response.

Privileges

Privilege Description
MACHINE_VIEW Machine read with the corresponding access group permission is sufficient to get a session's performance information.
POOL_VIEW Desktop read with the corresponding access group permission is sufficient to get a session's performance information.
FEDERATED_SESSIONS_VIEW Global session read is sufficient to get a session's performance information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Performance used to make the method call.
idSessionId

SessionID to get the performance data for.

Return Value

Type Description
HistoricalPerformanceData[]Historical performance data collected in latest 15 minutes.

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



Performance_GetProcessPerformanceData

Retrieves the process performance data.

Privileges

Privilege Description
MACHINE_VIEW Machine read with the corresponding access group permission is sufficient to get a session's process performance information.
POOL_VIEW Desktop read with the corresponding access group permission is sufficient to get a session's process performance information.
FEDERATED_SESSIONS_VIEW Global session read is sufficient to get a session's process performance information.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Performance used to make the method call.
idSessionId

SessionID to get the process performance data for.
processFilterProcessFilter

A filter to filter the processes in remote virtual machine.

Since Horizon 7.6
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
ProcessPerformanceData[]Process performance data collected. Will return all processes on the remote virtual machine if processFilter is not set.

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



Performance_GetRemoteApplicationPerformanceData

Deprecated. use #getRemoteApplicationStatistics(SessionId) instead.

Retrieves the remote applications statistics.

Privileges

Privilege Description
MACHINE_VIEW Machine read with the corresponding access group permission is sufficient to get a session's remote application statistics.
POOL_VIEW Desktop read with the corresponding access group permission is sufficient to get a session's remote application statistics.
FEDERATED_SESSIONS_VIEW Global session read is sufficient to get a session's remote application statistics.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Performance used to make the method call.
idSessionId

SessionID to get the remote application statistics for.

Return Value

Type Description
RemoteApplicationStatistics[]Remote application statistics.

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



Performance_GetRemoteApplicationStatistics

Retrieves the remote applications statistics.

Privileges

Privilege Description
MACHINE_VIEW Machine read with the corresponding access group permission is sufficient to get a session's remote application statistics.
POOL_VIEW Desktop read with the corresponding access group permission is sufficient to get a session's remote application statistics.
FEDERATED_SESSIONS_VIEW Global session read is sufficient to get a session's remote application statistics.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Performance used to make the method call.
idSessionId

SessionID to get the remote application statistics for.

Return Value

Type Description
RemoteApplicationStatistics[]Remote application statistics.

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