NSX-T Data Center REST API

Get BGP neighbor status for the route controller

Returns the status of all the BGP neighbors for the given route controller.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/route-controllers/{route-controller-id}/bgp/neighbors/status

Request Headers:

n/a

Query Parameters:

RouteControllerL2L3RuntimeRequestParameters+

RouteControllerL2L3RuntimeRequestParameters (schema)

Name	Description	Type	Notes
bgp_neighbor_type	Bgp neighbor type Bgp neighbor type that can be used as filter for T0 bgp neighbor status filter.	string	Enum: USER
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point Enforcement point path.	string
include_mark_for_delete_objects	Include objects that are marked for deletion in results If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending	If true, results are sorted in ascending order	boolean
sort_by	Field by which records are sorted	string
stats_type	Segment statistics type This indicates the type of statistics being requested. We support statistics from the data plane.	string	Enum: DATAPATH_STATS
transport_node_id	Transport Node Id Identifier of the transport node. This is a UUID.	string
virtual_network_appliance_path	Virtual network appliance path Contains string path of virtual network appliance. Virtual network appliance cluster should be member of enforcement point.	string

Request Body:

n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/route-controllers/RC-1/bgp/neighbors/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

RouteControllerBgpNeighborsStatusListResult+

RouteControllerBgpNeighborsStatusListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
last_update_timestamp	Last updated timestamp Timestamp when the bgp neighbor status statistics was last updated.	EpochMsTimestamp	Required Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Results Results	array of RouteControllerBgpNeighborStatus
route_controller_path	Route Controller Path Route controller path	string	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "route_controller_path": "/infra/route-controllers/RC-1", "results": [ { "virtual_network_appliance_path": "/infra/sites/default/enforcement-points/default/virtual-network-appliance-clusters/virtual-network-appliance-cluster_1/virtual-network-appliances/vna_1", "route_controller_path": "/infra/route-controllers/RC-1", "source_address": "40.40.40.101", "local_port": 0, "neighbor_address": "40.40.40.11", "remote_port": 0, "remote_as_number": "522", "connection_state": "IDLE", "messages_received": 0, "messages_sent": 0, "time_since_established": 0, "total_in_prefix_count": 0, "total_out_prefix_count": 0, "address_families": [ { "type": "IPV4_UNICAST", "in_prefix_count": 0, "out_prefix_count": 0 }, { "type": "L2VPN_EVPN", "in_prefix_count": 0, "out_prefix_count": 0 } ], "connection_drop_count": 0, "established_connection_count": 0, "hold_time": 180, "keep_alive_interval": 60, "graceful_restart_mode": "HELPER_ONLY", "announced_capabilities": [], "negotiated_capability": [], "neighbor_router_id": "0.0.0.0", "type": "USER", "last_update_timestamp": 1763594187816 }, { "virtual_network_appliance_path": "/infra/sites/default/enforcement-points/default/virtual-network-appliance-clusters/virtual-network-appliance-cluster_1/virtual-network-appliances/vna_1", "route_controller_path": "/infra/route-controllers/RC-1", "source_address": "40.40.40.101", "local_port": 0, "neighbor_address": "40.40.40.10", "remote_port": 0, "remote_as_number": "521", "connection_state": "IDLE", "messages_received": 0, "messages_sent": 0, "time_since_established": 0, "total_in_prefix_count": 0, "total_out_prefix_count": 0, "address_families": [ { "type": "IPV4_UNICAST", "in_prefix_count": 0, "out_prefix_count": 0 }, { "type": "L2VPN_EVPN", "in_prefix_count": 0, "out_prefix_count": 0 } ], "connection_drop_count": 0, "established_connection_count": 0, "hold_time": 180, "keep_alive_interval": 60, "graceful_restart_mode": "HELPER_ONLY", "announced_capabilities": [], "negotiated_capability": [], "neighbor_router_id": "0.0.0.0", "type": "USER", "last_update_timestamp": 1763594187816 }, { "virtual_network_appliance_path": "/infra/sites/default/enforcement-points/default/virtual-network-appliance-clusters/virtual-network-appliance-cluster_1/virtual-network-appliances/vna_2", "route_controller_path": "/infra/route-controllers/RC-1", "source_address": "40.40.40.101", "local_port": 63590, "neighbor_address": "40.40.40.11", "remote_port": 179, "remote_as_number": "522", "connection_state": "ESTABLISHED", "messages_received": 1157, "messages_sent": 1156, "time_since_established": 68988, "total_in_prefix_count": 1, "total_out_prefix_count": 2, "address_families": [ { "type": "IPV4_UNICAST", "in_prefix_count": 0, "out_prefix_count": 0 }, { "type": "L2VPN_EVPN", "in_prefix_count": 1, "out_prefix_count": 2 } ], "connection_drop_count": 0, "established_connection_count": 1, "hold_time": 180, "keep_alive_interval": 60, "graceful_restart_mode": "HELPER_ONLY", "announced_capabilities": [ "addPath L2VPN EVPN Rx", "IPv4 Unicast", "L2VPN EVPN", "hostName advHostName", "addPath IPv4 Unicast Rx", "routeRefresh", "4byteAs" ], "negotiated_capability": [ "addPath L2VPN EVPN Rx", "L2VPN EVPN", "hostName rcvHostName", "routeRefresh", "4byteAs" ], "neighbor_router_id": "192.168.100.41", "type": "USER", "last_update_timestamp": 1763594187816 }, { "virtual_network_appliance_path": "/infra/sites/default/enforcement-points/default/virtual-network-appliance-clusters/virtual-network-appliance-cluster_1/virtual-network-appliances/vna_2", "route_controller_path": "/infra/route-controllers/RC-1", "source_address": "40.40.40.101", "local_port": 64794, "neighbor_address": "40.40.40.10", "remote_port": 179, "remote_as_number": "521", "connection_state": "ESTABLISHED", "messages_received": 1158, "messages_sent": 1156, "time_since_established": 68988, "total_in_prefix_count": 2, "total_out_prefix_count": 2, "address_families": [ { "type": "IPV4_UNICAST", "in_prefix_count": 0, "out_prefix_count": 0 }, { "type": "L2VPN_EVPN", "in_prefix_count": 2, "out_prefix_count": 2 } ], "connection_drop_count": 0, "established_connection_count": 1, "hold_time": 180, "keep_alive_interval": 60, "graceful_restart_mode": "HELPER_ONLY", "announced_capabilities": [ "addPath L2VPN EVPN Rx", "IPv4 Unicast", "L2VPN EVPN", "hostName advHostName", "addPath IPv4 Unicast Rx", "routeRefresh", "4byteAs" ], "negotiated_capability": [ "addPath L2VPN EVPN Rx", "L2VPN EVPN", "hostName rcvHostName", "routeRefresh", "4byteAs" ], "neighbor_router_id": "192.168.100.40", "type": "USER", "last_update_timestamp": 1763594187816 } ] }