Get Bgp Neighbors Status

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. The query parameter "source=cached" is not supported.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors/status

COPY

Path Parameters

string

logical-router-id

Required

logical-router-id

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

source

Optional

Data source type.

Possible values are : realtime, cached,

string

transport_node_id

Optional

Transport node id

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns BgpNeighborsStatusListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineBgpNeighborsStatusListResult1

{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "logical_router_name": "string",
    "last_update_timestamp": 0,
    "logical_router_id": "string",
    "results": [
        {
            "transport_node": {
                "target_display_name": "string",
                "is_valid": false,
                "target_id": "string",
                "target_type": "string"
            },
            "connection_state": "string",
            "neighbor_address": "string",
            "messages_sent": 0,
            "connection_drop_count": 0,
            "remote_port": 0,
            "source_address": "string",
            "total_in_prefix_count": 0,
            "messages_received": 0,
            "neighbor_router_id": "string",
            "total_out_prefix_count": 0,
            "lr_component_id": "string",
            "graceful_restart": false,
            "remote_as_number": "string",
            "announced_capabilities": [
                "string"
            ],
            "local_port": 0,
            "keep_alive_interval": 0,
            "time_since_established": 0,
            "hold_time": 0,
            "negotiated_capability": [
                "string"
            ],
            "established_connection_count": 0
        }
    ]
}

400

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

403

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

500

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

503

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0,
    "details": "string",
    "related_errors": [
        {
            "module_name": "string",
            "error_message": "string",
            "error_code": 0,
            "details": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Logical Routing And Services Operations

POST

Add Bgp Neighbor