Create Sddc
Create SDDC
Request
URI
POST
https://{api_host}/v1/sddcs
COPY
Request Body
SDDC specification
SddcSpec
of type(s)
application/json
Optional
Show optional properties
{
"clusterSpec": {
"clusterName": "string"
},
"dnsSpec": {
"domain": "vmware.com",
"subdomain": "vcf.vmware.com"
},
"dvsSpecs": [
{
"dvsName": "string",
"networks": [
{}
],
"vmnics": [
{}
]
}
],
"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": [
{}
],
"sddcId": "sfo01-m01",
"taskName": "workflowconfig/workflowspec-ems.json",
"vcenterSpec": {
"rootVcenterPassword": "string",
"vcenterHostname": "string"
}
}{
"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": "string",
"cpuSharesValue": 0,
"memoryLimit": 0,
"memoryReservationExpandable": false,
"memoryReservationMb": 0,
"memoryReservationPercentage": 0,
"memorySharesLevel": "string",
"memorySharesValue": 0,
"name": "string",
"type": "string"
}
],
"vmFolders": {
"vmFolders": "string"
}
},
"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": [
"string"
],
"niocSpecs": [
{
"trafficType": "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
"value": "string"
}
],
"vmnics": [
"string"
]
}
],
"esxLicense": "string",
"excludedComponents": [
"string"
],
"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": "string"
}
],
"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": "string",
"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"
}
}Responses
200
OK
Returns
SddcTask
of type(s)
application/json
"SddcTask Object"
string
creationTimestamp
Optional
SDDC Task creation timestamp
string
id
Optional
Constraints:
minLength: 3
maxLength: 256
SDDC ID
localizableNamePack
Optional
A messasge pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
name
Optional
Task name
array of
sddcSubTasks
sddcSubTasks
Optional
All SDDC Sub-Tasks
string
status
Optional
SDDC Task status
202
Success
Returns
SddcTask
of type(s)
application/json
"SddcTask Object"
string
creationTimestamp
Optional
SDDC Task creation timestamp
string
id
Optional
Constraints:
minLength: 3
maxLength: 256
SDDC ID
localizableNamePack
Optional
A messasge pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
name
Optional
Task name
array of
sddcSubTasks
sddcSubTasks
Optional
All SDDC Sub-Tasks
string
status
Optional
SDDC Task status
400
SDDC already exists, Bad Request
Returns
Error
of type(s)
application/json
"Error Object"
array of
string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
array of
causes
causes
Optional
The underlying cause exceptions.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
500
Internal Server Error
Returns
Error
of type(s)
application/json
"Error Object"
array of
string
arguments
Optional
The arguments used to localize the message, Can be used by scripts to automate the error processing.
array of
causes
causes
Optional
The underlying cause exceptions.
object
context
Optional
The error context (e.g. the component where it occurred).
string
errorCode
Optional
The minor error code
string
errorType
Optional
The error type
string
message
Optional
The localized error message
string
referenceToken
Optional
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
string
remediationMessage
Optional
The localized remediation error message
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"clusterSpec":"{}","dnsSpec":"{}","dvsSpecs":["string"],"hostSpecs":["string"],"networkSpecs":["array"],"ntpServers":["string"],"sddcId:"string","taskName:"string","vcenterSpec":"{}"}' https://{api_host}/v1/sddcs
Sddc Operations
GET
Retrieve All Sddcs
POST
Create Sddc
GET
Get Bringup Info
GET
Get All Sddc Validations
POST
Validate Sddc Spec
GET
Get Sddc Validation
PATCH
Retry Sddc Validation
GET
Get Bringup Validation Report
GET
Retrieve SDDC
PATCH
Retry Sddc
GET
Get Bringup Detail Report
GET
Get Sddc Manager Info
POST
Convert To Json Spec