Documentation

win_command - Executes a command on a remote Windows node

New in version 2.2.

Synopsis

  • The win_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 $env:HOME and operations like "<", ">", "|", and ";" will not work (use the win_shell module if you need these features).

Options

parameter required default choices comments
chdir
no
set the specified path as the current working directory before executing a command
creates
no
a path or path filter pattern; when the referenced path exists on the target host, the task will be skipped.
free_form
yes
the win_command module takes a free form command to run. There is no parameter actually named 'free form'. See the examples!
removes
no
a path or path filter pattern; when the referenced path does not exist on the target host, the task will be skipped.

Examples

# Example from Ansible Playbooks.
- win_command: whoami
  register: whoami_out

# Run the command only if the specified file does not exist.
- win_command: wbadmin -backupTarget:C:\backup\ creates=C:\backup\

# You can also use the 'args' form to provide the options. This command
# will change the working directory to C:\somedir\\ and will only run when
# C:\backup\ doesn't exist.
- win_command: wbadmin -backupTarget:C:\backup\ creates=C:\backup\
  args:
    chdir: C:\somedir\
    creates: C:\backup\

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
end The command execution end time always string 2016-02-25 09:18:26.755339
stdout The command standard output always string Clustering node [email protected] with [email protected] ...
cmd The command executed by the task always string rabbitmqctl join_cluster [email protected]
start The command execution start time always string 2016-02-25 09:18:26.429568
delta The command execution delta time always string 0:00:00.325771
stderr The command standard error always string ls: cannot access foo: No such file or directory
rc The command return code (0 means success) always int 0
msg changed always boolean True
stdout_lines The command standard output split in lines always list ["u'Clustering node [email protected] with [email protected] ...'"]


Notes

Note

  • If you want to run a command through a shell (say you are using <, >, |, etc), you actually want the win_shell module instead. The win_command module is much more secure as it’s not affected by the user’s environment.
  • creates, removes, and 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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is maintained by those with core commit privileges

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.