.. _sflow_collector_custom:

sflow collector custom
======================

Configure Custom sFlow collector


custom Specification
--------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`2687_custom_list`

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

	                                       

	 **Element Name**                      custom

	 **Element URI**                       /axapi/v3/sflow/collector/custom/{name}

	 **Element Attributes**                custom_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2687_custom_attributes`



.. raw:: html

   </td><td></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/custom



.. raw:: html

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


:ref:`2687_custom_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/custom/{name}



.. raw:: html

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


:ref:`2687_custom_attributes`



.. raw:: html

   </td><td></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/custom



.. raw:: html

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


:ref:`2687_custom_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/custom/{name}



.. raw:: html

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


:ref:`2687_custom_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/custom/{name}



.. raw:: html

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


:ref:`2687_custom_attributes`



.. raw:: html

   </td><td></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/custom



.. raw:: html

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


:ref:`2687_custom_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/custom/{name}



.. raw:: html

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


:ref:`2687_custom_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2687_custom_list:

custom-list
-----------


    custom-list is **JSON List** of :ref:`2687_custom_attributes` 

        custom-list : [

             { :ref:`2687_custom_attributes` },

             { :ref:`2687_custom_attributes` },

             ...

         ]

.. _2687_custom_attributes:

custom attributes
-----------------

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