[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"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

InlineEdgeGateway1

Properties

array of EdgeGatewayUplink

edgeGatewayUplinks Required

The uplink connections for the edge gateway.

string

name Required

The name of the edge gateway.

string

description Optional

The description of the edge gateway(optional).

GatewayEdgeClusterConfig

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.

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.

EdgeGatewayBacking

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

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.

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.

EntityReference

orgRef Optional

The organization to which the gateway belongs.

EntityReference

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.

EntityReference

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.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

Show optional properties

{
	"edgeGatewayUplinks": [
		{}
	],
	"name": "string"
}

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

Vendor Extensions

This class contains the following vendor extensions defined in the spec:

x-vcloud-property-annotations:
    description:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    distributedRouterUplinkNetworkDefinition:
        x-vcloud-added-in: "36.1"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    distributedRoutingEnabled:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    edgeClusterConfig:
        x-vcloud-added-in: "34.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    edgeGatewayUplinks:
        x-vcloud-constraints:
            - constraint: NonSortable
    gatewayBacking:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    id:
        x-vcloud-constraints:
            - args:
                - arg: gateway
              constraint: Urn
            - constraint: ReadOnly
            - constraint: NonSortable
    nonDistributedRoutingEnabled:
        x-vcloud-added-in: "36.2"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    orgRef:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    orgVdc:
        x-vcloud-constraints:
            - constraint: NonSortable
        x-vcloud-deprecated-alternative: ownerRef
        x-vcloud-deprecated-in: "35.0"
    orgVdcNetworkCount:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    ownerRef:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - constraint: NonSortable
    serviceNetworkDefinition:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable

vmware-cloud-director

Used By

EdgeGateway

InlineEdgeGateway1

Properties

JSON Example

Vendor Extensions

Used By

Was this page helpful?