NsxTEdgeNodeSpec

NsxTEdgeNodeSpec
NsxTEdgeNodeSpec

This specification contains configuration inputs required to deploy and configure an edge node

JSON Example
{
    "edgeNodeName": "string",
    "managementIP": "string",
    "managementGateway": "string",
    "vmManagementPortgroupVlan": 0,
    "vmManagementPortgroupName": "string",
    "edgeTepGateway": "string",
    "edgeTep1IP": "string",
    "edgeTep2IP": "string",
    "edgeTepIpAddressPool": {
        "name": "string",
        "nsxId": "string"
    },
    "edgeTepVlan": 0,
    "clusterId": "string",
    "interRackCluster": false,
    "uplinkNetwork": [
        {
            "uplinkVlan": 0,
            "uplinkInterfaceIP": "string",
            "peerIP": "string",
            "asnPeer": 0,
            "bgpPeerPassword": "string",
            "bgpPeers": [
                {
                    "ip": "string",
                    "asn": 0,
                    "password": "string"
                }
            ]
        }
    ],
    "firstNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8",
    "secondNsxVdsUplink": "One among: uplink1, uplink2, uplink3, uplink4, uplink5, uplink6, uplink7, uplink8"
}
string As ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$
edgeNodeName
Required

Edge Node Name

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\/(([0-9])|([12][0-9])|(3[0-2]))$
managementIP
Required

Management Interface IP

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])$
managementGateway
Required

Management Gateway IP

integer As int32 As int32
vmManagementPortgroupVlan
Optional
Constraints: minimum: 0 maximum: 4094

Management Vlan Id

string
vmManagementPortgroupName
Optional

Management Network Name

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])$
edgeTepGateway
Optional

Edge TEP Gateway IP

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\/(([0-9])|([12][0-9])|(3[0-2]))$
edgeTep1IP
Optional

Edge TEP 1 IP

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\/(([0-9])|([12][0-9])|(3[0-2]))$
edgeTep2IP
Optional

Edge TEP 2 IP

edgeTepIpAddressPool
Optional

This specification indicates which NSX IP pool to use for an Edge node's TEPs

integer As int32 As int32
edgeTepVlan
Required
Constraints: minimum: 2 maximum: 4094

Edge TEP VLAN

string
clusterId
Optional

ID of vSphere cluster where the Edge node will be deployed

boolean
interRackCluster
Optional

Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks)

uplinkNetwork
Optional

Specifications of Tier0 uplinks for the Edge Node. For edge cluster creation uplink network is mandatory otherwise its optional an field

string As (uplink1|uplink2|uplink3|uplink4|uplink5|uplink6|uplink7|uplink8)
firstNsxVdsUplink
Optional

First NSX enabled VDS uplink for the Edge node

string As (uplink1|uplink2|uplink3|uplink4|uplink5|uplink6|uplink7|uplink8)
secondNsxVdsUplink
Optional

Second NSX enabled VDS uplink for the Edge node