Модуль community.general.utm_proxy_location_info — Создание, обновление или удаление записи расположения reverse_proxy в Sophos UTM

Примечание

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

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

Примеры

- name: Remove UTM proxy_location
  community.general.utm_proxy_location_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry

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

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

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

Авторы

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