fetch 1.06 KB
Newer Older
1
# this is a virtual module that is entirely implemented server side
2 3 4 5 6 7 8 9 10 11 12 13 14

DOCUMENTATION = '''
---
module: fetch
short_description: Fetches a file from remote nodes
description:
     - This module works like M(copy), but in reverse. It is used for fetching
       files from remote machines and storing them locally in a file tree,
       organized by hostname.
version_added: "0.2"
options:
  src:
    description:
Jan-Piet Mens committed
15
      - The file on the remote system to fetch. This I(must) be a file, not a
16 17 18 19 20 21 22
        directory. Recursive fetching may be supported in a later release.
    required: true
    default: null
    aliases: []
  dest:
    description:
      - A directory to save the file into. For example, if the I(dest)
Jan-Piet Mens committed
23
        directory is C(/backup) a I(src) file named C(/etc/profile) on host
24 25 26 27 28
        C(host.example.com), would be saved into
        C(/backup/host.example.com/etc/profile)
    required: true
    default: null
examples:
29
   - code: "fetch: src=/var/log/messages dest=/home/logtree"
30 31 32 33
     description: "Example from Ansible Playbooks"
requirements: []
author: Michael DeHaan
'''