ansible.netcommon.httpapi – Использование httpapi для выполнения команд на сетевых устройствах
Примечание
Этот плагин входит в коллекцию ansible.netcommon (версия 1.5.0).
Для его установки используйте: ansible-galaxy collection install ansible.netcommon.
Для использования в книге задач укажите: ansible.netcommon.httpapi.
Новый в версии 1.0.0: из ansible.netcommon
Обзор
- Этот плагин подключения предоставляет подключение к удаленным устройствам через API на основе HTTP(S).
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| become логический |
| записи ini: [privilege_escalation] переменная среды:ANSIBLE_BECOME переменная: ansible_become | Параметр become укажет сессии командной строки попытку повышения привилегий на платформах, которые ее поддерживают. Обычно это означает переход от пользовательского режима к enable режиму в сессии командной строки. Если become установлено в True и удаленное устройство не поддерживает повышение привилегий или привилегии уже повышены, то этот параметр будет проигнорирован.Можно настроить с командной строки через параметры --become или -b. |
| become_method строка | Значение по умолчанию: "sudo" | записи ini: [privilege_escalation] переменная среды:ANSIBLE_BECOME_METHOD переменная: ansible_become_method | Этот параметр позволяет указать метод повышения привилегий. Обычно значение become_method устанавливается в enable, но может быть определено и другими значениями. |
| host строка | Значение по умолчанию: "inventory_hostname" | переменная: ansible_host | Указывает полное доменное имя или 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 логический |
| записи 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 не указан, для подключения будет использован имя пользователя вошедшего пользователя. Можно настроить с командной строки через параметры --user или -u. | |
| session_key словарь | переменная: ansible_httpapi_session_key | Настройка ключа сессии для аутентификации на удаленном устройстве при необходимости для API устройства. Должен содержать словарь, представляющий имя ключа и его значение для токена. При указании параметра password игнорируется. | |
| use_proxy логический |
| переменная: ansible_httpapi_use_proxy | Использовать https_proxy для запросов. |
| use_ssl логический |
| переменная: ansible_httpapi_use_ssl | Использовать SSL (HTTPS) или нет (HTTP). |
| validate_certs логический |
| переменная: ansible_httpapi_validate_certs | Проверять сертификаты SSL |
Авторы
- Команда Ansible Networking
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/httpapi_connection.html
