router

Configure routing process

router Specification

Type Intermediate Resource
Element Name router
Element URI /axapi/v3/router
Element Attributes router_attributes
Schema router schema

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/router

router_attributes

router Attributes

bgp-list

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

Type: List

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

ipv6

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

Type: Object

Reference Object: /axapi/v3/router/ipv6

isis-list

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

Type: List

Reference Object: /axapi/v3/router/isis/{tag}

log

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

Type: Object

Reference Object: /axapi/v3/router/log

ospf-list

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

Type: List

Reference Object: /axapi/v3/router/ospf/{process-id}

rip

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

Type: Object

Reference Object: /axapi/v3/router/rip

ospf-list

Specification
Type list
Block object keys

area-list

Description: area-list is a JSON List . Please see below for l378_area-list

Type: List

Reference Object: /axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}

auto-cost-reference-bandwidth

Description: Use reference bandwidth method to assign OSPF cost (The reference bandwidth in terms of Mbits per second)

Type: number

Range: 1-4294967

Default: 10000

bfd-all-interfaces

Description: Enable BFD on all interfaces

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-information

Description: default-information is a JSON Block . Please see below for l378_default-information

Type: Object

Reference Object: /axapi/v3/router/ospf/{process-id}/default-information

default-metric

Description: Set metric of redistributed routes (Default metric)

Type: number

Range: 1-16777214

Default: 20

distance

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

Type: Object

distribute-internal-list

Description: distribute-internal-list is a JSON List . Please see below for l378_distribute-internal-list

Type: List

distribute-lists

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

Type: List

ha-standby-extra-cost

Description: Extra ospf cost when there is any standby HA group (The extra cost value)

Type: number

Range: 1-65535

host-list

Description: host-list is a JSON List . Please see below for l378_host-list

Type: List

log-adjacency-changes-cfg

Description: log-adjacency-changes-cfg is a JSON Block . Please see below for l378_log-adjacency-changes-cfg

Type: Object

max-concurrent-dd

Description: Maximum number allowed to process DD concurrently (Number of DD process)

Type: number

Range: 1-65535

Default: 5

maximum-area

Description: Maximum number of OSPF area (OSPF area limit)

Type: number

Range: 1-4294967294

neighbor-list

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

Type: List

network-list

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

Type: List

ospf-1

Description: ospf-1 is a JSON Block . Please see below for l378_ospf-1

Type: Object

overflow

Description: overflow is a JSON Block . Please see below for l378_overflow

Type: Object

passive-interface

Description: passive-interface is a JSON Block . Please see below for l378_passive-interface

Type: Object

process-id

Description: OSPF process ID

Type: number

Range: 0-65535

Default: 0

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/ospf/{process-id}/redistribute

rfc1583-compatible

Description: Compatible with RFC 1583

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

router-id

Description: router-id is a JSON Block . Please see below for l378_router-id

Type: Object

summary-address-list

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

Type: List

timers

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

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ospf-list.distribute-internal-list

Specification
Type list
Block object keys

di-area-ipv4

Description: OSPF area ID as a IP address format

Type: string

Format: ipv4-address

di-area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

di-cost

Description: Cost of route

Type: number

Range: 1-65535

Default: 1

di-type

Description: ‘lw4o6’: LW4O6 Prefix; ‘floating-ip’: Floating IP; ‘ip-nat’: IP NAT; ‘ip-nat-list’: IP NAT list; ‘vip’: Virtual IP (VIP); ‘vip-only-flagged’: Selected Virtual IP (VIP);

Type: string

Supported Values: lw4o6, floating-ip, ip-nat, ip-nat-list, vip, vip-only-flagged

ospf-list.distribute-lists

Specification
Type list
Block object keys

direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

option

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

ospf-id

Description: OSPF process ID

Type: number

Range: 1-65535

protocol

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘lw4o6’: LW4O6 Prefix; ‘ip-nat’: IP NAT; ‘ip-nat-list’: IP NAT list; ‘isis’: ISO IS-IS; ‘ospf’: Open Shortest Path First (OSPF); ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, lw4o6, ip-nat, ip-nat-list, isis, ospf, rip, static

value

Description: Access-list name

Type: string

ospf-list.router-id

Specification
Type object

value

Description: OSPF router-id in IPv4 address format

Type: string

Format: ipv4-address

ospf-list.neighbor-list

Specification
Type list
Block object keys

address

Description: Neighbor address

Type: string

Format: ipv4-address

cost

Description: OSPF cost for point-to-multipoint neighbor (Metric)

Type: number

Range: 1-65535

poll-interval

Description: OSPF dead-router polling interval (Seconds)

Type: number

Range: 1-65535

priority

Description: OSPF priority of non-broadcast neighbor

Type: number

Range: 0-255

ospf-list.ospf-1

Specification
Type object

abr-type

Description: abr-type is a JSON Block . Please see below for l378_abr-type

Type: Object

ospf-list.ospf-1.abr-type

Specification
Type object

option

Description: ‘cisco’: Alternative ABR, Cisco implementation (RFC3509); ‘ibm’: Alternative ABR, IBM implementation (RFC3509); ‘shortcut’: Shortcut ABR; ‘standard’: Standard behavior (RFC2328);

Type: string

Supported Values: cisco, ibm, shortcut, standard

Default: cisco

ospf-list.host-list

Specification
Type list
Block object keys

area-cfg

Description: area-cfg is a JSON Block . Please see below for l378_area-cfg

Type: Object

host-address

Description: Host address

Type: string

