ansible.builtin.fetch – Fetch files from remote nodes

Note

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name fetch even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 0.2: of ansible.builtin

Synopsis

  • This module works like 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 dest will be overwritten if they are different than the src.
  • This module is also supported for Windows targets.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
dest
string / required
A directory to save the file into.
For example, if the dest directory is /backup a src file named /etc/profile on host host.example.com, would be saved into /backup/host.example.com/etc/profile. The host name is based on the inventory name.
fail_on_missing
boolean
added in 1.1 of ansible.builtin
    Choices:
  • no
  • yes ←
When set to yes, 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 yes in Ansible 2.5.
flat
boolean
added in 1.2 of ansible.builtin
    Choices:
  • no ←
  • yes
Allows you to override the default behavior of appending hostname/path/to/file to the destination.
If 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.
src
string / required
The file on the remote system to fetch.
This must be a file, not a directory.
Recursive fetching may be supported in a later release.
validate_checksum
boolean
added in 1.4 of ansible.builtin
    Choices:
  • no
  • yes ←
Verify that the source and destination checksums match after the files are fetched.

Notes

Note

  • When running fetch with become, the ansible.builtin.slurp module will also be used to fetch the contents of the file for determining the remote checksum. This effectively doubles the transfer size, and depending on the file size can consume all available memory on the remote or local hosts causing a MemoryError. Due to this it is advisable to run this module without become whenever possible.
  • Prior to Ansible 2.5 this module would not fail if reading the remote file was impossible unless fail_on_missing was set.
  • In Ansible 2.5 or later, playbook authors are encouraged to use fail_when or ignore_errors to get this ability. They may also explicitly set fail_on_missing to no to get the non-failing behaviour.
  • This module is also supported for Windows targets.
  • Supports check_mode.

See Also

See also

ansible.builtin.copy

The official documentation on the ansible.builtin.copy module.

ansible.builtin.slurp

The official documentation on the ansible.builtin.slurp module.

Examples

- name: Store file into /tmp/fetched/host.example.com/tmp/somefile
  ansible.builtin.fetch:
    src: /tmp/somefile
    dest: /tmp/fetched

- name: Specifying a path directly
  ansible.builtin.fetch:
    src: /tmp/somefile
    dest: /tmp/prefix-{{ inventory_hostname }}
    flat: yes

- name: Specifying a destination path
  ansible.builtin.fetch:
    src: /tmp/uniquefile
    dest: /tmp/special/
    flat: yes

- name: Storing in a path relative to the playbook
  ansible.builtin.fetch:
    src: /tmp/uniquefile
    dest: special/prefix-{{ inventory_hostname }}
    flat: yes

Authors

  • Ansible Core Team
  • Michael DeHaan

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/fetch_module.html