community.general.utm_proxy_exception 模块 – 在 Sophos UTM 中创建、更新或销毁反向代理异常条目

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定： community.general.utm_proxy_exception。

概要 

在 Sophos UTM 中创建、更新或销毁反向代理异常条目。
此模块需要激活 UTM 的 REST 功能。

参数 

参数	注释
headers 字典	要发送到 POST 和 PUT 请求的其他标头的字典。某些模块需要此参数。默认值： `{}`
name 字符串 / 必需	对象的名称。将用于标识条目
op 字符串	要与路径参数的条目一起使用的操作数选项 `"AND"` ← (默认) `"OR"`
path 列表 / 元素=字符串	在反向代理中定义异常的路径默认值： `[]`
skip_custom_threats_filters 列表 / 元素=字符串	要跳过的威胁列表默认值： `[]`
skip_threats_filter_categories 列表 / 元素=字符串	定义要跳过的威胁类别默认值： `[]`
skipav 布尔值	跳过杀毒扫描选项 `false` ← (默认) `true`
skipbadclients 布尔值	阻止信誉不好的客户端选项 `false` ← (默认) `true`
skipcookie 布尔值	跳过 Cookie 签名检查选项 `false` ← (默认) `true`
skipform 布尔值	启用表单加固选项 `false` ← (默认) `true`
skipform_missingtoken 布尔值	启用缺少令牌的表单加固选项 `false` ← (默认) `true`
skiphtmlrewrite 布尔值	防止 SQL 注入选项 `false` ← (默认) `true`
skiptft 布尔值	启用真正的文件类型控制选项 `false` ← (默认) `true`
skipurl 布尔值	启用静态 URL 加固选项 `false` ← (默认) `true`
source 列表 / 元素=字符串	定义要跳过的威胁类别默认值： `[]`
state 字符串	对象的所需状态。 `present` 将创建或更新对象。 `absent` 将删除对象（如果它存在）。选项 `"absent"` `"present"` ← (默认)
status 布尔值	异常规则集的状态选项 `false` `true` ← (默认)
utm_host 字符串 / 必需	Sophos UTM 的 REST 端点。
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 布尔值	是否应验证 REST 接口的 SSL 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：不支持	可以在 `check_mode` 下运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要更改的内容，在 `check_mode` 中）的详细信息。

示例 

- 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

返回值 

常见的返回值已在此处记录，以下是此模块独有的字段

键	描述
结果复杂	已创建的utm对象返回值：成功
_locked 布尔值	对象当前是否已锁定返回值：成功
_ref 字符串	对象的引用名称返回值：成功
_type 字符串	对象的类型返回值：成功
注释字符串	可选的注释字符串返回值：成功
name 字符串	对象的名称返回值：成功
op 字符串	要与路径参数的条目一起使用的操作数返回值：成功
path 列表 / 元素=字符串	在反向代理中定义异常的路径返回值：成功
skip_custom_threats_filters 列表 / 元素=字符串	要跳过的威胁列表返回值：成功
skip_threats_filter_categories 列表 / 元素=字符串	定义要跳过的威胁类别返回值：成功
skipav 布尔值	跳过杀毒扫描返回值：成功
skipbadclients 布尔值	阻止信誉不好的客户端返回值：成功
skipcookie 布尔值	跳过 Cookie 签名检查返回值：成功
skipform 布尔值	启用表单加固返回值：成功
skipform_missingtoken 布尔值	启用缺少令牌的表单加固返回值：成功
skiphtmlrewrite 布尔值	防止 SQL 注入返回值：成功
skiptft 布尔值	启用真正的文件类型控制返回值：成功
skipurl 布尔值	启用静态 URL 加固返回值：成功
source 列表 / 元素=字符串	定义要跳过的威胁类别返回值：成功

作者

Sebastian Schenzel (@RickS-C137)