.. _sflow_collector:

sflow collector
===============

Configure sFlow collector (a.k.a. receiver)


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

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

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

	 **Element Name**                      collector

	 **Element URI**                       /axapi/v3/sflow/collector

	 **Element Attributes**                collector_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


collector_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _2692_collector_attributes:

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

    **custom-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/custom/{name} <sflow_collector_custom>`

    **ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/ip/{addr}+{port} <sflow_collector_ip>`

    **ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/ipv6/{addr}+{port} <sflow_collector_ipv6>`

.. _2692_custom-list:

custom-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **ipv4_addr**

        **Description** Configure IP address of the sFlow Receiver

        **Type:** string

        **Format:** ipv4-address

    **ipv6_addr**

        **Description** Configure IPv6 address of the sFlow Receiver

        **Type:** string

        **Format:** ipv6-address

    **name**

        **Description** Configure name of sFlow Receiver

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _2692_ip-list:

ip-list
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** Configure sFlow collector IP address

        **Type:** string

        **Format:** ipv4-address

    **customized-setting**

        **Description:** customized-setting is a **JSON Block**.  Please see below for :ref:`2692_ip-list_customized-setting` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/ip/{addr}+{port}/customized-setting <sflow_collector_ip>`

    **port**

        **Description** Port number (default is 6343)

        **Type:** number

        **Range:** 1-65535

        **Default:** 6343

    **use-mgmt-port**

        **Description** sFlow collector is through out-of-band management

        **Type:** boolean

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

        **Default:** 0

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

.. _2692_ip-list_customized-setting:

ip-list_customized-setting
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **a10-proprietary-polling**

        **Description** Enable counters for ACOS control blocks

        **Type:** boolean

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

        **Default:** 0

    **counter-polling**

        **Description** Enable counter polling

        **Type:** boolean

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

        **Default:** 0

    **event-notification**

        **Description** Enable event notification

        **Type:** boolean

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

        **Default:** 0

    **export-enable**

        **Description** 'export': Export settings; 

        **Type:** string

        **Supported Values:** export

    **packet-sampling**

        **Description** Enable packet sampling

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

.. _2692_ipv6-list:

ipv6-list
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** Configure sFlow collector IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **customized-setting**

        **Description:** customized-setting is a **JSON Block**.  Please see below for :ref:`2692_ipv6-list_customized-setting` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/ipv6/{addr}+{port}/customized-setting <sflow_collector_ipv6>`

    **port**

        **Description** Port number (default is 6343)

        **Type:** number

        **Range:** 1-65535

        **Default:** 6343

    **use-mgmt-port**

        **Description** sFlow collector is through out-of-band management

        **Type:** boolean

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

        **Default:** 0

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

.. _2692_ipv6-list_customized-setting:

ipv6-list_customized-setting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **a10-proprietary-polling**

        **Description** Enable counters for ACOS control blocks

        **Type:** boolean

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

        **Default:** 0

    **counter-polling**

        **Description** Enable counter polling

        **Type:** boolean

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

        **Default:** 0

    **event-notification**

        **Description** Enable event notification

        **Type:** boolean

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

        **Default:** 0

    **export-enable**

        **Description** 'export': Customizes export settings for collector; 

        **Type:** string

        **Supported Values:** export

    **packet-sampling**

        **Description** Enable packet sampling

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