summaryrefslogtreecommitdiff
path: root/docs/_include
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:39:38 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:39:38 +0300
commitfa9ba9ae2e9ae3b247d8d60d21b8ef107662aebb (patch)
tree44a45ff0ec3f37857628ac49dcc3a8fddcc6f85a /docs/_include
parent38dbd8698d0ea6498c60aa2892cbe693ef95d4c8 (diff)
downloadvyos-documentation-fa9ba9ae2e9ae3b247d8d60d21b8ef107662aebb.tar.gz
vyos-documentation-fa9ba9ae2e9ae3b247d8d60d21b8ef107662aebb.zip
docs: convert _include/interface-ip.txt MyST→RST (per RST-leftovers cleanup design)
Diffstat (limited to 'docs/_include')
-rw-r--r--docs/_include/interface-ip.txt71
1 files changed, 26 insertions, 45 deletions
diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt
index 2b8e9a00..4a8dbe64 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,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-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::
-::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }}
+ MSS value = MTU - 20 (IP header) - 20 (TCP header), resulting in
-::::
+ 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.
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
{{ var5 }} {{ var6 }} ip arp-cache-timeout
@@ -40,9 +38,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 +62,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 +73,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 +90,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 +107,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 +128,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 +145,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 +162,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 +175,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 +189,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>