Модуль community.general.utm_proxy_location_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_location_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: Remove UTM proxy_location
  community.general.utm_proxy_location_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry

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

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

Ключ	Описание
result сложный тип	Созданный объект UTM. Возвращается: при успешном выполнении
_locked логический	Заблокирован ли объект в данный момент. Возвращается: при успешном выполнении
_ref строка	Имя ссылки на объект. Возвращается: при успешном выполнении
_type строка	Тип объекта. Возвращается: при успешном выполнении
access_control строка	Используется ли состояние контроля доступа. Возвращается: при успешном выполнении
allowed_networks список / элементы=строка	Список имен ссылок на разрешенные сети. Возвращается: при успешном выполнении
auth_profile строка	Имя ссылки на профиль аутентификации. Возвращается: при успешном выполнении
backend строка	Имя ссылки на серверную часть. Возвращается: при успешном выполнении
be_path строка	Путь серверной части. Возвращается: при успешном выполнении
comment строка	Текст комментария. Возвращается: при успешном выполнении
denied_networks список / элементы=строка	Список имен запрещенных сетей. Возвращается: при успешном выполнении
hot_standby логический	Использовать горячий резерв. Возвращается: при успешном выполнении
name строка	Имя объекта. Возвращается: при успешном выполнении
path строка	Имя пути. Возвращается: при успешном выполнении
status логический	Активен ли объект. Возвращается: при успешном выполнении
stickysession_id строка	Идентификатор stickysession. Возвращается: при успешном выполнении
stickysession_status логический	Используется ли stickysession. Возвращается: при успешном выполнении
websocket_passthrough логический	Используется ли сквозная передача WebSocket. Возвращается: при успешном выполнении

Авторы

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_location_info_module.html