ansible.netcommon.napalm – Предоставляет постоянное соединение с использованием NAPALM
Примечание
Этот плагин входит в состав коллекции ansible.netcommon (версия 1.5.0).
Для его установки используйте: ansible-galaxy collection install ansible.netcommon.
Для использования в книге задач укажите: ansible.netcommon.napalm.
Введено в версии 1.0.0: из ansible.netcommon
УСТЕРЕГЛО
- Удалено в
-
главной версии после 2022-06-01
- Почему
-
Я почти уверен, что никто никогда не пытался использовать эти модули
- Альтернатива
-
Нет. Если кто-то действительно хочет использовать этот плагин, откройте вопрос, и мы отменит устаревание
Описание
- Этот плагин подключения обеспечивает подключение к сетевым устройствам с использованием библиотеки абстракции сетевого устройства NAPALM. Эта библиотека требует включения определенных функций на сетевых устройствах в зависимости от операционной системы целевого устройства. Плагину подключения требуется, чтобы
napalmбыл установлен локально на контроллере Ansible.
Требования
Ниже перечислены требования, необходимые на локальном узле контроллера, который выполняет это подключение.
- napalm
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| host строка | Значение по умолчанию: "inventory_hostname" | var: ansible_host | Указывает FQDN или IP-адрес удаленного устройства для установления SSH-соединения. |
| host_key_auto_add булево |
| записи ini: [paramiko_connection] env:ANSIBLE_HOST_KEY_AUTO_ADD | По умолчанию Ansible запросит пользователя перед добавлением SSH-ключа в файл известных хостов. Включив этот параметр, неизвестные ключи хостов будут автоматически добавляться в файл известных хостов. Убедитесь, что вы полностью понимаете последствия включения этого параметра в производственной системе, так как это может создать уязвимость безопасности. |
| network_os строка | var: ansible_network_os | Настраивает сетевую операционную систему платформы устройства. Это значение используется для загрузки абстракции устройства napalm. | |
| password строка | var: ansible_password var: ansible_ssh_pass var: ansible_ssh_password | Настраивает пароль пользователя, используемый для аутентификации на удаленном устройстве при первом установлении SSH-соединения. | |
| persistent_command_timeout целое число | Значение по умолчанию: 30 | записи ini: [persistent_connection] env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_command_timeout | Настраивает (в секундах) время ожидания возврата команды с удаленного устройства. Если этот таймер истечет до возврата команды, плагин подключения сгенерирует исключение и закроется. |
| persistent_connect_timeout целое число | Значение по умолчанию: 30 | записи ini: [persistent_connection] env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_connect_timeout | Настраивает (в секундах) время ожидания при попытке первоначального установления постоянного соединения. Если это значение истечёт, прежде чем подключение к удалённому устройству будет завершено, подключение завершится с ошибкой. |
| port целое число | Значение по умолчанию: 22 | записи ini: [defaults] env:ANSIBLE_REMOTE_PORT var: ansible_port | Указывает порт на удаленном устройстве, который слушает подключения при установлении SSH-соединения. |
| private_key_file строка | записи ini: [defaults] env:ANSIBLE_PRIVATE_KEY_FILE var: ansible_private_key_file | Файл приватного SSH-ключа или сертификата, используемый для аутентификации на удаленном устройстве при первом установлении SSH-соединения. | |
| remote_user строка | записи ini: [defaults] env:ANSIBLE_REMOTE_USER var: ansible_user | Имя пользователя, используемое для аутентификации на удаленном устройстве при первоначальном установлении SSH-соединения. Если remote_user не указан, для подключения будет использоваться имя пользователя вошедшего пользователя. Можно настроить с помощью командной строки с помощью параметров --user или -u. | |
| timeout целое число | Значение по умолчанию: 120 | Устанавливает время подключения (в секундах) для связи с удалённым устройством. Этот таймаут используется в качестве значения таймаута по умолчанию для команд при отправке команды на сетевой CLI. Если команда не вернётся в течение timeout секунд, генерируется ошибка. |
Статус
- Это подключение будет удалено в основной версии после 2022-06-01. [устаревший]
- Для получения дополнительной информации см. УСТЕРЕГЛО.
Авторы
- Команда Ansible Networking
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/napalm_connection.html
