BgpPeer

BgpPeer
BgpPeer
JSON Example
{
    "advertise_snat_ip": false,
    "advertise_vip": false,
    "advertisement_interval": 0,
    "bfd": false,
    "connect_timer": 0,
    "ebgp_multihop": 0,
    "hold_time": 0,
    "ibgp_local_as_override": false,
    "keepalive_interval": 0,
    "label": "string",
    "local_as": 0,
    "md5_secret": "string",
    "network_ref": "string",
    "peer_ip": {
        "addr": "string",
        "type": "string"
    },
    "peer_ip6": {
        "addr": "string",
        "type": "string"
    },
    "remote_as": 0,
    "shutdown": false,
    "subnet": {
        "ip_addr": {
            "addr": "string",
            "type": "string"
        },
        "mask": 0
    },
    "subnet6": {
        "ip_addr": {
            "addr": "string",
            "type": "string"
        },
        "mask": 0
    }
}
boolean
advertise_snat_ip
Optional
Constraints: default: true

Advertise SNAT IP to this Peer. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
advertise_vip
Optional
Constraints: default: true

Advertise VIP to this Peer. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
advertisement_interval
Optional
Constraints: default: 5

Advertisement interval for this Peer. Allowed values are 1-60. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
bfd
Optional
Constraints: default: true

Enable Bi-Directional Forward Detection. Only async mode supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
connect_timer
Optional
Constraints: default: 10

Connect timer for this Peer. Allowed values are 1-120. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ebgp_multihop
Optional

TTL for multihop ebgp Peer. Allowed values are 0-255. Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
hold_time
Optional

Hold time for this Peer. Allowed values are 3-7200. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
ibgp_local_as_override
Optional

Override the profile level local_as with the peer level remote_as. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
keepalive_interval
Optional

Keepalive interval for this Peer. Allowed values are 0-3600. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
label
Optional

Label used to enable learning and/or advertisement of routes to this peer. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
local_as
Optional

Local AS to use for this ebgp peer. If specified, this will override the local AS configured at the VRF level. Allowed values are 1-4294967295. Field introduced in 17.1.6,17.2.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
md5_secret
Optional

Peer Autonomous System Md5 Digest Secret Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
network_ref
Optional

Network providing reachability for Peer. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

peer_ip
Optional

peer_ip

peer_ip6
Optional

peer_ip6

integer As uint32 As uint32
remote_as
Optional

Peer Autonomous System ID. Allowed values are 1-4294967295. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
shutdown
Optional

Shutdown the BGP peer. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

subnet
Optional

subnet

subnet6
Optional

subnet6

Property Of