ansible.builtin.winrm – Выполнение задач на базе WinRM Майкрософт
Примечание
Этот модуль входит в состав ansible-base и включён во все установки Ansible. В большинстве случаев можно использовать короткое имя модуля winrm, даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для лёгкой ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.
Новое в версии 2.0: от ansible.builtin
Обзор
- Выполнение команд или операции put/fetch на целевом узле через WinRM
- Этот плагин позволяет передавать дополнительные аргументы, поддерживаемые протоколом, но не явно определённые здесь. Они должны иметь вид переменных, объявленных по следующему шаблону
ansible_winrm_<option>.
Требования
Ниже перечислены требования к локальному контроллеру, на котором выполняется это подключение.
- pywinrm (библиотека Python)
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| connection_timeout целое число | var: ansible_winrm_connection_timeout | Устанавливает параметры таймаута операции и чтения для подключения WinRM. Соответствует аргументам operation_timeout_sec и read_timeout_sec в pywinrm, поэтому избегайте настройки этих переменных вместе с этой.Значение по умолчанию соответствует значению, установленному в установленной версии pywinrm. | |
| kerberos_command строка | Значение по умолчанию: "kinit" | var: ansible_winrm_kinit_cmd | Команда kerberos для запроса билета аутентификации |
| kerberos_mode строка |
| var: ansible_winrm_kinit_mode | Режим использования kerberos. Вариант managed означает, что Ansible получит билет kerberos. В то время как manual означает, что билет уже получен пользователем. Если возникают проблемы с зависанием Ansible при попытке получения билета Kerberos, вы можете установить его на manual и получить его вне Ansible или установить pexpect через pip и повторить попытку. |
| kinit_args строка добавлен в версии 2.11 ansible.builtin | var: ansible_winrm_kinit_args | Дополнительные аргументы для передачи команде kinit, когда запрашивается билет аутентификации Kerberos.По умолчанию дополнительные аргументы не передаются в kinit, если не установлен ansible_winrm_kerberos_delegation. В этом случае -f добавляется к аргументам kinit, чтобы получить перенаправляемый билет.Если задано, аргументы перезапишут любые существующие значения по умолчанию для kinit, включая -f для делегированного билета. | |
| path строка | Значение по умолчанию: "/wsman" | var: ansible_winrm_path | Путь URI для подключения |
| pipelining булево |
"ANSIBLE_PIPELINING" | записи ini: [defaults] env:ANSIBLE_PIPELINING var: ansible_pipelining | Pipelining уменьшает количество операций подключения, необходимых для выполнения модуля на удалённом сервере, выполняя много модулей Ansible без фактической передачи файлов. Это может привести к значительному улучшению производительности при включении. Однако это может привести к конфликту с повышением привилегий (become). Например, при использовании операций sudo необходимо сначала отключить 'requiretty' в файле sudoers для целевых хостов, поэтому эта функция отключена по умолчанию. |
| port целое число | Значение по умолчанию: 5986 | var: ansible_port var: ansible_winrm_port | порт для winrm для подключения к удалённому целевому серверу По умолчанию используется порт https (5986), если используется http, он должен быть 5985 |
| remote_addr строка | Значение по умолчанию: "inventory_hostname" | var: ansible_host var: ansible_winrm_host | Адрес машины Windows |
| remote_password строка | var: ansible_password var: ansible_winrm_pass var: ansible_winrm_password | Пароль аутентификации для remote_user. Может быть передан в качестве опции командной строки.псевдонимы: пароль | |
| remote_user строка | var: ansible_user var: ansible_winrm_user | Пользователь для входа на машину Windows | |
| scheme строка |
| var: ansible_winrm_scheme | Схема URI для использования Если не указано, по умолчанию используется https или http, если port равен 5985. |
| transport список / элементы=строка | var: ansible_winrm_transport | Список winrm транспортов для попытки использования (ssl, plaintext, kerberos и т.д) Если None (по умолчанию), плагин попытается автоматически определить правильный список Доступные варианты зависят от версии pywinrm |
Авторы
- Команда разработчиков Ansible
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/winrm_connection.html
