Cluster Compute Resource Get Configuration

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.
Responses
200

OK

Returns ClusterConfigInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "dasConfig": {
        "_typeName": "string",
        "enabled": false,
        "vmMonitoring": "string",
        "hostMonitoring": "string",
        "vmComponentProtecting": "string",
        "failoverLevel": 0,
        "admissionControlPolicy": {
            "_typeName": "string",
            "resourceReductionToToleratePercent": 0,
            "pMemAdmissionControlEnabled": false
        },
        "admissionControlEnabled": false,
        "defaultVmSettings": {
            "_typeName": "string",
            "restartPriority": "string",
            "restartPriorityTimeout": 0,
            "isolationResponse": "string",
            "vmToolsMonitoringSettings": {
                "_typeName": "string",
                "enabled": false,
                "vmMonitoring": "string",
                "clusterSettings": false,
                "failureInterval": 0,
                "minUpTime": 0,
                "maxFailures": 0,
                "maxFailureWindow": 0
            },
            "vmComponentProtectionSettings": {
                "_typeName": "string",
                "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": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "restartPriority": "string",
            "powerOffOnIsolation": false,
            "dasSettings": {
                "_typeName": "string",
                "restartPriority": "string",
                "restartPriorityTimeout": 0,
                "isolationResponse": "string",
                "vmToolsMonitoringSettings": {
                    "_typeName": "string",
                    "enabled": false,
                    "vmMonitoring": "string",
                    "clusterSettings": false,
                    "failureInterval": 0,
                    "minUpTime": 0,
                    "maxFailures": 0,
                    "maxFailureWindow": 0
                },
                "vmComponentProtectionSettings": {
                    "_typeName": "string",
                    "vmStorageProtectionForAPD": "string",
                    "enableAPDTimeoutForHosts": false,
                    "vmTerminateDelayForAPDSec": 0,
                    "vmReactionOnAPDCleared": "string",
                    "vmStorageProtectionForPDL": "string"
                }
            }
        }
    ],
    "drsConfig": {
        "_typeName": "string",
        "enabled": false,
        "enableVmBehaviorOverrides": false,
        "defaultVmBehavior": "string",
        "vmotionRate": 0,
        "scaleDescendantsShares": "string",
        "option": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "drsVmConfig": [
        {
            "_typeName": "string",
            "key": {
                "_typeName": "string",
                "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"
        }
    ]
}
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.

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.

drsConfig
Required

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

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.

drsVmConfig
Optional

List of virtual machine configurations for the VMware DRS 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.

rule
Optional

Cluster-wide rules.


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