ClusterComputeResourceSummary

ClusterComputeResourceSummary
ClusterComputeResourceSummary

The ClusterComputeResourceSummary data object encapsulates runtime properties of a ClusterComputeResource.

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",
    "currentFailoverLevel": 0,
    "admissionControlInfo": {
        "_typeName": "string"
    },
    "numVmotions": 0,
    "targetBalance": 0,
    "currentBalance": 0,
    "drsScore": 0,
    "numVmsPerDrsScoreBucket": [
        0
    ],
    "usageSummary": {
        "_typeName": "string",
        "totalCpuCapacityMhz": 0,
        "totalMemCapacityMB": 0,
        "cpuReservationMhz": 0,
        "memReservationMB": 0,
        "poweredOffCpuReservationMhz": 0,
        "poweredOffMemReservationMB": 0,
        "cpuDemandMhz": 0,
        "memDemandMB": 0,
        "statsGenNumber": 0,
        "cpuEntitledMhz": 0,
        "memEntitledMB": 0,
        "poweredOffVmCount": 0,
        "totalVmCount": 0,
        "tier0MemCapacityMB": 0,
        "reservedTier0MemMB": 0,
        "unreservedTier0MemMB": 0
    },
    "currentEVCModeKey": "string",
    "currentEVCGraphicsModeKey": "string",
    "dasData": {
        "_typeName": "string"
    },
    "clusterMaintenanceModeStatus": "string",
    "vcsHealthStatus": "string",
    "vcsSlots": [
        {
            "_typeName": "string",
            "systemId": "string",
            "host": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "datastore": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                }
            ],
            "totalSlots": 0
        }
    ]
}
integer As int32 As int32
currentFailoverLevel
Required

Deprecated as of vSphere API 4.0, use ClusterFailoverLevelAdmissionControlInfo.currentFailoverLevel.

Current failover level.

This is the number of physical host failures that can be tolerated without impacting the ability to satisfy the minimums for all running virtual machines. This represents the current value, as opposed to desired value configured by the user.

admissionControlInfo
Optional

Information about the current amount of resources available for a vSphere HA cluster.

The actual type of admissionControlInfo will depend on what kind of ClusterDasAdmissionControlPolicy was used to configure the cluster.

integer As int32 As int32
numVmotions
Required

Total number of migrations with VMotion that have been done internal to this cluster.

integer As int32 As int32
targetBalance
Optional

The target balance, in terms of standard deviation, for a DRS cluster.

Units are thousandths. For example, 12 represents 0.012.

integer As int32 As int32
currentBalance
Optional

The current balance, in terms of standard deviation, for a DRS cluster.

Units are thousandths. For example, 12 represents 0.012.

integer As int32 As int32
drsScore
Optional

The DRS score of this cluster, in percentage.

array of integer
numVmsPerDrsScoreBucket
Optional

The number of VMs in this cluster corresponding to each DRS score bucket.

The buckets are defined as follows:

  • 0% - 20%
  • 21% - 40%
  • 41% - 60%
  • 61% - 80%
  • 81% - 100%
usageSummary
Optional

The current usage summary for a DRS cluster.

string
currentEVCModeKey
Optional

The Enhanced VMotion Compatibility mode that is currently in effect for all hosts in this cluster; unset if no EVC mode is active.

See also Capability.supportedEVCMode.

string
currentEVCGraphicsModeKey
Optional

The Enhanced VMotion Compatibility Graphics mode that is currently in effect for all hosts in this cluster; unset if no EVC mode is active.

See also Capability.supportedEVCGraphicsMode.

Since: vSphere API Release 7.0.1.0

dasData
Optional

Data pertaining to DAS.

string
clusterMaintenanceModeStatus
Optional

Configuration pertinent to state of the cluster maintenance mode.

Valid values are enumerated by the ClusterMaintenanceModeStatus type.

Since: vSphere API Release 7.0.0.2

string
vcsHealthStatus
Optional

Deprecated as of vSphere 9.0 with no replacement. In a future release of vSphere, the vCLS functionality will be disabled, vCLS system VMs will be deleted, and vCLS APIs will be removed.

The health status of the vSphere Cluster Services in the cluster.

Supported values are enumerated by the VcsHealthStatus type.

Since: vSphere API Release 7.0.1.1

array of ClusterComputeResourceVcsSlots
vcsSlots
Optional

Deprecated as of vSphere 9.0 with no replacement. In a future release of vSphere, the vCLS functionality will be disabled, vCLS system VMs will be deleted, and vCLS APIs will be removed.

An array of hosts and number of resource slots on the host for vSphere Cluster Services in the cluster.

The number of resource slots on the host includes both following types: 1. Number of vCS VMs running on the host (resource reserved and occupied). 2. Number of reserved and unoccupied slots (reserved for new vCS VMs).

Since: vSphere API Release 7.0.1.1

Property Of
Returned By