summaryrefslogtreecommitdiff
path: root/docs/_include
diff options
context:
space:
mode:
authormergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2026-05-14 04:23:58 +0000
committerGitHub <noreply@github.com>2026-05-14 04:23:58 +0000
commit90f7c6527c98a147b6cf54d801d100a1cee5b4b9 (patch)
tree5772942e0afd71dd63483ba26076e48528f4befc /docs/_include
parentd0f89d74ba9f880e91c2595a3afc668a64cb9467 (diff)
parent76cc079a11c8d2f60238a4ec19db02ab20d0c09c (diff)
downloadvyos-documentation-90f7c6527c98a147b6cf54d801d100a1cee5b4b9.tar.gz
vyos-documentation-90f7c6527c98a147b6cf54d801d100a1cee5b4b9.zip
Merge pull request #2035 from vyos/yuriy/rst-leftovers-sagitta
docs: convert sagitta `_include/interface-*.txt` from MyST fences back to RST
Diffstat (limited to 'docs/_include')
-rw-r--r--docs/_include/interface-address-with-dhcp.txt20
-rw-r--r--docs/_include/interface-address.txt8
-rw-r--r--docs/_include/interface-common-with-dhcp.txt40
-rw-r--r--docs/_include/interface-common-without-dhcp.txt16
-rw-r--r--docs/_include/interface-common-without-mac.txt64
-rw-r--r--docs/_include/interface-common.txt72
-rw-r--r--docs/_include/interface-description.txt6
-rw-r--r--docs/_include/interface-dhcp-options.txt24
-rw-r--r--docs/_include/interface-dhcpv6-options.txt22
-rw-r--r--docs/_include/interface-dhcpv6-prefix-delegation.txt14
-rw-r--r--docs/_include/interface-disable-flow-control.txt31
-rw-r--r--docs/_include/interface-disable-link-detect.txt6
-rw-r--r--docs/_include/interface-disable.txt8
-rw-r--r--docs/_include/interface-eapol.txt8
-rw-r--r--docs/_include/interface-evpn-uplink.txt4
-rw-r--r--docs/_include/interface-ip.txt70
-rw-r--r--docs/_include/interface-ipv6.txt59
-rw-r--r--docs/_include/interface-mac.txt8
-rw-r--r--docs/_include/interface-mirror.txt39
-rw-r--r--docs/_include/interface-mtu.txt8
-rw-r--r--docs/_include/interface-per-client-thread.txt4
-rw-r--r--docs/_include/interface-vlan-8021ad.txt248
-rw-r--r--docs/_include/interface-vlan-8021q.txt192
-rw-r--r--docs/_include/interface-vrf.txt14
24 files changed, 413 insertions, 572 deletions
diff --git a/docs/_include/interface-address-with-dhcp.txt b/docs/_include/interface-address-with-dhcp.txt
index 101a4e6d..b936abf4 100644
--- a/docs/_include/interface-address-with-dhcp.txt
+++ b/docs/_include/interface-address-with-dhcp.txt
@@ -1,11 +1,9 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} address <address | dhcp |
dhcpv6>
- Configure interface `<interface>` with one or more interface addresses.
+ Configure interface ``<interface>`` with one or more interface addresses.
* **address** can be specified multiple times as IPv4 and/or IPv6
address, e.g. 192.0.2.1/24 and/or 2001:db8::1/64
@@ -14,15 +12,15 @@
* **dhcpv6** interface address is received by DHCPv6 from a DHCPv6
server on this segment.
- :::{note}
- When using DHCP to retrieve IPv4 address and if local
+ .. note::
+
+ When using DHCP to retrieve IPv4 address and if local
+ customizations are needed, they should be possible using the enter and
+ exit hooks provided. The hook dirs are:
- customizations are needed, they should be possible using the enter and
- exit hooks provided. The hook dirs are:
+ * ``/config/scripts/dhcp-client/pre-hooks.d/``
+ * ``/config/scripts/dhcp-client/post-hooks.d/``
- * ``/config/scripts/dhcp-client/pre-hooks.d/``
- * ``/config/scripts/dhcp-client/post-hooks.d/``
- :::
Example:
.. code-block:: none
diff --git a/docs/_include/interface-address.txt b/docs/_include/interface-address.txt
index 90667dde..c7876ecc 100644
--- a/docs/_include/interface-address.txt
+++ b/docs/_include/interface-address.txt
@@ -1,8 +1,6 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> address \<address\>
+.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address>
-::::
-
- Configure interface `<interface>` with one or more interface
+ Configure interface ``<interface>`` with one or more interface
addresses.
* **address** can be specified multiple times as IPv4 and/or IPv6
@@ -13,4 +11,4 @@
.. code-block:: none
set interfaces {{ var0 }} {{ var1 }} address 192.0.2.1/24
- set interfaces {{ var0 }} {{ var1 }} address 2001:db8::1/64 \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} address 2001:db8::1/64
diff --git a/docs/_include/interface-common-with-dhcp.txt b/docs/_include/interface-common-with-dhcp.txt
index 393706f1..e389509e 100644
--- a/docs/_include/interface-common-with-dhcp.txt
+++ b/docs/_include/interface-common-with-dhcp.txt
@@ -1,31 +1,21 @@
-```{cmdincludemd} /_include/interface-address-with-dhcp.txt
-```
+.. cmdincludemd:: /_include/interface-address-with-dhcp.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-common.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-common.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
**DHCP(v6)**
-```{cmdincludemd} /_include/interface-dhcp-options.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-dhcpv6-options.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-dhcp-options.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-dhcpv6-prefix-delegation.txt
-```
+.. cmdincludemd:: /_include/interface-dhcpv6-options.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-dhcpv6-prefix-delegation.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/_include/interface-common-without-dhcp.txt b/docs/_include/interface-common-without-dhcp.txt
index 260653e1..e1bcd69d 100644
--- a/docs/_include/interface-common-without-dhcp.txt
+++ b/docs/_include/interface-common-without-dhcp.txt
@@ -1,11 +1,7 @@
-```{cmdincludemd} /_include/interface-address.txt
-```
+.. cmdincludemd:: /_include/interface-address.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-common.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-common.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/_include/interface-common-without-mac.txt b/docs/_include/interface-common-without-mac.txt
index 4803d4ca..741da782 100644
--- a/docs/_include/interface-common-without-mac.txt
+++ b/docs/_include/interface-common-without-mac.txt
@@ -1,47 +1,31 @@
-```{cmdincludemd} /_include/interface-description.txt
-```
+.. cmdincludemd:: /_include/interface-description.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-disable.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-disable.txt
-```
+.. cmdincludemd:: /_include/interface-disable-flow-control.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-disable-link-detect.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-disable-flow-control.txt
-```
+.. cmdincludemd:: /_include/interface-mtu.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-ip.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-disable-link-detect.txt
-```
+.. cmdincludemd:: /_include/interface-ipv6.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-mtu.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-ip.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-ipv6.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-vrf.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-vrf.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/_include/interface-common.txt b/docs/_include/interface-common.txt
index 45634cd8..f17f7578 100644
--- a/docs/_include/interface-common.txt
+++ b/docs/_include/interface-common.txt
@@ -1,53 +1,35 @@
-```{cmdincludemd} /_include/interface-description.txt
-```
+.. cmdincludemd:: /_include/interface-description.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-disable.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-disable.txt
-```
+.. cmdincludemd:: /_include/interface-disable-flow-control.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-disable-link-detect.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-disable-flow-control.txt
-```
+.. cmdincludemd:: /_include/interface-mac.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-mtu.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-disable-link-detect.txt
-```
+.. cmdincludemd:: /_include/interface-ip.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-ipv6.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
-```{cmdincludemd} /_include/interface-mac.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-mtu.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-ip.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-ipv6.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
-```{cmdincludemd} /_include/interface-vrf.txt
-```
-
- :var0: {{ var0 }}
- :var1: {{ var1 }}
+.. cmdincludemd:: /_include/interface-vrf.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/_include/interface-description.txt b/docs/_include/interface-description.txt
index ac3cbbb0..feffdc02 100644
--- a/docs/_include/interface-description.txt
+++ b/docs/_include/interface-description.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} description <description>
@@ -11,4 +9,4 @@
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} description 'This is an awesome interface running on VyOS' \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} description 'This is an awesome interface running on VyOS'
diff --git a/docs/_include/interface-dhcp-options.txt b/docs/_include/interface-dhcp-options.txt
index 1b25b9cb..c3faad93 100644
--- a/docs/_include/interface-dhcp-options.txt
+++ b/docs/_include/interface-dhcp-options.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcp-options client-id <description>
@@ -16,9 +14,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options client-id 'foo-bar'
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcp-options host-name <hostname>
@@ -31,9 +27,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options host-name 'VyOS'
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcp-options vendor-class-id <vendor-id>
@@ -46,9 +40,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options vendor-class-id 'VyOS'
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcp-options no-default-route
@@ -61,9 +53,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options no-default-route
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcp-options default-route-distance <distance>
@@ -75,9 +65,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options default-route-distance 220
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcp-options reject <address>
diff --git a/docs/_include/interface-dhcpv6-options.txt b/docs/_include/interface-dhcpv6-options.txt
index 4f6b9617..66357cd6 100644
--- a/docs/_include/interface-dhcpv6-options.txt
+++ b/docs/_include/interface-dhcpv6-options.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options duid <duid>
@@ -10,13 +8,15 @@
server compares the DUID with its database and delivers configuration data
(address, lease times, DNS servers, etc.) to the client.
+ .. stop_vyoslinter
+
.. code-block:: none
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} duid '0e:00:00:01:00:01:27:71:db:f0:00:50:56:bf:c5:6d'
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
+ .. start_vyoslinter
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options no-release
@@ -28,9 +28,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options no-release
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options parameters-only
@@ -43,9 +41,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options parameters-only
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options rapid-commit
@@ -56,9 +52,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options rapid-commit
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options temporary
diff --git a/docs/_include/interface-dhcpv6-prefix-delegation.txt b/docs/_include/interface-dhcpv6-prefix-delegation.txt
index 1974ade0..86fc33aa 100644
--- a/docs/_include/interface-dhcpv6-prefix-delegation.txt
+++ b/docs/_include/interface-dhcpv6-prefix-delegation.txt
@@ -4,15 +4,13 @@ VyOS 1.3 (equuleus) supports DHCPv6-PD (:rfc:`3633`). DHCPv6 Prefix Delegation
is supported by most ISPs who provide native IPv6 for consumers on fixed
networks.
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options pd <id> length <length>
Some ISPs by default only delegate a /64 prefix. To request for a specific
prefix size use this option to request for a bigger delegation for this pd
- `<id>`. This value is in the range from 32 - 64 so you could request up to a
+ ``<id>``. This value is in the range from 32 - 64 so you could request up to a
/32 prefix (if your ISP allows this) down to a /64 delegation.
The default value corresponds to 64.
@@ -23,9 +21,7 @@ networks.
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options pd 0 length 56
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee>
address <address>
@@ -50,9 +46,7 @@ networks.
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options pd 0 interface eth8 address 65534
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee> sla-id <id>
diff --git a/docs/_include/interface-disable-flow-control.txt b/docs/_include/interface-disable-flow-control.txt
index 88328c18..17267efd 100644
--- a/docs/_include/interface-disable-flow-control.txt
+++ b/docs/_include/interface-disable-flow-control.txt
@@ -1,25 +1,24 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ disable-flow-control
-disable-flow-control
-::::
+ Ethernet flow control is a mechanism for temporarily stopping the
+ transmission of data on Ethernet family computer networks. The goal of
+ this mechanism is to ensure zero packet loss in the presence of network
+ congestion.
- Ethernet flow control is a mechanism for temporarily stopping the transmission
- of data on Ethernet family computer networks. The goal of this mechanism is to
- ensure zero packet loss in the presence of network congestion.
+ The first flow control mechanism, the pause frame, was defined by the IEEE
+ 802.3x standard.
- The first flow control mechanism, the pause frame, was defined by the IEEE
- 802.3x standard.
+ A sending station (computer or network switch) may be transmitting data
+ faster than the other end of the link can accept it. Using flow control,
+ the receiving station can signal the sender requesting suspension of
+ transmissions until the receiver catches up.
- A sending station (computer or network switch) may be transmitting data faster
- than the other end of the link can accept it. Using flow control, the
- receiving station can signal the sender requesting suspension of
- transmissions until the receiver catches up.
-
- Use this command to disable the generation of Ethernet flow control (pause
- frames).
+ Use this command to disable the generation of Ethernet flow control (pause
+ frames).
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} disable-flow-control \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} disable-flow-control
diff --git a/docs/_include/interface-disable-link-detect.txt b/docs/_include/interface-disable-link-detect.txt
index a8add7f7..eea362e8 100644
--- a/docs/_include/interface-disable-link-detect.txt
+++ b/docs/_include/interface-disable-link-detect.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} disable-link-detect
@@ -13,4 +11,4 @@
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} disable-link-detect \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} disable-link-detect
diff --git a/docs/_include/interface-disable.txt b/docs/_include/interface-disable.txt
index 8ceea73b..84f34dca 100644
--- a/docs/_include/interface-disable.txt
+++ b/docs/_include/interface-disable.txt
@@ -1,14 +1,12 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} disable
- Disable given `<interface>`. It will be placed in administratively down
+ Disable given ``<interface>``. It will be placed in administratively down
(``A/D``) state.
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} disable \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} disable
diff --git a/docs/_include/interface-eapol.txt b/docs/_include/interface-eapol.txt
index 19edfaf6..eeda4965 100644
--- a/docs/_include/interface-eapol.txt
+++ b/docs/_include/interface-eapol.txt
@@ -6,9 +6,7 @@ resources.
EAPoL comes with an identify option. We automatically use the interface MAC
address as identity parameter.
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} eapol ca-certificate <name>
@@ -26,9 +24,7 @@ address as identity parameter.
set pki ca eapol-server-root-ca <Server root CA contents>
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol ca-certificate eapol-server-intermediate-ca
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} eapol certificate <name>
diff --git a/docs/_include/interface-evpn-uplink.txt b/docs/_include/interface-evpn-uplink.txt
index ff319799..3495361d 100644
--- a/docs/_include/interface-evpn-uplink.txt
+++ b/docs/_include/interface-evpn-uplink.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> evpn uplink
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> evpn uplink
When all the underlay links go down the PE no longer has access
to the VxLAN +overlay. To prevent blackholing of traffic the
diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt
index 2b8e9a00..3217e8cb 100644
--- a/docs/_include/interface-ip.txt
+++ b/docs/_include/interface-ip.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip adjust-mss <mss | clamp-mss-to-pmtu>
@@ -9,22 +7,21 @@
a SYN packet. By setting the MSS value, you are telling the remote side
unequivocally 'do not try to send me packets bigger than this value'.
- :::{note}
- This command was introduced in VyOS 1.4 - it was previously called:
+ .. note::
- ``set firewall options interface <name> adjust-mss <value>``
- :::
- :::{hint}
- MSS value = MTU - 20 (IP header) - 20 (TCP header), resulting in
+ This command was introduced in VyOS 1.4 - it was previously called:
- 1452 bytes on a 1492 byte MTU.
- :::
- Instead of a numerical MSS value `clamp-mss-to-pmtu` can be used to
- automatically set the proper value.
+ ``set firewall options interface <name> adjust-mss <value>``
+
+ .. hint::
+
+ MSS value = MTU - 20 (IP header) - 20 (TCP header), resulting in
+ 1452 bytes on a 1492 byte MTU.
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
+ Instead of a numerical MSS value ``clamp-mss-to-pmtu`` can be used to
+ automatically set the proper value.
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip arp-cache-timeout
@@ -40,9 +37,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip arp-cache-timeout 180
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip disable-arp-filter
@@ -66,9 +61,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip disable-arp-filter
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip disable-forwarding
@@ -79,9 +72,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip disable-forwarding
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip enable-directed-broadcast
@@ -98,9 +89,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-directed-broadcast
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip enable-arp-accept
@@ -117,9 +106,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-arp-accept
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip enable-arp-announce
@@ -140,9 +127,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-arp-announce
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip enable-arp-ignore
@@ -159,9 +144,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-arp-ignore
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip enable-proxy-arp
@@ -178,9 +161,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-proxy-arp
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip proxy-arp-pvlan
@@ -193,9 +174,10 @@
possible to allow these hosts to communicate through the upstream router by
proxy_arp'ing.
- :::{note}
- Does not need to be used together with proxy_arp.
- :::
+ .. note::
+
+ Does not need to be used together with proxy_arp.
+
This technology is known by different names:
- In :rfc:`3069` it is called VLAN Aggregation
@@ -206,9 +188,7 @@
- Ericsson call it MAC-Forced Forwarding (RFC Draft)
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip source-validation <strict | loose | disable>
diff --git a/docs/_include/interface-ipv6.txt b/docs/_include/interface-ipv6.txt
index 1d3b741b..0d355849 100644
--- a/docs/_include/interface-ipv6.txt
+++ b/docs/_include/interface-ipv6.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 address autoconf
@@ -12,11 +10,11 @@
its configuration parameters; routers respond to such a request with a router
advertisement packet that contains Internet Layer configuration parameters.
- :::{note}
- This method automatically disables IPv6 traffic forwarding on the
+ .. note::
+
+ This method automatically disables IPv6 traffic forwarding on the
+ interface in question.
- interface in question.
- :::
Example:
.. code-block:: none
@@ -24,9 +22,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 address autoconf
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 address eui64 <prefix>
@@ -39,9 +35,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 address eui64 2001:db8:beef::/64
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 address no-default-link-local
@@ -53,9 +47,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 address no-default-link-local
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 disable-forwarding
@@ -68,9 +60,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 disable-forwarding
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 adjust-mss <mss | clamp-mss-to-pmtu>
@@ -79,22 +69,22 @@
a SYN packet. By setting the MSS value, you are telling the remote side
unequivocally 'do not try to send me packets bigger than this value'.
- :::{note}
- This command was introduced in VyOS 1.4 - it was previously called:
+ .. note::
- ``set firewall options interface <name> adjust-mss6 <value>``
- :::
- :::{hint}
- MSS value = MTU - 40 (IPv6 header) - 20 (TCP header), resulting in
+ This command was introduced in VyOS 1.4 - it was previously called:
- 1432 bytes on a 1492 byte MTU.
- :::
- Instead of a numerical MSS value `clamp-mss-to-pmtu` can be used to
- automatically set the proper value.
+ ``set firewall options interface <name> adjust-mss6 <value>``
+
+ .. hint::
+
+ MSS value = MTU - 40 (IPv6 header) - 20 (TCP header), resulting in
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
+ 1432 bytes on a 1492 byte MTU.
-::::
+ Instead of a numerical MSS value ``clamp-mss-to-pmtu`` can be used to
+ automatically set the proper value.
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 accept-dad <1-3>
@@ -102,7 +92,8 @@
- 0: Disable DAD
- 1: Enable DAD (default)
- - 2: Enable DAD, and disable IPv6 operation if MAC-based duplicate link-local address has been found.
+ - 2: Enable DAD, and disable IPv6 operation if MAC-based duplicate
+ link-local address has been found.
Example:
@@ -110,9 +101,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 accept-dad 2
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ipv6 dup-addr-detect-transmits <n>
diff --git a/docs/_include/interface-mac.txt b/docs/_include/interface-mac.txt
index d81ce660..697bac7a 100644
--- a/docs/_include/interface-mac.txt
+++ b/docs/_include/interface-mac.txt
@@ -1,14 +1,12 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} mac <xx:xx:xx:xx:xx:xx>
Configure user defined :abbr:`MAC (Media Access Control)` address on given
- `<interface>`.
+ ``<interface>``.
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mac '00:01:02:03:04:05' \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mac '00:01:02:03:04:05'
diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt
index 3e2a7bed..c2305c15 100644
--- a/docs/_include/interface-mirror.txt
+++ b/docs/_include/interface-mirror.txt
@@ -2,39 +2,34 @@ 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.
-The benefit of mirroring the traffic is that the application is isolated from
-the source traffic and so application processing does not affect the traffic
+The benefit of mirroring the traffic is that the application is isolated from
+the source traffic and so application processing does not affect the traffic
or the system performance.
-VyOS uses the `mirror` option to configure port mirroring. The configuration
+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
+.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror
+ ingress <monitor-interface>
-ingress <monitor-interface>
+ Configure port mirroring for ``<interface>`` inbound traffic and copy the
+ traffic to ``<monitor-interface>``
-Configure port mirroring for `interface` inbound traffic and copy the
-traffic to `monitor-interface`
+ Example: Mirror the inbound traffic of ``{{ var1 }}`` port to ``{{ var2 }}``
-Example: Mirror the inbound traffic of `{{ var1 }}` port to `{{ var2 }}`
+ .. code-block:: none
-```none
+ set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }}
-```
- set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }}
-::::
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> mirror egress
+.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress
+ <monitor-interface>
-<monitor-interface>
+ Configure port mirroring for ``<interface>`` outbound traffic and copy the
+ traffic to ``<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 ``{{ var2 }}``
-Example: Mirror the outbound traffic of `{{ var1 }}` port to `{{ var2 }}`
+ .. code-block:: none
-```none
-
-```
- set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }}
-::::
+ set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }}
diff --git a/docs/_include/interface-mtu.txt b/docs/_include/interface-mtu.txt
index 01bf102e..7e4bd6ea 100644
--- a/docs/_include/interface-mtu.txt
+++ b/docs/_include/interface-mtu.txt
@@ -1,14 +1,12 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} mtu <mtu>
- Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
+ Configure :abbr:`MTU (Maximum Transmission Unit)` on given ``<interface>``. It
is the size (in bytes) of the largest ethernet frame sent on this link.
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mtu 1600 \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} mtu 1600
diff --git a/docs/_include/interface-per-client-thread.txt b/docs/_include/interface-per-client-thread.txt
index bc662ff5..e9040ee0 100644
--- a/docs/_include/interface-per-client-thread.txt
+++ b/docs/_include/interface-per-client-thread.txt
@@ -1,6 +1,4 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} per-client-thread
diff --git a/docs/_include/interface-vlan-8021ad.txt b/docs/_include/interface-vlan-8021ad.txt
index f3b4aec0..83bdfafe 100644
--- a/docs/_include/interface-vlan-8021ad.txt
+++ b/docs/_include/interface-vlan-8021ad.txt
@@ -26,138 +26,126 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
(service tag with Ethernet Type = 0x88a8).
-```{cmdincludemd} /_include/interface-address-with-dhcp.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-description.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-disable.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-disable-link-detect.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-mac.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-mtu.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-ip.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-ipv6.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-vrf.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
+.. cmdincludemd:: /_include/interface-address-with-dhcp.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-description.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-disable.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-disable-link-detect.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-mac.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-mtu.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-ip.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-ipv6.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-vrf.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
**DHCP(v6)**
-```{cmdincludemd} /_include/interface-dhcp-options.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-dhcpv6-options.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
-
-```{cmdincludemd} /_include/interface-dhcpv6-prefix-delegation.txt
-:var0: {{ var0 }}
-:var1: {{ var1 }}
-:var2: vif-s
-:var3: <vlan-id>
-:var4: 1000
-:var5: vif-c
-:var6: <vlan-id>
-:var7: 20
-```
+.. cmdincludemd:: /_include/interface-dhcp-options.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-dhcpv6-options.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
+
+.. cmdincludemd:: /_include/interface-dhcpv6-prefix-delegation.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+ :var2: vif-s
+ :var3: <vlan-id>
+ :var4: 1000
+ :var5: vif-c
+ :var6: <vlan-id>
+ :var7: 20
.. include:: /_include/common-references.txt
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
diff --git a/docs/_include/interface-vrf.txt b/docs/_include/interface-vrf.txt
index ab98c2d3..d5d43666 100644
--- a/docs/_include/interface-vrf.txt
+++ b/docs/_include/interface-vrf.txt
@@ -1,18 +1,16 @@
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
-
-::::
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} vrf <vrf>
Place interface in given VRF instance.
- :::{seealso}
- There is an entire chapter about how to configure a :ref:`vrf`,
+ .. seealso::
+
+ There is an entire chapter about how to configure a :ref:`vrf`,
+ please check this for additional information.
- please check this for additional information.
- :::
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} vrf red \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} vrf red