diff options
| author | Toshio Kuratomi <a.badger@gmail.com> | 2017-12-06 08:38:48 -0800 |
|---|---|---|
| committer | Toshio Kuratomi <a.badger@gmail.com> | 2017-12-08 10:07:21 -0800 |
| commit | 298255095d96d3dbfc10f6be4f4cb2fb0419a6ca (patch) | |
| tree | 205a5a5ea4e88c95a4e525c6e5cea9559f49ae38 | |
| parent | 6a6ae0cedeb58db5ab7990a3b1be87196123962c (diff) | |
| download | ansible-298255095d96d3dbfc10f6be4f4cb2fb0419a6ca.tar.gz | |
Fix Command module documentation
The command module docs were unclear. They talked about ignoring the user's environment which lead people to believe the user's environment variables were not used. In actual fact, the user's environment variables are used. They just are not expanded in the command.
(cherry picked from commit 824ec37a4fa03fac3d94d5fbd1b79eea79a2e777)
| -rw-r--r-- | lib/ansible/modules/commands/command.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/ansible/modules/commands/command.py b/lib/ansible/modules/commands/command.py index 5bf535a68f..8c40a953d9 100644 --- a/lib/ansible/modules/commands/command.py +++ b/lib/ansible/modules/commands/command.py @@ -57,7 +57,8 @@ options: default: null notes: - If you want to run a command through the shell (say you are using C(<), C(>), C(|), etc), you actually want the M(shell) module instead. - The C(command) module is much more secure as it's not affected by the user's environment. + Parsing shell metacharacters can lead to unexpected commands being executed if quoting is not done correctly so it is more secure to + use the C(command) module when possible. - " C(creates), C(removes), and C(chdir) can be specified after the command. For instance, if you only want to run a command if a certain file does not exist, use this." - The C(executable) parameter is removed since version 2.4. If you have a need for this parameter, use the M(shell) module instead. |