ansible.windows.win_command – Выполняет команду на удалённом узле Windows

Примечание

Этот плагин является частью коллекции ansible.windows (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install ansible.windows.

Для использования в плейбуке укажите: ansible.windows.win_command.

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Модуль win_command принимает имя команды, за которым следует список аргументов, разделённых пробелами.
Указанная команда будет выполнена на всех выбранных узлах. Она не будет обработана оболочкой, поэтому переменные, такие как $env:HOME, и операции, такие как "<", ">", "|", и ";", работать не будут (используйте модуль ansible.windows.win_shell, если вам нужны эти возможности).
Для узлов, не являющихся Windows, используйте модуль ansible.builtin.command вместо этого.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
chdir путь		Устанавливает указанный путь в качестве текущей рабочей директории перед выполнением команды.
creates путь		Путь или шаблон фильтрации пути; если на целевом хосте существует указанный путь, задача будет пропущена.
free_form строка / обязательно		Модуль `win_command` принимает произвольную команду для выполнения. На самом деле параметра с именем 'free form' нет. Смотрите примеры!
output_encoding_override строка		Этот параметр переопределяет кодировку вывода stdout/stderr. Вы можете использовать этот параметр, когда вам нужно выполнить команду, которая игнорирует кодовую страницу консоли. Вам следует использовать этот параметр только в очень редких случаях. Это значение может быть любой допустимой кодировкой `Name`, основанной на выводе `[System.Text.Encoding]::GetEncodings(`). См. https://docs.microsoft.com/dotnet/api/system.text.encoding.getencodings.
removes путь		Путь или шаблон фильтрации пути; если на целевом хосте отсутствует указанный путь, задача будет пропущена.
stdin строка		Устанавливает stdin команды непосредственно в указанное значение.

Примечания

Примечание

Если вы хотите выполнить команду через оболочку (например, вы используете <, >, |, и т.д.), вам нужен модуль ansible.windows.win_shell вместо этого. Модуль ansible.windows.win_command гораздо безопаснее, так как не зависит от среды пользователя.
creates, removes, и chdir могут быть указаны после команды. Например, если вы хотите выполнить команду только в том случае, если определённый файл отсутствует, используйте этот метод.

См. также

ansible.builtin.command: Официальная документация модуля ansible.builtin.command.
community.windows.psexec: Официальная документация модуля community.windows.psexec.
ansible.builtin.raw: Официальная документация модуля ansible.builtin.raw.
community.windows.win_psexec: Официальная документация модуля community.windows.win_psexec.
ansible.windows.win_shell: Официальная документация модуля ansible.windows.win_shell.

Примеры

- name: Save the result of 'whoami' in 'whoami_out'
  ansible.windows.win_command: whoami
  register: whoami_out

- name: Run command that only runs if folder exists and runs from a specific folder
  ansible.windows.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
  ansible.windows.win_command: powershell.exe -
  args:
    stdin: Write-Host test

Возвращаемые значения

Общие возвращаемые значения описаны в этой статье, следующие поля уникальны для данного модуля:

Ключ	Возвращённое значение	Описание
cmd строка	всегда	Команда, выполненная задачей Пример: rabbitmqctl join_cluster rabbit@main
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@main ...
stdout_lines список / элементы=строка	всегда	Стандартный вывод команды, разделённый на строки Пример: ["u'Clustering node rabbit@slave1 with rabbit@main ...'"]

Авторы

Matt Davis (@nitzmahone)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_command_module.html