summaryrefslogtreecommitdiff
path: root/docs/_include/interface-mirror.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_include/interface-mirror.txt')
-rw-r--r--docs/_include/interface-mirror.txt34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt
new file mode 100644
index 00000000..f2b340fe
--- /dev/null
+++ b/docs/_include/interface-mirror.txt
@@ -0,0 +1,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
+
+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
+ ingress <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 }}`
+
+ .. code-block:: none
+
+ set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }}
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress
+ <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 }}`
+
+ .. code-block:: none
+
+ set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }}
+
+