Format: ipv4-address

ospf-list.host-list.area-cfg

Specification
Type object

area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

cost

Description: Cost of host

Type: number

Range: 0-65535

Default: 0

ospf-list.log-adjacency-changes-cfg

Specification
Type object

state

Description: ‘detail’: Log changes in adjacency state; ‘disable’: Disable logging;

Type: string

Supported Values: detail, disable

ospf-list.area-list

Specification
Type list
Block object keys

area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

auth-cfg

Description: auth-cfg is a JSON Block . Please see below for l378_auth-cfg

Type: Object

default-cost

Description: Set the summary-default cost of a NSSA or stub area (Stub’s advertised default summary cost)

Type: number

Range: 0-16777215

Default: 1

filter-lists

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

Type: List

nssa-cfg

Description: nssa-cfg is a JSON Block . Please see below for l378_nssa-cfg

Type: Object

range-list

Description: range-list is a JSON List . Please see below for l378_range-list

Type: List

shortcut

Description: ‘default’: Set default shortcutting behavior; ‘disable’: Disable shortcutting through the area; ‘enable’: Enable shortcutting through the area;

Type: string

Supported Values: default, disable, enable

Default: default

stub-cfg

Description: stub-cfg is a JSON Block . Please see below for l378_stub-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

virtual-link-list

Description: virtual-link-list is a JSON List . Please see below for l378_virtual-link-list

Type: List

ospf-list.area-list.nssa-cfg

Specification
Type object

default-information-originate

Description: Originate Type 7 default into NSSA area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

Default: 1

metric-type

Description: OSPF metric type (OSPF metric type for default routes)

Type: number

Range: 1-2

Default: 2

no-redistribution

Description: No redistribution into this NSSA area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no-summary

Description: Do not send summary LSA into NSSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nssa

Description: Specify a NSSA area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

translator-role

Description: ‘always’: Translate always; ‘candidate’: Candidate for translator (default); ‘never’: Do not translate;

Type: string

Supported Values: always, candidate, never

Default: candidate

ospf-list.area-list.filter-lists

Specification
Type list
Block object keys

acl-direction

Description: ‘in’: Filter networks sent to this area; ‘out’: Filter networks sent from this area;

Type: string

Supported Values: in, out

acl-name

Description: Filter networks by access-list (Name of an access-list)

Type: string

filter-list

Description: Filter networks between OSPF areas

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

plist-direction

Description: ‘in’: Filter networks sent to this area; ‘out’: Filter networks sent from this area;

Type: string

Supported Values: in, out

plist-name

Description: Filter networks by prefix-list (Name of an IP prefix-list)

Type: string

ospf-list.area-list.stub-cfg

Specification
Type object

no-summary

Description: Do not inject inter-area routes into area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stub

Description: Configure OSPF area as stub

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf-list.area-list.auth-cfg

Specification
Type object

authentication

Description: Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

message-digest

Description: Use message-digest authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf-list.area-list.range-list

Specification
Type list
Block object keys

area-range-prefix

Description: Area range for IPv4 prefix

Type: string

Format: ipv4-cidr

option

Description: ‘advertise’: Advertise this range (default); ‘not-advertise’: DoNotAdvertise this range;

Type: string

Supported Values: advertise, not-advertise

Default: advertise

ospf-list.summary-address-list

Specification
Type list
Block object keys

not-advertise

Description: Suppress routes that match the prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

summary-address

Description: Configure IP address summaries (Summary prefix)

Type: string

Format: ipv4-cidr

tag

Description: Set tag (32-bit tag value)

Type: number

Range: 0-4294967295

ospf-list.passive-interface

Specification
Type object

eth-cfg

Description: eth-cfg is a JSON List . Please see below for l378_eth-cfg

Type: List

lif-cfg

Description: lif-cfg is a JSON List . Please see below for l378_lif-cfg

Type: List

loopback-cfg

Description: loopback-cfg is a JSON List . Please see below for l378_loopback-cfg

Type: List

trunk-cfg

Description: trunk-cfg is a JSON List . Please see below for l378_trunk-cfg

Type: List

ve-cfg

Description: ve-cfg is a JSON List . Please see below for l378_ve-cfg

Type: List

ospf-list.passive-interface.eth-cfg

Specification
Type list
Block object keys

eth-address

Description: Address of Interface

Type: string

Format: ipv4-address

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

ospf-list.passive-interface.ve-cfg

Specification
Type list
Block object keys

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ve-address

Description: Address of Interface

Type: string

Format: ipv4-address

ospf-list.passive-interface.trunk-cfg

Specification
Type list
Block object keys

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

trunk-address

Description: Address of Interface

Type: string

Format: ipv4-address

ospf-list.passive-interface.loopback-cfg

Specification
Type list
Block object keys

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

loopback-address

Description: Address of Interface

Type: string

Format: ipv4-address

ospf-list.passive-interface.lif-cfg

Specification
Type list
Block object keys

lif

Description: Logical interface (Lif interface number)

Type: number

Format: interface

lif-address

Description: Address of Interface

Type: string

Format: ipv4-address

ospf-list.default-information

Specification
Type object

always

Description: Always advertise default route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type

Description: OSPF metric type for default routes

Type: number

Range: 1-2

Default: 2

originate

Description: Distribute a default route

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

route-map

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

Type: string

uuid

Description: uuid of the object

Type: string

ospf-list.overflow

Specification
Type object

database

Description: database is a JSON Block . Please see below for l378_database

Type: Object

ospf-list.overflow.database

