ANSIBLE.FETCH(3)                ANSIBLE MODULES               ANSIBLE.FETCH(3)



NAME
       fetch - Fetches a file from remote nodes

DESCRIPTION
       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'.

OPTIONS
       dest   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(required)

       fail_on_missing
              Makes it fails when the source file is missing.  Choices:
              yes,no. (default: no)(Added in Ansible version 1.1.)


       flat   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 version 1.2.)


       src    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.(required)

       validate_md5
              Verify that the source and destination md5sums match after the
              files are fetched.  Choices: yes,no. (default: yes)(Added in
              Ansible version 1.4.)

EXAMPLES
       # 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



AUTHOR
       Michael DeHaan

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#fetch



1.4.5                             2014-02-12                  ANSIBLE.FETCH(3)
