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

Description

Retrieves all BGP neighbors configured for the edge gateway.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/neighbors
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 EdgeBgpNeighbors of type(s) application/json;version=36.3
{
	"values": [
		{
			"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
			}
		}
	]
}
array of EdgeBgpNeighbor
values Optional

All BGP neighbors for an edge gateway.

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/neighbors


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

Was this page helpful?