.. _cgnv6: cgnv6 ===== CGN and IPv6 Migration commands cgnv6 Specification ------------------- ===================================== ============================================== ===================================== ============================================== **Type** *Intermediate Resource* **Element Name** cgnv6 **Element URI** /axapi/v3/cgnv6 **Element Attributes** cgnv6_attributes **Schema** :download:`cgnv6 schema ` ===================================== ============================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/cgnv6 .. raw:: html cgnv6_attributes .. raw:: html
.. _43_cgnv6_attributes: cgnv6 attributes ---------------- **ddos-protection** **Description:** ddos-protection is a **JSON Block**. Please see below for :ref:`43_ddos-protection` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ddos-protection ` **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`43_dns64` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/dns64 ` **dns64-virtualserver-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/dns64-virtualserver/{name} ` **ds-lite** **Description:** ds-lite is a **JSON Block**. Please see below for :ref:`43_ds-lite` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite ` **ecmp** **Description:** ecmp is a **JSON Block**. Please see below for :ref:`43_ecmp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ecmp ` **fixed-nat** **Description:** fixed-nat is a **JSON Block**. Please see below for :ref:`43_fixed-nat` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/global ` **http-alg** **Description:** http-alg is a **JSON Block**. Please see below for :ref:`43_http-alg` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/http-alg ` **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`43_icmp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/icmp ` **l4** **Description:** l4 is a **JSON Block**. Please see below for :ref:`43_l4` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/l4 ` **logging** **Description:** logging is a **JSON Block**. Please see below for :ref:`43_logging` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/logging ` **lsn** **Description:** lsn is a **JSON Block**. Please see below for :ref:`43_lsn` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn ` **lsn-lid-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-lid/{lid-number} ` **lsn-radius-profile-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-radius-profile/{lid-profile-index} ` **lsn-rule-list-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list/{name} ` **lw-4o6** **Description:** lw-4o6 is a **JSON Block**. Please see below for :ref:`43_lw-4o6` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6 ` **map** **Description:** map is a **JSON Block**. Please see below for :ref:`43_map` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map ` **nat** **Description:** nat is a **JSON Block**. Please see below for :ref:`43_nat` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat ` **nat46-stateless** **Description:** nat46-stateless is a **JSON Block**. Please see below for :ref:`43_nat46-stateless` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless ` **nat64** **Description:** nat64 is a **JSON Block**. Please see below for :ref:`43_nat64` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64 ` **nptv6** **Description:** nptv6 is a **JSON Block**. Please see below for :ref:`43_nptv6` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nptv6 ` **one-to-one** **Description:** one-to-one is a **JSON Block**. Please see below for :ref:`43_one-to-one` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one ` **pcp** **Description:** pcp is a **JSON Block**. Please see below for :ref:`43_pcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/pcp ` **port-batch-v1** **Description:** port-batch-v1 is a **JSON Block**. Please see below for :ref:`43_port-batch-v1` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/port-batch-v1 ` **port-list-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/port-list/{name} ` **resource-usage** **Description:** resource-usage is a **JSON Block**. Please see below for :ref:`43_resource-usage` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/resource-usage ` **scaleout** **Description:** scaleout is a **JSON Block**. Please see below for :ref:`43_scaleout` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/scaleout ` **sctp** **Description:** sctp is a **JSON Block**. Please see below for :ref:`43_sctp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp ` **server-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/server/{name} ` **service-group-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/service-group/{name} ` **shared-service-group** **Description:** shared-service-group is a **JSON Block**. Please see below for :ref:`43_shared-service-group` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/shared-service-group ` **sixrd** **Description:** sixrd is a **JSON Block**. Please see below for :ref:`43_sixrd` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sixrd ` **stateful-firewall** **Description:** stateful-firewall is a **JSON Block**. Please see below for :ref:`43_stateful-firewall` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`43_template` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/template ` **translation** **Description:** translation is a **JSON Block**. Please see below for :ref:`43_translation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/translation ` .. _43_lsn: lsn ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **alg** **Description:** alg is a **JSON Block**. Please see below for :ref:`43_lsn_alg` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg ` **all-sessions** **Description:** all-sessions is a **JSON Block**. Please see below for :ref:`43_lsn_all-sessions` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/all-sessions ` **data-sessions** **Description:** data-sessions is a **JSON Block**. Please see below for :ref:`43_lsn_data-sessions` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/data-sessions ` **endpoint-independent-filtering** **Description:** endpoint-independent-filtering is a **JSON Block**. Please see below for :ref:`43_lsn_endpoint-independent-filtering` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/endpoint-independent-filtering ` **endpoint-independent-mapping** **Description:** endpoint-independent-mapping is a **JSON Block**. Please see below for :ref:`43_lsn_endpoint-independent-mapping` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/endpoint-independent-mapping ` **enhanced-user-tracking** **Description:** enhanced-user-tracking is a **JSON Block**. Please see below for :ref:`43_lsn_enhanced-user-tracking` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/enhanced-user-tracking ` **full-cone-session** **Description:** full-cone-session is a **JSON Block**. Please see below for :ref:`43_lsn_full-cone-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/full-cone-session ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_lsn_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/global ` **health-check-gateway-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/health-check-gateway/{ipv4-addr}+{ipv6-addr} ` **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`43_lsn_inside` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/inside ` **per-instance** **Description:** per-instance is a **JSON Block**. Please see below for :ref:`43_lsn_per-instance` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/per-instance ` **performance** **Description:** performance is a **JSON Block**. Please see below for :ref:`43_lsn_performance` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/performance ` **port-overloading** **Description:** port-overloading is a **JSON Block**. Please see below for :ref:`43_lsn_port-overloading` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading ` **port-reservation-entries** **Description:** port-reservation-entries is a **JSON Block**. Please see below for :ref:`43_lsn_port-reservation-entries` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-reservation-entries ` **port-reservation-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-reservation/{inside}+{inside-port-start}+{inside-port-end}+{nat}+{nat-port-start}+{nat-port-end} ` **radius** **Description:** radius is a **JSON Block**. Please see below for :ref:`43_lsn_radius` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/radius ` **stun-timeout** **Description:** stun-timeout is a **JSON Block**. Please see below for :ref:`43_lsn_stun-timeout` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/stun-timeout ` **system-status** **Description:** system-status is a **JSON Block**. Please see below for :ref:`43_lsn_system-status` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/system-status ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_lsn_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/tcp ` **user-quota-session** **Description:** user-quota-session is a **JSON Block**. Please see below for :ref:`43_lsn_user-quota-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/user-quota-session ` .. _43_lsn_all-sessions: lsn_all-sessions ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_radius: lsn_radius ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **server** **Description:** server is a **JSON Block**. Please see below for :ref:`43_lsn_radius_server` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/radius/server ` .. _43_lsn_radius_server: lsn_radius_server ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **accounting-interim-update** **Description** 'ignore': Ignore (default); 'append-entry': Append the AVPs to existing entry; 'replace-entry': Replace the AVPs of existing entry; **Type:** string **Supported Values:** ignore, append-entry, replace-entry **Default:** ignore **accounting-on** **Description** 'ignore': Ignore (default); 'delete-entries-using-attribute': Delete entries matching attribute in RADIUS Table; **Type:** string **Supported Values:** ignore, delete-entries-using-attribute **Default:** ignore **accounting-start** **Description** 'ignore': Ignore; 'append-entry': Append the AVPs to existing entry (default); 'replace-entry': Replace the AVPs of existing entry; **Type:** string **Supported Values:** ignore, append-entry, replace-entry **Default:** append-entry **accounting-stop** **Description** 'ignore': Ignore; 'delete-entry': Delete the entry (default); 'delete-entry-and-sessions': Delete the entry and data sessions associated; **Type:** string **Supported Values:** ignore, delete-entry, delete-entry-and-sessions **Default:** delete-entry **attribute** **Type:** List **attribute-name** **Description** 'msisdn': Clear using MSISDN; 'imei': Clear using IMEI; 'imsi': Clear using IMSI; **Type:** string **Supported Values:** msisdn, imei, imsi **Mutual Exclusion:** attribute-name and custom-attribute-name are mutually exclusive **custom-attribute-name** **Description** Clear using customized attribute **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** custom-attribute-name and attribute-name are mutually exclusive **disable-reply** **Description** Toggle option for RADIUS reply packet(Default: Accounting response will be sent) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **listen-port** **Description** Configure the listen port of RADIUS server (Port number) **Type:** number **Range:** 1024-65535 **remote** **Description:** remote is a **JSON Block**. Please see below for :ref:`43_lsn_radius_server_remote` **Type:** Object **secret** **Description** Configure shared secret **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **secret-string** **Description** The RADIUS secret **Type:** string **Format:** password **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** Join a VRRP-A failover group **Type:** number **Range:** 1-31 .. _43_lsn_radius_server_remote: lsn_radius_server_remote ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-list** **Type:** List .. _43_lsn_radius_server_remote_ip-list: lsn_radius_server_remote_ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-list-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **ip-list-name** **Description** IP-list name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ip-list-secret** **Description** Configure shared secret **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-list-secret-string** **Description** The RADIUS secret **Type:** string **Format:** password **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _43_lsn_radius_server_attribute: lsn_radius_server_attribute ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **attribute-value** **Description** 'inside-ipv6-prefix': Framed IPv6 Prefix; 'inside-ip': Inside IP address; 'inside-ipv6': Inside IPv6 address; 'imei': International Mobile Equipment Identity (IMEI); 'imsi': International Mobile Subscriber Identity (IMSI); 'msisdn': Mobile Subscriber Integrated Services Digital Network-Number (MSISDN); 'custom1': Customized attribute 1; 'custom2': Customized attribute 2; 'custom3': Customized attribute 3; 'custom4': Customized attribute 4; 'custom5': Customized attribute 5; 'custom6': Customized attribute 6; **Type:** string **Supported Values:** inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6 **custom-number** **Description** RADIUS attribute number **Type:** number **Range:** 1-255 **custom-vendor** **Description** RADIUS vendor attribute information (RADIUS vendor ID) **Type:** number **Range:** 1-65535 **name** **Description** Customized attribute name **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **number** **Description** RADIUS attribute number **Type:** number **Range:** 1-255 **prefix-length** **Description** '32': Prefix length 32; '48': Prefix length 48; '64': Prefix length 64; '80': Prefix length 80; '96': Prefix length 96; '112': Prefix length 112; **Type:** string **Supported Values:** 32, 48, 64, 80, 96, 112 **prefix-number** **Description** RADIUS attribute number **Type:** number **Range:** 1-255 **prefix-vendor** **Description** RADIUS vendor attribute information (RADIUS vendor ID) **Type:** number **Range:** 1-65535 **value** **Description** 'hexadecimal': Type of attribute value is hexadecimal; **Type:** string **Supported Values:** hexadecimal **vendor** **Description** RADIUS vendor attribute information (RADIUS vendor ID) **Type:** number **Range:** 1-65535 .. _43_lsn_endpoint-independent-mapping: lsn_endpoint-independent-mapping ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_lsn_endpoint-independent-mapping_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/endpoint-independent-mapping/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`43_lsn_endpoint-independent-mapping_udp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/endpoint-independent-mapping/udp ` .. _43_lsn_endpoint-independent-mapping_udp: lsn_endpoint-independent-mapping_udp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_endpoint-independent-mapping_udp_port-list: lsn_endpoint-independent-mapping_udp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_lsn_endpoint-independent-mapping_tcp: lsn_endpoint-independent-mapping_tcp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_endpoint-independent-mapping_tcp_port-list: lsn_endpoint-independent-mapping_tcp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_lsn_port-overloading: lsn_port-overloading ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_lsn_port-overloading_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/global ` **port-overloading-status** **Description:** port-overloading-status is a **JSON Block**. Please see below for :ref:`43_lsn_port-overloading_port-overloading-status` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/port-overloading-status ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_lsn_port-overloading_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`43_lsn_port-overloading_udp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/port-overloading/udp ` .. _43_lsn_port-overloading_port-overloading-status: lsn_port-overloading_port-overloading-status ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_port-overloading_udp: lsn_port-overloading_udp ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_port-overloading_udp_port-list: lsn_port-overloading_udp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_lsn_port-overloading_global: lsn_port-overloading_global ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **allow-different-user** **Description** Allow different users to overload the same port (default: disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **unique** **Description** 'destination-address': Allow overloading when the destination addresses is unique; 'destination-address-and-port': Allow overloading when the destination address and port 2-tuple is unique (default); **Type:** string **Supported Values:** destination-address, destination-address-and-port **Default:** destination-address-and-port **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_port-overloading_tcp: lsn_port-overloading_tcp ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_port-overloading_tcp_port-list: lsn_port-overloading_tcp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_lsn_system-status: lsn_system-status ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_health-check-gateway-list: lsn_health-check-gateway-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-addr** **Description** Specify IPv4 Gateway **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** Specify IPv6 Gateway **Type:** string **Format:** ipv6-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg: lsn_alg ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **esp** **Description:** esp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_esp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/esp ` **ftp** **Description:** ftp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_ftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/ftp ` **h323** **Description:** h323 is a **JSON Block**. Please see below for :ref:`43_lsn_alg_h323` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/h323 ` **mgcp** **Description:** mgcp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_mgcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/mgcp ` **pptp** **Description:** pptp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_pptp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/pptp ` **rtp** **Description:** rtp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_rtp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/rtp ` **rtsp** **Description:** rtsp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_rtsp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/rtsp ` **sip** **Description:** sip is a **JSON Block**. Please see below for :ref:`43_lsn_alg_sip` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/sip ` **tftp** **Description:** tftp is a **JSON Block**. Please see below for :ref:`43_lsn_alg_tftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/alg/tftp ` .. _43_lsn_alg_ftp: lsn_alg_ftp ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp-value** **Description** 'disable': Disable FTP ALG for LSN; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_sip: lsn_alg_sip ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtp-stun-timeout** **Description** RTP/RTCP STUN timeout in minutes (Default is 5 minutes) **Type:** number **Range:** 2-10 **Default:** 5 **sip-value** **Description** 'enable': Enable SIP ALG for LSN; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_esp: lsn_alg_esp ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **esp-value** **Description** 'enable': Enable ESP ALG for LSN; 'enable-with-ctrl': Enable ESP ALG for LSN with control session; **Type:** string **Supported Values:** enable, enable-with-ctrl **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_pptp: lsn_alg_pptp ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **pptp-value** **Description** 'enable': Enable PPTP ALG for LSN; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_rtsp: lsn_alg_rtsp ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtsp-value** **Description** 'enable': Enable RTSP ALG for LSN; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_h323: lsn_alg_h323 ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **h323-value** **Description** 'enable': Enable H323 ALG for LSN; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_rtp: lsn_alg_rtp ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtp-stun-timeout** **Description** RTP/RTCP STUN timeout (default: 5 minutes)} **Type:** number **Range:** 2-10 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_tftp: lsn_alg_tftp ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tftp-value** **Description** 'enable': Enable TFTP ALG for LSN; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_alg_mgcp: lsn_alg_mgcp ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mgcp-value** **Description** 'enable': Enable MGCP ALG for LSN; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_inside: lsn_inside ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **source** **Description:** source is a **JSON Block**. Please see below for :ref:`43_lsn_inside_source` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/inside/source ` .. _43_lsn_inside_source: lsn_inside_source ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **class-list** **Description** Class List (Class List 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 .. _43_lsn_global: lsn_global ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **attempt-port-preservation** **Description** 'disable': Don't attempt port preservation for NAT allocation; **Type:** string **Supported Values:** disable **enhanced-user-tracking** **Description** Enable enhanced user tracking and visibility (default: disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hairpinning** **Description** 'filter-none': Allow self-hairpinning (default). Warning: Only applies to UDP. TCP will use filter-self-ip-port; 'filter-self-ip': Block hairpinning to the user's own IP; 'filter-self-ip-port': Block hairpinning to the user's same IP and port combination; **Type:** string **Supported Values:** filter-none, filter-self-ip, filter-self-ip-port **Default:** filter-none **half-close-timeout** **Description** Set LSN Half close timeout (Half close timeout in seconds (default not set)) **Type:** number **Range:** 2-3000 **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`43_lsn_global_icmp` **Type:** Object **inbound-refresh** **Description** 'disable': Disable NAT Inbound Refresh Behavior; **Type:** string **Supported Values:** disable **ip-selection** **Description** 'random': Random (long-run uniformly distributed) NAT IP selection (default); 'round-robin': Round-robin; 'least-used-strict': Fewest NAT ports used; 'least-udp-used-strict': Fewest UDP NAT ports used; 'least-tcp-used-strict': Fewest TCP NAT ports used; 'least-reserved-strict': Fewest NAT ports reserved; 'least-udp-reserved-strict': Fewest UDP NAT ports reserved; 'least-tcp-reserved-strict': Fewest TCP NAT ports reserved; 'least-users-strict': Fewest number of users; **Type:** string **Supported Values:** random, round-robin, least-used-strict, least-udp-used-strict, least-tcp-used-strict, least-reserved-strict, least-udp-reserved-strict, least-tcp-reserved-strict, least-users-strict **Default:** random **logging** **Description:** logging is a **JSON Block**. Please see below for :ref:`43_lsn_global_logging` **Type:** Object **port-batching** **Description:** port-batching is a **JSON Block**. Please see below for :ref:`43_lsn_global_port-batching` **Type:** Object **strictly-sticky-nat** **Description** Strictly adheres to sticky-nat (default: disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **syn-timeout** **Description** Set LSN SYN timeout (SYN idle-timeout in seconds (default: 4 seconds)) **Type:** number **Range:** 2-30 **Default:** 4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_global_icmp: lsn_global_icmp ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **send-on-port-unavailable** **Description** 'host-unreachable': Send ICMP destination host unreachable; 'admin-filtered': Send ICMP admin filtered; 'disable': Disable ICMP port unavailable message (default); **Type:** string **Supported Values:** host-unreachable, admin-filtered, disable **Default:** disable **send-on-user-quota-exceeded** **Description** 'host-unreachable': Send ICMP destination host unreachable; 'admin-filtered': Send ICMP admin filtered (default); 'disable': Disable ICMP quota exceeded message; **Type:** string **Supported Values:** host-unreachable, admin-filtered, disable **Default:** admin-filtered .. _43_lsn_global_logging: lsn_global_logging ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **default-template** **Description** Bind the default NAT logging template for LSN (Bind a NAT logging template) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging ` **partition-name** **Description** Select partition name for logging **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **Mutual Exclusion:** partition-name and shared are mutually exclusive **Refernce Object:** :doc:`/axapi/v3/partition ` **pool** **Type:** List **shared** **Description** Select shared partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** shared and partition-name are mutually exclusive .. _43_lsn_global_logging_pool: lsn_global_logging_pool ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **pool-name** **Description** NAT pool **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/pool ` **template** **Description** Bind a NAT logging template **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging ` .. _43_lsn_global_port-batching: lsn_global_port-batching ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **size** **Description** '1': Allocate 1 port at a time (default); '8': Allocate 8 ports at a time; '16': Allocate 16 ports at a time; '32': Allocate 32 ports at a time; '64': Allocate 64 ports at a time; '128': Allocate 128 ports at a time; '256': Allocate 256 ports at a time; '512': Allocate 512 ports at a time; **Type:** string **Supported Values:** 1, 8, 16, 32, 64, 128, 256, 512 **Default:** 1 **tcp-time-wait-interval** **Description** Minutes before TCP NAT ports can be reused (default: 2) **Type:** number **Range:** 0-10 **Default:** 2 .. _43_lsn_tcp: lsn_tcp ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mss-clamp** **Description:** mss-clamp is a **JSON Block**. Please see below for :ref:`43_lsn_tcp_mss-clamp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/tcp/mss-clamp ` **reset-on-error** **Description:** reset-on-error is a **JSON Block**. Please see below for :ref:`43_lsn_tcp_reset-on-error` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/tcp/reset-on-error ` .. _43_lsn_tcp_mss-clamp: lsn_tcp_mss-clamp ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: ((576 - 60 - 60)))) **Type:** number **Range:** 0-1460 **Default:** 456 **mss-clamp-type** **Description** 'fixed': Specify a fixed max value for the TCP MSS; 'subtract': Specify the value to subtract from the TCP MSS; 'none': No TCP MSS clamping (default); **Type:** string **Supported Values:** fixed, subtract, none **Default:** none **mss-subtract** **Description** Specify the value to subtract from the TCP MSS (default: not configured) **Type:** number **Range:** 0-1460 **mss-value** **Description** The max value allowed for the TCP MSS (default: not configured)}, **Type:** number **Range:** 0-1460 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_tcp_reset-on-error: lsn_tcp_reset-on-error ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **outbound** **Description** 'disable': Disable send TCP reset on error; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_data-sessions: lsn_data-sessions ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_full-cone-session: lsn_full-cone-session ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_port-reservation-list: lsn_port-reservation-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **inside** **Description** Inside User Address and Port Range (Inside User IP address) **Type:** string **Format:** ipv4-address **inside-port-end** **Description** Inside End Port **Type:** number **Range:** 1-65535 **inside-port-start** **Description** Inside Start Port **Type:** number **Range:** 1-65535 **nat** **Description** NAT IP address **Type:** string **Format:** ipv4-address **nat-port-end** **Description** NAT End Port **Type:** number **Range:** 1-65535 **nat-port-start** **Description** NAT Start Port **Type:** number **Range:** 1-65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_stun-timeout: lsn_stun-timeout ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/stun-timeout/tcp/{port-start}+{port-end} ` **udp-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/stun-timeout/udp/{port-start}+{port-end} ` .. _43_lsn_stun-timeout_udp-list: lsn_stun-timeout_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port-end** **Description** Port Range (Port Range End) **Type:** number **Range:** 1-65535 **port-start** **Description** Port Range (Port Range Start) **Type:** number **Range:** 1-65535 **timeout** **Description** STUN timeout in minutes (default: 2 minutes) **Type:** number **Range:** 0-60 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_stun-timeout_tcp-list: lsn_stun-timeout_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port-end** **Description** Port Range (Port Range End) **Type:** number **Range:** 1-65535 **port-start** **Description** Port Range (Port Range Start) **Type:** number **Range:** 1-65535 **timeout** **Description** STUN timeout in minutes (default: 2 minutes) **Type:** number **Range:** 0-60 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_user-quota-session: lsn_user-quota-session ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_performance: lsn_performance ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_enhanced-user-tracking: lsn_enhanced-user-tracking ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_port-reservation-entries: lsn_port-reservation-entries ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_endpoint-independent-filtering: lsn_endpoint-independent-filtering ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_lsn_endpoint-independent-filtering_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/endpoint-independent-filtering/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`43_lsn_endpoint-independent-filtering_udp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn/endpoint-independent-filtering/udp ` .. _43_lsn_endpoint-independent-filtering_udp: lsn_endpoint-independent-filtering_udp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **session-limit** **Description** Limit number of EIF sessions that can be created per port **Type:** number **Range:** 1-65535 **Default:** 65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_endpoint-independent-filtering_udp_port-list: lsn_endpoint-independent-filtering_udp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_lsn_endpoint-independent-filtering_tcp: lsn_endpoint-independent-filtering_tcp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **session-limit** **Description** Limit number of EIF sessions that can be created per port **Type:** number **Range:** 1-65535 **Default:** 65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn_endpoint-independent-filtering_tcp_port-list: lsn_endpoint-independent-filtering_tcp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_lsn_per-instance: lsn_per-instance ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_global: global ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ping-sweep-detection** **Description** 'enable': Enable ping sweep detection; 'disable': Disable ping sweep detection(default); **Type:** string **Supported Values:** enable, disable **Default:** disable **port-scan-detection** **Description** 'enable': Enable port scan detection; 'disable': Disable port scan detection(default); **Type:** string **Supported Values:** enable, disable **Default:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_translation: translation ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp-timeout** **Description:** icmp-timeout is a **JSON Block**. Please see below for :ref:`43_translation_icmp-timeout` **Type:** Object **service-timeout-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/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 .. _43_translation_service-timeout-list: translation_service-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fast** **Description** Use Fast Aging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fast and timeout-val are mutually exclusive **port** **Description** Port Number **Type:** number **Range:** 1-65535 **port-end** **Description** End Port Number **Type:** number **Range:** 1-65535 **service-type** **Description** 'tcp': TCP Protocol; 'udp': UDP Protocol; **Type:** string **Supported Values:** tcp, udp **timeout-val** **Description** Timeout in seconds (Interval of 60 seconds) **Type:** number **Range:** 2-15000 **Mutual Exclusion:** timeout-val and fast are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_translation_icmp-timeout: translation_icmp-timeout ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **fast** **Description** Use Fast Aging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fast and icmp-timeout-val are mutually exclusive **icmp-timeout-val** **Description** Timeout in seconds (Interval of 60 seconds) **Type:** number **Range:** 2-15000 **Mutual Exclusion:** icmp-timeout-val and fast are mutually exclusive .. _43_icmp: icmp ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_port-batch-v1: port-batch-v1 ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable-port-batch-v1** **Description** Enable lsn port-batching v1 (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 .. _43_pcp: pcp ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **default-template** **Description** Bind the default template for PCP (Bind a PCP template) **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 .. _43_fixed-nat: fixed-nat ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **alg** **Description:** alg is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg ` **disable** **Description:** disable is a **JSON Block**. Please see below for :ref:`43_fixed-nat_disable` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/disable ` **disabled-config** **Description:** disabled-config is a **JSON Block**. Please see below for :ref:`43_fixed-nat_disabled-config` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/disabled-config ` **full-cone-session** **Description:** full-cone-session is a **JSON Block**. Please see below for :ref:`43_fixed-nat_full-cone-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/full-cone-session ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_fixed-nat_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/global ` **histogram** **Description:** histogram is a **JSON Block**. Please see below for :ref:`43_fixed-nat_histogram` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/histogram ` **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/inside ` **per-instance** **Description:** per-instance is a **JSON Block**. Please see below for :ref:`43_fixed-nat_per-instance` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/per-instance ` **port-mapping** **Description:** port-mapping is a **JSON Block**. Please see below for :ref:`43_fixed-nat_port-mapping` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/port-mapping ` **port-mapping-files** **Description:** port-mapping-files is a **JSON Block**. Please see below for :ref:`43_fixed-nat_port-mapping-files` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/port-mapping-files ` **user-quota** **Description:** user-quota is a **JSON Block**. Please see below for :ref:`43_fixed-nat_user-quota` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/user-quota ` .. _43_fixed-nat_port-mapping: fixed-nat_port-mapping ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_full-cone-session: fixed-nat_full-cone-session ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg: fixed-nat_alg ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **esp** **Description:** esp is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_esp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/esp ` **ftp** **Description:** ftp is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_ftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/ftp ` **h323** **Description:** h323 is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_h323` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/h323 ` **mgcp** **Description:** mgcp is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_mgcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/mgcp ` **pptp** **Description:** pptp is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_pptp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/pptp ` **rtsp** **Description:** rtsp is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_rtsp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/rtsp ` **sip** **Description:** sip is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_sip` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/sip ` **tftp** **Description:** tftp is a **JSON Block**. Please see below for :ref:`43_fixed-nat_alg_tftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/alg/tftp ` .. _43_fixed-nat_alg_ftp: fixed-nat_alg_ftp ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_sip: fixed-nat_alg_sip ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_esp: fixed-nat_alg_esp ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_pptp: fixed-nat_alg_pptp ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_rtsp: fixed-nat_alg_rtsp ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_h323: fixed-nat_alg_h323 ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_tftp: fixed-nat_alg_tftp ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_alg_mgcp: fixed-nat_alg_mgcp ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_inside: fixed-nat_inside ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **iplist-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/inside/iplist/{inside-ip-list}+{partition} ` **ipv4address-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/inside/ipv4address/{inside-start-address}+{inside-end-address}+{inside-netmask}+{partition} ` **ipv6address-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/fixed-nat/inside/ipv6address/{inside-start-address}+{inside-end-address}+{inside-netmask}+{partition} ` .. _43_fixed-nat_inside_iplist-list: fixed-nat_inside_iplist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dest-rule-list** **Description** Bind destination based Rule-List (Fixed NAT Rule-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dynamic-pool-size** **Description** Configure size of Dynamic pool (Default: 0) **Type:** number **Range:** 0-64511 **Default:** 0 **inside-ip-list** **Description** Name of IP List used to specify Inside Users **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **method** **Description** 'use-all-nat-ips': Use all the NAT IP addresses configured; 'use-least-nat-ips': Use the least number of NAT IP addresses required (default); **Type:** string **Supported Values:** use-all-nat-ips, use-least-nat-ips **Default:** use-least-nat-ips **nat-end-address** **Description** IPv4 End NAT Address **Type:** string **Format:** ipv4-address **nat-ip-list** **Description** Name of IP List used to specify NAT addresses **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **nat-netmask** **Description** NAT Addresses IP Netmask **Type:** string **Format:** ipv4-netmask-brief **nat-start-address** **Description** Start NAT Address **Type:** string **Format:** ipv4-address **offset** **Description:** offset is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside_iplist-list_offset` **Type:** Object **partition** **Description** Inside User Partition (Partition Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ports-per-user** **Description** Configure Ports per Inside User (ports-per-user) **Type:** number **Range:** 1-64512 **respond-to-user-mac** **Description** Use the user's source MAC for the next hop rather than the routing table (Default: off) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **session-quota** **Description** Configure per user quota on sessions **Type:** number **Range:** 1-2147483647 **skip-ports-on-rollover** **Description** Not using the first block of ports for NAT IPs smaller than the configured offset **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **usable-nat-ports** **Description:** usable-nat-ports is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside_iplist-list_usable-nat-ports` **Type:** Object **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 .. _43_fixed-nat_inside_iplist-list_usable-nat-ports: fixed-nat_inside_iplist-list_usable-nat-ports ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **usable-end-port** **Description** End Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 **usable-start-port** **Description** Start Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 .. _43_fixed-nat_inside_iplist-list_offset: fixed-nat_inside_iplist-list_offset ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **numeric-offset** **Description** Configure a numeric offset to the first NAT IP address **Type:** number **Range:** 0-1024000 **Default:** 0 **Mutual Exclusion:** numeric-offset and random are mutually exclusive **random** **Description** Randomly choose the first NAT IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** random and numeric-offset are mutually exclusive .. _43_fixed-nat_inside_ipv4address-list: fixed-nat_inside_ipv4address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dest-rule-list** **Description** Bind destination based Rule-List (Fixed NAT Rule-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dynamic-pool-size** **Description** Configure size of Dynamic pool (Default: 0) **Type:** number **Range:** 0-64511 **Default:** 0 **inside-end-address** **Description** IPv4 Inside User End Address **Type:** string **Format:** ipv4-address **inside-netmask** **Description** IPv4 Netmask **Type:** string **Format:** ipv4-netmask-brief **inside-start-address** **Description** IPv4 Inside User Start Address **Type:** string **Format:** ipv4-address **method** **Description** 'use-all-nat-ips': Use all the NAT IP addresses configured; 'use-least-nat-ips': Use the least number of NAT IP addresses required (default); **Type:** string **Supported Values:** use-all-nat-ips, use-least-nat-ips **Default:** use-least-nat-ips **nat-end-address** **Description** IPv4 End NAT Address **Type:** string **Format:** ipv4-address **nat-ip-list** **Description** Name of IP List used to specify NAT addresses **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **nat-netmask** **Description** NAT Addresses IP Netmask **Type:** string **Format:** ipv4-netmask-brief **nat-start-address** **Description** Start NAT Address **Type:** string **Format:** ipv4-address **offset** **Description:** offset is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside_ipv4address-list_offset` **Type:** Object **partition** **Description** Inside User Partition (Partition Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ports-per-user** **Description** Configure Ports per Inside User (ports-per-user) **Type:** number **Range:** 1-64512 **respond-to-user-mac** **Description** Use the user's source MAC for the next hop rather than the routing table (Default: off) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **session-quota** **Description** Configure per user quota on sessions **Type:** number **Range:** 1-2147483647 **skip-ports-on-rollover** **Description** Not using the first block of ports for NAT IPs smaller than the configured offset **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **usable-nat-ports** **Description:** usable-nat-ports is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside_ipv4address-list_usable-nat-ports` **Type:** Object **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 .. _43_fixed-nat_inside_ipv4address-list_usable-nat-ports: fixed-nat_inside_ipv4address-list_usable-nat-ports ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **usable-end-port** **Description** End Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 **usable-start-port** **Description** Start Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 .. _43_fixed-nat_inside_ipv4address-list_offset: fixed-nat_inside_ipv4address-list_offset ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **numeric-offset** **Description** Configure a numeric offset to the first NAT IP address **Type:** number **Range:** 0-1024000 **Default:** 0 **Mutual Exclusion:** numeric-offset and random are mutually exclusive **random** **Description** Randomly choose the first NAT IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** random and numeric-offset are mutually exclusive .. _43_fixed-nat_inside_ipv6address-list: fixed-nat_inside_ipv6address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dest-rule-list** **Description** Bind destination based Rule-List (Fixed NAT Rule-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **dynamic-pool-size** **Description** Configure size of Dynamic pool (Default: 0) **Type:** number **Range:** 0-64511 **Default:** 0 **inside-end-address** **Description** IPv6 Inside User End Address **Type:** string **Format:** ipv6-address **inside-netmask** **Description** Inside User IPv6 Netmask **Type:** number **Range:** 64-128 **inside-start-address** **Description** IPv6 Inside User Start Address **Type:** string **Format:** ipv6-address **method** **Description** 'use-all-nat-ips': Use all the NAT IP addresses configured; 'use-least-nat-ips': Use the least number of NAT IP addresses required (default); **Type:** string **Supported Values:** use-all-nat-ips, use-least-nat-ips **Default:** use-least-nat-ips **nat-end-address** **Description** IPv4 End NAT Address **Type:** string **Format:** ipv4-address **nat-ip-list** **Description** Name of IP List used to specify NAT addresses **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **nat-netmask** **Description** NAT Addresses IP Netmask **Type:** string **Format:** ipv4-netmask-brief **nat-start-address** **Description** Start NAT Address **Type:** string **Format:** ipv4-address **offset** **Description:** offset is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside_ipv6address-list_offset` **Type:** Object **partition** **Description** Inside User Partition (Partition Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ports-per-user** **Description** Configure Ports per Inside User (ports-per-user) **Type:** number **Range:** 1-64512 **respond-to-user-mac** **Description** Use the user's source MAC for the next hop rather than the routing table (Default: off) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **session-quota** **Description** Configure per user quota on sessions **Type:** number **Range:** 1-2147483647 **skip-ports-on-rollover** **Description** Not using the first block of ports for NAT IPs smaller than the configured offset **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **usable-nat-ports** **Description:** usable-nat-ports is a **JSON Block**. Please see below for :ref:`43_fixed-nat_inside_ipv6address-list_usable-nat-ports` **Type:** Object **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 .. _43_fixed-nat_inside_ipv6address-list_usable-nat-ports: fixed-nat_inside_ipv6address-list_usable-nat-ports ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **usable-end-port** **Description** End Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 **usable-start-port** **Description** Start Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 .. _43_fixed-nat_inside_ipv6address-list_offset: fixed-nat_inside_ipv6address-list_offset ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **numeric-offset** **Description** Configure a numeric offset to the first NAT IP address **Type:** number **Range:** 0-1024000 **Default:** 0 **Mutual Exclusion:** numeric-offset and random are mutually exclusive **random** **Description** Randomly choose the first NAT IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** random and numeric-offset are mutually exclusive .. _43_fixed-nat_global: fixed-nat_global ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **create-port-mapping-file** **Description** Create Port Mapping File **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **port-mapping-files-count** **Description** Number of old fixed_nat files to store **Type:** number **Range:** 1-10 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_user-quota: fixed-nat_user-quota ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_histogram: fixed-nat_histogram ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_disabled-config: fixed-nat_disabled-config ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_disable: fixed-nat_disable ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **clear-session** **Description** Clear all sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inside-end-v4address** **Description** IPv4 Inside User End Address **Type:** string **Format:** ipv4-address **inside-end-v6address** **Description** IPv6 Inside User End Address **Type:** string **Format:** ipv6-address **inside-start-v4address** **Description** IPv4 Inside User Start Address **Type:** string **Format:** ipv4-address **inside-start-v6address** **Description** IPv6 Inside User Start Address **Type:** string **Format:** ipv6-address **ip-list** **Description** Name of IP List used to specify Inside Users **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **partition** **Description** Inside User Partition (Partition Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **v4-netmask** **Description** IPv4 Netmask **Type:** string **Format:** ipv4-netmask-brief **v6-netmask** **Description** Inside User IPv6 Netmask **Type:** number **Range:** 64-128 .. _43_fixed-nat_port-mapping-files: fixed-nat_port-mapping-files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_fixed-nat_per-instance: fixed-nat_per-instance ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall: stateful-firewall ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **alg** **Description:** alg is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg ` **endpoint-independent-filtering** **Description:** endpoint-independent-filtering is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_endpoint-independent-filtering` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/endpoint-independent-filtering ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/global ` **stun-timeout-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/stun-timeout/{port}+{port-end} ` **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_udp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/udp ` **vrid** **Description:** vrid is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_vrid` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/vrid ` .. _43_stateful-firewall_udp: stateful-firewall_udp ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **idle-timeout-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/udp/idle-timeout/{port}+{port-end} ` **stun-timeout-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/udp/stun-timeout/{port}+{port-end} ` .. _43_stateful-firewall_udp_stun-timeout-list: stateful-firewall_udp_stun-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **Range:** 1-65535 **port-end** **Description** Port Range End **Type:** number **Range:** 1-65535 **stun-timeout-val-port-range** **Description** STUN timeout (default: 2 minutes) **Type:** number **Range:** 0-60 **Default:** 2 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_udp_idle-timeout-list: stateful-firewall_udp_idle-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fast** **Description** Fast aging for idle sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** fast and idle-timeout-val-port-range are mutually exclusive **idle-timeout-val-port-range** **Description** Idle timeout for IPv4 and IPv6 TCP established sessions (Idle timeout for IPv4 and IPv6 TCP established sessions (default: 300 seconds)) **Type:** number **Range:** 60-15000 **Default:** 300 **Mutual Exclusion:** idle-timeout-val-port-range and fast are mutually exclusive **port** **Description** Single Destination Port or Port Range Start **Type:** number **Range:** 1-65535 **port-end** **Description** Port Range End **Type:** number **Range:** 1-65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_vrid: stateful-firewall_vrid ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vrid-value** **Description** Set VRRP-A vrid for stateful firewall (IPv4 and IPv6) **Type:** number **Range:** 1-31 .. _43_stateful-firewall_alg: stateful-firewall_alg ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp** **Description:** ftp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg_ftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg/ftp ` **pptp** **Description:** pptp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg_pptp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg/pptp ` **rtp** **Description:** rtp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg_rtp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg/rtp ` **rtsp** **Description:** rtsp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg_rtsp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg/rtsp ` **sip** **Description:** sip is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg_sip` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg/sip ` **tftp** **Description:** tftp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_alg_tftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/alg/tftp ` .. _43_stateful-firewall_alg_ftp: stateful-firewall_alg_ftp ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp-value** **Description** 'disable': Disable ALG; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_alg_sip: stateful-firewall_alg_sip ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sip-value** **Description** 'disable': Disable ALG; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_alg_pptp: stateful-firewall_alg_pptp ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **pptp-value** **Description** 'disable': Disable ALG; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_alg_rtsp: stateful-firewall_alg_rtsp ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtsp-value** **Description** 'disable': Disable ALG; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_alg_rtp: stateful-firewall_alg_rtp ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtp-stun-timeout** **Description** RTP/RTCP STUN timeout (default: 5 minutes)} **Type:** number **Range:** 2-10 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_alg_tftp: stateful-firewall_alg_tftp ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tftp-value** **Description** 'disable': Disable ALG; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_global: stateful-firewall_global ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **respond-to-user-mac** **Description** Use the user's source MAC for the next hop rather than the routing table (default: off) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **stateful-firewall-value** **Description** 'enable': Enable stateful firewall; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_tcp: stateful-firewall_tcp ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **idle-timeout-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/tcp/idle-timeout/{port}+{port-end} ` **stun-timeout-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/tcp/stun-timeout/{port}+{port-end} ` **syn-timeout** **Description:** syn-timeout is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_tcp_syn-timeout` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/tcp/syn-timeout ` .. _43_stateful-firewall_tcp_stun-timeout-list: stateful-firewall_tcp_stun-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **Range:** 1-65535 **port-end** **Description** Port Range End **Type:** number **Range:** 1-65535 **stun-timeout-val-port-range** **Description** STUN timeout (default: 2minutes) **Type:** number **Range:** 0-60 **Default:** 2 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_tcp_syn-timeout: stateful-firewall_tcp_syn-timeout ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **syn-timeout-val** **Description** Set Seconds session can remain in half-open state before being deleted (default: 4 seconds) **Type:** number **Range:** 2-30 **Default:** 4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_tcp_idle-timeout-list: stateful-firewall_tcp_idle-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **idle-timeout-val-port-range** **Description** Set Idle timeout for IPv4 and IPv6 TCP established sessions (Idle timeout for IPv4 and IPv6 TCP established sessions (default: 300 seconds)) **Type:** number **Range:** 60-15000 **Default:** 300 **port** **Description** Single Destination Port or Port Range Start **Type:** number **Range:** 1-65535 **port-end** **Description** Port Range End **Type:** number **Range:** 1-65535 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_stun-timeout-list: stateful-firewall_stun-timeout-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **Range:** 1-65535 **port-end** **Description** Port Range End **Type:** number **Range:** 1-65535 **stun-timeout-val-port-range** **Description** STUN timeout (default: 2 minutes) **Type:** number **Range:** 0-60 **Default:** 2 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_endpoint-independent-filtering: stateful-firewall_endpoint-independent-filtering ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_endpoint-independent-filtering_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/endpoint-independent-filtering/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`43_stateful-firewall_endpoint-independent-filtering_udp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/stateful-firewall/endpoint-independent-filtering/udp ` .. _43_stateful-firewall_endpoint-independent-filtering_udp: stateful-firewall_endpoint-independent-filtering_udp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_endpoint-independent-filtering_udp_port-list: stateful-firewall_endpoint-independent-filtering_udp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_stateful-firewall_endpoint-independent-filtering_tcp: stateful-firewall_endpoint-independent-filtering_tcp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_stateful-firewall_endpoint-independent-filtering_tcp_port-list: stateful-firewall_endpoint-independent-filtering_tcp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Destination Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_nat: nat ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **exclude-port** **Description:** exclude-port is a **JSON Block**. Please see below for :ref:`43_nat_exclude-port` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/exclude-port ` **histogram** **Description:** histogram is a **JSON Block**. Please see below for :ref:`43_nat_histogram` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/histogram ` **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`43_nat_icmp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/icmp ` **icmpv6** **Description:** icmpv6 is a **JSON Block**. Please see below for :ref:`43_nat_icmpv6` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/icmpv6 ` **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`43_nat_inside` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/inside ` **pool-group-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/pool-group/{pool-group-name} ` **pool-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/pool/{pool-name} ` **range-list-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/range-list/{name}+{partition} ` **shared-pool** **Description:** shared-pool is a **JSON Block**. Please see below for :ref:`43_nat_shared-pool` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/shared-pool ` **shared-pool-group** **Description:** shared-pool-group is a **JSON Block**. Please see below for :ref:`43_nat_shared-pool-group` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/shared-pool-group ` .. _43_nat_shared-pool: nat_shared-pool ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_shared-pool-group: nat_shared-pool-group ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **members** **Description:** members is a **JSON Block**. Please see below for :ref:`43_nat_shared-pool-group_members` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/shared-pool-group/members ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_shared-pool-group_members: nat_shared-pool-group_members ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_pool-group-list: nat_pool-group-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **member-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/pool-group/{pool-group-name}/member/{pool-name} ` **pool-group-name** **Description** Specify pool group name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vrid** **Description** Specify VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_nat_pool-group-list_member-list: nat_pool-group-list_member-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **pool-name** **Description** Specify CGNv6 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 .. _43_nat_histogram: nat_histogram ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **bin-count** **Description** Number of bins in the histogram (default: 50) **Type:** number **Range:** 10-100 **Default:** 50 **bin-skew** **Description** Percentage of bins that represent the upper bound (default: 75) **Type:** number **Range:** 50-80 **Default:** 75 **data-skew** **Description** Percentage of data that represents the upper bound (default: 25) **Type:** number **Range:** 5-50 **Default:** 25 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_icmpv6: nat_icmpv6 ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **respond-to-ping** **Description** Respond to ICMPv6 echo requests to NAT pool IPs (default: disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_range-list-list: nat_range-list-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 **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 **name** **Description** Name for this Static List **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **partition** **Description** Inside User Partition (Partition 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 **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 .. _43_nat_exclude-port: nat_exclude-port ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_nat_exclude-port_tcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/exclude-port/tcp ` **udp** **Description:** udp is a **JSON Block**. Please see below for :ref:`43_nat_exclude-port_udp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/exclude-port/udp ` .. _43_nat_exclude-port_udp: nat_exclude-port_udp ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_exclude-port_udp_port-list: nat_exclude-port_udp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_nat_exclude-port_tcp: nat_exclude-port_tcp ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **port-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_exclude-port_tcp_port-list: nat_exclude-port_tcp_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port** **Description** Single Port or Port Range Start **Type:** number **port-end** **Description** Port Range End **Type:** number .. _43_nat_icmp: nat_icmp ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _43_nat_inside: nat_inside ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **source** **Description:** source is a **JSON Block**. Please see below for :ref:`43_nat_inside_source` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/inside/source ` .. _43_nat_inside_source: nat_inside_source ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **static-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/inside/source/static/{src-address}+{partition} ` **statistics** **Description:** statistics is a **JSON Block**. Please see below for :ref:`43_nat_inside_source_statistics` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat/inside/source/statistics ` .. _43_nat_inside_source_statistics: nat_inside_source_statistics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat_inside_source_static-list: nat_inside_source_static-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nat-address** **Description** NAT Address **Type:** string **Format:** ipv4-address **partition** **Description** Inside User Partition (Partition Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 .. _43_nat_pool-list: nat_pool-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **all** **Description** Share with all partitions **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 **exclude-ip** **Type:** List **group** **Description** Share with a partition group (Partition Group Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **max-users-per-ip** **Description** Number of users that can be assigned to a NAT IP **Type:** number **Range:** 1-64512 **netmask** **Description** Configure mask for pool **Type:** string **Format:** ipv4-netmask-brief **partition** **Description** Share with a single partition (Partition Name) **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **per-batch-port-usage-warning-threshold** **Description** Configure warning log threshold for per batch port usage (default: disabled) (Number of ports) **Type:** number **Range:** 32-4096 **pool-name** **Description** Specify pool name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-batch-v2-size** **Description** '64': Allocate 64 ports at a time; '128': Allocate 128 ports at a time; '256': Allocate 256 ports at a time; '512': Allocate 512 ports at a time; '1024': Allocate 1024 ports at a time; '2048': Allocate 2048 ports at a time; '4096': Allocate 4096 ports at a time; **Type:** string **Supported Values:** 64, 128, 256, 512, 1024, 2048, 4096 **shared** **Description** Share this pool with other partitions (default: not shared) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **simultaneous-batch-allocation** **Description** Allocate same TCP and UDP batches at once **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-address** **Description** Configure start IP address of NAT pool **Type:** string **Format:** ipv4-address **tcp-time-wait-interval** **Description** Minutes before TCP NAT ports can be reused **Type:** number **Range:** 0-10 **usable-nat-ports** **Description** Configure usable NAT ports **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **usable-nat-ports-end** **Description** End Port of Usable NAT Ports **Type:** number **Range:** 1024-65535 **usable-nat-ports-start** **Description** Start Port of Usable NAT Ports (needs to be even) **Type:** number **Range:** 1024-65535 **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 .. _43_nat_pool-list_exclude-ip: nat_pool-list_exclude-ip ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **exclude-ip-end** **Description** Address range end **Type:** string **Format:** ipv4-address **exclude-ip-start** **Description** Single IP address or IP address range start **Type:** string **Format:** ipv4-address .. _43_sctp: sctp ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_sctp_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/global ` **permit-payload-protocol** **Description:** permit-payload-protocol is a **JSON Block**. Please see below for :ref:`43_sctp_permit-payload-protocol` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/permit-payload-protocol ` **rate-limit** **Description:** rate-limit is a **JSON Block**. Please see below for :ref:`43_sctp_rate-limit` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit ` **rate-limit-entries** **Description:** rate-limit-entries is a **JSON Block**. Please see below for :ref:`43_sctp_rate-limit-entries` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit-entries ` .. _43_sctp_rate-limit-entries: sctp_rate-limit-entries ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_sctp_global: sctp_global ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **half-open-timeout** **Description** Set SCTP half-open timeout (SCTP half-open timeout in seconds (default 4)) **Type:** number **Range:** 2-30 **Default:** 4 **idle-timeout** **Description** SCTP idle timeout in minutes (default 5) **Type:** number **Range:** 1-63 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_sctp_rate-limit: sctp_rate-limit ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **destination-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit/destination/{ip} ` **source-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/rate-limit/source/{ip} ` .. _43_sctp_rate-limit_source-list: sctp_rate-limit_source-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip** **Description** IP address **Type:** string **Format:** ipv4-address **rate-limit** **Description** Rate limit in packets per second **Type:** number **Range:** 1-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_sctp_rate-limit_destination-list: sctp_rate-limit_destination-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip** **Description** IP address **Type:** string **Format:** ipv4-address **rate-limit** **Description** Rate limit in packets per second **Type:** number **Range:** 1-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_sctp_permit-payload-protocol: sctp_permit-payload-protocol ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **protocol-id-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/permit-payload-protocol/protocol-id/{id} ` **protocol-name-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/sctp/permit-payload-protocol/protocol-name/{protocol} ` .. _43_sctp_permit-payload-protocol_protocol-id-list: sctp_permit-payload-protocol_protocol-id-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **id** **Description** Specify SCTP permitted payload protocol IDs **Type:** number **Range:** 1-63 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_sctp_permit-payload-protocol_protocol-name-list: sctp_permit-payload-protocol_protocol-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **protocol** **Description** 'iua': IUA; 'm2ua': M2UA; 'm3ua': M3UA; 'sua': SUA; 'm2pa': M2PA; 'h.323': H.323; **Type:** string **Supported Values:** iua, m2ua, m3ua, sua, m2pa, h.323 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_shared-service-group: shared-service-group ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_dns64: dns64 ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat46-stateless: nat46-stateless ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_nat46-stateless_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/fragmentation ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_nat46-stateless_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/global ` **partition-prefix-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/partition-prefix/{partition} ` **prefix** **Description:** prefix is a **JSON Block**. Please see below for :ref:`43_nat46-stateless_prefix` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/prefix ` **static-dest-mapping-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/static-dest-mapping/{v4-address}+{v6-address} ` .. _43_nat46-stateless_static-dest-mapping-list: nat46-stateless_static-dest-mapping-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **count** **Description** Set number of consecutive mappings (Number of mappings) **Type:** number **shared** **Description** Share/Expose this mapping with other partitions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **to-shared** **Description** Send NATed traffic through shared partition **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 **v4-address** **Description** IPv4 address **Type:** string **Format:** ipv4-address **v6-address** **Description** IPv6 address **Type:** string **Format:** ipv6-address **vrid** **Description** VRRP-A vrid (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 .. _43_nat46-stateless_fragmentation: nat46-stateless_fragmentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_nat46-stateless_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_nat46-stateless_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat46-stateless/fragmentation/outbound ` .. _43_nat46-stateless_fragmentation_inbound: nat46-stateless_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmpv6 **Default:** ipv4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat46-stateless_fragmentation_outbound: nat46-stateless_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 Fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv6 **Default:** ipv6 **count** **Description** Configure number of ICMP messages sent when DF set. Default is 1 **Type:** number **Range:** 1-5 **Default:** 1 **df-set** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 Fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); **Type:** string **Supported Values:** drop, ipv6, send-icmp **Default:** send-icmp **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat46-stateless_global: nat46-stateless_global ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat46-stateless_prefix: nat46-stateless_prefix ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv6-prefix** **Description** IPv6 prefix **Type:** string **Format:** ipv6-address-plen **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 .. _43_nat46-stateless_partition-prefix-list: nat46-stateless_partition-prefix-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-prefix** **Description** IPv6 prefix **Type:** string **Format:** ipv6-address-plen **partition** **Description** Partition Name **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **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 .. _43_map: map ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **encapsulation** **Description:** encapsulation is a **JSON Block**. Please see below for :ref:`43_map_encapsulation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation ` **translation** **Description:** translation is a **JSON Block**. Please see below for :ref:`43_map_translation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation ` .. _43_map_encapsulation: map_encapsulation ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **domain-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/domain/{name} ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_map_encapsulation_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/fragmentation ` .. _43_map_encapsulation_fragmentation: map_encapsulation_fragmentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_map_encapsulation_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_map_encapsulation_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/fragmentation/outbound ` .. _43_map_encapsulation_fragmentation_inbound: map_encapsulation_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-set** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'ipv6': Use IPv6 fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); **Type:** string **Supported Values:** drop, ipv4, ipv6, send-icmp **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'ipv6': Use IPv6 fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv4, ipv6 **Default:** ipv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_encapsulation_fragmentation_outbound: map_encapsulation_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-set** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set)(default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmp, send-icmpv6 **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmpv6 **Default:** ipv4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_encapsulation_domain-list: map_encapsulation_domain-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **basic-mapping-rule** **Description:** basic-mapping-rule is a **JSON Block**. Please see below for :ref:`43_map_encapsulation_domain-list_basic-mapping-rule` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule ` **description** **Description** MAP-E domain description **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **format** **Description** 'draft-03': Construct IPv6 Interface Identifier according to draft-03; **Type:** string **Supported Values:** draft-03 **health-check-gateway** **Description:** health-check-gateway is a **JSON Block**. Please see below for :ref:`43_map_encapsulation_domain-list_health-check-gateway` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/domain/{name}/health-check-gateway ` **name** **Description** MAP-E domain name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **tunnel-endpoint-address** **Description** Tunnel Endpoint Address for MAP-E domain **Type:** string **Format:** ipv6-address **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 .. _43_map_encapsulation_domain-list_basic-mapping-rule: map_encapsulation_domain-list_basic-mapping-rule ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ea-length** **Description** Length of Embedded Address (EA) bits **Type:** number **Range:** 0-23 **port-start** **Description** Starting Port, Must be Power of 2 value **Type:** number **Range:** 1-32768 **prefix-rule-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/encapsulation/domain/{name}/basic-mapping-rule/prefix-rule/{name} ` **rule-ipv4-address-port-settings** **Description** 'prefix-addr': Each CE is assigned an IPv4 prefix; 'single-addr': Each CE is assigned an IPv4 address; 'shared-addr': Each CE is assigned a shared IPv4 address; **Type:** string **Supported Values:** prefix-addr, single-addr, shared-addr **share-ratio** **Description** Port sharing ratio for each NAT IP. Must be Power of 2 value **Type:** number **Range:** 1-65536 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_encapsulation_domain-list_basic-mapping-rule_prefix-rule-list: map_encapsulation_domain-list_basic-mapping-rule_prefix-rule-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ea-length** **Description** Length of Embedded Address (EA) bits **Type:** number **Range:** 0-23 **ipv4-address-port-settings** **Description** 'prefix-addr': Each CE is assigned an IPv4 prefix; 'single-addr': Each CE is assigned an IPv4 address; 'shared-addr': Each CE is assigned a shared IPv4 address; **Type:** string **Supported Values:** prefix-addr, single-addr, shared-addr **ipv4-netmask** **Description** Subnet mask (subnet bigger than /8 is not allowed) **Type:** string **Format:** ipv4-netmask-brief **name** **Description** MAP BMR prefix rule name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-start** **Description** Starting Port, Must be Power of 2 value **Type:** number **Range:** 1-32768 **rule-ipv4-prefix** **Description** IPv4 prefix of BMR **Type:** string **Format:** ipv4-address **rule-ipv6-prefix** **Description** IPv6 prefix of BMR **Type:** string **Format:** ipv6-address-plen **share-ratio** **Description** Port sharing ratio for each NAT IP. Must be Power of 2 value **Type:** number **Range:** 1-65536 **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 .. _43_map_encapsulation_domain-list_health-check-gateway: map_encapsulation_domain-list_health-check-gateway ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **address-list** **Type:** List **ipv6-address-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **withdraw-route** **Description** 'all-link-failure': Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; 'any-link-failure': Withdraw routes on health-check failure of any gateway (default); **Type:** string **Supported Values:** all-link-failure, any-link-failure **Default:** any-link-failure .. _43_map_encapsulation_domain-list_health-check-gateway_ipv6-address-list: map_encapsulation_domain-list_health-check-gateway_ipv6-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-gateway** **Description** IPv6 Gateway **Type:** string **Format:** ipv6-address .. _43_map_encapsulation_domain-list_health-check-gateway_address-list: map_encapsulation_domain-list_health-check-gateway_address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-gateway** **Description** IPv4 Gateway **Type:** string **Format:** ipv4-address .. _43_map_translation: map_translation ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **default-domain** **Description:** default-domain is a **JSON Block**. Please see below for :ref:`43_map_translation_default-domain` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/default-domain ` **domain-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name} ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_map_translation_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/fragmentation ` .. _43_map_translation_fragmentation: map_translation_fragmentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_map_translation_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_map_translation_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/fragmentation/outbound ` .. _43_map_translation_fragmentation_inbound: map_translation_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-set** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); **Type:** string **Supported Values:** drop, ipv6, send-icmp **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv6 **Default:** ipv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_translation_fragmentation_outbound: map_translation_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmpv6 **Default:** ipv4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_translation_domain-list: map_translation_domain-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **basic-mapping-rule** **Description:** basic-mapping-rule is a **JSON Block**. Please see below for :ref:`43_map_translation_domain-list_basic-mapping-rule` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule ` **default-mapping-rule** **Description:** default-mapping-rule is a **JSON Block**. Please see below for :ref:`43_map_translation_domain-list_default-mapping-rule` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/default-mapping-rule ` **description** **Description** MAP-T domain description **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **health-check-gateway** **Description:** health-check-gateway is a **JSON Block**. Please see below for :ref:`43_map_translation_domain-list_health-check-gateway` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/health-check-gateway ` **mtu** **Description** Domain MTU **Type:** number **name** **Description** MAP-T domain name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_map_translation_domain-list_tcp` **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 .. _43_map_translation_domain-list_default-mapping-rule: map_translation_domain-list_default-mapping-rule ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rule-ipv6-prefix** **Description** Rule IPv6 prefix **Type:** string **Format:** ipv6-address-plen **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_translation_domain-list_tcp: map_translation_domain-list_tcp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mss-clamp** **Description:** mss-clamp is a **JSON Block**. Please see below for :ref:`43_map_translation_domain-list_tcp_mss-clamp` **Type:** Object .. _43_map_translation_domain-list_tcp_mss-clamp: map_translation_domain-list_tcp_mss-clamp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: 516)) **Type:** number **Range:** 0-1440 **Default:** 516 **mss-clamp-type** **Description** 'fixed': Specify a fixed max value for the TCP MSS; 'none': No TCP MSS clamping(default); 'subtract': Specify the value to subtract from the TCP MSS; **Type:** string **Supported Values:** fixed, none, subtract **Default:** none **mss-subtract** **Description** Specify the value to subtract from the TCP MSS **Type:** number **Range:** 0-1440 **mss-value** **Description** The max value allowed for the TCP MSS **Type:** number **Range:** 0-1440 .. _43_map_translation_domain-list_health-check-gateway: map_translation_domain-list_health-check-gateway ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **address-list** **Type:** List **ipv6-address-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **withdraw-route** **Description** 'all-link-failure': Withdraw routes on health-check failure of all IPv4 gateways or all IPv6 gateways; 'any-link-failure': Withdraw routes on health-check failure of any gateway (default); **Type:** string **Supported Values:** all-link-failure, any-link-failure **Default:** any-link-failure .. _43_map_translation_domain-list_health-check-gateway_ipv6-address-list: map_translation_domain-list_health-check-gateway_ipv6-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-gateway** **Description** IPv6 Gateway **Type:** string **Format:** ipv6-address .. _43_map_translation_domain-list_health-check-gateway_address-list: map_translation_domain-list_health-check-gateway_address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-gateway** **Description** IPv4 Gateway **Type:** string **Format:** ipv4-address .. _43_map_translation_domain-list_basic-mapping-rule: map_translation_domain-list_basic-mapping-rule ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ea-length** **Description** Length of Embedded Address (EA) bits **Type:** number **Range:** 0-23 **port-start** **Description** Starting Port, Must be Power of 2 value **Type:** number **Range:** 1-32768 **prefix-rule-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain/{name}/basic-mapping-rule/prefix-rule/{name} ` **rule-ipv4-address-port-settings** **Description** 'prefix-addr': Each CE is assigned an IPv4 prefix; 'single-addr': Each CE is assigned an IPv4 address; 'shared-addr': Each CE is assigned a shared IPv4 address; **Type:** string **Supported Values:** prefix-addr, single-addr, shared-addr **share-ratio** **Description** Port sharing ratio for each NAT IP. Must be Power of 2 value **Type:** number **Range:** 1-65536 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_map_translation_domain-list_basic-mapping-rule_prefix-rule-list: map_translation_domain-list_basic-mapping-rule_prefix-rule-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-netmask** **Description** Subnet mask (subnet bigger than /8 is not allowed) **Type:** string **Format:** ipv4-netmask-brief **name** **Description** MAP BMR prefix rule name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **rule-ipv4-prefix** **Description** IPv4 prefix of BMR **Type:** string **Format:** ipv4-address **rule-ipv6-prefix** **Description** IPv6 prefix of BMR **Type:** string **Format:** ipv6-address-plen **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 .. _43_map_translation_default-domain: map_translation_default-domain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** MAP-T domain name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/map/translation/domain ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_template: template ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dns-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name} ` **http-alg-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/http-alg/{name} ` **logging-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging/{name} ` **pcp-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/pcp/{name} ` **policy-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/policy/{name} ` .. _43_template_policy-list: template_policy-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`43_template_policy-list_class-list` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/policy/{name}/class-list ` **name** **Description** Policy template 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 .. _43_template_policy-list_class-list: template_policy-list_class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **client-ip-l3-dest** **Description** Use destination IP as client IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** client-ip-l3-dest and client-ip-l7-header are mutually exclusive **client-ip-l7-header** **Description** Use extract client IP address from L7 header **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** client-ip-l7-header and client-ip-l3-dest are mutually exclusive **header-name** **Description** Specify L7 header name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **lid-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/policy/{name}/class-list/lid/{lidnum} ` **name** **Description** Class list 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 .. _43_template_policy-list_class-list_lid-list: template_policy-list_class-list_lid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-value** **Description** 'forward': Forward the traffic even it exceeds limit; 'reset': Reset the connection when it exceeds limit; **Type:** string **Supported Values:** forward, reset **conn-limit** **Description** Connection limit **Type:** number **Range:** 0-1048575 **conn-per** **Description** Per (Specify interval in number of 100ms) **Type:** number **Range:** 1-65535 **conn-rate-limit** **Description** Specify connection rate limit **Type:** number **Range:** 1-2147483647 **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`43_template_policy-list_class-list_lid-list_dns64` **Type:** Object **interval** **Description** Specify log interval in minutes, by default system will log every over limit instance **Type:** number **Range:** 1-255 **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-31 **lockout** **Description** Don't accept any new connection for certain time (Lockout duration in minutes) **Type:** number **Range:** 1-1023 **log** **Description** Log a message **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **over-limit-action** **Description** Set action when exceeds limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **request-limit** **Description** Request limit (Specify request limit) **Type:** number **Range:** 0-1048575 **request-per** **Description** Per (Specify interval in number of 100ms) **Type:** number **Range:** 1-65535 **request-rate-limit** **Description** Request rate limit (Specify request rate limit) **Type:** number **Range:** 1-4294967295 **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 .. _43_template_policy-list_class-list_lid-list_dns64: template_policy-list_class-list_lid-list_dns64 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **disable** **Description** Disable **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **exclusive-answer** **Description** Exclusive Answer in DNS Response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **prefix** **Description** IPv6 prefix **Type:** string **Format:** ipv6-address-plen .. _43_template_logging-list: template_logging-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **batched-logging-disable** **Description** Disable multiple logs per packet **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **custom** **Description:** custom is a **JSON Block**. Please see below for :ref:`43_template_logging-list_custom` **Type:** Object **disable-log-by-destination** **Description:** disable-log-by-destination is a **JSON Block**. Please see below for :ref:`43_template_logging-list_disable-log-by-destination` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination ` **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 **format** **Description** 'binary': Binary logging format; 'compact': Compact ASCII logging format (Hex format with compact representation); 'custom': Arbitrary custom logging format; 'default': Default A10 logging format (ASCII); 'rfc5424': RFC5424 compliant logging format; 'cef': Common Event Format for logging; **Type:** string **Supported Values:** binary, compact, custom, default, rfc5424, cef **Default:** default **include-destination** **Description** Include the destination IP and port in logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **include-http** **Description:** include-http is a **JSON Block**. Please see below for :ref:`43_template_logging-list_include-http` **Type:** Object **include-inside-user-mac** **Description** Include the inside user MAC address in logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **include-partition-name** **Description** Include partition name in logging events **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **include-port-block-account** **Description** include bytes accounting information in port-batch-v2 port-mapping and fixed-nat user-ports messages **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **include-radius-attribute** **Description:** include-radius-attribute is a **JSON Block**. Please see below for :ref:`43_template_logging-list_include-radius-attribute` **Type:** Object **include-session-byte-count** **Description** include byte count in session deletion logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log** **Description:** log is a **JSON Block**. Please see below for :ref:`43_template_logging-list_log` **Type:** Object **log-receiver** **Description:** log-receiver is a **JSON Block**. Please see below for :ref:`43_template_logging-list_log-receiver` **Type:** Object **name** **Description** Logging template name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **resolution** **Description** 'seconds': Logging timestamp resolution in seconds (default); '10-milliseconds': Logging timestamp resolution in 10s of milli-seconds; **Type:** string **Supported Values:** seconds, 10-milliseconds **Default:** seconds **rfc-custom** **Description:** rfc-custom is a **JSON Block**. Please see below for :ref:`43_template_logging-list_rfc-custom` **Type:** Object **rule** **Description:** rule is a **JSON Block**. Please see below for :ref:`43_template_logging-list_rule` **Type:** Object **service-group** **Description** Set NAT logging service-group **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **severity** **Description:** severity is a **JSON Block**. Please see below for :ref:`43_template_logging-list_severity` **Type:** Object **shared** **Description** Service group is in shared patition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **source-address** **Description:** source-address is a **JSON Block**. Please see below for :ref:`43_template_logging-list_source-address` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging/{name}/source-address ` **source-port** **Description:** source-port is a **JSON Block**. Please see below for :ref:`43_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 .. _43_template_logging-list_include-http: template_logging-list_include-http ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **file-extension** **Description** HTTP file extension **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **header-cfg** **Type:** List **l4-session-info** **Description** Log the L4 session information of the HTTP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **method** **Description** Log the HTTP Request Method **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **request-number** **Description** HTTP Request Number **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_include-http_header-cfg: template_logging-list_include-http_header-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **custom-header-name** **Description** Header name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **custom-max-length** **Description** Max length for a HTTP request log (Max header length (Default: 100 char)) **Type:** number **Range:** 100-1000 **Default:** 100 **http-header** **Description** 'cookie': Log HTTP Cookie Header; 'referer': Log HTTP Referer Header; 'user-agent': Log HTTP User-Agent Header; 'header1': Log HTTP Header 1; 'header2': Log HTTP Header 2; 'header3': Log HTTP Header 3; **Type:** string **Supported Values:** cookie, referer, user-agent, header1, header2, header3 **max-length** **Description** Max length for a HTTP request log (Max header length (Default: 100 char)) **Type:** number **Range:** 100-1000 **Default:** 100 .. _43_template_logging-list_severity: template_logging-list_severity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _43_template_logging-list_custom: template_logging-list_custom ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **custom-header** **Description** 'use-syslog-header': Use syslog header as custom log header; **Type:** string **Supported Values:** use-syslog-header **custom-message** **Description:** custom-message is a **JSON Block**. Please see below for :ref:`43_template_logging-list_custom_custom-message` **Type:** Object **custom-time-stamp-format** **Description** Customize the time stamp format (Customize the time-stamp format. Default:%Y%m%d%H%M%S) **Type:** string **Format:** string-rlx **Maximum Length:** 31 characters **Maximum Length:** 1 characters .. _43_template_logging-list_custom_custom-message: template_logging-list_custom_custom-message ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **custom-dhcpv6-map-prefix-assigned** **Description** MAP DHCPv6 prefix assigned **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-dhcpv6-map-prefix-released** **Description** MAP DHCPv6 prefix released **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-dhcpv6-map-prefix-renewed** **Description** MAP DHCPv6 prefix renewed **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-fixed-nat-allocated** **Description** Fixed-NAT allocated (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-fixed-nat-freed** **Description** Fixed-NAT freed (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-fixed-nat-interim-update** **Description** Fixed-NAT interim update (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-http-request-got** **Description** HTTP request got (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-allocated** **Description** Port allocated (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-batch-allocated** **Description** Port Batch allocated (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-batch-freed** **Description** Port Batch freed (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-batch-v2-allocated** **Description** Port Batch v2 allocated (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-batch-v2-freed** **Description** Port Batch v2 freed (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-batch-v2-interim-update** **Description** Port Batch v2 interim update (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-port-freed** **Description** Port freed (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-session-created** **Description** Session created (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **custom-session-deleted** **Description** Session deleted (Custom message string) **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _43_template_logging-list_source-address: template_logging-list_source-address ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip** **Description** Specify source IP address **Type:** string **Format:** ipv4-address **ipv6** **Description** Specify source IPv6 address **Type:** string **Format:** ipv6-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_template_logging-list_log: template_logging-list_log ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **fixed-nat** **Description:** fixed-nat is a **JSON Block**. Please see below for :ref:`43_template_logging-list_log_fixed-nat` **Type:** Object **http-requests** **Description** 'host': Log the HTTP Host Header; 'url': Log the HTTP Request URL; **Type:** string **Supported Values:** host, url **map-dhcpv6** **Description:** map-dhcpv6 is a **JSON Block**. Please see below for :ref:`43_template_logging-list_log_map-dhcpv6` **Type:** Object **merged-style** **Description** Merge creation and deletion of session logs to one **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **one-to-one-nat** **Description:** one-to-one-nat is a **JSON Block**. Please see below for :ref:`43_template_logging-list_log_one-to-one-nat` **Type:** Object **port-mappings** **Description** 'creation': Log only creation of NAT mappings; 'disable': Disable Log creation and deletion of NAT mappings; 'both': Log creation and deletion of NAT mappings; **Type:** string **Supported Values:** creation, disable, both **Default:** both **port-overloading** **Description** Force logging of all port-overloading sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **sessions** **Description** Log all data sessions created using NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **user-data** **Description** Log LSN Subscriber Information **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_log_one-to-one-nat: template_logging-list_log_one-to-one-nat ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **one-to-one-merged-style** **Description** Merge creation and deletion of session logs to one **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **one-to-one-nat-sessions** **Description** Log all One-to-One NAT sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_log_map-dhcpv6: template_logging-list_log_map-dhcpv6 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **map-dhcpv6-msg-type** **Type:** List **map-dhcpv6-prefix-all** **Description** Log MAP DHCPv6 prefix assignment/renewal/release **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** map-dhcpv6-prefix-all and map-dhcpv6-msg-type are mutually exclusive .. _43_template_logging-list_log_map-dhcpv6_map-dhcpv6-msg-type: template_logging-list_log_map-dhcpv6_map-dhcpv6-msg-type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **map-dhcpv6-msg-type** **Description** 'prefix-assignment': Log MAP DHCPv6 prefix assignment; 'prefix-renewal': Log MAP DHCPv6 prefix renewal; 'prefix-release': Log MAP DHCPv6 prefix release; **Type:** string **Supported Values:** prefix-assignment, prefix-renewal, prefix-release **Mutual Exclusion:** map-dhcpv6-msg-type and map-dhcpv6-prefix-all are mutually exclusive .. _43_template_logging-list_log_fixed-nat: template_logging-list_log_fixed-nat ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **fixed-nat-http-requests** **Description** 'host': Log the HTTP Host Header; 'url': Log the HTTP Request URL; **Type:** string **Supported Values:** host, url **fixed-nat-merged-style** **Description** Merge creation and deletion of session logs to one **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fixed-nat-port-mappings** **Description** 'both': Log creation and deletion of NAT mappings; 'creation': Log creation of NAT mappings; **Type:** string **Supported Values:** both, creation **fixed-nat-sessions** **Description** Log all Fixed NAT sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **user-ports** **Description:** user-ports is a **JSON Block**. Please see below for :ref:`43_template_logging-list_log_fixed-nat_user-ports` **Type:** Object .. _43_template_logging-list_log_fixed-nat_user-ports: template_logging-list_log_fixed-nat_user-ports ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **days** **Description** Specify period in days **Type:** number **Range:** 1-30 **start-time** **Description** Time when periodic logging starts (Specify start time(hh:mm)) **Type:** string **Format:** time-hhmm **user-ports** **Description** Log Fixed NAT User Ports Configured **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_source-port: template_logging-list_source-port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _43_template_logging-list_log-receiver: template_logging-list_log-receiver ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **radius** **Description** Use RADIUS server for NAT logging **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **secret-string** **Description** The RADIUS server's secret **Type:** string **Format:** password **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _43_template_logging-list_include-radius-attribute: template_logging-list_include-radius-attribute ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **attr-cfg** **Type:** List **framed-ipv6-prefix** **Description** Include radius attributes for the prefix **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **insert-if-not-existing** **Description** Configure what string is to be inserted for custom RADIUS attributes **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no-quote** **Description** No quotation marks for RADIUS attributes in logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **prefix-length** **Description** '32': Prefix length 32; '48': Prefix length 48; '64': Prefix length 64; '80': Prefix length 80; '96': Prefix length 96; '112': Prefix length 112; **Type:** string **Supported Values:** 32, 48, 64, 80, 96, 112 **zero-in-custom-attr** **Description** Insert 0000 for standard and custom attributes in log string **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_include-radius-attribute_attr-cfg: template_logging-list_include-radius-attribute_attr-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **attr** **Description** 'imei': Include IMEI; 'imsi': Include IMSI; 'msisdn': Include MSISDN; 'custom1': Customized attribute 1; 'custom2': Customized attribute 2; 'custom3': Customized attribute 3; 'custom4': Customized attribute 4; 'custom5': Customized attribute 5; 'custom6': Customized attribute 6; **Type:** string **Supported Values:** imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6 **attr-event** **Description** 'http-requests': Include in HTTP request logs; 'port-mappings': Include in port-mapping logs; 'sessions': Include in session logs; 'user-data': Include in user-data logs; **Type:** string **Supported Values:** http-requests, port-mappings, sessions, user-data .. _43_template_logging-list_rule: template_logging-list_rule ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **interim-update-interval** **Description** Log interim update of NAT mappings (Interim update interval in minutes(Interval is floored to a multiple of 5)) **Type:** number **Range:** 15-120 **rule-http-requests** **Description:** rule-http-requests is a **JSON Block**. Please see below for :ref:`43_template_logging-list_rule_rule-http-requests` **Type:** Object .. _43_template_logging-list_rule_rule-http-requests: template_logging-list_rule_rule-http-requests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dest-port** **Type:** List **disable-sequence-check** **Description** Disable http packet sequence check and don't drop out of order packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **include-all-headers** **Description** Include all configured headers despite of absence in HTTP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-every-http-request** **Description** Log every HTTP request in an HTTP 1.1 session (Default: Log the first HTTP request in a session) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-url-len** **Description** Max length of URL log (Max URL length (Default: 128 char)) **Type:** number **Range:** 100-1000 **Default:** 128 .. _43_template_logging-list_rule_rule-http-requests_dest-port: template_logging-list_rule_rule-http-requests_dest-port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dest-port-number** **Description** **Type:** number **Range:** 1-65535 **include-byte-count** **Description** Include the byte count of HTTP Request/Response in CGN session deletion logs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_disable-log-by-destination: template_logging-list_disable-log-by-destination ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp** **Description** Disable logging for icmp traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip/{ipv4-addr} ` **ip6-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/logging/{name}/disable-log-by-destination/ip6/{ipv6-addr} ` **others** **Description** Disable logging for other L4 protocols **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-list** **Type:** List **udp-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_template_logging-list_disable-log-by-destination_ip-list: template_logging-list_disable-log-by-destination_ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **icmp** **Description** Disable logging for icmp traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv4-addr** **Description** Configure an IP subnet **Type:** string **Format:** ipv4-cidr **others** **Description** Disable logging for other L4 protocols **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-list** **Type:** List **udp-list** **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 .. _43_template_logging-list_disable-log-by-destination_ip-list_tcp-list: template_logging-list_disable-log-by-destination_ip-list_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **tcp-port-end** **Description** Port Range End **Type:** number **tcp-port-start** **Description** Destination Port (Single Destination Port or Port Range Start) **Type:** number .. _43_template_logging-list_disable-log-by-destination_ip-list_udp-list: template_logging-list_disable-log-by-destination_ip-list_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **udp-port-end** **Description** Port Range End **Type:** number **udp-port-start** **Description** Destination Port (Single Destination Port or Port Range Start) **Type:** number .. _43_template_logging-list_disable-log-by-destination_tcp-list: template_logging-list_disable-log-by-destination_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **tcp-port-end** **Description** Port Range End **Type:** number **tcp-port-start** **Description** Destination Port (Single Destination Port or Port Range Start) **Type:** number .. _43_template_logging-list_disable-log-by-destination_ip6-list: template_logging-list_disable-log-by-destination_ip6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **icmp** **Description** Disable logging for icmp traffic **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-addr** **Description** Configure an IPv6 subnet **Type:** string **Format:** ipv6-address-plen **others** **Description** Disable logging for other L4 protocols **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **tcp-list** **Type:** List **udp-list** **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 .. _43_template_logging-list_disable-log-by-destination_ip6-list_tcp-list: template_logging-list_disable-log-by-destination_ip6-list_tcp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **tcp-port-end** **Description** Port Range End **Type:** number **tcp-port-start** **Description** Destination Port (Single Destination Port or Port Range Start) **Type:** number .. _43_template_logging-list_disable-log-by-destination_ip6-list_udp-list: template_logging-list_disable-log-by-destination_ip6-list_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **udp-port-end** **Description** Port Range End **Type:** number **udp-port-start** **Description** Destination Port (Single Destination Port or Port Range Start) **Type:** number .. _43_template_logging-list_disable-log-by-destination_udp-list: template_logging-list_disable-log-by-destination_udp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **udp-port-end** **Description** Port Range End **Type:** number **udp-port-start** **Description** Destination Port (Single Destination Port or Port Range Start) **Type:** number .. _43_template_logging-list_rfc-custom: template_logging-list_rfc-custom ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **header** **Description:** header is a **JSON Block**. Please see below for :ref:`43_template_logging-list_rfc-custom_header` **Type:** Object **message** **Description:** message is a **JSON Block**. Please see below for :ref:`43_template_logging-list_rfc-custom_message` **Type:** Object .. _43_template_logging-list_rfc-custom_header: template_logging-list_rfc-custom_header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **use-alternate-timestamp** **Description** Use alternate non-RFC5424 compliant timestamp. Ex: 1990 Jan 15 12:30:30 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_template_logging-list_rfc-custom_message: template_logging-list_rfc-custom_message ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dhcpv6-map-prefix-assigned** **Description** MAP DHCPv6 prefix assigned **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **dhcpv6-map-prefix-released** **Description** MAP DHCPv6 prefix released **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **dhcpv6-map-prefix-renewed** **Description** MAP DHCPv6 prefix renewed **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **http-request-got** **Description** HTTP request got (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **ipv6-tech** **Type:** List **session-created** **Description** Session created (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **session-deleted** **Description** Session deleted (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters .. _43_template_logging-list_rfc-custom_message_ipv6-tech: template_logging-list_rfc-custom_message_ipv6-tech ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fixed-nat-allocated** **Description** Fixed-NAT allocated (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **fixed-nat-freed** **Description** Fixed-NAT freed (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **port-allocated** **Description** Port allocated (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **port-batch-allocated** **Description** Port Batch allocated (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **port-batch-freed** **Description** Port Batch freed (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **port-batch-v2-allocated** **Description** Port Batch v2 allocated (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **port-batch-v2-freed** **Description** Port Batch v2 freed (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **port-freed** **Description** Port freed (Custom message string. Should be in the format of "MSGID [STRUCTURED-DATA] MSG") **Type:** string **Format:** string-rlx **Maximum Length:** 255 characters **Maximum Length:** 1 characters **tech-type** **Description** 'lsn': LSN; 'nat64': NAT64; 'ds-lite': DS-Lite; 'sixrd-nat64': 6rd-NAT64; **Type:** string **Supported Values:** lsn, nat64, ds-lite, sixrd-nat64 .. _43_template_pcp-list: template_pcp-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **allow-third-party-from-lan** **Description** Allow third party request coming from LAN (default is disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allow-third-party-from-wan** **Description** Allow third party request coming from WAN (default is disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **announce** **Description** PCP ANNOUNCE Opcode (default is enabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **check-client-nonce** **Description** To validate NONCE value in PCP request (default: disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable-map-filter** **Description** To disable processing of FILTER options in MAP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **map** **Description** PCP MAP Opcode (default is enabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **maximum** **Description** To set maximum lifetime of PCP mappings (default 1440 minutes) **Type:** number **Range:** 2-1440 **Default:** 1440 **minimum** **Description** To set minimum lifetime of PCP mappings (default 2 minutes) **Type:** number **Range:** 2-1440 **Default:** 2 **name** **Description** PCP Template name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **pcp-server-port** **Description** PCP server listening port (default 5351) (PCP UDP destination port) **Type:** number **Range:** 1024-65535 **Default:** 5351 **peer** **Description** PCP PEER Opcode (default is enabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **source-ip** **Description** Specify source IP address for IPv4 ANNOUNCE message **Type:** string **Format:** ipv4-address **source-ipv6** **Description** Specify source IPv6 address for IPv6 ANNOUNCE message **Type:** string **Format:** ipv6-address **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 .. _43_template_http-alg-list: template_http-alg-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **header-name-client-ip** **Description** Header name (default: X-Forwarded-For) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** X-Forwarded-For **header-name-msisdn** **Description** Header name (default: X-MSISDN) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** X-MSISDN **include-tunnel-ip** **Description** Include the tunnel IP (applies to DS-Lite and 6RD-NAT64 sessions) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **method** **Description** 'append': Append if there is already a header (default); 'replace': Replace if there is already a header; **Type:** string **Supported Values:** append, replace **Default:** append **name** **Description** HTTP-ALG template name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **request-insert-client-ip** **Description** Insert Client IP into HTTP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **request-insert-msisdn** **Description** Insert MSISDN into HTTP request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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 .. _43_template_dns-list: template_dns-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **class-list** **Description:** class-list is a **JSON Block**. Please see below for :ref:`43_template_dns-list_class-list` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name}/class-list ` **default-policy** **Description** 'nocache': Cache disable; 'cache': Cache enable; **Type:** string **Supported Values:** nocache, cache **Default:** nocache **disable-dns-template** **Description** Disable DNS template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dns64** **Description:** dns64 is a **JSON Block**. Please see below for :ref:`43_template_dns-list_dns64` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name}/dns64 ` **drop** **Description** Drop the malformed query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** drop and forward are mutually exclusive **forward** **Description** Forward to service group (Service group name) **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** forward and drop are mutually exclusive **max-cache-size** **Description** Define maximum cache size (Maximum cache entry per VIP) **Type:** number **name** **Description** DNS Template Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Period in minutes **Type:** number **Range:** 1-10000 **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 .. _43_template_dns-list_class-list: template_dns-list_class-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **lid-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/dns/{name}/class-list/lid/{lidnum} ` **name** **Description** Specify a class list 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 .. _43_template_dns-list_class-list_lid-list: template_dns-list_class-list_lid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action-value** **Description** 'dns-cache-disable': Disable DNS cache when it exceeds limit; 'dns-cache-enable': Enable DNS cache when it exceeds limit; 'forward': Forward the traffic even it exceeds limit; **Type:** string **Supported Values:** dns-cache-disable, dns-cache-enable, forward **conn-rate-limit** **Description** Connection rate limit **Type:** number **Range:** 1-2147483647 **dns** **Description:** dns is a **JSON Block**. Please see below for :ref:`43_template_dns-list_class-list_lid-list_dns` **Type:** Object **lidnum** **Description** Specify a limit ID **Type:** number **Range:** 1-31 **lockout** **Description** Don't accept any new connection for certain time (Lockout duration in minutes) **Type:** number **Range:** 1-1023 **log** **Description** Log a message **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **log-interval** **Description** Log interval (minute, by default system will log every over limit instance) **Type:** number **Range:** 1-255 **over-limit-action** **Description** Action when exceeds limit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **per** **Description** Per (Number of 100ms) **Type:** number **Range:** 1-65535 **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 .. _43_template_dns-list_class-list_lid-list_dns: template_dns-list_class-list_lid-list_dns ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **cache-action** **Description** 'cache-disable': Disable dns cache; 'cache-enable': Enable dns cache; **Type:** string **Supported Values:** cache-disable, cache-enable **Default:** cache-disable **ttl** **Description** TTL for cache entry (TTL in seconds) **Type:** number **Range:** 1-65535 **weight** **Description** Weight for cache entry **Type:** number **Range:** 1-7 .. _43_template_dns-list_dns64: template_dns-list_dns64 ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **answer-only-disable** **Description** Disable Only translate the Answer Section **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **auth-data** **Description** Set AA flag in DNS Response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cache** **Description** Use a cached A-query response to provide AAAA query responses for the same hostname **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **change-query** **Description** Always change incoming AAAA DNS Query to A **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **compress-disable** **Description** Disable Always try DNS Compression **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **deep-check-qr** **Description** Check DNS Question Record **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **deep-check-rr-disable** **Description** Disable Check DNS Response Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **drop-cname-disable** **Description** Disable Drop DNS CNAME Response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **edns-append** **Description** Append EDNS Record when send A Query to server **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable** **Description** Enable DNS64 (Need to config this option before config any other dns64 options) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fast-append** **Description** Append translated Records when original Response only has Answer Section **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ignore-rcode3-disable** **Description** Disable Ignore DNS error Response with rcode 3 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-qr-length** **Description** Max Question Record Length, default is 128 **Type:** number **Range:** 1-1023 **Default:** 128 **parallel-query** **Description** Forward AAAA Query & generate A Query in parallel **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **passive-query-disable** **Description** Disable Generate A query upon empty or error Response **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **retry** **Description** Retry count, default is 3 (Retry Number) **Type:** number **Range:** 0-15 **Default:** 3 **single-response-disable** **Description** Disable Single Response which is used to avoid ambiguity **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timeout** **Description** Timeout to send additional Queries, unit: second, default is 1 **Type:** number **Range:** 0-15 **Default:** 1 **trans-ptr** **Description** Translate DNS PTR Records **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **trans-ptr-query** **Description** Translate DNS PTR Query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ttl** **Description** Specify Max TTL in DNS Response, unit: second **Type:** number **Range:** 1-1000000000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_port-list-list: port-list-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** Specify name of the port list **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-config** **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 .. _43_port-list-list_port-config: port-list-list_port-config ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **original-port** **Description** Original port to be translated **Type:** number **Range:** 0-65535 **translated-port** **Description** Port after translation **Type:** number **Range:** 0-65535 .. _43_nat64: nat64 ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **alg** **Description:** alg is a **JSON Block**. Please see below for :ref:`43_nat64_alg` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg ` **enhanced-user-tracking** **Description:** enhanced-user-tracking is a **JSON Block**. Please see below for :ref:`43_nat64_enhanced-user-tracking` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/enhanced-user-tracking ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_nat64_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation ` **full-cone-session** **Description:** full-cone-session is a **JSON Block**. Please see below for :ref:`43_nat64_full-cone-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/full-cone-session ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_nat64_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/global ` **prefix-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/prefix/{prefix-val} ` **user-quota-session** **Description:** user-quota-session is a **JSON Block**. Please see below for :ref:`43_nat64_user-quota-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/user-quota-session ` .. _43_nat64_fragmentation: nat64_fragmentation ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-bit-transparency** **Description:** df-bit-transparency is a **JSON Block**. Please see below for :ref:`43_nat64_fragmentation_df-bit-transparency` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation/df-bit-transparency ` **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_nat64_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_nat64_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation/outbound ` .. _43_nat64_fragmentation_inbound: nat64_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **count** **Description** Configure number of ICMP messages sent when DF set. Default is 1 **Type:** number **Range:** 1-5 **Default:** 1 **df-set** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 fragmentation; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); **Type:** string **Supported Values:** drop, ipv6, send-icmp **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv6 **Default:** ipv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_fragmentation_outbound: nat64_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation (default); 'send-icmpv6': Send ICMPv6 Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmpv6 **Default:** ipv4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_fragmentation_df-bit-transparency: nat64_fragmentation_df-bit-transparency ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-bit-value** **Description** 'enable': Add an empty IPv6 fragmentation header if IPv4 DF bit is zero; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_full-cone-session: nat64_full-cone-session ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg: nat64_alg ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **esp** **Description:** esp is a **JSON Block**. Please see below for :ref:`43_nat64_alg_esp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/esp ` **ftp** **Description:** ftp is a **JSON Block**. Please see below for :ref:`43_nat64_alg_ftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/ftp ` **h323** **Description:** h323 is a **JSON Block**. Please see below for :ref:`43_nat64_alg_h323` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/h323 ` **mgcp** **Description:** mgcp is a **JSON Block**. Please see below for :ref:`43_nat64_alg_mgcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/mgcp ` **pptp** **Description:** pptp is a **JSON Block**. Please see below for :ref:`43_nat64_alg_pptp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/pptp ` **rtsp** **Description:** rtsp is a **JSON Block**. Please see below for :ref:`43_nat64_alg_rtsp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/rtsp ` **sip** **Description:** sip is a **JSON Block**. Please see below for :ref:`43_nat64_alg_sip` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/sip ` **tftp** **Description:** tftp is a **JSON Block**. Please see below for :ref:`43_nat64_alg_tftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/tftp ` .. _43_nat64_alg_ftp: nat64_alg_ftp ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp-enable** **Description** 'disable': Disable NAT64 FTP ALG; **Type:** string **Supported Values:** disable **trans-eprt-to-port** **Description** 'disable': disable; **Type:** string **Supported Values:** disable **trans-epsv-to-pasv** **Description** 'disable': disable; **Type:** string **Supported Values:** disable **trans-lprt-to-port** **Description** 'disable': disable; **Type:** string **Supported Values:** disable **trans-lpsv-to-pasv** **Description** 'disable': disable; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **xlat-no-trans-pasv** **Description** 'enable': enable; **Type:** string **Supported Values:** enable .. _43_nat64_alg_sip: nat64_alg_sip ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sip-enable** **Description** 'enable': Enable NAT64 SIP ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg_esp: nat64_alg_esp ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **esp-enable** **Description** 'enable': Enable NAT64 ESP ALG; 'enable-with-ctrl': Enable ESP NAT64 ALG with control session; **Type:** string **Supported Values:** enable, enable-with-ctrl **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg_pptp: nat64_alg_pptp ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **pptp-enable** **Description** 'enable': Enable NAT64 PPTP ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg_rtsp: nat64_alg_rtsp ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtsp-enable** **Description** 'enable': Enable NAT64 RTSP ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg_h323: nat64_alg_h323 ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **h323-enable** **Description** 'enable': Enable NAT64 H323 ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg_tftp: nat64_alg_tftp ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tftp-enable** **Description** 'enable': Enable NAT64 TFTP ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_alg_mgcp: nat64_alg_mgcp ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mgcp-enable** **Description** 'enable': Enable NAT64 MGCP ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_global: nat64_global ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **all** **Description** All packet sizes **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **force-non-zero-ipv4-id** **Description** Enable non-zero ID field in IPv4 header if no IPv6 fragment & IPv4 pkt size is more than 88 & less than or equal to 1280 bytes **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`43_nat64_global_icmp` **Type:** Object **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`43_nat64_global_inside` **Type:** Object **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_nat64_global_tcp` **Type:** Object **user-quota-prefix-length** **Description** User Quota Prefix Length (Default: 128) **Type:** number **Range:** 1-128 **Default:** 128 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_global_inside: nat64_global_inside ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **source** **Description:** source is a **JSON Block**. Please see below for :ref:`43_nat64_global_inside_source` **Type:** Object .. _43_nat64_global_inside_source: nat64_global_inside_source ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **class-list** **Description** Class-list to match for NAT64 **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _43_nat64_global_tcp: nat64_global_tcp ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mss-clamp** **Description:** mss-clamp is a **JSON Block**. Please see below for :ref:`43_nat64_global_tcp_mss-clamp` **Type:** Object **reset-on-error** **Description:** reset-on-error is a **JSON Block**. Please see below for :ref:`43_nat64_global_tcp_reset-on-error` **Type:** Object .. _43_nat64_global_tcp_mss-clamp: nat64_global_tcp_mss-clamp ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: 476)) **Type:** number **Range:** 0-1420 **Default:** 476 **mss-clamp-type** **Description** 'fixed': Specify a fixed max value for the TCP MSS; 'none': No TCP MSS clamping; 'subtract': Specify the value to subtract from the TCP MSS (default: 20); **Type:** string **Supported Values:** fixed, none, subtract **Default:** subtract **mss-subtract** **Description** Specify the value to subtract from the TCP MSS (default: 20) **Type:** number **Range:** 0-1420 **Default:** 20 **mss-value** **Description** The max value allowed for the TCP MSS (default: not configured) **Type:** number **Range:** 0-1420 .. _43_nat64_global_tcp_reset-on-error: nat64_global_tcp_reset-on-error ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **outbound** **Description** 'disable': Disable send TCP reset on error; **Type:** string **Supported Values:** disable .. _43_nat64_global_icmp: nat64_global_icmp ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **send-on-port-unavailable** **Description** 'host-unreachable': Send ICMP destination host unreachable; 'admin-filtered': Send ICMP admin filtered; 'disable': Disable ICMP port unavailable message (default); **Type:** string **Supported Values:** host-unreachable, admin-filtered, disable **Default:** disable **send-on-user-quota-exceeded** **Description** 'host-unreachable': Send ICMP destination host unreachable; 'admin-filtered': Send ICMP admin filtered (default); 'disable': Disable ICMP quota exceeded message; **Type:** string **Supported Values:** host-unreachable, admin-filtered, disable **Default:** admin-filtered .. _43_nat64_prefix-list: nat64_prefix-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **class-list** **Description** Class-list to match for NAT64 **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **prefix-val** **Description** NAT64 Prefix **Type:** string **Format:** ipv6-address-plen **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 .. _43_nat64_user-quota-session: nat64_user-quota-session ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nat64_enhanced-user-tracking: nat64_enhanced-user-tracking ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite: ds-lite ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **alg** **Description:** alg is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_ds-lite_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/fragmentation ` **full-cone-session** **Description:** full-cone-session is a **JSON Block**. Please see below for :ref:`43_ds-lite_full-cone-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/full-cone-session ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_ds-lite_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/global ` **port-reservation-entries** **Description:** port-reservation-entries is a **JSON Block**. Please see below for :ref:`43_ds-lite_port-reservation-entries` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/port-reservation-entries ` **port-reservation-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/port-reservation/{inside}+{tunnel-dest-address}+{inside-addr}+{inside-start-port}+{inside-end-port}+{nat}+{nat-start-port}+{nat-end-port} ` **user-quota-session** **Description:** user-quota-session is a **JSON Block**. Please see below for :ref:`43_ds-lite_user-quota-session` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/user-quota-session ` .. _43_ds-lite_fragmentation: ds-lite_fragmentation ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_ds-lite_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_ds-lite_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/fragmentation/outbound ` .. _43_ds-lite_fragmentation_inbound: ds-lite_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **count** **Description** Configure number of ICMP messages sent when DF set. Default is 1 **Type:** number **Range:** 1-5 **Default:** 1 **df-set** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 Fragmentation; 'ipv6': Use IPv6 fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); **Type:** string **Supported Values:** drop, ipv4, ipv6, send-icmp **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'ipv6': Use IPv6 fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv4, ipv6 **Default:** ipv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_fragmentation_outbound: ds-lite_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **count** **Description** Configure number of ICMP messages sent when DF set. Default is 1 **Type:** number **Range:** 1-5 **Default:** 1 **df-set** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 Fragmentation; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmp, send-icmpv6 **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets (default); 'send-icmpv6': Send ICMPv6 Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmpv6 **Default:** ipv4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_full-cone-session: ds-lite_full-cone-session ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg: ds-lite_alg ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp** **Description:** ftp is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_ftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/ftp ` **h323** **Description:** h323 is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_h323` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/h323 ` **mgcp** **Description:** mgcp is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_mgcp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/mgcp ` **pptp** **Description:** pptp is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_pptp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/pptp ` **rtsp** **Description:** rtsp is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_rtsp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/rtsp ` **sip** **Description:** sip is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_sip` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/sip ` **tftp** **Description:** tftp is a **JSON Block**. Please see below for :ref:`43_ds-lite_alg_tftp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ds-lite/alg/tftp ` .. _43_ds-lite_alg_ftp: ds-lite_alg_ftp ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ftp-enable** **Description** 'disable': Disable ALG; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg_sip: ds-lite_alg_sip ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sip-enable** **Description** 'enable': Enable ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg_pptp: ds-lite_alg_pptp ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **pptp-enable** **Description** 'enable': Enable ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg_rtsp: ds-lite_alg_rtsp ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rtsp-enable** **Description** 'enable': Enable ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg_h323: ds-lite_alg_h323 ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **h323-enable** **Description** 'enable': Enable ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg_tftp: ds-lite_alg_tftp ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tftp-enable** **Description** 'enable': Enable ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_alg_mgcp: ds-lite_alg_mgcp ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mgcp-enable** **Description** 'enable': Enable ALG; **Type:** string **Supported Values:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_global: ds-lite_global ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp** **Description:** icmp is a **JSON Block**. Please see below for :ref:`43_ds-lite_global_icmp` **Type:** Object **inside** **Description:** inside is a **JSON Block**. Please see below for :ref:`43_ds-lite_global_inside` **Type:** Object **ip-checksum-error** **Description** 'fix': Fix the bad checksum (default); 'drop': Drop packets with a bad checksum; **Type:** string **Supported Values:** fix, drop **Default:** fix **l4-checksum-error** **Description** 'propagate': Propagate the bad checksum (default); 'fix': Fix the bad checksum; 'drop': Drop packets with a bad checksum; **Type:** string **Supported Values:** propagate, fix, drop **Default:** propagate **tcp** **Description:** tcp is a **JSON Block**. Please see below for :ref:`43_ds-lite_global_tcp` **Type:** Object **user-quota-prefix-length** **Description** User Quota Prefix Length (Default: 128) **Type:** number **Range:** 1-128 **Default:** 128 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_global_inside: ds-lite_global_inside ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **source** **Description:** source is a **JSON Block**. Please see below for :ref:`43_ds-lite_global_inside_source` **Type:** Object .. _43_ds-lite_global_inside_source: ds-lite_global_inside_source ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **class-list** **Description** Class-list to match for DS-Lite **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _43_ds-lite_global_tcp: ds-lite_global_tcp ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mss-clamp** **Description:** mss-clamp is a **JSON Block**. Please see below for :ref:`43_ds-lite_global_tcp_mss-clamp` **Type:** Object **reset-on-error** **Description:** reset-on-error is a **JSON Block**. Please see below for :ref:`43_ds-lite_global_tcp_reset-on-error` **Type:** Object .. _43_ds-lite_global_tcp_mss-clamp: ds-lite_global_tcp_mss-clamp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **min** **Description** Specify the min value allowed for the TCP MSS (Specify the min value allowed for the TCP MSS (default: ((576 - 60 - 60 - 40)))) **Type:** number **Range:** 0-1420 **Default:** 416 **mss-clamp-type** **Description** 'fixed': Specify a fixed max value for the TCP MSS; 'none': No TCP MSS clamping; 'subtract': Specify the value to subtract from the TCP MSS (default: 40); **Type:** string **Supported Values:** fixed, none, subtract **Default:** subtract **mss-subtract** **Description** Specify the value to subtract from the TCP MSS (default: 40) **Type:** number **Range:** 0-1420 **Default:** 40 **mss-value** **Description** The max value allowed for the TCP MSS (default: not configured) **Type:** number **Range:** 0-1420 .. _43_ds-lite_global_tcp_reset-on-error: ds-lite_global_tcp_reset-on-error ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **outbound** **Description** 'disable': Disable send TCP reset on error; **Type:** string **Supported Values:** disable .. _43_ds-lite_global_icmp: ds-lite_global_icmp ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **send-on-port-unavailable** **Description** 'host-unreachable': Send ICMP destination host unreachable; 'admin-filtered': Send ICMP admin filtered; 'disable': Disable ICMP port unavailable message (default); **Type:** string **Supported Values:** host-unreachable, admin-filtered, disable **Default:** disable **send-on-user-quota-exceeded** **Description** 'host-unreachable': Send ICMP destination host unreachable; 'admin-filtered': Send ICMP admin filtered (default); 'disable': Disable ICMP quota exceeded message; **Type:** string **Supported Values:** host-unreachable, admin-filtered, disable **Default:** admin-filtered .. _43_ds-lite_port-reservation-list: ds-lite_port-reservation-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **inside** **Description** Inside User Address and Port Range (DS-Lite Inside User's Tunnel Source IPv6 Address) **Type:** string **Format:** ipv6-address **inside-addr** **Description** Inside User IP address **Type:** string **Format:** ipv4-address **inside-end-port** **Description** Inside End Port **Type:** number **Range:** 1-65535 **inside-start-port** **Description** Inside Start Port **Type:** number **Range:** 1-65535 **nat** **Description** NAT Port Range (NAT IP address) **Type:** string **Format:** ipv4-address **nat-end-port** **Description** NAT End Port **Type:** number **Range:** 1-65535 **nat-start-port** **Description** NAT Start Port **Type:** number **Range:** 1-65535 **tunnel-dest-address** **Description** DS-Lite Inside User's Tunnel Destination IPv6 Address **Type:** string **Format:** ipv6-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_user-quota-session: ds-lite_user-quota-session ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ds-lite_port-reservation-entries: ds-lite_port-reservation-entries ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_dns64-virtualserver-list: dns64-virtualserver-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **enable-disable-action** **Description** 'enable': Enable Virtual Server (default); 'disable': Disable Virtual Server; **Type:** string **Supported Values:** enable, disable **Default:** enable **ethernet** **Description** Ethernet interface **Type:** number **Format:** interface **ip-address** **Description** IP Address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ip-address ipv6-address and use-if-ip are mutually exclusive **ipv6-address** **Description** IPV6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ipv6-address ip-address and use-if-ip are mutually exclusive **name** **Description** CGNV6 Virtual Server Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **netmask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask-brief **policy** **Description** Policy template **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **port-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/dns64-virtualserver/{name}/port/{port-number}+{protocol} ` **template-policy** **Description** Policy template name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/policy ` **use-if-ip** **Description** Use Interface IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** use-if-ip ipv6-address and ip-address are mutually exclusive **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** Join a vrrp group (Specify ha VRRP-A vrid) **Type:** number **Range:** 1-31 .. _43_dns64-virtualserver-list_port-list: dns64-virtualserver-list_port-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-id-list** **Type:** List **acl-name-list** **Type:** List **action** **Description** 'enable': Enable; 'disable': Disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **auto** **Description** Configure auto NAT for the vport **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** Specify NAT pool or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **port-number** **Description** Port **Type:** number **Range:** 0-65534 **precedence** **Description** Set auto NAT pool as higher precedence for source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **protocol** **Description** 'dns-udp': DNS service over UDP; **Type:** string **Supported Values:** dns-udp **service-group** **Description** Bind a Service Group to this Virtual Server (Service Group Name) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/service-group ` **template-dns** **Description** DNS template (DNS template name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/dns ` **template-policy** **Description** Policy Template (Policy template name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/template/policy ` **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 .. _43_dns64-virtualserver-list_port-list_acl-name-list: dns64-virtualserver-list_port-list_acl-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-name** **Description** Apply an access list name (Named Access List) **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters **acl-name-seq-num** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **acl-name-src-nat-pool** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _43_dns64-virtualserver-list_port-list_acl-id-list: dns64-virtualserver-list_port-list_acl-id-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-id** **Description** ACL id VPORT **Type:** number **Range:** 1-199 **acl-id-seq-num** **Description** Specify ACL precedence (sequence-number) **Type:** number **Range:** 1-32 **acl-id-src-nat-pool** **Description** Policy based Source NAT (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _43_scaleout: scaleout ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **address-mapping** **Description:** address-mapping is a **JSON Block**. Please see below for :ref:`43_scaleout_address-mapping` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/scaleout/address-mapping ` **nat-ip-hashing-scheme** **Description:** nat-ip-hashing-scheme is a **JSON Block**. Please see below for :ref:`43_scaleout_nat-ip-hashing-scheme` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/scaleout/nat-ip-hashing-scheme ` .. _43_scaleout_address-mapping: scaleout_address-mapping ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_scaleout_nat-ip-hashing-scheme: scaleout_nat-ip-hashing-scheme ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **hashing-type** **Description** 'route-aggregation': Chunk contiguous NAT IPs for route aggregation(default); 'mod-user-groups': Hash NAT IPs by taking mod of user-groups; **Type:** string **Supported Values:** route-aggregation, mod-user-groups **Default:** route-aggregation **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_nptv6: nptv6 ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **common** **Description:** common is a **JSON Block**. Please see below for :ref:`43_nptv6_common` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/nptv6/common ` **domain-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/nptv6/domain/{name} ` .. _43_nptv6_domain-list: nptv6_domain-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **inside-prefix** **Description** Configure inside network prefix (Inside IPv6 network prefix) **Type:** string **Format:** ipv6-address-plen **name** **Description** Name of NPTv6 domain **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **outside-prefix** **Description** Configure outside network prefix (Outside IPv6 network prefix) **Type:** string **Format:** ipv6-address-plen **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 .. _43_nptv6_common: nptv6_common ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **send-icmpv6-on-error** **Description** 'disable': Disable to send ICMPv6 when error discovered; **Type:** string **Supported Values:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_resource-usage: resource-usage ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **fixed-nat-inside-user-count** **Description** Total configurable CGNV6 Fixed NAT inside users **Type:** number **fixed-nat-ip-addr-count** **Description** Total configurable CGNV6 Fixed NAT addresses **Type:** number **lsn-nat-addr-count** **Description** Total configurable CGNV6 NAT Pool addresses **Type:** number **radius-table-size** **Description** Total configurable CGNV6 RADIUS Table entries **Type:** number **stateless-entries** **Description:** stateless-entries is a **JSON Block**. Please see below for :ref:`43_resource-usage_stateless-entries` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/resource-usage/stateless-entries ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_resource-usage_stateless-entries: resource-usage_stateless-entries ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **l4-session-count** **Description** Helper size for CGN Stateless Technologies **Type:** number **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_one-to-one: one-to-one ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_one-to-one_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/global ` **mapping** **Description:** mapping is a **JSON Block**. Please see below for :ref:`43_one-to-one_mapping` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/mapping ` **pool-group-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name} ` **pool-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/pool/{pool-name} ` **shared-pool** **Description:** shared-pool is a **JSON Block**. Please see below for :ref:`43_one-to-one_shared-pool` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/shared-pool ` **shared-pool-group** **Description:** shared-pool-group is a **JSON Block**. Please see below for :ref:`43_one-to-one_shared-pool-group` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/shared-pool-group ` .. _43_one-to-one_shared-pool: one-to-one_shared-pool ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_one-to-one_pool-group-list: one-to-one_pool-group-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **member-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name}/member/{pool-name} ` **pool-group-name** **Description** Specify pool group name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vrid** **Description** Specify VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_one-to-one_pool-group-list_member-list: one-to-one_pool-group-list_member-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **pool-name** **Description** Specify CGNv6 one-to-one 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 .. _43_one-to-one_global: one-to-one_global ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **mapping-timeout** **Description** Configure timeout for the one-to-one NAT mapping (Timeout in minutes (default: 10 minutes)) **Type:** number **Range:** 0-180 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_one-to-one_mapping: one-to-one_mapping ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_one-to-one_shared-pool-group: one-to-one_shared-pool-group ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **members** **Description:** members is a **JSON Block**. Please see below for :ref:`43_one-to-one_shared-pool-group_members` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/one-to-one/shared-pool-group/members ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_one-to-one_shared-pool-group_members: one-to-one_shared-pool-group_members ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_one-to-one_pool-list: one-to-one_pool-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **end-address** **Description** Configure end IP address of NAT pool **Type:** string **Format:** ipv4-address **group** **Description** Share with a partition group (Partition Group Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **netmask** **Description** Configure mask for pool **Type:** string **Format:** ipv4-netmask-brief **partition** **Description** Share with a single partition (Partition Name) **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **pool-name** **Description** Specify pool name or pool group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** Share this pool with other partitions (default: not shared) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-address** **Description** Configure start IP address of NAT pool **Type:** string **Format:** ipv4-address **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 .. _43_logging: logging ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **nat-quota-exceeded** **Description:** nat-quota-exceeded is a **JSON Block**. Please see below for :ref:`43_logging_nat-quota-exceeded` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/logging/nat-quota-exceeded ` **nat-resource-exhausted** **Description:** nat-resource-exhausted is a **JSON Block**. Please see below for :ref:`43_logging_nat-resource-exhausted` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/logging/nat-resource-exhausted ` **source-address** **Description:** source-address is a **JSON Block**. Please see below for :ref:`43_logging_source-address` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/logging/source-address ` **tcp-svr-status** **Description:** tcp-svr-status is a **JSON Block**. Please see below for :ref:`43_logging_tcp-svr-status` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/logging/tcp-svr-status ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_logging_nat-resource-exhausted: logging_nat-resource-exhausted ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **level** **Description** 'warning': Log level Warning; 'critical': Log level Critical (Default); 'notice': Log level Notice; **Type:** string **Supported Values:** warning, critical, notice **Default:** critical **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_logging_tcp-svr-status: logging_tcp-svr-status ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_logging_nat-quota-exceeded: logging_nat-quota-exceeded ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **level** **Description** 'warning': Log level Warning (Default); 'critical': Log level Critical; 'notice': Log level Notice; **Type:** string **Supported Values:** warning, critical, notice **Default:** warning **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_logging_source-address: logging_source-address ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn-rule-list-list: lsn-rule-list-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **default** **Description:** default is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_default` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list/{name}/default ` **domain-ip** **Description:** domain-ip is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-ip` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list/{name}/domain-ip ` **domain-list-name-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list/{name}/domain-list-name/{name-domain-list} ` **domain-name-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list/{name}/domain-name/{name-domain} ` **http-match-domain-name** **Description** Enable match domain name in http request **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list/{name}/ip/{ipv4-addr} ` **name** **Description** LSN Rule-List 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 .. _43_lsn-rule-list-list_domain-ip: lsn-rule-list-list_domain-ip ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn-rule-list-list_default: lsn-rule-list-list_default ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rule-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn-rule-list-list_default_rule-cfg: lsn-rule-list-list_default_rule-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dscp-cfg** **Description:** dscp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_default_rule-cfg_dscp-cfg` **Type:** Object **icmp-others-cfg** **Description:** icmp-others-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_default_rule-cfg_icmp-others-cfg` **Type:** Object **proto** **Description** 'tcp': TCP L4 Protocol; 'udp': UDP L4 Protocol; 'icmp': ICMP L4 Protocol; 'others': Other L4 Protocol; 'dscp': Match dscp value; **Type:** string **Supported Values:** tcp, udp, icmp, others, dscp **tcp-cfg** **Description:** tcp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_default_rule-cfg_tcp-cfg` **Type:** Object **udp-cfg** **Description:** udp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_default_rule-cfg_udp-cfg` **Type:** Object .. _43_lsn-rule-list-list_default_rule-cfg_dscp-cfg: lsn-rule-list-list_default_rule-cfg_dscp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; **Type:** string **Supported Values:** action **action-type** **Description** 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-match** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); 'any': Match any dscp value; '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 .. _43_lsn-rule-list-list_default_rule-cfg_tcp-cfg: lsn-rule-list-list_default_rule-cfg_tcp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; 'template': Template; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **http-alg** **Description** HTTP-ALG Template (Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_default_rule-cfg_udp-cfg: lsn-rule-list-list_default_rule-cfg_udp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_default_rule-cfg_icmp-others-cfg: lsn-rule-list-list_default_rule-cfg_icmp-others-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_ip-list: lsn-rule-list-list_ip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-addr** **Description** Configure a Specific Rule-Set (IP Network Address) **Type:** string **Format:** ipv4-cidr **rule-cfg** **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 .. _43_lsn-rule-list-list_ip-list_rule-cfg: lsn-rule-list-list_ip-list_rule-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dscp-cfg** **Description:** dscp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_ip-list_rule-cfg_dscp-cfg` **Type:** Object **icmp-others-cfg** **Description:** icmp-others-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_ip-list_rule-cfg_icmp-others-cfg` **Type:** Object **proto** **Description** 'tcp': TCP L4 Protocol; 'udp': UDP L4 Protocol; 'icmp': ICMP L4 Protocol; 'others': Other L4 Protocol; 'dscp': Match dscp value; **Type:** string **Supported Values:** tcp, udp, icmp, others, dscp **tcp-cfg** **Description:** tcp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_ip-list_rule-cfg_tcp-cfg` **Type:** Object **udp-cfg** **Description:** udp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_ip-list_rule-cfg_udp-cfg` **Type:** Object .. _43_lsn-rule-list-list_ip-list_rule-cfg_dscp-cfg: lsn-rule-list-list_ip-list_rule-cfg_dscp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; **Type:** string **Supported Values:** action **action-type** **Description** 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-match** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); 'any': Match any dscp value; '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 .. _43_lsn-rule-list-list_ip-list_rule-cfg_tcp-cfg: lsn-rule-list-list_ip-list_rule-cfg_tcp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; 'template': Template; 'idle-timeout': Configure idle timeout; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template, idle-timeout **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **fast** **Description** 'fast': Fast Aging; **Type:** string **Supported Values:** fast **Mutual Exclusion:** fast and timeout-val are mutually exclusive **http-alg** **Description** HTTP-ALG Template (Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **timeout-val** **Description** Timeout in seconds **Type:** number **Range:** 2-129600 **Mutual Exclusion:** timeout-val and fast are mutually exclusive **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_ip-list_rule-cfg_udp-cfg: lsn-rule-list-list_ip-list_rule-cfg_udp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; 'idle-timeout': Configure idle timeout; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, idle-timeout **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **fast** **Description** 'fast': Fast Aging; **Type:** string **Supported Values:** fast **Mutual Exclusion:** fast and timeout-val are mutually exclusive **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **timeout-val** **Description** Timeout in seconds **Type:** number **Range:** 2-129600 **Mutual Exclusion:** timeout-val and fast are mutually exclusive **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_ip-list_rule-cfg_icmp-others-cfg: lsn-rule-list-list_ip-list_rule-cfg_icmp-others-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_domain-list-name-list: lsn-rule-list-list_domain-list-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name-domain-list** **Description** Configure a Specific Rule-Set (Domain List Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **rule-cfg** **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 .. _43_lsn-rule-list-list_domain-list-name-list_rule-cfg: lsn-rule-list-list_domain-list-name-list_rule-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dscp-cfg** **Description:** dscp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-list-name-list_rule-cfg_dscp-cfg` **Type:** Object **icmp-others-cfg** **Description:** icmp-others-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-list-name-list_rule-cfg_icmp-others-cfg` **Type:** Object **proto** **Description** 'tcp': TCP L4 Protocol; 'udp': UDP L4 Protocol; 'icmp': ICMP L4 Protocol; 'others': Other L4 Protocol; 'dscp': Match dscp value; **Type:** string **Supported Values:** tcp, udp, icmp, others, dscp **tcp-cfg** **Description:** tcp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-list-name-list_rule-cfg_tcp-cfg` **Type:** Object **udp-cfg** **Description:** udp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-list-name-list_rule-cfg_udp-cfg` **Type:** Object .. _43_lsn-rule-list-list_domain-list-name-list_rule-cfg_dscp-cfg: lsn-rule-list-list_domain-list-name-list_rule-cfg_dscp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; **Type:** string **Supported Values:** action **action-type** **Description** 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-match** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); 'any': Match any dscp value; '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 .. _43_lsn-rule-list-list_domain-list-name-list_rule-cfg_tcp-cfg: lsn-rule-list-list_domain-list-name-list_rule-cfg_tcp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; 'template': Template; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **http-alg** **Description** HTTP-ALG Template (Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_domain-list-name-list_rule-cfg_udp-cfg: lsn-rule-list-list_domain-list-name-list_rule-cfg_udp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_domain-list-name-list_rule-cfg_icmp-others-cfg: lsn-rule-list-list_domain-list-name-list_rule-cfg_icmp-others-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_domain-name-list: lsn-rule-list-list_domain-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name-domain** **Description** Configure a Specific Rule-Set (Domain Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **rule-cfg** **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 .. _43_lsn-rule-list-list_domain-name-list_rule-cfg: lsn-rule-list-list_domain-name-list_rule-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dscp-cfg** **Description:** dscp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-name-list_rule-cfg_dscp-cfg` **Type:** Object **icmp-others-cfg** **Description:** icmp-others-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-name-list_rule-cfg_icmp-others-cfg` **Type:** Object **proto** **Description** 'tcp': TCP L4 Protocol; 'udp': UDP L4 Protocol; 'icmp': ICMP L4 Protocol; 'others': Other L4 Protocol; 'dscp': Match dscp value; **Type:** string **Supported Values:** tcp, udp, icmp, others, dscp **tcp-cfg** **Description:** tcp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-name-list_rule-cfg_tcp-cfg` **Type:** Object **udp-cfg** **Description:** udp-cfg is a **JSON Block**. Please see below for :ref:`43_lsn-rule-list-list_domain-name-list_rule-cfg_udp-cfg` **Type:** Object .. _43_lsn-rule-list-list_domain-name-list_rule-cfg_dscp-cfg: lsn-rule-list-list_domain-name-list_rule-cfg_dscp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; **Type:** string **Supported Values:** action **action-type** **Description** 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-match** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); 'any': Match any dscp value; '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, any, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 .. _43_lsn-rule-list-list_domain-name-list_rule-cfg_tcp-cfg: lsn-rule-list-list_domain-name-list_rule-cfg_tcp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; 'template': Template; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp, template **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **http-alg** **Description** HTTP-ALG Template (Template Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_domain-name-list_rule-cfg_udp-cfg: lsn-rule-list-list_domain-name-list_rule-cfg_udp-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **end-port** **Description** End of Port Range (inclusive) **Type:** number **Range:** 1-65535 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **port-list** **Description** Port-List Name **Type:** string **Format:** string-rlx **Maximum Length:** 128 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **start-port** **Description** Single Port or Start of Port Range (inclusive), Port 0 is Match Any Port **Type:** number **Range:** 0-65535 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_lsn-rule-list-list_domain-name-list_rule-cfg_icmp-others-cfg: lsn-rule-list-list_domain-name-list_rule-cfg_icmp-others-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-cfg** **Description** 'action': LSN Rule-List Action; 'no-action': Exclude LSN Rule-List Action; **Type:** string **Supported Values:** action, no-action **action-type** **Description** 'dnat': Apply Dest NAT; 'drop': Drop the Packets; 'one-to-one-snat': Apply one-to-one source NAT for the packets; 'pass-through': Pass the Packets Through; 'snat': Redirect the Packets to a Different Source NAT Pool; 'set-dscp': To set dscp value for the packets; **Type:** string **Supported Values:** dnat, drop, one-to-one-snat, pass-through, snat, set-dscp **dscp-direction** **Description** 'inbound': To set dscp value for inbound packets; 'outbound': To set dscp value for outbound packets; **Type:** string **Supported Values:** inbound, outbound **dscp-value** **Description** 'default': Default dscp (000000); 'af11': AF11 (001010); 'af12': AF12 (001100); 'af13': AF13 (001110); 'af21': AF21 (010010); 'af22': AF22 (010100); 'af23': AF23 (010110); 'af31': AF31 (011010); 'af32': AF32 (011100); 'af33': AF33 (011110); 'af41': AF41 (100010); 'af42': AF42 (100100); 'af43': AF43 (100110); 'cs1': CS1 (001000); 'cs2': CS2 (010000); 'cs3': CS3 (011000); 'cs4': CS4 (100000); 'cs5': CS5 (101000); 'cs6': CS6 (110000); 'cs7': CS7 (111000); 'ef': EF (101110); '0': 000000; '1': 000001; '2': 000010; '3': 000011; '4': 000100; '5': 000101; '6': 000110; '7': 000111; '8': 001000; '9': 001001; '10': 001010; '11': 001011; '12': 001100; '13': 001101; '14': 001110; '15': 001111; '16': 010000; '17': 010001; '18': 010010; '19': 010011; '20': 010100; '21': 010101; '22': 010110; '23': 010111; '24': 011000; '25': 011001; '26': 011010; '27': 011011; '28': 011100; '29': 011101; '30': 011110; '31': 011111; '32': 100000; '33': 100001; '34': 100010; '35': 100011; '36': 100100; '37': 100101; '38': 100110; '39': 100111; '40': 101000; '41': 101001; '42': 101010; '43': 101011; '44': 101100; '45': 101101; '46': 101110; '47': 101111; '48': 110000; '49': 110001; '50': 110010; '51': 110011; '52': 110100; '53': 110101; '54': 110110; '55': 110111; '56': 111000; '57': 111001; '58': 111010; '59': 111011; '60': 111100; '61': 111101; '62': 111110; '63': 111111; **Type:** string **Supported Values:** default, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 **ipv4-list** **Description** IP-List (IP-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **no-snat** **Description** Disable source NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pool** **Description** NAT Pool (NAT Pool or Pool Group) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** The pool is a shared pool **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **vrid** **Description** VRRP-A vrid **Type:** number **Range:** 1-31 .. _43_service-group-list: service-group-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **health-check** **Description** Health Check (Monitor Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/health/monitor ` **member-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/service-group/{name}/member/{name}+{port} ` **name** **Description** CGNV6 Service Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **protocol** **Description** 'tcp': TCP LB service; 'udp': UDP LB service; **Type:** string **Supported Values:** tcp, udp **shared** **Description** Share with partition **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **shared-group** **Description** Share with a partition group (Partition Group Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** shared-group and shared-partition are mutually exclusive **shared-partition** **Description** Share with a single partition (Partition Name) **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **Mutual Exclusion:** shared-partition and shared-group are mutually exclusive **traffic-replication-mirror-ip-repl** **Description** Replaces IP with server-IP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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 .. _43_service-group-list_member-list: service-group-list_member-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** Member name **Type:** string **Format:** comp-string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/server ` **port** **Description** Port number **Type:** number **Range:** 0-65534 **Default:** 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 .. _43_http-alg: http-alg ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ecmp: ecmp ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **hashing-type** **Description** '4-tuple-hash': Hash on Src IP , Src Port, Dest IP and Dest Port; **Type:** string **Supported Values:** 4-tuple-hash **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lsn-radius-profile-list: lsn-radius-profile-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lid-profile-index** **Description** LSN RADIUS Profile Index **Type:** number **Range:** 1-16 **radius** **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 .. _43_lsn-radius-profile-list_radius: lsn-radius-profile-list_radius ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **attribute** **Description** 'custom1': Configure RADIUS Attribute Custom 1; 'custom2': Configure RADIUS Attribute Custom 2; 'custom3': Configure RADIUS Attribute Custom 3; 'custom4': Configure RADIUS Attribute Custom 4; 'custom5': Configure RADIUS Attribute Custom 5; 'custom6': Configure RADIUS Attribute Custom 6; 'imei': Configure RADIUS Attribute IMEI; 'imsi': Configure RADIUS Attribute IMSI; 'msisdn': Configure RADIUS Attribute MSISDN; 'default': Configure default; **Type:** string **Supported Values:** custom1, custom2, custom3, custom4, custom5, custom6, imei, imsi, msisdn, default **default-lsn-lid** **Description** LSN Limit ID (LID index) **Type:** number **Range:** 1-1023 **exact-value** **Description** Value of the attribute **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **exact-value-lsn-lid** **Description** LSN Limit ID (LID index) **Type:** number **Range:** 1-1023 **starts-with** **Description** Value of the attribute **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **starts-with-lsn-lid** **Description** LSN Limit ID (LID index) **Type:** number **Range:** 1-1023 .. _43_server-list: server-list ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': Enable this Real Server; 'disable': Disable this Real Server; **Type:** string **Supported Values:** enable, disable **Default:** enable **fqdn-name** **Description** Server hostname **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **health-check** **Description** Health Check Monitor (Health monitor name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive **Refernce Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable configured health check configuration **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive **host** **Description** IP Address **Type:** string **Format:** ipv4-address **name** **Description** Server Name **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **port-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/server/{name}/port/{port-number}+{protocol} ` **resolve-as** **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN; 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; **Type:** string **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6 **Default:** resolve-to-ipv4 **server-ipv6-addr** **Description** IPV6 address **Type:** string **Format:** ipv6-address **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 .. _43_server-list_port-list: server-list_port-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': enable; 'disable': disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **follow-port-protocol** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **health-check** **Description** Health Check (Monitor Name) **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** health-check health-check-follow-port and health-check-disable are mutually exclusive **Refernce Object:** :doc:`/axapi/v3/health/monitor ` **health-check-disable** **Description** Disable health check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive **health-check-follow-port** **Description** Specify which port to follow for health status (Port Number) **Type:** number **Range:** 1-65534 **Mutual Exclusion:** health-check-follow-port and health-check are mutually exclusive **port-number** **Description** Port Number **Type:** number **Range:** 0-65534 **protocol** **Description** 'tcp': TCP Port; 'udp': UDP Port; **Type:** string **Supported Values:** tcp, udp **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 .. _43_l4: l4 ^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6: lw-4o6 ^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **active-binding-table** **Description:** active-binding-table is a **JSON Block**. Please see below for :ref:`43_lw-4o6_active-binding-table` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/active-binding-table ` **all-binding-tables** **Description:** all-binding-tables is a **JSON Block**. Please see below for :ref:`43_lw-4o6_all-binding-tables` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/all-binding-tables ` **binding-table-files-status** **Description:** binding-table-files-status is a **JSON Block**. Please see below for :ref:`43_lw-4o6_binding-table-files-status` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/binding-table-files-status ` **binding-table-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/binding-table/{name} ` **binding-table-validate** **Description:** binding-table-validate is a **JSON Block**. Please see below for :ref:`43_lw-4o6_binding-table-validate` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/binding-table-validate ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_lw-4o6_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/fragmentation ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`43_lw-4o6_global` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/global ` **health-check-gateway-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/health-check-gateway/{ipv4-addr}+{ipv6-addr} ` **validation-log-files** **Description:** validation-log-files is a **JSON Block**. Please see below for :ref:`43_lw-4o6_validation-log-files` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/validation-log-files ` .. _43_lw-4o6_fragmentation: lw-4o6_fragmentation ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_lw-4o6_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_lw-4o6_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/fragmentation/outbound ` .. _43_lw-4o6_fragmentation_inbound: lw-4o6_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-set** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'ipv6': Use IPv6 fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); **Type:** string **Supported Values:** drop, ipv4, ipv6, send-icmp **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'ipv6': Use IPv6 fragmentation for oversize packets (default); **Type:** string **Supported Values:** drop, ipv4, ipv6 **Default:** ipv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_fragmentation_outbound: lw-4o6_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **df-set** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set)(default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmp, send-icmpv6 **Default:** send-icmp **frag-action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv4, send-icmpv6 **Default:** ipv4 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_health-check-gateway-list: lw-4o6_health-check-gateway-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-addr** **Description** LW-4over6 IPv4 Gateway **Type:** string **Format:** ipv4-address **ipv6-addr** **Description** LW-4over6 IPv6 Gateway **Type:** string **Format:** ipv6-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_active-binding-table: lw-4o6_active-binding-table ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_global: lw-4o6_global ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **hairpinning** **Description** 'filter-all': Disable all Hairpinning; 'filter-none': Allow all Hairpinning (default); 'filter-self-ip': Block Hairpinning to same IP; 'filter-self-ip-port': Block hairpinning to same IP and Port combination; **Type:** string **Supported Values:** filter-all, filter-none, filter-self-ip, filter-self-ip-port **Default:** filter-none **icmp-inbound** **Description** 'drop': Drop Inbound ICMP packets; 'handle': Handle Inbound ICMP packets(default); **Type:** string **Supported Values:** drop, handle **Default:** handle **inside-src-access-list** **Description** Access List for inside IPv4 addresses (ACL ID) **Type:** number **Range:** 1-199 **nat-prefix-list** **Description** Configure LW-4over6 NAT Prefix List (LW-4over6 NAT Prefix Class-list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **no-forward-match** **Description:** no-forward-match is a **JSON Block**. Please see below for :ref:`43_lw-4o6_global_no-forward-match` **Type:** Object **no-reverse-match** **Description:** no-reverse-match is a **JSON Block**. Please see below for :ref:`43_lw-4o6_global_no-reverse-match` **Type:** Object **use-binding-table** **Description** Bind LW-4over6 binding table for use (LW-4over6 Binding Table 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 .. _43_lw-4o6_global_no-forward-match: lw-4o6_global_no-forward-match ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **send-icmpv6** **Description** Send ICMPv6 Type 1 Code 5 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_lw-4o6_global_no-reverse-match: lw-4o6_global_no-reverse-match ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **send-icmp** **Description** Send ICMP Type 3 Code 1 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_lw-4o6_binding-table-validate: lw-4o6_binding-table-validate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **binding-name** **Description** LW-4over6 Binding Table Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _43_lw-4o6_all-binding-tables: lw-4o6_all-binding-tables ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_binding-table-files-status: lw-4o6_binding-table-files-status ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_validation-log-files: lw-4o6_validation-log-files ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_lw-4o6_binding-table-list: lw-4o6_binding-table-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **name** **Description** LW-4over6 Binding Table Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **tunnel-address-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/binding-table/{name}/tunnel-address/{ipv6-tunnel-addr} ` **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _43_lw-4o6_binding-table-list_tunnel-address-list: lw-4o6_binding-table-list_tunnel-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv6-tunnel-addr** **Description** Tunnel IPv6 Endpoint Address **Type:** string **Format:** ipv6-address **nat-address-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/binding-table/{name}/tunnel-address/{ipv6-tunnel-addr}/nat-address/{ipv4-nat-addr} ` **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _43_lw-4o6_binding-table-list_tunnel-address-list_nat-address-list: lw-4o6_binding-table-list_tunnel-address-list_nat-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-nat-addr** **Description** NAT IPv4 Address **Type:** string **Format:** ipv4-address **port-range-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/lw-4o6/binding-table/{name}/tunnel-address/{ipv6-tunnel-addr}/nat-address/{ipv4-nat-addr}/port-range/{port-start}+{port-end}+{tunnel-endpoint-address} ` **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters .. _43_lw-4o6_binding-table-list_tunnel-address-list_nat-address-list_port-range-list: lw-4o6_binding-table-list_tunnel-address-list_nat-address-list_port-range-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **port-end** **Description** Port Range End **Type:** number **Range:** 1-65535 **port-start** **Description** Single Port or Port Range Start **Type:** number **Range:** 1-65535 **tunnel-endpoint-address** **Description** Configure LW-4over6 IPIP Tunnel Endpoint Address (LW-4over6 Tunnel Endpoint Address) **Type:** string **Format:** ipv6-address .. _43_ddos-protection: ddos-protection ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **disable-nat-ip-by-bgp** **Description:** disable-nat-ip-by-bgp is a **JSON Block**. Please see below for :ref:`43_ddos-protection_disable-nat-ip-by-bgp` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ddos-protection/disable-nat-ip-by-bgp ` **ip-entries** **Description:** ip-entries is a **JSON Block**. Please see below for :ref:`43_ddos-protection_ip-entries` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ddos-protection/ip-entries ` **l4-entries** **Description:** l4-entries is a **JSON Block**. Please see below for :ref:`43_ddos-protection_l4-entries` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/ddos-protection/l4-entries ` **logging** **Description:** logging is a **JSON Block**. Please see below for :ref:`43_ddos-protection_logging` **Type:** Object **max-hw-entries** **Description** Configure maximum HW entries **Type:** number **Range:** 0-262144 **Default:** 262144 **packets-per-second** **Description:** packets-per-second is a **JSON Block**. Please see below for :ref:`43_ddos-protection_packets-per-second` **Type:** Object **syn-cookie** **Description:** syn-cookie is a **JSON Block**. Please see below for :ref:`43_ddos-protection_syn-cookie` **Type:** Object **toggle** **Description** 'enable': Enable CGNV6 NAT pool DDoS protection (default); 'disable': Disable CGNV6 NAT pool DDoS protection; **Type:** string **Supported Values:** enable, disable **Default:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **zone** **Description** Disable NAT IP based on DDoS zone name set in BGP **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _43_ddos-protection_logging: ddos-protection_logging ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **enable-action** **Description** 'local': Enable local logs only; 'remote': Enable logging to remote server & IPFIX; 'both': Enable both local & remote logs; **Type:** string **Supported Values:** local, remote, both **Default:** local **logging-action** **Description** 'enable': enable CGN DDoS protection logging; 'disable': Disable both local & remote CGN DDoS protection logging; **Type:** string **Supported Values:** enable, disable **Default:** enable .. _43_ddos-protection_ip-entries: ddos-protection_ip-entries ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ddos-protection_disable-nat-ip-by-bgp: ddos-protection_disable-nat-ip-by-bgp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ddos-protection_l4-entries: ddos-protection_l4-entries ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_ddos-protection_packets-per-second: ddos-protection_packets-per-second ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description:** action is a **JSON Block**. Please see below for :ref:`43_ddos-protection_packets-per-second_action` **Type:** Object **include-existing-session** **Description** Count traffic associated with existing session into the packets-per-second (Default: Disabled) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip** **Description** Configure packets-per-second threshold per IP(default 3000000) **Type:** number **Range:** 0-30000000 **Default:** 3000000 **other** **Description** Configure packets-per-second threshold for other L4 protocols(default 10000) **Type:** number **Range:** 0-30000000 **Default:** 10000 **tcp** **Description** Configure packets-per-second threshold per TCP port (default: 3000) **Type:** number **Range:** 0-30000000 **Default:** 3000 **udp** **Description** Configure packets-per-second threshold per UDP port (default: 3000) **Type:** number **Range:** 0-30000000 **Default:** 3000 .. _43_ddos-protection_packets-per-second_action: ddos-protection_packets-per-second_action ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action-type** **Description** 'log': Log the event only; 'drop': Log, and drop all packets (default); 'redistribute-route': Log, Drop, and Notify upstream router to reroute the packets; **Type:** string **Supported Values:** log, drop, redistribute-route **Default:** drop **expiration** **Description** To specify time to revert the action after pps is decreased to below threshold (Expiration time, in seconds (default is 3600 seconds)) **Type:** number **Range:** 10-8640000 **Default:** 3600 **remove-wait-timer** **Description** Time after which IP will be removed from blackhole **Type:** number **Range:** 0-300 **Default:** 300 **route-map** **Description** Route map name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **timer-multiply-max** **Description** To specify max value of timer multiplier for attacks lasted long time (Max value of timer multiplier (default is 6)) **Type:** number **Range:** 1-100 **Default:** 6 .. _43_ddos-protection_syn-cookie: ddos-protection_syn-cookie ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **syn-cookie-enable** **Description** Enable CGNv6 Syn-Cookie Protection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **syn-cookie-on-threshold** **Description** on-threshold for Syn-cookie (Decimal number) **Type:** number **Range:** 1-1000000 **syn-cookie-on-timeout** **Description** on-timeout for Syn-cookie (Timeout in seconds, default is 120 seconds (2 minutes)) **Type:** number **Range:** 1-300000 **Default:** 120 .. _43_lsn-lid-list: lsn-lid-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **conn-rate-limit** **Description:** conn-rate-limit is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_conn-rate-limit` **Type:** Object **ds-lite** **Description:** ds-lite is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_ds-lite` **Type:** Object **extended-user-quota** **Description:** extended-user-quota is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_extended-user-quota` **Type:** Object **lid-number** **Description** LSN Lid **Type:** number **Range:** 1-1023 **lsn-rule-list** **Description:** lsn-rule-list is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_lsn-rule-list` **Type:** Object **name** **Description** LSN Lid Name **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **override** **Description** 'none': Apply source NAT if configured (default); 'drop': Drop packets that match this LSN lid; 'pass-through': Layer-3 route packets that match this LSN lid and do not apply source NAT; **Type:** string **Supported Values:** none, drop, pass-through **Default:** none **respond-to-user-mac** **Description** Use the user's source MAC for the next hop rather than the routing table (default: off) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **source-nat-pool** **Description:** source-nat-pool is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_source-nat-pool` **Type:** Object **user-quota** **Description:** user-quota is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_user-quota` **Type:** Object **user-quota-prefix-length** **Description** NAT64/DS-Lite user quota prefix length (Prefix Length (Default: Uses the global NAT64/DS-Lite configured value)) **Type:** number **Range:** 1-128 **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 .. _43_lsn-lid-list_extended-user-quota: lsn-lid-list_extended-user-quota ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp** **Type:** List **udp** **Type:** List .. _43_lsn-lid-list_extended-user-quota_udp: lsn-lid-list_extended-user-quota_udp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **udp-service-port** **Description** Port (Port Value) **Type:** number **Range:** 1-65535 **udp-sessions** **Description** Number of Extended Quota sessions allowed for this service **Type:** number **Range:** 1-255 .. _43_lsn-lid-list_extended-user-quota_tcp: lsn-lid-list_extended-user-quota_tcp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **tcp-service-port** **Description** Port (Port Value) **Type:** number **Range:** 1-65535 **tcp-sessions** **Description** Number of Extended Quota sessions allowed for this service **Type:** number **Range:** 1-255 .. _43_lsn-lid-list_ds-lite: lsn-lid-list_ds-lite ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inside-src-permit-list** **Description** Class-List of IPv4 addresses permitted (Class-list to match for DS-Lite) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _43_lsn-lid-list_user-quota: lsn-lid-list_user-quota ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **icmp** **Description** User Quota for ICMP identifiers (NAT port quota per user (default: not configured)) **Type:** number **Range:** 1-64000 **quota-tcp** **Description:** quota-tcp is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_user-quota_quota-tcp` **Type:** Object **quota-udp** **Description:** quota-udp is a **JSON Block**. Please see below for :ref:`43_lsn-lid-list_user-quota_quota-udp` **Type:** Object **session** **Description** User Quota for number of data sessions **Type:** number **Range:** 1-2147483647 .. _43_lsn-lid-list_user-quota_quota-tcp: lsn-lid-list_user-quota_quota-tcp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **tcp-quota** **Description** NAT port quota per user (default: not configured) **Type:** number **Range:** 1-64000 **tcp-reserve** **Description** Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value)) **Type:** number **Range:** 0-64000 .. _43_lsn-lid-list_user-quota_quota-udp: lsn-lid-list_user-quota_quota-udp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **udp-quota** **Description** NAT port quota per user (default: not configured) **Type:** number **Range:** 1-64000 **udp-reserve** **Description** Number of ports to reserve per user (default: same as user-quota value) (Reserved quota per user (default: same as user-quota value)) **Type:** number **Range:** 0-64000 .. _43_lsn-lid-list_source-nat-pool: lsn-lid-list_source-nat-pool ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **pool-name** **Description** Source NAT Pool or Pool-Group **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **shared** **Description** Use a shared source NAT pool or pool-group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _43_lsn-lid-list_conn-rate-limit: lsn-lid-list_conn-rate-limit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **conn-rate-limit-val** **Description** Maximum connections per second (Default: No limit) **Type:** number **Range:** 1-65535 .. _43_lsn-lid-list_lsn-rule-list: lsn-lid-list_lsn-rule-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **destination** **Description** Apply LSN Rule-List on Destination (LSN Rule-List Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Refernce Object:** :doc:`/axapi/v3/cgnv6/lsn-rule-list ` .. _43_sixrd: sixrd ^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **domain-list** **Type:** List **Refernce Object:** :doc:`/axapi/v3/cgnv6/sixrd/domain/{name} ` **fragmentation** **Description:** fragmentation is a **JSON Block**. Please see below for :ref:`43_sixrd_fragmentation` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sixrd/fragmentation ` .. _43_sixrd_domain-list: sixrd_domain-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **br-ipv4-address** **Description** 6rd BR IPv4 address **Type:** string **Format:** ipv4-address **ce-ipv4-netmask** **Description** Mask length **Type:** string **Format:** ipv4-netmask-brief **ce-ipv4-network** **Description** Customer Edge IPv4 network **Type:** string **Format:** ipv4-address **ipv6-prefix** **Description** IPv6 prefix **Type:** string **Format:** ipv6-address-plen **mtu** **Description** Tunnel MTU **Type:** number **Range:** 1280-1480 **name** **Description** 6rd Domain name **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 .. _43_sixrd_fragmentation: sixrd_fragmentation ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **inbound** **Description:** inbound is a **JSON Block**. Please see below for :ref:`43_sixrd_fragmentation_inbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sixrd/fragmentation/inbound ` **outbound** **Description:** outbound is a **JSON Block**. Please see below for :ref:`43_sixrd_fragmentation_outbound` **Type:** Object **Refernce Object:** :doc:`/axapi/v3/cgnv6/sixrd/fragmentation/outbound ` .. _43_sixrd_fragmentation_inbound: sixrd_fragmentation_inbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'drop': Drop Silently; 'ipv4': Use IPv4 fragmentation for oversize packets; 'ipv6': Use IPv6 Fragmentation for oversize packets; 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big) (default); **Type:** string **Supported Values:** drop, ipv4, ipv6, send-icmpv6 **Default:** send-icmpv6 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _43_sixrd_fragmentation_outbound: sixrd_fragmentation_outbound ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 Fragmentation for oversize packets (default); 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv6, send-icmp, send-icmpv6 **Default:** ipv6 **count** **Description** Configure number of ICMP messages sent when DF set. Default is 1 **Type:** number **Range:** 1-5 **df-set** **Description** 'drop': Drop Silently; 'ipv6': Use IPv6 Fragmentation for oversize packets; 'send-icmp': Send ICMP Type 3 Code 4 (Fragmentation Needed and DF Set) (default); 'send-icmpv6': Send ICMP Type 2 Code 0 (Packet Too Big); **Type:** string **Supported Values:** drop, ipv6, send-icmp, send-icmpv6 **Default:** send-icmp **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters