router bgp

Border Gateway Protocol (BGP)

bgp Specification

Parameter Value
Type Collection
Object Key(s) as-number
Collection Name bgp-list
Collection URI /axapi/v3/router/bgp
Element Name bgp
Element URI /axapi/v3/router/bgp/{as-number}
Element Attributes bgp_attributes
Partition Visibility shared
Schema bgp schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/router/bgp

bgp attributes

Create List

POST

/axapi/v3/router/bgp

bgp attributes

Get Object

GET

/axapi/v3/router/bgp/{as-number}

bgp attributes

Get List

GET

/axapi/v3/router/bgp

bgp-list

Modify Object

POST

/axapi/v3/router/bgp/{as-number}

bgp attributes

Replace Object

PUT

/axapi/v3/router/bgp/{as-number}

bgp attributes

Replace List

PUT

/axapi/v3/router/bgp

bgp-list

Delete Object

DELETE

/axapi/v3/router/bgp/{as-number}

bgp attributes

bgp-list

bgp-list is JSON List of bgp attributes

bgp-list : [

]

bgp attributes

address-family

Description: address-family is a JSON Block. Please see below for address-family

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family

aggregate-address-list

Type: List

as-number

Description AS number

Type: string

Maximum Length: 11 characters

Maximum Length: 1 characters

auto-summary

Description Enable automatic network number summarization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bgp

Description: bgp is a JSON Block. Please see below for bgp

Type: Object

distance-list

Type: List

maximum-paths-value

Description Supported BGP multipath numbers

Type: number

Range: 1-64

Default: 1

neighbor

Description: neighbor is a JSON Block. Please see below for neighbor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/neighbor

network

Description: network is a JSON Block. Please see below for network

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/network

originate

Description Distribute a default route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redistribute

Description: redistribute is a JSON Block. Please see below for redistribute

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/redistribute

synchronization

Description Perform IGP synchronization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

timers

Description: timers is a JSON Block. Please see below for timers

Type: Object

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

redistribute

Specification Value
Type object

connected-cfg

Description: connected-cfg is a JSON Block. Please see below for redistribute_connected-cfg

Type: Object

floating-ip-cfg

Description: floating-ip-cfg is a JSON Block. Please see below for redistribute_floating-ip-cfg

Type: Object

ip-nat-cfg

Description: ip-nat-cfg is a JSON Block. Please see below for redistribute_ip-nat-cfg

Type: Object

ip-nat-list-cfg

Description: ip-nat-list-cfg is a JSON Block. Please see below for redistribute_ip-nat-list-cfg

Type: Object

isis-cfg

Description: isis-cfg is a JSON Block. Please see below for redistribute_isis-cfg

Type: Object

lw4o6-cfg

Description: lw4o6-cfg is a JSON Block. Please see below for redistribute_lw4o6-cfg

Type: Object

nat-map-cfg

Description: nat-map-cfg is a JSON Block. Please see below for redistribute_nat-map-cfg

Type: Object

ospf-cfg

Description: ospf-cfg is a JSON Block. Please see below for redistribute_ospf-cfg

Type: Object

rip-cfg

Description: rip-cfg is a JSON Block. Please see below for redistribute_rip-cfg

Type: Object

static-cfg

Description: static-cfg is a JSON Block. Please see below for redistribute_static-cfg

Type: Object

static-nat-cfg

Description: static-nat-cfg is a JSON Block. Please see below for redistribute_static-nat-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vip

Description: vip is a JSON Block. Please see below for redistribute_vip

Type: Object

redistribute_ip-nat-list-cfg

Specification Value
Type object

ip-nat-list

Description IP NAT list

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_lw4o6-cfg

Specification Value
Type object

lw4o6

Description LW4O6 Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_connected-cfg

Specification Value
Type object

connected

Description Connected

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_vip

Specification Value
Type object

only-flagged-cfg

Description: only-flagged-cfg is a JSON Block. Please see below for redistribute_vip_only-flagged-cfg

Type: Object

only-not-flagged-cfg

Description: only-not-flagged-cfg is a JSON Block. Please see below for redistribute_vip_only-not-flagged-cfg

Type: Object

redistribute_vip_only-not-flagged-cfg

Specification Value
Type object

only-not-flagged

Description Only not flagged

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_vip_only-flagged-cfg

Specification Value
Type object

only-flagged

Description Selected Virtual IP (VIP)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_ip-nat-cfg

Specification Value
Type object

ip-nat

Description IP NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_floating-ip-cfg

Specification Value
Type object

floating-ip

Description Floating IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_isis-cfg

Specification Value
Type object

isis

Description ISO IS-IS

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_nat-map-cfg

Specification Value
Type object

nat-map

Description NAT MAP Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_rip-cfg

Specification Value
Type object

rip

