fetch.py (ansible-2.14.0) | : | fetch.py (ansible-2.14.1rc1) | ||
---|---|---|---|---|
skipping to change at line 38 | skipping to change at line 38 | |||
dest: | dest: | |||
description: | description: | |||
- A directory to save the file into. | - 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 I(dest) directory is C(/backup) a I(src) file named C( /etc/profile) on host | |||
C(host.example.com), would be saved into C(/backup/host.example.com/etc/pr ofile). | C(host.example.com), would be saved into C(/backup/host.example.com/etc/pr ofile). | |||
The host name is based on the inventory name. | The host name is based on the inventory name. | |||
required: yes | required: yes | |||
fail_on_missing: | fail_on_missing: | |||
version_added: '1.1' | version_added: '1.1' | |||
description: | description: | |||
- When set to C(yes), the task will fail if the remote file cannot be read f or any reason. | - When set to C(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. | - Prior to Ansible 2.5, setting this would only fail if the source file was missing. | |||
- The default was changed to C(yes) in Ansible 2.5. | - The default was changed to C(true) in Ansible 2.5. | |||
type: bool | type: bool | |||
default: yes | default: yes | |||
validate_checksum: | validate_checksum: | |||
version_added: '1.4' | version_added: '1.4' | |||
description: | description: | |||
- Verify that the source and destination checksums match after the files are fetched. | - Verify that the source and destination checksums match after the files are fetched. | |||
type: bool | type: bool | |||
default: yes | default: yes | |||
flat: | flat: | |||
version_added: '1.2' | version_added: '1.2' | |||
skipping to change at line 90 | skipping to change at line 90 | |||
- When running fetch with C(become), the M(ansible.builtin.slurp) module will al so be | - When running fetch with C(become), the M(ansible.builtin.slurp) module will al so be | |||
used to fetch the contents of the file for determining the remote | used to fetch the contents of the file for determining the remote | |||
checksum. This effectively doubles the transfer size, and | checksum. This effectively doubles the transfer size, and | |||
depending on the file size can consume all available memory on the | depending on the file size can consume all available memory on the | |||
remote or local hosts causing a C(MemoryError). Due to this it is | remote or local hosts causing a C(MemoryError). Due to this it is | |||
advisable to run this module without C(become) whenever possible. | advisable to run this module without C(become) whenever possible. | |||
- Prior to Ansible 2.5 this module would not fail if reading the remote | - 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 C(fail_on_missing) was set. | |||
- In Ansible 2.5 or later, playbook authors are encouraged to use | - 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 | C(fail_when) or C(ignore_errors) to get this ability. They may | |||
also explicitly set C(fail_on_missing) to C(no) to get the | also explicitly set C(fail_on_missing) to C(false) to get the | |||
non-failing behaviour. | non-failing behaviour. | |||
seealso: | seealso: | |||
- module: ansible.builtin.copy | - module: ansible.builtin.copy | |||
- module: ansible.builtin.slurp | - module: ansible.builtin.slurp | |||
author: | author: | |||
- Ansible Core Team | - Ansible Core Team | |||
- Michael DeHaan | - Michael DeHaan | |||
''' | ''' | |||
EXAMPLES = r''' | EXAMPLES = r''' | |||
End of changes. 3 change blocks. | ||||
3 lines changed or deleted | 3 lines changed or added |