Files
deb-python-pyvmomi/docs/vim/ComputeResource/Summary.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
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
2014-06-17 14:07:42 -04:00

2.6 KiB

vim.ComputeResource.Summary

This data object type encapsulates a typical set of ComputeResource information that is useful for list views and summary pages.

extends

vmodl.DynamicData

Attributes:

totalCpu (int):

Aggregated CPU resources of all hosts, in MHz.

totalMemory (long):

Aggregated memory resources of all hosts, in bytes.

numCpuCores (short):

Number of physical CPU cores. Physical CPU cores are the processors contained by a CPU package.

numCpuThreads (short):

Aggregated number of CPU threads.

effectiveCpu (int):

Effective CPU resources (in MHz) available to run virtual machines. This is the aggregated effective resource level from all running hosts. Hosts that are in maintenance mode or are unresponsive are not counted. Resources used by the VMware Service Console are not included in the aggregate. This value represents the amount of resources available for the root resource pool for running virtual machines.

effectiveMemory (long):

Effective memory resources (in MB) available to run virtual machines. This is the aggregated effective resource level from all running hosts. Hosts that are in maintenance mode or are unresponsive are not counted. Resources used by the VMware Service Console are not included in the aggregate. This value represents the amount of resources available for the root resource pool for running virtual machines.

numHosts (int):

Total number of hosts.

numEffectiveHosts (int):

Total number of effective hosts.

overallStatus (vim.ManagedEntity.Status):

Overall alarm status. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.