Description Routing Information Protocol (RIP)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_ospf-cfg

Specification Value
Type object

ospf

Description Open Shortest Path First (OSPF)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

redistribute_static-nat-cfg

Specification Value
Type object

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

static-nat

Description Static NAT Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redistribute_static-cfg

Specification Value
Type object

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

static

Description Static routes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

aggregate-address-list

Specification Value
Type list
Block object keys  

aggregate-address

Description Configure BGP aggregate entries (Aggregate prefix)

Type: string

Format: ipv4-cidr

as-set

Description Generate AS set path information

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

summary-only

Description Filter more specific routes from updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bgp

Specification Value
Type object

always-compare-med

Description Allow comparing MED from different neighbors

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bestpath-cfg

Description: bestpath-cfg is a JSON Block. Please see below for bgp_bestpath-cfg

Type: Object

bgp-restart-time

Description BGP Peer Graceful Restart time in seconds (default 90)

Type: number

Range: 1-3600

Default: 90

bgp-stalepath-time

Description BGP Graceful Restart Stalepath retention time in seconds (default 360)

Type: number

Range: 1-3600

Default: 360

dampening-cfg

Description: dampening-cfg is a JSON Block. Please see below for bgp_dampening-cfg

Type: Object

deterministic-med

Description Pick the best-MED path among paths advertised from the neighboring AS

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enforce-first-as

Description Enforce the first AS for EBGP routes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fast-external-failover

Description Immediately reset session if a link to a directly connected external peer goes down

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

graceful-restart

Description Configure BGP BGP Graceful Restart

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

local-preference-value

Description Configure default local preference value

Type: number

Range: 0-4294967295

Default: 100

log-neighbor-changes

Description Log neighbor up/down and reset reason

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nexthop-trigger-count

Description BGP nexthop-tracking status (count)

Type: number

Range: 0-127

Default: 0

router-id

Description Override current router identifier (peers will reset) (Manually configured router identifier)

Type: string

Format: ipv4-address

scan-time

Description Configure background scan interval (Scan interval (sec) [Default:60 Disable:0])

Type: number

Range: 0-60

Default: 60

bgp_dampening-cfg

Specification Value
Type object

dampening

Description Enable route-flap dampening

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dampening-half-time

Description Reachability Half-life time for the penalty(minutes)

Type: number

Range: 1-45

dampening-max-supress

Description Maximum duration to suppress a stable route(minutes)

Type: number

Range: 1-255

dampening-penalty

Description Un-reachability Half-life time for the penalty(minutes)

Type: number

Range: 1-45

dampening-reuse

Description Value to start reusing a route

Type: number

Range: 1-20000

dampening-supress

Description Value to start suppressing a route

Type: number

Range: 1-20000

route-map

