NSX-T Data Center REST API

Get BGP neighbor status for the Tier0

Returns the status of all the BGP neighbors for the given Tier0.
To get BGP neighbor status for a particular enforcement point,
parameter "enforcement_point_path=<enforcement_point_path>" needs to be specified.
If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched.
To get BGP neighbors status for the logical router from particular edge node,
parameter "edge_path=<edge_path>" needs to be specified.
If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.

Request:

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

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc/locale-services/defalt/bgp/neighbors/status?enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

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

Example Response:

{ "cursor": "00361b9f1d54-2f05-441e-9851-c42518cc8b1dasdfds", "sort_ascending": true, "sort_by": "displayName", "result_count": 1, "tier0_path": "/infra/sites/default/enforcement-points/default", "results": [{ "edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7", "source_address": "10.1.1.1", "neighbor_address": "10.1.2.1", "remote_as_number": "1", "remote_port": 179, "local_port": 179, "connection_status": "CONNECTED", "messages_received": 12, "messages_sent": 10, "connection_drop_count": 0, "hold_time": 180, "keep_alive_time": 30, "graceful_restart": true, "last_updated_timestamp": 11999191991991 }] }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: