napalm – Предоставляет постоянное подключение с использованием NAPALM
Новое в версии 2.8.
Обзор
- Этот плагин подключения обеспечивает подключение к сетевым устройствам с использованием библиотеки абстракции сетевого устройства NAPALM. Эта библиотека требует включения определённых функций на сетевых устройствах в зависимости от операционной системы целевого устройства. Для работы плагина подключения на контроллере Ansible требуется
napalm.
Требования
Ниже перечислены требования к локальному узлу-мастеру, на котором выполняется это подключение.
- napalm
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| host - | По умолчанию: "inventory_hostname" | var: ansible_host | Указывает FQDN или IP-адрес удалённого устройства для установления SSH-соединения. |
| host_key_auto_add boolean | По умолчанию: "no" | записи 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 integer | По умолчанию: 30 | записи ini: [persistent_connection] env:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT var: ansible_command_timeout | Устанавливает, в секундах, время ожидания возврата команды с удалённого устройства. Если этот таймер истечёт, прежде чем команда вернётся, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout integer | По умолчанию: 30 | записи ini: [persistent_connection] env:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT var: ansible_connect_timeout | Устанавливает, в секундах, время ожидания при попытке первоначального установления постоянного соединения. Если это значение истечёт, прежде чем подключение к удалённому устройству будет завершено, подключение завершится ошибкой. |
| port integer | По умолчанию: 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 integer | По умолчанию: 120 | Устанавливает время подключения, в секундах, для связи с удалённым устройством. Этот таймаут используется в качестве значения таймаута по умолчанию для команд при отправке команды в сетевой CLI. Если команда не возвращается в течение timeout секунд, генерируется ошибка. |
Статус
- Для этого подключения не гарантируется обратная совместимость интерфейса. [превью]
- Это подключение поддерживается сообществом Ansible. [сообщество]
Авторы
- Команда Ansible по сетевым технологиям
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
Подсказка
Записи конфигурации для каждого типа записи имеют порядок приоритета снизу вверх. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/plugins/connection/napalm.html
