Compute Resource Get Summary

Compute Resource Get Summary

Basic runtime information about a compute resource.

This information is used on summary screens and in list views.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/ComputeResource/{moId}/summary
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case ComputeResource/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ComputeResourceSummary of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_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

Number of physical CPU cores.

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

integer
numCpuThreads
Required

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

The Status enumeration defines a general "health" value for a managed entity.

Possible values:

  • gray: The status is unknown.
  • green: The entity is OK.
  • yellow: The entity might have a problem.
  • red: The entity definitely has a problem.
Possible values are : gray, green, yellow, red,