[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Introduced2

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.


Properties

string
backingType Introduced Optional

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


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.


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.


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.


subnets Optional

Set of subnets this edge will have access to.


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.


boolean
usingIpSpace Introduced 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.


boolean
vrfLiteBacked Optional

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

JSON Example

{
	"backingType": "string",
	"connected": false,
	"dedicated": false,
	"quickAddAllocatedIpCount": 0,
	"subnets": {
		"values": [
			{}
		]
	},
	"uplinkId": "string",
	"uplinkName": "string",
	"usingIpSpace": false,
	"vrfLiteBacked": false
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    backingType:
        x-vcloud-added-in: "37.1"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    connected:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSortable
    dedicated:
        x-vcloud-added-in: "34.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
        x-vcloud-deprecated-alternative: Please use external network/provider gateway API to use IP Space and use the dedicatedOrg property.
        x-vcloud-deprecated-in: "37.1"
    quickAddAllocatedIpCount:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    subnets:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    uplinkId:
        x-vcloud-constraints:
            - constraint: NonSortable
    uplinkName:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    usingIpSpace:
        x-vcloud-added-in: "37.1"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    vrfLiteBacked:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 32.0
Property Of

InlineEdgeGateway1
What's changed in v37.1?

INTRODUCED (2)

Added Properties
backingType
usingIpSpace

Feedback

Was this page helpful?