.. _ipv6_nat:

ipv6 nat
========

Configure IPv6 NAT


nat Specification
-----------------

	===================================== =================================================
	 **Parameter**                         **Value** 

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

	 **Element Name**                      nat

	 **Element URI**                       /axapi/v3/ipv6/nat

	 **Element Attributes**                nat_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`nat schema <ipv6-nat/ipv6-nat.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/ipv6/nat



.. raw:: html

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


nat_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2182_nat_attributes:

nat attributes
--------------

    **icmpv6**

        **Description:** icmpv6 is a **JSON Block**.  Please see below for :ref:`2182_icmpv6` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/icmpv6 <ipv6_nat_icmpv6>`

    **inside**

        **Description:** inside is a **JSON Block**.  Please see below for :ref:`2182_inside` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/inside <ipv6_nat_inside>`

    **pool-group-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool-group/{pool-group-name} <ipv6_nat_pool_group>`

    **pool-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool/{pool-name} <ipv6_nat_pool>`

.. _2182_icmpv6:

icmpv6
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **respond-to-ping**

        **Description** Respond to ICMPv6 echo requests to NAT pool IPs (default: disabled)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2182_pool-group-list:

pool-group-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **member-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool-group/{pool-group-name}/member/{pool-name} <ipv6_nat_pool_group>`

    **pool-group-name**

        **Description** Specify pool group name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

        **Description** Specify VRRP-A vrid (Specify ha VRRP-A vrid)

        **Type:** number

        **Range:** 1-31

.. _2182_pool-group-list_sampling-enable:

pool-group-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'Failed': some-help-string; 

        **Type:** string

        **Supported Values:** all, Failed

.. _2182_pool-group-list_member-list:

pool-group-list_member-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **pool-name**

        **Description** Specify NAT pool name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2182_inside:

inside
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **source**

        **Description:** source is a **JSON Block**.  Please see below for :ref:`2182_inside_source` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/inside/source <ipv6_nat_inside_source>`

.. _2182_inside_source:

inside_source
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **list-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/inside/source/list/{list-name} <ipv6_nat_inside_source_list>`

.. _2182_inside_source_list-list:

inside_source_list-list
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **list-name**

        **Description** IPv6 access-list name

        **Type:** string

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ipv6/access-list <ipv6_access_list>`

    **pool**

        **Description** IPv6 NAT Pool (Pool Name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/ipv6/nat/pool-group <ipv6_nat_pool_group>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2182_pool-list:

pool-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **chunk-sharing**

        **Description** Share NAT pool chunk across CPUs

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **end-address**

        **Description** Configure end IP address of NAT pool

        **Type:** string

        **Format:** ipv6-address

    **gateway**

        **Description** Configure gateway IP

        **Type:** string

        **Format:** ipv6-address

    **ip-rr**

        **Description** Use IP address round-robin behavior

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **netmask**

        **Description** Configure mask for pool

        **Type:** number

        **Range:** 64-128

    **pool-name**

        **Description** Specify pool name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **port-overload**

        **Description** Nat Pool Port overload

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **sampling-enable**

        **Type:** List

    **scaleout-device-id**

        **Description** Configure Scaleout device id to which this NAT pool is to be bound (Specify Scaleout device id)

        **Type:** number

        **Range:** 1-16

    **start-address**

        **Description** Configure start IP address of NAT pool

        **Type:** string

        **Format:** ipv6-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

        **Description** Specify VRRP-A vrid (Specify ha VRRP-A vrid)

        **Type:** number

        **Range:** 1-31

.. _2182_pool-list_sampling-enable:

pool-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'Port-Usage': some help string; 'Total-Used': some help string; 'Total-Freed': some help string; 'Failed': some help string; 

        **Type:** string

        **Supported Values:** all, Port-Usage, Total-Used, Total-Freed, Failed