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

Name

Type

Description

_this

ManagedObjectReference

A reference to the Performance used to make the method call.

SessionId

SessionID to get the performance data for.

timestamp

xsd: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
PerformanceInfo	performance data collected since the given time stamp.

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_Get" type="vdi:Performance_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:PerformanceInfo"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the Performance used to make the method call.
id	SessionId	SessionID to get the protocol performance data for.

Return Value

Type	Description
DisplayProtocolPerformanceData	Protocol performance data collected.

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetDisplayProtocolPerformanceData" type="vdi:Performance_GetDisplayProtocolPerformanceDataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetDisplayProtocolPerformanceDataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:DisplayProtocolPerformanceData"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the Performance used to make the method call.
id	SessionId	SessionID to get the performance data for.

Return Value

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

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetHistoricalPerformanceData" type="vdi:Performance_GetHistoricalPerformanceDataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetHistoricalPerformanceDataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:HistoricalPerformanceData" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name

Type

Description

_this

ManagedObjectReference

A reference to the Performance used to make the method call.

SessionId

SessionID to get the process performance data for.

processFilter

ProcessFilter

A filter to filter the processes in remote virtual machine.

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
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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetProcessPerformanceData" type="vdi:Performance_GetProcessPerformanceDataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetProcessPerformanceDataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ProcessPerformanceData" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the Performance used to make the method call.
id	SessionId	SessionID to get the remote application statistics for.

Return Value

Type	Description
RemoteApplicationStatistics[]	Remote application statistics.

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetRemoteApplicationPerformanceData" type="vdi:Performance_GetRemoteApplicationPerformanceDataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetRemoteApplicationPerformanceDataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RemoteApplicationStatistics" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the Performance used to make the method call.
id	SessionId	SessionID to get the remote application statistics for.

Return Value

Type	Description
RemoteApplicationStatistics[]	Remote application statistics.

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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetRemoteApplicationStatistics" type="vdi:Performance_GetRemoteApplicationStatisticsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="Performance_GetRemoteApplicationStatisticsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RemoteApplicationStatistics" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>