ansible.netcommon.httpapi – Использование httpapi для выполнения команд на сетевых устройствах
Примечание
Этот плагин входит в состав коллекции ansible.netcommon (версия 1.4.1).
Для его установки используйте: ansible-galaxy collection install ansible.netcommon
Для использования в плейбуке укажите: ansible.netcommon.httpapi
Введено в версии 1.0.0: of ansible.netcommon
Описание
- Этот плагин подключения обеспечивает подключение к удалённым устройствам через API на основе HTTP(S).
Параметры
| Параметр | Варианты/Значения по умолчанию | Настройка | Комментарии |
|---|---|---|---|
| become boolean |
| записи ini: [privilege_escalation] переменная среды: ANSIBLE_BECOME переменная: ansible_become | Параметр become указывает сессии CLI на попытку повышения привилегий на платформах, которые это поддерживают. Обычно это означает переход от пользовательского режима к enable режиму в сессии CLI. Если become установлено в True, а удалённое устройство не поддерживает повышение привилегий или привилегии уже повышены, то этот параметр будет проигнорирован.Может быть настроен через командную строку с помощью опций --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 не указан, подключение будет использовать имя пользователя вошедшего пользователя. Можно настроить через командную строку с помощью опций --user или -u | |
| session_key словарь | переменная: ansible_httpapi_session_key | Настраивает ключ сессии, используемый для аутентификации на удалённом устройстве, когда это необходимо для API устройства. Он должен содержать словарь, представляющий имя ключа и значение для токена. При указании, password игнорируется. | |
| use_proxy boolean |
| переменная: ansible_httpapi_use_proxy | Использовать https_proxy для запросов. |
| use_ssl boolean |
| переменная: ansible_httpapi_use_ssl | Подключаться с использованием SSL (HTTPS) или без него (HTTP). |
| validate_certs boolean |
| переменная: ansible_httpapi_validate_certs | Проверять сертификаты SSL |
Авторы
- Команда 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.10/collections/ansible/netcommon/httpapi_connection.html
