community.general.utm_proxy_location_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_location_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: Remove UTM proxy_location
  community.general.utm_proxy_location_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry

返回值 

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

键	描述
result 复杂	已创建的 utm 对象已返回：成功
_locked 布尔值	对象当前是否被锁定已返回：成功
_ref 字符串	对象的引用名称已返回：成功
_type 字符串	对象的类型已返回：成功
access_control 字符串	是否使用访问控制状态已返回：成功
allowed_networks 列表 / 元素=字符串	允许的网络引用名称列表已返回：成功
auth_profile 字符串	身份验证配置文件引用名称已返回：成功
backend 字符串	后端引用名称已返回：成功
be_path 字符串	后端路径已返回：成功
comment 字符串	注释字符串已返回：成功
denied_networks 列表 / 元素=字符串	拒绝的网络名称列表已返回：成功
hot_standby 布尔值	使用热备用已返回：成功
name 字符串	对象的名称已返回：成功
path 字符串	路径名称已返回：成功
status 布尔值	对象是否处于活动状态已返回：成功
stickysession_id 字符串	粘性会话的标识符已返回：成功
stickysession_status 布尔值	是否使用粘性会话已返回：成功
websocket_passthrough 布尔值	是否将使用 WebSocket 直通已返回：成功

作者

Johannes Brunswicker (@MatrixCrawler)