Get BGP Neighbor Advertised Routes
Returns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled. The query parameter “source=cached” is not supported.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
| required |
|
string | Not available |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
integer | Number of routes to retrieve |
| optional |
|
string | Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional |
|
string | Enforcement point path |
| optional |
|
string | Comma separated list of fields that should be included in query result |
| optional |
|
integer | Maximum number of results to return in this page (server may return fewer) |
| optional |
|
boolean | Not available |
| optional |
|
string | Field by which records are sorted |
Response
Response
Response BodyResponse Body
200 OK returns
BgpNeighborRoutesListResult
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"cursor": "string",
"result_count": 0,
"results": [
{
"egde_node_routes": [
{
"routes": [
{
"as_path": "string",
"local_pref": 0,
"med": 0,
"network": "string",
"next_hop": "string",
"weight": 0
}
],
"source_address": "string",
"transport_node_id": "string"
}
],
"enforcement_point_path": "string",
"neighbor_path": "string"
}
],
"sort_ascending": false,
"sort_by": "string"
}| Property Name | Type | Description |
|---|---|---|
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| cursor | string |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
| result_count | integer |
Count of results found (across all pages), set only on first page |
| results | array of BgpNeighborRoutes |
Paged Collection of Bgp neighbor routes. |
| sort_ascending | boolean |
If true, results are sorted in ascending order |
| sort_by | string |
Field by which records are sorted |
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes
Errors
| Code | Returns | Description |
|---|---|---|
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | The requested resource could not be found but may be available again in the future. |
On This Page
Locale Services BGP Operations
delete
get
patch
