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 P	PerformanceDescription
historicalInterval* P	PerfInterval[]
perfCounter* P	PerfCounterInfo[]

Name

Type

Description

description P

PerformanceDescription

historicalInterval* P

PerfInterval[]

perfCounter* P

PerfCounterInfo[]

*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

Name

Type

Description

_this

ManagedObjectReference

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

intervalId P

PerfInterval

Since null

P Required privilege: intervalId

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

Name	Type	Description
_this	ManagedObjectReference	A reference to the PerformanceManager used to make the method call.
entity P	ManagedObjectReference	*Since* null
beginTime* P	xsd:dateTime	*Since* null
endTime* P	xsd:dateTime	*Since* null
intervalId* P	xsd:int	*Since* null

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

Return Value

Type	Description
PerfMetricId[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

querySpec P

PerfQuerySpec[]

Since null

P Required privilege: querySpec

Return Value

Type	Description
PerfEntityMetricBase[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

querySpec P

PerfQuerySpec

Since null

P Required privilege: querySpec

Return Value

Type	Description
PerfCompositeMetric

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

counterId P

xsd:int[]

Since null

P Required privilege: counterId

Return Value

Type	Description
PerfCounterInfo[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

level P

xsd:int

Since VI API 2.5

P Required privilege: level

Return Value

Type	Description
PerfCounterInfo[]

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

entity P

ManagedObjectReference

Since null

P Required privilege: entity

Return Value

Type	Description
PerfProviderSummary

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

samplePeriod P

xsd:int

Since null

P Required privilege: samplePeriod

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

counters P

xsd:int[]

Since vSphere API 4.1

P Required privilege: counters

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

counterLevelMap P

PerformanceManagerCounterLevelMapping[]

Since vSphere API 4.1

P Required privilege: counterLevelMap

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown 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

Name

Type

Description

_this

ManagedObjectReference

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

interval P

PerfInterval

Since null

P Required privilege: interval

Return Value

Type	Description
None

Faults

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

Events

Type
None