ansible/raw

# this is a virtual module that is entirely implemented server side

DOCUMENTATION = '''
---
module: raw
short_description: Executes a low-down and dirty SSH command
options: {}
description: 
     - Executes a low-down and dirty SSH command, not going through the module
       subsystem. This is useful and should only be done in two cases. The
       first case is installing C(python-simplejson) on older (Python 2.4 and
       before) hosts that need it as a dependency to run modules, since nearly
       all core modules require it. Another is speaking to any devices such as
       routers that do not have any Python installed. In any other case, using
       the M(shell) or M(command) module is much more appropriate. Arguments
       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: "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
'''
Setup module no longer saves to disk, as templates are mostly useful in playbooks and this allows lots of simplifications around file pathing and removes occasional permissions conflicts depending on how things are used. 13 years ago			`# this is a virtual module that is entirely implemented server side`
First attempt at standardizing DOCUMENTATION string (new DICT) 12 years ago
			`DOCUMENTATION = '''`
			`---`
			`module: raw`
Tweak DOCUMENTATION YAML as per latest 991 12 years ago			`short_description: Executes a low-down and dirty SSH command`
Module documentation should have options sorted 12 years ago			`options: {}`
Tweak DOCUMENTATION YAML as per latest 991 12 years ago			`description:`
			`- Executes a low-down and dirty SSH command, not going through the module`
			`subsystem. This is useful and should only be done in two cases. The`
DOCUMENTATION strings 12 years ago			`first case is installing C(python-simplejson) on older (Python 2.4 and`
Tweak DOCUMENTATION YAML as per latest 991 12 years ago			`before) hosts that need it as a dependency to run modules, since nearly`
			`all core modules require it. Another is speaking to any devices such as`
			`routers that do not have any Python installed. In any other case, using`
			`the M(shell) or M(command) module is much more appropriate. Arguments`
Add return code and error output to raw module Since we use 'raw' heavily on equipment where 'command' and 'shell' are not (yet) working (and python may need to be installed first using raw) these improvements are necessary in order to write more complex scripts (with return code handling and separated stdout/stderr). This change includes the following changes: - exec_command() now returns the return code of the command - _low_level_exec_command() now returns a dict, including 'rc', 'stdout' and 'stderr' - all users of the above interfaces have been improved to make use of the above changes - all connection plugins have been modified to return rc and stderr - fix the newline problem (stdout and stderr would have excess newlines) In a future commit I intend to add assertions or error handling code to verify the return code in those places where it wasn't done. Since only the output was available, the return code was ignored, even though we expect them to be 0. 12 years ago			`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.`
Make script module use raw module so it does not require python 12 years ago			`- This module does not require python on the remote system, much like`
			`the M(script) module.`
First attempt at standardizing DOCUMENTATION string (new DICT) 12 years ago			`examples:`
Add return code and error output to raw module Since we use 'raw' heavily on equipment where 'command' and 'shell' are not (yet) working (and python may need to be installed first using raw) these improvements are necessary in order to write more complex scripts (with return code handling and separated stdout/stderr). This change includes the following changes: - exec_command() now returns the return code of the command - _low_level_exec_command() now returns a dict, including 'rc', 'stdout' and 'stderr' - all users of the above interfaces have been improved to make use of the above changes - all connection plugins have been modified to return rc and stderr - fix the newline problem (stdout and stderr would have excess newlines) In a future commit I intend to add assertions or error handling code to verify the return code in those places where it wasn't done. Since only the output was available, the return code was ignored, even though we expect them to be 0. 12 years ago			`- description: Example from C(/usr/bin/ansible) to bootstrap a legacy python 2.4 host`
Make script module use raw module so it does not require python 12 years ago			`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.`
Added attribution to all module DOCUMENTATION strings 12 years ago			`author: Michael DeHaan`
First attempt at standardizing DOCUMENTATION string (new DICT) 12 years ago			`'''`