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

Validate Edge Cluster Spec

Description

Validate an Edge Cluster spec

Request

Request

URL

URL


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

Request Body

Request Body

EdgeClusterCreationSpec of type(s) application/json Required

NSX-T Edge cluster creation data to be validated

{
	"asn": 0,
	"edgeAdminPassword": "string",
	"edgeAuditPassword": "string",
	"edgeClusterName": "string",
	"edgeClusterProfileSpec": {
		"bfdAllowedHop": 0,
		"bfdDeclareDeadMultiple": 0,
		"bfdProbeInterval": 0,
		"edgeClusterProfileName": "string",
		"standbyRelocationThreshold": 0
	},
	"edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
	"edgeClusterType": "One among: NSX-T",
	"edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
	"edgeNodeSpecs": [
		{
			"clusterId": "string",
			"edgeNodeName": "string",
			"edgeTep1IP": "string",
			"edgeTep2IP": "string",
			"edgeTepGateway": "string",
			"edgeTepVlan": 0,
			"interRackCluster": false,
			"managementGateway": "string",
			"managementIP": "string"
		}
	],
	"edgeRootPassword": "string",
	"mtu": 0,
	"tier0Name": "string",
	"tier0RoutingType": "One among: EBGP, STATIC",
	"tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
	"tier1Name": "string"
}
integer as int64
asn Required

ASN to be used for the edge cluster


string
edgeAdminPassword Required

Edge Password for admin user


string
edgeAuditPassword Required

Edge Password for audit


string
edgeClusterName Required

Name for the edge cluster.


edgeClusterProfileSpec Required

Specifications for Edge Node


string
edgeClusterProfileType Required

Type of edge cluster profile


string
edgeClusterType Required

Type of edge cluster


string
edgeFormFactor Required

Edge Form Factor


array of NsxTEdgeNodeSpec
edgeNodeSpecs Required

Specifications for Edge Node. Number of Edge Nodes cannot exceed 8 if HA mode is ACTIVE-ACTIVE and can not exceed 2 if HA mode is ACTIVE-STANDBY


string
edgeRootPassword Required

Edge Password for root user.


string
tier1Name Required

Name for the T1 .


integer as int32
mtu Required

Maximum transmission unit


string
tier0Name Required

Name for the T0 .


string
tier0RoutingType Required

Tier 0 Routing type -eg eBGP, Static


string
tier0ServicesHighAvailability Required

High-availability Mode for Tier-0


array of string
internalTransitSubnets Introduced Changed Optional

Subnet addresses in CIDR notation that are used to assign addresses to logical links connecting service routers and distributed routers


array of string
transitSubnets Introduced Changed Optional

Transit subnet addresses in CIDR notation that are used to assign addresses to logical links connecting Tier-0 and Tier-1s

Response

Response

Response Body

Response Body

202 Accepted returns Validation of type(s) application/json
{
	"additionalProperties": {
		"key": "string"
	},
	"description": "string",
	"executionStatus": "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
	"id": "string",
	"resultStatus": "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, CANCELLATION_IN_PROGRESS",
	"validationChecks": [
		{
			"description": "string",
			"errorResponse": {
				"arguments": [
					"string"
				],
				"causes": [
					{
						"message": "string",
						"type": "string"
					}
				],
				"context": {
					"key": "string"
				},
				"errorCode": "string",
				"errorType": "string",
				"message": "string",
				"nestedErrors": "Error Object",
				"referenceToken": "string",
				"remediationMessage": "string"
			},
			"nestedValidationChecks": "ValidationCheck Object",
			"resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
			"severity": "One among: WARNING, ERROR, INFO"
		}
	]
}
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

400

Bad Request


500

InternalServerError

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"asn":0,"edgeAdminPassword":"string","edgeAuditPassword":"string","edgeClusterName":"string","edgeClusterProfileSpec":{"bfdAllowedHop":0,"bfdDeclareDeadMultiple":0,"bfdProbeInterval":0,"edgeClusterProfileName":"string","standbyRelocationThreshold":0},"edgeClusterProfileType":"One among: DEFAULT, CUSTOM","edgeClusterType":"One among: NSX-T","edgeFormFactor":"One among: XLARGE, LARGE, MEDIUM, SMALL","edgeNodeSpecs":[{"clusterId":"string","edgeNodeName":"string","edgeTep1IP":"string","edgeTep2IP":"string","edgeTepGateway":"string","edgeTepVlan":0,"firstNsxVdsUplink":"One among: uplink1, uplink2, uplink3, uplink4","interRackCluster":false,"managementGateway":"string","managementIP":"string","secondNsxVdsUplink":"One among: uplink1, uplink2, uplink3, uplink4","uplinkNetwork":[{"asnPeer":0,"bgpPeerPassword":"string","bgpPeers":[{"asn":0,"ip":"string","password":"string"}],"peerIP":"string","uplinkInterfaceIP":"string","uplinkVlan":0}]}],"edgeRootPassword":"string","internalTransitSubnets":["string"],"mtu":0,"tier0Name":"string","tier0RoutingType":"One among: EBGP, STATIC","tier0ServicesHighAvailability":"One among: ACTIVE_ACTIVE, ACTIVE_STANDBY","tier1Name":"string","transitSubnets":["string"]}' https://sfo-vcf01.rainpole.io/v1/edge-clusters/validations


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

Was this page helpful?