Specification
Type object

count

Description: Maximum number of LSAs

Type: number

Range: 0-4294967294

Default: 4294967294

db-external

Description: Maximum number of LSAs

Type: number

Range: 0-2147483647

Default: 2147483647

limit

Description: ‘hard’: Hard limit: Instance will be shutdown if exceeded; ‘soft’: Soft limit: Warning will be given if exceeded;

Type: string

Supported Values: hard, soft

Default: hard

recovery-time

Description: Time to recover (0 not recover)

Type: number

Range: 0-65535

Default: 0

ospf-list.distance

Specification
Type object

distance-ospf

Description: distance-ospf is a JSON Block . Please see below for l378_distance-ospf

Type: Object

distance-value

Description: OSPF Administrative distance

Type: number

Range: 1-255

Default: 110

ospf-list.distance.distance-ospf

Specification
Type object

distance-external

Description: External routes (Distance for external routes)

Type: number

Range: 1-255

distance-inter-area

Description: Inter-area routes (Distance for inter-area routes)

Type: number

Range: 1-255

distance-intra-area

Description: Intra-area routes (Distance for intra-area routes)

Type: number

Range: 1-255

ospf-list.redistribute

Specification
Type object

ip-nat

Description: IP-NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-nat-floating-list

Description: ip-nat-floating-list is a JSON List . Please see below for l378_ip-nat-floating-list

Type: List

metric-ip-nat

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type-ip-nat

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

ospf-list

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

Type: List

redist-list

Description: redist-list is a JSON List . Please see below for l378_redist-list

Type: List

route-map-ip-nat

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

Type: string

tag-ip-nat

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

vip-floating-list

Description: vip-floating-list is a JSON List . Please see below for l378_vip-floating-list

Type: List

vip-list

Description: vip-list is a JSON List . Please see below for l378_vip-list

Type: List

ospf-list.redistribute.redist-list

Specification
Type list
Block object keys

metric

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

route-map

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

Type: string

tag

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-4294967295

type

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘lw4o6’: LW4O6 Prefix; ‘isis’: ISO IS-IS; ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, ip-nat-list, lw4o6, isis, rip, static

ospf-list.redistribute.ospf-list

Specification
Type list
Block object keys

metric-ospf

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type-ospf

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

ospf

Description: Open Shortest Path First (OSPF)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

process-id

Description: OSPF process ID

Type: number

Range: 1-65535

route-map-ospf

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

Type: string

tag-ospf

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-4294967295

ospf-list.redistribute.ip-nat-floating-list

Specification
Type list
Block object keys

ip-nat-floating-IP-forward

Description: Floating-IP as forward address

Type: string

Format: ipv4-address

ip-nat-prefix

Description: Address

Type: string

Format: ipv4-cidr

ospf-list.redistribute.vip-list

Specification
Type list
Block object keys

metric-type-vip

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

metric-vip

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

route-map-vip

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

Type: string

tag-vip

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-2147483647

type-vip

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

ospf-list.redistribute.vip-floating-list

Specification
Type list
Block object keys

vip-address

Description: Address

Type: string

Format: ipv4-address

vip-floating-IP-forward

Description: Floating-IP as forward address

Type: string

Format: ipv4-address

ospf-list.network-list

Specification
Type list
Block object keys

network-area

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

Type: Object

network-ipv4

Description: Network number

Type: string

Format: ipv4-address

network-ipv4-cidr

Description: OSPF network prefix

Type: string

Format: ipv4-cidr

network-ipv4-mask

Description: OSPF wild card bits

Type: string

Format: ipv4-rev-netmask

ospf-list.network-list.network-area

Specification
Type object

instance-value

Description: Instance ID

Type: number

Range: 0-255

Default: 0

network-area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

network-area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

ospf-list.timers

Specification
Type object

spf

Description: spf is a JSON Block . Please see below for l378_spf

Type: Object

ospf-list.timers.spf

Specification
Type object

exp

Description: exp is a JSON Block . Please see below for l378_exp

Type: Object

ospf-list.timers.spf.exp

Specification
Type object

max-delay

Description: Maximum delay between receiving a change to SPF calculation in milliseconds

Type: number

Range: 0-2147483647

Default: 50000

min-delay

Description: Minimum delay between receiving a change to SPF calculation in milliseconds

Type: number

Range: 0-2147483647

Default: 500

log

Specification
Type object

file

Description: file is a JSON Block . Please see below for l378_file

Type: Object

Reference Object: /axapi/v3/router/log/file

log-buffer

Description: Logging goes to log-buffer

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

uuid

Description: uuid of the object

Type: string

log.file

Specification
Type object

name

Description: Logging filename (File name)

Type: string

per-protocol

Description: Per protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rotate

Description: Log file rotation (Number of backup files)

Type: number

Range: 0-100

size

Description: Log file maximum size (File size in MBytes)

Type: number

Range: 0-1000000

uuid

Description: uuid of the object

Type: string

rip

Specification
Type object

cisco-metric-behavior

Description: ‘enable’: Enables updating metric consistent with Cisco; ‘disable’: Disables updating metric consistent with Cisco; (Enable/Disable updating metric consistent with Cisco)

Type: string

Supported Values: enable, disable

Default: disable

default-information

Description: ‘originate’: originate; (Distribute default route)

Type: string

Supported Values: originate

default-metric

Description: Set a metric of redistribute routes (Default metric)

Type: number

Range: 1-16

Default: 1

distance-list-cfg

Description: distance-list-cfg is a JSON List . Please see below for l378_distance-list-cfg

