ansible.netcommon.netconf – Предоставляет постоянное подключение с использованием протокола netconf
Примечание
Этот плагин входит в коллекцию ansible.netcommon (версия 1.4.1).
Для его установки используйте: ansible-galaxy collection install ansible.netcommon.
Для использования в книге задач укажите: ansible.netcommon.netconf.
Новое в версии 1.0.0: из ansible.netcommon
Обзор
- Этот плагин подключения предоставляет подключение к удалённым устройствам через подсистему SSH NETCONF. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения вызовов RPC через NETCONF.
- Обратите внимание, что для работы этого плагина подключения на локальном контроллере Ansible необходимо установить ncclient.
Требования
Ниже приведены требования к локальному узлу контроллера, который выполняет это подключение.
- ncclient
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| host строка | Значение по умолчанию: "inventory_hostname" | var: ansible_host | Указывает FQDN или IP-адрес удалённого устройства для установления SSH-соединения. |
| host_key_checking логическое |
| ini entries: [defaults] [paramiko_connection] env:ANSIBLE_HOST_KEY_CHECKING env:ANSIBLE_SSH_HOST_KEY_CHECKING env:ANSIBLE_NETCONF_HOST_KEY_CHECKING var: ansible_host_key_checking var: ansible_ssh_host_key_checking var: ansible_netconf_host_key_checking | Установите это в "Ложь", если вы хотите избежать проверки ключей хоста, используемых базовыми инструментами Ansible для подключения к хосту. |
| look_for_keys логическое |
| ini entries: [paramiko_connection] env:ANSIBLE_PARAMIKO_LOOK_FOR_KEYS | Включает поиск SSH-ключей в стандартных местах (например, :file:`~/.ssh/id_*`). |
| netconf_ssh_config строка | ini entries: [netconf_connection] env:ANSIBLE_NETCONF_SSH_CONFIG var: ansible_netconf_ssh_config | Эта переменная используется для активации башенного/промежуточного хоста с подключением netconf. Если установлено в Истина, настройки башенного/промежуточного хоста SSH должны быть присутствовать в файле ~/.ssh/config, в противном случае можно указать путь к файлу конфигурации SSH для чтения настроек башенного/промежуточного хоста. | |
| network_os строка | var: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки плагина netconf, специфичного для устройства. Если этот параметр не настроен (или установлен в auto), Ansible попытается угадать правильное значение network_os. Если он не сможет правильно угадать network_os, он будет использовать default. | |
| password строка | var: ansible_password var: ansible_ssh_pass var: ansible_ssh_password var: ansible_netconf_password | Настраивает пароль пользователя, используемый для аутентификации на удалённом устройстве при первом установлении SSH-соединения. | |
| persistent_command_timeout целое число | Значение по умолчанию: 30 | ini entries: [persistent_connection] env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_command_timeout | Настраивает время ожидания (в секундах) возврата команды с удалённого устройства. Если этот таймер истечёт до возврата команды, плагин подключения сгенерирует исключение и закроет подключение. |
| persistent_connect_timeout целое число | Значение по умолчанию: 30 | ini entries: [persistent_connection] env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_connect_timeout | Настраивает время ожидания (в секундах) при попытке первоначального установления постоянного подключения. Если это значение истечёт до завершения подключения к удалённому устройству, подключение завершится с ошибкой. |
| persistent_log_messages логическое |
| ini entries: [persistent_connection] env:ANSIBLE_PERSISTENT_LOG_MESSAGES var: ansible_persistent_log_messages | Этот флаг включит протоколирование команд, выполняемых и ответов, полученных от целевого устройства, в файл журнала Ansible. Для работы этого параметра необходимо установить параметр конфигурации ansible 'log_path' в путь к файлу с правами записи. Убедитесь, что вы полностью понимаете последствия включения этого параметра, так как это может создать уязвимость безопасности, занося в файл журнала конфиденциальную информацию. |
| port целое число | Значение по умолчанию: 830 | ini entries: [defaults] env:ANSIBLE_REMOTE_PORT var: ansible_port | Указывает порт на удалённом устройстве, который слушает подключения при установлении SSH-соединения. |
| private_key_file строка | ini entries: [defaults] env:ANSIBLE_PRIVATE_KEY_FILE var: ansible_private_key_file | Файл закрытого SSH-ключа или сертификата, используемый для аутентификации на удалённом устройстве при первом установлении SSH-соединения. | |
| remote_user строка | ini entries: [defaults] env:ANSIBLE_REMOTE_USER var: ansible_user | Имя пользователя, используемое для аутентификации на удалённом устройстве при первом установлении SSH-соединения. Если remote_user не указан, для подключения используется имя пользователя вошедшего пользователя. Может быть настроено через командную строку с помощью параметров --user или -u. |
Авторы
- Команда Ansible Networking
© 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/netcommon/netconf_connection.html
