List Inter Site Edge Node Bgp Neighbors

Paginated list of BGP Neighbors on edge transport node.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/transport-nodes/{edge-node-id}/inter-site/bgp/neighbors

COPY

Path Parameters

string

edge-node-id

Required

edge-node-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

Constraints: minimum: 0 maximum: 1000 default: 1000

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

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns BgpNeighborListResult of type(s) application/json

This response body class contains all of the following: InlineBgpNeighborListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "address_families": [
                {
                    "enabled": false,
                    "in_filter_ipprefixlist_id": "string",
                    "in_filter_routemap_id": "string",
                    "maximum_routes": 0,
                    "out_filter_ipprefixlist_id": "string",
                    "out_filter_routemap_id": "string",
                    "type": "string"
                }
            ],
            "allow_as_in": false,
            "bfd_config": {
                "declare_dead_multiple": 0,
                "receive_interval": 0,
                "transmit_interval": 0
            },
            "enable_bfd": false,
            "enabled": false,
            "filter_in_ipprefixlist_id": "string",
            "filter_in_routemap_id": "string",
            "filter_out_ipprefixlist_id": "string",
            "filter_out_routemap_id": "string",
            "graceful_restart_mode": "string",
            "hold_down_timer": 0,
            "keep_alive_timer": 0,
            "logical_router_id": "string",
            "maximum_hop_limit": 0,
            "neighbor_address": "string",
            "password": "string",
            "remote_as": 0,
            "remote_as_num": "string",
            "source_address": "string",
            "source_addresses": [
                "string"
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json