15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
2.6 KiB
vim.PerformanceManager.ProviderSummary
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 boththe currentSupported and summarySupported properties are not mutually exclusive).
- extends
- Attributes:
-
entity (vmodl.ManagedObject):
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 .
currentSupported (bool):
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 intervalId of the PerfQuerySpec (passed to the QueryPerf operation) to the refreshRate to obtain the maximum information possible for the entity.
summarySupported (bool):
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 intervalId of QueryPerf to one of the historical intervals to obtain historical statistics for this entity.
refreshRate (int, optional):
Number of seconds between the generation of each counter. This value applies only to entities that support real-time (current) statistics