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

UniversalRoutes

List of routes associated with a Universal Router.

Properties

integer

keepAliveTimer Optional

The Keep Alive Timer is the frequency (in seconds) at which the Universal Router seeds Keep Alive messages to its egress peers.

array of string

providerScopesToForceUnconfigure Optional

The list network provider scopes whose route will be unconfigure forcefully. This means that a route that is in state that normally shouldn’t be unconfigurable (i.e. NSX or remote vCD site is down) will still be unconfigured. Errors may be ignored. Note that this force option also affects any route update where a network provider’s egress point is modified/changed. vCD will first unconfigure any existing egress point before configuring the new egress point.

array of UniversalRoute

values Optional

The list of Universal Routes.

JSON Example

{
	"keepAliveTimer": 0,
	"providerScopesToForceUnconfigure": [
		"string"
	],
	"values": [
		{
			"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:
    keepAliveTimer:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    providerScopesToForceUnconfigure:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable

vmware-cloud-director

Property Of

UniversalEgressRoutes

Parameter To

Update Universal Routes

Returned By

Get Universal Routes