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-02-29 12:33:29 +0000
commita9c7a3f8b035fe820fd32283460b1a28e696d2fe (patch)
tree2222e0f6aeea8b13b9bfe825a0e14f850e5be321 /ssh_config.5
parent68e8163d9209f731c582fe5350002c51c9551983 (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 9060d5be2..bbf638b53 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
@@ -1551,7 +1555,14 @@ from the server,
1551will send a message through the encrypted 1555will send a message through the encrypted
1552channel to request a response from the server. 1556channel to request a response from the server.
1553The default 1557The default
1554is 0, indicating that these messages will not be sent to the server. 1558is 0, indicating that these messages will not be sent to the server,
1559or 300 if the
1560.Cm BatchMode
1561option is set.
1562.Cm ProtocolKeepAlives
1563and
1564.Cm SetupTimeOut
1565are Debian-specific compatibility aliases for this option.
1555.It Cm StreamLocalBindMask 1566.It Cm StreamLocalBindMask
1556Sets the octal file creation mode mask 1567Sets the octal file creation mode mask
1557.Pq umask 1568.Pq umask
@@ -1617,6 +1628,12 @@ Specifies whether the system should send TCP keepalive messages to the
1617other side. 1628other side.
1618If they are sent, death of the connection or crash of one 1629If they are sent, death of the connection or crash of one
1619of the machines will be properly noticed. 1630of the machines will be properly noticed.
1631This option only uses TCP keepalives (as opposed to using ssh level
1632keepalives), so takes a long time to notice when the connection dies.
1633As such, you probably want
1634the
1635.Cm ServerAliveInterval
1636option as well.
1620However, this means that 1637However, this means that
1621connections will die if the route is down temporarily, and some people 1638connections will die if the route is down temporarily, and some people
1622find it annoying. 1639find it annoying.