community.general.utm_proxy_frontend_info 模块 – 在 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_frontend_info。

概要 

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

参数 

参数	注释
headers 字典	要发送到 POST 和 PUT 请求的附加标头的字典。某些模块需要它。默认值： `{}`
name 字符串 / 必需	对象的名称。将用于标识条目
state 字符串	对象的期望状态。 `present` 将创建或更新对象。 `absent` 将删除对象（如果存在）。选择 `"absent"` `"present"` ←（默认）
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	支持：完全在 community.general 3.3.0 中添加此操作不会修改状态。	可以在 `check_mode` 中运行并返回已更改的状态预测，而无需修改目标。
diff_mode	支持：不适用此操作不会修改状态。	当处于 diff 模式时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: Get utm proxy_frontend
  community.general.utm_proxy_frontend_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestBackendEntry
    host: REF_OBJECT_STRING

返回值 

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

键	描述
result 复杂	已创建的 utm 对象已返回：成功
_locked 布尔值	对象当前是否被锁定已返回：成功
_ref 字符串	对象的引用名称已返回：成功
_type 字符串	对象的类型已返回：成功
add_content_type_header 布尔值	是否添加内容类型标头已返回：成功
address 字符串	地址的引用名称已返回：成功
allowed_networks 列表 / 元素=字符串	关联网络的引用名称列表已返回：成功
certificate 字符串	证书（ca/host_key_cert）的引用名称已返回：成功
comment 字符串	注释字符串已返回：成功
disable_compression 布尔值	压缩支持的状态已返回：成功
domain 列表 / 元素=字符串	主机名列表已返回：成功
exceptions 列表 / 元素=字符串	关联的代理异常列表已返回：成功
htmlrewrite 布尔值	html 重写状态已返回：成功
htmlrewrite_cookies 布尔值	是否设置 html 重写 cookie 已返回：成功
implicitredirect 布尔值	是否使用隐式重定向已返回：成功
lbmethod 字符串	要使用的负载均衡器方法已返回：成功
locations 列表 / 元素=字符串	与对象关联的 reverse_proxy/locations 的引用名称已返回：成功
name 字符串	对象的名称已返回：成功
port 整数	前端连接的端口已返回：成功
preservehost 布尔值	保留主机头已返回：成功
profile 字符串	关联的 reverse_proxy/profile 已返回：成功
status 布尔值	前端对象是否处于活动状态已返回：成功
type 字符串	连接类型已返回：成功
xheaders 布尔值	xheaders 状态已返回：成功

作者

Johannes Brunswicker (@MatrixCrawler)