Type: List

distribute-list

Description: distribute-list is a JSON Block . Please see below for l378_distribute-list

Type: Object

Reference Object: /axapi/v3/router/rip/distribute-list

neighbor

Description: neighbor is a JSON List . Please see below for l378_neighbor

Type: List

network-addresses

Description: network-addresses is a JSON List . Please see below for l378_network-addresses

Type: List

network-interface-list-cfg

Description: network-interface-list-cfg is a JSON List . Please see below for l378_network-interface-list-cfg

Type: List

offset-list

Description: offset-list is a JSON Block . Please see below for l378_offset-list

Type: Object

Reference Object: /axapi/v3/router/rip/offset-list

passive-interface-list

Description: passive-interface-list is a JSON List . Please see below for l378_passive-interface-list

Type: List

recv-buffer-size

Description: Set the RIP UDP receive buffer size (the RIP UDP receive buffer size value)

Type: number

Range: 8192-2147483647

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/rip/redistribute

rip-maximum-prefix-cfg

Description: rip-maximum-prefix-cfg is a JSON Block . Please see below for l378_rip-maximum-prefix-cfg

Type: Object

route-cfg

Description: route-cfg is a JSON List . Please see below for l378_route-cfg

Type: List

timers

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

Type: Object

uuid

Description: uuid of the object

Type: string

version

Description: Set routing protocol version (RIP version)

Type: number

Range: 1-2

Default: 2

rip.rip-maximum-prefix-cfg

Specification
Type object

maximum-prefix

Description: Set the maximum number of RIP routes

Type: number

Range: 1-2048

maximum-prefix-thres

Description: Percentage of maximum routes to generate a warning (Default 75%)

Type: number

Range: 1-100

Default: 75

rip.route-cfg

Specification
Type list
Block object keys

route

Description: Static route advertisement (debugging purpose) (IP prefix network/length)

Type: string

Format: ipv4-cidr

rip.passive-interface-list

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

rip.redistribute

Specification
Type object

redist-list

Description: redist-list is a JSON List . Please see below for l378_redist-list

Type: List

uuid

Description: uuid of the object

Type: string

vip-list

Description: vip-list is a JSON List . Please see below for l378_vip-list

Type: List

rip.redistribute.vip-list

Specification
Type list
Block object keys

vip-metric

Description: Metric for redistributed routes (metric value)

Type: number

Range: 0-16

vip-route-map

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

Type: string

vip-type

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

rip.redistribute.redist-list

Specification
Type list
Block object keys

metric

Description: Metric for redistributed routes (metric value)

Type: number

Range: 0-16

route-map

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

Type: string

type

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘ip-nat’: IP NAT; ‘isis’: ISO IS-IS; ‘lw4o6’: LW4O6 Prefix; ‘ospf’: Open Shortest Path First (OSPF); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, ospf, static

rip.network-interface-list-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

rip.timers

Specification
Type object

timers-cfg

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

Type: Object

rip.timers.timers-cfg

Specification
Type object

basic

Description: Basic routing protocol update timers (Routing table update timer value in second. Default is 30)

Type: number

Range: 5-2147483647

val-2

Description: Routing information timeout timer. Default is 180

Type: number

Range: 5-2147483647

val-3

Description: Garbage collection timer. Default is 120

Type: number

Range: 5-2147483647

rip.neighbor

Specification
Type list
Block object keys

value

Description: Neighbor address

Type: string

Format: ipv4-address

rip.offset-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l378_acl-cfg

Type: List

uuid

Description: uuid of the object

Type: string

rip.offset-list.acl-cfg

Specification
Type list
Block object keys

acl

Description: Access-list name

Type: string

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

metric

Description: Metric value

Type: number

Range: 0-16

offset-list-direction

Description: ‘in’: Filter incoming updates; ‘out’: Filter outgoing updates;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

rip.distribute-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l378_acl-cfg

Type: List

prefix

Description: prefix is a JSON Block . Please see below for l378_prefix

Type: Object

Reference Object: /axapi/v3/router/rip/distribute-list/prefix

uuid

Description: uuid of the object

Type: string

rip.distribute-list.acl-cfg

Specification
Type list
Block object keys

acl

Description: Access-list name

Type: string

acl-direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

rip.distribute-list.prefix

Specification
Type object

prefix-cfg

Description: prefix-cfg is a JSON List . Please see below for l378_prefix-cfg

Type: List

uuid

Description: uuid of the object

Type: string

rip.distribute-list.prefix.prefix-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

prefix-list

Description: Filter prefixes in routing updates (Name of a prefix list)

Type: string

prefix-list-direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

rip.distance-list-cfg

Specification
Type list
Block object keys

distance

Description: Administrative distance (Distance value)

Type: number

Range: 1-255

Default: 120

distance-acl

Description: Access list name

Type: string

distance-ipv4-mask

Description: IP source prefix

Type: string

Format: ipv4-cidr

rip.network-addresses

Specification
Type list
Block object keys

network-ipv4-mask

Description: IP prefix network/length, e.g., 35.0.0.0/8

Type: string

Format: ipv4-cidr

bgp-list

Specification
Type list
Block object keys

address-family

Description: address-family is a JSON Block . Please see below for l378_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 l378_aggregate-address-list

Type: List

as-number

Description: AS number

Type: number

Range: 1-4294967295

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 l378_bgp

Type: Object

distance-list

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

Type: Object

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

network

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

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

bgp-list.redistribute

Specification
Type object

connected-cfg

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

