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>2016-08-07 12:18:42 +0100
commit67c34f23edbcd0f39ebc2aadae9d33950bd1f98a (patch)
tree7a34e8f2b79cda73a178062c183d317f2b611cfe /ssh_config.5
parente35c0bb4c3997b8ef885c6afdcc600b403eb878b (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: 2015-11-29 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 707d0e1c3..efc265ab7 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -268,8 +268,12 @@ The default is
268If set to 268If set to
269.Dq yes , 269.Dq yes ,
270passphrase/password querying will be disabled. 270passphrase/password querying will be disabled.
271In addition, the
272.Cm ServerAliveInterval
273option will be set to 300 seconds by default.
271This option is useful in scripts and other batch jobs where no user 274This option is useful in scripts and other batch jobs where no user
272is present to supply the password. 275is present to supply the password,
276and where it is desirable to detect a broken network swiftly.
273The argument must be 277The argument must be
274.Dq yes 278.Dq yes
275or 279or
@@ -1624,7 +1628,14 @@ from the server,
1624will send a message through the encrypted 1628will send a message through the encrypted
1625channel to request a response from the server. 1629channel to request a response from the server.
1626The default 1630The default
1627is 0, indicating that these messages will not be sent to the server. 1631is 0, indicating that these messages will not be sent to the server,
1632or 300 if the
1633.Cm BatchMode
1634option is set.
1635.Cm ProtocolKeepAlives
1636and
1637.Cm SetupTimeOut
1638are Debian-specific compatibility aliases for this option.
1628.It Cm StreamLocalBindMask 1639.It Cm StreamLocalBindMask
1629Sets the octal file creation mode mask 1640Sets the octal file creation mode mask
1630.Pq umask 1641.Pq umask
@@ -1690,6 +1701,12 @@ Specifies whether the system should send TCP keepalive messages to the
1690other side. 1701other side.
1691If they are sent, death of the connection or crash of one 1702If they are sent, death of the connection or crash of one
1692of the machines will be properly noticed. 1703of the machines will be properly noticed.
1704This option only uses TCP keepalives (as opposed to using ssh level
1705keepalives), so takes a long time to notice when the connection dies.
1706As such, you probably want
1707the
1708.Cm ServerAliveInterval
1709option as well.
1693However, this means that 1710However, this means that
1694connections will die if the route is down temporarily, and some people 1711connections will die if the route is down temporarily, and some people
1695find it annoying. 1712find it annoying.