[{"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

Get BGP Config

Description

Retrieves the general BGP configuration for an edge gateway.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
gatewayId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns EdgeBgpConfig of type(s) application/json;version=36.3
{
	"ecmp": false,
	"enabled": false,
	"gracefulRestart": {
		"mode": "DISABLE",
		"restartTimer": 0,
		"staleRouteTimer": 0
	},
	"localASNumber": "65546",
	"version": {
		"version": 0
	}
}
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.


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.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

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


[{"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 Operations
Feedback

Was this page helpful?