Type: Object

floating-ip-cfg

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

Type: Object

ip-nat-cfg

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

Type: Object

ip-nat-list-cfg

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

Type: Object

isis-cfg

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

Type: Object

lw4o6-cfg

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

Type: Object

ospf-cfg

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

Type: Object

rip-cfg

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

Type: Object

static-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

vip

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

Type: Object

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.redistribute.vip

Specification
Type object

only-flagged-cfg

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

Type: Object

only-not-flagged-cfg

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

Type: Object

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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-list.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 l378_bestpath-cfg

Type: Object

dampening-cfg

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

bgp-list.network

Specification
Type object

ip-cidr-list

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

Type: Object

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.neighbor

Specification
Type object

ipv4-neighbor-list

Description: ipv4-neighbor-list is a JSON List . Please see below for l378_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 l378_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 l378_peer-group-neighbor-list

Type: List

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

bgp-list.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 l378_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 l378_neighbor-filter-lists

Type: List

neighbor-prefix-lists

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

Type: List

neighbor-route-map-lists

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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 l378_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 l378_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 l378_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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 l378_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 l378_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 l378_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.address-family

Specification
Type object

ipv6

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

Type: Object

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

bgp-list.address-family.ipv6

Specification
Type object

aggregate-address-list

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

Type: Object

distance

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

bgp-list.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

bgp-list.address-family.ipv6.redistribute

Specification
Type object

connected-cfg

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

Type: Object

floating-ip-cfg

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

Type: Object

ip-nat-cfg

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

Type: Object

ip-nat-list-cfg

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

Type: Object

isis-cfg

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

Type: Object

lw4o6-cfg

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

Type: Object

nat64-cfg

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

Type: Object

ospf-cfg

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

Type: Object

rip-cfg

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

Type: Object

static-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

vip

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

Type: Object

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.address-family.ipv6.redistribute.vip

Specification
Type object

only-flagged-cfg

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

Type: Object

only-not-flagged-cfg

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

Type: Object

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.address-family.ipv6.network

Specification
Type object

ipv6-network-list

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

Type: Object

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

bgp-list.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

bgp-list.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

bgp-list.address-family.ipv6.neighbor

Specification
Type object

ipv4-neighbor-list

Description: ipv4-neighbor-list is a JSON List . Please see below for l378_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 l378_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 l378_peer-group-neighbor-list

Type: List

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

bgp-list.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 l378_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 l378_neighbor-filter-lists

Type: List

neighbor-prefix-lists

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

Type: List

neighbor-route-map-lists

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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 l378_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 l378_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 l378_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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 l378_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 l378_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 l378_neighbor-prefix-lists

Type: List

neighbor-route-map-lists

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

bgp-list.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

bgp-list.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

bgp-list.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

bgp-list.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

ipv6

Specification
Type object

ospf-list

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

Type: List

Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}

rip

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

Type: Object

Reference Object: /axapi/v3/router/ipv6/rip

ipv6.ospf-list

Specification
Type list
Block object keys

abr-type-option

Description: ‘cisco’: Alternative ABR, Cisco implementation (RFC3509); ‘ibm’: Alternative ABR, IBM implementation (RFC3509); ‘standard’: Standard behavior (RFC2328);

Type: string

Supported Values: cisco, ibm, standard

Default: cisco

area-list

Description: area-list is a JSON List . Please see below for l378_area-list

Type: List

Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}

auto-cost-reference-bandwidth

Description: Use reference bandwidth method to assign OSPF cost (The reference bandwidth in terms of Mbits per second)

Type: number

Range: 1-4294967

Default: 10000

bfd-all-interfaces

Description: Enable BFD on all interfaces

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-metric

Description: Set metric of redistributed routes (Default metric)

Type: number

Range: 1-16777214

Default: 20

distribute-internal-list

Description: distribute-internal-list is a JSON List . Please see below for l378_distribute-internal-list

Type: List

ha-standby-extra-cost

Description: Extra ospf cost when there is any standby HA group (The extra cost value)

Type: number

Range: 1-65535

log-adjacency-changes

Description: ‘detail’: Log changes in adjacency state; ‘disable’: Disable logging;

Type: string

Supported Values: detail, disable

max-concurrent-dd

Description: Maximum number allowed to process DD concurrently (Number of DD process)

Type: number

Range: 1-65535

Default: 5

passive-interface

Description: passive-interface is a JSON Block . Please see below for l378_passive-interface

Type: Object

process-id

Description: OSPFv3 process tag

Type: string

Default: 0

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}/redistribute

router-id

Description: router-id for the OSPF process (OSPFv3 router-id in IPv4 address format)

Type: string

Format: ipv4-address

timers

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

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ipv6.ospf-list.distribute-internal-list

Specification
Type list
Block object keys

area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

Default: 255.255.255.255

area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

cost

Description: Cost

Type: number

Range: 1-65535

Default: 1

type

Description: ‘lw4o6’: LW4O6 Prefix; ‘nat64’: NAT64 Prefix; ‘floating-ip’: Floating IP; ‘ip-nat’: IP NAT; ‘ip-nat-list’: IP NAT list; ‘vip’: Virtual IP (VIP); ‘vip-only-flagged’: Selected Virtual IP (VIP);

Type: string

Supported Values: lw4o6, nat64, floating-ip, ip-nat, ip-nat-list, vip, vip-only-flagged

ipv6.ospf-list.redistribute

Specification
Type object

ip-nat

Description: IP-NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-nat-floating-list

