EdgeClusterCreationSpec

EdgeClusterCreationSpec
EdgeClusterCreationSpec

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

JSON Example
{
    "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",
            "edgeTepIpAddressPool": {
                "name": "string",
                "nsxId": "string"
            },
            "edgeTepVlan": 0,
            "firstNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
            "interRackCluster": false,
            "managementGateway": "string",
            "managementIP": "string",
            "vmManagementPortgroupVlan": 0,
            "vmManagementPortgroupName": "string",
            "secondNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
            "uplinkNetwork": [
                {
                    "asnPeer": 0,
                    "bgpPeerPassword": "string",
                    "bgpPeers": [
                        {
                            "asn": 0,
                            "ip": "string",
                            "password": "string"
                        }
                    ],
                    "peerIP": "string",
                    "uplinkInterfaceIP": "string",
                    "uplinkVlan": 0
                }
            ]
        }
    ],
    "newIpAddressPoolSpecs": [
        {
            "description": "string",
            "ignoreUnavailableNsxtCluster": false,
            "name": "string",
            "subnets": [
                {
                    "cidr": "string",
                    "gateway": "string",
                    "ipAddressPoolRanges": [
                        {
                            "end": "string",
                            "start": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "edgeRootPassword": "string",
    "internalTransitSubnets": [
        "string"
    ],
    "mtu": 0,
    "skipTepRoutabilityCheck": false,
    "tier0Name": "string",
    "tier0RoutingType": "One among: EBGP, STATIC",
    "tier0ServicesHighAvailability": "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY",
    "tier1Name": "string",
    "tier1Unhosted": false,
    "transitSubnets": [
        "string"
    ]
}
integer As int64 As int64
asn
Optional

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

This specification contains edge cluster profile configurations

string
edgeClusterProfileType
Required

Type of edge cluster profile

string
edgeClusterType
Required

Type of edge cluster

string
edgeFormFactor
Required

Edge Form Factor

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

newIpAddressPoolSpecs
Optional

Specifications for new NSX IP address pool(s)

string
edgeRootPassword
Required

Edge Password for root user.

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

integer As int32 As int32
mtu
Required

Maximum transmission unit

boolean
skipTepRoutabilityCheck
Optional

Set to true to bypass normal ICMP-based check of Edge TEP / host TEP routability (default is false, meaning do check)

string
tier0Name
Optional

Name for the Tier-0

string
tier0RoutingType
Optional

Tier 0 Routing type -eg eBGP, Static

string
tier0ServicesHighAvailability
Optional

High-availability Mode for Tier-0

string
tier1Name
Optional

Name for the Tier-1

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