.. _visibility_topn_cgnv6_nat_pool_topn_tmpl:

visibility topn cgnv6-nat-pool-topn-tmpl
========================================

Configure template for cgnv6.nat.pool


cgnv6-nat-pool-topn-tmpl Specification
--------------------------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`4033_cgnv6-nat-pool-topn-tmpl_list`

	 **Collection URI**                    /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-tmpl

	                                       

	 **Element Name**                      cgnv6-nat-pool-topn-tmpl

	 **Element URI**                       /axapi/v3/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}

	 **Element Attributes**                cgnv6-nat-pool-topn-tmpl_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`cgnv6-nat-pool-topn-tmpl schema <visibility-topn-cgnv6-nat-pool-topn-tmpl/visibility-topn-cgnv6-nat-pool-topn-tmpl.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/visibility/topn/cgnv6-nat-pool-topn-tmpl



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility_topn_cgnv6_nat_pool_topn_tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility_topn_cgnv6_nat_pool_topn_tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility_topn_cgnv6_nat_pool_topn_tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}



.. raw:: html

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


:ref:`4033_cgnv6-nat-pool-topn-tmpl_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/visibility_topn_cgnv6_nat_pool_topn_tmpl_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _4033_cgnv6-nat-pool-topn-tmpl_list:

cgnv6-nat-pool-topn-tmpl-list
-----------------------------


    cgnv6-nat-pool-topn-tmpl-list is **JSON List** of :ref:`4033_cgnv6-nat-pool-topn-tmpl_attributes` 

        cgnv6-nat-pool-topn-tmpl-list : [

             { :ref:`4033_cgnv6-nat-pool-topn-tmpl_attributes` },

             { :ref:`4033_cgnv6-nat-pool-topn-tmpl_attributes` },

             ...

         ]

.. _4033_cgnv6-nat-pool-topn-tmpl_attributes:

cgnv6-nat-pool-topn-tmpl attributes
-----------------------------------

    **interval**

        **Description** '5': 5 minutes; '15': 15 minutes; '30': 30 minutes; '60': 60 minutes; 'all-time': Since template is activated; 

        **Type:** string

        **Supported Values:** 5, 15, 30, 60, all-time

    **metrics**

        **Description:** metrics is a **JSON Block**.  Please see below for :ref:`4033_metrics` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/topn/cgnv6-nat-pool-topn-tmpl/{name}/metrics <visibility_topn_cgnv6_nat_pool_topn_tmpl>`

    **name**

        **Description** Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **topn-size**

        **Description** Congure value of N for topn

        **Type:** number

        **Range:** 10-200

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

.. _4033_metrics:

metrics
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **tcp-total**

        **Description** Track Top-N entities for TCP total

        **Type:** boolean

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

        **Default:** 0

    **udp-total**

        **Description** Track Top-N entities for UDP Total

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