.. _sflow_polling:

sflow polling
=============

Configure sFlow counter polling on specified source


polling Specification
---------------------

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

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

	 **Element Name**                      polling

	 **Element URI**                       /axapi/v3/sflow/polling

	 **Element Attributes**                polling_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2704_polling_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_polling_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/polling



.. raw:: html

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


:ref:`2704_polling_attributes`



.. 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/polling



.. raw:: html

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


:ref:`2704_polling_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/polling



.. raw:: html

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


:ref:`2704_polling_attributes`



.. 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/polling



.. raw:: html

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


:ref:`2704_polling_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2704_polling_attributes:

polling attributes
------------------

    **a10-proprietary**

        **Description:** a10-proprietary is a **JSON Block**.  Please see below for :ref:`2704_a10-proprietary` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/polling/a10-proprietary <sflow_polling_a10_proprietary>`

    **cpu-usage**

        **Description** Polling CPU usage

        **Type:** boolean

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

        **Default:** 0

    **ddos**

        **Description:** ddos is a **JSON Block**.  Please see below for :ref:`2704_ddos` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/polling/ddos <sflow_polling_ddos>`

    **eth-list**

        **Type:** List

    **ethernet-ext-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/polling/ethernet-ext/{start} <sflow_polling_ethernet_ext>`

    **ethernet-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/polling/ethernet/{start} <sflow_polling_ethernet>`

    **http**

        **Description:** http is a **JSON Block**.  Please see below for :ref:`2704_http` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/polling/http <sflow_polling_http>`

    **http-counter**

        **Description** Polling HTTP counters

        **Type:** boolean

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

        **Default:** 0

    **system-health**

        **Description:** system-health is a **JSON Block**.  Please see below for :ref:`2704_system-health` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/polling/system-health <sflow_polling_system_health>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-list**

        **Type:** List

.. _2704_eth-list:

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

	 **Block object keys**             

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

    **eth-end**

        **Description** Ethernet interface to sample

        **Type:** number

        **Format:** interface

    **eth-start**

        **Description** Ethernet interface to sample

        **Type:** number

        **Format:** interface

.. _2704_http:

http
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **toggle**

        **Description** 'enable': Enable polling HTTP counters; 'disable': Disable polling HTTP counters; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2704_ve-list:

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

	 **Block object keys**             

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

    **ve-end**

        **Description** VE interface to sample

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/ve <interface_ve>`

    **ve-start**

        **Description** VE interface to sample

        **Type:** number

        **Reference Object:** :doc:`/axapi/v3/interface/ve <interface_ve>`

.. _2704_ethernet-list:

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

	 **Block object keys**             

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

    **start**

        **Description** Ethernet interface to poll

        **Type:** number

        **Format:** interface

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2704_ddos:

ddos
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **2_9-compatibility**

        **Description** Enable DDOS sflow polling 2.9 compatibility mode

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** 2_9-compatibility and 3_0-compatibility are mutually exclusive

    **3_0-compatibility**

        **Description** Enable DDOS sflow polling 3.0/3.1 compatibility mode

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** 3_0-compatibility and 2_9-compatibility are mutually exclusive

    **address-byte-order-host**

        **Description** Export sflow address field in host byte order

        **Type:** boolean

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

        **Default:** 0

    **dns-cache-zone-stats**

        **Description** Enable polling for dns cache per instance and per zone statistics

        **Type:** boolean

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

        **Default:** 0

    **dyn-entry-stats**

        **Description** Enable polling for dynamic entry statistics

        **Type:** boolean

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

        **Default:** 0

    **enable-anomaly-stats**

        **Description** Enable Polling for system wide anomaly statistics

        **Type:** boolean

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

        **Default:** 0

    **toggle**

        **Description** 'enable': Enable sflow polling for DDOS statistics; 'disable': Disable sflow polling for DDOS statistics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2704_ethernet-ext-list:

ethernet-ext-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **start**

        **Description** Ethernet interface to poll

        **Type:** number

        **Format:** interface

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2704_a10-proprietary:

a10-proprietary
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **export-deprecated-counters**

        **Description** Export deprecated counters

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

.. _2704_system-health:

system-health
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **license-statistics**

        **Description** 'enable': Enable polling license statistics; 'disable': Disable polling license statistics; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **per-control-cpu-usage**

        **Description** 'enable': Enable polling control cpu; 'disable': Disable polling control cpu usage; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **per-data-cpu-usage**

        **Description** 'enable': Enable polling data cpu; 'disable': Disable polling data cpu usage; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **system-health-usage**

        **Description** 'enable': Enable polling system health information; 'disable': Disable polling system health information; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters