.. _ip_nat_pool:

ip nat pool
===========

Configure IP pool name


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

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

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

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

	 **Collection Name**                   :ref:`2123_pool_list`

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

	                                       

	 **Element Name**                      pool

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

	 **Element Attributes**                pool_attributes

	 **Partition Visibility**              shared

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

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

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



.. raw:: html

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


:ref:`2123_pool_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/ip_nat_pool_POST.txt
   :literal:




.. raw:: html

   </div></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/ip/nat/pool



.. raw:: html

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


:ref:`2123_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/ip/nat/pool/{pool-name}



.. raw:: html

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


:ref:`2123_pool_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/ip_nat_pool_GET.txt
   :literal:




.. raw:: html

   </div></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/ip/nat/pool



.. raw:: html

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


:ref:`2123_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/ip/nat/pool/{pool-name}



.. raw:: html

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


:ref:`2123_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/ip/nat/pool/{pool-name}



.. raw:: html

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


:ref:`2123_pool_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/ip_nat_pool_PUT.txt
   :literal:




.. raw:: html

   </div></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/ip/nat/pool



.. raw:: html

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


:ref:`2123_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/ip/nat/pool/{pool-name}



.. raw:: html

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


:ref:`2123_pool_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/ip_nat_pool_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2123_pool_list:

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


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

        pool-list : [

             { :ref:`2123_pool_attributes` },

             { :ref:`2123_pool_attributes` },

             ...

         ]

.. _2123_pool_attributes:

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

    **chunk-sharing**

        **Description** Share NAT pool chunk across CPUs

        **Type:** boolean

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

        **Default:** 0

    **end-address**

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

        **Type:** string

        **Format:** ipv4-address

    **ethernet**

        **Description** Ethernet interface

        **Type:** number

        **Format:** interface

    **gateway**

        **Description** Configure gateway IP

        **Type:** string

        **Format:** ipv4-address

    **ip-rr**

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

        **Type:** boolean

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

        **Default:** 0

    **netmask**

        **Description** Configure mask for pool

        **Type:** string

        **Format:** ipv4-netmask-brief

    **pool-name**

        **Description** Specify pool name or pool group

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **port-overload**

        **Description** Nat Pool Port overload

        **Type:** boolean

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

        **Default:** 0

    **scaleout-device-id**

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

        **Type:** number

        **Range:** 1-16

    **start-address**

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

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** start-address and use-if-ip are mutually exclusive

    **use-if-ip**

        **Description** Use Interface IP

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** use-if-ip and start-address are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **vrid**

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

        **Type:** number

        **Range:** 1-31

        **Reference Object:** :doc:`/axapi/v3/vrrp-a/vrid <vrrp_a_vrid>`