Update a specific BGP Neighbor on a Logical Router

Request:

Method:

PUT

URI Path(s):

/api/v1/logical-routers/<logical-router-id>/routing/bgp/neighbors/<id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

BgpNeighbor+

BgpNeighbor (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
address_families	AddressFamily settings for the neighbor User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration.	array of BgpNeighborAddressFamily
allow_as_in	Flag to enable allowas_in option for BGP neighbor	boolean	Default: "False"
bfd_config	BFD Configuration Parameters for the given peer. By specifying these paramaters BFD config for this given peer can be overriden \| (the globally configured values will not apply for this peer)	BfdConfigParameters
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_bfd	Enable BFD for this BGP Neighbor Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.	boolean	Default: "False"
enabled	Flag to enable this BGP Neighbor	boolean	Default: "True"
filter_in_ipprefixlist_id	IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
filter_in_routemap_id	RouteMap to be used for IN direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
filter_out_ipprefixlist_id	IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
filter_out_routemap_id	RouteMap to be used for OUT direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
graceful_restart_mode	Graceful Restart Mode BGP Graceful Restart mode. If specified, then it will take precedence over global Graceful Restart mode configured in logical router BgpConfig otherwise BgpConfig level Graceful Restart mode will be applicable for peer.	GracefulRestartMode
hold_down_timer	Wait period (seconds) before declaring peer dead	integer	Minimum: 1 Maximum: 65535 Default: "180"
id	Unique identifier of this resource	string	Sortable
keep_alive_timer	Frequency (seconds) with which keep alive messages are sent to peers	integer	Minimum: 1 Maximum: 65535 Default: "60"
logical_router_id	Logical router id	string	Readonly
maximum_hop_limit	Maximum Number of hops allowed to reach BGP neighbor This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0.	int	Minimum: 1 Maximum: 255 Default: "1"
neighbor_address	Neighbor IP Address	IPAddress	Required
password	Password User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 20 characters.	string	Minimum length: 1
remote_as	Autonomous System Number of the neighbor This is a deprecated property, Please use 'remote_as_num' instead.	integer	Deprecated Minimum: 1 Maximum: 4294967296
remote_as_num	4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format	string
resource_type	Must be set to the value BgpNeighbor	string
source_address	Logical Router Uplink IP Address Deprecated - do not provide a value for this field. Use source_addresses instead.	IPAddress	Deprecated
source_addresses	Array of Logical Router Uplink IP Addresses BGP neighborship will be formed from all these source addresses to this neighbour.	array of IPAddress	Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/logical-routers/7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c/routing/bgp/neighbors/640912b0-4820-46f0-b7c2-7a9e2cb57505 { "_revision": 1, "hold_down_timer": 40, "neighbor_address": "10.30.1.1", "keep_alive_timer": 100, "source_addresses": ["192.168.0.1"], "remote_as_num": "64510", "address_families": [ { "type" : "IPV4_UNICAST", "enabled" : true, } ], "display_name": "neighbor A", "description": "to_neighbor_A", }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BgpNeighbor+

BgpNeighbor (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
address_families	AddressFamily settings for the neighbor User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration.	array of BgpNeighborAddressFamily
allow_as_in	Flag to enable allowas_in option for BGP neighbor	boolean	Default: "False"
bfd_config	BFD Configuration Parameters for the given peer. By specifying these paramaters BFD config for this given peer can be overriden \| (the globally configured values will not apply for this peer)	BfdConfigParameters
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable_bfd	Enable BFD for this BGP Neighbor Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.	boolean	Default: "False"
enabled	Flag to enable this BGP Neighbor	boolean	Default: "True"
filter_in_ipprefixlist_id	IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
filter_in_routemap_id	RouteMap to be used for IN direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
filter_out_ipprefixlist_id	IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
filter_out_routemap_id	RouteMap to be used for OUT direction filter for IPV4_UNICAST address family This is a deprecated property, Please use 'address_family' instead.	string	Deprecated
graceful_restart_mode	Graceful Restart Mode BGP Graceful Restart mode. If specified, then it will take precedence over global Graceful Restart mode configured in logical router BgpConfig otherwise BgpConfig level Graceful Restart mode will be applicable for peer.	GracefulRestartMode
hold_down_timer	Wait period (seconds) before declaring peer dead	integer	Minimum: 1 Maximum: 65535 Default: "180"
id	Unique identifier of this resource	string	Sortable
keep_alive_timer	Frequency (seconds) with which keep alive messages are sent to peers	integer	Minimum: 1 Maximum: 65535 Default: "60"
logical_router_id	Logical router id	string	Readonly
maximum_hop_limit	Maximum Number of hops allowed to reach BGP neighbor This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0.	int	Minimum: 1 Maximum: 255 Default: "1"
neighbor_address	Neighbor IP Address	IPAddress	Required
password	Password User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 20 characters.	string	Minimum length: 1
remote_as	Autonomous System Number of the neighbor This is a deprecated property, Please use 'remote_as_num' instead.	integer	Deprecated Minimum: 1 Maximum: 4294967296
remote_as_num	4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format	string
resource_type	Must be set to the value BgpNeighbor	string
source_address	Logical Router Uplink IP Address Deprecated - do not provide a value for this field. Use source_addresses instead.	IPAddress	Deprecated
source_addresses	Array of Logical Router Uplink IP Addresses BGP neighborship will be formed from all these source addresses to this neighbour.	array of IPAddress	Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "id": "640912b0-4820-46f0-b7c2-7a9e2cb57505", "resource_type": "BgpNeighbor", "hold_down_timer": 40, "neighbor_address": "10.30.1.1", "keep_alive_timer": 100, "source_addresses": ["192.168.0.1"], "remote_as_num": "64510", "address_families": [ { "type" : "IPV4_UNICAST", "enabled" : true, } ], "display_name": "neighbor A", "description": "to_neighbor_A", "_last_modified_user": "admin", "_last_modified_time": 1433949148014, "_create_time": 1433949148014, "_create_user": "admin", "_revision": 2 }

Update a specific BGP Neighbor on a Logical Router

Request:

BgpNeighbor (schema)

Example Request:

Successful Response:

BgpNeighbor (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: