ansible.builtin.paramiko_ssh – Выполнение задач через python ssh (paramiko)
Примечание
Этот модуль входит в состав ansible-base и включен во все установки Ansible. В большинстве случаев можно использовать сокращённое имя модуля paramiko_ssh, даже без указания ключевого слова collections:. Несмотря на это, рекомендуется использовать полное имя FQCN для удобной ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.
Добавлен в версии 0.1: of ansible.builtin
Описание
- Использование реализации python ssh (Paramiko) для подключения к целевым узлам
- Транспорт paramiko предоставляется, потому что многие дистрибутивы, в частности EL6 и более ранние, не поддерживают ControlPersist в своих реализациях SSH.
- Это необходимо на управляющей машине Ansible для эффективного управления подключениями. Таким образом, paramiko быстрее для большинства пользователей на этих платформах. Пользователи с возможностью ControlPersist могут рассмотреть использование -c ssh или настройку транспорта в файле конфигурации.
- Этот плагин также заимствует множество настроек из плагина ssh, так как оба они охватывают один и тот же протокол.
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| host_key_auto_add булево |
| записи ini: [paramiko_connection] переменная среды:ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD | TODO: написать |
| host_key_checking булево |
| записи ini: [defaults] [paramiko_connection] добавлен в 2.5 of ansible.builtin переменная среды:ANSIBLE_HOST_KEY_CHECKING переменная среды:ANSIBLE_SSH_HOST_KEY_CHECKING добавлен в 2.5 of ansible.builtin переменная среды:ANSIBLE_PARAMIKO_HOST_KEY_CHECKING добавлен в 2.5 of ansible.builtin переменная: ansible_host_key_checking добавлен в 2.5 of ansible.builtin переменная: ansible_ssh_host_key_checking добавлен в 2.5 of ansible.builtin переменная: ansible_paramiko_host_key_checking добавлен в 2.5 of ansible.builtin | Установите это в "False", если вы хотите избежать проверки ключей хоста используемыми Ansible средствами для подключения к хосту |
| look_for_keys булево |
| записи ini: [paramiko_connection] переменная среды:ANSIBLE_PARAMIKO_LOOK_FOR_KEYS | TODO: написать |
| password строка | переменная: ansible_password переменная: ansible_ssh_pass переменная: ansible_ssh_password переменная: ansible_paramiko_pass переменная: ansible_paramiko_password добавлен в 2.5 of ansible.builtin | Секрет, используемый для входа на SSH-сервер или в качестве парольной фразы для SSH-ключей, которые ее требуют Можно установить из командной строки с помощью параметра --ask-pass. | |
| proxy_command строка | По умолчанию: "" | записи ini: [paramiko_connection] переменная среды:ANSIBLE_PARAMIKO_PROXY_COMMAND | Информация о прокси для выполнения подключения через хост перехода Также этот плагин просканирует 'ssh_args', 'ssh_extra_args' и 'ssh_common_args' из настроек плагина 'ssh' для получения информации о прокси, если она задана. |
| pty булево |
| записи ini: [paramiko_connection] переменная среды:ANSIBLE_PARAMIKO_PTY | TODO: написать |
| record_host_keys булево |
| записи ini: [paramiko_connection] переменная среды:ANSIBLE_PARAMIKO_RECORD_HOST_KEYS | TODO: написать |
| remote_addr строка | По умолчанию: "inventory_hostname" | переменная: ansible_host переменная: ansible_ssh_host переменная: ansible_paramiko_host | Адрес удалённой цели |
| remote_user строка | записи ini: [defaults] [paramiko_connection] добавлен в 2.5 of ansible.builtin переменная среды:ANSIBLE_REMOTE_USER переменная среды:ANSIBLE_PARAMIKO_REMOTE_USER добавлен в 2.5 of ansible.builtin переменная: ansible_user переменная: ansible_ssh_user переменная: ansible_paramiko_user | Пользователь для входа/аутентификации Можно установить из командной строки с помощью опций --user или -u. | |
| use_persistent_connections булево |
| записи ini: [defaults] переменная среды:ANSIBLE_USE_PERSISTENT_CONNECTIONS | Включает/выключает использование постоянных подключений |
Авторы
- Команда разработчиков 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/paramiko_ssh_connection.html