.. _visibility_flow_collector:

visibility flow-collector
=========================

sFlow/Netflow collector


flow-collector Specification
----------------------------

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

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

	 **Element Name**                      flow-collector

	 **Element URI**                       /axapi/v3/visibility/flow-collector

	 **Element Attributes**                flow-collector_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`flow-collector schema <visibility-flow-collector/visibility-flow-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/visibility/flow-collector



.. raw:: html

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


flow-collector_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _3569_flow-collector_attributes:

flow-collector attributes
-------------------------

    **netflow**

        **Description:** netflow is a **JSON Block**.  Please see below for :ref:`3569_netflow` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/netflow <visibility_flow_collector_netflow>`

    **sflow**

        **Description:** sflow is a **JSON Block**.  Please see below for :ref:`3569_sflow` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/sflow <visibility_flow_collector_sflow>`

.. _3569_netflow:

netflow
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **template**

        **Description:** template is a **JSON Block**.  Please see below for :ref:`3569_netflow_template` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/netflow/template <visibility_flow_collector_netflow_template>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3569_netflow_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'pkts-rcvd': Total nflow packets received; 'v9-templates-created': Total v9 templates created; 'v9-templates-deleted': Total v9 templates deleted; 'v10-templates-created': Total v10(IPFIX) templates created; 'v10-templates-deleted': Total v10(IPFIX) templates deleted; 'template-drop-exceeded': Total templates dropped because of maximum limit; 'template-drop-out-of-memory': Total templates dropped becuase of out of memory; 'frag-dropped': Total nflow fragment packets dropped; 'agent-not-found': nflow pkts from not configured agents; 'version-not-supported': nflow version not supported; 'unknown-dir': nflow sample direction is unknown; 

        **Type:** string

        **Supported Values:** all, pkts-rcvd, v9-templates-created, v9-templates-deleted, v10-templates-created, v10-templates-deleted, template-drop-exceeded, template-drop-out-of-memory, frag-dropped, agent-not-found, version-not-supported, unknown-dir

.. _3569_netflow_template:

netflow_template
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **detail**

        **Description:** detail is a **JSON Block**.  Please see below for :ref:`3569_netflow_template_detail` 

        **Type:** Object

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3569_netflow_template_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'templates-added-to-delq': Netflow templates added to the delete queue; 'templates-removed-from-delq': Netflow templates removed from the delete queue; 

        **Type:** string

        **Supported Values:** all, templates-added-to-delq, templates-removed-from-delq

.. _3569_netflow_template_detail:

netflow_template_detail
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3569_sflow:

sflow
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3569_sflow_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'pkts-received': Total sflow pkts received; 'frag-dropped': Total sflow fragment packets droppped; 'agent-not-found': sflow pkts from not configured agents; 'version-not-supported': sflow version not supported; 'unknown-dir': sflow sample direction is unknown; 

        **Type:** string

        **Supported Values:** all, pkts-received, frag-dropped, agent-not-found, version-not-supported, unknown-dir