InlineEdgeGateway1

InlineEdgeGateway1
InlineEdgeGateway1
JSON Example
{
    "id": "string",
    "name": "string",
    "description": "string",
    "edgeGatewayUplinks": [
        {
            "uplinkId": "string",
            "uplinkName": "string",
            "subnets": {
                "values": [
                    {
                        "gateway": "string",
                        "prefixLength": 0,
                        "dnsSuffix": "string",
                        "dnsServer1": "string",
                        "dnsServer2": "string",
                        "ipRanges": {
                            "values": [
                                {
                                    "startAddress": "string",
                                    "endAddress": "string"
                                }
                            ]
                        },
                        "enabled": false,
                        "totalIpCount": 0,
                        "usedIpCount": 0,
                        "primaryIp": "string",
                        "autoAllocateIpRanges": false
                    }
                ]
            },
            "connected": false,
            "quickAddAllocatedIpCount": 0,
            "dedicated": false,
            "usingIpSpace": false,
            "natAndFirewallServiceIntention": "string",
            "vpnServiceIntention": "string",
            "vrfLiteBacked": false,
            "backingType": "string"
        }
    ],
    "distributedRoutingEnabled": false,
    "nonDistributedRoutingEnabled": false,
    "orgVdcNetworkCount": 0,
    "gatewayBacking": {
        "backingId": "string",
        "gatewayType": {},
        "networkProvider": {
            "name": "string",
            "id": "string"
        },
        "isUniversalVdcGroupEdge": false,
        "networkingTenancyEnabled": false
    },
    "orgVdc": {
        "name": "string",
        "id": "string"
    },
    "ownerRef": {
        "name": "string",
        "id": "string"
    },
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "serviceNetworkDefinition": "string",
    "distributedRouterUplinkNetworkDefinition": "string",
    "deploymentMode": "string",
    "edgeClusterConfig": {
        "primaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string",
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        },
        "secondaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string",
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        },
        "secondaryEdgeClusters": [
            {
                "edgeClusterRef": {
                    "name": "string",
                    "id": "string"
                },
                "backingId": "string",
                "networkProviderScope": "string",
                "nsxTManagerRef": {
                    "name": "string",
                    "id": "string"
                }
            }
        ]
    }
}
string
id
Optional

The unique identifier of the edge gateway.

string
name
Required

The name of the edge gateway.

string
description
Optional

The description of the edge gateway(optional).

edgeGatewayUplinks
Required

The uplink connections for the edge gateway.

boolean
distributedRoutingEnabled
Optional

A flag indicating whether distributed routing is enabled or not. The default is false and updatable for NSX-V edges. The value is always true for NSX-T edges.

boolean
nonDistributedRoutingEnabled
Optional

A flag indicating whether non-distributed routing is enabled or not. The default is false and updatable only for NSX-T edges. The value is always true for NSX-V edges.

integer
orgVdcNetworkCount
Optional

The number of Org vDC networks connected to the gateway.

gatewayBacking
Optional

The backing details of the edge gateway

orgVdc
Optional

Entity reference used to describe VCD entities

ownerRef
Optional

Entity reference used to describe VCD entities

orgRef
Optional

Entity reference used to describe VCD entities

string
serviceNetworkDefinition
Optional

The network definition in CDIR form that DNS and DHCP service on an NSX-T edge will run on. The subnet prefix length must be 27. This property applies to creating or importing an NSX-T Edge. This is not supported for VMC. If nothing is set, the default is 192.168.255.225/27. The DHCP listener IP network is on 192.168.255.225/30. The DNS listener IP network is on 192.168.255.228/32. This field cannot be updated.

string
distributedRouterUplinkNetworkDefinition
Optional

The uplink network is the network that is used to connect the distributed router to the gateway. This is in CIDR form. This is not set if distributed routing is disabled. This field cannot be updated. This applies to NSX-V edges only.

string
deploymentMode
Optional

The deployment mode for this Edge Gateway. Supported Edge Gateway deployment modes are:

  • ACTIVE_STANDBY - a deployment mode where there are two instances of the backing NSX-T router; one actively handling the traffic, and the other is in standby mode. Most of the Edge Gateway services are supported, such as NAT, Firewall and VPN. Edge Cluster Configuration is required. If Edge Cluster is not specified, the gateway will default to the Edge Cluster of the uplink Provider Gateway's backing Tier-0 router.
  • DISTRIBUTED_ONLY - a deployment mode where the backing NSX-T Tier-1 router is distributed across all ESXi hosts within a NSX-T transport zone. This mode is designed to handle east-west traffic within the data center efficiently. Edge Gateway services such as NAT, Firewall and VPN are not supported. Edge Cluster Configuration should not be specified.
Default mode is ACTIVE_STANDBY. This field applies to NSX-T Edge Gateways only.
edgeClusterConfig
Optional

Represents the Edge Cluster Configuration for a given Edge Gateway.