SddcSpec

Spec contains parameters for creating/bringing up an SDDC

Properties

array of SddcHostSpec

hostSpecs Required

List of Host Specs

SddcVcenterSpec

vcenterSpec Required

vCenter Spec

SddcClusterSpec

clusterSpec Required

Cluster Spec

DnsSpec

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

SddcNsxtSpec

nsxtSpec Optional

NSX-T Spec

array of string

excludedComponents Optional

Components to be excluded

array of PscSpec

pscSpecs Optional

PSC VM spec

RemoteSiteSpec

remoteSiteSpec Optional

Remote site spec. This field is deprecated and will be removed in a future release.

string

esxLicense Optional

License for the ESXi hosts

SddcManagerSpec

sddcManagerSpec Optional

SDDC Manager Virtual Machine spec

SecuritySpec

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

vsanSpec Optional

VSAN Spec

VxManagerSpec

vxManagerSpec Optional

VxManager Spec

JSON Example

Show optional properties

{
    "sddcId": "sfo01-m01",
    "taskName": "workflowconfig/workflowspec-ems.json"
}

{
    "ceipEnabled": "true",
    "dvSwitchVersion": "One among:7.0.0, 7.0.2, 7.0.3",
    "excludedComponents": "One among:NSX, VSAN, EsxThumbprintValidation, CEIP, Backup",
    "fipsEnabled": "true",
    "sddcId": "sfo01-m01",
    "shouldCleanupVsan": "false",
    "taskName": "workflowconfig/workflowspec-ems.json"
}

[{"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

Parameter To

Retry SDDC
Validate SDDC Spec
Create SDDC

Returned By

Convert To JSON Spec

SddcSpec

Properties

JSON Example

Parameter To

Returned By

Was this page helpful?