.. _netflow_collector_template:

netflow collector template
==========================

Configure NetFlow/IPFIX collector templates


template Specification
----------------------

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

	===================================== ===================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/netflow/collector/template

	 **Element Attributes**                template_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/netflow/collector/template/oper

	 **Schema**                             :download:`template schema <netflow-collector-template/netflow-collector-template.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/netflow/collector/template



.. raw:: html

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


:ref:`2290_template_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/netflow_collector_template_POST.txt
   :literal:




.. raw:: html

   </div></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/netflow/collector/template



.. raw:: html

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


:ref:`2290_template_attributes`



.. 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/netflow/collector/template



.. raw:: html

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


:ref:`2290_template_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/netflow/collector/template



.. raw:: html

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


:ref:`2290_template_attributes`



.. 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/netflow/collector/template



.. raw:: html

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


:ref:`2290_template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2290_template_attributes:

template attributes
-------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2290_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'v9-templates-created': Netflow v9 Templates Created; 'v9-templates-deleted': Netflow v9 Templates Deleted; 'v10-templates-created': Netflow v10(IPFIX) Templates Created; 'v10-templates-deleted': Netflow v10(IPFIX) Templates Deleted; 'template-drop-exceeded': Netflow Templates Dropped Maximum Limit Reached; 'template-drop-out-of-memory': Netflow Templates Dropped OOM; 'templates-added-to-delq': Netflow Templates Added To Delete Queue; 'templates-removed-from-delq': Netflow Templates Removed From Delete Queue; 

        **Type:** string

        **Supported Values:** all, v9-templates-created, v9-templates-deleted, v10-templates-created, v10-templates-deleted, template-drop-exceeded, template-drop-out-of-memory, templates-added-to-delq, templates-removed-from-delq