netconf - Предоставляет постоянное подключение с использованием протокола netconf
Новое в версии 2.3.
Обзор
- Этот плагин подключения обеспечивает подключение к удаленным устройствам через подсистему SSH NETCONF. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения вызовов RPC через NETCONF.
- Обратите внимание, что для работы этого плагина подключения требуется установленный ncclient на локальном контроллере Ansible.
Требования
Ниже перечислены требования, необходимые на локальном узле-мастере, выполняющем это подключение.
- ncclient
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| host | По умолчанию: inventory_hostname | var: ansible_host | Указывает FQDN или IP-адрес удаленного устройства для установления SSH-соединения. |
| host_key_auto_add | По умолчанию: нет | записи ini: [ ] [ ] переменная окружения: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 | По умолчанию: 10 | записи ini: [ ] [ ] переменная окружения:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT | Настраивает время ожидания (в секундах), которое Ansible даст команде для возврата ответа с удаленного устройства. Если таймер истечет, прежде чем команда вернет ответ, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout | По умолчанию: 30 | записи ini: [ ] [ ] переменная окружения:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT | Настраивает время ожидания (в секундах) при первоначальной попытке установить постоянное соединение. Если это значение истечет, прежде чем соединение с удаленным устройством будет установлено, соединение завершится неудачно. |
| port | По умолчанию: 830 | записи ini: [defaults ] переменная окружения:ANSIBLE_REMOTE_PORT var: ansible_port | Указывает порт на удаленном устройстве, прослушивающий подключения при установлении SSH-соединения. |
| private_key_file | записи ini: [ ] [ ] переменная окружения: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 | По умолчанию: 120 | Устанавливает время подключения для связи с удаленным устройством. Этот таймаут используется в качестве значения таймаута по умолчанию при ожидании ответа после вызова RPC. Если RPC не возвращает ответ в течение времени таймаута, генерируется ошибка. |
Статус
Автор
- Команда 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.5/plugins/connection/netconf.html