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

概要

  • 在 Sophos UTM 中创建、更新或销毁反向代理前端条目。

  • 此模块需要激活 UTM 的 REST 功能。

参数

参数

注释

add_content_type_header

布尔值

是否添加内容类型标头

选项

  • false ← (默认)

  • true

address

字符串

网络/接口地址对象的引用名称。

默认值： "REF_DefaultInternalAddress"

allowed_networks

列表 / 元素=字符串

允许的网络的引用名称列表。

默认值： ["REF_NetworkAny"]

certificate

字符串

ca/host_key_cert 对象的引用名称。

默认值： ""

comment

字符串

添加到对象的可选注释

默认值： ""

disable_compression

布尔值

是否启用压缩

选项

  • false ← (默认)

  • true

domain

列表 / 元素=字符串

前端对象的域名列表

exceptions

列表 / 元素=字符串

异常引用名称列表 (reverse_proxy/exception)

默认值： []

headers

字典

发送到 POST 和 PUT 请求的附加标头的字典。

某些模块需要此参数。

默认值： {}

htmlrewrite

布尔值

是否启用 html 重写

选项

  • false ← (默认)

  • true

htmlrewrite_cookies

布尔值

是否启用 html 重写 cookie

选项

  • false ← (默认)

  • true

implicitredirect

布尔值

是否启用隐式重定向

选项

  • false ← (默认)

  • true

lbmethod

字符串

应使用哪种负载均衡器方法

选项

  • ""

  • "bybusyness" ← (默认)

  • "bytraffic"

  • "byrequests"

locations

列表 / 元素=字符串

位置引用名称列表 (reverse_proxy/location)

默认值： []

name

字符串 / 必需

对象的名称。将用于标识条目

port

整数

前端 HTTP 端口

默认值： 80

preservehost

布尔值

是否保留主机标头

选项

  • false ← (默认)

  • true

profile

字符串

reverse_proxy/profile 的引用字符串

默认值： ""

state

字符串

对象的所需状态。

present 将创建或更新对象。

absent 将删除存在的对象。

选项

  • "absent"

  • "present" ← (默认)

status

布尔值

是否激活前端条目

选项

  • false

  • true ← (默认)

type

字符串

应使用哪个协议

选项

  • "http" ← (默认)

  • "https"

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 ← (默认)

xheaders

布尔值

是否传递主机标头

选项

  • false ← (默认)

  • true

属性

属性

支持

描述

check_mode

支持：不支持

可以在 check_mode 下运行并返回更改状态预测，而无需修改目标。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: Create utm proxy_frontend
  community.general.utm_proxy_frontend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestFrontendEntry
    host: REF_OBJECT_STRING
    state: present

- name: Remove utm proxy_frontend
  community.general.utm_proxy_frontend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestFrontendEntry
    state: absent

返回值

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

键

描述

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

列表 / 元素=字符串

与对象关联的反向代理/位置的引用名称

返回：成功

name

字符串

对象的名称

返回：成功

port

整数

前端连接的端口

返回：成功

preservehost

布尔值

保留主机头

返回：成功

profile

字符串

关联的反向代理/配置文件

返回：成功

status

布尔值

前端对象是否处于活动状态

返回：成功

type

字符串

连接类型

返回：成功

xheaders

布尔值

xheaders 状态

返回：成功

作者

  • Johannes Brunswicker (@MatrixCrawler)