Модуль community.general.utm_proxy_location — создание, обновление или удаление записи location обратного прокси в 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.

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

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

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

Параметры

Параметр	Комментарии
access_control string	Активировать ли управление доступом для location. Варианты: `"0"` ← (по умолчанию) `"1"`
allowed_networks list / elements=string	Список разрешённых сетей. По умолчанию: `["REF_NetworkAny"]`
auth_profile string	Справочное имя профиля аутентификации. По умолчанию: `""`
backend list / elements=string	Список бэкендов, связанных с этим объявлением location. По умолчанию: `[]`
be_path string	Путь бэкенда. По умолчанию: `""`
comment string	Необязательная строка комментария. По умолчанию: `""`
denied_networks list / elements=string	Список ссылок на запрещённые сети. По умолчанию: `[]`
headers dictionary	Словарь дополнительных заголовков, отправляемых в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
hot_standby boolean	Активировать режим горячего резерва. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя объекта, идентифицирующее запись.
path string	Путь location. По умолчанию: `"/"`
state string	Требуемое состояние объекта. `present` создаёт или обновляет объект. `absent` удаляет объект, если он существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
status boolean	Активна ли location. Варианты: `false` `true` ← (по умолчанию)
stickysession_id string	Идентификатор stickysession. По умолчанию: `"ROUTEID"`
stickysession_status boolean	Включить stickysession. Варианты: `false` ← (по умолчанию) `true`
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` ← (по умолчанию)
websocket_passthrough boolean	Включить пропуск трафика WebSocket. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

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

Примеры

- name: Create UTM proxy_location
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry
    backend: REF_OBJECT_STRING
    state: present

- name: Remove UTM proxy_location
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry
    state: absent

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

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

Ключ	Описание
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–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_module.html