Managed Object - PerformanceManager

Property of
ServiceContent
See also
PerfCompositeMetric, PerfCounterInfo, PerfEntityMetricBase, PerfInterval, PerfMetricId, PerformanceDescription, PerformanceManagerCounterLevelMapping, PerfProviderSummary, PerfQuerySpec
Since
null


Managed Object Description

Properties

Name Type Description
description PPerformanceDescription


historicalInterval* PPerfInterval[]


perfCounter* PPerfCounterInfo[]


*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
CreatePerfInterval, QueryAvailablePerfMetric, QueryPerf, QueryPerfComposite, QueryPerfCounter, QueryPerfCounterByLevel, QueryPerfProviderSummary, RemovePerfInterval, ResetCounterLevelMapping, UpdateCounterLevelMapping, UpdatePerfInterval

CreatePerfInterval

Deprecated.

Required Privileges
Performance.ModifyIntervals

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
intervalId PPerfInterval

Since null
P Required privilege: intervalId

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryAvailablePerfMetric

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
entity PManagedObjectReference

Since null
beginTime* Pxsd:dateTime

Since null
endTime* Pxsd:dateTime

Since null
intervalId* Pxsd:int

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
PerfMetricId[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryPerf

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
querySpec PPerfQuerySpec[]

Since null
P Required privilege: querySpec

Return Value

Type Description
PerfEntityMetricBase[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryPerfComposite

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
querySpec PPerfQuerySpec

Since null
P Required privilege: querySpec

Return Value

Type Description
PerfCompositeMetric

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryPerfCounter

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
counterId Pxsd:int[]

Since null
P Required privilege: counterId

Return Value

Type Description
PerfCounterInfo[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryPerfCounterByLevel

Required Privileges
System.View
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
level Pxsd:int

Since VI API 2.5
P Required privilege: level

Return Value

Type Description
PerfCounterInfo[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryPerfProviderSummary

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
entity PManagedObjectReference

Since null
P Required privilege: entity

Return Value

Type Description
PerfProviderSummary

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RemovePerfInterval

Deprecated.

Required Privileges
Performance.ModifyIntervals

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
samplePeriod Pxsd:int

Since null
P Required privilege: samplePeriod

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ResetCounterLevelMapping

Required Privileges
Performance.ModifyIntervals
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
counters Pxsd:int[]

Since vSphere API 4.1
P Required privilege: counters

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



UpdateCounterLevelMapping

Required Privileges
Performance.ModifyIntervals
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
counterLevelMap PPerformanceManagerCounterLevelMapping[]

Since vSphere API 4.1
P Required privilege: counterLevelMap

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



UpdatePerfInterval

Required Privileges
Performance.ModifyIntervals

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PerformanceManager used to make the method call.
interval PPerfInterval

Since null
P Required privilege: interval

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None