[{"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
Update Universal Routes
DescriptionUpdates routing configuration for a Universal Router.
Request
URLURL
https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/routing/routes
Path Parameters
Path Parameters
string
universalRouterId
Required
Request Body
Request Body
UniversalRoutes
of type(s) application/json
Required
{
"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"
}
]
}
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.
Authentication
This operation uses the following authentication methods.
Errors
Error
400
Invalid configuration.
Error
404
The specified resource was not found
Code Samples
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{"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"}]}' https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/routing/routes
[{"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
