From 43e3609f46d59836e158b931103044687d2848e3 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 02:40:47 +0300 Subject: docs: convert _include/interface-mirror.txt MyST→RST (per RST-leftovers cleanup design) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/_include/interface-mirror.txt | 39 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 22 deletions(-) (limited to 'docs/_include/interface-mirror.txt') diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt index 3e2a7bed..178f2060 100644 --- a/docs/_include/interface-mirror.txt +++ b/docs/_include/interface-mirror.txt @@ -2,39 +2,34 @@ SPAN port mirroring can copy the inbound/outbound traffic of the interface to the specified interface, usually the interface can be connected to some special equipment, such as behavior control system, intrusion detection system and traffic collector, and can copy all related traffic from this port. -The benefit of mirroring the traffic is that the application is isolated from -the source traffic and so application processing does not affect the traffic +The benefit of mirroring the traffic is that the application is isolated from +the source traffic and so application processing does not affect the traffic or the system performance. -VyOS uses the `mirror` option to configure port mirroring. The configuration +VyOS uses the ``mirror`` option to configure port mirroring. The configuration is divided into 2 different directions. Destination ports should be configured for different traffic directions. -::::{cfgcmd} set interfaces {{ var0 }} \ mirror +.. cfgcmd:: set interfaces {{ var0 }} mirror + ingress -ingress + Configure port mirroring for ```` inbound traffic and copy the + traffic to ```` -Configure port mirroring for `interface` inbound traffic and copy the -traffic to `monitor-interface` + Example: Mirror the inbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}`` -Example: Mirror the inbound traffic of `{{ var1 }}` port to `{{ var2 }}` + .. code-block:: none -```none + set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }} -``` - set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }} -:::: -::::{cfgcmd} set interfaces {{ var0 }} \ mirror egress +.. cfgcmd:: set interfaces {{ var0 }} mirror egress + - + Configure port mirroring for ```` outbound traffic and copy the + traffic to ```` -Configure port mirroring for `interface` outbound traffic and copy the -traffic to `monitor-interface` + Example: Mirror the outbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}`` -Example: Mirror the outbound traffic of `{{ var1 }}` port to `{{ var2 }}` + .. code-block:: none -```none - -``` - set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }} -:::: + set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }} -- cgit v1.2.3 From 2b1daf484bf71804e0034c13d96d3b37dffd8990 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 02:56:58 +0300 Subject: docs: fix cfgcmd body indent in interface-mirror.txt (Copilot review) --- docs/_include/interface-mirror.txt | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/_include/interface-mirror.txt') diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt index 178f2060..c2305c15 100644 --- a/docs/_include/interface-mirror.txt +++ b/docs/_include/interface-mirror.txt @@ -13,23 +13,23 @@ for different traffic directions. .. cfgcmd:: set interfaces {{ var0 }} mirror ingress - Configure port mirroring for ```` inbound traffic and copy the - traffic to ```` + Configure port mirroring for ```` inbound traffic and copy the + traffic to ```` - Example: Mirror the inbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}`` + Example: Mirror the inbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}`` - .. code-block:: none + .. code-block:: none - set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }} + set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }} .. cfgcmd:: set interfaces {{ var0 }} mirror egress - Configure port mirroring for ```` outbound traffic and copy the - traffic to ```` + Configure port mirroring for ```` outbound traffic and copy the + traffic to ```` - Example: Mirror the outbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}`` + Example: Mirror the outbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}`` - .. code-block:: none + .. code-block:: none - set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }} + set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }} -- cgit v1.2.3