diff options
| author | Robert Göhler <github@ghlr.de> | 2020-12-09 14:52:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-09 14:52:03 +0100 |
| commit | 4bf9023027b9c5945fc4e21d751f39eb09598727 (patch) | |
| tree | 79249108e920836c206ba8f58c37bb2e9bab9b2e /docs | |
| parent | 4dfdd5057ea801c69f48f1aa83700a2915c1775c (diff) | |
| parent | dd2b63e441ce0d48ae1cbe8d1abac9e4d55c2465 (diff) | |
| download | vyos-documentation-4bf9023027b9c5945fc4e21d751f39eb09598727.tar.gz vyos-documentation-4bf9023027b9c5945fc4e21d751f39eb09598727.zip | |
Merge pull request #386 from jack9603301/master
interface: mirror: Upload Port Mirror(SPAN) Document
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_include/interface-mirror.txt | 17 | ||||
| -rw-r--r-- | docs/configuration/interfaces/bonding.rst | 5 | ||||
| -rw-r--r-- | docs/configuration/interfaces/bridge.rst | 5 | ||||
| -rw-r--r-- | docs/configuration/interfaces/ethernet.rst | 5 |
4 files changed, 32 insertions, 0 deletions
diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt new file mode 100644 index 00000000..8cdbf77d --- /dev/null +++ b/docs/_include/interface-mirror.txt @@ -0,0 +1,17 @@ +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` + +.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress <monitor-interface> + + Configure port mirroring for `interface` outbound traffic and copy the traffic to `monitor-interface` + + diff --git a/docs/configuration/interfaces/bonding.rst b/docs/configuration/interfaces/bonding.rst index 8ec8f34d..547594e5 100644 --- a/docs/configuration/interfaces/bonding.rst +++ b/docs/configuration/interfaces/bonding.rst @@ -263,6 +263,11 @@ VLAN :var0: bond :var1: bond0 +Port Mirror (SPAN) +================== +.. cmdinclude:: ../../_include/interface-mirror.txt + :var0: ethernet + ******* Example ******* diff --git a/docs/configuration/interfaces/bridge.rst b/docs/configuration/interfaces/bridge.rst index 766d2aa5..a471b8f8 100644 --- a/docs/configuration/interfaces/bridge.rst +++ b/docs/configuration/interfaces/bridge.rst @@ -135,6 +135,11 @@ VLAN can either be an individual VLAN id or a range of VLAN ids delimited by a hyphen. +Port Mirror (SPAN) +================== +.. cmdinclude:: ../../_include/interface-mirror.txt + :var0: ethernet + ******* Example ******* diff --git a/docs/configuration/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst index 9311c947..562aeabc 100644 --- a/docs/configuration/interfaces/ethernet.rst +++ b/docs/configuration/interfaces/ethernet.rst @@ -83,6 +83,11 @@ QinQ (802.1ad) :var0: ethernet :var1: eth0 +Port Mirror (SPAN) +================== +.. cmdinclude:: ../../_include/interface-mirror.txt + :var0: ethernet + ********* Operation ********* |