.. _sflow_collector_host:

sflow collector host
====================

Configure sFlow collector using FQDN


host Specification
------------------

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

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

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

	 **Collection Name**                   :ref:`2816_host_list`

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

	                                       

	 **Element Name**                      host

	 **Element URI**                       /axapi/v3/sflow/collector/host/{name}+{port}

	 **Element Attributes**                host_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2816_host_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/host



.. raw:: html

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


:ref:`2816_host_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/host/{name}+{port}



.. raw:: html

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


:ref:`2816_host_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/host



.. raw:: html

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


:ref:`2816_host_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/host/{name}+{port}



.. raw:: html

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


:ref:`2816_host_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/host/{name}+{port}



.. raw:: html

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


:ref:`2816_host_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/host



.. raw:: html

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


:ref:`2816_host_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/host/{name}+{port}



.. raw:: html

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


:ref:`2816_host_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2816_host_list:

host-list
---------


    host-list is **JSON List** of :ref:`2816_host_attributes` 

        host-list : [

             { :ref:`2816_host_attributes` },

             { :ref:`2816_host_attributes` },

             ...

         ]

.. _2816_host_attributes:

host attributes
---------------

    **customized-setting**

        **Description:** customized-setting is a **JSON Block**.  Please see below for :ref:`2816_customized-setting` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/host/{name}+{port}/customized-setting <sflow_collector_host>`

    **name**

        **Description** Configure FQDN name of sFlow Receiver

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

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

.. _2816_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': 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