Description: ip-nat-floating-list is a JSON List . Please see below for l378_ip-nat-floating-list

Type: List

metric-ip-nat

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type-ip-nat

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

ospf-list

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

Type: List

redist-list

Description: redist-list is a JSON List . Please see below for l378_redist-list

Type: List

route-map-ip-nat

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

Type: string

uuid

Description: uuid of the object

Type: string

vip-floating-list

Description: vip-floating-list is a JSON List . Please see below for l378_vip-floating-list

Type: List

vip-list

Description: vip-list is a JSON List . Please see below for l378_vip-list

Type: List

ipv6.ospf-list.redistribute.redist-list

Specification
Type list
Block object keys

metric

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

route-map

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

Type: string

type

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘nat64’: NAT64 Prefix; ‘lw4o6’: LW4O6 Prefix; ‘isis’: ISO IS-IS; ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, ip-nat-list, nat64, lw4o6, isis, rip, static

ipv6.ospf-list.redistribute.ospf-list

Specification
Type list
Block object keys

metric-ospf

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type-ospf

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

ospf

Description: Open Shortest Path First (OSPF)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

process-id

Description: OSPF process ID

Type: string

route-map-ospf

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

Type: string

ipv6.ospf-list.redistribute.ip-nat-floating-list

Specification
Type list
Block object keys

ip-nat-floating-IP-forward

Description: Floating-IP as forward address

Type: string

Format: ipv6-address

ip-nat-prefix

Description: Address

Type: string

Format: ipv6-address-plen

ipv6.ospf-list.redistribute.vip-list

Specification
Type list
Block object keys

metric-type-vip

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

metric-vip

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

route-map-vip

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

Type: string

type-vip

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

ipv6.ospf-list.redistribute.vip-floating-list

Specification
Type list
Block object keys

vip-address

Description: Address

Type: string

Format: ipv6-address

vip-floating-IP-forward

Description: Floating-IP as forward address

Type: string

Format: ipv6-address

ipv6.ospf-list.area-list

Specification
Type list
Block object keys

area-ipv4

Description: OSPFv3 area ID in IP address format

Type: string

Format: ipv4-address

area-num

Description: OSPFv3 area ID as a decimal value

Type: number

Range: 0-4294967295

default-cost

Description: Set the summary-default cost of a NSSA or stub area (Stub’s advertised default summary cost)

Type: number

Range: 0-16777215

Default: 1

no-summary

Description: Do not inject inter-area routes into area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

range-list

Description: range-list is a JSON List . Please see below for l378_range-list

Type: List

stub

Description: Configure OSPFv3 area as stub

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

virtual-link-list

Description: virtual-link-list is a JSON List . Please see below for l378_virtual-link-list

Type: List

ipv6.ospf-list.area-list.range-list

Specification
Type list
Block object keys

option

Description: ‘advertise’: Advertise this range (default); ‘not-advertise’: DoNotAdvertise this range;

Type: string

Supported Values: advertise, not-advertise

value

Description: Area range for IPv6 prefix

Type: string

Format: ipv6-address-plen

ipv6.ospf-list.passive-interface

Specification
Type object

eth-cfg

Description: eth-cfg is a JSON List . Please see below for l378_eth-cfg

Type: List

loopback-cfg

Description: loopback-cfg is a JSON List . Please see below for l378_loopback-cfg

Type: List

trunk-cfg

Description: trunk-cfg is a JSON List . Please see below for l378_trunk-cfg

Type: List

ve-cfg

Description: ve-cfg is a JSON List . Please see below for l378_ve-cfg

Type: List

ipv6.ospf-list.passive-interface.ve-cfg

Specification
Type list
Block object keys

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ipv6.ospf-list.passive-interface.trunk-cfg

Specification
Type list
Block object keys

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ipv6.ospf-list.passive-interface.loopback-cfg

Specification
Type list
Block object keys

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

ipv6.ospf-list.passive-interface.eth-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

ipv6.ospf-list.timers

Specification
Type object

spf

Description: spf is a JSON Block . Please see below for l378_spf

Type: Object

ipv6.ospf-list.timers.spf

Specification
Type object

exp

Description: exp is a JSON Block . Please see below for l378_exp

Type: Object

ipv6.ospf-list.timers.spf.exp

Specification
Type object

max-delay

Description: Maximum delay between receiving a change to SPF calculation in milliseconds

Type: number

Range: 0-2147483647

Default: 50000

min-delay

Description: Minimum delay between receiving a change to SPF calculation in milliseconds

Type: number

Range: 0-2147483647

Default: 500

ipv6.rip

Specification
Type object

aggregate-address-cfg

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

Type: List

cisco-metric-behavior

Description: ‘enable’: Enables updating metric consistent with Cisco; ‘disable’: Disables updating metric consistent with Cisco; (Enable/Disable updating metric consistent with Cisco)

Type: string

Supported Values: enable, disable

Default: disable

default-information

Description: ‘originate’: originate; (Distribute default route)

Type: string

Supported Values: originate

default-metric

Description: Set a metric of redistribute routes (Default metric)

Type: number

Range: 1-16

Default: 1

distribute-list

Description: distribute-list is a JSON Block . Please see below for l378_distribute-list

Type: Object

Reference Object: /axapi/v3/router/ipv6/rip/distribute-list

offset-list

Description: offset-list is a JSON Block . Please see below for l378_offset-list

Type: Object

Reference Object: /axapi/v3/router/ipv6/rip/offset-list

passive-interface-list

Description: passive-interface-list is a JSON List . Please see below for l378_passive-interface-list

