community.general.utm_proxy_exception модуль — Создание, обновление или удаление записи исключения 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_exception.

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

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
headers dictionary	Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходим для некоторых модулей. Default: `{}`
name string / required	Имя объекта. Будет использоваться для идентификации записи
op string	Операнд, который будет использоваться с записями параметра path Choices: `"AND"` ← (default) `"OR"`
path list / elements=string	Пути, для которых определено исключение в обратном прокси Default: `[]`
skip_custom_threats_filters list / elements=string	Список угроз, которые необходимо пропустить Default: `[]`
skip_threats_filter_categories list / elements=string	Определите, какие категории угроз пропускаются Default: `[]`
skipav boolean	Пропустить проверку антивируса Choices: `false` ← (default) `true`
skipbadclients boolean	Блокировать клиентов с плохой репутацией Choices: `false` ← (default) `true`
skipcookie boolean	Пропустить проверку подписи Cookie Choices: `false` ← (default) `true`
skipform boolean	Включить защиту форм Choices: `false` ← (default) `true`
skipform_missingtoken boolean	Включить защиту форм с отсутствующими токенами Choices: `false` ← (default) `true`
skiphtmlrewrite boolean	Защита от SQL-инъекций Choices: `false` ← (default) `true`
skiptft boolean	Включить контроль типов файлов Choices: `false` ← (default) `true`
skipurl boolean	Включить защиту статических URL-адресов Choices: `false` ← (default) `true`
source list / elements=string	Определите, какие категории угроз пропускаются Default: `[]`
state string	Требуемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он был. Choices: `"absent"` `"present"` ← (default)
status boolean	Статус набора правил исключений Choices: `false` `true` ← (default)
utm_host string / required	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` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create UTM proxy_exception
  community.general.utm_proxy_exception:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestExceptionEntry
    backend: REF_OBJECT_STRING
    state: present

- name: Remove UTM proxy_exception
  community.general.utm_proxy_exception:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestExceptionEntry
    state: absent

Значения возврата

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

Ключ	Описание
result сложный	Созданный объект utm Возвращается: success
_locked логический	Заблокирован ли объект в данный момент Возвращается: success
_ref строка	Имя ссылки объекта Возвращается: success
_type строка	Тип объекта Возвращается: success
comment строка	Дополнительная строка комментария Возвращается: success
name строка	Имя объекта Возвращается: success
op строка	Операнд, используемый с записями параметра пути Возвращается: success
path список / элементы=строка	Пути, для которых определено исключение в обратном прокси Возвращается: success
skip_custom_threats_filters список / элементы=строка	Список угроз, которые будут пропущены Возвращается: success
skip_threats_filter_categories список / элементы=строка	Определяет, какие категории угроз пропускаются Возвращается: success
skipav логический	Пропустить сканирование антивируса Возвращается: success
skipbadclients логический	Заблокировать клиентов с плохой репутацией Возвращается: success
skipcookie логический	Пропустить проверку Cookie Signing Возвращается: success
skipform логический	Включить hardening форм Возвращается: success
skipform_missingtoken логический	Включить hardening форм с отсутствующими токенами Возвращается: success
skiphtmlrewrite логический	Защита от SQL Возвращается: success
skiptft логический	Включить контроль типа файла Возвращается: success
skipurl логический	Включить hardening статических URL Возвращается: success
source список / элементы=строка	Определяет, какие категории угроз пропускаются Возвращается: success

Авторы

Sebastian Schenzel (@RickS-C137)

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

© 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_exception_module.html