diff options
Diffstat (limited to 'lib/ansible/modules/shell.py')
| -rw-r--r-- | lib/ansible/modules/shell.py | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/lib/ansible/modules/shell.py b/lib/ansible/modules/shell.py index cd403b7c..52fda1b0 100644 --- a/lib/ansible/modules/shell.py +++ b/lib/ansible/modules/shell.py @@ -16,8 +16,8 @@ DOCUMENTATION = r''' module: shell short_description: Execute shell commands on targets description: - - The M(ansible.builtin.shell) module takes the command name followed by a list of space-delimited arguments. - - Either a free form command or O(cmd) parameter is required, see the examples. + - The C(shell) module takes the command name followed by a list of space-delimited arguments. + - Either a free form command or C(cmd) parameter is required, see the examples. - It is almost exactly like the M(ansible.builtin.command) module but runs the command through a shell (C(/bin/sh)) on the remote node. - For Windows targets, use the M(ansible.windows.win_shell) module instead. @@ -69,7 +69,7 @@ extends_documentation_fragment: - action_common_attributes.raw attributes: check_mode: - details: while the command itself is arbitrary and cannot be subject to the check mode semantics it adds O(creates)/O(removes) options as a workaround + details: while the command itself is arbitrary and cannot be subject to the check mode semantics it adds C(creates)/C(removes) options as a workaround support: partial diff_mode: support: none @@ -90,8 +90,6 @@ notes: - An alternative to using inline shell scripts with this module is to use the M(ansible.builtin.script) module possibly together with the M(ansible.builtin.template) module. - For rebooting systems, use the M(ansible.builtin.reboot) or M(ansible.windows.win_reboot) module. - - If the command returns non UTF-8 data, it must be encoded to avoid issues. One option is to pipe - the output through C(base64). seealso: - module: ansible.builtin.command - module: ansible.builtin.raw |