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

Примечание

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

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

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

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

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

Описание

Создание, обновление или удаление записи обратного прокси-фронта в 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	Поддержка: нет Это действие не изменяет состояние.	Возвратит подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`), когда работает в режиме diff.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

END_OF_DOCUMENT_MARKER

Key	Description
result complex	Объект UTM, который был создан Возвращено: success
_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	Имя ссылки на сертификат (ca/host_key_cert) Возвращено: success
comment string	Строка комментария Возвращено: success
disable_compression boolean	Состояние поддержки сжатия Возвращено: success
domain list / elements=string	Список имён хостов Возвращено: success
exceptions list / elements=string	Список связанных исключений прокси Возвращено: success
htmlrewrite boolean	Состояние переписывания HTML Возвращено: success
htmlrewrite_cookies boolean	будет ли установлен куки переписывания html Возвращено: success
implicitredirect boolean	использовать ли неявное перенаправление Возвращено: success
lbmethod string	Метод балансировщика нагрузки, который нужно использовать Возвращено: success
locations list / elements=string	Имена ссылок на reverse_proxy/locations, связанные с объектом Возвращено: success
name string	Имя объекта Возвращено: success
port integer	Порт frontend-соединения Возвращено: success
preservehost boolean	Сохранять заголовок хоста Возвращено: success
profile string	Связанный reverse_proxy/profile Возвращено: success
status boolean	Активен ли объект frontend или нет Возвращено: success

тип строка	Тип подключения Возвращаемое значение: успех
xheaders булево	Состояние xheaders Возвращаемое значение: успех

Авторы

Johannes Brunswicker (@MatrixCrawler)

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

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