[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Create Cluster

Description

Create a Cluster and add to an existing Domain

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/clusters

Copy

Request Body

ClusterCreationSpec of type(s) application/json Required

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,
						"esaConfig": {
							"enabled": false
						},
						"failuresToTolerate": 0,
						"licenseKey": "string"
					},
					"vsanRemoteDatastoreClusterSpec": {
						"vsanRemoteDatastoreSpec": [
							{
								"datastoreUuid": "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": [
											{
												"IpAddressPoolRangeSpec": "Too large to render past this point..."
											}
										]
									}
								]
							}
						}
					},
					"vdsSpecs": [
						{
							"isUsedByNsxt": false,
							"mtu": 0,
							"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, VM_MANAGEMENT"
								}
							]
						}
					]
				},
				"skipThumbprintValidation": false,
				"vxRailDetails": {
					"adminCredentials": {
						"credentialType": "One among: SSH",
						"password": "string",
						"username": "string"
					},
					"arrayContextWithKeyValuePair": {
						"key": {}
					},
					"contextWithKeyValuePair": {
						"key": {}
					},
					"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"
}

ComputeSpec

computeSpec Required

Cluster specification to be added to the domain

string

domainId Required

ID of the domain to which the clusters will be added

Response

200 OK Response Body>

Response Body

200 OK

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

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 _

202 Accepted Response Body>

Response Body

202 Accepted

Returns Task of type(s) application/json

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

type Optional

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 _

Errors

Error

400

Bad Request

Error

500

InternalServerError

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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,"esaConfig":{"enabled":false},"failuresToTolerate":0,"licenseKey":"string"},"vsanRemoteDatastoreClusterSpec":{"vsanRemoteDatastoreSpec":[{"datastoreUuid":"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":[{"IpAddressPoolRangeSpec":"Too large to render past this point..."}]}]}}},"vdsSpecs":[{"isUsedByNsxt":false,"mtu":0,"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, VM_MANAGEMENT"}]}]},"skipThumbprintValidation":false,"vxRailDetails":{"adminCredentials":{"credentialType":"One among: SSH","password":"string","username":"string"},"arrayContextWithKeyValuePair":{"key":{}},"contextWithKeyValuePair":{"key":{}},"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"}' https://sfo-vcf01.rainpole.io/v1/clusters

vcf

Clusters Operations

post

Add Datastore To Cluster

put

Assign Tags To Existing Cluster

get

Assignable Tags To Cluster

post

Create Cluster

delete

Delete Cluster

get

Get Cluster

get

Get Cluster Datastores Introduced

get

Get Cluster Tag Manager URL

get

Get Clusters

get

Get Datastore Criterion

get

Get Datastore Query Response

get

Get Datastores Criteria

get

Get Host Criteria

get

Get Host Criterion

get

Get Host Query Response

get

Get Tags Assigned To Cluster

get

Get Tags Assigned To Clusters

get

Get VDses

post

Post Datastore Query

post

Post Host Query

delete

Remove Datastore From Cluster

delete

Remove Tags From Existing Cluster

patch

Update Cluster

post

Validate Cluster Operations

post

Validate Clusters Operations

post

Validate vSAN Remote Datastore Spec

Create Cluster

Request

URL

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

Clusters Operations

Was this page helpful?