diff options
author | Richard Kettlewell <rjk@greenend.org.uk> | 2014-02-09 16:09:52 +0000 |
---|---|---|
committer | Colin Watson <cjwatson@debian.org> | 2020-10-18 12:07:21 +0100 |
commit | 164d1c9f11309d38273ac64e30eda2baa3733f78 (patch) | |
tree | 0164bba0d3d7196bb5ba57cb1c3ffb9a5d136e39 /ssh_config.5 | |
parent | 61b4d4c07d19cd0816ab5d48da81a75f7adbdf24 (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: 2020-02-21
Patch-Name: keepalive-extensions.patch
Diffstat (limited to 'ssh_config.5')
-rw-r--r-- | ssh_config.5 | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/ssh_config.5 b/ssh_config.5 index bd86d000c..3ceb800ba 100644 --- a/ssh_config.5 +++ b/ssh_config.5 | |||
@@ -275,9 +275,13 @@ If set to | |||
275 | .Cm yes , | 275 | .Cm yes , |
276 | user interaction such as password prompts and host key confirmation requests | 276 | user interaction such as password prompts and host key confirmation requests |
277 | will be disabled. | 277 | will be disabled. |
278 | In addition, the | ||
279 | .Cm ServerAliveInterval | ||
280 | option will be set to 300 seconds by default (Debian-specific). | ||
278 | This option is useful in scripts and other batch jobs where no user | 281 | This option is useful in scripts and other batch jobs where no user |
279 | is present to interact with | 282 | is present to interact with |
280 | .Xr ssh 1 . | 283 | .Xr ssh 1 , |
284 | and where it is desirable to detect a broken network swiftly. | ||
281 | The argument must be | 285 | The argument must be |
282 | .Cm yes | 286 | .Cm yes |
283 | or | 287 | or |
@@ -1624,7 +1628,14 @@ from the server, | |||
1624 | will send a message through the encrypted | 1628 | will send a message through the encrypted |
1625 | channel to request a response from the server. | 1629 | channel to request a response from the server. |
1626 | The default | 1630 | The default |
1627 | is 0, indicating that these messages will not be sent to the server. | 1631 | is 0, indicating that these messages will not be sent to the server, |
1632 | or 300 if the | ||
1633 | .Cm BatchMode | ||
1634 | option is set (Debian-specific). | ||
1635 | .Cm ProtocolKeepAlives | ||
1636 | and | ||
1637 | .Cm SetupTimeOut | ||
1638 | are Debian-specific compatibility aliases for this option. | ||
1628 | .It Cm SetEnv | 1639 | .It Cm SetEnv |
1629 | Directly specify one or more environment variables and their contents to | 1640 | Directly specify one or more environment variables and their contents to |
1630 | be sent to the server. | 1641 | be sent to the server. |
@@ -1704,6 +1715,12 @@ Specifies whether the system should send TCP keepalive messages to the | |||
1704 | other side. | 1715 | other side. |
1705 | If they are sent, death of the connection or crash of one | 1716 | If they are sent, death of the connection or crash of one |
1706 | of the machines will be properly noticed. | 1717 | of the machines will be properly noticed. |
1718 | This option only uses TCP keepalives (as opposed to using ssh level | ||
1719 | keepalives), so takes a long time to notice when the connection dies. | ||
1720 | As such, you probably want | ||
1721 | the | ||
1722 | .Cm ServerAliveInterval | ||
1723 | option as well. | ||
1707 | However, this means that | 1724 | However, this means that |
1708 | connections will die if the route is down temporarily, and some people | 1725 | connections will die if the route is down temporarily, and some people |
1709 | find it annoying. | 1726 | find it annoying. |