InlineEdgeGateway1
Properties
The description of the edge gateway(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.
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.
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.
The backing details of the edge gateway; only required if importing an NSX-T router.
The unique identifier of the edge gateway.
The name of the edge gateway.
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.
The organization vDC which the gateway belongs to. Property is deprecated. Please use ownerRef.
The number of Org vDC networks connected to the gateway.
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.
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.
JSON Example
{
"description": "string",
"distributedRouterUplinkNetworkDefinition": "string",
"distributedRoutingEnabled": false,
"edgeClusterConfig": {
"primaryEdgeCluster": {
"backingId": "string",
"edgeClusterRef": {
"id": "string",
"name": "string"
}
},
"secondaryEdgeCluster": {
"backingId": "string",
"edgeClusterRef": {
"id": "string",
"name": "string"
}
}
},
"edgeGatewayUplinks": [
{
"backingType": "string",
"connected": false,
"dedicated": false,
"quickAddAllocatedIpCount": 0,
"subnets": {
"values": [
{
"autoAllocateIpRanges": false,
"dnsServer1": "string",
"dnsServer2": "string",
"dnsSuffix": "string",
"enabled": false,
"gateway": "string",
"ipRanges": {
"values": [
{
"endAddress": "string",
"startAddress": "string"
}
]
},
"prefixLength": 0,
"primaryIp": "string",
"totalIpCount": 0,
"usedIpCount": 0
}
]
},
"uplinkId": "string",
"uplinkName": "string",
"usingIpSpace": false,
"vrfLiteBacked": false
}
],
"gatewayBacking": {
"backingId": "string",
"gatewayType": "enum",
"networkProvider": {
"id": "string",
"name": "string"
}
},
"id": "string",
"name": "string",
"nonDistributedRoutingEnabled": false,
"orgRef": {
"id": "string",
"name": "string"
},
"orgVdc": {
"id": "string",
"name": "string"
},
"orgVdcNetworkCount": 0,
"ownerRef": {
"id": "string",
"name": "string"
},
"serviceNetworkDefinition": "string"
}
Used By
EdgeGateway
What's changed in v36.3?
Added Properties
distributedRouterUplinkNetworkDefinition
nonDistributedRoutingEnabled
