community.general.ipa_hostgroup 模块 – 管理 FreeIPA 主机组

注意

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

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

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

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

概要 

使用 IPA API 添加、修改和删除 IPA 主机组。

参数 

参数	注释
append 布尔值在 community.general 6.6.0 中添加	如果 `true`，则将列出的 `host` 添加到 `hostgroup`。如果 `false`，则只有列出的 `host` 将在 `hostgroup` 中，删除任何其他主机。选项 `false` ← (默认) `true`
cn 别名：name 字符串 / 必需	主机组的名称。由于它是唯一标识符，因此无法更改。
description 字符串	描述。
host 列表 / 元素=字符串	属于主机组的主机列表。如果传递空列表，则所有主机都将从组中删除。如果省略此选项，则不会检查或更改主机。如果传递此选项，则所有未传递的已分配主机都将从组中取消分配。
hostgroup 列表 / 元素=字符串	属于该主机组的主机组列表。如果传递空列表，则所有主机组都将从组中删除。如果省略此选项，则不会检查或更改主机组。如果传递此选项，则所有未传递的已分配主机组都将从组中取消分配。
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"`
state 字符串	要确保的状态。 `"absent"` 和 `"disabled"` 效果相同。 `"present"` 和 `"enabled"` 效果相同。选项 `"absent"` `"disabled"` `"enabled"` `"present"` ← (默认)
validate_certs 布尔值	这仅在`ipa_prot` 为 `https` 时适用。如果设置为`false`，则不会验证 SSL 证书。仅应在使用自签名证书的个人控制站点上将此设置为`false`。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在`check_mode`下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在`check_mode`中更改的内容）的详细信息。

示例 

- name: Ensure host-group databases is present
  community.general.ipa_hostgroup:
    name: databases
    state: present
    host:
    - db.example.com
    hostgroup:
    - mysql-server
    - oracle-server
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure host-group databases is absent
  community.general.ipa_hostgroup:
    name: databases
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

返回值 

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

键	描述
hostgroup 字典	IPA API 返回的主机组。返回：始终

作者

Thomas Krahn (@Nosmoht)