summaryrefslogtreecommitdiff
path: root/docs/interfaces/vlan.rst
diff options
context:
space:
mode:
authorkmpm <peter@birchroad.net>2019-01-20 19:47:04 +0100
committerkmpm <peter@birchroad.net>2019-01-20 19:47:04 +0100
commite6fa2569332c15a61f3c99ba0fe639696836d3bd (patch)
treeea76f27cd53bd4f4de869e5fc7f2654775cb5501 /docs/interfaces/vlan.rst
parentbc5ad9350e7444d5efc470340cb0c979c0606e0c (diff)
downloadvyos-documentation-e6fa2569332c15a61f3c99ba0fe639696836d3bd.tar.gz
vyos-documentation-e6fa2569332c15a61f3c99ba0fe639696836d3bd.zip
Split network-interfaces into multiple files
- Now sections as separate files under interfaces/ - Fixed some references
Diffstat (limited to 'docs/interfaces/vlan.rst')
-rw-r--r--docs/interfaces/vlan.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/interfaces/vlan.rst b/docs/interfaces/vlan.rst
new file mode 100644
index 00000000..76fadd3c
--- /dev/null
+++ b/docs/interfaces/vlan.rst
@@ -0,0 +1,47 @@
+VLAN Sub-Interfaces (802.1Q)
+----------------------------
+.. _interfaces-vlan:
+
+802.1Q VLAN interfaces are represented as virtual sub-interfaces in VyOS. The
+term used for this is `vif`. Configuration of a tagged sub-interface is
+accomplished using the configuration command
+`set interfaces ethernet <name> vif <vlan-id>`.
+
+.. code-block:: sh
+
+ set interfaces ethernet eth1 vif 100 description 'VLAN 100'
+ set interfaces ethernet eth1 vif 100 address '192.168.100.1/24'
+ set interfaces ethernet eth1 vif 100 address '2001:db8:100::1/64'
+
+Resulting in:
+
+.. code-block:: sh
+
+ ethernet eth1 {
+ address 192.168.100.1/24
+ address 2001:db8:100::1/64
+ description INSIDE
+ duplex auto
+ hw-id 00:0c:29:44:3b:19
+ smp_affinity auto
+ speed auto
+ vif 100 {
+ address 192.168.100.1/24
+ description "VLAN 100"
+ }
+ }
+
+VLAN interfaces are shown as `<name>.<vlan-id>`, e.g. `eth1.100`:
+
+.. code-block:: sh
+
+ vyos@vyos:~$ show interfaces
+ Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
+ Interface IP Address S/L Description
+ --------- ---------- --- -----------
+ eth0 172.16.51.129/24 u/u OUTSIDE
+ eth1 192.168.0.1/24 u/u INSIDE
+ eth1.100 192.168.100.1/24 u/u VLAN 100
+ lo 127.0.0.1/8 u/u
+ ::1/128
+