Tweak DOCUMENTATION YAML as per latest 991

This commit is contained in:
Jan-Piet Mens
2012-09-19 16:09:26 +02:00
parent 1bd9ea6440
commit 60e0410298
4 changed files with 77 additions and 40 deletions

View File

@@ -3,18 +3,18 @@
DOCUMENTATION = '''
---
module: raw
short_description: Executes a low-down and dirty SSH command, not going through the module subsystem.
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 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
'shell' or 'command' module is much more appropriate. Arguments given to
'raw' are run directly through the configured remote shell and only output
is returned. There is no error detection or change handler support for
this module
short_description: Executes a low-down and dirty SSH command
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 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 and
only output is returned. There is no error detection or change handler
support for this module
examples:
- code: ansible newhost.example.com -m raw -a "yum -y install python-simplejson"
description: Example from /usr/bin/ansible to bootstrap a legacy python 2.4 host