SyntheticClassEdgeGatewayAllOf1

Description not available

Properties

string
description Optional

The description of the edge gateway(optional).


boolean
distributedRoutingEnabled Optional

A flag indicating whether distributed routing is enabled or not. The default is false.


edgeClusterConfig Optional

Edge Cluster Configuration for the Edge Gateway. Can be specified if a gateway needs to be placed on a specific set of Edge Clusters. For NSX-T Edges, user should specify the ID of the NSX-T edge cluster as the value of primaryEdgeCluster’s backingId. The gateway defaults to the Edge Cluster of the connected External Network’s backing Tier-0 router, if nothing is specified. The value of secondaryEdgeCluster will be set to NULL for NSX-T edge gateways. For NSX-V Edges, this is read-only and the legacy API must be used for edge specific placement.


edgeGatewayUplinks Optional

The uplink connections for the edge gateway.


gatewayBacking Optional

The backing details of the edge gateway; only required if importing an NSX-T router.


string
id Optional

The unique identifier of the edge gateway.


string
name Optional

The name of the edge gateway.


orgRef Optional

The organization to which the gateway belongs.


orgVdc Optional

The organization vDC which the gateway belongs to. Property is deprecated. Please use ownerRef.


integer
orgVdcNetworkCount Optional

The number of Org vDC networks connected to the gateway.


ownerRef Optional

The organization vDC or vDC Group that this edge gateway belongs to. If the ownerRef is set to a vDC Group, this gateway will be available across all the participating Organization vDCs in the vDC Group.


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.22527. The DHCP listener IP network is on 192.168.255.22530. The DNS listener IP network is on 192.168.255.22832. This field cannot be updated.

JSON Example

{
    "description": "string",
    "distributedRoutingEnabled": false,
    "edgeClusterConfig": {
        "primaryEdgeCluster": {
            "backingId": "string",
            "edgeClusterRef": {
                "id": "string",
                "name": "string"
            }
        },
        "secondaryEdgeCluster": {
            "backingId": "string",
            "edgeClusterRef": {
                "id": "string",
                "name": "string"
            }
        }
    },
    "edgeGatewayUplinks": [
        {
            "connected": false,
            "dedicated": false,
            "quickAddAllocatedIpCount": 0,
            "subnets": {
                "values": [
                    {}
                ]
            },
            "uplinkId": "string",
            "uplinkName": "string",
            "vrfLiteBacked": false
        }
    ],
    "gatewayBacking": {
        "backingId": "string",
        "gatewayType": "enum",
        "networkProvider": {
            "id": "string",
            "name": "string"
        }
    },
    "id": "string",
    "name": "string",
    "orgRef": {
        "id": "string",
        "name": "string"
    },
    "orgVdc": {
        "id": "string",
        "name": "string"
    },
    "orgVdcNetworkCount": 0,
    "ownerRef": {
        "id": "string",
        "name": "string"
    },
    "serviceNetworkDefinition": "string"
}
Used By

EdgeGateway
Feedback

Was this page helpful?