Spec-Zone.ru › Ansible 2.9

win_shell – Выполнение команд оболочки на целевых хостах

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

Описание

  • Модуль win_shell принимает имя команды, за которым следует список аргументов, разделенных пробелами. Он похож на модуль win_command, но выполняет команду через оболочку (по умолчанию PowerShell) на целевом хосте.
  • Для целевых хостов, отличных от Windows, используйте модуль shell.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
chdir
путь
Устанавливает указанный путь в качестве текущей рабочей директории перед выполнением команды
creates
путь
Путь или шаблон фильтрации путей; если на целевом хосте существует путь, соответствующий указанному, задача будет пропущена.
executable
путь
Изменить оболочку, используемую для выполнения команды (например, cmd).
Целевая оболочка должна принимать параметр /c, за которым следует исходная командная строка для выполнения.
free_form
строка / обязательный
Модуль win_shell принимает команду для выполнения в свободном формате.
Нет параметра с именем "free form". См. примеры!
no_profile
логическое
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Не загружать пользовательский профиль перед выполнением команды. Это применимо только при использовании PowerShell в качестве исполняемого файла.
removes
путь
Путь или шаблон фильтрации путей; если на целевом хосте нет пути, соответствующего указанному, задача будет пропущена.
stdin
строка
добавлен в 2.5
Установить stdin команды непосредственно в указанное значение.

Примечания

Примечание

  • Если вы хотите безопасно и предсказуемо запустить исполняемый файл, лучше использовать модуль win_command. Лучшие практики при написании playbooks будут основываться на использовании модуля win_command, если win_shell явно не требуется. При выполнении произвольных команд используйте здравый смысл.
  • WinRM не вернет результат выполнения команды, пока не завершатся все дочерние процессы. Поэтому невозможно использовать win_shell для запуска длительно выполняющихся дочерних или фоновых процессов. Рассмотрите возможность создания службы Windows для управления фоновыми процессами.

См. также

См. также

psexec – Выполнение команд на удалённом хосте Windows, основанное на модели PsExec
Официальная документация по модулю psexec.
raw – Выполнение низкоуровневой и грязной команды
Официальная документация по модулю raw.
script – Запуск локального скрипта на удалённом узле после его передачи
Официальная документация по модулю script.
shell – Выполнение команд оболочки на целевых узлах
Официальная документация по модулю shell.
win_command – Выполнение команды на удалённом узле Windows
Официальная документация по модулю win_command.
win_psexec – Выполнение команд (удаленно) как другого (привилегированного) пользователя
Официальная документация по модулю win_psexec.

Примеры

# Execute a command in the remote shell; stdout goes to the specified
# file on the remote.
- win_shell: C:\somescript.ps1 >> C:\somelog.txt

# Change the working directory to somedir/ before executing the command.
- win_shell: C:\somescript.ps1 >> C:\somelog.txt chdir=C:\somedir

# You can also use the 'args' form to provide the options. This command
# will change the working directory to somedir/ and will only run when
# somedir/somelog.txt doesn't exist.
- win_shell: C:\somescript.ps1 >> C:\somelog.txt
  args:
    chdir: C:\somedir
    creates: C:\somelog.txt

# Run a command under a non-Powershell interpreter (cmd in this case)
- win_shell: echo %HOMEDIR%
  args:
    executable: cmd
  register: homedir_out

- name: Run multi-lined shell commands
  win_shell: |
    $value = Test-Path -Path C:\temp
    if ($value) {
        Remove-Item -Path C:\temp -Force
    }
    New-Item -Path C:\temp -ItemType Directory

- name: Retrieve the input based on stdin
  win_shell: '$string = [Console]::In.ReadToEnd(); Write-Output $string.Trim()'
  args:
    stdin: Input message

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

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

Ключ Возвращаемое значение Описание
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 ...'"]


Статус

  • Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
  • Этот модуль поддерживается командой разработчиков Ansible. [ядро]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

  • 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.9/modules/win_shell_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API