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

EdgeClusterCreationSpec

This specification contains the parameters required to add a NSX-T edge cluster spanning multiple VI clusters.

Properties

string

tier0ServicesHighAvailability Required

High-availability Mode for Tier-0

string

edgeAdminPassword Required

Edge Password for admin user

string

edgeAuditPassword Required

Edge Password for audit

string

edgeClusterName Required

Name for the edge cluster.

NsxTEdgeClusterProfileSpec

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

integer as int32

mtu Required

Maximum transmission unit

string

tier0Name Required

Name for the Tier-0

string

tier0RoutingType Required

Tier 0 Routing type -eg eBGP, Static

integer as int64

asn Optional

ASN to be used for the edge cluster

array of string

internalTransitSubnets Optional

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

boolean

tier1Unhosted Optional

Select whether Tier-1 being created per this spec is hosted on the new Edge cluster or not (default value is false, meaning hosted)

array of string

transitSubnets Optional

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

JSON Example

Show optional properties

{
    "edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
    "edgeClusterType": "One among: NSX-T",
    "edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY"
}

{
    "edgeClusterProfileType": "One among: DEFAULT, CUSTOM",
    "edgeClusterType": "One among: NSX-T",
    "edgeFormFactor": "One among: XLARGE, LARGE, MEDIUM, SMALL",
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY"
}

vcf-for-vxrail

Parameter To

Create Edge
Validate Edge Cluster Spec

EdgeClusterCreationSpec

Properties

JSON Example

Parameter To

Was this page helpful?