ipv6

List the global IPv6 configuration parameters.

ipv6 Specification

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

Operations Allowed:

Operation Method URI Payload

Get Object

GET

/axapi/v3/ipv6

ipv6_attributes

ipv6 Attributes

access-list-list

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

Type: List

Reference Object: /axapi/v3/ipv6/access-list/{name}

address

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

Type: Object

Reference Object: /axapi/v3/ipv6/address

default-gateway

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

Type: Object

Reference Object: /axapi/v3/ipv6/default-gateway

frag

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

Type: Object

Reference Object: /axapi/v3/ipv6/frag

icmpv6

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

Type: Object

Reference Object: /axapi/v3/ipv6/icmpv6

nat

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

Type: Object

Reference Object: /axapi/v3/ipv6/nat

neighbor

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

Type: Object

Reference Object: /axapi/v3/ipv6/neighbor

ospf

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

Type: Object

Reference Object: /axapi/v3/ipv6/ospf

prefix-list-list

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

Type: List

Reference Object: /axapi/v3/ipv6/prefix-list/{name}

route

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

Type: Object

Reference Object: /axapi/v3/ipv6/route

frag

Specification
Type object

frag-timeout

Description: in milliseconds 4 - 16000 (default is 1000)

Type: number

Range: 4-16000

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l401_sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

frag.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘session-inserted’: Session Inserted; ‘session-expired’: Session Expired; ‘icmp-rcv’: ICMP Received; ‘icmpv6-rcv’: ICMPv6 Received; ‘udp-rcv’: UDP Received; ‘tcp-rcv’: TCP Received; ‘ipip-rcv’: IP-in-IP Received; ‘ipv6ip-rcv’: IPv6-in-IP Received; ‘other-rcv’: Other Received; ‘icmp-dropped’: ICMP Dropped; ‘icmpv6-dropped’: ICMPv6 Dropped; ‘udp-dropped’: UDP Dropped; ‘tcp-dropped’: TCP Dropped; ‘ipip-dropped’: IP-in-IP Dropped; ‘ipv6ip-dropped’: IPv6-in-IP Dropped; ‘other-dropped’: Other Dropped; ‘overlap-error’: Overlapping Fragment Dropped; ‘bad-ip-len’: Bad IP Length; ‘too-small’: Fragment Too Small Drop; ‘first-tcp-too-small’: First TCP Fragment Too Small Drop; ‘first-l4-too-small’: First L4 Fragment Too Small Drop; ‘total-sessions-exceeded’: Total Sessions Exceeded Drop; ‘no-session-memory’: Out of Session Memory; ‘fast-aging-set’: Fragmentation Fast Aging Set; ‘fast-aging-unset’: Fragmentation Fast Aging Unset; ‘fragment-queue-success’: Fragment Queue Success; ‘unaligned-len’: Payload Length Unaligned; ‘exceeded-len’: Payload Length Out of Bounds; ‘duplicate-first-frag’: Duplicate First Fragment; ‘duplicate-last-frag’: Duplicate Last Fragment; ‘total-fragments-exceeded’: Total Queued Fragments Exceeded; ‘fragment-queue-failure’: Fragment Queue Failure; ‘reassembly-success’: Fragment Reassembly Success; ‘max-len-exceeded’: Fragment Max Data Length Exceeded; ‘reassembly-failure’: Fragment Reassembly Failure; ‘policy-drop’: MTU Exceeded Policy Drop; ‘error-drop’: Fragment Processing Drop; ‘max-packets-exceeded’: Too Many Packets Per Reassembly Drop; ‘session-packets-exceeded’: Session Max Packets Exceeded; ‘frag-session-count’: Fragmentation Session Count; ‘high-cpu-threshold’: High CPU Threshold Reached; ‘low-cpu-threshold’: Low CPU Threshold Reached; ‘cpu-threshold-drop’: High CPU Drop; ‘ipd-entry-drop’: DDoS Protection Drop; ‘sctp-rcv’: SCTP Received; ‘sctp-dropped’: SCTP Dropped;

