Author: | Michael DeHaan |
---|
This module works like copy, but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. Note that this module is written to transfer log files that might not be present, so a missing remote file won’t be an error unless fail_on_missing is set to ‘yes’.
parameter | required | default | choices | comments |
---|---|---|---|---|
dest | yes | 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 |
||
fail_on_missing | no | no |
|
Makes it fails when the source file is missing. (added in Ansible 1.1) |
flat | no | Allows you to override the default behavior of prepending 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. Obviously this is only handy if the filenames are unique. (added in Ansible 1.2) | ||
src | yes | 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_md5 | no | yes |
|
Verify that the source and destination md5sums match after the files are fetched. (added in Ansible 1.4) |
# Store file into /tmp/fetched/host.example.com/tmp/somefile
- fetch: src=/tmp/somefile dest=/tmp/fetched
# Specifying a path directly
- fetch: src=/tmp/somefile dest=/tmp/prefix-{{ ansible_hostname }} flat=yes
# Specifying a destination path
- fetch: src=/tmp/uniquefile dest=/tmp/special/ flat=yes
# Storing in a path relative to the playbook
- fetch: src=/tmp/uniquefile dest=special/prefix-{{ ansible_hostname }} flat=yes