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>2014-10-07 14:26:47 +0100
commitbd3abc2f732da3a61e4158b915480808957a4357 (patch)
treeaaf782fab71ffb0cb4579105a143e22a54975376 /ssh_config.5
parentcbbc8577950b93090171c7394bcdeb68b7c3cd0c (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: 2014-10-07 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 01f1f7ff6..ea92ea80d 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -205,8 +205,12 @@ Valid arguments are
205If set to 205If set to
206.Dq yes , 206.Dq yes ,
207passphrase/password querying will be disabled. 207passphrase/password querying will be disabled.
208In addition, the
209.Cm ServerAliveInterval
210option will be set to 300 seconds by default.
208This option is useful in scripts and other batch jobs where no user 211This option is useful in scripts and other batch jobs where no user
209is present to supply the password. 212is present to supply the password,
213and where it is desirable to detect a broken network swiftly.
210The argument must be 214The argument must be
211.Dq yes 215.Dq yes
212or 216or
@@ -1336,8 +1340,15 @@ from the server,
1336will send a message through the encrypted 1340will send a message through the encrypted
1337channel to request a response from the server. 1341channel to request a response from the server.
1338The default 1342The default
1339is 0, indicating that these messages will not be sent to the server. 1343is 0, indicating that these messages will not be sent to the server,
1344or 300 if the
1345.Cm BatchMode
1346option is set.
1340This option applies to protocol version 2 only. 1347This option applies to protocol version 2 only.
1348.Cm ProtocolKeepAlives
1349and
1350.Cm SetupTimeOut
1351are Debian-specific compatibility aliases for this option.
1341.It Cm StreamLocalBindMask 1352.It Cm StreamLocalBindMask
1342Sets the octal file creation mode mask 1353Sets the octal file creation mode mask
1343.Pq umask 1354.Pq umask
@@ -1403,6 +1414,12 @@ Specifies whether the system should send TCP keepalive messages to the
1403other side. 1414other side.
1404If they are sent, death of the connection or crash of one 1415If they are sent, death of the connection or crash of one
1405of the machines will be properly noticed. 1416of the machines will be properly noticed.
1417This option only uses TCP keepalives (as opposed to using ssh level
1418keepalives), so takes a long time to notice when the connection dies.
1419As such, you probably want
1420the
1421.Cm ServerAliveInterval
1422option as well.
1406However, this means that 1423However, this means that
1407connections will die if the route is down temporarily, and some people 1424connections will die if the route is down temporarily, and some people
1408find it annoying. 1425find it annoying.