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

EdgeGateway

An edge gateway object

AllOf

This class requires all of the following:

NetworkingObjectStatus

InlineEdgeGateway1

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",
	"status": "enum"
}

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
    status:
        x-vcloud-added-in: "33.0"
        x-vcloud-constraints:
            - constraint: ReadOnly

vmware-cloud-director

Availability

Added in 32.0

Property Of

InlineEdgeGateways1

Parameter To

Create Edge Gateway
Update Edge Gateway

Returned By

Get Edge Gateway