[{"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

Validate Domains Operations

Description

Validate the input spec for domains operations

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/domains/validations

Copy

Request Body

DomainCreationSpec of type(s) application/json Required

Domain Creation Spec

Show optional properties

{
	"computeSpec": {
		"clusterSpecs": [
			{
				"datastoreSpec": {},
				"hostSpecs": [
					{
						"id": "string"
					}
				],
				"name": "string",
				"networkSpec": {
					"nsxClusterSpec": {},
					"vdsSpecs": [
						{
							"name": "string"
						}
					]
				}
			}
		]
	},
	"domainName": "string",
	"vcenterSpec": {
		"datacenterName": "string",
		"name": "string",
		"networkDetailsSpec": {
			"ipAddress": "string"
		},
		"rootPassword": "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
	},
	"domainName": "string",
	"nsxTSpec": {
		"formFactor": "string",
		"ipAddressPoolSpec": {
			"description": "string",
			"ignoreUnavailableNsxtCluster": false,
			"name": "string",
			"subnets": [
				{
					"cidr": "string",
					"gateway": "string",
					"ipAddressPoolRanges": [
						{
							"end": "string",
							"start": "string"
						}
					]
				}
			]
		},
		"licenseKey": "string",
		"nsxManagerAdminPassword": "string",
		"nsxManagerAuditPassword": "string",
		"nsxManagerSpecs": [
			{
				"name": "string",
				"networkDetailsSpec": {
					"dnsName": "string",
					"gateway": "string",
					"ipAddress": "string",
					"subnetMask": "string"
				}
			}
		],
		"vip": "string",
		"vipFqdn": "string"
	},
	"orgName": "string",
	"vcenterSpec": {
		"datacenterName": "string",
		"name": "string",
		"networkDetailsSpec": {
			"dnsName": "string",
			"gateway": "string",
			"ipAddress": "string",
			"subnetMask": "string"
		},
		"rootPassword": "string",
		"storageSize": "One among:lstorage, xlstorage",
		"vmSize": "One among:xlarge, large, medium, small, tiny"
	}
}

ComputeSpec

computeSpec Required

Specification representing the clusters to be added to the workload domain

string

domainName Required

Name of the workload domain

VcenterSpec

vcenterSpec Required

Specification details for vCenter

NsxTSpec

nsxTSpec Optional

Specification details for NSX-T configuration

string

orgName Optional

Organization name of the workload domain

Response

Response Body

200 OK

Returns Validation of type(s) application/json

{
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS"
}

map of string

additionalProperties Optional

string

description Optional

Description of the validation

string

executionStatus Optional

Execution status of the validation

string

id Optional

ID of the validation

string

resultStatus Optional

Result status of the validation after it has completed its execution

array of ValidationCheck

validationChecks Optional

List of one or more validation checks that are performed as part of the validation

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,"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,"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"}}]},"domainName":"string","nsxTSpec":{"formFactor":"string","ipAddressPoolSpec":{"description":"string","ignoreUnavailableNsxtCluster":false,"name":"string","subnets":[{"cidr":"string","gateway":"string","ipAddressPoolRanges":[{"end":"string","start":"string"}]}]},"licenseKey":"string","nsxManagerAdminPassword":"string","nsxManagerAuditPassword":"string","nsxManagerSpecs":[{"name":"string","networkDetailsSpec":{"dnsName":"string","gateway":"string","ipAddress":"string","subnetMask":"string"}}],"vip":"string","vipFqdn":"string"},"orgName":"string","vcenterSpec":{"datacenterName":"string","name":"string","networkDetailsSpec":{"dnsName":"string","gateway":"string","ipAddress":"string","subnetMask":"string"},"rootPassword":"string","storageSize":"One among:lstorage, xlstorage","vmSize":"One among:xlarge, large, medium, small, tiny"}}' https://sfo-vcf01.rainpole.io/v1/domains/validations

vcf

Domains Operations

put

Assign Tags To Existing Domain

get

Assignable Tags To Domain

post

Create Domain

delete

Delete Domain

get

Get Cluster Criteria

get

Get Cluster Criterion

get

Get Cluster Query Response

get

Get Clusters Query Response

get

Get Datastore Criterion

get

Get Datastore Query Response

get

Get Datastores Criteria

get

Get Domain

get

Get Domain Endpoints

get

Get Domain Tag Manager URL

get

Get Domains

get

Get Tags Assigned To Domain

get

Get Tags Assigned To Domains

post

Post Cluster Query

post

Post Clusters Query

post

Post Datastore Query

delete

Remove Tags From Domain

patch

Update Domain

post

Validate Domains Operations

Validate Domains Operations

Request

URL

Request Body

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Domains Operations

Was this page helpful?