VMware Developer Documentation
API Reference PowerCLI Reference
[{"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/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
VMware Cloud Foundation on Dell EMC VxRail API Reference Guide Domains

Validate Domains Operations

Description

Validate the input spec for domain update operations

Request

Request

URL

URL

post
https://sfo-vcf01.rainpole.io/v1/domains/{id}/validations
Copy
Path Parameters

Path Parameters

string
id Required

Domain ID

Request Body

Request Body

DomainUpdateSpec of type(s) application/json Required

Domain Update Spec Validation

{
	"clusterSpec": {
		"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": [
									{
										"end": "string",
										"start": "string"
									}
								]
							}
						]
					}
				}
			},
			"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"
		}
	},
	"markForDeletion": false,
	"name": "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"
	}
}
ClusterSpec
clusterSpec Optional

Cluster Specification for the domain
boolean
markForDeletion Optional

Enable deletion for the domain
string
name Optional

Name of the domain
NsxTSpec
nsxTSpec Optional

NSX-T Specification for the domain
Response

Response

Response Body

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

Errors

Error
400

Bad Request
Error
500

InternalServerError
Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"clusterSpec":{"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":[{"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"}},"markForDeletion":false,"name":"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"}}' https://sfo-vcf01.rainpole.io/v1/domains/{id}/validations

Generated on: 09 Jun 23 08:13 UTC
[{"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/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
On This Page
Domains Operations
put
Assign Tags To Existing Domain
get
Assignable Tags To Domain
post
Create Domain
delete
Delete Domain
get
Domain Create Validation
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 Domain Update Validation
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
post
Validate Domains Operations
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us