Get Bgp Neighbor

Get Bgp Neighbor

Retrieves a specific BGP neighbor of Edge Gateway.

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

externalNetworkId

string
neighborId
Required

neighborId

string
externalNetworkId
Required

externalNetworkId

string
neighborId
Required

neighborId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderGatewayBgpNeighbor of type(s) application/json;version=39.0
This response body class contains all of the following: CommonGatewayBgpNeighbor , InlineProviderGatewayBgpNeighbor1 
{
    "id": "string",
    "neighborAddress": "10.22.1.100",
    "remoteASNumber": "65546, 1.10",
    "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, 1.10",
    "asPathModifierType": "string",
    "active": false,
    "sourceAddresses": [
        "123.0.0.1",
        "198.0.0.10",
        "2008:db8::96"
    ],
    "maxHopLimit": 0,
    "bgpPermissionGroupRef": {
        "id": "urn:vcloud:bgpPermissionGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "name": "string",
        "accessLevel": "string"
    }
}

404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 34.0
On This Page
Edge Gateway Bgp Neighbor Operations
DELETE
Delete Bgp Neighbor
GET
Get Bgp Neighbor
GET
Get Bgp Neighbor Status
PUT
Update Bgp Neighbor