summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsrividya0208 <a.srividya@vyos.io>2023-07-19 04:38:46 -0400
committerrebortg <github@ghlr.de>2023-07-20 15:25:29 +0200
commita2cd087623827933dc3d50ad3cf559e164a1e5d8 (patch)
tree26c6812eb0a9bcd9abb3121f9cda4136bf1e9806 /docs
parent00d250e42462eb1a4c4ad40302f3b6efe261afe4 (diff)
downloadvyos-documentation-a2cd087623827933dc3d50ad3cf559e164a1e5d8.tar.gz
vyos-documentation-a2cd087623827933dc3d50ad3cf559e164a1e5d8.zip
interface mirror options are changed.
two paragraphs are defined about the mirror option, removed the paragraph having the older cli structure. (cherry picked from commit c7d52cf762def52fecf9d1ec08dff61032dabd86)
Diffstat (limited to 'docs')
-rw-r--r--docs/_include/interface-mirror.txt5
-rw-r--r--docs/configuration/interfaces/ethernet.rst15
2 files changed, 4 insertions, 16 deletions
diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt
index f2b340fe..66d63248 100644
--- a/docs/_include/interface-mirror.txt
+++ b/docs/_include/interface-mirror.txt
@@ -1,7 +1,10 @@
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
+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
+or the system performance.
VyOS uses the `mirror` option to configure port mirroring. The configuration
is divided into 2 different directions. Destination ports should be configured
diff --git a/docs/configuration/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst
index cdf85576..ade72c98 100644
--- a/docs/configuration/interfaces/ethernet.rst
+++ b/docs/configuration/interfaces/ethernet.rst
@@ -53,21 +53,6 @@ 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
-
Offloading
----------