diff options
Diffstat (limited to 'lib/ansible/modules/fetch.py')
| -rw-r--r-- | lib/ansible/modules/fetch.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/ansible/modules/fetch.py b/lib/ansible/modules/fetch.py index 646f78d..77ebd19 100644 --- a/lib/ansible/modules/fetch.py +++ b/lib/ansible/modules/fetch.py @@ -16,7 +16,7 @@ short_description: Fetch files from remote nodes description: - This module works like M(ansible.builtin.copy), but in reverse. - It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. -- Files that already exist at I(dest) will be overwritten if they are different than the I(src). +- Files that already exist at O(dest) will be overwritten if they are different than the O(src). - This module is also supported for Windows targets. version_added: '0.2' options: @@ -29,16 +29,16 @@ options: dest: description: - A directory to save the file into. - - For example, if the I(dest) directory is C(/backup) a I(src) file named C(/etc/profile) on host + - For example, if the O(dest) directory is C(/backup) a O(src) file named C(/etc/profile) on host C(host.example.com), would be saved into C(/backup/host.example.com/etc/profile). The host name is based on the inventory name. required: yes fail_on_missing: version_added: '1.1' description: - - When set to C(true), the task will fail if the remote file cannot be read for any reason. + - When set to V(true), the task will fail if the remote file cannot be read for any reason. - Prior to Ansible 2.5, setting this would only fail if the source file was missing. - - The default was changed to C(true) in Ansible 2.5. + - The default was changed to V(true) in Ansible 2.5. type: bool default: yes validate_checksum: @@ -51,7 +51,7 @@ options: version_added: '1.2' description: - Allows you to override the default behavior of appending hostname/path/to/file to the destination. - - If C(dest) ends with '/', it will use the basename of the source file, similar to the copy module. + - If O(dest) ends with '/', it will use the basename of the source file, similar to the copy module. - This can be useful if working with a single host, or if retrieving files that are uniquely named per host. - If using multiple hosts with the same filename, the file will be overwritten for each host. type: bool @@ -85,10 +85,10 @@ notes: remote or local hosts causing a C(MemoryError). Due to this it is advisable to run this module without C(become) whenever possible. - Prior to Ansible 2.5 this module would not fail if reading the remote - file was impossible unless C(fail_on_missing) was set. + file was impossible unless O(fail_on_missing) was set. - In Ansible 2.5 or later, playbook authors are encouraged to use C(fail_when) or C(ignore_errors) to get this ability. They may - also explicitly set C(fail_on_missing) to C(false) to get the + also explicitly set O(fail_on_missing) to V(false) to get the non-failing behaviour. seealso: - module: ansible.builtin.copy |