ansible.netcommon.napalm – Предоставляет постоянное подключение с использованием NAPALM

Примечание

Этот плагин входит в состав коллекции ansible.netcommon (версия 1.4.1).

Для его установки используйте: 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] host_key_auto_add = нет 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] command_timeout = 30 env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_command_timeout	Настраивает время ожидания в секундах для получения результата команды с удалённого устройства. Если этот таймер истечёт до возврата команды, плагин подключения сгенерирует исключение и закроет соединение.
persistent_connect_timeout целое число	Значение по умолчанию: 30	записи ini: [persistent_connection] connect_timeout = 30 env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_connect_timeout	Настраивает время ожидания в секундах при попытке первоначального установления постоянного подключения. Если это значение истечёт до завершения подключения к удалённому устройству, подключение завершится с ошибкой.
port целое число	Значение по умолчанию: 22	записи ini: [defaults] remote_port = 22 env:ANSIBLE_REMOTE_PORT var: ansible_port	Указывает порт на удаленном устройстве, который слушает подключения при установлении SSH-соединения.
private_key_file строка		записи ini: [defaults] private_key_file = None env:ANSIBLE_PRIVATE_KEY_FILE var: ansible_private_key_file	Файл закрытого SSH-ключа или сертификата, используемый для аутентификации на удаленном устройстве при первом установлении SSH-соединения.
remote_user строка		записи ini: [defaults] remote_user = None 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/netcommon/napalm_connection.html