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
Parameters
Parameters
string
tier-0-id
Required
No description available
string
locale-service-id
Required
No description available
string
neighbor-id
Required
No description available
Query Parameters
Query Parameters
integer
count
Optional
Number of routes to retrieve
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
enforcement_point_path
Optional
Enforcement point path
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
No description available
string
sort_by
Optional
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
}
]
}
string
file_name
Optional
File name set by HTTP server if API returns CSV result as a file.
array of
BgpNeighborRouteDetailsCsvRecord
results
Optional
BGP neighbor learned/advertised route details.
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}/routes?format=csv
Errors
404
The requested resource could not be found but may be available again in the future.
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).
On This Page
Locale Services BGP Operations
delete
get
patch
