Get Bgp Neighbors

Get Bgp Neighbors

Retrieves all BGP neighbors configured for the Edge Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/neighbors
COPY
Path Parameters
string
externalNetworkId
Required

externalNetworkId

string
externalNetworkId
Required

externalNetworkId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderGatewayBgpNeighbors of type(s) application/json;version=38.1 
{
    "values": [
        {
            "id": "string",
            "neighborAddress": "10.22.1.100",
            "remoteASNumber": "65546",
            "keepAliveTimer": 0,
            "holdDownTimer": 0,
            "allowASIn": false,
            "neighborPassword": "string",
            "inRoutesFilterRef": {
                "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                "name": "string",
                "type": "string"
            },
            "outRoutesFilterRef": {
                "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                "name": "string",
                "type": "string"
            },
            "version": {
                "version": 0
            },
            "gracefulRestartModeValue": "string",
            "bfd": {
                "enabled": false,
                "bfdInterval": 0,
                "declareDeadMultiple": 0
            },
            "ipAddressTypeFilteringValue": "string",
            "routeFilteringConfigurations": [
                {
                    "ipAddressTypeFilteringValue": "string",
                    "active": false,
                    "inboundRoutesFilterRef": {
                        "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                        "name": "string",
                        "type": "string"
                    },
                    "outboundRoutesFilterRef": {
                        "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
                        "name": "string",
                        "type": "string"
                    },
                    "maximumRoutes": 0
                }
            ],
            "localASNumber": "65546",
            "asPathModifierType": "string",
            "active": false,
            "bgpPermissionGroupRef": {
                "id": "urn:vcloud:bgpPermissionGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "name": "string",
                "accessLevel": "string"
            }
        }
    ]
}
array of ProviderGatewayBgpNeighbor
values
Optional

All BGP neighbors for a Provider Gateway.


Availability
Added in 34.0
On This Page
Edge Gateway Bgp Neighbors Operations
POST
Create Bgp Neighbor
GET
Get Bgp Neighbors