.. _netflow_collector:

netflow collector
=================

Configure NetFlow/IPFIX collector


collector Specification
-----------------------

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

	===================================== ==========================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      collector

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

	 **Element Attributes**                collector_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/netflow/collector



.. raw:: html

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


collector_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2291_collector_attributes:

collector attributes
--------------------

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`2291_template` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/collector/template <netflow_collector_template>`

    **template-detail**

        **Description:** template-detail is a **JSON Block**.  Please see below for :ref:`2291_template-detail` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/netflow/collector/template-detail <netflow_collector_template_detail>`

.. _2291_template-detail:

template-detail
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2291_template:

template
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2291_template_sampling-enable:

template_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