mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
114 lines
4 KiB
Python
114 lines
4 KiB
Python
# this is a virtual module that is entirely implemented server side
|
|
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['stableinterface'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
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:
|
|
- 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)
|
|
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:
|
|
- When set to 'yes', the task will fail if the remote file cannot be
|
|
read for any reason. Prior to Ansible-2.4, setting this would only fail
|
|
if the source file was missing.
|
|
- The default was changed to "yes" in Ansible-2.4.
|
|
required: false
|
|
choices: [ "yes", "no" ]
|
|
default: "yes"
|
|
validate_checksum:
|
|
version_added: "1.4"
|
|
description:
|
|
- Verify that the source and destination checksums match after the files are fetched.
|
|
required: false
|
|
choices: [ "yes", "no" ]
|
|
default: "yes"
|
|
aliases: [ "validate_md5" ]
|
|
flat:
|
|
version_added: "1.2"
|
|
description:
|
|
- Allows you to override the default behavior of appending
|
|
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.
|
|
requirements: []
|
|
author:
|
|
- "Ansible Core Team"
|
|
- "Michael DeHaan"
|
|
notes:
|
|
- When running fetch with C(become), the M(slurp) module will also be
|
|
used to fetch the contents of the file for determining the remote
|
|
checksum. This effectively doubles the transfer size, and
|
|
depending on the file size can consume all available memory on the
|
|
remote or local hosts causing a C(MemoryError). Due to this it is
|
|
advisable to run this module without C(become) whenever possible.
|
|
- Prior to Ansible-2.4 this module would not fail if reading the remote
|
|
file was impossible unless fail_on_missing was set. In Ansible-2.4+,
|
|
playbook authors are encouraged to use fail_when or ignore_errors to
|
|
get this ability. They may also explicitly set fail_on_missing to False
|
|
to get the non-failing behaviour.
|
|
'''
|
|
|
|
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-{{ inventory_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-{{ inventory_hostname }}
|
|
flat: yes
|
|
'''
|