mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
43 lines
1.4 KiB
Plaintext
43 lines
1.4 KiB
Plaintext
12 years ago
|
# this is a virtual module that is entirely implemented server side
|
||
12 years ago
|
|
||
|
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,
|
||
12 years ago
|
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'.
|
||
12 years ago
|
version_added: "0.2"
|
||
|
options:
|
||
|
src:
|
||
|
description:
|
||
12 years ago
|
- The file on the remote system to fetch. This I(must) be a file, not a
|
||
12 years ago
|
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)
|
||
12 years ago
|
directory is C(/backup) a I(src) file named C(/etc/profile) on host
|
||
12 years ago
|
C(host.example.com), would be saved into
|
||
|
C(/backup/host.example.com/etc/profile)
|
||
|
required: true
|
||
|
default: null
|
||
12 years ago
|
fail_on_missing:
|
||
12 years ago
|
version_added: "1.1"
|
||
12 years ago
|
description:
|
||
12 years ago
|
- Makes it fails when the source file is missing.
|
||
12 years ago
|
required: false
|
||
|
choices: [ "yes", "no" ]
|
||
|
default: "no"
|
||
12 years ago
|
examples:
|
||
12 years ago
|
- code: "fetch: src=/var/log/messages dest=/home/logtree"
|
||
12 years ago
|
description: "Example from Ansible Playbooks"
|
||
|
requirements: []
|
||
|
author: Michael DeHaan
|
||
|
'''
|