ipv6¶
Global IP configuration subcommands
ipv6 Specification¶
Parameter Value Type Intermediate Resource Element Name ipv6 Element URI /axapi/v3/ipv6 Element Attributes ipv6_attributes Partition Visibility shared Schema ipv6 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/ipv6 | ipv6_attributes |
ipv6 attributes¶
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
fib
Description: fib is a JSON Block. Please see below for fib
Type: Object
Reference Object: /axapi/v3/ipv6/fib
fib-summary
Description: fib-summary is a JSON Block. Please see below for fib-summary
Type: Object
Reference Object: /axapi/v3/ipv6/fib-summary
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
Type: List
Reference Object: /axapi/v3/ipv6/prefix-list/{name}
reroute
Description: reroute is a JSON Block. Please see below for reroute
Type: Object
Reference Object: /axapi/v3/ipv6/reroute
rib
Description: rib is a JSON Block. Please see below for rib
Type: Object
Reference Object: /axapi/v3/ipv6/rib
route
Description: route is a JSON Block. Please see below for route
Type: Object
Reference Object: /axapi/v3/ipv6/route
telemetry
Description: telemetry is a JSON Block. Please see below for telemetry
Type: Object
Reference Object: /axapi/v3/ipv6/telemetry
frag¶
Specification Value Type object frag-timeout
Description in milliseconds 4 - 16000 (default is 1000)
Type: number
Range: 4-16000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat¶
Specification Value Type object icmpv6
Description: icmpv6 is a JSON Block. Please see below for nat_icmpv6
Type: Object
Reference Object: /axapi/v3/ipv6/nat/icmpv6
inside
Description: inside is a JSON Block. Please see below for nat_inside
Type: Object
Reference Object: /axapi/v3/ipv6/nat/inside
pool-group-list
Type: List
Reference Object: /axapi/v3/ipv6/nat/pool-group/{pool-group-name}
pool-list
Type: List
Reference Object: /axapi/v3/ipv6/nat/pool/{pool-name}
nat_icmpv6¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_pool-group-list¶
Specification Value Type list Block object keys 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
Maximum Length: 63 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid
Description Specify VRRP-A vrid (Specify ha VRRP-A vrid)
Type: number
Range: 1-31
nat_pool-group-list_member-list¶
Specification Value Type list Block object keys pool-name
Description Specify NAT pool name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_inside¶
Specification Value Type object source
Description: source is a JSON Block. Please see below for nat_inside_source
Type: Object
Reference Object: /axapi/v3/ipv6/nat/inside/source
nat_inside_source¶
Specification Value Type object list-list
Type: List
Reference Object: /axapi/v3/ipv6/nat/inside/source/list/{list-name}
nat_inside_source_list-list¶
Specification Value Type list Block object keys list-name
Description IPv6 access-list name
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/ipv6/access-list
pool
Description IPv6 NAT Pool (Pool Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
nat_pool-list¶
Specification Value 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
Maximum Length: 63 characters
Maximum Length: 1 characters
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-8
start-address
Description Configure start IP address of NAT pool
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid
Description Specify VRRP-A vrid (Specify ha VRRP-A vrid)
Type: number
Range: 1-31
fib-summary¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
telemetry¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
route¶
Specification Value Type object rib-list
Type: List
Reference Object: /axapi/v3/ipv6/route/rib/{ipv6-address}
source
Description: source is a JSON Block. Please see below for route_source
Type: Object
Reference Object: /axapi/v3/ipv6/route/source
static
Description: static is a JSON Block. Please see below for route_static
Type: Object
Reference Object: /axapi/v3/ipv6/route/static
route_rib-list¶
Specification Value Type list Block object keys ipv6-address
Description IPV6 address
Type: string
Format: ipv6-address-plen
ipv6-nexthop-ipv6
Type: Listipv6-nexthop-tunnel
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
route_rib-list_ipv6-nexthop-tunnel¶
Specification Value Type list Block object keys description
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
distance-nexthop-tunnel
Description Distance value for this route
Type: number
Range: 1-255
Default: 1
ipv6-nexthop-tunnel-addr
Description Forwarding router’s address
Type: string
Format: ipv6-address
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Range: 1-128
route_rib-list_ipv6-nexthop-ipv6¶
Specification Value Type list Block object keys description
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
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
Range: 6-103
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_source¶
Specification Value Type object ve-list
Type: List
Reference Object: /axapi/v3/ipv6/route/source/ve/{ve-num}+{nexthop-ip}
route_source_ve-list¶
Specification Value Type list Block object keys nexthop-ip
Description Nexthop IPv6 address
Type: string
Format: ipv6-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-num
Description
Type: number
Range: 1-4094
route_static¶
Specification Value Type object bfd
Description: bfd is a JSON Block. Please see below for route_static_bfd
Type: Object
Reference Object: /axapi/v3/ipv6/route/static/bfd
route_static_bfd¶
Specification Value Type object bfd-ipv6-list
Type: List
Reference Object: /axapi/v3/ipv6/route/static/bfd/bfd-ipv6/{local-ipv6}+{nexthop-ipv6}
ethernet-list
Type: List
Reference Object: /axapi/v3/ipv6/route/static/bfd/ethernet/{eth-num}+{nexthop-ipv6-ll}
trunk-list
Type: List
Reference Object: /axapi/v3/ipv6/route/static/bfd/trunk/{trunk-num}+{nexthop-ipv6-ll}
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 Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
route_static_bfd_ethernet-list¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
route_static_bfd_trunk-list¶
Specification Value 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-4096
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
route_static_bfd_ve-list¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-num
Description Virtual ethernet interface
Type: number
Range: 2-4094
ospf¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
access-list-list¶
Specification Value Type list Block object keys name
Description Named Access List
Type: string
Maximum Length: 16 characters
Maximum Length: 1 characters
rules
Type: Listuser-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
access-list-list_rules¶
Specification Value 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-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
ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
Range: 0-1
fragments
Description IP fragments
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
Maximum Length: 63 characters
Maximum Length: 1 characters
seq-num
Description Sequence Number
Type: number
Range: 1-8192
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-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
trunk
Description Ethernet trunk (trunk number)
Type: number
Format: interface
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
fib¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
icmpv6¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
default-gateway¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
neighbor¶
Specification Value Type object dynamic
Description: dynamic is a JSON Block. Please see below for neighbor_dynamic
Type: Object
Reference Object: /axapi/v3/ipv6/neighbor/dynamic
static-list
Type: List
Reference Object: /axapi/v3/ipv6/neighbor/static/{ipv6-addr}+{vlan}
neighbor_dynamic¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
neighbor_static-list¶
Specification Value Type list Block object keys ethernet
Description Ethernet port (Port Value)
Type: number
Format: interface
Range: 6-103
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-4096
Mutual Exclusion: trunk and ethernet are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan
address¶
Specification Value 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
Maximum Length: 64 characters
Maximum Length: 1 characters
reroute¶
Specification Value Type object suppress-protocols
Description: suppress-protocols is a JSON Block. Please see below for reroute_suppress-protocols
Type: Object
Reference Object: /axapi/v3/ipv6/reroute/suppress-protocols
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
reroute_suppress-protocols¶
Specification Value Type object connected
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ebgp
Description EBGP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ibgp
Description IBGP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
isis
Description ISIS
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ospf
Description OSPF
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
rip
Description RIP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
static
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
prefix-list-list¶
Specification Value Type list Block object keys name
Description Name of a prefix list
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
rules
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
prefix-list-list_rules¶
Specification Value 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
Maximum Length: 80 characters
Maximum Length: 1 characters
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
rib¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters