win_command - Выполнение команды на удаленном узле Windows
Новая в версии 2.2.
Описание
- Модуль
win_commandпринимает имя команды, за которым следует список аргументов, разделенных пробелами. - Заданная команда будет выполнена на всех выбранных узлах. Она не будет обрабатываться через оболочку, поэтому переменные, такие как
$env:HOME, и операции, такие как"<",">","|", и";", не будут работать (используйте модуль win_shell, если вам нужны эти возможности). - Для целевых узлов, не являющихся Windows, используйте модуль command вместо него.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| chdir | установить указанный путь в качестве текущей рабочей директории перед выполнением команды. | |
| creates | путь или шаблон фильтрации пути; если указанный путь существует на целевом узле, задача будет пропущена. | |
| free_form обязательно | модуль win_command принимает команду в свободном формате для выполнения. Нет параметра с именем 'free form'. См. примеры! | |
| removes | путь или шаблон фильтрации пути; если указанный путь не существует на целевом узле, задача будет пропущена. | |
| stdin (добавлено в 2.5) | Установить stdin команды непосредственно в указанное значение. |
Примечания
Примечание
- Если вы хотите выполнить команду через оболочку (скажем, вы используете
<,>,|, и т.д.), вам на самом деле нужен модуль win_shell. Модульwin_commandгораздо безопаснее, так как он не зависит от среды пользователя. -
creates,removes, иchdirмогут быть указаны после команды. Например, если вы хотите выполнить команду только в том случае, если определенный файл не существует, используйте это. - Для целевых узлов, не являющихся Windows, используйте модуль command вместо него.
Примеры
- 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
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cmd строка | всегда | Команда, выполненная задачей Пример: rabbitmqctl join_cluster rabbit@master |
| delta строка | всегда | Время выполнения команды Пример: 0:00:00.325771 |
| end строка | всегда | Время окончания выполнения команды Пример: 2016-02-25 09:18:26.755339 |
| msg логическое значение | всегда | изменилось Пример: True |
| rc целое число | всегда | Код возврата команды (0 означает успех) |
| start строка | всегда | Время начала выполнения команды Пример: 2016-02-25 09:18:26.429568 |
| stderr строка | всегда | Стандартная ошибка команды Пример: ls: cannot access foo: No such file or directory |
| stdout строка | всегда | Стандартный вывод команды Пример: Clustering node rabbit@slave1 with rabbit@master ... |
| stdout_lines список | всегда | Стандартный вывод команды, разделенный по строкам Пример: ["u'Clustering node rabbit@slave1 with rabbit@master ...'"] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим с предыдущими версиями.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, пожалуйста, обратитесь к этой статье базы знаний
Автор
- Matt Davis
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/win_command_module.html