netconf - Предоставляет постоянное подключение с использованием протокола netconf
Новое в версии 2.3.
Описание
- Этот плагин подключения обеспечивает подключение к удаленным устройствам через подсистему SSH NETCONF. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения вызовов RPC через NETCONF.
- Обратите внимание, что для работы этого плагина подключения на локальном контроллере Ansible необходимо установить ncclient.
Требования
Ниже перечислены требования, необходимые на локальном узле-мастере, выполняющем это подключение.
- ncclient
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| host | Значение по умолчанию: "inventory_hostname" | var: ansible_host | Указывает FQDN или IP-адрес удаленного устройства для установления SSH-соединения. |
| host_key_auto_add bool |
| Элементы ini: [paramiko_connection ] переменная среды:ANSIBLE_HOST_KEY_AUTO_ADD | По умолчанию Ansible запросит пользователя перед добавлением SSH-ключей в файл известных хостов. Включив этот параметр, неизвестные ключи хостов будут автоматически добавляться в файл известных хостов. Необходимо полностью понимать последствия включения этого параметра в производственных системах, так как это может создать уязвимость безопасности. |
| network_os | var: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки специфичного для устройства плагина netconf. Если этот параметр не настроен, используется плагин netconf по умолчанию. | |
| password | var: ansible_password var: ansible_ssh_pass | Настраивает пароль пользователя, используемый для аутентификации на удаленном устройстве при первом установлении SSH-соединения. | |
| persistent_command_timeout int | Значение по умолчанию: 10 | Элементы ini: [persistent_connection ] переменная среды:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT | Настраивает (в секундах) время ожидания возврата команды с удаленного устройства. Если этот таймер истечет до возврата команды, плагин подключения сгенерирует исключение и закроет соединение |
| persistent_connect_timeout int | Значение по умолчанию: 30 | Элементы ini: [persistent_connection ] переменная среды:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT | Настраивает (в секундах) время ожидания при попытке первоначального установления постоянного соединения. Если это значение истечет до завершения подключения к удаленному устройству, подключение завершится неудачей |
| port int | Значение по умолчанию: 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 опций | |
| timeout int | Значение по умолчанию: 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.6/plugins/connection/netconf.html
