New in version 2.2.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
chdir
|
|
set the specified path as the current working directory before executing a command.
|
creates
|
|
a path or path filter pattern; when the referenced path exists on the target host, the task will be skipped.
|
free_form
required |
|
the
win_command module takes a free form command to run. There is no parameter actually named 'free form'. See the examples! |
removes
|
|
a path or path filter pattern; when the referenced path does not exist on the target host, the task will be skipped.
|
stdin
(added in 2.5) |
|
Set the stdin of the command directly to the specified value.
|
Note
- name: Save the result of 'whoami' in 'whoami_out'
win_command: whoami
register: whoami_out
- name: Run command that only runs if folder exists and runs from a specific folder
win_command: wbadmin -backupTarget:C:\backup\
args:
chdir: C:\somedir\
creates: C:\backup\
- name: Run an executable and send data to the stdin for the executable
win_command: powershell.exe -
args:
stdin: Write-Host test
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
cmd
string
|
always |
|
delta
string
|
always |
The command execution delta time
Sample:
0:00:00.325771
|
end
string
|
always |
The command execution end time
Sample:
2016-02-25 09:18:26.755339
|
msg
boolean
|
always |
changed
Sample:
True
|
rc
int
|
always |
The command return code (0 means success)
|
start
string
|
always |
The command execution start time
Sample:
2016-02-25 09:18:26.429568
|
stderr
string
|
always |
The command standard error
Sample:
ls: cannot access foo: No such file or directory
|
stdout
string
|
always |
|
stdout_lines
list
|
always |
The command standard output split in lines
Sample:
["u'Clustering node [email protected] with [email protected] ...'"]
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.