[{"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/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]

vcf-for-vxrail

Validate SDDC Spec

Description

SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/sddcs/validations

Copy

Query Parameters

string

name Optional

Validation name Deprecated: ESXI_VERSION_VALIDATION

Possible values are: JSON_SPEC_VALIDATION , SECURE_PLATFORM_AUDIT , LICENSE_KEY_VALIDATION , TIME_SYNC_VALIDATION , NETWORK_IP_POOLS_VALIDATION , NETWORK_CONFIG_VALIDATION , NETWORK_CONNECTIVITY_VALIDATION , ESXI_HOST_READINESS_VALIDATION , PASSWORDS_VALIDATION , HOST_IP_DNS_VALIDATION , CLOUDBUILDER_READY_VALIDATION , VSAN_AVAILABILITY_VALIDATION , NSXT_NETWORKS_VALIDATION , MANAGEMENT_NETWORKS_VALIDATION

boolean

redo Optional

redo

Request Body

SddcSpec of type(s) application/json Required

SDDC specification

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"
}

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 Spec

array of string

excludedComponents Optional

Components to be excluded

array of PscSpec

pscSpecs Optional

PSC VM spec

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 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

Response

200 OK Response Body>

Response Body

200 OK

Returns Validation of type(s) application/json

{
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS"
}

map of string

additionalProperties Optional

string

description Optional

Description of the validation

string

executionStatus Optional

Execution status of the validation

string

id Optional

ID of the validation

string

resultStatus Optional

Result status of the validation after it has completed its execution

array of ValidationCheck

validationChecks Optional

List of one or more validation checks that are performed as part of the validation

202 Accepted Response Body>

Response Body

202 Accepted

Returns Validation of type(s) application/json

{
    "executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
    "resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS"
}

map of string

additionalProperties Optional

string

description Optional

Description of the validation

string

executionStatus Optional

Execution status of the validation

string

id Optional

ID of the validation

string

resultStatus Optional

Result status of the validation after it has completed its execution

array of ValidationCheck

validationChecks Optional

List of one or more validation checks that are performed as part of the validation

Errors

403

Forbidden

Error

404

Not Found

Error

500

Internal Server Error

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"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"}' https://sfo-vcf01.rainpole.io/v1/sddcs/validations

vcf-for-vxrail

SDDC Operations

post

Convert To JSON Spec

post

Create SDDC

get

Get All SDDC Validations

get

Get Bringup Detail Report

get

Get Bringup Info

get

Get Bringup Validation Report

get

Get SDDC Manager Info

get

Get SDDC Validation

get

Retrieve All SDDCs

get

Retrieve SDDC

patch

Retry SDDC

patch

Retry SDDC Validation

post

Validate SDDC Spec

Validate SDDC Spec

Request

URL

Query Parameters

Request Body

Response

Response Body

200 OK

Response Body

202 Accepted

Errors

Code Samples

cURL Command

On This Page

SDDC Operations

Was this page helpful?