diff options
author | Stoned Elipot <stoned.elipot@gmail.com> | 2013-12-25 12:12:11 +0100 |
---|---|---|
committer | Stoned Elipot <stoned.elipot@gmail.com> | 2013-12-25 12:12:11 +0100 |
commit | 0955744b3a0b32619cabc4659ef0b2dd6f461590 (patch) | |
tree | fd04593884db8226f10a76a228b99f527606f514 /commands | |
parent | 4c168abcccb08902014c435c71d6757755632536 (diff) | |
download | ansible-modules-core-0955744b3a0b32619cabc4659ef0b2dd6f461590.tar.gz |
shell module: document removes option and sync with command module doc
Diffstat (limited to 'commands')
-rw-r--r-- | commands/shell | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/commands/shell b/commands/shell index 5b3969a1..03299b96 100644 --- a/commands/shell +++ b/commands/shell @@ -7,20 +7,26 @@ DOCUMENTATION = ''' module: shell short_description: Execute commands in nodes. description: - - The shell module takes the command name followed by a list of arguments, - space delimited. It is almost exactly like the M(command) module but runs + - The M(shell) module takes the command name followed by a list of space-delimited arguments. + It is almost exactly like the M(command) module but runs the command through a shell (C(/bin/sh)) on the remote node. version_added: "0.2" options: - (free form): + free_form: description: - - The command module takes a free form command to run - required: null + - The shell module takes a free form command to run + required: true default: null creates: description: - - a filename, when it already exists, this step will NOT be run - required: false + - a filename, when it already exists, this step will B(not) be run. + required: no + default: null + removes: + description: + - a filename, when it does not exist, this step will B(not) be run. + version_added: "0.8" + required: no default: null chdir: description: |