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

概要 

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

参数 

参数	注释
access_control 字符串	是否激活位置的访问控制选项 `"0"` ← (默认) `"1"`
allowed_networks 列表 / 元素=字符串	允许的网络列表默认： `["REF_NetworkAny"]`
auth_profile 字符串	身份验证配置文件的引用名称默认： `""`
backend 列表 / 元素=字符串	与此位置声明连接的后端列表默认： `[]`
be_path 字符串	后端的路径默认： `""`
comment 字符串	可选的注释字符串默认： `""`
denied_networks 列表 / 元素=字符串	被拒绝的网络引用列表默认： `[]`
headers 字典	要发送到 POST 和 PUT 请求的附加标头的字典。某些模块需要此参数。默认： `{}`
hot_standby 布尔值	激活热备模式选项 `false` ← (默认) `true`
name 字符串 / 必需	对象的名称。将用于标识条目
path 字符串	位置的路径默认： `"/"`
state 字符串	对象的所需状态。 `present` 将创建或更新对象。 `absent` 如果对象存在，则将其删除。选项 `"absent"` `"present"` ← (默认)
status 布尔值	位置是否处于活动状态选项 `false` `true` ← (默认)
stickysession_id 字符串	粘性会话 ID 默认： `"ROUTEID"`
stickysession_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` ← (默认)
websocket_passthrough 布尔值	启用 WebSocket 直通选项 `false` ← (默认) `true`

属性 

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

示例 

- name: Create UTM proxy_location
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry
    backend: REF_OBJECT_STRING
    state: present

- name: Remove UTM proxy_location
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestLocationEntry
    state: absent

返回值 

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

键	描述
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)