From 4bc9e94a7ad57ee6735533da59a808dc8caf3ba5 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Thu, 26 Nov 2020 20:12:54 +0100
Subject: ethernet: document mirror CLI option

---
 docs/interfaces/ethernet.rst | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 8b1ad6bd..f2ab3f67 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -31,7 +31,8 @@ Ethernet options
 
    VyOS default will be `auto`.
 
-.. cfgcmd:: set interfaces ethernet <interface> speed <auto | 10 | 100 | 1000 | 2500 | 5000 | 10000 | 25000 | 40000 | 50000 | 100000>
+.. cfgcmd:: set interfaces ethernet <interface> speed <auto | 10 | 100 | 1000 |
+  2500 | 5000 | 10000 | 25000 | 40000 | 50000 | 100000>
 
    Configure physical interface speed setting.
 
@@ -49,6 +50,22 @@ Ethernet options
 
    VyOS default will be `auto`.
 
+
+.. cfgcmd:: set interfaces ethernet <interface> mirror <interface>
+
+  Use this command to mirror the inbound traffic from one Ethernet interface to
+  another interface. This feature is typically used to provide a copy of traffic
+  inbound on one interface to a system running a monitoring or IPS application
+  on another interface. 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.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces ethernet eth0 mirror eth1
+
 VLAN
 ====
 
-- 
cgit v1.2.3