Description Route-map to specify criteria for dampening (Route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

bgp_bestpath-cfg

Specification Value
Type object

compare-routerid

Description Compare router-id for identical EBGP paths

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ignore

Description Ignore as-path length in selecting a route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

missing-as-worst

Description Treat missing MED as the least preferred one

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

remove-recv-med

Description To remove rcvd MED attribute

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

remove-send-med

Description To remove send MED attribute

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

network

Specification Value
Type object

ip-cidr-list

monitor

Description: monitor is a JSON Block. Please see below for network_monitor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/network/monitor

synchronization

Description: synchronization is a JSON Block. Please see below for network_synchronization

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/network/synchronization

network_synchronization

Specification Value
Type object

network-synchronization

Description Perform IGP synchronization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

network_monitor

Specification Value
Type object

default

Description: default is a JSON Block. Please see below for network_monitor_default

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/network/monitor/default

network_monitor_default

Specification Value
Type object

network-monitor-default

Description default route monitoring

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

network_ip-cidr-list

Specification Value
Type list
Block object keys  

backdoor

Description Specify a BGP backdoor route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

comm-value

Description community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export

Type: string

Format: string-rlx

description

Description Network specific description (Up to 80 characters describing this network)

Type: string

Format: string-rlx

Maximum Length: 80 characters

Maximum Length: 1 characters

lcomm-value

Description Large community value in the format XX:YY:ZZ

Type: string

Format: string-rlx

network-ipv4-cidr

Description Specify network mask

Type: string

Format: ipv4-cidr

route-map

Description Route-map to modify the attributes (Name of the route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

timers

Specification Value
Type object

bgp-holdtime

Description Holdtime

Type: number

Range: 0-65535

Default: 90

bgp-keepalive

Description Keepalive interval

Type: number

Range: 0-65535

Default: 30

neighbor

Specification Value
Type object

ethernet-neighbor-list

ipv4-neighbor-list

ipv6-neighbor-list

peer-group-neighbor-list

trunk-neighbor-list

ve-neighbor-list

neighbor_ve-neighbor-list

Specification Value
Type list
Block object keys  

peer-group-name

Description

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

unnumbered

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual ethernet interface number

Type: number

Format: interface

neighbor_ipv4-neighbor-list

Specification Value
Type list
Block object keys  

acos-application-only

Description Send BGP update to ACOS application

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

advertisement-interval

Description Minimum interval between sending BGP routing updates (time in seconds)

Type: number

Range: 1-600

Mutual Exclusion: advertisement-interval and peer-group-name are mutually exclusive

allowas-in

Description Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

as-origination-interval

Description Minimum interval between sending AS-origination routing updates (time in seconds)

Type: number

Range: 1-600

Mutual Exclusion: as-origination-interval and peer-group-name are mutually exclusive

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bfd-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

bfd-value

Description Key String

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

collide-established

Description Include Neighbor in Established State for Collision Detection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

connect

Description BGP connect timer

Type: number

Range: 1-65535

default-originate

Description Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: default-originate and peer-group-name are mutually exclusive

description

Description Neighbor specific description (Up to 80 characters describing this neighbor)

Type: string

Format: string-rlx

Maximum Length: 80 characters

Maximum Length: 1 characters

disallow-infinite-holdtime

Description BGP per neighbor disallow-infinite-holdtime

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: disallow-infinite-holdtime and peer-group-name are mutually exclusive

distribute-lists

Type: List

dont-capability-negotiate

Description Do not perform capability negotiation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic

Description Advertise dynamic capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ebgp-multihop

Description Allow EBGP neighbors not on directly connected networks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ebgp-multihop-hop-count

Description maximum hop count

Type: number

Range: 1-255

enforce-multihop

Description Enforce EBGP neighbors to perform multihop

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ethernet

Description Ethernet interface (Port number)

Type: number

Format: interface

Mutual Exclusion: ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk, lif, and tunnel are mutually exclusive

graceful-restart

Description enable graceful-restart helper for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inbound

Description Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

key-id

Description Key ID

Type: number

Range: 0-255

key-type

Description ‘md5’: md5; ‘meticulous-md5’: meticulous-md5; ‘meticulous-sha1’: meticulous-sha1; ‘sha1’: sha1; ‘simple’: simple; (Keyed MD5/Meticulous Keyed MD5/Meticulous Keyed SHA1/Keyed SHA1/Simple Password)

Type: string

Supported Values: md5, meticulous-md5, meticulous-sha1, sha1, simple

lif

Description Logical interface (Lif interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

Mutual Exclusion: lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and tunnel are mutually exclusive

loopback

Description Loopback interface (Port number)

Type: number

Format: interface

Mutual Exclusion: loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk, lif, and tunnel are mutually exclusive

maximum-prefix

Description Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

maximum-prefix-thres

Description threshold-value, 1 to 100 percent

Type: number

Range: 1-100

multihop

Description Enable multihop

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nbr-remote-as

Description Specify AS number of BGP neighbor

Type: string

Maximum Length: 11 characters

Maximum Length: 1 characters

neighbor-filter-lists

Type: List

neighbor-ipv4

Description Neighbor address

Type: string

Format: ipv4-address

neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Type: List

next-hop-self

Description Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: next-hop-self and peer-group-name are mutually exclusive

override-capability

Description Override capability negotiation result

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-encrypted

Description

pass-value

Description Key String

Type: string

Format: password

Maximum Length: 80 characters

Maximum Length: 1 characters

passive

Description Don’t send open messages to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-name

Description Configure peer-group (peer-group name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: peer-group-name,advertisement-interval, as-origination-interval, default-originate, disallow-infinite-holdtime, next-hop-self, timers, and unsuppress-map are mutually exclusive

prefix-list-direction

Description ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

restart-min

Description restart value, 1 to 1440 minutes

Type: number

Range: 1-1440

route-map

Description Route-map to specify criteria to originate default (route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

route-refresh

Description Advertise route-refresh capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

send-community-val

Description ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

shutdown

Description Administratively shut down this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

strict-capability-match

Description Strict capability negotiation match

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

telemetry

Description Send BGP update to telemetry db

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

timers-holdtime

Description Holdtime

Type: number

Range: 0-65535

Default: 90

timers-keepalive

Description Keepalive interval

Type: number

Range: 0-65535

Default: 30

trunk

Description Trunk interface (Trunk interface number)

Type: number

Format: interface

Mutual Exclusion: trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve, lif, and tunnel are mutually exclusive

tunnel

Description Tunnel interface (Tunnel interface number)

Type: number

Format: interface

Mutual Exclusion: tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and lif are mutually exclusive

unsuppress-map

Description Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: unsuppress-map and peer-group-name are mutually exclusive

update-source-ip

Description IP address

Type: string

Format: ipv4-address

Mutual Exclusion: update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive

update-source-ipv6

Description IPv6 address

Type: string

Format: ipv6-address

Mutual Exclusion: update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

Mutual Exclusion: ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif, and tunnel are mutually exclusive

weight

Description Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

neighbor_ipv4-neighbor-list_distribute-lists

Specification Value
Type list
Block object keys  

distribute-list

Description Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

distribute-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

neighbor_ipv4-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

neighbor_ipv4-neighbor-list_neighbor-filter-lists

Specification Value
Type list
Block object keys  

filter-list

Description Establish BGP filters (AS path access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

filter-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

neighbor_ipv4-neighbor-list_neighbor-prefix-lists

Specification Value
Type list
Block object keys  

nbr-prefix-list

Description Filter updates to/from this neighbor (Name of a prefix list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

nbr-prefix-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

neighbor_peer-group-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

advertisement-interval

Description Minimum interval between sending BGP routing updates (time in seconds)

Type: number

Range: 1-600

allowas-in

Description Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

as-origination-interval

Description Minimum interval between sending AS-origination routing updates (time in seconds)

Type: number

Range: 1-600

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

collide-established

Description Include Neighbor in Established State for Collision Detection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

connect

Description BGP connect timer

Type: number

Range: 1-65535

default-originate

Description Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

description

Description Neighbor specific description (Up to 80 characters describing this neighbor)

Type: string

Format: string-rlx

Maximum Length: 80 characters

Maximum Length: 1 characters

dont-capability-negotiate

Description Do not perform capability negotiation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic

Description Advertise dynamic capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ebgp-multihop

Description Allow EBGP neighbors not on directly connected networks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ebgp-multihop-hop-count

Description maximum hop count

Type: number

Range: 1-255

enforce-multihop

Description Enforce EBGP neighbors to perform multihop

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ethernet

Description Ethernet interface (Port number)

Type: number

Format: interface

Mutual Exclusion: ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk, lif, and tunnel are mutually exclusive

extended-nexthop

Description Advertise extended-nexthop capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inbound

Description Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

lif

Description Logical interface (Lif interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

Mutual Exclusion: lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and tunnel are mutually exclusive

loopback

Description Loopback interface (Port number)

Type: number

Format: interface

Mutual Exclusion: loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk, lif, and tunnel are mutually exclusive

maximum-prefix

Description Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

maximum-prefix-thres

Description threshold-value, 1 to 100 percent

Type: number

Range: 1-100

multihop

Description Enable multihop

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

neighbor-route-map-lists

Type: List

override-capability

Description Override capability negotiation result

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-encrypted

Description

pass-value

Description Key String

Type: string

Format: password

Maximum Length: 80 characters

Maximum Length: 1 characters

passive

Description Don’t send open messages to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group

Description Neighbor tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

peer-group-key

Description Configure peer-group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-remote-as

Description Specify AS number of BGP neighbor

Type: string

Maximum Length: 11 characters

Maximum Length: 1 characters

remove-private-as

Description Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route-map to specify criteria to originate default (route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

route-refresh

Description Advertise route-refresh capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

shutdown

Description Administratively shut down this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

strict-capability-match

Description Strict capability negotiation match

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

timers-holdtime

Description Holdtime

Type: number

Range: 0-65535

Default: 90

timers-keepalive

Description Keepalive interval

Type: number

Range: 0-65535

Default: 30

trunk

Description Trunk interface (Trunk interface number)

Type: number

Format: interface

Mutual Exclusion: trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve, lif, and tunnel are mutually exclusive

tunnel

Description Tunnel interface (Tunnel interface number)

Type: number

Format: interface

Mutual Exclusion: tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and lif are mutually exclusive

update-source-ip

Description IP address

Type: string

Format: ipv4-address

Mutual Exclusion: update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive

update-source-ipv6

Description IPv6 address

Type: string

Format: ipv6-address

Mutual Exclusion: update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

Mutual Exclusion: ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif, and tunnel are mutually exclusive

weight

Description Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

neighbor_peer-group-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

neighbor_ipv6-neighbor-list

Specification Value
Type list
Block object keys  

acos-application-only

Description Send BGP update to ACOS application

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

advertisement-interval

Description Minimum interval between sending BGP routing updates (time in seconds)

Type: number

Range: 1-600

Mutual Exclusion: advertisement-interval and peer-group-name are mutually exclusive

allowas-in

Description Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

as-origination-interval

Description Minimum interval between sending AS-origination routing updates (time in seconds)

Type: number

Range: 1-600

Mutual Exclusion: as-origination-interval and peer-group-name are mutually exclusive

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bfd-encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

bfd-value

Description Key String

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

collide-established

Description Include Neighbor in Established State for Collision Detection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

connect

Description BGP connect timer

Type: number

Range: 1-65535

default-originate

Description Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: default-originate and peer-group-name are mutually exclusive

description

Description Neighbor specific description (Up to 80 characters describing this neighbor)

Type: string

Format: string-rlx

Maximum Length: 80 characters

Maximum Length: 1 characters

disallow-infinite-holdtime

Description BGP per neighbor disallow-infinite-holdtime

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: disallow-infinite-holdtime and peer-group-name are mutually exclusive

distribute-lists

Type: List

dont-capability-negotiate

Description Do not perform capability negotiation

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dynamic

Description Advertise dynamic capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ebgp-multihop

Description Allow EBGP neighbors not on directly connected networks

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ebgp-multihop-hop-count

Description maximum hop count

Type: number

Range: 1-255

enforce-multihop

Description Enforce EBGP neighbors to perform multihop

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ethernet

Description Ethernet interface (Port number)

Type: number

Format: interface

Mutual Exclusion: ethernet,update-source-ip, update-source-ipv6, loopback, ve, trunk, lif, and tunnel are mutually exclusive

extended-nexthop

Description Advertise extended-nexthop capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

graceful-restart

Description enable graceful-restart helper for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inbound

Description Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

key-id

Description Key ID

Type: number

Range: 0-255

key-type

Description ‘md5’: md5; ‘meticulous-md5’: meticulous-md5; ‘meticulous-sha1’: meticulous-sha1; ‘sha1’: sha1; ‘simple’: simple; (Keyed MD5/Meticulous Keyed MD5/Meticulous Keyed SHA1/Keyed SHA1/Simple Password)

Type: string

Supported Values: md5, meticulous-md5, meticulous-sha1, sha1, simple

lif

Description Logical interface (Lif interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

Mutual Exclusion: lif,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and tunnel are mutually exclusive

loopback

Description Loopback interface (Port number)

Type: number

Format: interface

Mutual Exclusion: loopback,update-source-ip, update-source-ipv6, ethernet, ve, trunk, lif, and tunnel are mutually exclusive

maximum-prefix

Description Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

maximum-prefix-thres

Description threshold-value, 1 to 100 percent

Type: number

Range: 1-100

multihop

Description Enable multihop

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nbr-remote-as

Description Specify AS number of BGP neighbor

Type: string

Maximum Length: 11 characters

Maximum Length: 1 characters

neighbor-filter-lists

Type: List

neighbor-ipv6

Description Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Type: List

next-hop-self

Description Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: next-hop-self and peer-group-name are mutually exclusive

override-capability

Description Override capability negotiation result

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-encrypted

Description

pass-value

Description Key String

Type: string

Format: password

Maximum Length: 80 characters

Maximum Length: 1 characters

passive

Description Don’t send open messages to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-name

Description Configure peer-group (peer-group name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: peer-group-name,advertisement-interval, as-origination-interval, default-originate, disallow-infinite-holdtime, next-hop-self, timers, and unsuppress-map are mutually exclusive

prefix-list-direction

Description ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

restart-min

Description restart value, 1 to 1440 minutes

Type: number

Range: 1-1440

route-map

Description Route-map to specify criteria to originate default (route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

route-refresh

Description Advertise route-refresh capability to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

send-community-val

Description ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

shutdown

Description Administratively shut down this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

strict-capability-match

Description Strict capability negotiation match

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

telemetry

Description Send BGP update to telemetry db

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

timers-holdtime

Description Holdtime

Type: number

Range: 0-65535

Default: 90

timers-keepalive

Description Keepalive interval

Type: number

Range: 0-65535

Default: 30

trunk

Description Trunk interface (Trunk interface number)

Type: number

Format: interface

Mutual Exclusion: trunk,update-source-ip, update-source-ipv6, ethernet, loopback, ve, lif, and tunnel are mutually exclusive

tunnel

Description Tunnel interface (Tunnel interface number)

Type: number

Format: interface

Mutual Exclusion: tunnel,update-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk, and lif are mutually exclusive

unsuppress-map

Description Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Mutual Exclusion: unsuppress-map and peer-group-name are mutually exclusive

update-source-ip

Description IP address

Type: string

Format: ipv4-address

Mutual Exclusion: update-source-ip,update-source-ipv6, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive

update-source-ipv6

Description IPv6 address

Type: string

Format: ipv6-address

Mutual Exclusion: update-source-ipv6,update-source-ip, ethernet, loopback, ve, trunk, lif, and tunnel are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

Mutual Exclusion: ve,update-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif, and tunnel are mutually exclusive

weight

Description Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

neighbor_ipv6-neighbor-list_distribute-lists

Specification Value
Type list
Block object keys  

distribute-list

Description Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

distribute-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

neighbor_ipv6-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

neighbor_ipv6-neighbor-list_neighbor-filter-lists

Specification Value
Type list
Block object keys  

filter-list

Description Establish BGP filters (AS path access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

filter-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

neighbor_ipv6-neighbor-list_neighbor-prefix-lists

Specification Value
Type list
Block object keys  

nbr-prefix-list

Description Filter updates to/from this neighbor (Name of a prefix list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

nbr-prefix-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

neighbor_ethernet-neighbor-list

Specification Value
Type list
Block object keys  

ethernet

Description Ethernet interface number

Type: number

Format: interface

peer-group-name

Description

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

unnumbered

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

neighbor_trunk-neighbor-list

Specification Value
Type list
Block object keys  

peer-group-name

Description

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

trunk

Description Trunk interface number

Type: number

Format: interface

unnumbered

Description

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

distance-list

Specification Value
Type list
Block object keys  

acl-str

Description Access list name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

admin-distance

Description Define an administrative distance

Type: number

Range: 1-255

ext-routes-dist

Description Distance for routes external to the AS

Type: number

Range: 1-255

int-routes-dist

Description Distance for routes internal to the AS

Type: number

Range: 1-255

local-routes-dist

Description Distance for local routes

Type: number

Range: 1-255

src-prefix

Description IP source prefix

Type: string

Format: ipv4-cidr

address-family

Specification Value
Type object

ipv4-flowspec

Description: ipv4-flowspec is a JSON Block. Please see below for address-family_ipv4-flowspec

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv4-flowspec

ipv6

Description: ipv6 is a JSON Block. Please see below for address-family_ipv6

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6

ipv6-flowspec

Description: ipv6-flowspec is a JSON Block. Please see below for address-family_ipv6-flowspec

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6-flowspec

address-family_ipv6-flowspec

Specification Value
Type object

neighbor

Description: neighbor is a JSON Block. Please see below for address-family_ipv6-flowspec_neighbor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6-flowspec/neighbor

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6-flowspec_neighbor

address-family_ipv6-flowspec_neighbor_ipv6-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

neighbor-ipv6

Description Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-route-map-lists

Type: List

send-community-val

Description ‘all’: Send Standard, Extended, and Large Community attributes; ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes; ‘large’: Send Large Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6-flowspec_neighbor_ipv6-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6-flowspec_neighbor_ipv4-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

neighbor-ipv4

Description Neighbor address

Type: string

Format: ipv4-address

neighbor-route-map-lists

Type: List

send-community-val

Description ‘all’: Send Standard, Extended, and Large Community attributes; ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes; ‘large’: Send Large Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6-flowspec_neighbor_ipv4-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv4-flowspec

Specification Value
Type object

neighbor

Description: neighbor is a JSON Block. Please see below for address-family_ipv4-flowspec_neighbor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv4-flowspec/neighbor

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv4-flowspec_neighbor

address-family_ipv4-flowspec_neighbor_ipv6-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

neighbor-ipv6

Description Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-route-map-lists

Type: List

send-community-val

Description ‘all’: Send Standard, Extended, and Large Community attributes; ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes; ‘large’: Send Large Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv4-flowspec_neighbor_ipv6-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv4-flowspec_neighbor_ipv4-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

neighbor-ipv4

Description Neighbor address

Type: string

Format: ipv4-address

neighbor-route-map-lists

Type: List

send-community-val

Description ‘all’: Send Standard, Extended, and Large Community attributes; ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes; ‘large’: Send Large Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv4-flowspec_neighbor_ipv4-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6

Specification Value
Type object

aggregate-address-list

Type: List

auto-summary

Description Enable automatic network number summarization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

bgp

Description: bgp is a JSON Block. Please see below for address-family_ipv6_bgp

Type: Object

distance

Description: distance is a JSON Block. Please see below for address-family_ipv6_distance

Type: Object

maximum-paths-value

Description Supported BGP multipath numbers

Type: number

Range: 1-64

Default: 1

neighbor

Description: neighbor is a JSON Block. Please see below for address-family_ipv6_neighbor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor

network

Description: network is a JSON Block. Please see below for address-family_ipv6_network

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network

originate

Description Distribute an IPv6 default route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

redistribute

Description: redistribute is a JSON Block. Please see below for address-family_ipv6_redistribute

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/redistribute

synchronization

Description Perform IGP synchronization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_distance

Specification Value
Type object

distance-ext

Description Distance for routes external to the AS

Type: number

Range: 1-255

distance-int

Description Distance for routes internal to the AS

Type: number

Range: 1-255

distance-local

Description Distance for local routes

Type: number

Range: 1-255

address-family_ipv6_redistribute

Specification Value
Type object

connected-cfg

Description: connected-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_connected-cfg

Type: Object

floating-ip-cfg

Description: floating-ip-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_floating-ip-cfg

Type: Object

ip-nat-cfg

Description: ip-nat-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_ip-nat-cfg

Type: Object

ip-nat-list-cfg

Description: ip-nat-list-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_ip-nat-list-cfg

Type: Object

isis-cfg

Description: isis-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_isis-cfg

Type: Object

lw4o6-cfg

Description: lw4o6-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_lw4o6-cfg

Type: Object

nat-map-cfg

Description: nat-map-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_nat-map-cfg

Type: Object

nat64-cfg

Description: nat64-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_nat64-cfg

Type: Object

ospf-cfg

Description: ospf-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_ospf-cfg

Type: Object

rip-cfg

Description: rip-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_rip-cfg

Type: Object

static-cfg

Description: static-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_static-cfg

Type: Object

static-nat-cfg

Description: static-nat-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_static-nat-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vip

Description: vip is a JSON Block. Please see below for address-family_ipv6_redistribute_vip

Type: Object

address-family_ipv6_redistribute_ip-nat-list-cfg

Specification Value
Type object

ip-nat-list

Description IP NAT list

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_lw4o6-cfg

Specification Value
Type object

lw4o6

Description LW4O6 Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_nat64-cfg

Specification Value
Type object

nat64

Description NAT64 Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_connected-cfg

Specification Value
Type object

connected

Description Connected

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_vip

Specification Value
Type object

only-flagged-cfg

Description: only-flagged-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_vip_only-flagged-cfg

Type: Object

only-not-flagged-cfg

Description: only-not-flagged-cfg is a JSON Block. Please see below for address-family_ipv6_redistribute_vip_only-not-flagged-cfg

Type: Object

address-family_ipv6_redistribute_vip_only-not-flagged-cfg

Specification Value
Type object

only-not-flagged

Description Only not flagged

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_vip_only-flagged-cfg

Specification Value
Type object

only-flagged

Description Selected Virtual IP (VIP)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_ip-nat-cfg

Specification Value
Type object

ip-nat

Description IP NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_floating-ip-cfg

Specification Value
Type object

floating-ip

Description Floating IP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_isis-cfg

Specification Value
Type object

isis

Description ISO IS-IS

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_nat-map-cfg

Specification Value
Type object

nat-map

Description NAT MAP Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_rip-cfg

Specification Value
Type object

rip

Description Routing Information Protocol (RIP)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_ospf-cfg

Specification Value
Type object

ospf

Description Open Shortest Path First (OSPF)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_redistribute_static-nat-cfg

Specification Value
Type object

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

static-nat

Description Static NAT Prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-family_ipv6_redistribute_static-cfg

Specification Value
Type object

route-map

Description Route map reference (Pointer to route-map entries)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

static

Description Static routes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-family_ipv6_aggregate-address-list

Specification Value
Type list
Block object keys  

aggregate-address

Description Configure BGP aggregate entries (Aggregate IPv6 prefix)

Type: string

Format: ipv6-address-plen

as-set

Description Generate AS set path information

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

summary-only

Description Filter more specific routes from updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-family_ipv6_bgp

Specification Value
Type object

dampening

Description Enable route-flap dampening

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

dampening-half

Description Reachability Half-life time for the penalty(minutes)

Type: number

Range: 1-45

dampening-max-supress

Description Maximum duration to suppress a stable route(minutes)

Type: number

Range: 1-255

dampening-start-reuse

Description Value to start reusing a route

Type: number

Range: 1-20000

dampening-start-supress

Description Value to start suppressing a route

Type: number

Range: 1-20000

dampening-unreachability

Description Un-reachability Half-life time for the penalty(minutes)

Type: number

Range: 1-45

route-map

Description Route-map to specify criteria for dampening (Route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_network

Specification Value
Type object

ipv6-network-list

monitor

Description: monitor is a JSON Block. Please see below for address-family_ipv6_network_monitor

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/monitor

synchronization

Description: synchronization is a JSON Block. Please see below for address-family_ipv6_network_synchronization

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/synchronization

address-family_ipv6_network_ipv6-network-list

Specification Value
Type list
Block object keys  

backdoor

Description Specify a BGP backdoor route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

comm-value

Description community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export

Type: string

Format: string-rlx

description

Description Network specific description (Up to 80 characters describing this network)

Type: string

Format: string-rlx

Maximum Length: 80 characters

Maximum Length: 1 characters

lcomm-value

Description Large community value in the format XX:YY:ZZ

Type: string

Format: string-rlx

network-ipv6

Description Specify a network to announce via BGP

Type: string

Format: ipv6-address-plen

route-map

Description Route-map to modify the attributes (Name of the route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_network_synchronization

Specification Value
Type object

network-synchronization

Description Perform IGP synchronization

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_network_monitor

Specification Value
Type object

default

Description: default is a JSON Block. Please see below for address-family_ipv6_network_monitor_default

Type: Object

Reference Object: /axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/monitor/default

address-family_ipv6_network_monitor_default

Specification Value
Type object

network-monitor-default

Description default route monitoring

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_neighbor

Specification Value
Type object

ethernet-neighbor-ipv6-list

ipv4-neighbor-list

ipv6-neighbor-list

peer-group-neighbor-list

trunk-neighbor-ipv6-list

ve-neighbor-ipv6-list

address-family_ipv6_neighbor_ethernet-neighbor-ipv6-list

Specification Value
Type list
Block object keys  

ethernet

Description Ethernet interface number

Type: number

Format: interface

peer-group-name

Description

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_neighbor_ipv4-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in

Description Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

default-originate

Description Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Type: List

graceful-restart

Description enable graceful-restart helper for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inbound

Description Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum-prefix

Description Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

maximum-prefix-thres

Description threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Type: List

neighbor-ipv4

Description Neighbor address

Type: string

Format: ipv4-address

neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Type: List

next-hop-self

Description Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-name

Description Configure peer-group (peer-group name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

prefix-list-direction

Description ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

restart-min

Description restart value, 1 to 1440 minutes

Type: number

Range: 1-1440

route-map

Description Route-map to specify criteria to originate default (route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

send-community-val

Description ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

unsuppress-map

Description Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

address-family_ipv6_neighbor_ipv4-neighbor-list_distribute-lists

Specification Value
Type list
Block object keys  

distribute-list

Description Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

distribute-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-filter-lists

Specification Value
Type list
Block object keys  

filter-list

Description Establish BGP filters (AS path access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

filter-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-prefix-lists

Specification Value
Type list
Block object keys  

nbr-prefix-list

Description Filter updates to/from this neighbor (Name of a prefix list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

nbr-prefix-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

address-family_ipv6_neighbor_peer-group-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in

Description Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

inbound

Description Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum-prefix

Description Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

maximum-prefix-thres

Description threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-route-map-lists

Type: List

next-hop-self

Description Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group

Description Neighbor tag

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

remove-private-as

Description Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_neighbor_ve-neighbor-ipv6-list

Specification Value
Type list
Block object keys  

peer-group-name

Description

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual ethernet interface number

Type: number

Format: interface

address-family_ipv6_neighbor_trunk-neighbor-ipv6-list

Specification Value
Type list
Block object keys  

peer-group-name

Description

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

trunk

Description Trunk interface number

Type: number

Format: interface

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

address-family_ipv6_neighbor_ipv6-neighbor-list

Specification Value
Type list
Block object keys  

activate

Description Enable the Address Family for this Neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in

Description Accept as-path with my AS present in it

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allowas-in-count

Description Number of occurrences of AS number

Type: number

Range: 1-10

Default: 3

default-originate

Description Originate default route to this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Type: List

graceful-restart

Description enable graceful-restart helper for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

inbound

Description Allow inbound soft reconfiguration for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum-prefix

Description Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model))

Type: number

maximum-prefix-thres

Description threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Type: List

neighbor-ipv6

Description Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Type: List

next-hop-self

Description Disable the next hop calculation for this neighbor

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

peer-group-name

Description Configure peer-group (peer-group name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

prefix-list-direction

Description ‘both’: both; ‘receive’: receive; ‘send’: send;

Type: string

Supported Values: both, receive, send

remove-private-as

Description Remove private AS number from outbound updates

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

restart-min

Description restart value, 1 to 1440 minutes

Type: number

Range: 1-1440

route-map

Description Route-map to specify criteria to originate default (route-map name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

send-community-val

Description ‘both’: Send Standard and Extended Community attributes; ‘none’: Disable Sending Community attributes; ‘standard’: Send Standard Community attributes; ‘extended’: Send Extended Community attributes;

Type: string

Supported Values: all, both, none, standard, extended, large

Default: both

unsuppress-map

Description Route-map to selectively unsuppress suppressed routes (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

weight

Description Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

address-family_ipv6_neighbor_ipv6-neighbor-list_distribute-lists

Specification Value
Type list
Block object keys  

distribute-list

Description Filter updates to/from this neighbor (IP standard/extended/named access list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

distribute-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-route-map-lists

Specification Value
Type list
Block object keys  

nbr-rmap-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

nbr-route-map

Description Apply route map to neighbor (Name of route map)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-filter-lists

Specification Value
Type list
Block object keys  

filter-list

Description Establish BGP filters (AS path access-list name)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

filter-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out

address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-prefix-lists

Specification Value
Type list
Block object keys  

nbr-prefix-list

Description Filter updates to/from this neighbor (Name of a prefix list)

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

nbr-prefix-list-direction

Description ‘in’: in; ‘out’: out;

Type: string

Supported Values: in, out