psexec – Выполняет команды на удалённом хосте Windows на основе модели PsExec
Новое в версии 2.6.
Описание
- Выполняет удалённую команду с хоста Linux на хост Windows без настройки WinRM.
- Может быть запущен на контроллере Ansible для настройки хостов Windows, чтобы подготовить их к WinRM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- pypsexec
- smbprotocol[kerberos] для необязательной аутентификации Kerberos
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| arguments строка | Любые аргументы в виде одной строки для использования при запуске исполняемого файла. | |
| asynchronous булево |
| Выполнит команду как отдельный процесс, и модуль вернёт значение сразу после запуска, в то время как процесс будет продолжать выполняться в фоновом режиме. Значения возврата stdout и stderr будут равны null, когда это значение установлено в yes.Опция stdin не работает с этим типом процесса. Значение возврата rc не устанавливается, когда это значение yes
|
| connection_password строка | Пароль для connection_user. Требуется, если не установлены требования Kerberos или имя пользователя является локальной учётной записью на хосте Windows. Можно опустить, чтобы использовать билет Kerberos для принципала, установленного connection_user, если установлена библиотека Kerberos и билет уже был получен с помощью kinit команды ранее. | |
| connection_timeout строка | Значение по умолчанию: 60 | Таймаут в секундах ожидания при получении начального ответа SMB negotiate от сервера. |
| connection_username строка | Имя пользователя для подключения к удалённому хосту Windows. Этот пользователь должен быть членом группы Administrators на хосте Windows.Требуется, если не установлены требования Kerberos или имя пользователя является локальной учётной записью на хосте Windows. Можно опустить, чтобы использовать стандартный билет Kerberos-принципала в кэше локальных данных, если установлена библиотека Kerberos. Если process_username не указан, то удалённый процесс будет выполняться под учётной записью Network Logon под этой учётной записью. | |
| encrypt булево |
| Использует шифрование SMB для шифрования сообщений SMB, отправляемых на хост и с хоста. Это требует протокол SMB 3, который поддерживается только с Windows Server 2012 или Windows 8. Более старые версии, такие как Windows 7 или Windows Server 2008 (R2), должны установить это значение в no и использовать отсутствие шифрования.При установке значения no, пакеты находятся в открытом виде и могут быть видны всем, кто перехватывает сеть. Все параметры процесса включены в это. |
| executable строка / обязательно | Исполняемый файл для запуска на хосте Windows. | |
| hostname строка / обязательно | Удаленный хост Windows для подключения, может быть IP-адресом или именем хоста. | |
| integrity_level строка |
| Уровень целостности процесса, когда process_username определён и не равен System.Когда default, используется уровень целостности по умолчанию, основанный на настройках системы.Когда elevated, команда будет запущена с правами администратора.Когда limited, команда будет вынуждена запуститься без прав администратора. |
| interactive булево |
| Выполняет процесс как интерактивный процесс, который отображает окно процесса сессии Windows, указанной параметром interactive_session. Значения возврата stdout и stderr будут null, когда это значение установлено в yes.Опция stdin не работает с этим типом процесса. |
| interactive_session целое число | Значение по умолчанию: 0 | Идентификатор сессии Windows, который используется при отображении интерактивного процесса на удалённом хосте Windows. Это допустимо только при interactive, равном yes.Значение по умолчанию — 0 , это консольная сессия хоста Windows. |
| load_profile булево |
| Запускает удалённую команду с загруженным профилем пользователя. |
| port целое число | Значение по умолчанию: 445 | Порт, на котором удалённая служба SMB прослушивает подключения. |
| priority строка |
| Устанавливает приоритет команды на хосте Windows. См. https://msdn.microsoft.com/en-us/library/windows/desktop/ms683211.aspx для получения дополнительной информации. |
| process_password строка | Пароль для process_username. Требуется, если process_username определён и не System. | |
| process_timeout целое число | Значение по умолчанию: 0 | Таймаут в секундах, накладываемый на запущенный процесс. Значение 0 означает отсутствие таймаута. |
| process_username строка | Пользователь, от имени которого будет выполняться процесс. Это может быть установлено для запуска процесса под интерактивным входом указанной учётной записи, что обходит ограничения, связанные с использованием входа Network Logon, если это не указано. Если опущено, процесс запускается под той же учётной записью, что и connection_username, с помощью входа Network Logon. Установлено в System для запуска от имени встроенной учётной записи SYSTEM. Пароль для этой учётной записи не требуется.Если encrypt равно no, имя пользователя и пароль передаются в виде простого XOR-зашифрованного байтового строкового значения, которое не шифруется. Для получения имени пользователя и пароля не требуются специальные инструменты, только знание протокола. | |
| show_ui_on_logon_screen булево |
| Отображает пользовательский интерфейс процесса на экране Winlogon безопасного рабочего стола, когда process_username равно System. |
| stdin строка | Данные для отправки в канал stdin после запуска процесса. Этот параметр не имеет эффекта, когда interactive или asynchronous равны yes. | |
| working_directory строка | Значение по умолчанию: "C:\\Windows\\System32" | Изменяет рабочую директорию, установленную при запуске процесса. |
Примечания
Примечание
- Для работы данного модуля на хосте Windows требуется настроенный и включённый SMB, а также открытый порт 445 в брандмауэре.
- Этот модуль будет ожидать завершения процесса, если параметр asynchronous не
yes, убедитесь, что процесс запущен как неинтерактивная команда, чтобы избежать бесконечного ожидания ввода. - Пользователь connection_username должен быть членом локальной группы администраторов на хосте Windows. Для хостов, не входящих в домен, значение
LocalAccountTokenFilterPolicyдолжно быть установлено на1, чтобы обеспечить корректную работу. См. https://support.microsoft.com/ru-ru/help/951016/description-of-user-account-control-and-remote-restrictions-in-windows. - Дополнительную информацию о данном модуле и требованиях к хосту можно найти по адресу https://github.com/jborean93/pypsexec.
Примеры
- name: Run a cmd.exe command
psexec:
hostname: server
connection_username: username
connection_password: password
executable: cmd.exe
arguments: /c echo Hello World
- name: Run a PowerShell command
psexec:
hostname: server.domain.local
connection_username: username@DOMAIN.LOCAL
connection_password: password
executable: powershell.exe
arguments: Write-Host Hello World
- name: Send data through stdin
psexec:
hostname: 192.168.1.2
connection_username: username
connection_password: password
executable: powershell.exe
arguments: '-'
stdin: |
Write-Host Hello World
Write-Error Error Message
exit 0
- name: Run the process as a different user
psexec:
hostname: server
connection_user: username
connection_password: password
executable: whoami.exe
arguments: /all
process_username: anotheruser
process_password: anotherpassword
- name: Run the process asynchronously
psexec:
hostname: server
connection_username: username
connection_password: password
executable: cmd.exe
arguments: /c rmdir C:\temp
asynchronous: yes
- name: Use Kerberos authentication for the connection (requires smbprotocol[kerberos])
psexec:
hostname: host.domain.local
connection_username: user@DOMAIN.LOCAL
executable: C:\some\path\to\executable.exe
arguments: /s
- name: Disable encryption to work with WIndows 7/Server 2008 (R2)
psexec:
hostanme: windows-pc
connection_username: Administrator
connection_password: Password01
encrypt: no
integrity_level: elevated
process_username: Administrator
process_password: Password01
executable: powershell.exe
arguments: (New-Object -ComObject Microsoft.Update.Session).CreateUpdateInstaller().IsBusy
- name: Download and run ConfigureRemotingForAnsible.ps1 to setup WinRM
psexec:
hostname: '{{ hostvars[inventory_hostname]["ansible_host"] | default(inventory_hostname) }}'
connection_username: '{{ ansible_user }}'
connection_password: '{{ ansible_password }}'
encrypt: yes
executable: powershell.exe
arguments: '-'
stdin: |
$ErrorActionPreference = "Stop"
$sec_protocols = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::SystemDefault
$sec_protocols = $sec_protocols -bor [Net.SecurityProtocolType]::Tls12
[Net.ServicePointManager]::SecurityProtocol = $sec_protocols
$url = "https://github.com/ansible/ansible/raw/devel/examples/scripts/ConfigureRemotingForAnsible.ps1"
Invoke-Expression ((New-Object Net.WebClient).DownloadString($url))
exit
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| msg строка | модуль завершился неудачно | Любые детали исключения при попытке выполнения процесса Пример: Получено исключение от удаленной службы PAExec: Не удалось запустить "invalid.exe". Система не может найти указанный файл. [Err=0x2, 2] |
| pid целое число | успех и асинхронный режим 'да' | Идентификатор процесса асинхронного процесса, который был создан Пример: 719 |
| rc целое число | успех и асинхронный режим 'нет' | Код возврата удалённого процесса |
| stderr строка | успех и интерактивный или асинхронный режим 'нет' | stderr от удалённого процесса Пример: Ошибка [10] при выполнении процесса |
| stdout строка | успех и интерактивный или асинхронный режим 'нет' | stdout от удалённого процесса Пример: Привет мир |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Jordan Borean (@jborean93)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/psexec_module.html