community.general/library/network/fetch

# 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,
       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'.
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:
      - Makes it fails when the source file is missing.
    required: false
    choices: [ "yes", "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:
   - code: "fetch: src=/var/log/messages dest=/home/logtree"
     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: []
author: Michael DeHaan
'''
Setup module no longer saves to disk, as templates are mostly useful in playbooks and this allows lots of simplifications around file pathing and removes occasional permissions conflicts depending on how things are used. 2012-07-14 17:59:12 +02:00			`# this is a virtual module that is entirely implemented server side`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00
			`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,`
Initial Commit. 2013-05-23 19:33:36 +02:00			`organized by hostname. Note that this module is written to transfer`
Update fetch documentation 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'.`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00			`version_added: "0.2"`
			`options:`
			`src:`
			`description:`
DOCUMENTATION strings 2012-11-21 18:49:30 +01:00			`- The file on the remote system to fetch. This I(must) be a file, not a`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00			`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)`
DOCUMENTATION strings 2012-11-21 18:49:30 +01:00			`directory is C(/backup) a I(src) file named C(/etc/profile) on host`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00			`C(host.example.com), would be saved into`
			`C(/backup/host.example.com/etc/profile)`
			`required: true`
			`default: null`
Added a fail_on_missing option to fetch. 2013-03-02 19:04:48 +01:00			`fail_on_missing:`
Double quoted version_added in documentation 2013-03-30 20:44:34 +01:00			`version_added: "1.1"`
Added a fail_on_missing option to fetch. 2013-03-02 19:04:48 +01:00			`description:`
Double quoted version_added in documentation 2013-03-30 20:44:34 +01:00			`- Makes it fails when the source file is missing.`
Added a fail_on_missing option to fetch. 2013-03-02 19:04:48 +01:00			`required: false`
			`choices: [ "yes", "no" ]`
			`default: "no"`
Initial Commit. 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`
			`file, similar to the copy module. Obvioiusly this is only handy if the filenames`
			`are unqiue.`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00			`examples:`
Reformat code: examples consistently - added terse syntax to modules.rst - added description of special variables to template module 2012-10-23 15:14:01 +02:00			`- code: "fetch: src=/var/log/messages dest=/home/logtree"`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00			`description: "Example from Ansible Playbooks"`
Initial Commit. 2013-05-23 19:33:36 +02:00			`- 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"`
DOCUMENTATION for fetch,mount,ohai,easy_install - .rst now supresses default if none is set (looks better in HTML) - .rst now handles empty options list - Fixed postgresql_user and mysql_user because YAML contained colons - docs for facter 2012-09-30 12:21:35 +02:00			`requirements: []`
			`author: Michael DeHaan`
			`'''`