community.general.utm_proxy_frontend_info – создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.utm_proxy_frontend_info.
Обзор
- Создает, обновляет или удаляет запись обратного прокси-фронта в SOPHOS UTM.
- Для работы этого модуля необходимо активировать REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| headers словарь | Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей | |
| name строка / обязательно | Имя объекта. Будет использоваться для идентификации записи | |
| state строка |
| Желаемое состояние объекта. present создаст или обновит объектabsent удалит объект, если он был присутствующим |
| utm_host строка / обязательно | REST-точка входа Sophos UTM. | |
| utm_port целое число | Значение по умолчанию: 4444 | Порт REST-интерфейса. |
| utm_protocol строка |
| Протокол REST-точки входа. |
| utm_token строка / обязательно | Токен для идентификации в REST-API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, Глава 2.4.2. | |
| validate_certs булево |
| Требуется ли проверка SSL-сертификата REST-интерфейса. |
Примеры
- name: Get utm proxy_frontend
community.general.utm_proxy_frontend_info:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestBackendEntry
host: REF_OBJECT_STRING
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание | |
|---|---|---|---|
| result сложный | success | Объект utm, который был создан | |
| _locked булево | success | Заблокирован ли объект в данный момент | |
| _ref строка | success | Имя ссылки объекта | |
| _type строка | success | Тип объекта | |
| add_content_type_header булево | success | Добавить ли заголовок типа контента | |
| address строка | success | Имя ссылки адреса | |
| allowed_networks список / элементы=строка | success | Список ссылок сетей, связанных с объектом | |
| certificate строка | success | Ссылка на сертификат (ca/host_key_cert) | |
| comment строка | success | Строка комментария | |
| disable_compression булево | success | Состояние поддержки сжатия | |
| domain список / элементы=строка | success | Список хост-имен | |
| exceptions список / элементы=строка | success | Список связанных исключений прокси | |
| htmlrewrite булево | success | Состояние переписывания html | |
| htmlrewrite_cookies булево | success | Устанавливать ли cookie переписывания html | |
| implicitredirect булево | success | Использовать неявное перенаправление | |
| lbmethod строка | success | Метод балансировки нагрузки | |
| locations список / элементы=строка | success | Ссылки обратного прокси/локаций, связанных с объектом | |
| name строка | success | Имя объекта | |
| port целое число | success | Порт подключения фронта | |
| preservehost булево | success | Сохранить заголовок хоста | |
| profile строка | success | Связанный обратный прокси/профиль | |
| status булево | success | Активен ли объект фронта | |
| type строка | success | Тип подключения | |
| xheaders булево | success | Состояние xheaders | |
Авторы
- Johannes Brunswicker (@MatrixCrawler)
© 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/community/general/utm_proxy_frontend_info_module.html
