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

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать модуль в плейбуке, укажите: community.general.utm_proxy_frontend_info.

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление или удаление записи внешнего интерфейса reverse_proxy в SOPHOS UTM.
Для работы этого модуля необходимо активировать REST-возможности UTM.

Параметры

Параметр	Комментарии
headers словарь	Словарь дополнительных заголовков, отправляемых в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
name строка / обязательный	Имя объекта, идентифицирующее запись.
state строка	Требуемое состояние объекта. `present` создает или обновляет объект. `absent` удаляет объект, если он существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
utm_host строка / обязательный	Конечная точка REST Sophos UTM.
utm_port целое число	Порт интерфейса REST. По умолчанию: `4444`
utm_protocol строка	Протокол конечной точки REST. Варианты: `"http"` `"https"` ← (по умолчанию)
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. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примеры

- 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 составной тип	Созданный объект UTM. Возвращается: при успехе
_locked логическое значение	Заблокирован ли объект в данный момент. Возвращается: при успехе
_ref строка	Справочное имя объекта. Возвращается: при успехе
_type строка	Тип объекта. Возвращается: при успехе
add_content_type_header логическое значение	Добавлять ли заголовок типа содержимого. Возвращается: при успехе
address строка	Справочное имя адреса. Возвращается: при успехе
allowed_networks список / элементы=строка	Список справочных имен связанных сетей. Возвращается: при успехе
certificate строка	Справочное имя сертификата (ca/host_key_cert). Возвращается: при успехе
comment строка	Текст комментария. Возвращается: при успехе
disable_compression логическое значение	Состояние поддержки сжатия. Возвращается: при успехе
domain список / элементы=строка	Список имен хостов. Возвращается: при успехе
exceptions список / элементы=строка	Список связанных исключений прокси. Возвращается: при успехе
htmlrewrite логическое значение	Состояние перезаписи HTML. Возвращается: при успехе
htmlrewrite_cookies логическое значение	Установлена ли cookie перезаписи HTML. Возвращается: при успехе
implicitredirect логическое значение	Используется ли неявная переадресация. Возвращается: при успехе
lbmethod строка	Используемый метод балансировщика нагрузки. Возвращается: при успехе
locations список / элементы=строка	Справочные имена связанных с объектом reverse_proxy/locations. Возвращается: при успехе
name строка	Имя объекта. Возвращается: при успехе
port целое число	Порт подключения внешнего интерфейса. Возвращается: при успехе
preservehost логическое значение	Сохранять заголовок Host. Возвращается: при успехе
profile строка	Связанный reverse_proxy/profile. Возвращается: при успехе
status логическое значение	Активен ли объект внешнего интерфейса. Возвращается: при успехе
type строка	Тип подключения. Возвращается: при успехе
xheaders логическое значение	Состояние xheaders. Возвращается: при успехе

Авторы

Johannes Brunswicker (@MatrixCrawler)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/utm_proxy_frontend_info_module.html