.. _ipv6_nat_pool:

ipv6 nat pool
=============

IPv6 pool name


pool Specification
------------------

	===================================== ==================================================================
	===================================== ==================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *pool-name*

	 **Collection Name**                   :ref:`1240_pool_list`

	 **Collection URI**                    /axapi/v3/ipv6/nat/pool

	                                       

	 **Element Name**                      pool

	 **Element URI**                       /axapi/v3/ipv6/nat/pool/{pool-name}

	 **Element Attributes**                pool_attributes

	 **Statistics Data URI**               /axapi/v3/ipv6/nat/pool/{pool-name}/stats

	 **Operational Data URI**              /axapi/v3/ipv6/nat/pool/{pool-name}/oper

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


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ipv6/nat/pool



.. raw:: html

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


:ref:`1240_pool_attributes`



.. raw:: html

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




.. raw:: html

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


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ipv6/nat/pool



.. raw:: html

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


:ref:`1240_pool_attributes`



.. raw:: html

   </td><td></td></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/pool/{pool-name}



.. raw:: html

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


:ref:`1240_pool_attributes`



.. raw:: html

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




.. raw:: html

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


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ipv6/nat/pool



.. raw:: html

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


:ref:`1240_pool_list`



.. raw:: html

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




.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ipv6/nat/pool/{pool-name}



.. raw:: html

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


:ref:`1240_pool_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ipv6/nat/pool/{pool-name}



.. raw:: html

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


:ref:`1240_pool_attributes`



.. raw:: html

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




.. raw:: html

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


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ipv6/nat/pool



.. raw:: html

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


:ref:`1240_pool_list`



.. raw:: html

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




.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/ipv6/nat/pool/{pool-name}



.. raw:: html

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


:ref:`1240_pool_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1240_pool_list:

pool-list
---------


    pool-list is **JSON List** of :ref:`1240_pool_attributes` 

        pool-list : [

             { :ref:`1240_pool_attributes` },

             { :ref:`1240_pool_attributes` },

             ...

         ]

.. _1240_pool_attributes:

pool attributes
---------------

    **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

.. _1240_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1240_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - Failed
      - 8
      - some help string

   *  - 
      - Total-Used
      - 8
      - some help string

   *  - 
      - Total-Freed
      - 8
      - some help string

   *  - 
      - Port-Usage
      - 8
      - some help string

.. _1240_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - nat-pool-addr-list
      - 
      - nat-pool-addr-list