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

UniversalRoute

A Route for a Universal Router.

Properties

string

networkProviderScope Required

The network provider scope for the given route. There can only be one route per fault domain for a Universal Route.

EgressPointReference

defaultEgress Optional

For a given route, routing by default will go through the default egress point. Every valid/configured route will have a default egress point.

string

errorMessage Optional

EgressPointReference

standbyEgress Optional

A standby egress point can be configured for failover of routes in case there is an issue routign to the default egress point.

UniversalRoutingStatus

status Optional

The status of the route (whether it’s realized, failed, etc.).

JSON Example

Show optional properties

{
	"networkProviderScope": "string"
}

{
	"defaultEgress": {
		"egressPointId": "string",
		"gatewayRef": {
			"id": "string",
			"name": "string"
		},
		"vdcRef": {
			"id": "string",
			"name": "string"
		}
	},
	"errorMessage": "string",
	"networkProviderScope": "string",
	"standbyEgress": {
		"egressPointId": "string",
		"gatewayRef": {
			"id": "string",
			"name": "string"
		},
		"vdcRef": {
			"id": "string",
			"name": "string"
		}
	},
	"status": "enum"
}

Vendor Extensions

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

x-vcloud-property-annotations:
    defaultEgress:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    errorMessage:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    networkProviderScope:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    standbyEgress:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    status:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable