ComputeResourceSummary

ComputeResourceSummary
ComputeResourceSummary

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "totalCpu": 0,
    "totalMemory": 0,
    "numCpuCores": 0,
    "numCpuThreads": 0,
    "effectiveCpu": 0,
    "effectiveMemory": 0,
    "numHosts": 0,
    "numEffectiveHosts": 0,
    "overallStatus": "string"
}
integer As int32 As int32
totalCpu
Required

Aggregated CPU resources of all hosts, in MHz.

integer As int64 As int64
totalMemory
Required

Aggregated memory resources of all hosts, in bytes.

integer
numCpuCores
Required
Constraints: minimum: -32768 maximum: 32767

Number of physical CPU cores.

Physical CPU cores are the processors contained by a CPU package.

integer
numCpuThreads
Required
Constraints: minimum: -32768 maximum: 32767

Aggregated number of CPU threads.

integer As int32 As int32
effectiveCpu
Required

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.

integer As int64 As int64
effectiveMemory
Required

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.

integer As int32 As int32
numHosts
Required

Total number of hosts.

integer As int32 As int32
numEffectiveHosts
Required

Total number of effective hosts.

overallStatus
Required

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.

Property Of
Used By
Returned By