.. _sflow_setting:

sflow setting
=============

Configure sFlow


setting Specification
---------------------

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

	===================================== ======================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      setting

	 **Element URI**                       /axapi/v3/sflow/setting

	 **Element Attributes**                setting_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2706_setting_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_setting_POST.txt
   :literal:




.. raw:: html

   </div></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/setting



.. raw:: html

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


:ref:`2706_setting_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_setting_GET.txt
   :literal:




.. raw:: html

   </div></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/setting



.. raw:: html

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


:ref:`2706_setting_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/setting



.. raw:: html

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


:ref:`2706_setting_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_setting_PUT.txt
   :literal:




.. raw:: html

   </div></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/setting



.. raw:: html

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


:ref:`2706_setting_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_setting_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2706_setting_attributes:

setting attributes
------------------

    **append-mapping-info**

        **Description** Allow TPS to always send mapping ctr block (260, 271, and 272)

        **Type:** boolean

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

        **Default:** 0

    **counter-polling-interval**

        **Description** sFlow counter polling interval, default is 20

        **Type:** number

        **Range:** 1-200

        **Default:** 20

    **default-counter-polling-mtu**

        **Description** Default MTU for counter-polling packets - DDoS 3.2 format only (Default: 1500)

        **Type:** number

        **Range:** 1200-1500

        **Default:** 1500

    **local-collection**

        **Description** 'enable': Enable local sflow collection (Default); 'disable': Disable local sflow collection; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **local-t1-polling-interval**

        **Description** Set sFlow local counter polling interval for T1 stats

        **Type:** number

        **Range:** 1-18000

    **local-t2-polling-interval**

        **Description** Set sFlow local counter polling interval for T2 stats

        **Type:** number

        **Range:** 1-18000

    **management-link-utilization**

        **Description** limit management link speed in (Mbps)

        **Type:** number

        **Range:** 1-10000

        **Mutual Exclusion:** management-link-utilization and management-link-utilization-percentage are mutually exclusive

    **management-link-utilization-percentage**

        **Description** percentage limit of the management link speed (Default is 30%)

        **Type:** number

        **Range:** 1-100

        **Default:** 30

        **Mutual Exclusion:** management-link-utilization-percentage and management-link-utilization are mutually exclusive

    **max-header**

        **Description** Configure maximum number of bytes that should be copied from a sampled packet (default: 128) (The maximum number of bytes (Default: 128))

        **Type:** number

        **Range:** 14-512

    **packet-sampling-rate**

        **Description** sFlow packet sampling rate, default is 1000

        **Type:** number

        **Range:** 10-10000

        **Default:** 1000

    **port-range-end**

        **Description** Source port-range end

        **Type:** number

        **Range:** 2049-63640

    **port-range-start**

        **Description** Source port-range

        **Type:** number

        **Range:** 2049-63640

    **randomize-source-port**

        **Description** 'enable': Randomize source port; 'disable': Fix source port 6343; 'packet-sampling-only': Only randomized source port for packet-sampling (Default); 

        **Type:** string

        **Supported Values:** enable, disable, packet-sampling-only

        **Default:** packet-sampling-only

    **source-ip-use-mgmt**

        **Description** Use management interface's IP address for source IP of sFlow packets

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