summaryrefslogtreecommitdiff
path: root/docs/configuration/system/sflow.rst
blob: b131d8a959af59fae71a115a32044181a1b5d6fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. _ntp:

#####
sFlow
#####

VyOS supports sFlow accounting for both IPv4 and IPv6 traffic. The system acts as a flow exporter, and you are free to use it with any compatible collector.

sFlow is a technology that enables monitoring of network traffic by sending sampled packets to a collector device.

The sFlow accounting based on hsflowd https://sflow.net/

Configuration
=============

.. cfgcmd:: set system sflow agent-address <address>

   Configure sFlow agent IPv4 or IPv6 address


.. cfgcmd:: set system sflow agent-interface <interface>

   Configure agent IP address associated with this interface.


.. cfgcmd:: set system sflow drop-monitor-limit <limit>

   Dropped packets reported on DROPMON Netlink channel by Linux kernel are exported via the standard sFlow v5 extension for reporting dropped packets

.. cfgcmd:: set system sflow interface <interface>

   Configure and enable collection of flow information for the interface identified by <interface>.

   You can configure multiple interfaces which whould participate in sflow accounting.


.. cfgcmd:: set system sflow polling <sec>

   Configure schedule counter-polling in seconds (default: 30)

.. cfgcmd:: set system sflow sampling-rate <rate>

   Use this command to configure the sampling rate for sFlow accounting (default: 1000)

.. cfgcmd:: set system sflow server <address> port <port>

   Configure address of sFlow collector. sFlow server at <address> can be both listening on an IPv4 or IPv6 address.


Example
=======

.. code-block:: none

  set system sflow agent-address '192.0.2.14'
  set system sflow agent-interface 'eth0'
  set system sflow drop-monitor-limit '50'
  set system sflow interface 'eth0'
  set system sflow interface 'eth1'
  set system sflow polling '30'
  set system sflow sampling-rate '1000'
  set system sflow server 192.0.2.1 port '6343'
  set system sflow server 203.0.113.23 port '6343'