summaryrefslogtreecommitdiff
path: root/docs/_include
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:42:00 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:42:00 +0300
commit067a3ac546ff96bb0f8fefa1261027f50cecb673 (patch)
tree5e0529d92ccedd03ae05f772c3ca8373ccd62d06 /docs/_include
parentab2649a8a167b456fcf36c87cec72fcba4d56406 (diff)
downloadvyos-documentation-067a3ac546ff96bb0f8fefa1261027f50cecb673.tar.gz
vyos-documentation-067a3ac546ff96bb0f8fefa1261027f50cecb673.zip
docs: convert _include/interface-vlan-8021q.txt MyST→RST (per RST-leftovers cleanup design)
Diffstat (limited to 'docs/_include')
-rw-r--r--docs/_include/interface-vlan-8021q.txt192
1 files changed, 89 insertions, 103 deletions
diff --git a/docs/_include/interface-vlan-8021q.txt b/docs/_include/interface-vlan-8021q.txt
index 70e017c4..21bdc971 100644
--- a/docs/_include/interface-vlan-8021q.txt
+++ b/docs/_include/interface-vlan-8021q.txt
@@ -21,116 +21,102 @@ revisions is 802.1Q-2014 which incorporated IEEE 802.1aq
802.1q VLAN interfaces are represented as virtual sub-interfaces in VyOS. The
term used for this is ``vif``.
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> vif \<vlan-id\>
+.. cfgcmd:: set interfaces {{ var0 }} <interface> vif <vlan-id>
-::::
-
- Create a new VLAN interface on interface `<interface>` using the VLAN number
- provided via `<vlan-id>`.
+ Create a new VLAN interface on interface ``<interface>`` using the VLAN number
+ provided via ``<vlan-id>``.
You can create multiple VLAN interfaces on a physical interface. The VLAN ID
range is from 0 to 4094.
- :::{note}
- Only 802.1Q-tagged packets are accepted on Ethernet vifs.
- :::
-
-```{cmdincludemd} /_include/interface-address-with-dhcp.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-description.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-disable.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-disable-link-detect.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-mac.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-mtu.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-ip.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-ipv6.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-vrf.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
+ .. note::
+
+ Only 802.1Q-tagged packets are accepted on Ethernet vifs.
+
+.. cmdincludemd:: /_include/interface-address-with-dhcp.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-description.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-disable.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-disable-link-detect.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-mac.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-mtu.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-ip.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-ipv6.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-vrf.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
**DHCP(v6)**
-```{cmdincludemd} /_include/interface-dhcp-options.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-dhcpv6-options.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
-
-```{cmdincludemd} /_include/interface-dhcpv6-prefix-delegation.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif
-:var3: <vlan-id>
-:var4: 10
-```
+.. cmdincludemd:: /_include/interface-dhcp-options.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-dhcpv6-options.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
+
+.. cmdincludemd:: /_include/interface-dhcpv6-prefix-delegation.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif
+ :var3: <vlan-id>
+ :var4: 10
.. include:: /_include/common-references.txt