ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Clarify script module documentation a minor amount.

Browse source
This commit is contained in:
Michael DeHaan 2013-04-25 08:45:23 -04:00
parent 1f96925159
commit 143b82c18c
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
library/script
View file

@ -2,11 +2,12 @@
DOCUMENTATION = """ DOCUMENTATION = """
--- ---
module: script module: script
short_description: Runs a local script on a remote node short_description: Runs a local script on a remote node after transferring it
description: description:
- The M(script) module takes the script name followed by a list of - The M(script) module takes the script name followed by a list of
space-delimited arguments. space-delimited arguments.
- The given script will be processed through the shell environment. - The pathed local script will be transfered to the remote node and then executed.
- The given script will be processed through the shell environment on the remote node.
- This module does not require python on the remote system, much like - This module does not require python on the remote system, much like
the M(raw) module. the M(raw) module.
options: options:
@ -20,7 +21,7 @@ examples:
- description: "Example from Ansible Playbooks" - description: "Example from Ansible Playbooks"
code: "action: script /some/local/script.sh --some-arguments 1234" code: "action: script /some/local/script.sh --some-arguments 1234"
notes: notes:
- It is preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points! - It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points!
author: Michael DeHaan author: Michael DeHaan
""" """