diff options
| author | Brian Coca <bcoca@users.noreply.github.com> | 2024-11-07 22:22:40 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-07 22:22:40 +0100 |
| commit | bf48b538f8b5757649b87a33f5f9771025beae09 (patch) | |
| tree | a61d9372985bd635616a1ea557d307eeb1b21cb4 | |
| parent | ansible-test - Replace FreeBSD 13.3 with 13.4 (#84236) (diff) | |
| download | ansible-bf48b538f8b5757649b87a33f5f9771025beae09.tar.xz ansible-bf48b538f8b5757649b87a33f5f9771025beae09.zip | |
command module, fix docs to reflect reality (#84191)
though the previous docs were the 'intended' outcome,
the current behaviour has been active for a long time and should
not be removed due to backward compatibility issues.
One thing we can do going forward is deprecate substitution enabled by default.
| -rw-r--r-- | lib/ansible/modules/command.py | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/lib/ansible/modules/command.py b/lib/ansible/modules/command.py index 2ce939ac28..ed71342ab6 100644 --- a/lib/ansible/modules/command.py +++ b/lib/ansible/modules/command.py @@ -15,12 +15,11 @@ version_added: historical description: - The M(ansible.builtin.command) module takes the command name followed by a list of space-delimited arguments. - The given command will be executed on all selected nodes. - - The command(s) will not be - processed through the shell, so variables like C($HOSTNAME) and operations - like C("*"), C("<"), C(">"), C("|"), C(";") and C("&") will not work. + - The command(s) will not be processed through the shell, so operations like C("*"), C("<"), C(">"), C("|"), C(";") and C("&") will not work. + Also, environment variables are resolved via Python, not shell, see O(expand_argument_vars) and are left unchanged if not matched. Use the M(ansible.builtin.shell) module if you need these features. - - To create C(command) tasks that are easier to read than the ones using space-delimited - arguments, pass parameters using the C(args) L(task keyword,https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#task) + - To create C(command) tasks that are easier to read than the ones using space-delimited arguments, + pass parameters using the C(args) L(task keyword,https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html#task) or use O(cmd) parameter. - Either a free form command or O(cmd) parameter is required, see the examples. - For Windows targets, use the M(ansible.windows.win_command) module instead. @@ -41,8 +40,8 @@ attributes: options: expand_argument_vars: description: - - Expands the arguments that are variables, for example C($HOME) will be expanded before being passed to the - command to run. + - Expands the arguments that are variables, for example C($HOME) will be expanded before being passed to the command to run. + - If a variable is not matched, it is left unchanged, unlike shell substitution which would remove it. - Set to V(false) to disable expansion and treat the value as a literal argument. type: bool default: true |