.. _cgnv6_nat64:

cgnv6 nat64
===========

Configure NAT64


nat64 Specification
-------------------

	===================================== ====================================================
	===================================== ====================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      nat64

	 **Element URI**                       /axapi/v3/cgnv6/nat64

	 **Element Attributes**                nat64_attributes

	 **Schema**                             :download:`nat64 schema <cgnv6-nat64/cgnv6-nat64.txt>`
	===================================== ====================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cgnv6/nat64



.. raw:: html

   </td><td valign = 'top'>


nat64_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _730_nat64_attributes:

nat64 attributes
----------------

    **alg**

        **Description:** alg is a **JSON Block**.  Please see below for :ref:`730_alg` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg <cgnv6_nat64_alg>`

    **enhanced-user-tracking**

        **Description:** enhanced-user-tracking is a **JSON Block**.  Please see below for :ref:`730_enhanced-user-tracking` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/enhanced-user-tracking <cgnv6_nat64_enhanced_user_tracking>`

    **fragmentation**

        **Description:** fragmentation is a **JSON Block**.  Please see below for :ref:`730_fragmentation` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation <cgnv6_nat64_fragmentation>`

    **full-cone-session**

        **Description:** full-cone-session is a **JSON Block**.  Please see below for :ref:`730_full-cone-session` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/full-cone-session <cgnv6_nat64_full_cone_session>`

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`730_global` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/global <cgnv6_nat64_global>`

    **prefix-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/prefix/{prefix-val} <cgnv6_nat64_prefix>`

    **user-quota-session**

        **Description:** user-quota-session is a **JSON Block**.  Please see below for :ref:`730_user-quota-session` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/user-quota-session <cgnv6_nat64_user_quota_session>`

.. _730_fragmentation:

fragmentation
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **df-bit-transparency**

        **Description:** df-bit-transparency is a **JSON Block**.  Please see below for :ref:`730_fragmentation_df-bit-transparency` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation/df-bit-transparency <cgnv6_nat64_fragmentation_df_bit_transparency>`

    **inbound**

        **Description:** inbound is a **JSON Block**.  Please see below for :ref:`730_fragmentation_inbound` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation/inbound <cgnv6_nat64_fragmentation_inbound>`

    **outbound**

        **Description:** outbound is a **JSON Block**.  Please see below for :ref:`730_fragmentation_outbound` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/fragmentation/outbound <cgnv6_nat64_fragmentation_outbound>`

.. _730_fragmentation_inbound:

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

.. _730_fragmentation_outbound:

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

.. _730_fragmentation_df-bit-transparency:

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

.. _730_full-cone-session:

full-cone-session
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _730_alg:

alg
^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **esp**

        **Description:** esp is a **JSON Block**.  Please see below for :ref:`730_alg_esp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/esp <cgnv6_nat64_alg_esp>`

    **ftp**

        **Description:** ftp is a **JSON Block**.  Please see below for :ref:`730_alg_ftp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/ftp <cgnv6_nat64_alg_ftp>`

    **h323**

        **Description:** h323 is a **JSON Block**.  Please see below for :ref:`730_alg_h323` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/h323 <cgnv6_nat64_alg_h323>`

    **mgcp**

        **Description:** mgcp is a **JSON Block**.  Please see below for :ref:`730_alg_mgcp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/mgcp <cgnv6_nat64_alg_mgcp>`

    **pptp**

        **Description:** pptp is a **JSON Block**.  Please see below for :ref:`730_alg_pptp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/pptp <cgnv6_nat64_alg_pptp>`

    **rtsp**

        **Description:** rtsp is a **JSON Block**.  Please see below for :ref:`730_alg_rtsp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/rtsp <cgnv6_nat64_alg_rtsp>`

    **sip**

        **Description:** sip is a **JSON Block**.  Please see below for :ref:`730_alg_sip` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/sip <cgnv6_nat64_alg_sip>`

    **tftp**

        **Description:** tftp is a **JSON Block**.  Please see below for :ref:`730_alg_tftp` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/cgnv6/nat64/alg/tftp <cgnv6_nat64_alg_tftp>`

.. _730_alg_ftp:

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

.. _730_alg_sip:

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

.. _730_alg_esp:

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

.. _730_alg_pptp:

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

.. _730_alg_rtsp:

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

.. _730_alg_h323:

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

.. _730_alg_tftp:

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

.. _730_alg_mgcp:

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

.. _730_global:

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:`730_global_icmp` 

        **Type:** Object

    **inside**

        **Description:** inside is a **JSON Block**.  Please see below for :ref:`730_global_inside` 

        **Type:** Object

    **tcp**

        **Description:** tcp is a **JSON Block**.  Please see below for :ref:`730_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

.. _730_global_inside:

global_inside
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **source**

        **Description:** source is a **JSON Block**.  Please see below for :ref:`730_global_inside_source` 

        **Type:** Object

.. _730_global_inside_source:

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

.. _730_global_tcp:

global_tcp
^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **mss-clamp**

        **Description:** mss-clamp is a **JSON Block**.  Please see below for :ref:`730_global_tcp_mss-clamp` 

        **Type:** Object

    **reset-on-error**

        **Description:** reset-on-error is a **JSON Block**.  Please see below for :ref:`730_global_tcp_reset-on-error` 

        **Type:** Object

.. _730_global_tcp_mss-clamp:

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

.. _730_global_tcp_reset-on-error:

global_tcp_reset-on-error
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **outbound**

        **Description** 'disable': Disable send TCP reset on error; 

        **Type:** string

        **Supported Values:** disable

.. _730_global_icmp:

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

.. _730_prefix-list:

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

.. _730_user-quota-session:

user-quota-session
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _730_enhanced-user-tracking:

enhanced-user-tracking
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters