summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2020-12-20 16:33:55 +0100
committerGitHub <noreply@github.com>2020-12-20 16:33:55 +0100
commitd26b6a952be035a261a505cec3f45f148fc0a877 (patch)
treee33b960371896d71747473db680848f857adc25c /docs
parentc06ec85619a4c98342ab8791d73fd6ab5a9239db (diff)
parent84ea67db630846210df983f4ab4cb966a550790a (diff)
downloadvyos-documentation-d26b6a952be035a261a505cec3f45f148fc0a877.tar.gz
vyos-documentation-d26b6a952be035a261a505cec3f45f148fc0a877.zip
Merge pull request #399 from jack9603301/master
Examples of adding VLAN awareness and port mirroring
Diffstat (limited to 'docs')
-rw-r--r--docs/_include/interface-mirror.txt12
-rw-r--r--docs/configuration/interfaces/bonding.rst4
-rw-r--r--docs/configuration/interfaces/bridge.rst22
-rw-r--r--docs/configuration/interfaces/ethernet.rst2
4 files changed, 38 insertions, 2 deletions
diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt
index a3d12220..7903299a 100644
--- a/docs/_include/interface-mirror.txt
+++ b/docs/_include/interface-mirror.txt
@@ -12,11 +12,23 @@ for different traffic directions.
Configure port mirroring for `interface` inbound traffic and copy the
traffic to `monitor-interface`
+
+ Example: Mirror the inbound traffic of `{{ var1 }}` port to `eth2`
+
+ .. 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 `eth2`
+
+ .. code-block:: none
+
+ set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }}
diff --git a/docs/configuration/interfaces/bonding.rst b/docs/configuration/interfaces/bonding.rst
index 84f00132..92601b37 100644
--- a/docs/configuration/interfaces/bonding.rst
+++ b/docs/configuration/interfaces/bonding.rst
@@ -266,7 +266,9 @@ VLAN
Port Mirror (SPAN)
==================
.. cmdinclude:: ../../_include/interface-mirror.txt
- :var0: ethernet
+ :var0: bonding
+ :var1: bond1
+ :var2: eth3
*******
Example
diff --git a/docs/configuration/interfaces/bridge.rst b/docs/configuration/interfaces/bridge.rst
index a471b8f8..17e3d50b 100644
--- a/docs/configuration/interfaces/bridge.rst
+++ b/docs/configuration/interfaces/bridge.rst
@@ -127,6 +127,12 @@ VLAN
VLAN tag enters the port, the data packet will be forced to add a tag of a
specific vlan id. When the vlan id flag flows out, the tag of the vlan id
will be stripped
+
+ Example: Set `eth0` member port to be native VLAN 2
+
+ .. code-block:: none
+
+ set interfaces bridge br1 member interface eth0 native-vlan 2
.. cfgcmd:: set interfaces bridge <interface> member interface <member>
allowed-vlan <vlan-id>
@@ -134,11 +140,25 @@ VLAN
Allows specific VLAN IDs to pass through the bridge member interface. This
can either be an individual VLAN id or a range of VLAN ids delimited by a
hyphen.
+
+ Example: Set `eth0` member port to be allowed VLAN 4
+
+ .. code-block:: none
+
+ set interfaces bridge br1 member interface eth0 allowed-vlan 4
+
+ Example: Set `eth0` member port to be allowed VLAN 6-8
+
+ .. code-block:: none
+
+ set interfaces bridge br1 member interface eth0 allowed-vlan 6-8
Port Mirror (SPAN)
==================
.. cmdinclude:: ../../_include/interface-mirror.txt
- :var0: ethernet
+ :var0: bridge
+ :var1: br1
+ :var2: eth3
*******
Example
diff --git a/docs/configuration/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst
index 2debed16..25eebf25 100644
--- a/docs/configuration/interfaces/ethernet.rst
+++ b/docs/configuration/interfaces/ethernet.rst
@@ -121,6 +121,8 @@ Port Mirror (SPAN)
==================
.. cmdinclude:: ../../_include/interface-mirror.txt
:var0: ethernet
+ :var1: eth1
+ :var2: eth3
*********
Operation