Cluster Compute Resource Reconfigure Cluster Task

Deprecated as of VI API 2.5, use ReconfigureComputeResource_Task.

Reconfigures a cluster.

Required privileges: Host.Inventory.EditCluster

Request

URI

POST

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

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method 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.3.0 APIs.

Request Body

ReconfigureClusterRequestType of type(s) application/json

Required

Show optional properties

{
    "spec": {},
    "modify": false
}

{
    "spec": {
        "_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"
        },
        "dasVmConfigSpec": [
            {
                "_typeName": "string",
                "operation": "string",
                "removeKey": {
                    "_typeName": "string"
                },
                "info": {
                    "_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"
                    }
                }
            ]
        },
        "drsVmConfigSpec": [
            {
                "_typeName": "string",
                "operation": "string",
                "removeKey": {
                    "_typeName": "string"
                },
                "info": {
                    "_typeName": "string",
                    "key": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "enabled": false,
                    "behavior": "string"
                }
            }
        ],
        "rulesSpec": [
            {
                "_typeName": "string",
                "operation": "string",
                "removeKey": {
                    "_typeName": "string"
                },
                "info": {
                    "_typeName": "string",
                    "key": 0,
                    "status": "string",
                    "enabled": false,
                    "name": "string",
                    "mandatory": false,
                    "userCreated": false,
                    "inCompliance": false,
                    "ruleUuid": "string"
                }
            }
        ]
    },
    "modify": false
}

ClusterConfigSpec

spec

Required

Deprecated as of VI API 2.5, use ClusterConfigSpecEx.

A complete cluster configuration.

All fields are defined as optional. In case of a reconfiguration, unset fields are unchanged.

boolean

modify

Required

Flag to specify whether the specification ("spec") should be applied incrementally. If "modify" is false and the operation succeeds, then the configuration of the cluster matches the specification exactly; in this case any unset portions of the specification will result in unset or default portions of the configuration.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure 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