aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/flowprobe/flowprobe_plugin_doc.rst
diff options
context:
space:
mode:
authorNathan Skrzypczak <nathan.skrzypczak@gmail.com>2021-10-08 14:05:35 +0200
committerDave Wallace <dwallacelf@gmail.com>2021-10-13 23:22:20 +0000
commitf47122e07e1ecd0151902a3cabe46c60a99bee8e (patch)
tree0c28c0eca2cb17050d6f31fd8f0ca8f78299bf0d /src/plugins/flowprobe/flowprobe_plugin_doc.rst
parent1e4281223ab4d655b54496ae13fbdb68f867e351 (diff)
docs: convert plugins doc md->rst
Type: improvement Change-Id: I7e821cce1feae229e1be4baeed249b9cca658135 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'src/plugins/flowprobe/flowprobe_plugin_doc.rst')
-rw-r--r--src/plugins/flowprobe/flowprobe_plugin_doc.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/plugins/flowprobe/flowprobe_plugin_doc.rst b/src/plugins/flowprobe/flowprobe_plugin_doc.rst
new file mode 100644
index 00000000000..8ad9c88ffbf
--- /dev/null
+++ b/src/plugins/flowprobe/flowprobe_plugin_doc.rst
@@ -0,0 +1,17 @@
+IPFIX flow record plugin
+========================
+
+Introduction
+------------
+
+This plugin generates ipfix flow records on interfaces which have the
+feature enabled
+
+Sample configuration
+--------------------
+
+set ipfix exporter collector 192.168.6.2 src 192.168.6.1
+template-interval 20 port 4739 path-mtu 1500
+
+flowprobe params record l3 active 20 passive 120 flowprobe feature
+add-del GigabitEthernet2/3/0 l2