Type: List

recv-buffer-size

Description: Set the RIPNG UDP receive buffer size (the RIPNG UDP receive buffer size value)

Type: number

Range: 8192-2147483647

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/ipv6/rip/redistribute

ripng-neighbor

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

Type: Object

route-cfg

Description: route-cfg is a JSON List . Please see below for l378_route-cfg

Type: List

route-map

Description: route-map is a JSON Block . Please see below for l378_route-map

Type: Object

Reference Object: /axapi/v3/router/ipv6/rip/route-map

timers

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

Type: Object

uuid

Description: uuid of the object

Type: string

ipv6.rip.offset-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l378_acl-cfg

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.rip.offset-list.acl-cfg

Specification
Type list
Block object keys

acl

Description: Access-list name

Type: string

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

metric

Description: Metric value

Type: number

Range: 0-16

offset-list-direction

Description: ‘in’: Filter incoming updates; ‘out’: Filter outgoing updates;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ipv6.rip.route-map

Specification
Type object

map-cfg

Description: map-cfg is a JSON List . Please see below for l378_map-cfg

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.rip.route-map.map-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

map

Description: Route map name

Type: string

route-map-direction

Description: ‘in’: Route map set for input filtering; ‘out’: Route map set for output filtering;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ipv6.rip.passive-interface-list

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ipv6.rip.redistribute

Specification
Type object

redist-list

Description: redist-list is a JSON List . Please see below for l378_redist-list

Type: List

uuid

Description: uuid of the object

Type: string

vip-list

Description: vip-list is a JSON List . Please see below for l378_vip-list

Type: List

ipv6.rip.redistribute.vip-list

Specification
Type list
Block object keys

vip-metric

Description: Metric for redistributed routes (metric value)

Type: number

Range: 0-16

vip-route-map

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

Type: string

vip-type

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

ipv6.rip.redistribute.redist-list

Specification
Type list
Block object keys

metric

Description: Metric for redistributed routes (metric value)

Type: number

Range: 0-16

route-map

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

Type: string

type

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘ip-nat’: IP NAT; ‘isis’: ISO IS-IS; ‘lw4o6’: LW4O6 Prefix; ‘nat64’: NAT64 Prefix; ‘ospf’: Open Shortest Path First (OSPF); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, nat64, ospf, static

ipv6.rip.route-cfg

Specification
Type list
Block object keys

route

Description: Static route advertisement (debugging purpose) (IP prefix)

Type: string

Format: ipv6-address-plen

ipv6.rip.timers

Specification
Type object

timers-cfg

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

Type: Object

ipv6.rip.timers.timers-cfg

Specification
Type object

basic

Description: Basic routing protocol update timers (Routing table update timer value in second. Default is 30)

Type: number

Range: 5-2147483647

val-2

Description: Routing information timeout timer. Default is 180

Type: number

Range: 5-2147483647

val-3

Description: Garbage collection timer. Default is 120

Type: number

Range: 5-2147483647

ipv6.rip.aggregate-address-cfg

Specification
Type list
Block object keys

aggregate-address

Description: Set aggregate RIP route announcement (Aggregate network)

Type: string

Format: ipv6-address-plen

ipv6.rip.ripng-neighbor

Specification
Type object

ripng-neighbor-cfg

Description: ripng-neighbor-cfg is a JSON List . Please see below for l378_ripng-neighbor-cfg

Type: List

ipv6.rip.ripng-neighbor.ripng-neighbor-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

neighbor-link-local-addr

Description: IPv6 link-local address

Type: string

Format: ipv6-address

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ipv6.rip.distribute-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l378_acl-cfg

Type: List

prefix

Description: prefix is a JSON Block . Please see below for l378_prefix

Type: Object

Reference Object: /axapi/v3/router/ipv6/rip/distribute-list/prefix

uuid

Description: uuid of the object

Type: string

ipv6.rip.distribute-list.acl-cfg

Specification
Type list
Block object keys

acl

Description: Access-list name

Type: string

acl-direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ipv6.rip.distribute-list.prefix

Specification
Type object

prefix-cfg

Description: prefix-cfg is a JSON List . Please see below for l378_prefix-cfg

Type: List

uuid

Description: uuid of the object

Type: string

ipv6.rip.distribute-list.prefix.prefix-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

prefix-list

Description: Filter prefixes in routing updates (Name of a prefix list)

Type: string

prefix-list-direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

isis-list

Specification
Type list
Block object keys

address-family

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

Type: Object

Reference Object: /axapi/v3/router/isis/{tag}/address-family

adjacency-check

Description: Check ISIS neighbor protocol support

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

area-password-cfg

Description: area-password-cfg is a JSON Block . Please see below for l378_area-password-cfg

Type: Object

authentication

Description: authentication is a JSON Block . Please see below for l378_authentication

Type: Object

bfd

Description: ‘all-interfaces’: Enable BFD on all interfaces;

Type: string

Supported Values: all-interfaces

default-information

Description: ‘originate’: Distribute a default route;

Type: string

Supported Values: originate

distance-list

Description: distance-list is a JSON List . Please see below for l378_distance-list

Type: List

domain-password-cfg

Description: domain-password-cfg is a JSON Block . Please see below for l378_domain-password-cfg

Type: Object

ha-standby-extra-cost

Description: Extra IS-IS metric when there is any standby ha group (The extra cost value)

Type: number

Range: 1-65535

ignore-lsp-errors

Description: Ignore LSPs with bad checksums

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

is-type

