httpapi – Использование httpapi для выполнения команд на сетевых устройствах
Новое в версии 2.6.
Описание
- Этот плагин подключения обеспечивает подключение к удаленным устройствам через API на основе HTTP(S).
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| become boolean | Значение по умолчанию: "no" | записи в 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 для обработки повышения привилегий. Обычно значение 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 integer | Значение по умолчанию: 30 | записи в ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT переменная: ansible_command_timeout | Настраивает время ожидания в секундах, которое будет ждать возврата команды с удаленного устройства. Если этот таймер истечет до возврата команды, плагин подключения сгенерирует исключение и закроет соединение. |
| persistent_connect_timeout integer | Значение по умолчанию: 30 | записи в ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT переменная: ansible_connect_timeout | Настраивает время ожидания в секундах при первой попытке установить постоянное подключение. Если это значение истечет до завершения подключения к удаленному устройству, подключение будет прервано. |
| persistent_log_messages boolean | Значение по умолчанию: "no" | записи в ini: [persistent_connection] переменная среды:ANSIBLE_PERSISTENT_LOG_MESSAGES переменная: ansible_persistent_log_messages | Этот флаг включит протоколирование команды, выполняемой и полученного ответа с целевого устройства в файл журнала Ansible. Для работы этого параметра необходимо указать параметр конфигурации Ansible 'log_path' со значением пути к файлу с правами записи. Необходимо понимать последствия включения этого параметра, так как это может создать уязвимость безопасности, протоколируя конфиденциальную информацию в файл журнала. |
| port integer | записи в 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 integer | Значение по умолчанию: 120 | Устанавливает время подключения в секундах для связи с удаленным устройством. Это значение таймаута используется по умолчанию для команд при отправке команды в сетевой CLI. Если команда не возвращается в течение timeout секунд, генерируется ошибка. | |
| use_ssl boolean | Значение по умолчанию: "no" | переменная: ansible_httpapi_use_ssl | Использовать SSL (HTTPS) или нет (HTTP). |
| validate_certs boolean добавлено в 2.7 | Значение по умолчанию: "yes" | переменная: ansible_httpapi_validate_certs | Проверять сертификаты SSL |
Статус
- Для этого подключения не гарантируется обратная совместимость интерфейса. [превью]
- Это подключение поддерживается сообществом Ansible. [сообщество]
Авторы
- Команда 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.8/plugins/connection/httpapi.html
