mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 13:20:23 -07:00
Library functions and modules should be in the 3 man page section. Also the files should end in '.3'
This commit is contained in:
parent
53d24ef002
commit
85fb7c6d4b
45 changed files with 10 additions and 8 deletions
28
docs/man/man3/ansible.raw.3
Normal file
28
docs/man/man3/ansible.raw.3
Normal file
|
@ -0,0 +1,28 @@
|
|||
.TH ANSIBLE.RAW 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/raw
|
||||
.SH NAME
|
||||
raw \- Executes a low-down and dirty SSH command
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
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 \fIshell\fR or \fIcommand\fR module is much more appropriate. Arguments given to \fIraw\fR 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
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
."
|
||||
."
|
||||
." ------ NOTES
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
ansible newhost.example.com -m raw -a "yum -y install python-simplejson"
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Michael DeHaan
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#raw
|
Loading…
Add table
Add a link
Reference in a new issue