mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
shell module: document removes option and sync with command module doc
This commit is contained in:
parent
c44b876c82
commit
b85743e228
1 changed files with 13 additions and 7 deletions
|
@ -7,20 +7,26 @@ DOCUMENTATION = '''
|
||||||
module: shell
|
module: shell
|
||||||
short_description: Execute commands in nodes.
|
short_description: Execute commands in nodes.
|
||||||
description:
|
description:
|
||||||
- The shell module takes the command name followed by a list of arguments,
|
- The M(shell) module takes the command name followed by a list of space-delimited arguments.
|
||||||
space delimited. It is almost exactly like the M(command) module but runs
|
It is almost exactly like the M(command) module but runs
|
||||||
the command through a shell (C(/bin/sh)) on the remote node.
|
the command through a shell (C(/bin/sh)) on the remote node.
|
||||||
version_added: "0.2"
|
version_added: "0.2"
|
||||||
options:
|
options:
|
||||||
(free form):
|
free_form:
|
||||||
description:
|
description:
|
||||||
- The command module takes a free form command to run
|
- The shell module takes a free form command to run
|
||||||
required: null
|
required: true
|
||||||
default: null
|
default: null
|
||||||
creates:
|
creates:
|
||||||
description:
|
description:
|
||||||
- a filename, when it already exists, this step will NOT be run
|
- a filename, when it already exists, this step will B(not) be run.
|
||||||
required: false
|
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
|
default: null
|
||||||
chdir:
|
chdir:
|
||||||
description:
|
description:
|
||||||
|
|
Loading…
Reference in a new issue