summaryrefslogtreecommitdiff
path: root/ssh_config.5
diff options
context:
space:
mode:
authorRichard Kettlewell <rjk@greenend.org.uk>2014-02-09 16:09:52 +0000
committerColin Watson <cjwatson@debian.org>2017-01-16 15:02:53 +0000
commit9078d9722d24a42b8f86621d20a6a6b42ba18d37 (patch)
tree643f99b191240b82cc1987e4d66da88916a44f76 /ssh_config.5
parentffecece153b7caedf997dccf17747633675631fd (diff)
Various keepalive extensions
Add compatibility aliases for ProtocolKeepAlives and SetupTimeOut, supported in previous versions of Debian's OpenSSH package but since superseded by ServerAliveInterval. (We're probably stuck with this bit for compatibility.) In batch mode, default ServerAliveInterval to five minutes. Adjust documentation to match and to give some more advice on use of keepalives. Author: Ian Jackson <ian@chiark.greenend.org.uk> Author: Matthew Vernon <matthew@debian.org> Author: Colin Watson <cjwatson@debian.org> Last-Update: 2016-12-26 Patch-Name: keepalive-extensions.patch
Diffstat (limited to 'ssh_config.5')
-rw-r--r--ssh_config.521
1 files changed, 19 insertions, 2 deletions
diff --git a/ssh_config.5 b/ssh_config.5
index a7703fc77..a0457314c 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -250,8 +250,12 @@ Valid arguments are
250If set to 250If set to
251.Cm yes , 251.Cm yes ,
252passphrase/password querying will be disabled. 252passphrase/password querying will be disabled.
253In addition, the
254.Cm ServerAliveInterval
255option will be set to 300 seconds by default (Debian-specific).
253This option is useful in scripts and other batch jobs where no user 256This option is useful in scripts and other batch jobs where no user
254is present to supply the password. 257is present to supply the password,
258and where it is desirable to detect a broken network swiftly.
255The argument must be 259The argument must be
256.Cm yes 260.Cm yes
257or 261or
@@ -1485,7 +1489,14 @@ from the server,
1485will send a message through the encrypted 1489will send a message through the encrypted
1486channel to request a response from the server. 1490channel to request a response from the server.
1487The default 1491The default
1488is 0, indicating that these messages will not be sent to the server. 1492is 0, indicating that these messages will not be sent to the server,
1493or 300 if the
1494.Cm BatchMode
1495option is set (Debian-specific).
1496.Cm ProtocolKeepAlives
1497and
1498.Cm SetupTimeOut
1499are Debian-specific compatibility aliases for this option.
1489.It Cm StreamLocalBindMask 1500.It Cm StreamLocalBindMask
1490Sets the octal file creation mode mask 1501Sets the octal file creation mode mask
1491.Pq umask 1502.Pq umask
@@ -1544,6 +1555,12 @@ Specifies whether the system should send TCP keepalive messages to the
1544other side. 1555other side.
1545If they are sent, death of the connection or crash of one 1556If they are sent, death of the connection or crash of one
1546of the machines will be properly noticed. 1557of the machines will be properly noticed.
1558This option only uses TCP keepalives (as opposed to using ssh level
1559keepalives), so takes a long time to notice when the connection dies.
1560As such, you probably want
1561the
1562.Cm ServerAliveInterval
1563option as well.
1547However, this means that 1564However, this means that
1548connections will die if the route is down temporarily, and some people 1565connections will die if the route is down temporarily, and some people
1549find it annoying. 1566find it annoying.