InlineBgpNeighbor1

InlineBgpNeighbor1
InlineBgpNeighbor1
JSON Example
{
    "filter_in_ipprefixlist_id": "string",
    "neighbor_address": "string",
    "remote_as": 0,
    "filter_out_ipprefixlist_id": "string",
    "hold_down_timer": 0,
    "enabled": false,
    "remote_as_num": "string",
    "bfd_config": {
        "receive_interval": 0,
        "declare_dead_multiple": 0,
        "transmit_interval": 0
    },
    "logical_router_id": "string",
    "filter_out_routemap_id": "string",
    "keep_alive_timer": 0,
    "filter_in_routemap_id": "string",
    "source_addresses": [
        "string"
    ],
    "password": "string",
    "source_address": "string",
    "enable_bfd": false,
    "address_families": [
        {
            "in_filter_ipprefixlist_id": "string",
            "out_filter_routemap_id": "string",
            "type": "string",
            "in_filter_routemap_id": "string",
            "enabled": false,
            "out_filter_ipprefixlist_id": "string"
        }
    ]
}
string
filter_in_ipprefixlist_id
Optional

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

string As ipv4 As ipv4
neighbor_address
Required

Neighbor IP Address

integer As int64 As int64
remote_as
Optional

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

string
filter_out_ipprefixlist_id
Optional

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

integer As int64 As int64
hold_down_timer
Optional

hold_down_timer

boolean
enabled
Optional

enabled

string
remote_as_num
Optional

remote_as_num

object
bfd_config
Optional

By specifying these paramaters BFD config for this given peer can be overriden | (the globally configured values will not apply for this peer)

string
logical_router_id
Optional

logical_router_id

string
filter_out_routemap_id
Optional

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

integer As int64 As int64
keep_alive_timer
Optional

keep_alive_timer

string
filter_in_routemap_id
Optional

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

array of string
source_addresses
Optional

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

string
password
Optional

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.

string As ipv4 As ipv4
source_address
Optional

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

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.

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.