community.general.utm_dns_host 模块 – 在 Sophos UTM 中创建、更新或销毁 DNS 条目

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。

要在剧本中使用它，请指定： community.general.utm_dns_host。

概要 

在 SOPHOS UTM 中创建、更新或销毁 DNS 条目。
此模块需要激活 UTM 的 REST 功能。

参数 

参数	注释
address 字符串	条目的 IPv4 地址。可以留空以进行自动解析。默认值： `"0.0.0.0"`
address6 字符串	条目的 IPv6 地址。可以留空以进行自动解析。默认值： `"::"`
comment 字符串	添加到 dns 主机对象的可选注释默认值： `""`
headers 字典	要发送到 POST 和 PUT 请求的其他标头的字典。一些模块需要此参数。默认值： `{}`
hostname 字符串	dns 主机对象的 hostname
interface 字符串	要使用的接口的引用名称。如果未提供，将使用默认接口默认值： `""`
name 字符串 / 必需	对象的名称。将用于标识条目
resolved 布尔值	主机名的 ipv4 地址是否已解析选项 `false` ← (默认) `true`
resolved6 布尔值	主机名的 ipv6 地址是否已解析选项 `false` ← (默认) `true`
state 字符串	对象的所需状态。 `present` 将创建或更新对象。 `absent` 将删除对象（如果存在）。选项 `"absent"` `"present"` ← (默认)
timeout 整数	UTM 再次为主机名解析 IP 地址的超时时间默认值： `0`
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 dns host entry
  community.general.utm_dns_host:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestDNSEntry
    hostname: testentry.some.tld
    state: present

- name: Remove UTM dns host entry
  community.general.utm_dns_host:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestDNSEntry
    state: absent

返回值 

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

键	描述
result 复杂类型	创建的 UTM 对象返回：成功
_locked 布尔值	对象当前是否被锁定返回：成功
_ref 字符串	对象的引用名称返回：成功
address 字符串	对象的 ipv4 地址返回：成功
address6 字符串	对象的 ipv6 地址返回：成功
comment 字符串	注释字符串返回：成功
hostname 字符串	对象的 hostname 返回：成功
interface 字符串	对象关联的接口的引用名称返回：成功
name 字符串	对象的名称返回：成功
resolved 布尔值	ipv4 地址是否已解析返回：成功
resolved6 布尔值	ipv6 地址是否已解析返回：成功
timeout 整数	尝试新解析之前的超时时间返回：成功

作者

Johannes Brunswicker (@MatrixCrawler)