Clarify script module documentation a minor amount.
This commit is contained in:
parent
1f96925159
commit
143b82c18c
1 changed files with 4 additions and 3 deletions
|
@ -2,11 +2,12 @@
|
|||
DOCUMENTATION = """
|
||||
---
|
||||
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:
|
||||
- The M(script) module takes the script name followed by a list of
|
||||
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
|
||||
the M(raw) module.
|
||||
options:
|
||||
|
@ -20,7 +21,7 @@ examples:
|
|||
- description: "Example from Ansible Playbooks"
|
||||
code: "action: 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!
|
||||
- It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points!
|
||||
author: Michael DeHaan
|
||||
"""
|
||||
|
||||
|
|
Loading…
Reference in a new issue