.. _ipv6: 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** :download:`ipv6 schema ` ===================================== ============================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/ipv6 .. raw:: html ipv6_attributes .. raw:: html
.. _2207_ipv6_attributes: ipv6 attributes --------------- **access-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/access-list/{name} ` **address** **Description:** address is a **JSON Block**. Please see below for :ref:`2207_address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/address ` **default-gateway** **Description:** default-gateway is a **JSON Block**. Please see below for :ref:`2207_default-gateway` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/default-gateway ` **fib** **Description:** fib is a **JSON Block**. Please see below for :ref:`2207_fib` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/fib ` **fib-summary** **Description:** fib-summary is a **JSON Block**. Please see below for :ref:`2207_fib-summary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/fib-summary ` **frag** **Description:** frag is a **JSON Block**. Please see below for :ref:`2207_frag` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/frag ` **icmpv6** **Description:** icmpv6 is a **JSON Block**. Please see below for :ref:`2207_icmpv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/icmpv6 ` **nat** **Description:** nat is a **JSON Block**. Please see below for :ref:`2207_nat` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/nat ` **neighbor** **Description:** neighbor is a **JSON Block**. Please see below for :ref:`2207_neighbor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/neighbor ` **ospf** **Description:** ospf is a **JSON Block**. Please see below for :ref:`2207_ospf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/ospf ` **prefix-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/prefix-list/{name} ` **reroute** **Description:** reroute is a **JSON Block**. Please see below for :ref:`2207_reroute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/reroute ` **rib** **Description:** rib is a **JSON Block**. Please see below for :ref:`2207_rib` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/rib ` **route** **Description:** route is a **JSON Block**. Please see below for :ref:`2207_route` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/route ` **telemetry** **Description:** telemetry is a **JSON Block**. Please see below for :ref:`2207_telemetry` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/telemetry ` **unnumbered** **Description:** unnumbered is a **JSON Block**. Please see below for :ref:`2207_unnumbered` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/unnumbered ` .. _2207_frag: frag ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **frag-timeout** **Description** in milliseconds 4 - 65535 (default is 60000) **Type:** number **Range:** 4-65535 **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_frag_sampling-enable: frag_sampling-enable ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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; '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; 'max-packets-exceeded': Too Many Packets Per Reassembly Drop; 'session-packets-exceeded': Session Max Packets Exceeded; 'frag-session-count': Fragmentation Session Count; 'sctp-rcv': SCTP Received; 'sctp-dropped': SCTP Dropped; 'first-gtp-packet-too-small': First GTP Fragment Too Small Drop; **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, high-cpu-threshold, low-cpu-threshold, cpu-threshold-drop, ipd-entry-drop, max-packets-exceeded, session-packets-exceeded, frag-session-count, sctp-rcv, sctp-dropped, first-gtp-packet-too-small .. _2207_nat: nat ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **icmpv6** **Description:** icmpv6 is a **JSON Block**. Please see below for :ref:`2207_nat_icmpv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/nat/icmpv6 ` **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`2207_nat_inside` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/nat/inside ` **pool-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool-group/{pool-group-name} ` **pool-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool/{pool-name} ` .. _2207_nat_icmpv6: 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 .. _2207_nat_pool-group-list: nat_pool-group-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **member-list** **Type:** List **Reference Object:** :doc:`/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 **sampling-enable** **Type:** List **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 .. _2207_nat_pool-group-list_sampling-enable: nat_pool-group-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'Failed': some-help-string; **Type:** string **Supported Values:** all, Failed .. _2207_nat_pool-group-list_member-list: 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 .. _2207_nat_inside: nat_inside ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **source** **Description:** source is a **JSON Block**. Please see below for :ref:`2207_nat_inside_source` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/nat/inside/source ` .. _2207_nat_inside_source: nat_inside_source ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/nat/inside/source/list/{list-name} ` .. _2207_nat_inside_source_list-list: 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:** :doc:`/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 .. _2207_nat_pool-list: nat_pool-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **chunk-sharing** **Description** Share NAT pool chunk across CPUs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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 **port-overload** **Description** Nat Pool Port overload **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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-16 **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 .. _2207_nat_pool-list_sampling-enable: nat_pool-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'Port-Usage': some help string; 'Total-Used': some help string; 'Total-Freed': some help string; 'Failed': some help string; **Type:** string **Supported Values:** all, Port-Usage, Total-Used, Total-Freed, Failed .. _2207_fib-summary: fib-summary ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_telemetry: telemetry ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_route: route ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **rib-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/route/rib/{ipv6-address} ` **source** **Description:** source is a **JSON Block**. Please see below for :ref:`2207_route_source` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/route/source ` **static** **Description:** static is a **JSON Block**. Please see below for :ref:`2207_route_static` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/route/static ` .. _2207_route_rib-list: 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:** List **ipv6-nexthop-tunnel** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_route_rib-list_ipv6-nexthop-tunnel: 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 .. _2207_route_rib-list_ipv6-nexthop-ipv6: 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 **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 .. _2207_route_source: route_source ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ve-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/route/source/ve/{ve-num}+{nexthop-ip} ` .. _2207_route_source_ve-list: 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 .. _2207_route_static: route_static ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bfd** **Description:** bfd is a **JSON Block**. Please see below for :ref:`2207_route_static_bfd` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd ` .. _2207_route_static_bfd: route_static_bfd ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bfd-ipv6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/bfd-ipv6/{local-ipv6}+{nexthop-ipv6} ` **ethernet-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/ethernet/{eth-num}+{nexthop-ipv6-ll} ` **trunk-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/trunk/{trunk-num}+{nexthop-ipv6-ll} ` **ve-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/route/static/bfd/ve/{ve-num}+{nexthop-ipv6-ll} ` .. _2207_route_static_bfd_bfd-ipv6-list: route_static_bfd_bfd-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': BFD down; (BFD state) **Type:** string **Supported Values:** down **local-ipv6** **Description** Local IPv6 address **Type:** string **Format:** ipv6-address **nexthop-ipv6** **Description** Nexthop IPv6 address **Type:** string **Format:** ipv6-address **template** **Description** Configure tracking template (bind tracking template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-255 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_route_static_bfd_ethernet-list: route_static_bfd_ethernet-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': BFD down; (BFD state) **Type:** string **Supported Values:** down **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 **template** **Description** Configure tracking template (bind tracking template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-255 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_route_static_bfd_trunk-list: route_static_bfd_trunk-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': BFD down; (BFD state) **Type:** string **Supported Values:** down **nexthop-ipv6-ll** **Description** Nexthop IPv6 address (Link-local) **Type:** string **Format:** ipv6-address **template** **Description** Configure tracking template (bind tracking template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-255 **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 .. _2207_route_static_bfd_ve-list: route_static_bfd_ve-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': BFD down; (BFD state) **Type:** string **Supported Values:** down **nexthop-ipv6-ll** **Description** Nexthop IPv6 address (Link-local) **Type:** string **Format:** ipv6-address **template** **Description** Configure tracking template (bind tracking template name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-255 **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 .. _2207_ospf: 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 .. _2207_access-list-list: 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:** List **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 .. _2207_access-list-list_rules: 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-object-group** **Description** Destination network object group name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **fragments** **Description** IP fragments **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **geo-location** **Description** Specify geo-location name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 **Maximum Length:** 63 characters **Maximum Length:** 1 characters **seq-num** **Description** Sequence Number **Type:** number **Range:** 1-8192 **service-obj-group** **Description** Service object group (Source object group name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 **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 .. _2207_fib: fib ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_icmpv6: 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 .. _2207_default-gateway: default-gateway ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv6-default-gateway** **Description** Default gateway address **Type:** string **Format:** ipv6-address **Reference Object:** :doc:`/axapi/v3/ipv6/address ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_neighbor: neighbor ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dynamic** **Description:** dynamic is a **JSON Block**. Please see below for :ref:`2207_neighbor_dynamic` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/neighbor/dynamic ` **static-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ipv6/neighbor/static/{ipv6-addr}+{vlan} ` .. _2207_neighbor_dynamic: neighbor_dynamic ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_neighbor_static-list: neighbor_static-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet port (Port Value) **Type:** number **Format:** interface **Mutual Exclusion:** ethernet, trunk, and tunnel 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, ethernet, and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface **Type:** number **Range:** 1-128 **Mutual Exclusion:** tunnel, ethernet, and trunk are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vlan** **Description** VLAN ID **Type:** number **Range:** 2-4094 **Reference Object:** :doc:`/axapi/v3/network/vlan ` .. _2207_address: 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 .. _2207_reroute: reroute ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **suppress-protocols** **Description:** suppress-protocols is a **JSON Block**. Please see below for :ref:`2207_reroute_suppress-protocols` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/reroute/suppress-protocols ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_reroute_suppress-protocols: 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 .. _2207_prefix-list-list: 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:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_prefix-list-list_rules: 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 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 .. _2207_unnumbered: unnumbered ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **use-source-acl** **Description** Access List, Upon deny packet's source address will be NATed (ACL Name) **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ipv6/access-list ` **use-source-ipv6** **Description:** use-source-ipv6 is a **JSON Block**. Please see below for :ref:`2207_unnumbered_use-source-ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ipv6/unnumbered/use-source-ipv6 ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_unnumbered_use-source-ipv6: unnumbered_use-source-ipv6 ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2207_rib: rib ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters