ClusterConfigInfoEx

ClusterConfigInfoEx
ClusterConfigInfoEx

The ClusterConfigInfoEx data object describes a complete cluster configuration.

For information about configuring a cluster, see ClusterConfigSpecEx.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "vmSwapPlacement": "string",
    "spbmEnabled": false,
    "defaultHardwareVersionKey": "string",
    "maximumHardwareVersionKey": "string",
    "systemVMsConfig": {
        "_typeName": "string",
        "allowedDatastores": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "notAllowedDatastores": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "dsTagCategoriesToExclude": [
            "string"
        ],
        "deploymentMode": "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"
        }
    ],
    "orchestration": {
        "_typeName": "string",
        "defaultVmReadiness": {
            "_typeName": "string",
            "readyCondition": "string",
            "postReadyDelay": 0
        }
    },
    "vmOrchestration": [
        {
            "_typeName": "string",
            "vm": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "vmReadiness": {
                "_typeName": "string",
                "readyCondition": "string",
                "postReadyDelay": 0
            }
        }
    ],
    "dpmConfigInfo": {
        "_typeName": "string",
        "enabled": false,
        "defaultDpmBehavior": "string",
        "hostPowerActionRate": 0,
        "option": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "dpmHostConfig": [
        {
            "_typeName": "string",
            "key": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "enabled": false,
            "behavior": "string"
        }
    ],
    "vsanConfigInfo": {
        "_typeName": "string",
        "enabled": false,
        "defaultConfig": {
            "_typeName": "string",
            "uuid": "string",
            "autoClaimStorage": false,
            "checksumEnabled": false
        },
        "vsanEsaEnabled": false
    },
    "vsanHostConfig": [
        {
            "_typeName": "string",
            "enabled": false,
            "hostSystem": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "clusterInfo": {
                "_typeName": "string",
                "uuid": "string",
                "nodeUuid": "string"
            },
            "storageInfo": {
                "_typeName": "string",
                "autoClaimStorage": false,
                "diskMapping": [
                    {
                        "_typeName": "string",
                        "ssd": {
                            "_typeName": "string",
                            "deviceName": "string",
                            "deviceType": "string",
                            "key": "string",
                            "uuid": "string",
                            "descriptor": [
                                {
                                    "_typeName": "string",
                                    "quality": "string",
                                    "id": "string"
                                }
                            ],
                            "canonicalName": "string",
                            "displayName": "string",
                            "lunType": "string",
                            "vendor": "string",
                            "model": "string",
                            "revision": "string",
                            "scsiLevel": 0,
                            "serialNumber": "string",
                            "durableName": {
                                "_typeName": "string",
                                "namespace": "string",
                                "namespaceId": 0,
                                "data": [
                                    0
                                ]
                            },
                            "alternateName": [
                                {
                                    "_typeName": "string",
                                    "namespace": "string",
                                    "namespaceId": 0,
                                    "data": [
                                        0
                                    ]
                                }
                            ],
                            "standardInquiry": [
                                0
                            ],
                            "queueDepth": 0,
                            "operationalState": [
                                "string"
                            ],
                            "capabilities": {
                                "_typeName": "string",
                                "updateDisplayNameSupported": false
                            },
                            "vStorageSupport": "string",
                            "protocolEndpoint": false,
                            "perenniallyReserved": false,
                            "clusteredVmdkSupported": false,
                            "applicationProtocol": "string",
                            "dispersedNs": false,
                            "capacity": {
                                "_typeName": "string",
                                "blockSize": 0,
                                "block": 0
                            },
                            "devicePath": "string",
                            "ssd": false,
                            "localDisk": false,
                            "physicalLocation": [
                                "string"
                            ],
                            "emulatedDIXDIFEnabled": false,
                            "vsanDiskInfo": {
                                "_typeName": "string",
                                "vsanUuid": "string",
                                "formatVersion": 0
                            },
                            "scsiDiskType": "string"
                        },
                        "nonSsd": [
                            {
                                "_typeName": "string",
                                "deviceName": "string",
                                "deviceType": "string",
                                "key": "string",
                                "uuid": "string",
                                "descriptor": [
                                    {
                                        "_typeName": "string",
                                        "quality": "string",
                                        "id": "string"
                                    }
                                ],
                                "canonicalName": "string",
                                "displayName": "string",
                                "lunType": "string",
                                "vendor": "string",
                                "model": "string",
                                "revision": "string",
                                "scsiLevel": 0,
                                "serialNumber": "string",
                                "durableName": {
                                    "_typeName": "string",
                                    "namespace": "string",
                                    "namespaceId": 0,
                                    "data": [
                                        0
                                    ]
                                },
                                "alternateName": [
                                    {
                                        "_typeName": "string",
                                        "namespace": "string",
                                        "namespaceId": 0,
                                        "data": [
                                            0
                                        ]
                                    }
                                ],
                                "standardInquiry": [
                                    0
                                ],
                                "queueDepth": 0,
                                "operationalState": [
                                    "string"
                                ],
                                "capabilities": {
                                    "_typeName": "string",
                                    "updateDisplayNameSupported": false
                                },
                                "vStorageSupport": "string",
                                "protocolEndpoint": false,
                                "perenniallyReserved": false,
                                "clusteredVmdkSupported": false,
                                "applicationProtocol": "string",
                                "dispersedNs": false,
                                "capacity": {
                                    "_typeName": "string",
                                    "blockSize": 0,
                                    "block": 0
                                },
                                "devicePath": "string",
                                "ssd": false,
                                "localDisk": false,
                                "physicalLocation": [
                                    "string"
                                ],
                                "emulatedDIXDIFEnabled": false,
                                "vsanDiskInfo": {
                                    "_typeName": "string",
                                    "vsanUuid": "string",
                                    "formatVersion": 0
                                },
                                "scsiDiskType": "string"
                            }
                        ]
                    }
                ],
                "diskMapInfo": [
                    {
                        "_typeName": "string",
                        "mapping": {
                            "_typeName": "string",
                            "ssd": {
                                "_typeName": "string",
                                "deviceName": "string",
                                "deviceType": "string",
                                "key": "string",
                                "uuid": "string",
                                "descriptor": [
                                    {
                                        "_typeName": "string",
                                        "quality": "string",
                                        "id": "string"
                                    }
                                ],
                                "canonicalName": "string",
                                "displayName": "string",
                                "lunType": "string",
                                "vendor": "string",
                                "model": "string",
                                "revision": "string",
                                "scsiLevel": 0,
                                "serialNumber": "string",
                                "durableName": {
                                    "_typeName": "string",
                                    "namespace": "string",
                                    "namespaceId": 0,
                                    "data": [
                                        0
                                    ]
                                },
                                "alternateName": [
                                    {
                                        "_typeName": "string",
                                        "namespace": "string",
                                        "namespaceId": 0,
                                        "data": [
                                            0
                                        ]
                                    }
                                ],
                                "standardInquiry": [
                                    0
                                ],
                                "queueDepth": 0,
                                "operationalState": [
                                    "string"
                                ],
                                "capabilities": {
                                    "_typeName": "string",
                                    "updateDisplayNameSupported": false
                                },
                                "vStorageSupport": "string",
                                "protocolEndpoint": false,
                                "perenniallyReserved": false,
                                "clusteredVmdkSupported": false,
                                "applicationProtocol": "string",
                                "dispersedNs": false,
                                "capacity": {
                                    "_typeName": "string",
                                    "blockSize": 0,
                                    "block": 0
                                },
                                "devicePath": "string",
                                "ssd": false,
                                "localDisk": false,
                                "physicalLocation": [
                                    "string"
                                ],
                                "emulatedDIXDIFEnabled": false,
                                "vsanDiskInfo": {
                                    "_typeName": "string",
                                    "vsanUuid": "string",
                                    "formatVersion": 0
                                },
                                "scsiDiskType": "string"
                            },
                            "nonSsd": [
                                {
                                    "_typeName": "string",
                                    "deviceName": "string",
                                    "deviceType": "string",
                                    "key": "string",
                                    "uuid": "string",
                                    "descriptor": [
                                        {
                                            "_typeName": "string",
                                            "quality": "string",
                                            "id": "string"
                                        }
                                    ],
                                    "canonicalName": "string",
                                    "displayName": "string",
                                    "lunType": "string",
                                    "vendor": "string",
                                    "model": "string",
                                    "revision": "string",
                                    "scsiLevel": 0,
                                    "serialNumber": "string",
                                    "durableName": {
                                        "_typeName": "string",
                                        "namespace": "string",
                                        "namespaceId": 0,
                                        "data": [
                                            0
                                        ]
                                    },
                                    "alternateName": [
                                        {
                                            "_typeName": "string",
                                            "namespace": "string",
                                            "namespaceId": 0,
                                            "data": [
                                                0
                                            ]
                                        }
                                    ],
                                    "standardInquiry": [
                                        0
                                    ],
                                    "queueDepth": 0,
                                    "operationalState": [
                                        "string"
                                    ],
                                    "capabilities": {
                                        "_typeName": "string",
                                        "updateDisplayNameSupported": false
                                    },
                                    "vStorageSupport": "string",
                                    "protocolEndpoint": false,
                                    "perenniallyReserved": false,
                                    "clusteredVmdkSupported": false,
                                    "applicationProtocol": "string",
                                    "dispersedNs": false,
                                    "capacity": {
                                        "_typeName": "string",
                                        "blockSize": 0,
                                        "block": 0
                                    },
                                    "devicePath": "string",
                                    "ssd": false,
                                    "localDisk": false,
                                    "physicalLocation": [
                                        "string"
                                    ],
                                    "emulatedDIXDIFEnabled": false,
                                    "vsanDiskInfo": {
                                        "_typeName": "string",
                                        "vsanUuid": "string",
                                        "formatVersion": 0
                                    },
                                    "scsiDiskType": "string"
                                }
                            ]
                        },
                        "mounted": false
                    }
                ],
                "checksumEnabled": false
            },
            "networkInfo": {
                "_typeName": "string",
                "port": [
                    {
                        "_typeName": "string",
                        "ipConfig": {
                            "_typeName": "string",
                            "upstreamIpAddress": "string",
                            "downstreamIpAddress": "string"
                        },
                        "device": "string"
                    }
                ]
            },
            "faultDomainInfo": {
                "_typeName": "string",
                "name": "string"
            },
            "vsanEsaEnabled": false
        }
    ],
    "group": [
        {
            "_typeName": "string",
            "name": "string",
            "userCreated": false,
            "uniqueID": "string"
        }
    ],
    "infraUpdateHaConfig": {
        "_typeName": "string",
        "enabled": false,
        "behavior": "string",
        "moderateRemediation": "string",
        "severeRemediation": "string",
        "providers": [
            "string"
        ]
    },
    "proactiveDrsConfig": {
        "_typeName": "string",
        "enabled": false
    },
    "cryptoConfig": {
        "_typeName": "string",
        "cryptoMode": "string"
    }
}
systemVMsConfig
Optional

