ansible.netcommon.netconf – Предоставляет постоянное подключение с использованием протокола netconf
Примечание
Этот плагин входит в состав коллекции ansible.netcommon (версия 1.5.0).
Для его установки используйте: 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: [defaults] [paramiko_connection] переменная среды:ANSIBLE_HOST_KEY_CHECKING переменная среды:ANSIBLE_SSH_HOST_KEY_CHECKING переменная среды:ANSIBLE_NETCONF_HOST_KEY_CHECKING var: ansible_host_key_checking var: ansible_ssh_host_key_checking var: ansible_netconf_host_key_checking | Установите значение "False", если вы хотите избежать проверки ключа хоста подлежащими инструментами Ansible для подключения к хосту. |
| look_for_keys логическое значение |
| записи ini: [paramiko_connection] переменная среды:ANSIBLE_PARAMIKO_LOOK_FOR_KEYS | Включает поиск SSH-ключей в стандартных местах (например, :file:`~/.ssh/id_*`). |
| netconf_ssh_config строка | записи ini: [netconf_connection] переменная среды:ANSIBLE_NETCONF_SSH_CONFIG var: ansible_netconf_ssh_config | Эта переменная используется для включения бастионного/промежуточного хоста с подключением netconf. Если установлено значение True, настройки бастионного/промежуточного хоста 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: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_command_timeout | Настраивает время ожидания (в секундах) возврата команды с удаленного устройства. Если таймер истечет до возврата команды, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout целое число | Значение по умолчанию: 30 | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_connect_timeout | Настраивает время ожидания (в секундах) при первоначальной попытке установления постоянного подключения. Если это значение истечет до завершения подключения к удаленному устройству, подключение завершится неудачно. |
| persistent_log_messages логическое значение |
| записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_LOG_MESSAGES var: ansible_persistent_log_messages | Этот флаг включит протоколирование команд, выполненных и полученных ответов с целевого устройства в файл журнала Ansible. Для работы этого параметра необходимо указать опцию конфигурации Ansible 'log_path' с путем к файлу, имеющему доступ для записи. Необходимо понимать все последствия включения этого параметра, так как это может создать уязвимость безопасности, записывая конфиденциальную информацию в файл журнала. |
| port целое число | Значение по умолчанию: 830 | записи ini: [defaults] переменная среды:ANSIBLE_REMOTE_PORT var: ansible_port | Указывает порт на удаленном устройстве, который слушает подключения при установлении SSH-соединения. |
| private_key_file строка | записи ini: [defaults] переменная среды:ANSIBLE_PRIVATE_KEY_FILE var: ansible_private_key_file | Файл с приватным SSH-ключом или сертификатом, используемый для аутентификации на удаленном устройстве при первоначальном установлении SSH-соединения. | |
| remote_user строка | записи ini: [defaults] переменная среды:ANSIBLE_REMOTE_USER var: ansible_user | Имя пользователя, используемое для аутентификации на удаленном устройстве при первоначальном установлении SSH-соединения. Если remote_user не указан, для подключения будет использовано имя пользователя текущего пользователя. Может быть настроен из командной строки с помощью опций --user или -u. |
Авторы
- Команда Ansible Networking
© 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/netcommon/netconf_connection.html
