BgpProfile

BgpProfile
BgpProfile
JSON Example
{
    "community": [
        "string"
    ],
    "hold_time": 0,
    "ibgp": false,
    "ip_communities": [
        {
            "community": [
                "string"
            ],
            "ip_begin": {
                "addr": "string",
                "type": "string"
            },
            "ip_end": {
                "addr": "string",
                "type": "string"
            }
        }
    ],
    "keepalive_interval": 0,
    "local_as": 0,
    "local_preference": 0,
    "num_as_path_prepend": 0,
    "peers": [
        {
            "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
            }
        }
    ],
    "routing_options": [
        {
            "advertise_default_route": false,
            "advertise_learned_routes": false,
            "label": "string",
            "learn_only_default_route": false,
            "learn_routes": false,
            "max_learn_limit": 0
        }
    ],
    "send_community": false,
    "shutdown": false
}
array of string
community
Optional

Community string either in aa nn format where aa, nn is within [1,65535] or local-AS|no-advertise|no-export|internet. Field introduced in 17.1.2. Maximum of 16 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
hold_time
Optional
Constraints: default: 180

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

boolean
ibgp
Required
Constraints: default: true

BGP peer type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ip_communities
Optional

Communities per IP address range. Field introduced in 17.1.3. Maximum of 1024 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
keepalive_interval
Optional
Constraints: default: 60

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

integer As uint32 As uint32
local_as
Required

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

integer As uint32 As uint32
local_preference
Optional

LOCAL_PREF to be used for routes advertised. Applicable only over iBGP. 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
num_as_path_prepend
Optional

Number of times the local AS should be prepended additionally. Allowed values are 1-10. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of BgpPeer
peers
Optional

BGP Peers. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

routing_options
Optional

Learning and advertising options for BGP peers. Field introduced in 20.1.1. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
send_community
Optional
Constraints: default: true

Send community attribute to all peers. Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
shutdown
Optional

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

Property Of