[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Get BGP Neighbor Advertised Routes
DescriptionReturns routes advertised by BGP neighbor from all edge transport nodes on which this neighbor is currently enabled. The query parameter “source=cached” is not supported.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
BgpNeighborRoutesListResult
of type(s) application/json
This response body class contains all of the following:
ListResult, InlineBgpNeighborRoutesListResult1
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
Invoke-GetTier0BgpNeighborAdvertisedRoutes -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}/advertised-routes
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get-bgp-neighbor-advertised-routes
x-vmw-nsx-module: PolicyConnectivityStatistics
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 0s Operations
delete
get
patch
