netconf – Предоставляет постоянное соединение с использованием протокола netconf
Новое в версии 2.3.
Обзор
- Этот плагин подключения обеспечивает подключение к удалённым устройствам через подсистему SSH NETCONF. Данный плагин подключения обычно используется сетевыми устройствами для отправки и получения вызовов RPC через NETCONF.
- Обратите внимание, что для работы с этим плагином подключения требуется пакет ncclient на локальном контроллере Ansible.
Требования
Ниже перечислены требования, необходимые на локальном узле-мастере, выполняющем это подключение.
- ncclient
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| host - | Значение по умолчанию: "inventory_hostname" | переменная: ansible_host | Указывает FQDN или IP-адрес удалённого устройства для установления SSH-соединения. |
| host_key_auto_add boolean |
| записи 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-ключей в обычных местах (например, :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 | Настраивает пароль пользователя, используемый для аутентификации на удалённом устройстве при первом установлении SSH-соединения. | |
| persistent_command_timeout integer | Значение по умолчанию: 10 | записи 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 | Настраивает (в секундах) время ожидания при попытке первоначального установления постоянного соединения. Если это значение истечёт до завершения подключения к удалённому устройству, подключение завершится с ошибкой |
| 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 секунд, генерируется ошибка. |
Статус
Авторы
- Команда 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.7/plugins/connection/netconf.html
