EdgeGatewayUplink

EdgeGatewayUplink

The uplink (i.e. external network/provider gateway) that the edge gateway is connected to. This also contains the external network IPs that are allocated to the edge.

JSON Example

{
    "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"
}

string

uplinkId

Optional

The identifier of the external network/provider gateway this edge gateway is connected to.

string

uplinkName

Optional

The name of the external network/provider gateway this edge gateway is connected to.

EdgeGatewaySubnets

subnets

Optional

List of Subnets of an edge gateway

boolean

connected

Optional

Whether or not the gateway is connected to this uplink. This value defaults to true if it is not set. When filtering by this field, if the filter is false, all gateways that have 0 connected uplinks will be returned, while if it is true, all gateways with at least one connected uplink will be returned.

integer

quickAddAllocatedIpCount

Optional

If set on create or update api calls, the specified number of IP addresses will be additionally allocated for this uplink. IPs will be allocated from multiple subnets if needed.

boolean

dedicated

Optional

This property can be set to make the provider gateway be exclusively used by this edge gateway. This property is read-only for Provider gateways using IP Space. If the associated provider gateway is using IP Spaces, user can update the provider gateway itself to dedicate it to the Organization. Provider gateways using IP Spaces cannot be dedicated to an Edge Gateway.

boolean

usingIpSpace

Optional

This fields is read-only and is set to true if the provider gateway backing the uplink (external network) is using IP Space; else, false.

string

natAndFirewallServiceIntention

Optional

The different types of NAT and firewall Rules intentions being used by the Provider Gateway backing the uplink:

• PROVIDER_GATEWAY - Allow management of NAT and firewall rules only on Provider Gateways.
• EDGE_GATEWAY - Allow management of NAT and firewall rules only on Edge Gateways.
• PROVIDER_AND_EDGE_GATEWAY - Allow management of NAT and firewall rules on both the Provider and Edge gateways.

This only applies if the Provider Gateway backing the Uplink is using IP Spaces; else, the value is unset.

string

vpnServiceIntention

Optional

The different types of IPSec and L2 VPN intentions being used by the Provider Gateway backing the uplink:

PROVIDER_GATEWAY - Allow management of IPSec VPN Tunnels only on Provider Gateways. L2 VPN will not be manageable on connected Edge Gateways, as L2 VPN is not currently supported for Provider Gateways.

EDGE_GATEWAY - Allow management of IPSec and L2 VPN Tunnels only on Edge Gateways.

PROVIDER_AND_EDGE_GATEWAY - Allow management of IPSec VPN Tunnels on both the Provider and Edge Gateways, and L2 VPN on Edge Gateways. This only applies if the Provider Gateway backing the Uplink is using IP Spaces; else, the value is unset.

boolean

vrfLiteBacked

Optional

Whether the associated external network is backed by a NSX-T VRF-Lite Tier-0.

string

backingType

Optional

Type of backing for the network this interface is connected to. Can be NSXT_TIER0, NSXT_VRF_TIER0 or IMPORTED_T_LOGICAL_SWITCH

Availability

Added in 32.0