napalm – Предоставляет постоянное подключение с помощью NAPALM
Новое в версии 2.8.
Обзор
- Этот плагин подключения обеспечивает подключение к сетевым устройствам с использованием библиотеки абстракции сетевых устройств NAPALM. Для этого требуется включение определенных функций на сетевых устройствах в зависимости от операционной системы целевого устройства. Плагин подключения требует
napalm, чтобы быть установленным локально на контроллере Ansible.
Требования
Ниже перечислены требования к локальному узлу-мастеру, на котором выполняется это подключение.
- 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. Если команда не вернется в течение времени тайм-аута, генерируется ошибка. |
Статус
- Это подключение не гарантирует обратную совместимость интерфейса. [preview]
- Это подключение поддерживается сообществом Ansible. [community]
Авторы
- Команда 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.9/plugins/connection/napalm.html