.. _sflow_collector_ip:

sflow collector ip
==================

Configure sFlow IPv4 collector


ip Specification
----------------

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

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

	 **Object Key(s)**                     *addr, port*

	 **Collection Name**                   :ref:`2648_ip_list`

	 **Collection URI**                    /axapi/v3/sflow/collector/ip

	                                       

	 **Element Name**                      ip

	 **Element URI**                       /axapi/v3/sflow/collector/ip/{addr}+{port}

	 **Element Attributes**                ip_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2648_ip_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/sflow_collector_ip_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/sflow/collector/ip



.. raw:: html

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


:ref:`2648_ip_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/sflow/collector/ip/{addr}+{port}



.. raw:: html

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


:ref:`2648_ip_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/sflow_collector_ip_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/sflow/collector/ip



.. raw:: html

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


:ref:`2648_ip_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/sflow/collector/ip/{addr}+{port}



.. raw:: html

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


:ref:`2648_ip_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/sflow/collector/ip/{addr}+{port}



.. raw:: html

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


:ref:`2648_ip_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/sflow_collector_ip_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/sflow/collector/ip



.. raw:: html

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


:ref:`2648_ip_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/sflow/collector/ip/{addr}+{port}



.. raw:: html

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


:ref:`2648_ip_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/sflow_collector_ip_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2648_ip_list:

ip-list
-------


    ip-list is **JSON List** of :ref:`2648_ip_attributes` 

        ip-list : [

             { :ref:`2648_ip_attributes` },

             { :ref:`2648_ip_attributes` },

             ...

         ]

.. _2648_ip_attributes:

ip attributes
-------------

    **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:`2648_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

.. _2648_customized-setting:

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