summaryrefslogtreecommitdiff
path: root/docs/_include/interface-adjust-mss.txt
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-10-08 21:33:17 +0200
committerChristian Poessinger <christian@poessinger.com>2021-10-08 21:33:17 +0200
commitb34fb791251b3c79cc15ed59b26b77411a929661 (patch)
tree68a41bb51fc736c43987bca8387ad36e746af879 /docs/_include/interface-adjust-mss.txt
parent6bf77c37f10147daf076f8abfc7cf1923a92a67b (diff)
downloadvyos-documentation-b34fb791251b3c79cc15ed59b26b77411a929661.tar.gz
vyos-documentation-b34fb791251b3c79cc15ed59b26b77411a929661.zip
interfaces: T3090: add new TCP MSS clamping CLI commands
Diffstat (limited to 'docs/_include/interface-adjust-mss.txt')
-rw-r--r--docs/_include/interface-adjust-mss.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/_include/interface-adjust-mss.txt b/docs/_include/interface-adjust-mss.txt
new file mode 100644
index 00000000..195682e7
--- /dev/null
+++ b/docs/_include/interface-adjust-mss.txt
@@ -0,0 +1,13 @@
+.. 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.