ansible.builtin.psrp – Выполнение задач через протокол удалённого управления Microsoft PowerShell
Примечание
Этот модуль входит в состав ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля psrp, даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для удобной ссылки на документацию по модулю и для предотвращения конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.
Новая версия в версии 2.7: of ansible.builtin
Обзор
- Выполнение команд или передача/получение данных на целевом узле через PSRP (плагин WinRM)
- Это аналогично плагину подключения winrm, который использует тот же базовый транспорт, но вместо этого выполняется в интерпретаторе PowerShell.
Требования
Ниже перечислены требования к локальному контроллеру, на котором выполняется это соединение.
- pypsrp (библиотека Python)
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| auth строка |
| var: ansible_psrp_auth | Протокол аутентификации для аутентификации удалённого пользователя. По умолчанию, negotiate, будет пытаться использовать Kerberos, если он доступен, и переключится на NTLM, если нет. |
| ca_cert путь | var: ansible_psrp_cert_trust_path var: ansible_psrp_ca_cert | Путь к цепочке сертификатов PEM для проверки сертификата сервера. Это значение игнорируется, если cert_validation установлено в ignore.псевдонимы: cert_trust_path | |
| cert_validation строка |
| var: ansible_psrp_cert_validation | Требовать или нет проверку сертификата удалённого сервера. Установите в ignore, чтобы не проверять сертификаты.
ca_cert может быть установлен в путь к цепочке сертификатов PEM, которая будет использоваться при проверке. |
| certificate_key_pem путь | var: ansible_psrp_certificate_key_pem | Локальный путь к ключу сертификата X509 для использования с аутентификацией по сертификату. | |
| certificate_pem путь | var: ansible_psrp_certificate_pem | Локальный путь к сертификату X509 для использования с аутентификацией по сертификату. | |
| configuration_name строка | Значение по умолчанию: "Microsoft.PowerShell" | var: ansible_psrp_configuration_name | Имя конечной точки конфигурации PowerShell для подключения. |
| connection_timeout целое число | Значение по умолчанию: 30 | var: ansible_psrp_connection_timeout | Тайм-аут соединения для отправки запроса на удалённый хост. Измеряется в секундах. |
| credssp_auth_mechanism строка |
| var: ansible_psrp_credssp_auth_mechanism | Подпротокол аутентификации для использования с аутентификацией CredSSP. Когда auto, и Kerberos, и NTLM будут использованы с приоритетом Kerberos. |
| credssp_disable_tlsv1_2 булево |
| var: ansible_psrp_credssp_disable_tlsv1_2 | Отключает использование TLSv1.2 в канале аутентификации CredSSP. Это не следует устанавливать в yes, если хост не поддерживает TLSv1.2. |
| credssp_minimum_version целое число | Значение по умолчанию: 2 | var: ansible_psrp_credssp_minimum_version | Минимальная версия аутентификации сервера CredSSP, которая будет принята. Установите в 5, чтобы убедиться, что сервер обновлён и не уязвим для CVE 2018-0886. |
| ignore_proxy булево |
| var: ansible_psrp_ignore_proxy | Отключит любые настройки прокси окружения и подключится напрямую к удалённому хосту. Этот параметр игнорируется, если proxy установлен. |
| max_envelope_size целое число | Значение по умолчанию: 153600 | var: ansible_psrp_max_envelope_size | Устанавливает максимальный размер каждого сообщения WSMan, отправляемого на удалённый хост. Измеряется в байтах. По умолчанию 150KiB, для совместимости со старыми хостами. |
| message_encryption строка |
| var: ansible_psrp_message_encryption | Управляет настройками шифрования сообщений, это отличается от шифрования TLS, когда ansible_psrp_protocol https. Только протоколы аутентификации negotiate, kerberos, ntlm, и credssp могут осуществлять шифрование сообщений. Другие протоколы аутентификации поддерживают шифрование только тогда, когда protocol установлено в https. auto означает, что шифрование сообщений используется только при отсутствии TLS/HTTPS.always эквивалентно auto, но шифрование сообщений всегда используется, даже при работе через TLS/HTTPS.never отключает все проверки шифрования, действующие при работе через HTTP, а также отключает все процессы шифрования аутентификации. |
| negotiate_delegate булево |
| var: ansible_psrp_negotiate_delegate | Разрешить удалённому пользователю делегировать свои учётные данные другому серверу, т.е. делегирование учётных данных. Действительно только при использовании Kerberos в качестве выбранного протокола аутентификации или при явном указании Kerberos. Игнорируется, если используется NTLM. |
| negotiate_hostname_override строка | var: ansible_psrp_negotiate_hostname_override | Заменить имя удалённого хоста при поиске хоста в Kerberos-поиске. Это позволяет Ansible подключаться по IP, но аутентифицироваться на удалённом сервере по его имени DNS. Действительно только при использовании Kerberos в качестве выбранного протокола аутентификации или при явном указании Kerberos. Игнорируется, если используется NTLM. | |
| negotiate_send_cbt булево |
| var: ansible_psrp_negotiate_send_cbt | Отправить структуру Channel Binding Token (CBT) при аутентификации. CBT используется для дополнительной защиты от атак «человек посередине» MitM путём связывания внешнего канала передачи данных с каналом аутентификации.CBT не используется, если используется только HTTP, только HTTPS. |
| negotiate_service строка | Значение по умолчанию: "WSMAN" | var: ansible_psrp_negotiate_service | Заменить часть сервиса SPN, используемую при аутентификации Kerberos. Действительно только при использовании Kerberos в качестве выбранного протокола аутентификации или при явном указании Kerberos. Игнорируется, если используется NTLM. |
| operation_timeout целое число | Значение по умолчанию: 20 | var: ansible_psrp_operation_timeout | Устанавливает тайм-аут WSMan для каждой операции. Измеряется в секундах. Не должно превышать значение для connection_timeout. |
| path строка | Значение по умолчанию: "wsman" | var: ansible_psrp_path | Путь URI для подключения. |
| port целое число | var: ansible_port var: ansible_psrp_port | Порт для подключения PSRP к удалённой цели. По умолчанию 5986, если protocol не определён или равен https, в противном случае порт равен 5985. | |
| protocol строка |
| var: ansible_psrp_protocol | Устанавливает используемый протокол для подключения. По умолчанию https если port не определён или port не 5985. |
| proxy строка | var: ansible_psrp_proxy | Устанавливает URL прокси-сервера для подключения к удалённому хосту. | |
| read_timeout целое число добавлен в 2.8 ansible.builtin | Значение по умолчанию: 30 | var: ansible_psrp_read_timeout | Тайм-аут чтения для получения данных с удалённого хоста. Это значение должно быть всегда больше, чем operation_timeout. Этот параметр требует pypsrp >= 0.3. Измеряется в секундах. |
| reconnection_backoff целое число добавлен в 2.8 ansible.builtin | Значение по умолчанию: 2 | var: ansible_psrp_connection_backoff var: ansible_psrp_reconnection_backoff | Время задержки, используемое между попытками повторного подключения. (Сначала ждёт X, затем ждёт 2*X, затем ждёт 4*X и т.д.) Измеряется в секундах. Переменная ansible_psrp_reconnection_backoff была добавлена в Ansible 2.9. |
| reconnection_retries целое число добавлен в 2.8 ansible.builtin | Значение по умолчанию: 0 | var: ansible_psrp_reconnection_retries | Количество попыток повторного подключения при ошибках соединения. |
| remote_addr строка | Значение по умолчанию: "inventory_hostname" | var: ansible_host var: ansible_psrp_host | Имя хоста или IP-адрес удалённого хоста. |
| remote_password строка | var: ansible_password var: ansible_winrm_pass var: ansible_winrm_password | Пароль для аутентификации на remote_user. Может быть передан в качестве параметра командной строки.псевдонимы: пароль |
| remote_user строка | var: ansible_user var: ansible_psrp_user | Пользователь, от имени которого следует войти. |
Авторы
- Команда разработчиков Ansible
© 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/builtin/psrp_connection.html
