.. _ip: ip == Global IP configuration subcommands ip Specification ---------------- ===================================== =========================================== **Parameter** **Value** ===================================== =========================================== **Type** *Intermediate Resource* **Element Name** ip **Element URI** /axapi/v3/ip **Element Attributes** ip_attributes **Partition Visibility** shared **Schema** :download:`ip schema ` ===================================== =========================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/ip .. raw:: html ip_attributes .. raw:: html
.. _2146_ip_attributes: ip attributes ------------- **access-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/access-list/{name} ` **address** **Description:** address is a **JSON Block**. Please see below for :ref:`2146_address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/address ` **anomaly-drop** **Description:** anomaly-drop is a **JSON Block**. Please see below for :ref:`2146_anomaly-drop` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/anomaly-drop ` **app-protocol-port** **Description:** app-protocol-port is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port ` **as-path-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/as-path/{access-list}+{action}+{value} ` **community-list** **Description:** community-list is a **JSON Block**. Please see below for :ref:`2146_community-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/community-list ` **default-gateway** **Description:** default-gateway is a **JSON Block**. Please see below for :ref:`2146_default-gateway` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/default-gateway ` **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`2146_dns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/dns ` **extcommunity-list** **Description:** extcommunity-list is a **JSON Block**. Please see below for :ref:`2146_extcommunity-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/extcommunity-list ` **fib** **Description:** fib is a **JSON Block**. Please see below for :ref:`2146_fib` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/fib ` **fib-summary** **Description:** fib-summary is a **JSON Block**. Please see below for :ref:`2146_fib-summary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/fib-summary ` **frag** **Description:** frag is a **JSON Block**. Please see below for :ref:`2146_frag` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/frag ` **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`2146_icmp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/icmp ` **large-community-list** **Description:** large-community-list is a **JSON Block**. Please see below for :ref:`2146_large-community-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/large-community-list ` **map-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/map-list/{name} ` **mgmt-traffic-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/mgmt-traffic/{traffic-type} ` **nat** **Description:** nat is a **JSON Block**. Please see below for :ref:`2146_nat` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat ` **nat-global** **Description:** nat-global is a **JSON Block**. Please see below for :ref:`2146_nat-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat-global ` **prefix-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/prefix-list/{name} ` **reroute** **Description:** reroute is a **JSON Block**. Please see below for :ref:`2146_reroute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/reroute ` **rib** **Description:** rib is a **JSON Block**. Please see below for :ref:`2146_rib` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/rib ` **route** **Description:** route is a **JSON Block**. Please see below for :ref:`2146_route` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/route ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`2146_tcp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/tcp ` **telemetry** **Description:** telemetry is a **JSON Block**. Please see below for :ref:`2146_telemetry` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/telemetry ` **unnumbered** **Description:** unnumbered is a **JSON Block**. Please see below for :ref:`2146_unnumbered` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/unnumbered ` .. _2146_fib-summary: fib-summary ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_tcp: tcp ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **syn-cookie** **Description:** syn-cookie is a **JSON Block**. Please see below for :ref:`2146_tcp_syn-cookie` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_tcp_syn-cookie: tcp_syn-cookie ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sack-enable** **Description** Enable HW Syn-Cookie SACK support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **threshold** **Description** SYN cookie expire threshold (seconds (default is 4)) **Type:** number **Range:** 1-100 **Default:** 4 .. _2146_mgmt-traffic-list: mgmt-traffic-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **source-interface** **Description:** source-interface is a **JSON Block**. Please see below for :ref:`2146_mgmt-traffic-list_source-interface` **Type:** Object **traffic-type** **Description** 'all': All; 'ftp': FTP; 'ntp': NTP; 'snmp-trap': SNMP Trap; 'ssh': SSH and SCP; 'syslog': SYSLOG; 'telnet': Telnet; 'tftp': TFTP; 'web': Web - HTTP and HTTPS; **Type:** string **Supported Values:** all, ftp, ntp, snmp-trap, ssh, syslog, telnet, tftp, web **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_mgmt-traffic-list_source-interface: mgmt-traffic-list_source-interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **lif** **Description** Logical interface (Lif interface number) **Type:** number **Range:** 1-128 **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Range:** 1-128 **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _2146_app-protocol-port: app-protocol-port ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **monitor** **Description:** monitor is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/monitor ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_tcp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_udp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp ` .. _2146_app-protocol-port_udp: app-protocol-port_udp ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **passthrough** **Description:** passthrough is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_udp_passthrough` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/passthrough ` **port** **Description:** port is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_udp_port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port ` .. _2146_app-protocol-port_udp_passthrough: app-protocol-port_udp_passthrough ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable global port processing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enables global port processing **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 .. _2146_app-protocol-port_udp_port: app-protocol-port_udp_port ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **add-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/add/{port} ` **disable-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/disable/{port} ` .. _2146_app-protocol-port_udp_port_add-list: app-protocol-port_udp_port_add-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **app-name-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name} ` **port** **Description** Port Number **Type:** number **Range:** 0-65534 **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 .. _2146_app-protocol-port_udp_port_add-list_app-name-list: app-protocol-port_udp_port_add-list_app-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **interface** **Description:** interface is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_udp_port_add-list_app-name-list_interface` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name}/interface ` **name** **Description** Application Protocol Port 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 .. _2146_app-protocol-port_udp_port_add-list_app-name-list_interface: app-protocol-port_udp_port_add-list_app-name-list_interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **management** **Description** Management Interface **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 **ve-cfg** **Type:** List .. _2146_app-protocol-port_udp_port_add-list_app-name-list_interface_ve-cfg: app-protocol-port_udp_port_add-list_app-name-list_interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve-end** **Description** VE port **Type:** number **ve-start** **Description** VE port (VE Interface number) **Type:** number .. _2146_app-protocol-port_udp_port_add-list_app-name-list_interface_eth-cfg: app-protocol-port_udp_port_add-list_app-name-list_interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet-end** **Description** Ethernet port **Type:** number **Format:** interface **ethernet-start** **Description** Ethernet port (Ethernet Interface number) **Type:** number **Format:** interface .. _2146_app-protocol-port_udp_port_disable-list: app-protocol-port_udp_port_disable-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **interface** **Description:** interface is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_udp_port_disable-list_interface` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/udp/port/disable/{port}/interface ` **port** **Description** Port Number **Type:** number **Range:** 0-65534 **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 .. _2146_app-protocol-port_udp_port_disable-list_interface: app-protocol-port_udp_port_disable-list_interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **management** **Description** Management Interface **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 **ve-cfg** **Type:** List .. _2146_app-protocol-port_udp_port_disable-list_interface_ve-cfg: app-protocol-port_udp_port_disable-list_interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve-end** **Description** VE port **Type:** number **ve-start** **Description** VE port (VE Interface number) **Type:** number .. _2146_app-protocol-port_udp_port_disable-list_interface_eth-cfg: app-protocol-port_udp_port_disable-list_interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet-end** **Description** Ethernet port **Type:** number **Format:** interface **ethernet-start** **Description** Ethernet port (Ethernet Interface number) **Type:** number **Format:** interface .. _2146_app-protocol-port_monitor: app-protocol-port_monitor ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Enables global port processing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enables global port processing **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 .. _2146_app-protocol-port_tcp: app-protocol-port_tcp ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **passthrough** **Description:** passthrough is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_tcp_passthrough` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/passthrough ` **port** **Description:** port is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_tcp_port` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port ` .. _2146_app-protocol-port_tcp_passthrough: app-protocol-port_tcp_passthrough ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable passthrough mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enables passthrough mode **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 .. _2146_app-protocol-port_tcp_port: app-protocol-port_tcp_port ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **add-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/add/{port} ` **disable-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/disable/{port} ` .. _2146_app-protocol-port_tcp_port_add-list: app-protocol-port_tcp_port_add-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **app-name-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}/app-name/{name} ` **port** **Description** Port Number **Type:** number **Range:** 0-65534 **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 .. _2146_app-protocol-port_tcp_port_add-list_app-name-list: app-protocol-port_tcp_port_add-list_app-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **interface** **Description:** interface is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_tcp_port_add-list_app-name-list_interface` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/add/{port}/app-name/{name}/interface ` **name** **Description** Application Protocol Port 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 .. _2146_app-protocol-port_tcp_port_add-list_app-name-list_interface: app-protocol-port_tcp_port_add-list_app-name-list_interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **management** **Description** Management Interface **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 **ve-cfg** **Type:** List .. _2146_app-protocol-port_tcp_port_add-list_app-name-list_interface_ve-cfg: app-protocol-port_tcp_port_add-list_app-name-list_interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve-end** **Description** VE port **Type:** number **ve-start** **Description** VE port (VE Interface number) **Type:** number .. _2146_app-protocol-port_tcp_port_add-list_app-name-list_interface_eth-cfg: app-protocol-port_tcp_port_add-list_app-name-list_interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet-end** **Description** Ethernet port **Type:** number **Format:** interface **ethernet-start** **Description** Ethernet port (Ethernet Interface number) **Type:** number **Format:** interface .. _2146_app-protocol-port_tcp_port_disable-list: app-protocol-port_tcp_port_disable-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **interface** **Description:** interface is a **JSON Block**. Please see below for :ref:`2146_app-protocol-port_tcp_port_disable-list_interface` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/app-protocol-port/tcp/port/disable/{port}/interface ` **port** **Description** Port Number **Type:** number **Range:** 0-65534 **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 .. _2146_app-protocol-port_tcp_port_disable-list_interface: app-protocol-port_tcp_port_disable-list_interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **management** **Description** Management Interface **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 **ve-cfg** **Type:** List .. _2146_app-protocol-port_tcp_port_disable-list_interface_ve-cfg: app-protocol-port_tcp_port_disable-list_interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve-end** **Description** VE port **Type:** number **ve-start** **Description** VE port (VE Interface number) **Type:** number .. _2146_app-protocol-port_tcp_port_disable-list_interface_eth-cfg: app-protocol-port_tcp_port_disable-list_interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet-end** **Description** Ethernet port **Type:** number **Format:** interface **ethernet-start** **Description** Ethernet port (Ethernet Interface number) **Type:** number **Format:** interface .. _2146_rib: rib ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_extcommunity-list: extcommunity-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **expanded-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/extcommunity-list/expanded/{expanded} ` **expanded-num-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/extcommunity-list/expanded-num/{ext-list-num} ` **standard-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/extcommunity-list/standard/{standard} ` **standard-num-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/extcommunity-list/standard-num/{std-list-num} ` .. _2146_extcommunity-list_expanded-num-list: extcommunity-list_expanded-num-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ext-list-num** **Description** Extended Community list number (expanded) **Type:** number **Range:** 100-199 **rules-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_extcommunity-list_expanded-num-list_rules-list: extcommunity-list_expanded-num-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ext-list-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **ext-list-value** **Description** An ordered list as a regular-expression **Type:** string **Format:** string-rlx .. _2146_extcommunity-list_expanded-list: extcommunity-list_expanded-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **expanded** **Description** Add an expanded extcommunity-list entry (Extended Community list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **rules-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_extcommunity-list_expanded-list_rules-list: extcommunity-list_expanded-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **expanded-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **expanded-value** **Description** An ordered list as a regular-expression **Type:** string **Format:** string-rlx .. _2146_extcommunity-list_standard-num-list: extcommunity-list_standard-num-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **rules-list** **Type:** List **std-list-num** **Description** Extended Community list number (standard) **Type:** number **Range:** 1-99 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_extcommunity-list_standard-num-list_rules-list: extcommunity-list_standard-num-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **std-list-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **std-list-value** **Description** rt Route Target extended community in aa:nn or IPaddr:nn format OR soo Site-of-Origin extended community in aa:nn or IPaddr:nn **Type:** string **Format:** string-rlx .. _2146_extcommunity-list_standard-list: extcommunity-list_standard-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **rules-list** **Type:** List **standard** **Description** Add a standard extcommunity-list entry (Extended Community list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_extcommunity-list_standard-list_rules-list: extcommunity-list_standard-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **standard-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **standard-value** **Description** rt Route Target extended community in aa:nn or IPaddr:nn format OR soo Site-of-Origin extended community in aa:nn or IPaddr:nn **Type:** string **Format:** string-rlx .. _2146_icmp: icmp ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **redirect** **Description** Disable outbound ICMP redirect messages **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **unreachable** **Description** Disable outbound ICMP 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 .. _2146_anomaly-drop: anomaly-drop ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bad-content** **Description** bad content threshold (threshold value) **Type:** number **Range:** 1-127 **drop-all** **Description** drop all IP anomaly packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **frag** **Description** drop all fragmented packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-option** **Description** drop packets with IP options **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-ext-header** **Description:** ipv6-ext-header is a **JSON Block**. Please see below for :ref:`2146_anomaly-drop_ipv6-ext-header` **Type:** Object **land-attack** **Description** drop IP packets with the same source and destination addresses **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **out-of-sequence** **Description** out of sequence packet threshold (threshold value) **Type:** number **Range:** 1-127 **packet-deformity** **Description:** packet-deformity is a **JSON Block**. Please see below for :ref:`2146_anomaly-drop_packet-deformity` **Type:** Object **ping-of-death** **Description** drop oversize ICMP packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sampling-enable** **Type:** List **security-attack** **Description:** security-attack is a **JSON Block**. Please see below for :ref:`2146_anomaly-drop_security-attack` **Type:** Object **tcp-no-flag** **Description** drop TCP packets with no flag **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-syn-fin** **Description** drop TCP packets with both syn and fin flags set **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-syn-frag** **Description** drop fragmented TCP packets with syn flag set **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 **zero-window** **Description** zero window size threshold (threshold value) **Type:** number **Range:** 1-127 .. _2146_anomaly-drop_security-attack: anomaly-drop_security-attack ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **security-attack-layer-3** **Description** drop packets with layer 3 anomaly **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **security-attack-layer-4** **Description** drop packets with layer 4 anomaly **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _2146_anomaly-drop_packet-deformity: anomaly-drop_packet-deformity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **packet-deformity-layer-3** **Description** drop packets with layer 3 anomaly **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **packet-deformity-layer-4** **Description** drop packets with layer 4 anomaly **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _2146_anomaly-drop_sampling-enable: anomaly-drop_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'land': Land Attack Drop; 'emp_frg': Empty Fragment Drop; 'emp_mic_frg': Micro Fragment Drop; 'opt': IPv4 Options Drop; 'frg': IPv4 Fragment Drop; 'bad_ip_hdrlen': Bad IP Header Len Drop; 'bad_ip_flg': Bad IP Flags Drop; 'bad_ip_ttl': Bad IP TTL Drop; 'no_ip_payload': No IP Payload drop; 'over_ip_payload': Oversize IP Payload Drop; 'bad_ip_payload_len': Bad IP Payload Len Drop; 'bad_ip_frg_offset': Bad IP Fragment Offset Drop; 'csum': Bad IP Checksum Drop; 'pod': ICMP Ping of Death Drop; 'bad_tcp_urg_offset': TCP Bad Urgent Offset Drop; 'tcp_sht_hdr': TCP Short Header Drop; 'tcp_bad_iplen': TCP Bad IP Length Drop; 'tcp_null_frg': TCP Null Flags Drop; 'tcp_null_scan': TCP Null Scan Drop; 'tcp_syn_fin': TCP Syn and Fin Drop; 'tcp_xmas': TCP XMAS Flags Drop; 'tcp_xmas_scan': TCP XMAS Scan Drop; 'tcp_syn_frg': TCP Syn Fragment Drop; 'tcp_frg_hdr': TCP Fragmented Header Drop; 'tcp_bad_csum': TCP Bad Checksum Drop; 'udp_srt_hdr': UDP Short Header Drop; 'udp_bad_len': UDP Bad Length Drop; 'udp_kerb_frg': UDP Kerberos Fragment Drop; 'udp_port_lb': UDP Port Loopback Drop; 'udp_bad_csum': UDP Bad Checksum Drop; 'runt_ip_hdr': Runt IP Header Drop; 'runt_tcp_udp_hdr': Runt TCP/UDP Header Drop; 'ipip_tnl_msmtch': IP-over-IP Tunnel Mismatch Drop; 'tcp_opt_err': TCP Option Error Drop; 'ipip_tnl_err': IP-over-IP Tunnel Error Drop; 'vxlan_err': VXLAN Tunnel Error Drop; 'nvgre_err': GRE Tunnel Error Drop; 'gre_pptp_err': GRE PPTP Error Drop; **Type:** string **Supported Values:** all, land, emp_frg, emp_mic_frg, opt, frg, bad_ip_hdrlen, bad_ip_flg, bad_ip_ttl, no_ip_payload, over_ip_payload, bad_ip_payload_len, bad_ip_frg_offset, csum, pod, bad_tcp_urg_offset, tcp_sht_hdr, tcp_bad_iplen, tcp_null_frg, tcp_null_scan, tcp_syn_fin, tcp_xmas, tcp_xmas_scan, tcp_syn_frg, tcp_frg_hdr, tcp_bad_csum, udp_srt_hdr, udp_bad_len, udp_kerb_frg, udp_port_lb, udp_bad_csum, runt_ip_hdr, runt_tcp_udp_hdr, ipip_tnl_msmtch, tcp_opt_err, ipip_tnl_err, vxlan_err, nvgre_err, gre_pptp_err, ipv6_eh_hbh, ipv6_eh_dest, ipv6_eh_routing, ipv6_eh_frag, ipv6_eh_ah, ipv6_eh_esp, ipv6_eh_mobility, ipv6_eh_none, ipv6_eh_other, ipv6_eh_malformed .. _2146_anomaly-drop_ipv6-ext-header: anomaly-drop_ipv6-ext-header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dst-option-list** **Type:** List **hbh-option-list** **Type:** List **ipv6-eh-auth** **Description** Filter authentication extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-dest** **Description** Filter destination extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-esp** **Description** Filter ESP extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-frag** **Description** Filter fragmentation extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-hbh** **Description** Filter hop by hop extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-malformed** **Description** Filter malformed extension headers (check for order and occurrences) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-mobility** **Description** Filter mobility extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-nonext** **Description** Filter no-next-header extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-eh-routing** **Description** Filter routing extension header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **routing-option-list** **Type:** List **unknown-ext-header-list** **Type:** List .. _2146_anomaly-drop_ipv6-ext-header_routing-option-list: anomaly-drop_ipv6-ext-header_routing-option-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **routing-otype-from** **Description** Filter routing header option type (Option type value) **Type:** number **routing-otype-to** **Description** Option type range end **Type:** number .. _2146_anomaly-drop_ipv6-ext-header_dst-option-list: anomaly-drop_ipv6-ext-header_dst-option-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dst-otype-from** **Description** Filter destination header option type (Option type value) **Type:** number **dst-otype-to** **Description** Option type range end **Type:** number .. _2146_anomaly-drop_ipv6-ext-header_hbh-option-list: anomaly-drop_ipv6-ext-header_hbh-option-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hbh-otype-from** **Description** Filter hop by hop option type (Option type value) **Type:** number **hbh-otype-to** **Description** Option type range end **Type:** number .. _2146_anomaly-drop_ipv6-ext-header_unknown-ext-header-list: anomaly-drop_ipv6-ext-header_unknown-ext-header-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **eh-type-from** **Description** Filter unknown extension header (eh) type (Extension header type value) **Type:** number **eh-type-to** **Description** Extension header type range end **Type:** number .. _2146_telemetry: telemetry ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_community-list: community-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **expanded-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/community-list/expanded/{expanded} ` **expanded-num-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/community-list/expanded-num/{ext-list-num} ` **standard-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/community-list/standard/{standard} ` **standard-num-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/community-list/standard-num/{std-list-num} ` .. _2146_community-list_expanded-num-list: community-list_expanded-num-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ext-list-num** **Description** Community list number (expanded) **Type:** number **Range:** 100-199 **rules-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_community-list_expanded-num-list_rules-list: community-list_expanded-num-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ext-list-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **ext-list-value** **Description** An ordered list as a regular-expression **Type:** string **Format:** string-rlx .. _2146_community-list_expanded-list: community-list_expanded-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **expanded** **Description** Add an expanded community-list entry (Community list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **rules-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_community-list_expanded-list_rules-list: community-list_expanded-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **expanded-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **expanded-value** **Description** An ordered list as a regular-expression **Type:** string **Format:** string-rlx .. _2146_community-list_standard-num-list: community-list_standard-num-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **rules-list** **Type:** List **std-list-num** **Description** Community list number (standard) **Type:** number **Range:** 1-99 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_community-list_standard-num-list_rules-list: community-list_standard-num-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **std-list-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **std-list-comm-value** **Description** community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export **Type:** string **Format:** string-rlx .. _2146_community-list_standard-list: community-list_standard-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **rules-list** **Type:** List **standard** **Description** Add a standard community-list entry (Community list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_community-list_standard-list_rules-list: community-list_standard-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **standard-action** **Description** 'deny': Specify community to reject; 'permit': Specify community to accept; **Type:** string **Supported Values:** deny, permit **standard-comm-value** **Description** community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export **Type:** string **Format:** string-rlx .. _2146_fib: fib ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_default-gateway: default-gateway ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **gateway-ip** **Description** Default gateway address **Type:** string **Format:** ipv4-address **Reference Object:** :doc:`/axapi/v3/ip/address ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat: nat ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **alg** **Description:** alg is a **JSON Block**. Please see below for :ref:`2146_nat_alg` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/alg ` **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`2146_nat_icmp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/icmp ` **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`2146_nat_inside` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/inside ` **nat-global** **Description:** nat-global is a **JSON Block**. Please see below for :ref:`2146_nat_nat-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/nat-global ` **pool-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/pool-group/{pool-group-name} ` **pool-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/pool/{pool-name} ` **range-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/range-list/{name} ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`2146_nat_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/template ` **translation** **Description:** translation is a **JSON Block**. Please see below for :ref:`2146_nat_translation` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/translation ` .. _2146_nat_range-list-list: nat_range-list-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **global-netmaskv4** **Description** Mask for this Address range **Type:** string **Format:** ipv4-netmask **global-start-ipv4-addr** **Description** Global Start IPv4 Address of this list **Type:** string **Format:** ipv4-address **global-start-ipv6-addr** **Description** Global Start IPv6 Address of this list **Type:** string **Format:** ipv6-address-plen **local-netmaskv4** **Description** Mask for this Address range **Type:** string **Format:** ipv4-netmask **local-start-ipv4-addr** **Description** Local Start IPv4 Address of this list **Type:** string **Format:** ipv4-address **local-start-ipv6-addr** **Description** Local Start IPv6 Address of this list **Type:** string **Format:** ipv6-address-plen **name** **Description** Name for this Static List **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **v4-acl-id** **Description** Access list ID **Type:** number **Range:** 1-199 **v4-acl-name** **Description** Access list name **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **v4-count** **Description** Number of addresses to be translated in this range **Type:** number **Range:** 1-200000 **v4-vrid** **Description** VRRP-A vrid (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid ` **v6-acl-name** **Description** Access list name **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **v6-count** **Description** Number of addresses to be translated in this range **Type:** number **Range:** 1-200000 **v6-vrid** **Description** VRRP-A vrid (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid ` .. _2146_nat_alg: nat_alg ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`2146_nat_alg_dns` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/alg/dns ` **pptp** **Description:** pptp is a **JSON Block**. Please see below for :ref:`2146_nat_alg_pptp` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/alg/pptp ` .. _2146_nat_alg_pptp: nat_alg_pptp ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **pptp** **Description** 'disable': Disable PPTP NAT ALG; 'enable': Enable PPTP NAT ALG; **Type:** string **Supported Values:** disable, enable **Default:** disable **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_alg_pptp_sampling-enable: nat_alg_pptp_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'current-smp-sessions': some help string; 'current-gre-sessions': some help string; 'smp-session-creation-failure': some help string; 'truncated-pns-message': some help string; 'truncated-pac-message': some help string; 'mismatched-pns-call-id': some help string; 'mismatched-pac-call-id': some help string; 'retransmitted-pns-message': some help string; 'retransmitted-pac-message': some help string; 'truncated-gre-packet': some help string; 'unknown-gre-version': some help string; 'no-matching-gre-session': some help string; **Type:** string **Supported Values:** all, current-smp-sessions, current-gre-sessions, smp-session-creation-failure, truncated-pns-message, truncated-pac-message, mismatched-pns-call-id, mismatched-pac-call-id, retransmitted-pns-message, retransmitted-pac-message, truncated-gre-packet, unknown-gre-version, no-matching-gre-session .. _2146_nat_alg_dns: nat_alg_dns ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dns-alg** **Description** 'disable': Disable DNS NAT ALG; 'enable': Enable DNS NAT ALG; **Type:** string **Supported Values:** disable, enable **Default:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_pool-group-list: nat_pool-group-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **member-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/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 **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid ` .. _2146_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 .. _2146_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 .. _2146_nat_nat-global: nat_nat-global ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_nat-global_sampling-enable: nat_nat-global_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'cross_cpu_helper_created': Cross CPU Helper Created; 'cross_cpu_helper_free': Cross CPU Helper Free; 'cross_cpu_sent': Cross CPU Helper Packets Sent; 'cross_cpu_rcv': Cross CPU Helper Packets Received; 'cross_cpu_helper_nat_pool_standby': Cross CPU Helper Standby; 'cross_cpu_helper_cpu_mismatch': Cross CPU Helper CPU Mismatch; 'cross_cpu_bad_l3': Cross CPU Unsupported L3; 'cross_cpu_bad_l4': Cross CPU Unsupported L4; 'cross_cpu_no_session': Cross CPU No Session Found; 'cross_cpu_helper_deleted': Cross CPU Helper Deleted; 'cross_cpu_helper_free_retry_lookup': Cross CPU Helper Free Retry Lookup; 'cross_cpu_helper_free_not_found': Cross CPU Helper Free Not Found; **Type:** string **Supported Values:** all, cross_cpu_helper_created, cross_cpu_helper_free, cross_cpu_sent, cross_cpu_rcv, cross_cpu_helper_nat_pool_standby, cross_cpu_helper_cpu_mismatch, cross_cpu_bad_l3, cross_cpu_bad_l4, cross_cpu_no_session, cross_cpu_helper_deleted, cross_cpu_helper_free_retry_lookup, cross_cpu_helper_free_not_found .. _2146_nat_template: nat_template ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **logging-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/template/logging/{name} ` .. _2146_nat_template_logging-list: nat_template_logging-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **facility** **Description** 'kernel': 0: Kernel; 'user': 1: User-level; 'mail': 2: Mail; 'daemon': 3: System daemons; 'security-authorization': 4: Security/authorization; 'syslog': 5: Syslog internal; 'line-printer': 6: Line printer; 'news': 7: Network news; 'uucp': 8: UUCP subsystem; 'cron': 9: Time-related; 'security-authorization-private': 10: Private security/authorization; 'ftp': 11: FTP; 'ntp': 12: NTP; 'audit': 13: Audit; 'alert': 14: Alert; 'clock': 15: Clock-related; 'local0': 16: Local use 0; 'local1': 17: Local use 1; 'local2': 18: Local use 2; 'local3': 19: Local use 3; 'local4': 20: Local use 4; 'local5': 21: Local use 5; 'local6': 22: Local use 6; 'local7': 23: Local use 7; **Type:** string **Supported Values:** kernel, user, mail, daemon, security-authorization, syslog, line-printer, news, uucp, cron, security-authorization-private, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7 **Default:** local0 **include-destination** **Description** Include the destination IP and port in logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **include-rip-rport** **Description** Include the IP and port of real server in logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log** **Description:** log is a **JSON Block**. Please see below for :ref:`2146_nat_template_logging-list_log` **Type:** Object **name** **Description** NAT logging template name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **service-group** **Description** Set NAT logging service-group **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/slb/service-group ` **severity** **Description:** severity is a **JSON Block**. Please see below for :ref:`2146_nat_template_logging-list_severity` **Type:** Object **source-port** **Description:** source-port is a **JSON Block**. Please see below for :ref:`2146_nat_template_logging-list_source-port` **Type:** Object **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 .. _2146_nat_template_logging-list_severity: nat_template_logging-list_severity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **severity-string** **Description** 'emergency': 0: Emergency; 'alert': 1: Alert; 'critical': 2: Critical; 'error': 3: Error; 'warning': 4: Warning; 'notice': 5: Notice; 'informational': 6: Informational; 'debug': 7: Debug; **Type:** string **Supported Values:** emergency, alert, critical, error, warning, notice, informational, debug **Default:** debug **Mutual Exclusion:** severity-string and severity-val are mutually exclusive **severity-val** **Description** Logging severity level **Type:** number **Range:** 0-7 **Default:** 7 **Mutual Exclusion:** severity-val and severity-string are mutually exclusive .. _2146_nat_template_logging-list_log: nat_template_logging-list_log ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **port-mappings** **Description** 'creation': Log creation of NAT mappgins; 'disable': Disable Log creation and deletion of NAT mappings; **Type:** string **Supported Values:** creation, disable .. _2146_nat_template_logging-list_source-port: nat_template_logging-list_source-port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **any** **Description** Use any source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** any and source-port-num are mutually exclusive **source-port-num** **Description** Set source port for sending NAT syslogs (default: 514) **Type:** number **Range:** 1-65535 **Default:** 514 **Mutual Exclusion:** source-port-num and any are mutually exclusive .. _2146_nat_translation: nat_translation ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp-timeout** **Description:** icmp-timeout is a **JSON Block**. Please see below for :ref:`2146_nat_translation_icmp-timeout` **Type:** Object **ignore-tcp-msl** **Description** reclaim TCP resource immediately without MSL **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **service-timeout-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/translation/service-timeout/{service-type}+{port} ` **tcp-timeout** **Description** TCP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes)) **Type:** number **Range:** 2-15000 **Default:** 300 **udp-timeout** **Description** UDP protocol extended translations (Timeout in seconds (Interval of 60 seconds), default is 300 seconds (5 minutes)) **Type:** number **Range:** 2-15000 **Default:** 300 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_translation_service-timeout-list: nat_translation_service-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Port Number **Type:** number **Range:** 1-65535 **service-type** **Description** 'tcp': TCP Protocol; 'udp': UDP Protocol; **Type:** string **Supported Values:** tcp, udp **timeout-type** **Description** 'age': Expiration time; 'fast': Use Fast aging; **Type:** string **Supported Values:** age, fast **timeout-val** **Description** Timeout in seconds (Interval of 60 seconds) **Type:** number **Range:** 2-15000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_translation_icmp-timeout: nat_translation_icmp-timeout ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp-timeout** **Description** 'age': Expiration time; 'fast': Use Fast aging; **Type:** string **Supported Values:** age, fast **Default:** fast **icmp-timeout-val** **Description** Timeout in seconds (Interval of 60 seconds) **Type:** number **Range:** 2-15000 .. _2146_nat_icmp: nat_icmp ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **always-source-nat-errors** **Description** Source NAT intermediate routers' IPs for ICMP errors (default: disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **respond-to-ping** **Description** Respond to ICMP 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 .. _2146_nat_inside: nat_inside ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **source** **Description:** source is a **JSON Block**. Please see below for :ref:`2146_nat_inside_source` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/inside/source ` .. _2146_nat_inside_source: nat_inside_source ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`2146_nat_inside_source_class-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/inside/source/class-list ` **list** **Description:** list is a **JSON Block**. Please see below for :ref:`2146_nat_inside_source_list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/nat/inside/source/list ` **static-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/inside/source/static/{src-address}+{nat-address} ` .. _2146_nat_inside_source_static-list: nat_inside_source_static-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': Enable static mapping (default); 'disable': Disable static mapping; **Type:** string **Supported Values:** enable, disable **Default:** enable **nat-address** **Description** NAT Address **Type:** string **Format:** ipv4-address **src-address** **Description** Original Source Address **Type:** string **Format:** ipv4-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vrid** **Description** VRRP-A vrid (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid ` .. _2146_nat_inside_source_list: nat_inside_source_list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-id-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/inside/source/list/acl-id-list/{acl-id} ` **acl-name-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/nat/inside/source/list/acl-name-list/{name} ` .. _2146_nat_inside_source_list_acl-id-list-list: nat_inside_source_list_acl-id-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-id** **Description** Acl id **Type:** number **Range:** 1-199 **msl** **Description** Maximum Session Life Value **Type:** number **Range:** 1-1800 **pool** **Description** Pool or Pool Group (Pool or Pool Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_inside_source_list_acl-name-list-list: nat_inside_source_list_acl-name-list-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **msl** **Description** Maximum Session Life Value **Type:** number **Range:** 1-1800 **name** **Description** Apply an access list **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ip/access-list ` **pool** **Description** Pool or Pool Group (Pool or Pool Group Nam) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_nat_inside_source_class-list: nat_inside_source_class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** Class List Name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_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:** ipv4-address **ethernet** **Description** Ethernet interface **Type:** number **Format:** interface **gateway** **Description** Configure gateway IP **Type:** string **Format:** ipv4-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:** string **Format:** ipv4-netmask-brief **pool-name** **Description** Specify pool name or pool group **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 **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:** ipv4-address **Mutual Exclusion:** start-address and use-if-ip are mutually exclusive **use-if-ip** **Description** Use Interface IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-if-ip and start-address are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vrid** **Description** Configure VRRP-A vrid (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid ` .. _2146_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 .. _2146_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.0.0/0 le 32" **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-32 **ipaddr** **Description** IP prefix, e.g., 35.0.0.0/8 **Type:** string **Format:** ipv4-cidr **le** **Description** Maximum prefix length to be matched **Type:** number **Range:** 0-32 **seq** **Description** Sequence number of an entry **Type:** number **Range:** 1-4294967295 .. _2146_frag: frag ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **buff** **Description** Max buff used for fragmentation (Buffer Value(10000-3000000)) **Type:** number **Range:** 10000-3000000 **cpu-threshold** **Description:** cpu-threshold is a **JSON Block**. Please see below for :ref:`2146_frag_cpu-threshold` **Type:** Object **max-packets-per-reassembly** **Description** Max number of fragmented packets allowed per reassembly(0 is unlimited) (default 0) **Type:** number **Range:** 2-16 **max-reassembly-sessions** **Description** Max number of pending reassembly sessions allowed (default 100000) **Type:** number **Range:** 1-200000 **sampling-enable** **Type:** List **timeout** **Description** Fragmentation timeout (in milliseconds 4 - 65535 (default is 60000)) **Type:** number **Range:** 4-65535 **Default:** 60000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_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 .. _2146_frag_cpu-threshold: frag_cpu-threshold ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **high** **Description** When CPU usage reaches this value, it will stop processing fragments (default: 75%) **Type:** number **Range:** 0-100 **Default:** 75 **low** **Description** When CPU usage remains under this value, it will resume processing fragments (default: 60%) **Type:** number **Range:** 0-100 **Default:** 60 .. _2146_dns: dns ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **primary** **Description:** primary is a **JSON Block**. Please see below for :ref:`2146_dns_primary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/dns/primary ` **secondary** **Description:** secondary is a **JSON Block**. Please see below for :ref:`2146_dns_secondary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/dns/secondary ` **suffix** **Description:** suffix is a **JSON Block**. Please see below for :ref:`2146_dns_suffix` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/dns/suffix ` .. _2146_dns_suffix: dns_suffix ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **domain-name** **Description** DNS suffix **Type:** string **Maximum Length:** 32 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_dns_primary: dns_primary ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-v4-addr** **Description** DNS server address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-v4-addr and ip-v6-addr are mutually exclusive **ip-v6-addr** **Description** DNS server address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ip-v6-addr and ip-v4-addr are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_dns_secondary: dns_secondary ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-v4-addr** **Description** DNS server address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-v4-addr and ip-v6-addr are mutually exclusive **ip-v6-addr** **Description** DNS server address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ip-v6-addr and ip-v4-addr are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_large-community-list: large-community-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **expanded-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/large-community-list/expanded/{expanded} ` **expanded-num-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/large-community-list/expanded-num/{ext-list-num} ` **standard-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/large-community-list/standard/{standard} ` **standard-num-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/large-community-list/standard-num/{std-list-num} ` .. _2146_large-community-list_expanded-num-list: large-community-list_expanded-num-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ext-list-num** **Description** Large community list number (expanded) **Type:** number **Range:** 100-199 **rules-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_large-community-list_expanded-num-list_rules-list: large-community-list_expanded-num-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ext-list-lcom-action** **Description** 'deny': Specify large community to reject; 'permit': Specify large community to accept; **Type:** string **Supported Values:** deny, permit **ext-list-lcom-value** **Description** An ordered list as a regular-expression **Type:** string **Format:** string-rlx .. _2146_large-community-list_expanded-list: large-community-list_expanded-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **expanded** **Description** Add an expanded large community-list entry (Large community list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **rules-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_large-community-list_expanded-list_rules-list: large-community-list_expanded-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **expanded-lcom-action** **Description** 'deny': Specify large community to reject; 'permit': Specify large community to accept; **Type:** string **Supported Values:** deny, permit **expanded-lcom-value** **Description** An ordered list as a regular-expression **Type:** string **Format:** string-rlx .. _2146_large-community-list_standard-num-list: large-community-list_standard-num-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **rules-list** **Type:** List **std-list-num** **Description** Large Community list number (standard) **Type:** number **Range:** 1-99 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_large-community-list_standard-num-list_rules-list: large-community-list_standard-num-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **std-list-lcom-action** **Description** 'deny': Specify large community to reject; 'permit': Specify large community to accept; **Type:** string **Supported Values:** deny, permit **std-list-lcomm-value** **Description** Large community value in the format XX:YY:ZZ **Type:** string **Format:** string-rlx .. _2146_large-community-list_standard-list: large-community-list_standard-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **rules-list** **Type:** List **standard** **Description** Add a standard large community-list entry (Large community list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_large-community-list_standard-list_rules-list: large-community-list_standard-list_rules-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **standard-lcom-action** **Description** 'deny': Specify large community to reject; 'permit': Specify large community to accept; **Type:** string **Supported Values:** deny, permit **standard-lcomm-value** **Description** Large community value in the format XX:YY:ZZ **Type:** string **Format:** string-rlx .. _2146_access-list-list: access-list-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** IP Access List Name. Does not support name as digits or start with digit. **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 .. _2146_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:** ipv4-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-mask** **Description** Destination Mask 0=apply 255=ignore **Type:** string **Format:** ipv4-rev-netmask **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:** ipv4-address **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 **icmp** **Description** Internet Control Message Protocol **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** icmp,tcp, udp, ip, and service-obj-group 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 **ip** **Description** Any Internet Protocol **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** ip,icmp, tcp, udp, and service-obj-group 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, and ip are mutually exclusive **special-code** **Description** 'frag-required': Code 4, fragmentation required; 'host-unreachable': Code 1, destination host unreachable; 'network-unreachable': Code 0, destination network unreachable; 'port-unreachable': Code 3, destination port unreachable; 'proto-unreachable': Code 2, destination protocol unreachable; 'route-failed': Code 5, source route failed; **Type:** string **Supported Values:** frag-required, host-unreachable, network-unreachable, port-unreachable, proto-unreachable, route-failed **Mutual Exclusion:** special-code, any-code, and icmp-code are mutually exclusive **special-type** **Description** 'echo-reply': Type 0, echo reply; 'echo-request': Type 8, echo request; 'info-reply': Type 16, information reply; 'info-request': Type 15, information request; 'mask-reply': Type 18, address mask reply; 'mask-request': Type 17, address mask request; 'parameter-problem': Type 12, parameter problem; 'redirect': Type 5, redirect message; 'source-quench': Type 4, source quench; 'time-exceeded': Type 11, time exceeded; 'timestamp': Type 13, timestamp; 'timestamp-reply': Type 14, timestamp reply; 'dest-unreachable': Type 3, destination unreachable; **Type:** string **Supported Values:** echo-reply, echo-request, info-reply, info-request, mask-reply, mask-request, parameter-problem, redirect, source-quench, time-exceeded, timestamp, timestamp-reply, 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:** ipv4-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-mask** **Description** Source Mask 0=apply 255=ignore **Type:** string **Format:** ipv4-rev-netmask **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:** ipv4-address **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, ip, and service-obj-group are mutually exclusive **transparent-session-only** **Description** Only log transparent sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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, ip, and service-obj-group are mutually exclusive **vlan** **Description** VLAN ID **Type:** number **Range:** 1-4094 .. _2146_map-list-list: map-list-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **file** **Description** Create/Edit a IP Map List stored as a file **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **mapping-list** **Type:** List **name** **Description** Specify name of the IP Map List **Type:** string **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 .. _2146_map-list-list_mapping-list: map-list-list_mapping-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **count** **Description** Number of addresses to be translated in this range **Type:** number **Range:** 1-16777216 **global-start-ip** **Description** Global Start IPv4 Address of this list **Type:** string **Format:** ipv4-address **local-start-ip** **Description** Local Start IPv4 Address of this list **Type:** string **Format:** ipv4-address .. _2146_address: address ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-addr** **Description** IP address **Type:** string **Format:** ipv4-address **ip-mask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_unnumbered: unnumbered ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **use-source-ip** **Description:** use-source-ip is a **JSON Block**. Please see below for :ref:`2146_unnumbered_use-source-ip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/unnumbered/use-source-ip ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_unnumbered_use-source-ip: unnumbered_use-source-ip ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_as-path-list: as-path-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **access-list** **Description** Specify an access list name (Regular expression access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **action** **Description** 'deny': Specify packets to reject; 'permit': Specify packets to forward; **Type:** string **Supported Values:** deny, permit **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **value** **Description** A regular-expression to match the BGP AS paths **Type:** string **Format:** string-rlx .. _2146_route: route ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **rib-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/route/rib/{ip-dest-addr}+{ip-mask} ` **source** **Description:** source is a **JSON Block**. Please see below for :ref:`2146_route_source` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/route/source ` **static** **Description:** static is a **JSON Block**. Please see below for :ref:`2146_route_static` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/route/static ` .. _2146_route_rib-list: route_rib-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-dest-addr** **Description** Destination prefix **Type:** string **Format:** ipv4-address **ip-mask** **Description** Destination prefix mask **Type:** string **Format:** ipv4-netmask-brief **ip-nexthop-ipv4** **Type:** List **ip-nexthop-lif** **Type:** List **ip-nexthop-partition** **Type:** List **ip-nexthop-tunnel** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_route_rib-list_ip-nexthop-lif: route_rib-list_ip-nexthop-lif ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **description-nexthop-lif** **Description** Description for static route **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **lif** **Description** LIF Interface (Logical tunnel interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters .. _2146_route_rib-list_ip-nexthop-ipv4: route_rib-list_ip-nexthop-ipv4 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **description-nexthop-ip** **Description** Description for static route **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **distance-nexthop-ip** **Description** Distance value for this route **Type:** number **Range:** 1-255 **Default:** 1 **ip-next-hop** **Description** Forwarding router's address **Type:** string **Format:** ipv4-address .. _2146_route_rib-list_ip-nexthop-tunnel: route_rib-list_ip-nexthop-tunnel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **description-nexthop-tunnel** **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 **ip-next-hop-tunnel** **Description** Forwarding router's address **Type:** string **Format:** ipv4-address **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Range:** 1-128 .. _2146_route_rib-list_ip-nexthop-partition: route_rib-list_ip-nexthop-partition ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **description-nexthop-partition** **Description** Description for static route **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **description-partition-vrid** **Description** Description for static route **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **partition-name** **Description** Name of network partition **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **vrid-num-in-partition** **Description** Specify ha VRRP-A vrid **Type:** number **Range:** 0-31 .. _2146_route_source: route_source ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ve-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/route/source/ve/{ve-num}+{nexthop-ip} ` .. _2146_route_source_ve-list: route_source_ve-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nexthop-ip** **Description** Nexthop IP address **Type:** string **Format:** ipv4-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 .. _2146_route_static: route_static ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bfd-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/ip/route/static/bfd/{local-ip}+{nexthop-ip} ` .. _2146_route_static_bfd-list: route_static_bfd-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': BFD down; (BFD state) **Type:** string **Supported Values:** down **local-ip** **Description** Local IP address **Type:** string **Format:** ipv4-address **nexthop-ip** **Description** Nexthop IP address **Type:** string **Format:** ipv4-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 .. _2146_nat-global: nat-global ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **reset-idle-tcp-conn** **Description** Reset Idle TCP Connections **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 .. _2146_reroute: reroute ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **suppress-protocols** **Description:** suppress-protocols is a **JSON Block**. Please see below for :ref:`2146_reroute_suppress-protocols` **Type:** Object **Reference Object:** :doc:`/axapi/v3/ip/reroute/suppress-protocols ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2146_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