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,
    "maximum_hop_limit": 0,
    "enabled": false,
    "bfd_config": {
        "receive_interval": 0,
        "declare_dead_multiple": 0,
        "transmit_interval": 0
    },
    "logical_router_id": "string",
    "remote_as_num": "string",
    "filter_out_routemap_id": "string",
    "filter_in_routemap_id": "string",
    "keep_alive_timer": 0,
    "password": "string",
    "source_address": "string",
    "source_addresses": [
        "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

Wait period (seconds) before declaring peer dead

integer As int32 As int32
maximum_hop_limit
Optional

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.

boolean
enabled
Optional

Flag to enable this BGP Neighbor

bfd_config
Optional

bfd_config

string
logical_router_id
Optional

Logical router id

string
remote_as_num
Optional

4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format

string
filter_out_routemap_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.

integer As int64 As int64
keep_alive_timer
Optional

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

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. Maximum length of this field is 20 characters.

string As ipv4 As ipv4
source_address
Optional

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

array of string
source_addresses
Optional

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

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.