Cluster Compute Resource Get Configuration

Deprecated as of VI API 2.5, use configurationEx, which is a ClusterConfigInfoEx data object..

Configuration of the cluster.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/configuration

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.

Session

Responses

200

Returns ClusterConfigInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "dasConfig": {
        "enabled": false,
        "vmMonitoring": "string",
        "hostMonitoring": "string",
        "vmComponentProtecting": "string",
        "failoverLevel": 0,
        "admissionControlPolicy": {
            "resourceReductionToToleratePercent": 0,
            "pMemAdmissionControlEnabled": false
        },
        "admissionControlEnabled": false,
        "defaultVmSettings": {
            "restartPriority": "string",
            "restartPriorityTimeout": 0,
            "isolationResponse": "string",
            "vmToolsMonitoringSettings": {
                "enabled": false,
                "vmMonitoring": "string",
                "clusterSettings": false,
                "failureInterval": 0,
                "minUpTime": 0,
                "maxFailures": 0,
                "maxFailureWindow": 0
            },
            "vmComponentProtectionSettings": {
                "vmStorageProtectionForAPD": "string",
                "enableAPDTimeoutForHosts": false,
                "vmTerminateDelayForAPDSec": 0,
                "vmReactionOnAPDCleared": "string",
                "vmStorageProtectionForPDL": "string"
            }
        },
        "option": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ],
        "heartbeatDatastore": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "hBDatastoreCandidatePolicy": "string"
    },
    "dasVmConfig": [
        {
            "_typeName": "string",
            "key": {
                "type": "string",
                "value": "string"
            },
            "restartPriority": "string",
            "powerOffOnIsolation": false,
            "dasSettings": {
                "restartPriority": "string",
                "restartPriorityTimeout": 0,
                "isolationResponse": "string",
                "vmToolsMonitoringSettings": {
                    "enabled": false,
                    "vmMonitoring": "string",
                    "clusterSettings": false,
                    "failureInterval": 0,
                    "minUpTime": 0,
                    "maxFailures": 0,
                    "maxFailureWindow": 0
                },
                "vmComponentProtectionSettings": {
                    "vmStorageProtectionForAPD": "string",
                    "enableAPDTimeoutForHosts": false,
                    "vmTerminateDelayForAPDSec": 0,
                    "vmReactionOnAPDCleared": "string",
                    "vmStorageProtectionForPDL": "string"
                }
            }
        }
    ],
    "drsConfig": {
        "enabled": false,
        "enableVmBehaviorOverrides": false,
        "defaultVmBehavior": "string",
        "vmotionRate": 0,
        "scaleDescendantsShares": "string",
        "option": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "drsVmConfig": [
        {
            "_typeName": "string",
            "key": {
                "type": "string",
                "value": "string"
            },
            "enabled": false,
            "behavior": "string"
        }
    ],
    "rule": [
        {
            "_typeName": "string",
            "key": 0,
            "status": "string",
            "enabled": false,
            "name": "string",
            "mandatory": false,
            "userCreated": false,
            "inCompliance": false,
            "ruleUuid": "string"
        }
    ]
}

ClusterDasConfigInfo

dasConfig

Required

The ClusterDasConfigInfo data object contains configuration data about the HA service on a cluster.

All fields are optional. If you set the modify parameter to true when you call ReconfigureComputeResource_Task, an unset property has no effect on the existing property value in the cluster configuration on the Server. If you set the modify parameter to false when you reconfigure a cluster, the cluster configuration is reverted to the default values, then the new configuration values are applied.

array of ClusterDasVmConfigInfo

dasVmConfig

Optional

List of virtual machine configurations for the vSphere HA service.

Each entry applies to one virtual machine.

If a virtual machine is not specified in this array, the service uses the default settings for that virtual machine.

ClusterDrsConfigInfo

drsConfig

Required

The ClusterDrsConfigInfo data object contains configuration information for the VMware DRS service.

array of ClusterDrsVmConfigInfo

drsVmConfig