Модуль community.general.utm_proxy_frontend — создание, обновление или удаление записи интерфейсной части reverse_proxy в Sophos UTM

add_content_type_header

boolean

Добавлять ли заголовок Content-Type.

Варианты:

• false ← (по умолчанию)
• true

address

string

Справочное имя объекта network/interface_address.

По умолчанию: "REF_DefaultInternalAddress"

allowed_networks

list / elements=string

Список справочных имён разрешённых сетей.

По умолчанию: ["REF_NetworkAny"]

certificate

string

Справочное имя объекта ca/host_key_cert.

По умолчанию: ""

comment

string

Необязательный комментарий, добавляемый к объекту.

По умолчанию: ""

disable_compression

boolean

Включать ли сжатие.

Варианты:

• false ← (по умолчанию)
• true

domain

list / elements=string

Список доменных имён для объекта интерфейсной части.

exceptions

list / elements=string

Список справочных имён исключений (reverse_proxy/exception).

По умолчанию: []

headers

dictionary

Словарь дополнительных заголовков, передаваемых в запросах POST и PUT.

Необходим для некоторых модулей.

По умолчанию: {}

htmlrewrite

boolean

Включать ли переписывание HTML.

Варианты:

• false ← (по умолчанию)
• true

htmlrewrite_cookies

boolean

Включать ли переписывание cookie в HTML.

Варианты:

• false ← (по умолчанию)
• true

implicitredirect

boolean

Включать ли неявную переадресацию.

Варианты:

• false ← (по умолчанию)
• true

lbmethod

string

Метод балансировщика нагрузки.

Варианты:

• ""
• "bybusyness" ← (по умолчанию)
• "bytraffic"
• "byrequests"

locations

list / elements=string

Список справочных имён расположений (reverse_proxy/location).

По умолчанию: []

name

string / обязательный

Имя объекта, идентифицирующее запись.

port

integer

HTTP-порт интерфейсной части.

По умолчанию: 80

preservehost

boolean

Сохранять ли заголовок Host.

Варианты:

• false ← (по умолчанию)
• true

profile

string

Справочная строка объекта reverse_proxy/profile.

По умолчанию: ""

state

string

Требуемое состояние объекта.

present создаёт объект или обновляет его.

absent удаляет объект, если он существует.

Варианты:

• "absent"
• "present" ← (по умолчанию)

status

boolean

Активировать ли запись интерфейсной части.

Варианты:

• false
• true ← (по умолчанию)

type

string

Используемый протокол.

Варианты:

• "http" ← (по умолчанию)
• "https"

utm_host

string / обязательный

Конечная точка REST Sophos UTM.

utm_port

integer

Порт REST-интерфейса.

По умолчанию: 4444

utm_protocol

string

Протокол конечной точки REST.

Варианты:

• "http"
• "https" ← (по умолчанию)

utm_token

string / обязательный

Токен для идентификации в 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-интерфейса.

Варианты:

• false
• true ← (по умолчанию)

xheaders

boolean

Передавать ли заголовок Host.

Варианты:

• false ← (по умолчанию)
• true

check_mode

Поддержка: нет

Можно выполнять в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: нет

В режиме diff возвращает сведения об изменениях (или о возможных изменениях в check_mode).

result

complex

Созданный объект utm.

Возвращается: при успехе

_locked

boolean

Заблокирован ли объект в данный момент.

Возвращается: при успехе

_ref

string

Имя ссылки на объект.

Возвращается: при успехе

_type

string

Тип объекта.

Возвращается: при успехе

add_content_type_header

boolean

Добавлять ли заголовок Content-Type.

Возвращается: при успехе

address

string

Имя ссылки на адрес.

Возвращается: при успехе

allowed_networks

list / elements=string

Список имен ссылок на связанные сети.

Возвращается: при успехе

certificate

string

Имя ссылки на сертификат (ca/host_key_cert).

Возвращается: при успехе

comment

string

Текст комментария.

Возвращается: при успехе

disable_compression

boolean

Состояние поддержки сжатия.

Возвращается: при успехе

domain

list / elements=string

Список имен хостов.

Возвращается: при успехе

exceptions

list / elements=string

Список связанных исключений прокси-сервера.

Возвращается: при успехе

htmlrewrite

boolean

Состояние перезаписи HTML.

Возвращается: при успехе

htmlrewrite_cookies

boolean

Установлена ли cookie для перезаписи HTML.

Возвращается: при успехе

implicitredirect

boolean

Использовать ли неявное перенаправление.

Возвращается: при успехе

lbmethod

string

Метод балансировки нагрузки, который следует использовать.

Возвращается: при успехе

locations

list / elements=string

Имена ссылок на связанные с объектом reverse_proxy/locations.

Возвращается: при успехе

name

string

Имя объекта.

Возвращается: при успехе

port

integer

Порт подключения внешнего интерфейса.

Возвращается: при успехе

preservehost

boolean

Сохранять заголовок Host.

Возвращается: при успехе

profile

string

Связанный reverse_proxy/profile.

Возвращается: при успехе

status

boolean

Активен ли объект внешнего интерфейса.

Возвращается: при успехе

type

string

Тип подключения.

Возвращается: при успехе

xheaders

boolean

Состояние xheaders.

Возвращается: при успехе