vSphere Web Services API

		Local Properties
Managed Object Types	Data Object Types	All Properties	All Methods

Data Object - PerfCounterInfo(vim.PerformanceManager.CounterInfo)

Property of

PerformanceManager

Returned by

QueryPerfCounter, QueryPerfCounterByLevel

Extends

DynamicData

See also

ElementDescription, PerfStatsType, PerfSummaryType

Since

2.0

Data Object Description

This data object type contains metadata for a performance counter. See PerformanceManager for definitions of available counters.

Properties

Name	Type	Description
associatedCounterId*	xsd:int[]	Deprecated. As of VI API 2.5, this property is not used. The counter IDs associated with the same performance counter name for the same device type. For example, the rollup types for CPU Usage for a host are average, minimum, and maximum. Therefore, their counter IDs are associated.
groupInfo	ElementDescription	The group of the performance counter with its label and summary details. Counter groups include "cpu," "mem," "net," "disk," "system," "rescpu," and "clusterServices," for example.
key	xsd:int	A system-generated number that uniquely identifies the counter in the context of the system. The performance counter ID.
level*	xsd:int	Minimum level at which metrics of this type will be collected by VirtualCenter Server. The value for this property for any performance counter is a number from 1 to 4. The higher the setting, the more data is collected by VirtualCenter Server. The default setting for VirtualCenter Server is 1, which collects the minimal amount of performance data that is typically useful to administrators and developers alike. The specific level of each counter is documented in the respective counter-documentation pages, by group. See PerformanceManager for links to the counter group pages. Since VI API 2.5
nameInfo	ElementDescription	The name of the counter with label and summary details. For example, the counter with name "usage" for the "cpu" group of performance counters.
perDeviceLevel*	xsd:int	Minimum level at which the per device metrics of this type will be collected by vCenter Server. The value for this property for any performance counter is a number from 1 to 4. By default all per device metrics are calculated at level 3 or more. If a certain per device counter is collected at a certain level, the aggregate metric is also calculated at that level, i.e., perDeviceLevel is greater than or equal to level. Since vSphere API Release 4.1
rollupType	PerfSummaryType	The counter type. Valid values include average, maximum, minimum, latest, summation, or none. This determines the type of statistical values that are returned for the counter. None means that the counter is never rolled up.
statsType	PerfStatsType	Statistics type for the counter. Valid values include absolute, delta, or rate.
unitInfo	ElementDescription	The unit for the values of the performance counter with its label and summary details. See PerformanceManagerUnit for a description of the valid values.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="PerfCounterInfo"> <complexContent> <extension base="vim25:DynamicData"> <sequence> <element name="key" type="xsd:int"/> <element name="nameInfo" type="vim25:ElementDescription"/> <element name="groupInfo" type="vim25:ElementDescription"/> <element name="unitInfo" type="vim25:ElementDescription"/> <element name="rollupType" type="vim25:PerfSummaryType"/> <element name="statsType" type="vim25:PerfStatsType"/> <element name="level" type="xsd:int" minOccurs="0"/> <element name="perDeviceLevel" type="xsd:int" minOccurs="0"/> <element name="associatedCounterId" type="xsd:int" minOccurs="0" maxOccurs="unbounded"/> </sequence> </extension> </complexContent> </complexType>

Top of page		Local Properties
Managed Object Types	Data Object Types	All Properties	All Methods