Clarify `expect_disconnect` behavior

This commit is contained in:
Rick Hornsby 2020-03-03 12:44:58 -06:00
parent ce674ff272
commit 0a2fb8c383
1 changed files with 3 additions and 3 deletions

View File

@ -65,9 +65,9 @@ The example below is fully functional.
- `Vars` is the list of `environment_vars`, if configured. - `Vars` is the list of `environment_vars`, if configured.
- `EnvVarFile` is the path to the file containing env vars, if - `EnvVarFile` is the path to the file containing env vars, if
`use_env_var_file` is true. `use_env_var_file` is true.
- `expect_disconnect` (boolean) - Defaults to `false`. Whether to error if
the server disconnects us. A disconnect might happen if you restart the ssh - `expect_disconnect` (boolean) - Defaults to `false`. Allow server to disconnect from us without throwing an error.
server or reboot the host. A disconnect might happen if you restart the ssh server or reboot the host.
- `inline_shebang` (string) - The - `inline_shebang` (string) - The
[shebang](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) value to use [shebang](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) value to use