command - Executes a command on a remote node
Synopsis
- The
command
module takes the command name followed by a list of space-delimited arguments. - The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like
$HOME
and operations like"<"
,">"
,"|"
,";"
and"&"
will not work (use the shell module if you need these features). - For Windows targets, use the win_command module instead.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
chdir | Change into this directory before running the command. | |
creates | A filename or (since 2.0) glob pattern, when it already exists, this step will not be run. | |
free_form required | The command module takes a free form command to run. There is no parameter actually named 'free form'. See the examples! | |
removes | A filename or (since 2.0) glob pattern, when it does not exist, this step will not be run. | |
stdin (added in 2.4) | Default: None | Set the stdin of the command directly to the specified value. |
warn (added in 1.8) |
| If command_warnings are on in ansible.cfg, do not warn about this particular line if set to no . |
Notes
Note
- If you want to run a command through the shell (say you are using
<
,>
,|
, etc), you actually want the shell module instead. Parsing shell metacharacters can lead to unexpected commands being executed if quoting is not done correctly so it is more secure to use thecommand
module when possible. -
creates
,removes
, andchdir
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
executable
parameter is removed since version 2.4. If you have a need for this parameter, use the shell module instead. - For Windows targets, use the win_command module instead.
Examples
- name: return motd to registered var command: cat /etc/motd register: mymotd - name: Run the command if the specified file does not exist. command: /usr/bin/make_database.sh arg1 arg2 creates=/path/to/database # You can also use the 'args' form to provide the options. - name: This command will change the working directory to somedir/ and will only run when /path/to/database doesn't exist. command: /usr/bin/make_database.sh arg1 arg2 args: chdir: somedir/ creates: /path/to/database - name: safely use templated variable to run command. Always use the quote filter to avoid injection issues. command: cat {{ myfile|quote }} register: myoutput
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cmd list | always | the cmd that was run on the remote machine Sample: ['echo', 'hello'] |
delta string | always | cmd end time - cmd start time Sample: 0.001529 |
end string | always | cmd end time Sample: 2017-09-29 22:03:48.084657 |
start string | always | cmd start time Sample: 2017-09-29 22:03:48.083128 |
Status
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Support
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Author
- Ansible Core Team
- Michael DeHaan
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/command_module.html