summaryrefslogtreecommitdiff
path: root/docs/_include/interface-mirror.txt
diff options
context:
space:
mode:
authormergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2026-05-14 04:23:58 +0000
committerGitHub <noreply@github.com>2026-05-14 04:23:58 +0000
commit90f7c6527c98a147b6cf54d801d100a1cee5b4b9 (patch)
tree5772942e0afd71dd63483ba26076e48528f4befc /docs/_include/interface-mirror.txt
parentd0f89d74ba9f880e91c2595a3afc668a64cb9467 (diff)
parent76cc079a11c8d2f60238a4ec19db02ab20d0c09c (diff)
downloadvyos-documentation-90f7c6527c98a147b6cf54d801d100a1cee5b4b9.tar.gz
vyos-documentation-90f7c6527c98a147b6cf54d801d100a1cee5b4b9.zip
Merge pull request #2035 from vyos/yuriy/rst-leftovers-sagitta
docs: convert sagitta `_include/interface-*.txt` from MyST fences back to RST
Diffstat (limited to 'docs/_include/interface-mirror.txt')
-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..c2305c15 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 }}