[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"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 Config

Description

Updates the general BGP configuration on an edge gateway.

Request

URL

put

https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp

Copy

Path Parameters

string

gatewayId Required

Request Body

EdgeBgpConfig of type(s) application/json Required

Show optional properties

{}

{
    "localASNumber": "65546"
}

ObjectVersion

version Required

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.

boolean

ecmp Optional

A flag indicating whether ECMP is enabled or not.

boolean

enabled Optional

A flag indicating whether BGP configuration is enabled or not.

EdgeBgpGracefulRestartConfig

gracefulRestart Optional

BGP Graceful Restart configuration. Not specifying a value results in default bahavior. Read only if using a VRF-Lite backed external network.

string

localASNumber Optional

BGP AS number to advertise to BGP peers. BGP AS number can be specified in either ASPLAIN or ASDOT formats, like ASPLAIN format :- ‘65546’, ASDOT format :- ‘1.10’. Read only if using a VRF-Lite backed external network.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

202 Accepted

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

Operation doesn't return any data structure.

Errors

Error

400

Invalid configuration.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"localASNumber":"65546"}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp

vmware-cloud-director

Availability

Added in 34.0

Edge Gateway BGP Operations

get

Get BGP Config

put

Update BGP Config

Update BGP Config

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

202 Accepted

Errors

Code Samples

cURL Command

Availability

On This Page

Edge Gateway BGP Operations

Was this page helpful?