router bgp

Border Gateway Protocol (BGP)

bgp Specification

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
Schema bgp schema

Operations Allowed:

Operation Method URI Payload

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

Description: aggregate-address-list is a JSON List . Please see below for aggregate-address-list

Type: List

as-number

Description: AS number

Type: number

Range: 1-4294967295

Required: Yes

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

Description: distance-list is a JSON List . Please see below for 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

uuid

Description: uuid of the object

Type: string

redistribute

Specification
Type object

connected-cfg

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

Type: Object

floating-ip-cfg

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

Type: Object

ip-nat-cfg

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

Type: Object

ip-nat-list-cfg

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

Type: Object

isis-cfg

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

Type: Object

lw4o6-cfg

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

Type: Object

ospf-cfg

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

Type: Object

rip-cfg

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

Type: Object

static-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

vip

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

Type: Object

redistribute.ip-nat-list-cfg

Specification
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

redistribute.lw4o6-cfg

Specification
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

redistribute.connected-cfg

Specification
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

redistribute.ip-nat-cfg

Specification
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

redistribute.floating-ip-cfg

Specification
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

redistribute.isis-cfg

Specification
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

redistribute.vip

Specification
Type object

only-flagged-cfg

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

Type: Object

only-not-flagged-cfg

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

Type: Object

redistribute.vip.only-not-flagged-cfg

Specification
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

redistribute.vip.only-flagged-cfg

Specification
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

redistribute.rip-cfg

Specification
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

redistribute.ospf-cfg

Specification
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

redistribute.static-cfg

Specification
Type object

route-map

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

Type: string

static

Description: Static routes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

aggregate-address-list

Specification
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
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 l351_bestpath-cfg

Type: Object

dampening-cfg

Description: dampening-cfg is a JSON Block . Please see below for l351_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

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
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

bgp.bestpath-cfg

Specification
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
Type object

ip-cidr-list

Description: ip-cidr-list is a JSON List . Please see below for l351_ip-cidr-list

Type: List

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

synchronization

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

Type: Object

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

network.synchronization

Specification
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

network.ip-cidr-list

Specification
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

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

uuid

Description: uuid of the object

Type: string

timers

Specification
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
Type object

ipv4-neighbor-list

Description: ipv4-neighbor-list is a JSON List . Please see below for l351_ipv4-neighbor-list

Type: List

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

ipv6-neighbor-list

Description: ipv6-neighbor-list is a JSON List . Please see below for l351_ipv6-neighbor-list

Type: List

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

peer-group-neighbor-list

Description: peer-group-neighbor-list is a JSON List . Please see below for l351_peer-group-neighbor-list

Type: List

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

neighbor.peer-group-neighbor-list

Specification
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

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

disallow-infinite-holdtime

Description: BGP per neighbor disallow-infinite-holdtime

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

distribute-lists

Description: distribute-lists is a JSON List . Please see below for l351_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 and lif are mutually exclusive

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 number)

Type: number

Range: 1-128

Mutual Exclusion: lif update-source-ip, update-source-ipv6, ethernet, loopback, ve and trunk 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 and lif 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

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l351_neighbor-filter-lists

Type: List

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l351_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l351_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

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

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

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: number

Range: 1-4294967295

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

route-map

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

Type: string

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: both, none, standard, extended

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

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 and lif are mutually exclusive

unsuppress-map

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

Type: string

update-source-ip

Description: IP address

Type: string

Format: ipv4-address

Mutual Exclusion: update-source-ip update-source-ipv6, ethernet, loopback, ve, trunk and lif 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 and lif are mutually exclusive

uuid

Description: uuid of the object

Type: string

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 and lif 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.distribute-lists

Specification
Type list
Block object keys

distribute-list

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

Type: string

distribute-list-direction

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

Type: string

Supported Values: in, out

neighbor.peer-group-neighbor-list.neighbor-route-map-lists

Specification
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

neighbor.peer-group-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

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

Type: string

nbr-prefix-list-direction

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

Type: string

Supported Values: in, out

neighbor.peer-group-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

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

Type: string

filter-list-direction

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

Type: string

Supported Values: in, out

neighbor.ipv6-neighbor-list

Specification
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

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

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

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

Description: distribute-lists is a JSON List . Please see below for l351_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 and lif are mutually exclusive

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 number)

Type: number

Range: 1-128

Mutual Exclusion: lif update-source-ip, update-source-ipv6, ethernet, loopback, ve and trunk 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 and lif 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