Configuration for System VMs deployment.

Since: vSphere API Release 7.0.3.0

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.

orchestration
Optional

vSphere cluster VM orchestration settings.

Used by vSphere HA when restarting failed VMs. For example, if a host fails, vSphere HA identifies the list of VMs to be restarted. The order in which the failed VMs to be restarted is determined by:

  • VM restart priority setting (restartPriority). Lower priority VMs are restarted only after higher priority VMs are restarted and ready (ClusterVmReadiness).
  • VM dependency rule (ClusterDependencyRuleInfo). If a VM depends on other VMs, then it will be restarted only after all the VMs in its dependency list are ready. Cyclic dependency is not permitted across VMs. Also, higher priority VMs cannot depend on lower priority VMs.
vmOrchestration
Optional

List of virtual machine configurations that apply during cluster wide VM orchestration.

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.

dpmConfigInfo
Optional

Configuration of the VMware DPM service.

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

dpmHostConfig
Optional

List of host configurations for the VMware DPM service.

Each entry applies to one host.

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

vsanConfigInfo
Optional

The VsanClusterConfigInfo data object contains configuration data for the VSAN service in a cluster.

This data object is used both for specifying cluster-wide settings when updating the VSAN service, and as an output datatype when retrieving current cluster-wide VSAN service settings.

See also ReconfigureComputeResource_Task.

vsanHostConfig
Optional

List of host configurations for the VMware VSAN service.

Each entry applies to one host.

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

group
Optional

Cluster-wide groups.

infraUpdateHaConfig
Optional

Configuration of the vSphere InfraUpdateHA service.

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

proactiveDrsConfig
Optional

Cluster-wide configuration of the ProactiveDRS service.

cryptoConfig
Optional

Cluster-wide configuration of the encryption mode.