summaryrefslogtreecommitdiff
path: root/docs/_include
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_include')
-rw-r--r--docs/_include/interface-adjust-mss.txt13
-rw-r--r--docs/_include/interface-common.txt4
-rw-r--r--docs/_include/interface-ip.txt17
-rw-r--r--docs/_include/interface-ipv6.txt5
-rw-r--r--docs/_include/interface-vlan-8021ad.txt10
-rw-r--r--docs/_include/interface-vlan-8021q.txt7
6 files changed, 21 insertions, 35 deletions
diff --git a/docs/_include/interface-adjust-mss.txt b/docs/_include/interface-adjust-mss.txt
deleted file mode 100644
index 195682e7..00000000
--- a/docs/_include/interface-adjust-mss.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
- {{ var5 }} {{ var6 }} adjust-mss <mss>
-
- As Internet wide PMTU discovery rarely works, we sometimes need to clamp our
- TCP MSS value to a specific value. This is a field in the TCP options part of
- 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:
- ``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.
diff --git a/docs/_include/interface-common.txt b/docs/_include/interface-common.txt
index 4c6ebbe8..5a997482 100644
--- a/docs/_include/interface-common.txt
+++ b/docs/_include/interface-common.txt
@@ -22,10 +22,6 @@
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-adjust-mss.txt
- :var0: {{ var0 }}
- :var1: {{ var1 }}
-
.. cmdinclude:: /_include/interface-ip.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt
index abbed529..75441040 100644
--- a/docs/_include/interface-ip.txt
+++ b/docs/_include/interface-ip.txt
@@ -1,4 +1,21 @@
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ {{ var5 }} {{ var6 }} ip adjust-mss <mss | clamp-mss-to-pmtu>
+
+ As Internet wide PMTU discovery rarely works, we sometimes need to clamp our
+ TCP MSS value to a specific value. This is a field in the TCP options part of
+ 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:
+ ``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.
+
+ 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
Once a neighbor has been found, the entry is considered to be valid for at
diff --git a/docs/_include/interface-ipv6.txt b/docs/_include/interface-ipv6.txt
index d1ed8837..eb60b4e8 100644
--- a/docs/_include/interface-ipv6.txt
+++ b/docs/_include/interface-ipv6.txt
@@ -55,7 +55,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 disable-forwarding
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
- {{ var5 }} {{ var6 }} ipv6 adjust-mss <mss>
+ {{ var5 }} {{ var6 }} ipv6 adjust-mss <mss | clamp-mss-to-pmtu>
As Internet wide PMTU discovery rarely works, we sometimes need to clamp our
TCP MSS value to a specific value. This is a field in the TCP options part of
@@ -67,3 +67,6 @@
.. hint:: MSS value = MTU - 40 (IPv6 header) - 20 (TCP header), resulting in
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.
diff --git a/docs/_include/interface-vlan-8021ad.txt b/docs/_include/interface-vlan-8021ad.txt
index 0b37560f..0a1722dc 100644
--- a/docs/_include/interface-vlan-8021ad.txt
+++ b/docs/_include/interface-vlan-8021ad.txt
@@ -88,16 +88,6 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
-.. cmdinclude:: /_include/interface-adjust-mss.txt
- :var0: {{ var0 }}
- :var1: {{ var1 }}
- :var2: vif-s
- :var3: <vlan-id>
- :var4: 1000
- :var5: vif-c
- :var6: <vlan-id>
- :var7: 20
-
.. cmdinclude:: /_include/interface-ip.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
diff --git a/docs/_include/interface-vlan-8021q.txt b/docs/_include/interface-vlan-8021q.txt
index 7eb8d350..1a527590 100644
--- a/docs/_include/interface-vlan-8021q.txt
+++ b/docs/_include/interface-vlan-8021q.txt
@@ -73,13 +73,6 @@ term used for this is ``vif``.
:var3: <vlan-id>
:var4: 10
-.. cmdinclude:: /_include/interface-adjust-mss.txt
- :var0: {{ var0 }}
- :var1: {{ var1 }}
- :var2: vif
- :var3: <vlan-id>
- :var4: 10
-
.. cmdinclude:: /_include/interface-ip.txt
:var0: {{ var0 }}
:var1: {{ var1 }}