[{"label":"Latest (4.5.0)","version":"latest"},{"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

Request

URL

URL


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

Query Parameters

Query Parameters

string
name Optional

Validation name Deprecated: ESXI_VERSION_VALIDATION

Possible values are: JSON_SPEC_VALIDATIONSECURE_PLATFORM_AUDITLICENSE_KEY_VALIDATIONTIME_SYNC_VALIDATIONNETWORK_IP_POOLS_VALIDATIONNETWORK_CONFIG_VALIDATIONNETWORK_CONNECTIVITY_VALIDATIONESXI_VERSION_VALIDATIONESXI_HOST_READINESS_VALIDATIONPASSWORDS_VALIDATIONHOST_IP_DNS_VALIDATIONCLOUDBUILDER_READY_VALIDATIONVSAN_AVAILABILITY_VALIDATIONNSXT_NETWORKS_VALIDATIONAVN_NETWORKS_VALIDATIONMANAGEMENT_NETWORKS_VALIDATION


boolean
redo Optional

redo


Request Body

Request Body

SddcSpec of type(s) application/json Required

SDDC specification

{
    "sddcId": "sfo01-m01",
    "taskName": "workflowconfig/workflowspec-ems.json"
}
array of SddcHostSpec
hostSpecs Required

List of Host Specs


vcenterSpec Required

vCenter Spec


clusterSpec Required

Cluster Spec


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


nsxtSpec Optional

NSX-T Spec


array of string
excludedComponents Optional

Components to be excluded


array of PscSpec
pscSpecs Optional

PSC VM spec


remoteSiteSpec Optional

Remote site spec


string
esxLicense Optional

License for the ESXi hosts


sddcManagerSpec Optional

SDDC Manager Virtual Machine spec


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 Optional

VSAN Spec


vxManagerSpec Optional

VxManager Spec

Response

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

Errors

403

Forbidden


404

Not Found


500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"ceipEnabled":"true","dvSwitchVersion":"One among:6.5.0, 7.0.0, 7.0.2, 7.0.3","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","sddcId":"sfo01-m01","shouldCleanupVsan":"false","taskName":"workflowconfig/workflowspec-ems.json"}' https://sfo-vcf01.rainpole.io/v1/sddcs/validations


[{"label":"Latest (4.5.0)","version":"latest"},{"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
Feedback

Was this page helpful?