InlineBgpNeighbor1

JSON Example

{
    "address_families": [
        {
            "enabled": false,
            "in_filter_ipprefixlist_id": "string",
            "in_filter_routemap_id": "string",
            "maximum_routes": 0,
            "out_filter_ipprefixlist_id": "string",
            "out_filter_routemap_id": "string",
            "type": "string"
        }
    ],
    "allow_as_in": false,
    "bfd_config": "BfdConfigParameters Object",
    "enable_bfd": false,
    "enabled": false,
    "filter_in_ipprefixlist_id": "string",
    "filter_in_routemap_id": "string",
    "filter_out_ipprefixlist_id": "string",
    "filter_out_routemap_id": "string",
    "graceful_restart_mode": "string",
    "hold_down_timer": 0,
    "keep_alive_timer": 0,
    "logical_router_id": "string",
    "maximum_hop_limit": 0,
    "neighbor_address": "string",
    "password": "string",
    "remote_as": 0,
    "remote_as_num": "string",
    "source_address": "string",
    "source_addresses": [
        "string"
    ]
}

array of BgpNeighborAddressFamily

address_families

Optional

User can enable the neighbor for the specific address families and also define filters per address family. When the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons. User can change that if required, by defining the address family configuration.

boolean

allow_as_in

Optional

Flag to enable allowas_in option for BGP neighbor

BfdConfigParameters

bfd_config

Optional

BFD configuration for the given Peer.

boolean

enable_bfd

Optional

Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.

boolean

enabled

Optional

Constraints: default: true

Flag to enable this BGP Neighbor

string

filter_in_ipprefixlist_id

Optional

This is a deprecated property, Please use 'address_family' instead.

string

filter_in_routemap_id

Optional

This is a deprecated property, Please use 'address_family' instead.

string

filter_out_ipprefixlist_id

Optional

This is a deprecated property, Please use 'address_family' instead.

string

filter_out_routemap_id

Optional

This is a deprecated property, Please use 'address_family' instead.

string

graceful_restart_mode

Optional

BGP Graceful Restart mode. If specified, then it will take precedence over global Graceful Restart mode configured in logical router BgpConfig otherwise BgpConfig level Graceful Restart mode will be applicable for peer.

Possible values are : DISABLE, HELPER_ONLY, GR_AND_HELPER,

integer As int64 As int64

hold_down_timer

Optional

Constraints: minimum: 1 maximum: 65535 default: 180

Wait period (seconds) before declaring peer dead

integer As int64 As int64

keep_alive_timer

Optional

Constraints: minimum: 1 maximum: 65535 default: 60

Frequency (seconds) with which keep alive messages are sent to peers

string

logical_router_id

Optional

Logical router id

integer As int32 As int32

maximum_hop_limit

Optional

Constraints: minimum: 1 maximum: 255 default: 1

This value is set on TTL(time to live) of BGP header. When router receives the BGP packet, it decrements the TTL. The default value of TTL is one when BPG request is initiated.So in the case of a BGP peer multiple hops away and and value of TTL is one, then next router in the path will decrement the TTL to 0, realize it cant forward the packet and will drop it. If the hop count value to reach neighbor is equal to or less than the maximum_hop_limit value then intermediate router decrements the TTL count by one and forwards the request to BGP neighour. If the hop count value is greater than the maximum_hop_limit value then intermediate router discards the request when TTL becomes 0.

string As ip As ip

neighbor_address

Required

Neighbor IP Address

string

password

Optional

Constraints: minLength: 1 maxLength: 32

User can create (POST) the neighbor with or without the password. The view (GET) on the neighbor, would never reveal if the password is set or not. The password can be set later using edit neighbor workFlow (PUT) On the edit neighbor (PUT), if the user does not specify the password property, the older value is retained. Maximum length of this field is 32 characters.

integer As int64 As int64

remote_as

Optional

Constraints: minimum: 1 maximum: 4294967296

This is a deprecated property, Please use 'remote_as_num' instead.

string

remote_as_num

Optional

4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format

string As ip As ip

source_address

Optional

Deprecated - do not provide a value for this field. Use source_addresses instead.

array of string

source_addresses

Optional

Constraints: maxItems: 8

BGP neighborship will be formed from all these source addresses to this neighbour.

Used By

BgpNeighbor