Range: 1-65536

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: number

Range: 1-4294967295

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l351_neighbor-filter-lists

Type: List

neighbor-ipv6

Description: Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l351_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l351_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

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

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

route-map

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

Type: string

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: both, none, standard, extended

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

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 and lif are mutually exclusive

unsuppress-map

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

Type: string

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 and lif 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 and lif are mutually exclusive

uuid

Description: uuid of the object

Type: string

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 and lif 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
Type list
Block object keys

distribute-list

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

Type: string

distribute-list-direction

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

Type: string

Supported Values: in, out

neighbor.ipv6-neighbor-list.neighbor-route-map-lists

Specification
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

neighbor.ipv6-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

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

Type: string

filter-list-direction

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

Type: string

Supported Values: in, out

neighbor.ipv6-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

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

Type: string

nbr-prefix-list-direction

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

Type: string

Supported Values: in, out

neighbor.ipv4-neighbor-list

Specification
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

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

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

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

Description: distribute-lists is a JSON List . Please see below for l351_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 and lif are mutually exclusive

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 number)

Type: number

Range: 1-128

Mutual Exclusion: lif update-source-ip, update-source-ipv6, ethernet, loopback, ve and trunk 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 and lif 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

Range: 1-65536

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: number

Range: 1-4294967295

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l351_neighbor-filter-lists

Type: List

neighbor-ipv4

Description: Neighbor address

Type: string

Format: ipv4-address

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l351_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l351_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

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

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

route-map

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

Type: string

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: both, none, standard, extended

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

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 and lif are mutually exclusive

unsuppress-map

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

Type: string

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 and lif 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 and lif are mutually exclusive

uuid

Description: uuid of the object

Type: string

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 and lif 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
Type list
Block object keys

distribute-list

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

Type: string

distribute-list-direction

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

Type: string

Supported Values: in, out

neighbor.ipv4-neighbor-list.neighbor-route-map-lists

Specification
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

neighbor.ipv4-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

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

Type: string

filter-list-direction

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

Type: string

Supported Values: in, out

neighbor.ipv4-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

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

Type: string

nbr-prefix-list-direction

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

Type: string

Supported Values: in, out

distance-list

Specification
Type list
Block object keys

acl-str

Description: Access list name

Type: string

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
Type object

ipv6

Description: ipv6 is a JSON Block . Please see below for l351_ipv6

Type: Object

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

address-family.ipv6

Specification
Type object

aggregate-address-list

Description: aggregate-address-list is a JSON List . Please see below for 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 bgp

Type: Object

distance

Description: distance is a JSON Block . Please see below for l351_distance

Type: Object

maximum-paths-value

Description: Supported BGP multipath numbers

Type: number

Range: 1-10

Default: 1

neighbor

Description: neighbor is a JSON Block . Please see below for 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 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 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

address-family.ipv6.distance

Specification
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
Type object

connected-cfg

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

Type: Object

floating-ip-cfg

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

Type: Object

ip-nat-cfg

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

Type: Object

ip-nat-list-cfg

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

Type: Object

isis-cfg

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

Type: Object

lw4o6-cfg

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

Type: Object

nat64-cfg

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

Type: Object

ospf-cfg

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

Type: Object

rip-cfg

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

Type: Object

static-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

vip

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

Type: Object

address-family.ipv6.redistribute.ip-nat-list-cfg

Specification
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

address-family.ipv6.redistribute.lw4o6-cfg

Specification
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

address-family.ipv6.redistribute.nat64-cfg

Specification
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

address-family.ipv6.redistribute.connected-cfg

Specification
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

address-family.ipv6.redistribute.ip-nat-cfg

Specification
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

address-family.ipv6.redistribute.floating-ip-cfg

Specification
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

address-family.ipv6.redistribute.isis-cfg

Specification
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

address-family.ipv6.redistribute.vip

Specification
Type object

only-flagged-cfg

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

Type: Object

only-not-flagged-cfg

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

Type: Object

address-family.ipv6.redistribute.vip.only-not-flagged-cfg

Specification
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

address-family.ipv6.redistribute.vip.only-flagged-cfg

Specification
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

address-family.ipv6.redistribute.rip-cfg

Specification
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

address-family.ipv6.redistribute.ospf-cfg

Specification
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

address-family.ipv6.redistribute.static-cfg

Specification
Type object

route-map

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

Type: string

static

Description: Static routes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

address-family.ipv6.aggregate-address-list

Specification
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
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

