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 字符串	要与 path 参数的条目一起使用的操作数选择 `"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

返回值 

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

键	描述
result 复杂	已创建的 utm 对象返回: 成功
_locked 布尔值	对象当前是否被锁定返回: 成功
_ref 字符串	对象的引用名称返回: 成功
_type 字符串	对象的类型返回: 成功
comment 字符串	可选的注释字符串返回: 成功
name 字符串	对象的名称返回: 成功
op 字符串	要与 path 参数的条目一起使用的操作数返回: 成功
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)