Cluster Compute Resource Get Summary Ex

Cluster Compute Resource Get Summary Ex

Deprecated do not use this property. The same information could be obtained via summary.

The cluster summary.

Since: vSphere API Release 7.0.1.1

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/summaryEx
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 ClusterComputeResource/{moId}.

string
release
Required

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


Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Base class for admission control related information of a vSphere HA 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

This class contains cluster usage summary that is populated by DRS and used by Cloud Placement Engine in VCD.

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

Base class for DAS data for high availability service for a cluster.

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

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

vcsSlots
Optional

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


Availability
Added in vSphere API Release 7.0.1.1
Cluster Compute Resource Operations
POST
Cluster Compute Resource Abandon Hci Workflow
POST
Cluster Compute Resource Add Host Task
POST
Cluster Compute Resource Apply Recommendation
POST
Cluster Compute Resource Cancel Recommendation
POST
Cluster Compute Resource Cluster Enter Maintenance Mode
POST
Cluster Compute Resource Configure HCI Task
POST
Cluster Compute Resource Destroy Task
POST
Cluster Compute Resource Evc Manager
POST
Cluster Compute Resource Extend HCI Task
POST
Cluster Compute Resource Find Rules For Vm
GET
Cluster Compute Resource Get Action History
GET
Cluster Compute Resource Get Alarm Actions Enabled
GET
Cluster Compute Resource Get Available Field
GET
Cluster Compute Resource Get Config Issue
GET
Cluster Compute Resource Get Config Manager Enabled
GET
Cluster Compute Resource Get Config Status
GET
Cluster Compute Resource Get Configuration
GET
Cluster Compute Resource Get Configuration Ex
GET
Cluster Compute Resource Get Custom Value
GET
Cluster Compute Resource Get Datastore
GET
Cluster Compute Resource Get Declared Alarm State
GET
Cluster Compute Resource Get Disabled Method
GET
Cluster Compute Resource Get Drs Fault
GET
Cluster Compute Resource Get Drs Recommendation
GET
Cluster Compute Resource Get Effective Role
GET
Cluster Compute Resource Get Environment Browser
GET
Cluster Compute Resource Get Hci Config
GET
Cluster Compute Resource Get Host
GET
Cluster Compute Resource Get Lifecycle Managed
GET
Cluster Compute Resource Get Migration History
GET
Cluster Compute Resource Get Name
GET
Cluster Compute Resource Get Network
GET
Cluster Compute Resource Get Overall Status
GET
Cluster Compute Resource Get Parent
GET
Cluster Compute Resource Get Permission
GET
Cluster Compute Resource Get Recent Task
GET
Cluster Compute Resource Get Recommendation
GET
Cluster Compute Resource Get Resource Pool
POST
Cluster Compute Resource Get Resource Usage
GET
Cluster Compute Resource Get Summary
GET
Cluster Compute Resource Get Summary Ex
POST
Cluster Compute Resource Get System V Ms Restricted Datastores
GET
Cluster Compute Resource Get Tag
GET
Cluster Compute Resource Get Triggered Alarm State
GET
Cluster Compute Resource Get Value
POST
Cluster Compute Resource Move Host Into Task
POST
Cluster Compute Resource Move Into Task
POST
Cluster Compute Resource Place Vm
POST
Cluster Compute Resource Recommend Hosts For Vm
POST
Cluster Compute Resource Reconfigure Cluster Task
POST
Cluster Compute Resource Reconfigure Compute Resource Task
POST
Cluster Compute Resource Refresh Recommendation
POST
Cluster Compute Resource Reload
POST
Cluster Compute Resource Rename Task
POST
Cluster Compute Resource Retrieve Das Advanced Runtime Info
POST
Cluster Compute Resource Set Crypto Mode
POST
Cluster Compute Resource Set Custom Value
POST
Cluster Compute Resource Stamp All Rules With Uuid Task
POST
Cluster Compute Resource Validate HCI Configuration