Management Plane API >
Networking
>
Logical Routing And Services
>
Logical Routers
Get BGP neighbor learned routes
Returns routes learned by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled. It always returns realtime response.
Request:
Method:
GET
URI Path(s):
/api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<neighbor-id>/routes
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/logical-routers/875381be-a4c5-4173-8aa7-ab71695a8129/routing/bgp/neighbors/f8431964-f400-4da5-8c18-4ce4e6bd5fa5/routes
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BgpNeighborRouteDetails
+
BgpNeighborRouteDetails
(
schema
)
Name
Description
Type
Notes
logical_router_id
Logical router id
string
Required
Readonly
neighbor_address
Neighbor IP address
BGP neighbor peer IP address.
IPAddress
Required
Readonly
neighbor_id
BGP neighbor id
string
Required
Readonly
per_transport_node_routes
Route details per transport node
Array of BGP neighbor route details per transport node.
array of
RoutesPerTransportNode
Readonly
Example Response:
{ "logical_router_id": "4cca3156-bcc0-4c77-9a6a-141cb33a3844", "neighbor_address": "40.40.40.10", "per_transport_node_routes": [{ "transport_node_id": "6c9e2815-ad34-4b9c-bb95-8af87990cf5a", "source_address": "10.10.10.1", "routes": [{ "network": "2.1.4.0/24", "next_hop": "40.40.40.10", "local_pref": 0, "weight": 0, "med": 1, "as_path": 1000 }, { "network": "40.40.40.0/24", "next_hop": "40.40.40.10", "local_pref": 0, "weight": 0, "med": 1, "as_path": 1000 }] }, { "transport_node_id": "7980e91e-ba6d-11e8-9bda-020009ead346", "source_address": "50.50.50.1", "routes": [{ "network": "2.1.4.0/24", "next_hop": "40.40.40.10", "local_pref": 0, "weight": 0, "med": 1, "as_path": 1000 }, { "network": "40.40.40.0/24", "next_hop": "40.40.40.10", "local_pref": 0, "weight": 0, "med": 1, "as_path": 1000 }] }] }
Required Permissions:
read
Feature:
routing_routers
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable