.. _cgnv6_nat_pool_stats:

cgnv6 nat pool stats
====================

Statistics for the object pool


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

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

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

	 **Collection Name**                   :ref:`472_pool_list`

	 **Collection URI**                    /axapi/v3/cgnv6/nat/pool/{pool-name}

	                                       

	 **Element Name**                      pool

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

	 **Element Attributes**                pool_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`pool schema <cgnv6-nat-pool-stats/cgnv6-nat-pool-stats.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/cgnv6/nat/pool/{pool-name}



.. raw:: html

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


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



.. raw:: html

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


:ref:`472_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/cgnv6/nat/pool/{pool-name}/stats



.. raw:: html

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


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



.. raw:: html

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


:ref:`472_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/cgnv6/nat/pool/{pool-name}/stats



.. raw:: html

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


:ref:`472_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/cgnv6/nat/pool/{pool-name}/stats



.. raw:: html

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


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



.. raw:: html

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


:ref:`472_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/cgnv6/nat/pool/{pool-name}/stats



.. raw:: html

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


:ref:`472_pool_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _472_pool_list:

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


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

        pool-list : [

             { :ref:`472_pool_attributes` },

             { :ref:`472_pool_attributes` },

             ...

         ]

.. _472_pool_attributes:

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

    **pool-name**

        **Description** Specify pool name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`472_stats` 

        **Type:** Object

.. _472_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **icmp**

        **Description** ICMP

        **Type:** number

        **Format:** counter

    **icmp-freed**

        **Description** ICMP Freed

        **Type:** number

        **Format:** counter

    **icmp-hit-full**

        **Description** ICMP Hit Full

        **Type:** number

        **Format:** counter

    **icmp-peak**

        **Description** ICMP Peak

        **Type:** number

        **Format:** counter

    **icmp-rsvd**

        **Description** ICMP Reserved

        **Type:** number

        **Format:** counter

    **icmp-total**

        **Description** ICMP Total

        **Type:** number

        **Format:** counter

    **ip-free**

        **Description** IP Free

        **Type:** number

        **Format:** counter

    **ip-total**

        **Description** IP Total

        **Type:** number

        **Format:** counter

    **ip-used**

        **Description** IP Used

        **Type:** number

        **Format:** counter

    **tcp**

        **Description** TCP

        **Type:** number

        **Format:** counter

    **tcp-freed**

        **Description** TCP Freed

        **Type:** number

        **Format:** counter

    **tcp-hit-full**

        **Description** TCP Hit Full

        **Type:** number

        **Format:** counter

    **tcp-peak**

        **Description** TCP Peak

        **Type:** number

        **Format:** counter

    **tcp-port-overload-create**

        **Description** TCP Port Overloading Session Created

        **Type:** number

        **Format:** counter

    **tcp-port-overload-free**

        **Description** TCP Port Overloading Session Freed

        **Type:** number

        **Format:** counter

    **tcp-port-overloaded**

        **Description** TCP Port Overloaded

        **Type:** number

        **Format:** counter

    **tcp-rsvd**

        **Description** TCP Reserved

        **Type:** number

        **Format:** counter

    **tcp-total**

        **Description** TCP total

        **Type:** number

        **Format:** counter

    **udp**

        **Description** UDP

        **Type:** number

        **Format:** counter

    **udp-freed**

        **Description** UDP Freed

        **Type:** number

        **Format:** counter

    **udp-hit-full**

        **Description** UDP Hit Full

        **Type:** number

        **Format:** counter

    **udp-peak**

        **Description** UDP Peak

        **Type:** number

        **Format:** counter

    **udp-port-overload-create**

        **Description** UDP Port Overloading Session Created

        **Type:** number

        **Format:** counter

    **udp-port-overload-free**

        **Description** UDP Port Overloading Session Freed

        **Type:** number

        **Format:** counter

    **udp-port-overloaded**

        **Description** UDP Port Overloaded

        **Type:** number

        **Format:** counter

    **udp-rsvd**

        **Description** UDP Reserved

        **Type:** number

        **Format:** counter

    **udp-total**

        **Description** UDP Total

        **Type:** number

        **Format:** counter

    **users**

        **Description** Users

        **Type:** number

        **Format:** counter