ansible/library/files/fetch

61 lines
2.1 KiB
Text
Raw Normal View History

# this is a virtual module that is entirely implemented server side
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,
2013-05-23 19:33:36 +02:00
organized by hostname. Note that this module is written to transfer
2013-03-18 04:17:56 +01:00
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'.
version_added: "0.2"
options:
src:
description:
2012-11-21 18:49:30 +01:00
- The file on the remote system to fetch. This I(must) be a file, not a
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)
2012-11-21 18:49:30 +01:00
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/profile)
required: true
default: null
fail_on_missing:
version_added: "1.1"
description:
- Makes it fails when the source file is missing.
required: false
choices: [ "yes", "no" ]
default: "no"
2013-05-23 19:33:36 +02:00
flat:
version_added: "1.2"
description:
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
2013-07-02 04:33:25 +02:00
file, similar to the copy module. Obviously this is only handy if the filenames
2013-05-23 19:33:36 +02:00
are unqiue.
requirements: []
author: Michael DeHaan
'''
2013-05-29 16:45:31 +02:00
EXAMPLES = '''
# Store file into /tmp/fetched/host.example.com/tmp/somefile
- fetch: src=/tmp/somefile dest=/tmp/fetched
2013-05-29 16:45:31 +02:00
# Specifying a path directly
- fetch: src=/tmp/somefile dest=/tmp/prefix-{{ ansible_hostname }} flat=yes
2013-05-29 16:45:31 +02:00
# Specifying a destination path
- fetch: src=/tmp/uniquefile dest=/tmp/special/ flat=yes
2013-05-29 16:45:31 +02:00
# Storing in a path relative to the playbook
- fetch: src=/tmp/uniquefile dest=special/prefix-{{ ansible_hostname }} flat=yes
2013-05-29 16:45:31 +02:00
'''