From acd1dd8df12dc0727b9fb1dab79ed1c3009110c5 Mon Sep 17 00:00:00 2001 From: Ian Levesque Date: Tue, 18 Apr 2017 20:06:51 -0400 Subject: [PATCH] Add ssh_connection / retries option documentation (#23463) No docs were included when https://github.com/ansible/ansible/pull/9927 was merged. --- docs/docsite/rst/intro_configuration.rst | 9 +++++++++ 1 file changed, 9 insertions(+) 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