From f14c617084d03253cd0b49135d872dcf9064b051 Mon Sep 17 00:00:00 2001 From: Paul Freeman Date: Thu, 17 Sep 2015 11:59:32 +0100 Subject: [PATCH] Documentation for retry_files_enabled and retry_files_save_path --- docsite/rst/intro_configuration.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index 3527d77c8bb..aa64807613f 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -544,6 +544,27 @@ Additional paths can be provided separated by colon characters, in the same way Roles will be first searched for in the playbook directory. Should a role not be found, it will indicate all the possible paths that were searched. +.. _retry_files_enabled: + +retry_files_enabled +=================== + +This controls whether a failed Ansible playbook should create a .retry file. The default setting is True:: + + retry_files_enabled = False + +.. _retry_files_save_path: + +retry_files_save_path +===================== + +The retry files save path is where Ansible will save .retry files when a playbook fails and retry_files_enabled is True (the default). +The default location is ~/ and can be changed to any writeable path:: + + retry_files_save_path = ~/.ansible-retry + +The directory will be created if it does not already exist. + .. _sudo_exe: sudo_exe