diff options
Diffstat (limited to 'commands/script')
-rw-r--r-- | commands/script | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/commands/script b/commands/script index c5e0e0b9..00a1bced 100644 --- a/commands/script +++ b/commands/script @@ -4,12 +4,12 @@ DOCUMENTATION = """ module: script 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 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. + - "The M(script) module takes the script name followed by a list of + space-delimited arguments. " + - "The local script at path 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: free_form: description: @@ -17,11 +17,12 @@ options: required: true default: null aliases: [] -examples: - - description: "Example from Ansible Playbooks" - code: "action: script /some/local/script.sh --some-arguments 1234" notes: - It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points! author: Michael DeHaan """ +EXAMPLES = ''' +# Example from Ansible Playbooks +- script: /some/local/script.sh --some-arguments 1234 +''' |