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
gatewayId
Required

gatewayId

string
neighborId
Required

neighborId

string
gatewayId
Required

gatewayId

string
neighborId
Required

neighborId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeBgpNeighbor of type(s) application/json;version=37.0 
{
    "id": "string",
    "neighborAddress": "10.22.1.100",
    "remoteASNumber": "65546",
    "keepAliveTimer": 0,
    "holdDownTimer": 0,
    "gracefulRestartMode": "string",
    "bfd": {
        "enabled": false,
        "bfdInterval": 0,
        "declareDeadMultiple": 0
    },
    "allowASIn": false,
    "neighborPassword": "string",
    "ipAddressTypeFiltering": "string",
    "inRoutesFilterRef": {
        "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
        "name": "string"
    },
    "outRoutesFilterRef": {
        "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
        "name": "string"
    },
    "version": {
        "version": 0
    }
}
string
id
Optional

The unique id of this BGP neighbor. On updates, the id is required for the object, while for create a new id will be generated. This id is not a VCD URN.

string
neighborAddress
Required

The IP address of the BGP neighbor. Both IPv4 and IPv6 formats are supported.

string
remoteASNumber
Required

The remote AS number of a BGP neighbor in ASPLAIN format.

integer As int32 As int32
keepAliveTimer
Optional

Specifies the time interval (in seconds) between keep alive messages sent to peer.

integer As int32 As int32
holdDownTimer
Optional

Specifies the time interval (in seconds) before declaring a peer dead.

GracefulRestartModeTypes
gracefulRestartMode
Optional

gracefulRestartMode

EdgeBgpBfdConfig
bfd
Optional

bfd

boolean
allowASIn
Optional

A flag indicating whether AllowAS-in is enabled or not. This specifies whether BGP neighbors can receive routes with same AS.

string
neighborPassword
Optional

Password for BGP neighbor authentication. Empty string ("") clears existing password. Not specifying a value will be treated as "no password".

string
ipAddressTypeFiltering
Optional

Specifies IP address type based filtering in each direction. Setting the value to 'DISABLED' will disable address family based filtering.

Possible values are : IPV4, IPV6, DISABLED,
ExtObjectReference
inRoutesFilterRef
Optional

inRoutesFilterRef

ExtObjectReference
outRoutesFilterRef
Optional

outRoutesFilterRef

ObjectVersion
version
Optional

version


404

The specified resource was not found

Returns Error of type(s) application/json;version=37.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