summaryrefslogtreecommitdiff
path: root/docs/vpp/configuration/ipfix.rst
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
commit5d6fa52b8985f8068314aba26878a1d7d5cb84e5 (patch)
tree99359ff282846e26b5c5fa2b9b176b35b172809f /docs/vpp/configuration/ipfix.rst
parent631e454d674ad5111d2b56a6964ead461894a1f6 (diff)
downloadvyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.tar.gz
vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.zip
feat: flip swap mechanism — MD as primary, RST as override (Phase 1)
This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io
Diffstat (limited to 'docs/vpp/configuration/ipfix.rst')
-rw-r--r--docs/vpp/configuration/ipfix.rst57
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/vpp/configuration/ipfix.rst b/docs/vpp/configuration/ipfix.rst
deleted file mode 100644
index 92c734be..00000000
--- a/docs/vpp/configuration/ipfix.rst
+++ /dev/null
@@ -1,57 +0,0 @@
-#######################
-VPP IPFIX Configuration
-#######################
-
-VPP IPFIX in VyOS allows monitoring and exporting network traffic flows
-for analytics, security, and accounting. IPFIX works with the VPP
-(Vector Packet Processing) backend to provide high-performance flow tracking.
-
-Overview
---------
-
-VyOS integrates VPP for high-performance packet processing. IPFIX
-configuration controls how flows are monitored, exported, and which
-interfaces are included.
-
-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``).
-- **Interfaces**: Physical or virtual interfaces to monitor.
-- **Direction**: Which traffic to monitor (`rx`, `tx`, `both`).
-- **Flow variant**: Optional filter for IPv4 or IPv6 flows.
-
-Configuration Options
----------------------
-
-- **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.
-
-Example Configuration
----------------------
-
-.. code-block:: none
-
- set vpp ipfix active-timeout '15'
- set vpp ipfix inactive-timeout '120'
- set vpp ipfix collector 192.0.2.2 port '4739'
- set vpp ipfix collector 192.0.2.2 source-address '192.0.2.1'
- set vpp ipfix flowprobe-record 'l2'
- set vpp ipfix flowprobe-record 'l3'
- set vpp ipfix flowprobe-record 'l4'
- set vpp ipfix interface eth0
- set vpp ipfix interface eth1 direction 'both'
- set vpp ipfix interface eth1 flow-variant 'ipv4'
-