SddcSpec
SddcSpec
Spec contains parameters for creating/bringing up an SDDC
JSON Example
{
"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.5.0, 7.0.0, 7.0.2, 7.0.3",
"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": "string",
"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": "string",
"username": "root"
}
},
"sddcId": "sfo01-m01",
"sddcManagerSpec": {
"hostname": "string",
"ipAddress": "string",
"licenseKey": "string",
"localUserPassword": "string",
"netmask": "string",
"rootUserCredentials": {
"password": "string",
"username": "root"
},
"secondUserCredentials": {
"password": "string",
"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": "string",
"username": "root"
},
"defaultRootUserCredentials": {
"password": "string",
"username": "root"
},
"sshThumbprint": "string",
"sslThumbprint": "string",
"vxManagerHostName": "string"
}
}boolean
ceipEnabled
Optional
Enable VCF Customer Experience Improvement Program
string
certificatesPassphrase
Optional
Passphrase for the vCenter / NSX certificates
string
dvSwitchVersion
Optional
The version of the distributed virtual switches to be used
string
esxLicense
Optional
License for the ESXi hosts
array of string
excludedComponents
Optional
Components to be excluded
boolean
fipsEnabled
Optional
Enable Federal Information Processing Standards
string
managementPoolName
Optional
A String identifying the network pool associated with the management domain
array of string
ntpServers
Required
List of NTP servers
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: '-'.
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
taskName
Required
Name of the task to execute