mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
24 lines
719 B
Text
24 lines
719 B
Text
|
|
||
|
|
DOCUMENTATION = """
|
||
|
|
---
|
||
|
|
module: script
|
||
|
|
short_description: Runs a local script on a remote node
|
||
|
|
description:
|
||
|
|
- The command module takes the script name followed by a list of space-delimited arguments.
|
||
|
|
- The given command will be processed through the shell environment.
|
||
|
|
options:
|
||
|
|
free_form:
|
||
|
|
description:
|
||
|
|
- the command module takes a free form command to run
|
||
|
|
required: true
|
||
|
|
default: null
|
||
|
|
aliases: []
|
||
|
|
examples:
|
||
|
|
- description: "Example from Ansible Playbooks"
|
||
|
|
code: "script: /some/local/script.sh --some-arguments 1234"
|
||
|
|
notes:
|
||
|
|
- It is preferable to write Ansible modules than pushing scripts. Convert your script to an ansible module for bonus points!
|
||
|
|
author: Michael DeHaan
|
||
|
|
"""
|
||
|
|
|