mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
module docs for slurp
This commit is contained in:
parent
f13e20655e
commit
8b737c959d
1 changed files with 29 additions and 0 deletions
|
@ -18,6 +18,35 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: slurp
|
||||||
|
short_description: Slurps a file from remote nodes
|
||||||
|
description:
|
||||||
|
- This module works like M(fetch). It is used for fetching a base64-
|
||||||
|
encoded blob containing the data in a remote file.
|
||||||
|
options:
|
||||||
|
src:
|
||||||
|
description:
|
||||||
|
- The file on the remote system to fetch. This must be a file, not a
|
||||||
|
directory.
|
||||||
|
required: true
|
||||||
|
default: null
|
||||||
|
aliases: []
|
||||||
|
examples:
|
||||||
|
- code: |
|
||||||
|
ansible host -m slurp -a 'src=/tmp/xx'
|
||||||
|
host | success >> {
|
||||||
|
"content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=",
|
||||||
|
"encoding": "base64"
|
||||||
|
}
|
||||||
|
description: "Example using C(/usr/bin/ansible)"
|
||||||
|
notes:
|
||||||
|
- "See also: M(fetch)"
|
||||||
|
requirements: []
|
||||||
|
author: Michael DeHaan
|
||||||
|
'''
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
argument_spec = dict(
|
argument_spec = dict(
|
||||||
|
|
Loading…
Reference in a new issue