Developer Documentation
Get BGP Neighbor Routes CSV
Returns routes learned by BGP neighbor from all edge nodes on which this neighbor is currently enabled. Routes from all enforcement points are returned.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes?format=csv
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
BgpNeighborRouteDetailsInCsvFormat
{
"file_name": "string",
"results": [
{
"as_path": "string",
"local_pref": 0,
"logical_router_id": "string",
"med": 0,
"neighbor_address": "string",
"neighbor_id": "string",
"network": "string",
"next_hop": "string",
"source_address": "string",
"transport_node_id": "string",
"weight": 0
}
]
}| Property Name | Type | Description |
|---|---|---|
| file_name | string |
File name set by HTTP server if API returns CSV result as a file. |
| results | array of BgpNeighborRouteDetailsCsvRecord |
BGP neighbor learned/advertised route details. |
Errors
| Code | Returns | Description |
|---|---|---|
| 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 | Not Found |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
On This Page
Locale Services BGP Operations
delete
get
patch