Description: ‘level-1’: Act as a station router only; ‘level-1-2’: Act as both a station router and an area router; ‘level-2-only’: Act as an area router only;

Type: string

Supported Values: level-1, level-1-2, level-2-only

Default: level-1

log-adjacency-changes-cfg

Description: log-adjacency-changes-cfg is a JSON Block . Please see below for l378_log-adjacency-changes-cfg

Type: Object

lsp-gen-interval-list

Description: lsp-gen-interval-list is a JSON List . Please see below for l378_lsp-gen-interval-list

Type: List

lsp-refresh-interval

Description: Set LSP refresh interval (LSP refresh time in seconds)

Type: number

Range: 1-65535

Default: 900

max-lsp-lifetime

Description: Set maximum LSP lifetime (Maximum LSP lifetime in seconds)

Type: number

Range: 350-65535

Default: 1200

metric-style-list

Description: metric-style-list is a JSON List . Please see below for l378_metric-style-list

Type: List

net-list

Description: net-list is a JSON List . Please see below for l378_net-list

Type: List

passive-interface-list

Description: passive-interface-list is a JSON List . Please see below for l378_passive-interface-list

Type: List

protocol-list

Description: protocol-list is a JSON List . Please see below for l378_protocol-list

Type: List

redistribute

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

Type: Object

Reference Object: /axapi/v3/router/isis/{tag}/redistribute

set-overload-bit-cfg

Description: set-overload-bit-cfg is a JSON Block . Please see below for l378_set-overload-bit-cfg

Type: Object

spf-interval-exp-list

Description: spf-interval-exp-list is a JSON List . Please see below for l378_spf-interval-exp-list

Type: List

summary-address-list

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

Type: List

tag

Description: ISO routing area tag

Type: string

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

isis-list.domain-password-cfg

Specification
Type object

authenticate

Description: authenticate is a JSON Block . Please see below for l378_authenticate

Type: Object

password

Description: Set the authentication password for a routing domain (Routing domain password)

Type: string

Format: string-rlx

isis-list.domain-password-cfg.authenticate

Specification
Type object

snp

Description: ‘send-only’: Send but do not check PDUs on receiving; ‘validate’: Send and check PDUs on receiving;

Type: string

Supported Values: send-only, validate

isis-list.set-overload-bit-cfg

Specification
Type object

on-startup

Description: on-startup is a JSON Block . Please see below for l378_on-startup

Type: Object

set-overload-bit

Description: Signal other touers not to use us in SPF

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

suppress-list

Description: suppress-list is a JSON List . Please see below for l378_suppress-list

Type: List

isis-list.set-overload-bit-cfg.suppress-list

Specification
Type list
Block object keys

suppress

Description: ‘external’: If overload-bit set, don’t advertise IP prefixes learned from other protocols; ‘interlevel’: If overload-bit set, don’t advertise IP prefixes learned from another ISIS level;

Type: string

Supported Values: external, interlevel

isis-list.set-overload-bit-cfg.on-startup

Specification
Type object

delay

Description: Time in seconds to advertise ourself as overloaded after reboot

Type: number

Range: 5-86400

Mutual Exclusion: delay and wait-for-bgp are mutually exclusive

wait-for-bgp

Description: Let BGP decide when to unset the overload bit

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: wait-for-bgp and delay are mutually exclusive

isis-list.net-list

Specification
Type list
Block object keys

net

Description: A Network Entity Title for this process (XX.XXXX. ... .XXXX.XX Network entity title (NET))

Type: string

Format: nasp-string

isis-list.metric-style-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Level-1 only; ‘level-1-2’: Level-1-2; ‘level-2’: Level-2 only;

Type: string

Supported Values: level-1, level-1-2, level-2

Default: level-1-2

type

Description: ‘narrow’: Use old style of TLVs with narrow metric; ‘wide’: Use new style of TLVs to carry wider metric; ‘transition’: Send and accept both styles of TLVs during transition; ‘narrow-transition’: Send old style of TLVs with narrow metric with accepting both styles of TLVs; ‘wide-transition’: Send new style of TLVs to carry wider metric with accepting both styles of TLVs;

Type: string

Supported Values: narrow, wide, transition, narrow-transition, wide-transition

Default: narrow

isis-list.authentication

Specification
Type object

key-chain-list

Description: key-chain-list is a JSON List . Please see below for l378_key-chain-list

Type: List

mode-list

Description: mode-list is a JSON List . Please see below for l378_mode-list

Type: List

send-only-list

Description: send-only-list is a JSON List . Please see below for l378_send-only-list

Type: List

isis-list.authentication.key-chain-list

Specification
Type list
Block object keys

key-chain

Description: Authentication key-chain (Name of key-chain)

Type: string

level

Description: ‘level-1’: Specify authentication key-chain for level-1 PDUs; ‘level-2’: Specify authentication key-chain for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

isis-list.authentication.mode-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify authentication mode for level-1 PDUs; ‘level-2’: Specify authentication mode for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

mode

Description: ‘md5’: Authentication mode;

Type: string

Supported Values: md5

isis-list.authentication.send-only-list

Specification
Type list
Block object keys

level

Description: ‘level-1’: Specify authentication send-only for level-1 PDUs; ‘level-2’: Specify authentication send-only for level-2 PDUs;

Type: string

Supported Values: level-1, level-2

send-only

Description: Authentication send-only

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

isis-list.protocol-list

Specification
Type list
Block object keys

protocol-topology

Description: Protocol Topology

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

isis-list.log-adjacency-changes-cfg