httpapi – Использование httpapi для выполнения команд на сетевых устройствах
Новое в версии 2.6.
Обзор
- Этот плагин подключения обеспечивает подключение к удаленным устройствам через API на основе HTTP(S).
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| become boolean | По умолчанию: "нет" | записи ini: [privilege_escalation] переменная среды:ANSIBLE_BECOME переменная: ansible_become | Опция become укажет сессии CLI на попытку повышения привилегий на платформах, которые это поддерживают. Обычно это означает переход от пользовательского режима к enable режиму в сессии CLI. Если become установлено в True, а удаленное устройство не поддерживает повышение привилегий или привилегия уже повышена, то эта опция игнорируется.Можно настроить из CLI с помощью опций --become или -b. |
| become_method - | По умолчанию: "sudo" | записи ini: [privilege_escalation] переменная среды:ANSIBLE_BECOME_METHOD переменная: ansible_become_method | Этот параметр позволяет указать метод повышения привилегий. Обычно значение become_method устанавливается в enable, но может быть определено и другими значениями. |
| host - | По умолчанию: "inventory_hostname" | переменная: ansible_host | Указывает FQDN или IP-адрес удаленного устройства для установления подключения HTTP(S). |
| network_os - | переменная: ansible_network_os | Настройка сетевой операционной системы платформы устройства. Это значение используется для загрузки правильного плагина httpapi для взаимодействия с удаленным устройством | |
| password - | переменная: ansible_password переменная: ansible_httpapi_pass переменная: ansible_httpapi_password | Настройка пароля пользователя для аутентификации на удаленном устройстве при необходимости для API устройства. | |
| persistent_command_timeout целое число | По умолчанию: 30 | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT переменная: ansible_command_timeout | Настройка (в секундах) времени ожидания возврата команды с удаленного устройства. Если таймер истечёт до возврата команды, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout целое число | По умолчанию: 30 | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT переменная: ansible_connect_timeout | Настройка (в секундах) времени ожидания при попытке первоначального установления постоянного соединения. Если это значение истечёт до завершения подключения к удаленному устройству, подключение будет прервано. |
| persistent_log_messages boolean | По умолчанию: "нет" | записи ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_LOG_MESSAGES переменная: ansible_persistent_log_messages | Этот флаг включит протоколирование команды, выполненной и полученного ответа с целевого устройства в файл журнала Ansible. Для работы этой опции требуется настройка опции конфигурации Ansible «log_path» на путь к файлу с правами записи. Убедитесь, что вы полностью понимаете последствия включения этой опции, так как она может создать уязвимость, записывая конфиденциальную информацию в файл журнала. |
| port целое число | записи ini: [defaults] переменная среды:ANSIBLE_REMOTE_PORT переменная: ansible_httpapi_port | Указывает порт на удаленном устройстве, который слушает подключения при установке подключения HTTP(S). Если не указано, будет выбрано 80 или 443 в зависимости от значения use_ssl. | |
| remote_user - | записи ini: [defaults] переменная среды:ANSIBLE_REMOTE_USER переменная: ansible_user | Имя пользователя, используемое для аутентификации на удаленном устройстве при первоначальном установлении подключения к API. Если remote_user не указан, соединение будет использовать имя пользователя вошедшего пользователя. Можно настроить из CLI с помощью опций --user или -u. | |
| timeout целое число | По умолчанию: 120 | Устанавливает время соединения (в секундах) для взаимодействия с удаленным устройством. Это значение по умолчанию используется для таймаута команд при отправке команды на сетевой CLI. Если команда не вернет результат в течение timeout секунд, будет сгенерирована ошибка. | |
| use_proxy boolean добавлен в 2.9 | По умолчанию: "да" | переменная: ansible_httpapi_use_proxy | Использовать https_proxy для запросов? |
| use_ssl boolean | По умолчанию: "нет" | переменная: ansible_httpapi_use_ssl | Использовать SSL (HTTPS) или нет (HTTP)? |
| validate_certs boolean добавлен в 2.7 | По умолчанию: "да" | переменная: ansible_httpapi_validate_certs | Проверять сертификаты SSL? |
Статус
- Этот тип подключения не гарантирует обратную совместимость. [превью]
- Это подключение поддерживается сообществом 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/httpapi.html
