summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-11-23 17:32:11 +0100
committerChristian Poessinger <christian@poessinger.com>2020-11-23 17:32:11 +0100
commit6588e905512e80e6038fd210837b52f43a7632ad (patch)
tree90f0b2fb985ebd2901301b2638912e3e42a42268 /docs/interfaces
parent55b77175b4824384f5540a17f53f4e18fbedbce0 (diff)
downloadvyos-documentation-6588e905512e80e6038fd210837b52f43a7632ad.tar.gz
vyos-documentation-6588e905512e80e6038fd210837b52f43a7632ad.zip
interfaces: add generic VLAN documentation
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/bond.rst7
-rw-r--r--docs/interfaces/bridge.rst61
-rw-r--r--docs/interfaces/ethernet.rst7
-rw-r--r--docs/interfaces/pseudo-ethernet.rst7
-rw-r--r--docs/interfaces/wireless.rst8
5 files changed, 44 insertions, 46 deletions
diff --git a/docs/interfaces/bond.rst b/docs/interfaces/bond.rst
index 21088c02..eea35e2c 100644
--- a/docs/interfaces/bond.rst
+++ b/docs/interfaces/bond.rst
@@ -256,6 +256,13 @@ Bond options
The maximum number of targets that can be specified is 16. The default value
is no IP addresses.
+VLAN
+====
+
+.. cmdinclude:: ../_include/interface-vlan.txt
+ :var0: bond
+ :var1: bond0
+
*******
Example
*******
diff --git a/docs/interfaces/bridge.rst b/docs/interfaces/bridge.rst
index 058d7b01..045ae2a8 100644
--- a/docs/interfaces/bridge.rst
+++ b/docs/interfaces/bridge.rst
@@ -113,56 +113,27 @@ links providing fault tolerance if an active link fails.
Designated Bridges. Hello packets are used to communicate information
about the topology throughout the entire Bridged Local Area Network.
-Enable VLAN-aware bridge
--------------------------
+VLAN
+====
-.. cfgcmd:: set interfaces bridge <interface> member interface <member> native-vlan <vlan-id>
-
- Set the native VLAN ID flag of the interface. When a data packet without a 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
-
-.. cfgcmd:: set interfaces bridge <interface> member interface <member> allowed-vlan <vlan-id>
-
- Allows specific VLAN IDs to pass through the bridge member interface
-
-.. cfgcmd:: set interfaces bridge <interface> member interface <member> allowed-vlan <n-m>
-
- `n` and `m` represent a VLAN ID, which identifies a VLAN ID range and allows all VLAN IDS in this range to pass through the bridge member interface
-
-VLAN (802.1q) configuration
----------------------------
-
-IEEE 802.1q, often referred to as Dot1q, is the networking standard that supports
-virtual LANs (VLANs) on an IEEE 802.3 Ethernet network. The standard defines a
-system of VLAN tagging for Ethernet frames and the accompanying procedures to be
-used by bridges and switches in handling such frames. The standard also contains
-provisions for a quality-of-service prioritization scheme commonly known as IEEE
-802.1p and defines the Generic Attribute Registration Protocol.
-
-Portions of the network which are VLAN-aware (i.e., IEEE 802.1q conformant) can
-include VLAN tags. When a frame enters the VLAN-aware portion of the network, a
-tag is added to represent the VLAN membership. Each frame must be distinguishable
-as being within exactly one VLAN. A frame in the VLAN-aware portion of the network
-that does not contain a VLAN tag is assumed to be flowing on the native VLAN.
-
-The standard was developed by IEEE 802.1, a working group of the IEEE 802
-standards committee, and continues to be actively revised. One of the notable
-revisions is 802.1Q-2014 which incorporated IEEE 802.1aq (Shortest Path Bridging)
-and much of the IEEE 802.1d standard.
-
-802.1q VLAN interfaces are represented as virtual sub-interfaces in VyOS. The
-term used for this is ``vif``.
+.. cmdinclude:: ../_include/interface-vlan.txt
+ :var0: bridge
+ :var1: br0
-.. cfgcmd:: set interfaces bridge <interface> vif <vlan-id>
+.. cfgcmd:: set interfaces bridge <interface> member interface <member>
+ native-vlan <vlan-id>
- Create a new VLAN interface on interface `<interface>` using the VLAN number
- provided via `<vlan-id>`.
+ Set the native VLAN ID flag of the interface. When a data packet without a
+ 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
- You can create multiple VLAN interfaces on a physical interface. The VLAN ID
- range is from 1 to 4094.
+.. cfgcmd:: set interfaces bridge <interface> member interface <member>
+ allowed-vlan <vlan-id>
- .. note:: Only 802.1Q-tagged packets are accepted on Bridge vifs.
+ 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
diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 71a340b1..343a7d59 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -49,6 +49,13 @@ Ethernet options
VyOS default will be `auto`.
+VLAN
+====
+
+.. cmdinclude:: ../_include/interface-vlan.txt
+ :var0: ethernet
+ :var1: eth0
+
*********
Operation
*********
diff --git a/docs/interfaces/pseudo-ethernet.rst b/docs/interfaces/pseudo-ethernet.rst
index b373a617..d4eb8eff 100644
--- a/docs/interfaces/pseudo-ethernet.rst
+++ b/docs/interfaces/pseudo-ethernet.rst
@@ -56,3 +56,10 @@ Pseudo Ethernet/MACVLAN options
Specifies the physical `<ethX>` Ethernet interface associated with a Pseudo
Ethernet `<interface>`.
+
+VLAN
+====
+
+.. cmdinclude:: ../_include/interface-vlan.txt
+ :var0: pseudo-ethernet
+ :var1: peth0
diff --git a/docs/interfaces/wireless.rst b/docs/interfaces/wireless.rst
index 75c42f29..b51eb274 100644
--- a/docs/interfaces/wireless.rst
+++ b/docs/interfaces/wireless.rst
@@ -274,7 +274,6 @@ VHT (Very High Throughput) capabilities (802.11ac)
Station supports receiving VHT variant HT Control field
-
Wireless options (Station/Client)
=================================
@@ -373,6 +372,13 @@ Resulting in
}
+VLAN
+====
+
+.. cmdinclude:: ../_include/interface-vlan.txt
+ :var0: wireless
+ :var1: wlan0
+
*********
Operation
*********