[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Get BGP Neighbor Routes

Description

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

Request

Request

URL

URL


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

Path Parameters

string
tier-0-id Required

string
locale-service-id Required

string
neighbor-id Required

Query Parameters

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

string
sort_by Optional

Field by which records are sorted


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns BgpNeighborRoutesListResult of type(s) application/json
This response body class contains all of the following: ListResult, InlineBgpNeighborRoutesListResult1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-GetTier0BgpNeighborRoutes -tier0Id "Mytier0Id" -localeServiceId "MylocaleServiceId" -neighborId "MyneighborId" -count 56 -cursor "Mycursor" -enforcementPointPath "MyenforcementPointPath" -includedFields "MyincludedFields" -pageSize 789 -sortAscending $true -sortBy "MysortBy"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-bgp-neighbor-routes
x-vmw-nsx-module: PolicyConnectivityStatistics


Feedback

Was this page helpful?