netconf – Предоставляет постоянное подключение с использованием протокола netconf
Описание
- Этот плагин подключения обеспечивает подключение к удалённым устройствам через подсистему SSH NETCONF. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения вызовов RPC через NETCONF.
- Обратите внимание, что для работы этого плагина подключения необходимо установить ncclient на локальном контроллере Ansible.
Требования
Ниже перечислены требования, необходимые на локальном узле-мастере, на котором выполняется данное подключение.
- ncclient
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| host - | Значение по умолчанию: "inventory_hostname" | переменная: ansible_host | Указывает FQDN или IP-адрес удалённого устройства для установления 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 должны быть в файле ~/.ssh/config, альтернативно можно указать путь к файлу конфигурации ssh для чтения настроек бастионного/прокси-хоста. | |
| network_os - | переменная: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки плагина netconf, специфичного для устройства. Если этот параметр не настроен (или установлен в auto), Ansible попытается угадать правильное значение network_os. Если не удастся угадать, будет использоваться default. | |
| 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 не возвращает результат в течение timeout секунд, генерируется ошибка. |
Статус
- Интерфейс этого подключения не гарантирует обратную совместимость. [preview]
- Это подключение поддерживается сообществом Ansible. [community]
Авторы
- Команда 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.9/plugins/connection/netconf.html