Type: string

Supported Values: all, session-inserted, session-expired, icmp-rcv, icmpv6-rcv, udp-rcv, tcp-rcv, ipip-rcv, ipv6ip-rcv, other-rcv, icmp-dropped, icmpv6-dropped, udp-dropped, tcp-dropped, ipip-dropped, ipv6ip-dropped, other-dropped, overlap-error, bad-ip-len, too-small, first-tcp-too-small, first-l4-too-small, total-sessions-exceeded, no-session-memory, fast-aging-set, fast-aging-unset, fragment-queue-success, unaligned-len, exceeded-len, duplicate-first-frag, duplicate-last-frag, total-fragments-exceeded, fragment-queue-failure, reassembly-success, max-len-exceeded, reassembly-failure, policy-drop, error-drop, max-packets-exceeded, session-packets-exceeded, frag-session-count, high-cpu-threshold, low-cpu-threshold, cpu-threshold-drop, ipd-entry-drop, sctp-rcv, sctp-dropped

nat

Specification
Type object

icmpv6

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

Type: Object

Reference Object: /axapi/v3/ipv6/nat/icmpv6

inside

Description: inside is a JSON Block . Please see below for l401_inside

Type: Object

Reference Object: /axapi/v3/ipv6/nat/inside

pool-group-list

Description: pool-group-list is a JSON List . Please see below for l401_pool-group-list

Type: List

Reference Object: /axapi/v3/ipv6/nat/pool-group/{pool-group-name}

pool-list

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

Type: List

Reference Object: /axapi/v3/ipv6/nat/pool/{pool-name}

nat.icmpv6

Specification
Type object

respond-to-ping

