router ipv6

IPv6 information

ipv6 Specification

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

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/router/ipv6

ipv6_attributes

ipv6 Attributes

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

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

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

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 l361_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 l361_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 l361_vip-floating-list

Type: List

vip-list

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

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

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

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

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

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

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 l361_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 l361_virtual-link-list

Type: List

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

ospf-list.passive-interface

Specification
Type object

eth-cfg

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

Type: List

loopback-cfg

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

Type: List

trunk-cfg

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

Type: List

ve-cfg

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

Type: List

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

ospf-list.passive-interface.trunk-cfg

Specification
Type list
Block object keys

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

ospf-list.passive-interface.loopback-cfg

Specification
Type list
Block object keys

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

ospf-list.passive-interface.eth-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

ospf-list.timers

Specification
Type object

spf

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

Type: Object

ospf-list.timers.spf

Specification
Type object

exp

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

rip

Specification
Type object

aggregate-address-cfg

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

Type: Object

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

ripng-neighbor

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

Type: Object

route-cfg

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

Type: List

route-map

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

Type: Object

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

timers

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

Type: Object

uuid

Description: uuid of the object

Type: string

rip.offset-list

Specification
Type object

acl-cfg

Description: acl-cfg is a JSON List . Please see below for l361_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.route-map

Specification
Type object

map-cfg

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

Type: List

uuid

Description: uuid of the object

Type: string

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

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 l361_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 l361_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; ‘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

rip.route-cfg

Specification
Type list
Block object keys

route

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

Type: string

Format: ipv6-address-plen

rip.timers

Specification
Type object

timers-cfg

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

rip.ripng-neighbor

Specification
Type object

ripng-neighbor-cfg

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

Type: List

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

rip.distribute-list

Specification
Type object

acl-cfg

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

Type: List

prefix

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

Type: Object

Reference Object: /axapi/v3/router/ipv6/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 l361_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