community.general.utm_proxy_frontend – создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.utm_proxy_frontend.
Описание
- Создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM.
- Для работы данного модуля необходимо активировать REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| add_content_type_header boolean |
| Добавлять заголовок типа содержимого или нет |
| address string | Значение по умолчанию: "REF_DefaultInternalAddress" | Имя ссылки объекта сети/адреса интерфейса. |
| allowed_networks list / elements=string | Значение по умолчанию: ["REF_NetworkAny"] | Список имен ссылок разрешённых сетей. |
| certificate string | Значение по умолчанию: "" | Имя ссылки объекта ca/ключ_сертификата_хоста. |
| comment string | Значение по умолчанию: "" | Дополнительный комментарий к объекту (необязательно) |
| disable_compression boolean |
| Включить или выключить сжатие |
| domain list / elements=string | Список доменных имён для объекта фронта | |
| exceptions list / elements=string | Значение по умолчанию: [] | Список ссылок исключений (reverse_proxy/exception) |
| headers dictionary | Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходим для некоторых модулей | |
| htmlrewrite boolean |
| Включить или выключить переписывание HTML |
| htmlrewrite_cookies boolean |
| Включить или выключить переписывание куки HTML |
| implicitredirect boolean |
| Включить или выключить неявное перенаправление |
| lbmethod string |
| Какой метод балансировки нагрузки использовать |
| locations list / elements=string | Значение по умолчанию: [] | Список ссылок местоположений (reverse_proxy/location) |
| name string / required | Имя объекта. Используется для идентификации записи | |
| port integer | Значение по умолчанию: 80 | HTTP порт фронта |
| preservehost boolean |
| Сохранять заголовок хоста или нет |
| profile string | Значение по умолчанию: "" | Строка ссылки reverse_proxy/profile |
| state string |
| Желаемое состояние объекта. present создаст или обновит объектabsent удалит объект, если он был |
| status boolean |
| Активировать запись фронта или нет |
| type string |
| Какой протокол использовать |
| utm_host string / required | REST конечная точка Sophos UTM. | |
| utm_port integer | Значение по умолчанию: 4444 | Порт REST интерфейса. |
| utm_protocol string |
| Протокол REST конечной точки. |
| utm_token string / required | Токен, используемый для идентификации в 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–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_module.html
