.. _sflow: sflow ===== Configure sFlow sflow Specification ------------------- ===================================== ============================================== **Parameter** **Value** ===================================== ============================================== **Type** *Intermediate Resource* **Element Name** sflow **Element URI** /axapi/v3/sflow **Element Attributes** sflow_attributes **Partition Visibility** shared **Schema** :download:`sflow schema ` ===================================== ============================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/sflow .. raw:: html sflow_attributes .. raw:: html
.. _2667_sflow_attributes: sflow attributes ---------------- **agent** **Description:** agent is a **JSON Block**. Please see below for :ref:`2667_agent` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/agent ` **collector** **Description:** collector is a **JSON Block**. Please see below for :ref:`2667_collector` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/collector ` **event-notification** **Description:** event-notification is a **JSON Block**. Please see below for :ref:`2667_event-notification` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/event-notification ` **global** **Description:** global is a **JSON Block**. Please see below for :ref:`2667_global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/global ` **polling** **Description:** polling is a **JSON Block**. Please see below for :ref:`2667_polling` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/polling ` **sampling** **Description:** sampling is a **JSON Block**. Please see below for :ref:`2667_sampling` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/sampling ` **setting** **Description:** setting is a **JSON Block**. Please see below for :ref:`2667_setting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/setting ` **source-address** **Description:** source-address is a **JSON Block**. Please see below for :ref:`2667_source-address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/source-address ` .. _2667_source-address: source-address ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _2667_global: global ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2667_global_sampling-enable: global_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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; 'total-sflow-local-packets-sent': Total sflow packets sent desc {}; 'total-sflow-packets-sent-mgmt': Total sflow packets sent via Mgmt Interface; 'total-sflow-packets-drop-mgmt': sflow packets dropped because of rate limit via Mgmt Interface; **Type:** string **Supported Values:** all, total-packet-sample-records, total-counter-sample-records, total-sflow-packets-sent, total-sflow-local-packets-sent, total-sflow-packets-sent-mgmt, total-sflow-packets-drop-mgmt .. _2667_agent: agent ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **address** **Description:** address is a **JSON Block**. Please see below for :ref:`2667_agent_address` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/agent/address ` .. _2667_agent_address: agent_address ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _2667_sampling: sampling ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _2667_sampling_eth-list: sampling_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 .. _2667_sampling_ve-list: sampling_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 ` **ve-start** **Description** VE interface to sample **Type:** number **Reference Object:** :doc:`/axapi/v3/interface/ve ` .. _2667_event-notification: event-notification ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ddos** **Description:** ddos is a **JSON Block**. Please see below for :ref:`2667_event-notification_ddos` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/event-notification/ddos ` .. _2667_event-notification_ddos: event-notification_ddos ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **toggle** **Description** 'enable': Enable sflow notification for DDOS events; 'disable': Disable sflow notification for DDOS events; **Type:** string **Supported Values:** enable, disable **Default:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2667_setting: setting ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **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 .. _2667_polling: polling ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **a10-proprietary** **Description:** a10-proprietary is a **JSON Block**. Please see below for :ref:`2667_polling_a10-proprietary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/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:`2667_polling_ddos` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/polling/ddos ` **eth-list** **Type:** List **ethernet-ext-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/sflow/polling/ethernet-ext/{start} ` **ethernet-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/sflow/polling/ethernet/{start} ` **http** **Description:** http is a **JSON Block**. Please see below for :ref:`2667_polling_http` **Type:** Object **Reference Object:** :doc:`/axapi/v3/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:`2667_polling_system-health` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/polling/system-health ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-list** **Type:** List .. _2667_polling_eth-list: polling_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 .. _2667_polling_http: polling_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 .. _2667_polling_ve-list: polling_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 ` **ve-start** **Description** VE interface to sample **Type:** number **Reference Object:** :doc:`/axapi/v3/interface/ve ` .. _2667_polling_ethernet-list: polling_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 .. _2667_polling_ddos: polling_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 **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 .. _2667_polling_ethernet-ext-list: polling_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 .. _2667_polling_a10-proprietary: polling_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 .. _2667_polling_system-health: polling_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 .. _2667_collector: collector ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/sflow/collector/ip/{addr}+{port} ` **ipv6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/sflow/collector/ipv6/{addr}+{port} ` .. _2667_collector_ip-list: collector_ip-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **addr** **Description** Configure sFlow collector IP address **Type:** string **Format:** ipv4-address **customized-setting** **Description:** customized-setting is a **JSON Block**. Please see below for :ref:`2667_collector_ip-list_customized-setting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/collector/ip/{addr}+{port}/customized-setting ` **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 .. _2667_collector_ip-list_customized-setting: collector_ip-list_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': Export settings; **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 .. _2667_collector_ipv6-list: collector_ipv6-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **addr** **Description** Configure sFlow collector IPv6 address **Type:** string **Format:** ipv6-address **customized-setting** **Description:** customized-setting is a **JSON Block**. Please see below for :ref:`2667_collector_ipv6-list_customized-setting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/sflow/collector/ipv6/{addr}+{port}/customized-setting ` **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 .. _2667_collector_ipv6-list_customized-setting: collector_ipv6-list_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