community.general.utm_ca_host_key_cert 模块 – 在 Sophos UTM 中创建、更新或删除 ca host_key_cert 条目

注意

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

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

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

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

概要 

在 SOPHOS UTM 中创建、更新或删除 ca host_key_cert 条目。
此模块需要激活 UTM 的 REST 功能。

参数 

参数	注释
ca 字符串 / 必需	对现有 utm_ca_signing_ca 或 utm_ca_verification_ca 对象的引用。
certificate 字符串 / 必需	PEM 格式的证书。
comment 字符串	可选注释字符串。
encrypted 布尔值	可选启用加密。选项 `false` ← (默认) `true`
headers 字典	要发送到 POST 和 PUT 请求的附加标头的字典。某些模块需要此参数。默认值： `{}`
key 字符串	可选的 PEM 格式私钥。
meta 字符串 / 必需	对现有 utm_ca_meta_x509 对象的引用。
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	支持：不支持	可以在 `check_mode` 下运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: Create a ca_host_key_cert entry
  community.general.utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    ca: REF_ca/signing_ca_OBJECT_STRING
    meta: REF_ca/meta_x509_OBJECT_STRING
    certificate: |
      --- BEGIN CERTIFICATE ---
      . . .
       . . .
      . . .
      --- END CERTIFICATE ---
    state: present

- name: Remove a ca_host_key_cert entry
  community.general.utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    state: absent

- name: Read a ca_host_key_cert entry
  community.general.utm_ca_host_key_cert:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry
    state: info

返回值 

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

键	描述
result 复杂类型	已创建的 utm 对象返回：成功
_locked 布尔值	对象当前是否已锁定返回：成功
_ref 字符串	对象的引用名称返回：成功
_type 字符串	对象的类型返回：成功
ca 字符串	对现有 utm_ca_signing_ca 或 utm_ca_verification_ca 对象的引用。返回：成功
certificate 字符串	PEM 格式的证书返回：成功
comment 字符串	注释字符串（可能是空字符串）返回：成功
encrypted 布尔值	是否启用加密返回：成功
key 字符串	PEM 格式的私钥（可能是空字符串）返回：成功
meta 字符串	对现有 utm_ca_meta_x509 对象的引用。返回：成功
name 字符串	对象名称返回：成功

作者

Stephan Schwarz (@stearz)