.. _ipv6_nat_pool_group:

ipv6 nat pool-group
===================

IPv6 pool group name


pool-group Specification
------------------------

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

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

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

	 **Collection Name**                   :ref:`2178_pool-group_list`

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

	                                       

	 **Element Name**                      pool-group

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

	 **Element Attributes**                pool-group_attributes

	 **Partition Visibility**              shared

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

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



.. raw:: html

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


:ref:`2178_pool-group_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/ipv6_nat_pool_group_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/ipv6/nat/pool-group



.. raw:: html

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


:ref:`2178_pool-group_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-group/{pool-group-name}



.. raw:: html

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


:ref:`2178_pool-group_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/ipv6_nat_pool_group_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/ipv6/nat/pool-group



.. raw:: html

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


:ref:`2178_pool-group_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-group/{pool-group-name}



.. raw:: html

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


:ref:`2178_pool-group_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-group/{pool-group-name}



.. raw:: html

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


:ref:`2178_pool-group_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/ipv6_nat_pool_group_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/ipv6/nat/pool-group



.. raw:: html

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


:ref:`2178_pool-group_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-group/{pool-group-name}



.. raw:: html

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


:ref:`2178_pool-group_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/ipv6_nat_pool_group_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2178_pool-group_list:

pool-group-list
---------------


    pool-group-list is **JSON List** of :ref:`2178_pool-group_attributes` 

        pool-group-list : [

             { :ref:`2178_pool-group_attributes` },

             { :ref:`2178_pool-group_attributes` },

             ...

         ]

.. _2178_pool-group_attributes:

pool-group attributes
---------------------

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

.. _2178_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

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

        **Type:** string

        **Supported Values:** all, Failed

.. _2178_member-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