summaryrefslogtreecommitdiff
path: root/docs/_include
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:40:47 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:40:47 +0300
commit43e3609f46d59836e158b931103044687d2848e3 (patch)
tree826366bf15598567b73439ae92b2dca5ef9ceb48 /docs/_include
parent241f97d685a8093bc91e80f6d0ffd84b118f6130 (diff)
downloadvyos-documentation-43e3609f46d59836e158b931103044687d2848e3.tar.gz
vyos-documentation-43e3609f46d59836e158b931103044687d2848e3.zip
docs: convert _include/interface-mirror.txt MyST→RST (per RST-leftovers cleanup design)
Diffstat (limited to 'docs/_include')
-rw-r--r--docs/_include/interface-mirror.txt39
1 files changed, 17 insertions, 22 deletions
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 }} \<interface\> mirror
+.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror
+ ingress <monitor-interface>
-ingress <monitor-interface>
+ Configure port mirroring for ``<interface>`` inbound traffic and copy the
+ traffic to ``<monitor-interface>``
-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 }} \<interface\> mirror egress
+.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress
+ <monitor-interface>
-<monitor-interface>
+ Configure port mirroring for ``<interface>`` outbound traffic and copy the
+ traffic to ``<monitor-interface>``
-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 }}