community.general.ipa_vault 模块 – 管理 FreeIPA 密钥库

注意

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

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

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

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

概要

  • 添加、修改和删除密钥库和秘密密钥库。

  • 应启用 KRA 服务才能使用此模块。

参数

参数

注释

cn

别名：name

字符串 / 必需

密钥库名称。

由于它是唯一标识符，因此无法更改。

description

字符串

描述。

ipa_host

字符串

IPA 服务器的 IP 地址或主机名。

如果任务中未指定此值，则将使用环境变量 IPA_HOST 的值。

如果任务中既未指定环境变量 IPA_HOST，也未指定值，则将使用 DNS 来尝试发现 FreeIPA 服务器。

FreeIPA 中所需的相应条目是 ipa-ca 条目。

如果任务中 DNS 条目、环境变量 IPA_HOST 和值均不可用，则将使用默认值。

默认值： "ipa.example.com"

ipa_pass

字符串

管理员用户的密码。

如果任务中未指定此值，则将使用环境变量 IPA_PASS 的值。

请注意，如果 urllib_gssapi 库可用，则可以使用 GSSAPI 来对 FreeIPA 进行身份验证。

如果环境变量 KRB5CCNAME 可用，则模块将使用此 Kerberos 凭据缓存来对 FreeIPA 服务器进行身份验证。

如果环境变量 KRB5_CLIENT_KTNAME 可用，而 KRB5CCNAME 不可用；则模块将使用此 Kerberos 密钥表进行身份验证。

如果 GSSAPI 不可用，则需要使用 ipa_pass。

ipa_port

整数

FreeIPA/IPA 服务器的端口。

如果任务中未指定此值，则将使用环境变量 IPA_PORT 的值。

如果任务中既未指定环境变量 IPA_PORT，也未指定值，则将设置默认值。

默认值： 443

ipa_prot

字符串

IPA 服务器使用的协议。

如果任务中未指定此值，则将使用环境变量 IPA_PROT 的值。

如果任务中既未指定环境变量 IPA_PROT，也未指定值，则将设置默认值。

选项

  • "http"

  • "https" ← (默认)

ipa_timeout

整数

指定连接的空闲超时时间（以秒为单位）。

对于批量操作，您可能需要增加此值以避免 IPA 服务器超时。

如果任务中未指定此值，则将使用环境变量 IPA_TIMEOUT 的值。

如果任务中既未指定环境变量 IPA_TIMEOUT，也未指定值，则将设置默认值。

默认值： 10

ipa_user

字符串

在 IPA 服务器上使用的管理员帐户。

如果任务中未指定此值，则将使用环境变量 IPA_USER 的值。

如果任务中既未指定环境变量 IPA_USER，也未指定值，则将设置默认值。

默认值： "admin"

ipavaultpublickey

别名: vault_public_key

字符串

公钥。

ipavaultsalt

别名: vault_salt

字符串

Vault 密钥。

ipavaulttype

别名: vault_type

字符串

Vault 类型基于安全级别。

选项

  • "asymmetric"

  • "standard"

  • "symmetric" ← (默认)

replace

布尔值

强制替换 IPA 服务器上已存在的 Vault。

选项

  • false ← (默认)

  • true

service

字符串

任何服务都可以拥有一个或多个服务 Vault。

与 user 参数互斥。

state

字符串

要确保的状态。

选项

  • "absent"

  • "present" ← (默认)

username

别名: user

列表 / 元素=字符串

任何用户都可以拥有一个或多个用户 Vault。

与 service 参数互斥。

validate_certs

布尔值

验证 IPA 服务器证书。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

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

diff_mode

支持：不支持

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

示例

- name: Ensure vault is present
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    user: user01
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure vault is present for Admin user
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure vault is absent
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    user: user01
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Modify vault if already exists
  community.general.ipa_vault:
    name: vault01
    vault_type: standard
    description: "Vault for test"
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    replace: true

- name: Get vault info if already exists
  community.general.ipa_vault:
    name: vault01
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

返回值

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

键

描述

vault

字典

IPA API 返回的 Vault。

返回值：始终返回

作者

  • Juan Manuel Parrilla (@jparrill)