Description: Respond to ICMPv6 echo requests to NAT pool IPs (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

nat.pool-group-list

Specification
Type list
Block object keys

member-list

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

Type: List

Reference Object: /axapi/v3/ipv6/nat/pool-group/{pool-group-name}/member/{pool-name}

pool-group-name

Description: Specify pool group name

Type: string

Format: string-rlx

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

vrid

Description: Specify VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

nat.pool-group-list.member-list

Specification
Type list
Block object keys

pool-name

Description: Specify NAT pool name

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

nat.inside

Specification
Type object

source

Description: source is a JSON Block . Please see below for l401_source

Type: Object

Reference Object: /axapi/v3/ipv6/nat/inside/source

nat.inside.source

Specification
Type object

list-list

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

Type: List

Reference Object: /axapi/v3/ipv6/nat/inside/source/list/{list-name}

nat.inside.source.list-list

Specification
Type list
Block object keys

list-name

Description: IPv6 access-list name

Type: string

Reference Object: /axapi/v3/ipv6/access-list

pool

Description: IPv6 NAT Pool (Pool Name)

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

nat.pool-list

Specification
Type list
Block object keys

end-address

Description: Configure end IP address of NAT pool

Type: string

Format: ipv6-address

gateway

Description: Configure gateway IP

Type: string

Format: ipv6-address

ip-rr

Description: Use IP address round-robin behavior

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

netmask

Description: Configure mask for pool

Type: number

Range: 64-128

pool-name

Description: Specify pool name

Type: string

Format: string-rlx

sampling-enable

Description: sampling-enable is a JSON List . Please see below for l401_sampling-enable

Type: List

scaleout-device-id

Description: Configure Scaleout device id to which this NAT pool is to be bound (Specify Scaleout device id)

Type: number

Range: 1-64

start-address

Description: Configure start IP address of NAT pool

Type: string

Format: ipv6-address

uuid

Description: uuid of the object

Type: string

vrid

Description: Specify VRRP-A vrid (Specify ha VRRP-A vrid)

Type: number

Range: 1-31

nat.pool-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘Port-Usage’: Port-Usage; ‘Total-Used’: Total-Used; ‘Total-Freed’: Total-Freed; ‘Failed’: Failed;

Type: string

Supported Values: all, Port-Usage, Total-Used, Total-Freed, Failed

route

Specification
Type object

rib-list

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

Type: List

Reference Object: /axapi/v3/ipv6/route/rib/{ipv6-address}

static

Description: static is a JSON Block . Please see below for l401_static

Type: Object

Reference Object: /axapi/v3/ipv6/route/static

route.rib-list

Specification
Type list
Block object keys

ipv6-address

Description: IPV6 address

Type: string

Format: ipv6-address-plen

ipv6-nexthop-ipv6

Description: ipv6-nexthop-ipv6 is a JSON List . Please see below for l401_ipv6-nexthop-ipv6

Type: List

uuid

Description: uuid of the object

Type: string

route.rib-list.ipv6-nexthop-ipv6

Specification
Type list
Block object keys

description

Description: Description for static route

Type: string

Format: string-rlx

distance

Description: Distance value for this route

Type: number

Range: 1-255

Default: 1

ethernet

Description: Ethernet interface (Ethernet interface number)

Type: number

Format: interface

ipv6-nexthop

Description: Forwarding router’s 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

route.static

Specification
Type object

bfd

Description: bfd is a JSON Block . Please see below for l401_bfd

Type: Object

Reference Object: /axapi/v3/ipv6/route/static/bfd

route.static.bfd

Specification
Type object

bfd-ipv6-list

Description: bfd-ipv6-list is a JSON List . Please see below for l401_bfd-ipv6-list

Type: List

Reference Object: /axapi/v3/ipv6/route/static/bfd/bfd-ipv6/{local-ipv6}+{nexthop-ipv6}

ethernet-list

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

Type: List

Reference Object: /axapi/v3/ipv6/route/static/bfd/ethernet/{eth-num}+{nexthop-ipv6-ll}

trunk-list

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

Type: List

Reference Object: /axapi/v3/ipv6/route/static/bfd/trunk/{trunk-num}+{nexthop-ipv6-ll}

ve-list

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

Type: List

Reference Object: /axapi/v3/ipv6/route/static/bfd/ve/{ve-num}+{nexthop-ipv6-ll}

route.static.bfd.bfd-ipv6-list

Specification
Type list
Block object keys

local-ipv6

Description: Local IPv6 address

Type: string

Format: ipv6-address

nexthop-ipv6

Description: Nexthop IPv6 address

Type: string

Format: ipv6-address

uuid

Description: uuid of the object

Type: string

route.static.bfd.ethernet-list

Specification
Type list
Block object keys

eth-num

Description: Ethernet (not a member of vlan or trunk)

Type: number

Range: 0-2147483647

nexthop-ipv6-ll

Description: Nexthop IPv6 address (Link-local)

Type: string

Format: ipv6-address

uuid

Description: uuid of the object

Type: string

route.static.bfd.trunk-list

Specification
Type list
Block object keys

nexthop-ipv6-ll

Description: Nexthop IPv6 address (Link-local)

Type: string

Format: ipv6-address

trunk-num

Description: Trunk interface

Type: number

Range: 1-16

uuid

Description: uuid of the object

Type: string

route.static.bfd.ve-list

Specification
Type list
Block object keys

nexthop-ipv6-ll

Description: Nexthop IPv6 address (Link-local)

Type: string

Format: ipv6-address

uuid

Description: uuid of the object

Type: string

ve-num

Description: Virtual ethernet interface

Type: number

Range: 2-4094

access-list-list

Specification
Type list
Block object keys

name

Description: Named Access List

Type: string

rules

Description: rules is a JSON List . Please see below for l401_rules

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

access-list-list.rules

Specification
Type list
Block object keys

acl-log

Description: Log matches against this entry

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

action

Description: ‘deny’: Deny; ‘permit’: Permit; ‘l3-vlan-fwd-disable’: Disable L3 forwarding between VLANs;

Type: string

Supported Values: deny, permit, l3-vlan-fwd-disable

any-code

Description: Any ICMP code

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: any-code icmp-code and special-code are mutually exclusive

any-type

Description: Any ICMP type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: any-type icmp-type and special-type are mutually exclusive

dscp

Description: DSCP

Type: number

Range: 1-63

dst-any

Description: Any destination host

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: dst-any dst-host, dst-subnet and dst-object-group are mutually exclusive

dst-eq

Description: Match only packets on a given destination port (port number)

Type: number

Range: 1-65535

Mutual Exclusion: dst-eq dst-gt, dst-lt and dst-range are mutually exclusive

dst-gt

Description: Match only packets with a greater port number

Type: number

Range: 1-65534

Mutual Exclusion: dst-gt dst-eq, dst-lt and dst-range are mutually exclusive

dst-host

Description: A single destination host (Host address)

Type: string

Format: ipv6-address

Mutual Exclusion: dst-host dst-any, dst-subnet and dst-object-group are mutually exclusive

dst-lt

Description: Match only packets with a lesser port number

Type: number

Range: 2-65535

Mutual Exclusion: dst-lt dst-eq, dst-gt and dst-range are mutually exclusive

dst-object-group

Description: Destination network object group name (Source network object group name)

Type: string

Mutual Exclusion: dst-object-group dst-any, dst-host and dst-subnet are mutually exclusive

dst-port-end

Description: Edning Destination Port Number

Type: number

Range: 1-65535

dst-range

Description: Match only packets in the range of port numbers (Starting Destination Port Number)

Type: number

Range: 1-65535

Mutual Exclusion: dst-range dst-eq, dst-gt and dst-lt are mutually exclusive

dst-subnet

Description: Destination Address

Type: string

Format: ipv6-address-plen

Mutual Exclusion: dst-subnet dst-any, dst-host and dst-object-group are mutually exclusive

established

Description: TCP established

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fragments

Description: IP fragments

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

geo-location

Description: Specify geo-location name

Type: string

Mutual Exclusion: geo-location icmp, tcp, udp, ipv6 and service-obj-group are mutually exclusive

icmp

Description: Internet Control Message Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: icmp tcp, udp, ipv6, service-obj-group and geo-location are mutually exclusive

icmp-code

Description: ICMP code number

Type: number

Range: 0-254

Mutual Exclusion: icmp-code any-code and special-code are mutually exclusive

icmp-type

Description: ICMP type number

Type: number

Range: 0-254

Mutual Exclusion: icmp-type any-type and special-type are mutually exclusive

ipv6

Description: Any Internet Protocol

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: ipv6 icmp, tcp, udp, service-obj-group and geo-location are mutually exclusive

remark

Description: Access list entry comment (Notes for this ACL)

Type: string

Format: string-rlx

seq-num

Description: Sequence Number

Type: number

Range: 1-8192

service-obj-group

Description: Service object group (Source object group name)

Type: string

Mutual Exclusion: service-obj-group icmp, tcp, udp, ipv6 and geo-location are mutually exclusive

special-code

Description: ‘addr-unreachable’: Code 3, address unreachable; ‘admin-prohibited’: Code 1, admin prohibited; ‘no-route’: Code 0, no route to destination; ‘not-neighbour’: Code 2, not neighbor; ‘port-unreachable’: Code 4, destination port unreachable;

Type: string

Supported Values: addr-unreachable, admin-prohibited, no-route, not-neighbour, port-unreachable

Mutual Exclusion: special-code any-code and icmp-code are mutually exclusive

special-type

Description: ‘echo-reply’: Type 129, echo reply; ‘echo-request’: help Type 128, echo request; ‘packet-too-big’: Type 2, packet too big; ‘param-prob’: Type 4, parameter problem; ‘time-exceeded’: Type 3, time exceeded; ‘dest-unreachable’: Type 1, destination unreachable;

Type: string

Supported Values: echo-reply, echo-request, packet-too-big, param-prob, time-exceeded, dest-unreachable

Mutual Exclusion: special-type icmp-type and any-type are mutually exclusive

src-any

Description: Any source host

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: src-any src-host, src-subnet and src-object-group are mutually exclusive

src-eq

Description: Match only packets on a given source port (port number)

Type: number

Range: 1-65535

Mutual Exclusion: src-eq src-gt, src-lt and src-range are mutually exclusive

src-gt

Description: Match only packets with a greater port number

Type: number

Range: 1-65534

Mutual Exclusion: src-gt src-eq, src-lt and src-range are mutually exclusive

src-host

Description: A single source host (Host address)

Type: string

Format: ipv6-address

Mutual Exclusion: src-host src-any, src-subnet and src-object-group are mutually exclusive

src-lt

Description: Match only packets with a lower port number

Type: number

Range: 2-65535

Mutual Exclusion: src-lt src-eq, src-gt and src-range are mutually exclusive

src-object-group

Description: Network object group (Source network object group name)

Type: string

Mutual Exclusion: src-object-group src-any, src-host and src-subnet are mutually exclusive

src-port-end

Description: Ending Port Number

Type: number

Range: 1-65535

src-range

Description: match only packets in the range of port numbers (Starting Port Number)

Type: number

Range: 1-65535

Mutual Exclusion: src-range src-eq, src-gt and src-lt are mutually exclusive

src-subnet

Description: Source Address

Type: string

Format: ipv6-address-plen

Mutual Exclusion: src-subnet src-any, src-host and src-object-group are mutually exclusive

tcp

Description: protocol TCP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: tcp icmp, udp, ipv6, service-obj-group and geo-location are mutually exclusive

udp

Description: protocol UDP

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: udp icmp, tcp, ipv6, service-obj-group and geo-location are mutually exclusive

vlan

Description: VLAN ID

Type: number

Range: 1-4094

icmpv6

Specification
Type object

redirect

Description: Disable outbound ICMPv6 redirect messages

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

unreachable

Description: Disable outbound ICMPv6 unreachable messages

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

default-gateway

Specification
Type object

ipv6-default-gateway

Description: Default gateway address

Type: string

Format: ipv6-address

Reference Object: /axapi/v3/ipv6/address

uuid

Description: uuid of the object

Type: string

neighbor

Specification
Type object

static-list

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

Type: List

Reference Object: /axapi/v3/ipv6/neighbor/static/{ipv6-addr}+{mac}+{vlan}

neighbor.static-list

Specification
Type list
Block object keys

ethernet

Description: Ethernet port (Port Value)

Type: number

Format: interface

Mutual Exclusion: ethernet and trunk are mutually exclusive

ipv6-addr

Description: IPV6 address

Type: string

Format: ipv6-address

mac

Description: MAC Address

Type: string

Format: mac-address

trunk

Description: Trunk group

Type: number

Range: 1-16

Mutual Exclusion: trunk and ethernet are mutually exclusive

uuid

Description: uuid of the object

Type: string

vlan

Description: VLAN ID

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

address

Specification
Type object

anycast

Description: Configure an IPv6 anycast address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: anycast and link-local are mutually exclusive

ipv6-address

Description: IPV6 address

Type: string

Format: ipv6-address-plen

link-local

Description: Configure an IPv6 link local address

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: link-local and anycast are mutually exclusive

uuid

Description: uuid of the object

Type: string

prefix-list-list

Specification
Type list
Block object keys

name

Description: Name of a prefix list

Type: string

rules

Description: rules is a JSON List . Please see below for l401_rules

Type: List

uuid

Description: uuid of the object

Type: string

prefix-list-list.rules

Specification
Type list
Block object keys

action

Description: ‘deny’: Specify packets to reject; ‘permit’: Specify packets to forward;

Type: string

Supported Values: deny, permit

any

Description: Any prefix match. Same as ”::0/0 le le 128”

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

description

Description: Prefix-list specific description (Up to 80 characters describing this prefix-list)

Type: string

ge

Description: Minimum prefix length to be matched

Type: number

Range: 0-128

ipaddr

Description: IPv6 prefix, e.g., 3ffe::/16

Type: string

Format: ipv6-address-plen

le

Description: Maximum prefix length to be matched

Type: number

Range: 0-128

seq

Description: Sequence number of an entry

Type: number

Range: 1-4294967295

ospf

Specification
Type object

display-route-single-line

Description: Print an entry in single line

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string