diff --git a/raw b/raw index 061d8eb066a..6e5b760fa8e 100644 --- a/raw +++ b/raw @@ -16,8 +16,16 @@ description: given to M(raw) are run directly through the configured remote shell. Standard output, error output and return code are returned when available. There is no change handler support for this module. + - This module does not require python on the remote system, much like + the M(script) module. examples: - description: Example from C(/usr/bin/ansible) to bootstrap a legacy python 2.4 host - code: ansible newhost.example.com -m raw -a "yum -y install python-simplejson" + code: "action: raw yum -y install python-simplejson" +notes: + - If you want to execute a command securely and predictably, it may be + better to use the M(command) module instead. Best practices when writing + playbooks will follow the trend of using M(command) unless M(shell) is + explicitly required. When running ad-hoc commands, use your best + judgement. author: Michael DeHaan ''' diff --git a/script b/script index 054f4a807d4..0e0b5138034 100644 --- a/script +++ b/script @@ -4,9 +4,11 @@ DOCUMENTATION = """ module: script short_description: Runs a local script on a remote node description: - - The M(script) module takes the script name followed by a list of space-delimited arguments. + - 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. - - See also the M(command) and M(shell) modules. + - This module does not require python on the remote system, much like + the M(raw) module. options: free_form: description: @@ -16,7 +18,7 @@ options: aliases: [] examples: - description: "Example from Ansible Playbooks" - code: "script: /some/local/script.sh --some-arguments 1234" + 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! author: Michael DeHaan