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

Get Route Advertisement

Description

Retrieve the list of subnets that will be advertised so that the Edge Gateway can route out to the connected external network. Org vDC networks that are in any of these subnets can then be routed out to the external networks.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/advertisement
Copy

Path Parameters

Path Parameters

string
gatewayId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns RouteAdvertisement of type(s) application/json;version=37.1
{
    "subnets": [
        "100.64.1.0/24",
        "fc7e:f206:db42::/48"
    ]
}
boolean
enable Optional

True means that the subnets will be advertised. The default is true.


array of string
subnets Optional

List of subnets that will be advertised so that the Edge Gateway can route out to the connected external network. Each value is in CIDR format. Note that the CIDR value will automatically be converted to its network definition based on the prefix length.

Errors

Errors

Error
404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/advertisement


[{"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
Availability
Added in 34.0
Edge Gateway Route Advertisement Operations
Feedback

Was this page helpful?