1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Merge pull request #2945 from jsmartin/new_fetch

Fetch destination path can now be overriden.
This commit is contained in:
Michael DeHaan 2013-05-24 19:57:19 -07:00
commit 84623441e1
2 changed files with 28 additions and 3 deletions

View file

@ -46,14 +46,26 @@ class ActionModule(object):
options.update(utils.parse_kv(module_args)) options.update(utils.parse_kv(module_args))
source = options.get('src', None) source = options.get('src', None)
dest = options.get('dest', None) dest = options.get('dest', None)
flat = options.get('flat', False)
flat = utils.boolean(flat)
fail_on_missing = options.get('fail_on_missing', False) fail_on_missing = options.get('fail_on_missing', False)
fail_on_missing = utils.boolean(fail_on_missing) fail_on_missing = utils.boolean(fail_on_missing)
if source is None or dest is None: if source is None or dest is None:
results = dict(failed=True, msg="src and dest are required") results = dict(failed=True, msg="src and dest are required")
return ReturnData(conn=conn, result=results) return ReturnData(conn=conn, result=results)
# files are saved in dest dir, with a subdir for each host, then the filename if flat:
dest = "%s/%s/%s" % (utils.path_dwim(self.runner.basedir, dest), conn.host, source) if dest.endswith("/"):
# if the path ends with "/", we'll use the source filename as the
# destination filename
base = os.path.basename(source)
dest = os.path.join(dest, base)
if not dest.startswith("/"):
# if dest does not start with "/", we'll assume a relative path
dest = utils.path_dwim(self.runner.basedir, dest)
else:
# files are saved in dest dir, with a subdir for each host, then the filename
dest = "%s/%s/%s" % (utils.path_dwim(self.runner.basedir, dest), conn.host, source)
dest = dest.replace("//","/") dest = dest.replace("//","/")
# calculate md5 sum for the remote file # calculate md5 sum for the remote file

View file

@ -7,7 +7,7 @@ short_description: Fetches a file from remote nodes
description: description:
- This module works like M(copy), but in reverse. It is used for fetching - 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, files from remote machines and storing them locally in a file tree,
organized by hostname. Note that this module is written to transfer 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 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'. be an error unless fail_on_missing is set to 'yes'.
version_added: "0.2" version_added: "0.2"
@ -34,9 +34,22 @@ options:
required: false required: false
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
default: "no" default: "no"
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
file, similar to the copy module. Obvioiusly this is only handy if the filenames
are unqiue.
examples: examples:
- code: "fetch: src=/var/log/messages dest=/home/logtree" - code: "fetch: src=/var/log/messages dest=/home/logtree"
description: "Example from Ansible Playbooks" description: "Example from Ansible Playbooks"
- code: "fetch: src=/tmp/somefile dest="/tmp/beefcake-{{ ansible_hostname }}" flat=yes"
description: "Copies a file from remote machine and stores it at the absolute path /tmp/beefcake-{{ ansible_hostname }}"
- code: "fetch: src=/tmp/uniquefile dest="/tmp/special/" flat=yes"
description: "Copies a file from remote machine and stores it at the absolute path /tmp/special"
- code: "fetch: src=/tmp/uniquefile dest="special/" flat=yes"
description: "Copies a file from remote machine and stores it in special/uniquefile relative to the playbook"
requirements: [] requirements: []
author: Michael DeHaan author: Michael DeHaan
''' '''