community.general.utm_network_interface_address 模块 – 创建、更新或销毁网络/接口地址对象

注意

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

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

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

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

概要 

在 Sophos UTM 中创建、更新或销毁网络/接口地址对象。
此模块需要激活 UTM 的 REST 功能。

参数 

参数	注释
address 字符串 / 必填	网络/接口地址对象的 IPv4 地址。
address6 字符串	网络/接口地址对象的 IPv6 地址。
comment 字符串	添加到对象的可选注释默认值： `""`
headers 字典	要发送到 POST 和 PUT 请求的附加标头的字典。某些模块需要。默认值： `{}`
name 字符串 / 必填	对象的名称。将用于标识条目
resolved 布尔值	对象是否已解析选项 `false` `true`
resolved6 布尔值	对象是否已解析选项 `false` `true`
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	支持：不支持	可以在 `check_mode` 下运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：不支持	处于差异模式时，将返回有关更改内容（或可能需要在 `check_mode` 下更改的内容）的详细信息。

示例 

- name: Create a network interface address
  utm_proxy_backend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestNetworkInterfaceAddress
    address: 0.0.0.0
    state: present

- name: Remove a network interface address
  network_interface_address:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestNetworkInterfaceAddress
    address: 0.0.0.0
    state: absent

返回值 

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

键	描述
result 复杂类型	创建的 UTM 对象返回：成功
_locked 布尔值	对象当前是否被锁定返回：成功
_ref 字符串	对象的引用名称返回：成功
_type 字符串	对象的类型返回：成功
address 字符串	网络/接口地址对象的 IPv4 地址返回：成功
address6 字符串	网络/接口地址对象的 IPv6 地址返回：成功
comment 字符串	注释字符串返回：成功
name 字符串	对象名称返回：成功
resolved 布尔值	对象是否已解析返回：成功
resolved6 布尔值	对象是否已解析返回：成功

作者

Juergen Wiebe (@steamx)