Create Cluster
Create a Cluster and add to an existing Domain
Cluster Creation Spec
Show optional properties
{
"computeSpec": {
"clusterSpecs": [
{
"datastoreSpec": {},
"hostSpecs": [
{
"id": "string"
}
],
"name": "string",
"networkSpec": {
"nsxClusterSpec": {},
"vdsSpecs": [
{
"name": "string"
}
]
}
}
]
},
"domainId": "string"
}{
"computeSpec": {
"clusterSpecs": [
{
"advancedOptions": {
"evcMode": "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
"highAvailability": {
"enabled": false
}
},
"clusterImageId": "string",
"datastoreSpec": {
"nfsDatastoreSpecs": [
{
"datastoreName": "string",
"nasVolume": {
"path": "string",
"readOnly": false,
"serverName": [
"string"
],
"userTag": "string"
}
}
],
"vmfsDatastoreSpec": {
"fcSpec": [
{
"datastoreName": "string"
}
]
},
"vsanDatastoreSpec": {
"datastoreName": "string",
"dedupAndCompressionEnabled": false,
"failuresToTolerate": 0,
"licenseKey": "string"
},
"vvolDatastoreSpecs": [
{
"name": "string",
"vasaProviderSpec": {
"storageContainerId": "string",
"storageProtocolType": "One among: ISCSI, NFS, FC",
"userId": "string",
"vasaProviderId": "string"
}
}
]
},
"hostSpecs": [
{
"azName": "string",
"hostName": "string",
"hostNetworkSpec": {
"vmNics": [
{
"id": "string",
"moveToNvds": false,
"uplink": "string",
"vdsName": "string"
}
]
},
"id": "string",
"ipAddress": "string",
"licenseKey": "string",
"password": "string",
"serialNumber": "string",
"sshThumbprint": "string",
"username": "string"
}
],
"name": "string",
"networkSpec": {
"nsxClusterSpec": {
"nsxTClusterSpec": {
"geneveVlanId": 0,
"ipAddressPoolSpec": {
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"name": "string",
"subnets": [
{
"cidr": "string",
"gateway": "string",
"ipAddressPoolRanges": [
{
"end": "string",
"start": "string"
}
]
}
]
}
}
},
"vdsSpecs": [
{
"isUsedByNsxt": false,
"name": "string",
"niocBandwidthAllocationSpecs": [
{
"niocTrafficResourceAllocation": {
"limit": 0,
"reservation": 0,
"sharesInfo": {
"level": "One among: low, normal, high, custom",
"shares": 0
}
},
"type": "string"
}
],
"portGroupSpecs": [
{
"activeUplinks": [
"string"
],
"name": "string",
"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"
}
]
}
]
},
"skipThumbprintValidation": false,
"vxRailDetails": {
"adminCredentials": {
"credentialType": "One among: SSH",
"password": "string",
"username": "string"
},
"dnsName": "string",
"ipAddress": "string",
"networks": [
{
"freeIps": [
"string"
],
"gateway": "string",
"id": "string",
"ipPools": [
{
"end": "string",
"start": "string"
}
],
"mask": "string",
"mtu": 0,
"subnet": "string",
"type": "string",
"usedIps": [
"string"
],
"vlanId": 0
}
],
"nicProfile": "string",
"rootCredentials": {
"credentialType": "One among: SSH",
"password": "string",
"username": "string"
},
"sshThumbprint": "string",
"sslThumbprint": "string"
}
}
],
"skipFailedHosts": "false"
},
"domainId": "string"
}This specification contains the parameters required to add each cluster to a workload domain
ID of the domain to which the clusters will be added
OK
"Task Object"Task completion timestamp
Task creation timestamp
List of errors in case of a failure
Task ID
Represents task can be cancellable or not.
Task name
Resolution state
List of resources associated with task
Task status
List of sub-tasks of the task
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Accepted
"Task Object"Task completion timestamp
Task creation timestamp
List of errors in case of a failure
Task ID
Represents task can be cancellable or not.
Task name
Resolution state
List of resources associated with task
Task status
List of sub-tasks of the task
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
Bad Request
"Error Object"The arguments used to localize the message, Can be used by scripts to automate the error processing.
The underlying cause exceptions.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
InternalServerError
"Error Object"The arguments used to localize the message, Can be used by scripts to automate the error processing.
The underlying cause exceptions.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"computeSpec":"{}","domainId:"string"}' https://{api_host}/v1/clusters