PerfProviderSummary

PerfProviderSummary
PerfProviderSummary

This data object type contains information about a performance provider, the type of statistics it generates, and the refreshRate for statistics generation.

A performance provider is any managed object that generates real-time or historical statistics (or both—the currentSupported and summarySupported properties are not mutually exclusive).

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "currentSupported": false,
    "summarySupported": false,
    "refreshRate": 0
}
entity
Required

Reference to the performance provider, the managed object that provides real-time or historical metrics.

The managed objects include but are not limited to managed entities, such as host systems, virtual machines, and resource pools.

boolean
currentSupported
Required

True if this entity supports real-time (current) statistics; false if it does not.

If this property is true for an entity, a client application can set the PerfQuerySpec.intervalId of the PerfQuerySpec (passed to the PerformanceManager.QueryPerf operation) to the PerfProviderSummary.refreshRate to obtain the maximum information possible for the entity.

boolean
summarySupported
Required

True if this entity supports historical (aggregated) statistics; false if it does not.

When this property is true for an entity, a client application can set the PerfQuerySpec.intervalId of PerformanceManager.QueryPerf to one of the historical intervals to obtain historical statistics for this entity.

integer As int32 As int32
refreshRate
Optional

Number of seconds between the generation of each counter.

This value applies only to entities that support real-time (current) statistics.

Property Of
Returned By