ansible.builtin.psrp – Выполнение задач через протокол удалённого вызова PowerShell Microsoft
Примечание
Этот модуль входит в ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля psrp, даже не указывая ключевое слово collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для лёгкой ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.
Новое в версии 2.7: модуля ansible.builtin
Описание
- Выполнение команд или передача/получение данных на целевой узел через PSRP (плагин WinRM)
- Это аналогично плагину подключения winrm, который использует тот же базовый транспорт, но вместо этого выполняется в интерпретаторе PowerShell.
Требования
Ниже перечислены требования к локальному узлу-контролёру, на котором выполняется данное соединение.
- pypsrp>=0.4.0 (библиотека 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 был выбранным способом аутентификации или был явно указан. Игнорируется при использовании NTLM. |
| negotiate_hostname_override строка | var: ansible_psrp_negotiate_hostname_override | Переопределить удалённое имя хоста при поиске хоста в Kerberos-поиске. Это позволяет Ansible подключаться по IP, но аутентифицироваться на удалённом сервере по имени DNS. Действительно только когда Kerberos был выбранным способом аутентификации или был явно указан. Игнорируется при использовании NTLM. | |
| negotiate_send_cbt логическое значение |
| var: ansible_psrp_negotiate_send_cbt | Отправить структуру маркера связи канала (CBT) при аутентификации. CBT используется для дополнительной защиты от атак «человек посередине» MitM путём привязки внешнего канала передачи к каналу аутентификации.CBT не используется при использовании только HTTP, только HTTPS. |
| negotiate_service строка | По умолчанию: "WSMAN" | var: ansible_psrp_negotiate_service | Переопределить часть службы SPN, используемую во время аутентификации Kerberos. Действительно только когда Kerberos был выбранным способом аутентификации или был явно указан. Игнорируется при использовании NTLM. |
| operation_timeout целое число | По умолчанию: 20 | var: ansible_psrp_operation_timeout | Устанавливает таймаут WSMan для каждой операции. Измеряется в секундах. Не должно превышать значение для connection_timeout. |
| path строка | По умолчанию: "wsman" | var: ansible_psrp_path | Путь URI для подключения. |
| pipelining логическое значение |
"ANSIBLE_PIPELINING" | записи ini: [defaults] переменная среды:ANSIBLE_PIPELINING var: ansible_pipelining | Pipelining уменьшает количество операций подключения, необходимых для выполнения модуля на удалённом сервере, путём выполнения многих Ansible-модулей без фактического переноса файлов. Это может привести к значительному улучшению производительности при включении. Однако это может конфликтовать с повышением привилегий (become). Например, при использовании операций sudo необходимо сначала отключить «requiretty» в файле sudoers для целевых хостов, поэтому эта функция по умолчанию отключена. |
| 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 | переменная: ansible_psrp_reconnection_retries | Количество попыток при ошибках соединения. |
| remote_addr строка | Значение по умолчанию: "inventory_hostname" | переменная: ansible_host переменная: ansible_psrp_host | Имя хоста или IP-адрес удалённого хоста. |
| remote_password строка | переменная: ansible_password переменная: ansible_winrm_pass переменная: ansible_winrm_password | Пароль для аутентификации на remote_user. Может быть передан в качестве параметра командной строки.псевдонимы: password | |
| remote_user строка | переменная: ansible_user переменная: ansible_psrp_user | Пользователь для входа. |
Авторы
- Команда разработчиков 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/psrp_connection.html