address-family.ipv6.network

Specification
Type object

ipv6-network-list

Description: ipv6-network-list is a JSON List . Please see below for l351_ipv6-network-list

Type: List

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

synchronization

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

Type: Object

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

address-family.ipv6.network.ipv6-network-list

Specification
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

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

uuid

Description: uuid of the object

Type: string

address-family.ipv6.network.synchronization

Specification
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

address-family.ipv6.neighbor

Specification
Type object

ipv4-neighbor-list

Description: ipv4-neighbor-list is a JSON List . Please see below for l351_ipv4-neighbor-list

Type: List

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

ipv6-neighbor-list

Description: ipv6-neighbor-list is a JSON List . Please see below for l351_ipv6-neighbor-list

Type: List

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

peer-group-neighbor-list

Description: peer-group-neighbor-list is a JSON List . Please see below for l351_peer-group-neighbor-list

Type: List

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

address-family.ipv6.neighbor.peer-group-neighbor-list

Specification
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

Description: distribute-lists is a JSON List . Please see below for l351_distribute-lists

Type: List

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

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l351_neighbor-filter-lists

Type: List

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l351_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l351_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

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

route-map

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

Type: string

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: both, none, standard, extended

Default: both

unsuppress-map

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

Type: string

uuid

Description: uuid of the object

Type: string

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-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

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

Type: string

nbr-prefix-list-direction

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

Type: string

Supported Values: in, out

address-family.ipv6.neighbor.peer-group-neighbor-list.distribute-lists

Specification
Type list
Block object keys

distribute-list

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

Type: string

distribute-list-direction

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

Type: string

Supported Values: in, out

address-family.ipv6.neighbor.peer-group-neighbor-list.neighbor-route-map-lists

Specification
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

address-family.ipv6.neighbor.peer-group-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

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

Type: string

filter-list-direction

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

Type: string

Supported Values: in, out

address-family.ipv6.neighbor.ipv6-neighbor-list

Specification
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

Description: distribute-lists is a JSON List . Please see below for l351_distribute-lists

Type: List

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

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l351_neighbor-filter-lists

Type: List

neighbor-ipv6

Description: Neighbor IPv6 address

Type: string

Format: ipv6-address

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l351_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l351_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

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

route-map

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

Type: string

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: both, none, standard, extended

Default: both

unsuppress-map

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

Type: string

uuid

Description: uuid of the object

Type: string

weight

Description: Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

address-family.ipv6.neighbor.ipv6-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

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

Type: string

nbr-prefix-list-direction

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

Type: string

Supported Values: in, out

address-family.ipv6.neighbor.ipv6-neighbor-list.distribute-lists

Specification
Type list
Block object keys

distribute-list

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

Type: string

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
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

address-family.ipv6.neighbor.ipv6-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

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

Type: string

filter-list-direction

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

Type: string

Supported Values: in, out

address-family.ipv6.neighbor.ipv4-neighbor-list

Specification
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

Description: distribute-lists is a JSON List . Please see below for l351_distribute-lists

Type: List

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

Range: 1-65536

maximum-prefix-thres

Description: threshold-value, 1 to 100 percent

Type: number

Range: 1-100

neighbor-filter-lists

Description: neighbor-filter-lists is a JSON List . Please see below for l351_neighbor-filter-lists

Type: List

neighbor-ipv4

Description: Neighbor address

Type: string

Format: ipv4-address

neighbor-prefix-lists

Description: neighbor-prefix-lists is a JSON List . Please see below for l351_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

Description: neighbor-route-map-lists is a JSON List . Please see below for l351_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

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

route-map

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

Type: string

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: both, none, standard, extended

Default: both

unsuppress-map

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

Type: string

uuid

Description: uuid of the object

Type: string

weight

Description: Set default weight for routes from this neighbor

Type: number

Range: 0-65535

Default: 0

address-family.ipv6.neighbor.ipv4-neighbor-list.neighbor-prefix-lists

Specification
Type list
Block object keys

nbr-prefix-list

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

Type: string

nbr-prefix-list-direction

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

Type: string

Supported Values: in, out

address-family.ipv6.neighbor.ipv4-neighbor-list.distribute-lists

Specification
Type list
Block object keys

distribute-list

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

Type: string

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
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

address-family.ipv6.neighbor.ipv4-neighbor-list.neighbor-filter-lists

Specification
Type list
Block object keys

filter-list

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

Type: string

filter-list-direction

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

Type: string

Supported Values: in, out