NSX-T Data Center REST API

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:

Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes
/policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>/advertised-routes
Request Headers:
n/a
Query Parameters:
BgpRoutesRequestParameters+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/to-onprem/advertised-routes

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BgpNeighborRoutesListResult+

Example Response:

{ "neighbor_path": "/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/to-onprem", "enforcement_point_path": "/infra/deployment-zones/default/enforcement-points/default", "edge_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, "med": 1, "as_path": 1000, "route_origin": "INTERNAL" }, { "network": "40.40.40.0/24", "next_hop": "40.40.40.10", "local_pref": 0, "med": 1, "as_path": 1000, "route_origin": "EXTERNAL" }] }, { "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, "med": 1, "as_path": 1000, "route_origin": "INTERNAL" }, { "network": "40.40.40.0/24", "next_hop": "40.40.40.10", "local_pref": 0, "med": 1, "as_path": 1000, "route_origin": "EXTERNAL" }] }] }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: