diff options
| author | Robert Göhler <github@ghlr.de> | 2023-04-11 21:03:35 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-11 21:03:35 +0200 |
| commit | 690e09577b3a48cac2ea5ef34270d27fca5b1394 (patch) | |
| tree | 337bb29186ee492f0cd042e52a21dc88f14ff858 /docs/configuration/system/sflow.rst | |
| parent | 537bce9c9577fb3363a84bbd705566965c36ca60 (diff) | |
| parent | 3b0e163a555cfce341cf8e4221cd830cfcb2a200 (diff) | |
| download | vyos-documentation-690e09577b3a48cac2ea5ef34270d27fca5b1394.tar.gz vyos-documentation-690e09577b3a48cac2ea5ef34270d27fca5b1394.zip | |
Merge branch 'master' into sr-mpls-correction
Diffstat (limited to 'docs/configuration/system/sflow.rst')
| -rw-r--r-- | docs/configuration/system/sflow.rst | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/configuration/system/sflow.rst b/docs/configuration/system/sflow.rst new file mode 100644 index 00000000..b131d8a9 --- /dev/null +++ b/docs/configuration/system/sflow.rst @@ -0,0 +1,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' |