summaryrefslogtreecommitdiff
path: root/docs/_include/interface-ip.txt
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/interface-ip.txt
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/interface-ip.txt')
-rw-r--r--docs/_include/interface-ip.txt70
1 files changed, 25 insertions, 45 deletions
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>