[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update BGP Neighbor

Description

Updates a specific BGP neighbor of edge gateway.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/neighbors/{neighborId}
Copy

Path Parameters

Path Parameters

string
gatewayId Required

string
neighborId Required

Request Body

Request Body

EdgeBgpNeighbor of type(s) application/json Required
{
	"neighborAddress": "10.22.1.100",
	"remoteASNumber": "65546"
}
string
neighborAddress Required

The IP address of the BGP neighbor. Both IPv4 and IPv6 formats are supported.


string
remoteASNumber Required

The remote AS number of a BGP neighbor in ASPLAIN format.


boolean
allowASIn Optional

A flag indicating whether AllowAS-in is enabled or not. This specifies whether BGP neighbors can receive routes with same AS.


integer as int32
holdDownTimer Optional

Specifies the time interval (in seconds) before declaring a peer dead.


string
id Optional

The unique id of this BGP neighbor. On updates, the id is required for the object, while for create a new id will be generated. This id is not a VCD URN.


inRoutesFilterRef Optional

Specifies route filtering configuration for the BGP neighbor in IN direction. It is the reference to the prefix list, indicating which routes to filter for IN direction. Not specifying a value will be treated as “no IN route filters”.


string
ipAddressTypeFiltering Optional

Specifies IP address type based filtering in each direction. Setting the value to ‘DISABLED’ will disable address family based filtering.

Possible values are: IPV4IPV6DISABLED


integer as int32
keepAliveTimer Optional

Specifies the time interval (in seconds) between keep alive messages sent to peer.


gracefulRestartMode Optional

Describes Graceful Restart configuration Modes for BGP configuration on an edge gateway. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.

  • DISABLE - Both graceful restart and helper modes are disabled.
  • HELPER_ONLY - Only helper mode is enabled.
  • GRACEFUL_AND_HELPER - Both graceful restart and helper modes are enabled.

Possible values are: DISABLEHELPER_ONLYGRACEFUL_AND_HELPER


string
neighborPassword Optional

Password for BGP neighbor authentication. Empty string ("") clears existing password. Not specifying a value will be treated as “no password”.


outRoutesFilterRef Optional

Specifies route filtering configuration for the BGP neighbor in OUT direction. It is the reference to the prefix list, indicating which routes to filter for OUT direction. Not specifying a value will be treated as “no OUT route filters”.


bfd Optional

Specifies the BFD configuration for failure detection. Not specifying a value results in default bahavior.


version Optional

This property describes the current version of the entity. To prevent clients from overwriting each other’s changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Errors

Errors

400

Invalid configuration.


404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"allowASIn":false,"bfd":{"bfdInterval":0,"declareDeadMultiple":0,"enabled":false},"gracefulRestartMode":"DISABLE","holdDownTimer":0,"id":"string","inRoutesFilterRef":{"id":"2a4ba9ad-e8d5-409c-8cae-c06910cd9b47","name":"string"},"ipAddressTypeFiltering":"IPV4","keepAliveTimer":0,"neighborAddress":"10.22.1.100","neighborPassword":"string","outRoutesFilterRef":{"id":"2a4ba9ad-e8d5-409c-8cae-c06910cd9b47","name":"string"},"remoteASNumber":"65546","version":{"version":0}}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/neighbors/{neighborId}


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 34.0
Edge Gateway BGP Neighbor Operations
Feedback

Was this page helpful?