summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Levesque <irlevesque@gmail.com>2017-04-18 20:06:51 -0400
committerscottb <dharmabumstead@users.noreply.github.com>2017-04-18 17:06:51 -0700
commitacd1dd8df12dc0727b9fb1dab79ed1c3009110c5 (patch)
tree6dd94d30a8cc9d0f8ee7babaa42d472f73e48344
parentd63af51f90d72c199189ea80b1ca40d7a030f48d (diff)
downloadansible-acd1dd8df12dc0727b9fb1dab79ed1c3009110c5.tar.gz
Add ssh_connection / retries option documentation (#23463)
No docs were included when https://github.com/ansible/ansible/pull/9927 was merged.
-rw-r--r--docs/docsite/rst/intro_configuration.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/docsite/rst/intro_configuration.rst b/docs/docsite/rst/intro_configuration.rst
index a104b7b554..c1901898b5 100644
--- a/docs/docsite/rst/intro_configuration.rst
+++ b/docs/docsite/rst/intro_configuration.rst
@@ -1107,6 +1107,15 @@ This defaults to::
control_path_dir=~/.ansible/cp
+.. _retries:
+
+retries
+=======
+
+Adds the option to retry failed ssh executions if the failure is encountered in ssh itself, not the remote command. This can be helpful if there are transient network issues. Enabled by setting retries to an integer greater than 1. Defaults to::
+
+ retries = 0
+
.. _scp_if_ssh:
scp_if_ssh