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