Create Or Replace Bgp Neighbor Config
If BGP neighbor config with the neighbor-id is not already present, create a new neighbor config. If it already exists, replace the BGP neighbor config with this object.
Request
URI
PUT
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
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
Request Body
BgpNeighborConfig of type(s) application/json
Optional
This request body class requires all of the following: PolicyConfigResource , InlineBgpNeighborConfig1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_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"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_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"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"allow_as_in": false,
"bfd": {
"enabled": false,
"interval": 0,
"multiple": 0
},
"graceful_restart_mode": "string",
"hold_down_time": 0,
"in_route_filters": [
"string"
],
"keep_alive_time": 0,
"maximum_hop_limit": 0,
"neighbor_address": "string",
"out_route_filters": [
"string"
],
"password": "string",
"remote_as_num": "string",
"route_filtering": [
{
"address_family": "string",
"enabled": false,
"in_route_filters": [
"string"
],
"out_route_filters": [
"string"
]
}
],
"source_addresses": [
"string"
]
}
Responses
200
OK
Returns BgpNeighborConfig of type(s) application/json
This response body class contains all of the following: PolicyConfigResource , InlineBgpNeighborConfig1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_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"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_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"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"allow_as_in": false,
"bfd": {
"enabled": false,
"interval": 0,
"multiple": 0
},
"graceful_restart_mode": "string",
"hold_down_time": 0,
"in_route_filters": [
"string"
],
"keep_alive_time": 0,
"maximum_hop_limit": 0,
"neighbor_address": "string",
"out_route_filters": [
"string"
],
"password": "string",
"remote_as_num": "string",
"route_filtering": [
{
"address_family": "string",
"enabled": false,
"in_route_filters": [
"string"
],
"out_route_filters": [
"string"
]
}
],
"source_addresses": [
"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