ansible.builtin.paramiko_ssh – Выполнение задач через python ssh (paramiko)
Примечание
Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля paramiko_ssh, даже не указывая ключевое слово collections:. Несмотря на это, мы рекомендуем использовать полное имя FQCN для удобной ссылки на документацию по модулю и для предотвращения конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.
Добавлен в версии 0.1: модуля 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 ansible.builtin переменная окружения:ANSIBLE_HOST_KEY_CHECKING переменная окружения:ANSIBLE_SSH_HOST_KEY_CHECKING добавлен в версии 2.5 ansible.builtin переменная окружения:ANSIBLE_PARAMIKO_HOST_KEY_CHECKING добавлен в версии 2.5 ansible.builtin переменная: ansible_host_key_checking добавлен в версии 2.5 ansible.builtin переменная: ansible_ssh_host_key_checking добавлен в версии 2.5 ansible.builtin переменная: ansible_paramiko_host_key_checking добавлен в версии 2.5 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 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 ansible.builtin переменная окружения:ANSIBLE_REMOTE_USER переменная окружения:ANSIBLE_PARAMIKO_REMOTE_USER добавлен в версии 2.5 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/paramiko_ssh_connection.html
