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/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
VMware Cloud Foundation API Reference Guide Domains

Create Domain

Description

Create a Domain

Request

Request

URL

URL

post
https://sfo-vcf01.rainpole.io/v1/domains
Copy
Request Body

Request Body

DomainCreationSpec of type(s) application/json Required

Domain creation data

{
	"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
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 configuration
string
orgName Optional

Organization name of the workload domain
SsoDomainSpec
ssoDomainSpec Introduced Optional

SSO domain specification
Response

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

Errors

Error
400

Bad Request
Error
500

InternalServerError
Code Samples

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},"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","ssoDomainSpec":{"ssoDomainName":"string","ssoDomainPassword":"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

Generated on: 25 May 23 10:38 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/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
On This Page
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
Feedback

Was this page helpful?

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