community.general.utm_ca_host_key_cert_info 模块 – 获取 Sophos UTM 中 ca host_key_cert 条目的信息

注意

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

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

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

要在 playbook 中使用它，请指定： community.general.utm_ca_host_key_cert_info。

概要

  • 获取 SOPHOS UTM 中 ca host_key_cert 条目的信息。

参数

参数

注释

headers

字典

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

某些模块需要。

默认值： {}

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

支持：完全支持

在 community.general 3.3.0 中添加

此操作不会修改状态。

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持： N/A

此操作不会修改状态。

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

示例

- name: Get info for a ca host_key_cert entry
  community.general.utm_ca_host_key_cert_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestHostKeyCertEntry

返回值

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

键

描述

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)