summaryrefslogtreecommitdiff
path: root/docs/vpp
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-10 21:46:24 +0300
committerGitHub <noreply@github.com>2026-04-10 19:46:24 +0100
commitac00e1c4a6b456628e412123383450653f668bdb (patch)
treed17abbfc59ef01c3386d8d75c47649b9d69d6a6a /docs/vpp
parentb5858598e32441560da34a4a62dc687fe4df9c16 (diff)
downloadvyos-documentation-ac00e1c4a6b456628e412123383450653f668bdb.tar.gz
vyos-documentation-ac00e1c4a6b456628e412123383450653f668bdb.zip
docs: remove TODO markers, fix stub notes, add linter markers (#1828)
Remove TODO tracking comments, reformat stub notes with inline links, add stop/start_vyoslinter markers around long code blocks, and fix minor structural issues across 23 documentation files. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs/vpp')
-rw-r--r--docs/vpp/configuration/ipfix.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/vpp/configuration/ipfix.rst b/docs/vpp/configuration/ipfix.rst
index 2085740a..92c734be 100644
--- a/docs/vpp/configuration/ipfix.rst
+++ b/docs/vpp/configuration/ipfix.rst
@@ -1,5 +1,6 @@
+#######################
VPP IPFIX Configuration
-=======================
+#######################
VPP IPFIX in VyOS allows monitoring and exporting network traffic flows
for analytics, security, and accounting. IPFIX works with the VPP
@@ -18,7 +19,8 @@ Key IPFIX Concepts
- **Active timeout**: Maximum time a flow is kept active before export.
- **Inactive timeout**: Maximum time an idle flow is kept before export.
- **Collector**: The remote host and port to which flow records are sent.
-- **Flow layers**: Determines which layer information is included (`l2`, `l3`, `l4`).
+- **Flow layers**: Determines which layer information is included
+ (``l2``, ``l3``, ``l4``).
- **Interfaces**: Physical or virtual interfaces to monitor.
- **Direction**: Which traffic to monitor (`rx`, `tx`, `both`).
- **Flow variant**: Optional filter for IPv4 or IPv6 flows.
@@ -26,12 +28,16 @@ Key IPFIX Concepts
Configuration Options
---------------------
-- **active-timeout**: Duration (in seconds) after which active flows are exported.
-- **inactive-timeout**: Duration (in seconds) after which idle flows are exported.
+- **active-timeout**: Duration (in seconds) after which active flows
+ are exported.
+- **inactive-timeout**: Duration (in seconds) after which idle flows
+ are exported.
- **collector `<ip>` port `<port>`**: IP and UDP port of the IPFIX collector.
- **collector `<ip>` source-address `<ip>`**: Source address for flow export.
- **flowprobe-record `<l2|l3|l4>`**: Layers to include in flow records.
-- **interface `<interface>` [direction `<rx|tx|both>`] [flow-variant `<ipv4|ipv6>`]**: Interfaces to monitor, direction of traffic, and optional flow variant filter.
+- **interface** ``<interface>`` **[direction** ``<rx|tx|both>``\ **]**
+ **[flow-variant** ``<ipv4|ipv6>``\ **]**: Interfaces to monitor,
+ direction of traffic, and optional flow variant filter.
Example Configuration
---------------------