community.general.utm_proxy_frontend – создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.utm_proxy_frontend.
Обзор
- Создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM.
- Для работы данного модуля необходимо активировать REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| add_content_type_header boolean |
| Добавлять заголовок типа содержимого или нет |
| address строка | Значение по умолчанию: "REF_DefaultInternalAddress" | Идентификатор ссылки на объект сети/адреса интерфейса. |
| allowed_networks список / элементы=строка | Значение по умолчанию: ["REF_NetworkAny"] | Список ссылок на разрешенные сети. |
| certificate строка | Значение по умолчанию: "" | Идентификатор ссылки на объект ca/host_key_cert. |
| comment строка | Значение по умолчанию: "" | Необязательный комментарий к объекту. |
| disable_compression boolean |
| Включить или выключить сжатие |
| domain список / элементы=строка | Список доменных имен для объекта фронта. | |
| exceptions список / элементы=строка | Значение по умолчанию: [] | Список ссылок на исключения (reverse_proxy/exception). |
| headers словарь | Словарь дополнительных заголовков для POST и PUT запросов. Необходим для некоторых модулей. | |
| htmlrewrite boolean |
| Включить или выключить переписывание HTML. |
| htmlrewrite_cookies boolean |
| Включить или выключить переписывание куки при переписывании HTML. |
| implicitredirect boolean |
| Включить или выключить неявное перенаправление. |
| lbmethod строка |
| Метод балансировки нагрузки. |
| locations список / элементы=строка | Значение по умолчанию: [] | Список ссылок на локации (reverse_proxy/location). |
| name строка / обязательно | Имя объекта. Используется для идентификации записи. | |
| port целое число | Значение по умолчанию: 80 | Порт HTTP фронта. |
| preservehost boolean |
| Сохранять заголовок хоста. |
| profile строка | Значение по умолчанию: "" | Ссылка на профиль reverse_proxy/profile. |
| state строка |
| Желаемое состояние объекта. present создает или обновляет объект.absent удалит объект, если он присутствовал. |
| status boolean |
| Активировать запись фронта или нет. |
| type строка |
| Используемый протокол. |
| 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 boolean |
| Проверять сертификат SSL REST-интерфейса или нет. |
| xheaders boolean |
| Передавать заголовок хоста или нет |
Примеры
- name: Create utm proxy_frontend
community.general.utm_proxy_frontend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestFrontendEntry
host: REF_OBJECT_STRING
state: present
- name: Remove utm proxy_frontend
community.general.utm_proxy_frontend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestFrontendEntry
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| result complex | success | Созданный объект utm | |
| _locked boolean | success | Заблокирован ли объект в данный момент | |
| _ref string | success | Имя ссылки объекта | |
| _type string | success | Тип объекта | |
| add_content_type_header boolean | success | Добавлять ли заголовок типа контента | |
| address string | success | Имя ссылки адреса | |
| allowed_networks list / elements=string | success | Список имён ссылок ассоциированных сетей | |
| certificate string | success | Имя ссылки сертификата (ca/host_key_cert) | |
| comment string | success | Строка комментария | |
| disable_compression boolean | success | Состояние поддержки сжатия | |
| domain list / elements=string | success | Список имён хостов | |
| exceptions list / elements=string | success | Список ассоциированных исключений прокси | |
| htmlrewrite boolean | success | Состояние переписывания HTML | |
| htmlrewrite_cookies boolean | success | Установка cookie переписывания HTML | |
| implicitredirect boolean | success | Использовать неявное перенаправление | |
| lbmethod string | success | Метод балансировщика нагрузки | |
| locations list / elements=string | success | Имена ссылок связанных с объектом обратных прокси/локаций | |
| name string | success | Имя объекта | |
| port integer | success | Порт переднего соединения | |
| preservehost boolean | success | Сохранить заголовок хоста | |
| profile string | success | Связанный обратный прокси/профиль | |
| status boolean | success | Активен ли объект переднего плана | |
| type string | success | Тип соединения | |
| xheaders boolean | success | Состояние xheaders | |
Авторы
- Johannes Brunswicker (@MatrixCrawler)
© 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/community/general/utm_proxy_frontend_module.html
