CommonGatewayBgpNeighbor

CommonGatewayBgpNeighbor
CommonGatewayBgpNeighbor

A BGP neighbor configuration.

JSON Example
{
    "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
    }
}
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 or ASDOT 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. Must be at least three times the keep alive timer.

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".

inRoutesFilterRef
Optional

Reference for entities which are external to VCD and do not have a VCD URN identifier.

outRoutesFilterRef
Optional

Reference for entities which are external to VCD and do not have a VCD URN identifier.

version
Optional

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.

Availability
Added in 38.0