Get Tier0 Bgp Neighbor Routes

Get Tier0 Bgp Neighbor Routes

Returns routes learned by BGP neighbor from all edge nodes on which this neighbor is currently enabled.

Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes
COPY
Path Parameters
string
tier-0-id
Required

tier-0-id

string
locale-service-id
Required

locale-service-id

string
neighbor-id
Required

neighbor-id

Query Parameters
integer
count
Optional

Number of routes to retrieve

string
cursor
Optional

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

string
enforcement_point_path
Optional

Enforcement point path

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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns BgpNeighborRoutesListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineBgpNeighborRoutesListResult1 
{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "egde_node_routes": [
                {
                    "routes": [
                        {
                            "as_path": "string",
                            "local_pref": 0,
                            "med": 0,
                            "network": "string",
                            "next_hop": "string",
                            "weight": 0
                        }
                    ],
                    "source_address": "string",
                    "transport_node_id": "string"
                }
            ],
            "enforcement_point_path": "string",
            "neighbor_path": "string"
        }
    ]
}

400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "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 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1 
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

On This Page
Tier 0s Operations
PUT
Create Or Replace Bgp Neighbor Config
PUT
Create Or Replace Bgp Routing Config
DELETE
Delete Bgp Neighbor Config
GET
Get Tier0 Bgp Neighbor Advertised Routes
GET
Get Tier0 Bgp Neighbor Advertised Routes In Csv Format Csv
GET
Get Tier0 Bgp Neighbor Routes
GET
Get Tier0 Bgp Neighbor Routes In Csv Format Csv
GET
List Bgp Neighbor Configs
PATCH
Patch Bgp Neighbor Config
PATCH
Patch Bgp Routing Config
GET
Read Bgp Neighbor Config
GET
Read Bgp Routing Config