.. _sflow:

sflow
=====

Configure sFlow


sflow Specification
-------------------

	===================================== ==============================================
	===================================== ==============================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      sflow

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

	 **Element Attributes**                sflow_attributes

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/sflow



.. raw:: html

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


sflow_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1623_sflow_attributes:

sflow attributes
----------------

    **agent**

        **Description:** agent is a **JSON Block**.  Please see below for :ref:`1623_agent` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/agent <sflow_agent>`

    **collector**

        **Description:** collector is a **JSON Block**.  Please see below for :ref:`1623_collector` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/collector <sflow_collector>`

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`1623_global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/global <sflow_global>`

    **polling**

        **Description:** polling is a **JSON Block**.  Please see below for :ref:`1623_polling` 

        **Type:** Object

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

    **sampling**

        **Description:** sampling is a **JSON Block**.  Please see below for :ref:`1623_sampling` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/sampling <sflow_sampling>`

    **setting**

        **Description:** setting is a **JSON Block**.  Please see below for :ref:`1623_setting` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/setting <sflow_setting>`

    **source-address**

        **Description:** source-address is a **JSON Block**.  Please see below for :ref:`1623_source-address` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/source-address <sflow_source_address>`

.. _1623_source-address:

source-address
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip**

        **Description** Source IPv4 address

        **Type:** string

        **Format:** ipv4-address

    **ipv6**

        **Description** Source IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1623_global:

global
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1623_global_sampling-enable:

global_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total-packet-sample-records': Total packet sample records; 'total-counter-sample-records': Total counter sample records; 'total-sflow-packets-sent': Total sflow packets sent; 

        **Type:** string

        **Supported Values:** all, total-packet-sample-records, total-counter-sample-records, total-sflow-packets-sent

.. _1623_agent:

agent
^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **address**

        **Description:** address is a **JSON Block**.  Please see below for :ref:`1623_agent_address` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/sflow/agent/address <sflow_agent_address>`

.. _1623_agent_address:

agent_address
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip**

        **Description** Configure sFlow agent IP address

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip and ipv6 are mutually exclusive

    **ipv6**

        **Description** Configure sFlow agent IPv6 address

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6 and ip are mutually exclusive

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1623_sampling:

sampling
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **eth-list**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **ve-list**

        **Type:** List

.. _1623_sampling_eth-list:

sampling_eth-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1623_sampling_ve-list:

sampling_ve-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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>`

.. _1623_setting:

setting
^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **counter-polling-interval**

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

        **Type:** number

        **Range:** 1-200

        **Default:** 10

    **local-collection**

        **Description** Enable local sflow collection

        **Type:** boolean

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

        **Default:** 0

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

        **Default:** 128

    **packet-sampling-rate**

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

        **Type:** number

        **Range:** 10-1000000

        **Default:** 1000

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

.. _1623_polling:

polling
^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cpu-usage**

        **Description** Polling CPU usage

        **Type:** boolean

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

        **Default:** 0

    **eth-list**

        **Type:** List

    **http-counter**

        **Description** Polling HTTP 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

    **ve-list**

        **Type:** List

.. _1623_polling_eth-list:

polling_eth-list
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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

.. _1623_polling_ve-list:

polling_ve-list
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **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>`

.. _1623_collector:

collector
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ip-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/ip/{addr}+{port} <sflow_collector_ip>`

    **ipv6-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/sflow/collector/ipv6/{addr}+{port} <sflow_collector_ipv6>`

.. _1623_collector_ip-list:

collector_ip-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** Configure sFlow collector IP address

        **Type:** string

        **Format:** ipv4-address

    **port**

        **Description** Port number (default is 6343)

        **Type:** number

        **Range:** 1-65535

        **Default:** 6343

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1623_collector_ipv6-list:

collector_ipv6-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **addr**

        **Description** Configure sFlow collector IPv6 address

        **Type:** string

        **Format:** ipv6-address

    **port**

        **Description** Port number (default is 6343)

        **Type:** number

        **Range:** 1-65535

        **Default:** 6343

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters