[{"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
Create SDDC
DescriptionCreate SDDC
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/sddcs
Request Body
Request Body
{
"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": "Admin!23",
"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"
}
}
string
taskName
Required
Name of the task to execute
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
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
array of
string
excludedComponents
Optional
Components to be excluded
string
esxLicense
Optional
License for the ESXi hosts
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
Response
Response
Response BodyResponse Body
200 OK returns
SddcTask
of type(s) application/json
{
"creationTimestamp": "string",
"id": "string",
"localizableNamePack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"sddcSubTasks": [
{
"creationTimestamp": "string",
"description": "string",
"errors": [
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"key": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": "Error Object",
"referenceToken": "string",
"remediationMessage": "string"
}
],
"localizableDescriptionPack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"localizableNamePack": {
"arguments": [
"string"
],
"component": "string",
"message": "string",
"messageKey": "string"
},
"name": "string",
"processingStateDescription": "string",
"processingStateName": "string",
"sddcId": "123e4567-e89b-42d3-a456-556642440000",
"status": "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
"updateTimestamp": "string"
}
],
"status": "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
string
creationTimestamp
Optional
SDDC Task creation timestamp
string
id
Optional
SDDC ID
string
name
Optional
Task name
string
status
Optional
SDDC Task status
Errors
Code Samples
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"ceipEnabled":"true","certificatesPassphrase":"string","clusterSpec":{"clusterEvcMode":"string","clusterName":"string","hostFailuresToTolerate":0,"hostProfileComplianceCheckHour":0,"hostProfileComplianceCheckMinute":0,"hosts":["string"],"personalityName":"string","resourcePoolSpecs":[{"cpuLimit":0,"cpuReservationExpandable":false,"cpuReservationMhz":0,"cpuReservationPercentage":0,"cpuSharesLevel":"custom","cpuSharesValue":0,"memoryLimit":0,"memoryReservationExpandable":false,"memoryReservationMb":0,"memoryReservationPercentage":0,"memorySharesLevel":"custom","memorySharesValue":0,"name":"string","type":"management"}],"vmFolders":{"key":"One among:MANAGEMENT, NETWORKING, EDGENODES"}},"dnsSpec":{"domain":"vmware.com","nameserver":"172.0.0.4","secondaryNameserver":"172.0.0.5","subdomain":"vcf.vmware.com"},"dvSwitchVersion":"One among:6.0.0, 6.5.0, 7.0.0","dvsSpecs":[{"dvsName":"string","isUsedByNsxt":false,"mtu":0,"networks":["One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs"],"niocSpecs":[{"trafficType":"One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI","value":"string"}],"vmnics":["string"]}],"esxLicense":"string","excludedComponents":["One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup, EBGP"],"fipsEnabled":"true","hostSpecs":[{"association":"string","credentials":{"password":"Admin!23","username":"root"},"hostname":"esx-1","ipAddressPrivate":{"cidr":"172.0.0.0/24","gateway":"192.168.0.1","ipAddress":"192.168.0.123","subnet":"255.255.255.252"},"key":"string","serverId":"string","sshThumbprint":"string","sslThumbprint":"string","vSwitch":"string","vmknicSpecs":[{"ipAddress":"string","macAddress":"string","portgroup":"One among:VSAN, VMOTION, MANAGEMENT"}],"vswitch":"string"}],"managementPoolName":"string","networkSpecs":[{"activeUplinks":["string"],"excludeIpAddressRanges":["string"],"excludeIpaddresses":["string"],"gateway":"string","includeIpAddress":["string"],"includeIpAddressRanges":[{"endIpAddress":"192.168.0.128","startIpAddress":"192.168.0.123"}],"mtu":"string","networkType":"One among: VSAN, VMOTION, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type","portGroupKey":"string","standbyUplinks":["string"],"subnet":"string","subnetMask":"string","teamingPolicy":"One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased","vlanId":"string"}],"nsxtSpec":{"ipAddressPoolSpec":{"description":"string","ignoreUnavailableNsxtCluster":false,"name":"string","subnets":[{"cidr":"string","gateway":"string","ipAddressPoolRanges":[{"end":"string","start":"string"}]}]},"logicalSegments":[{"name":"string","networkType":"Oneamong:X_REGION"}],"nsxtAdminPassword":"string","nsxtAuditPassword":"string","nsxtEdgeSpec":{"asn":0,"bgpNeighbours":[{"autonomousSystem":0,"forwardingIp":"192.168.0.123","holdDownTimeSeconds":0,"keepAliveTimeSeconds":0,"neighbourIp":"192.168.0.123","password":"string","protocolIp":"192.168.0.123","weight":0}],"edgeAdminPassword":"string","edgeAuditPassword":"string","edgeClusterName":"string","edgeFormFactor":"Oneamong:SMALL","edgeNodeSpecs":[{"edgeNodeHostname":"string","edgeNodeName":"string","edgeVtep1Cidr":"string","edgeVtep2Cidr":"string","interfaces":[{"interfaceCidr":"string","name":"string"}],"managementCidr":"string"}],"edgeRootPassword":"string","edgeServicesSpecs":{"tier0GatewayName":"string","tier1GatewayName":"string"},"tier0ServicesHighAvailability":"string"},"nsxtLicense":"string","nsxtManagerSize":"One among:medium, large","nsxtManagers":[{"hostname":"string","ip":"string"}],"overLayTransportZone":{"networkName":"string","zoneName":"string"},"rootLoginEnabledForNsxtManager":false,"rootNsxtManagerPassword":"string","sshEnabledForNsxtManager":false,"transportVlanId":0,"vip":"string","vipFqdn":"string","vlanTransportZone":{"networkName":"string","zoneName":"string"}},"ntpServers":["string"],"pscSpecs":[{"adminUserSsoPassword":"string","pscId":"string","pscSsoSpec":{"ssoDomain":"string"}}],"remoteSiteSpec":{"pscAddress":"string","sslThumbprint":"string","vcCredentials":{"password":"Admin!23","username":"root"}},"sddcId":"sfo01-m01","sddcManagerSpec":{"hostname":"string","ipAddress":"string","licenseKey":"string","localUserPassword":"string","netmask":"string","rootUserCredentials":{"password":"Admin!23","username":"root"},"secondUserCredentials":{"password":"Admin!23","username":"root"}},"securitySpec":{"esxiCertsMode":"One among:Custom, VMCA","rootCaCerts":[{"alias":"string","certChain":["string"]}]},"shouldCleanupVsan":"false","skipEsxThumbprintValidation":false,"skipGatewayPingValidation":false,"taskName":"workflowconfig/workflowspec-ems.json","vcenterSpec":{"licenseFile":"string","rootVcenterPassword":"string","sshThumbprint":"string","sslThumbprint":"string","storageSize":"One among:lstorage, xlstorage","vcenterHostname":"string","vcenterIp":"string","vcenterNetmask":"string","vmSize":"One among:xlarge, large, medium, small, tiny"},"vsanSpec":{"datastoreName":"string","hclFile":"string","licenseFile":"string","vsanDedup":false,"vsanName":"string"},"vxManagerSpec":{"defaultAdminUserCredentials":{"password":"Admin!23","username":"root"},"defaultRootUserCredentials":{"password":"Admin!23","username":"root"},"sshThumbprint":"string","sslThumbprint":"string","vxManagerHostName":"string"}}' https://sfo-vcf01.rainpole.io/v1/sddcs
[{"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
On This Page
SDDC Operations
post
post
get
get
patch
patch
post
