Folder Create Cluster
Deprecated as of VI API 2.5, use CreateClusterEx.
Creates a new cluster compute resource in this folder.
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.
Required privileges: Host.Inventory.CreateCluster
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Folder/{moId}/CreateCluster
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 Folder/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Request Body
CreateClusterRequestType of type(s) application/json
Required
Show optional properties
{
"name": "string",
"spec": {}
}{
"name": "string",
"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"
}
}
]
}
}string
name
Required
Name for the new cluster.
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.
Responses
200
A new ClusterComputeResource instance.
Returns MoRefClusterComputeResource of type(s) application/json
This response body class contains all of the following: MoRefComputeResource
{
"_typeName": "string",
"type": "string",
"value": "string"
}
500
DuplicateName: if an entity with that name already exists.
InvalidArgument: if the cluster configuration specification parameter is invalid.
InvalidName: if the name is not a valid entity name.
NotSupported: if the cluster is being added to a folder whose childType property value does not contain "ComputeResource" or "ClusterComputeResource".
Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}
On This Page
Virtual Infrastructure Operations
POST
Folder Add Standalone Host Task
POST
Folder Batch Add Hosts To Cluster Task
POST
Folder Batch Add Standalone Hosts Task
POST
Folder Create Cluster
POST
Folder Create Cluster Ex
POST
Folder Create Datacenter
POST
Folder Create DVS Task
POST
Folder Create Folder
POST
Folder Create Storage Pod
POST
Folder Create VM Task
POST
Folder Destroy Task
GET
Folder Get Alarm Actions Enabled
GET
Folder Get Available Field
GET
Folder Get Child Entity
GET
Folder Get Child Type
GET
Folder Get Config Issue
GET
Folder Get Config Status
GET
Folder Get Custom Value
GET
Folder Get Declared Alarm State
GET
Folder Get Disabled Method
GET
Folder Get Effective Role
GET
Folder Get Name
GET
Folder Get Namespace
GET
Folder Get Overall Status
GET
Folder Get Parent
GET
Folder Get Permission
GET
Folder Get Recent Task
GET
Folder Get Tag
GET
Folder Get Triggered Alarm State
GET
Folder Get Value
POST
Folder Move Into Folder Task
POST
Folder Register VM Task
POST
Folder Reload
POST
Folder Rename Task
POST
Folder Set Custom Value
POST
Folder Unregister And Destroy Task