[{"label":"Latest (4.4.0)","version":"latest"},{"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

SddcSpec

Spec contains parameters for creating/bringing up an SDDC


Properties

array of SddcHostSpec
hostSpecs Required

List of Host Specs


vcenterSpec Required

vCenter Spec


clusterSpec Required

Cluster Spec


dnsSpec Required

DNS Spec


string
taskName Required

Name of the task to execute


array of DvsSpec
dvsSpecs Required

List of Dvs Specs


string
sddcId Required

Client string that identifies an SDDC by name or instance name. Used for management domain name. Can contain only letters, numbers and the following symbols: ‘-’.


array of string
ntpServers Required

List of NTP servers


array of SddcNetworkSpec
networkSpecs Required

List of Network Specs


boolean
ceipEnabled Optional

Enable VCF Customer Experience Improvement Program


string
managementPoolName Optional

A String identifying the network pool associated with the management domain


boolean
fipsEnabled Optional

Enable Federal Information Processing Standards


nsxtSpec Optional

NSX-T Spec


array of string
excludedComponents Optional

Components to be excluded


array of PscSpec
pscSpecs Optional

PSC VM spec


remoteSiteSpec Optional

Remote site spec


string
esxLicense Optional

License for the ESXi hosts


sddcManagerSpec Optional

SDDC Manager Virtual Machine spec


securitySpec Optional

Security spec


boolean
shouldCleanupVsan Optional

Flag indicating whether cleanup vSAN should be ran


boolean
skipEsxThumbprintValidation Optional

Skip ESXi thumbprint validation


boolean
skipGatewayPingValidation Optional

Skip VSAN / VMOTION networks gateway connectivity validation


string
dvSwitchVersion Optional

The version of the distributed virtual switches to be used


string
certificatesPassphrase Optional

Passphrase for the vCenter / NSX certificates


vsanSpec Optional

VSAN Spec


vxManagerSpec Optional

VxManager Spec

JSON Example

{
	"clusterSpec": {
		"clusterName": "string"
	},
	"dnsSpec": {
		"domain": "vmware.com",
		"subdomain": "vcf.vmware.com"
	},
	"dvsSpecs": [
		{
			"dvsName": "string",
			"networks": [
				"One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs"
			],
			"vmnics": [
				"string"
			]
		}
	],
	"hostSpecs": [
		{
			"association": "string",
			"credentials": {
				"password": "string",
				"username": "root"
			},
			"hostname": "esx-1",
			"ipAddressPrivate": {
				"ipAddress": "192.168.0.123"
			},
			"vSwitch": "string"
		}
	],
	"networkSpecs": [
		{
			"mtu": "string",
			"networkType": "One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type",
			"vlanId": "string"
		}
	],
	"ntpServers": [
		"string"
	],
	"sddcId": "sfo01-m01",
	"taskName": "workflowconfig/workflowspec-ems.json",
	"vcenterSpec": {
		"rootVcenterPassword": "string",
		"vcenterHostname": "string"
	}
}
[{"label":"Latest (4.4.0)","version":"latest"},{"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
Parameter To

Create SDDC
Retry SDDC
Validate SDDC Spec
Returned By

Convert To JSON Spec

Feedback

Was this page helpful?