Get the status of all the BGP neighbors for the Logical Router of the given id

Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter "transport_node_id=" needs to be specified. Query parameter "source=realtime" is the only supported source.

Request:

Method:

GET

URI Path(s):

/api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/status

Request Headers:

n/a

Query Parameters:

ListByOptionalNodeIdParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	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		boolean
sort_by	Field by which records are sorted	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType
transport_node_id	Transport node id	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/logical-routers/875381be-a4c5-4173-8aa7-ab71695a8129/routing/bgp/neighbors/status?transport_node_id=f8431964-f400-4da5-8c18-4ce4e6bd5fa5&source=realtime

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BgpNeighborsStatusListResult+

BgpNeighborsStatusListResult (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	Timestamp indicating last update time of data Timestamp when the data was last updated, unset if data source has never updated the data.	EpochMsTimestamp	Readonly
logical_router_id	Logical router id	string	Required Readonly
logical_router_name	Name of the logical router	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Status of BGP neighbors of the logical router	array of BgpNeighborStatus	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "00361b9f1d54-2f05-441e-9851-c42518cc8b1dasdfds", "sort_ascending": true, "sort_by": "displayName", "result_count": 1, "logical_router_id": "875381be-a4c5-4173-8aa7-ab71695a8129", "logical_router_name": "PLR", "results": [{ "lr_component_id": "70c955dd-22c0-4199-b3a9-8f312478116a", "transport_node_id": "7aaaaadd-22c0-4199-bddd-3aaaaaa8116a", "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 }] }

Get the status of all the BGP neighbors for the Logical Router of the given id

Request:

ListByOptionalNodeIdParameters (schema)

Example Request:

Successful Response:

BgpNeighborsStatusListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: