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 boolean 在 community.general 6.6.0 中添加	如果为 `true`，则将列出的 `host` 添加到 `hostgroup`。如果为 `false`，则只有列出的 `host` 会在 `hostgroup` 中，删除任何其他主机。选择 `false` ←（默认） `true`
cn 别名：name string / 必选	主机组的名称。不能更改，因为它是唯一的标识符。
description string	描述。
host list / elements=string	属于主机组的主机列表。如果传递空列表，则所有主机将从组中删除。如果省略此选项，则不会检查或更改主机。如果传递此选项，则所有未传递的已分配主机将从组中取消分配。
hostgroup list / elements=string	属于该主机组的主机组列表。如果传递空列表，则所有主机组将从组中删除。如果省略此选项，则不会检查或更改主机组。如果传递此选项，则所有未传递的已分配主机组将从组中取消分配。
ipa_host string	IPA 服务器的 IP 或主机名。如果任务中未指定该值，则将使用环境变量 `IPA_HOST` 的值。如果任务中未指定环境变量 `IPA_HOST` 和该值，则将使用 DNS 尝试发现 FreeIPA 服务器。 FreeIPA 中需要的相关条目是 `ipa-ca` 条目。如果任务中既没有 DNS 条目，也没有环境变量 `IPA_HOST`，也没有该值，则将使用默认值。默认： `"ipa.example.com"`
ipa_pass string	管理用户的密码。如果任务中未指定该值，则将使用环境变量 `IPA_PASS` 的值。请注意，如果 `urllib_gssapi` 库可用，则可以使用 GSSAPI 向 FreeIPA 进行身份验证。如果环境变量 `KRB5CCNAME` 可用，则该模块将使用此 Kerberos 凭据缓存向 FreeIPA 服务器进行身份验证。如果环境变量 `KRB5_CLIENT_KTNAME` 可用，并且 `KRB5CCNAME` 不可用；该模块将使用此 Kerberos 密钥表进行身份验证。如果 GSSAPI 不可用，则需要使用 `ipa_pass`。
ipa_port integer	FreeIPA / IPA 服务器的端口。如果任务中未指定该值，则将使用环境变量 `IPA_PORT` 的值。如果任务中未指定环境变量 `IPA_PORT` 和该值，则将设置默认值。默认： `443`
ipa_prot string	IPA 服务器使用的协议。如果任务中未指定该值，则将使用环境变量 `IPA_PROT` 的值。如果任务中未指定环境变量 `IPA_PROT` 和该值，则将设置默认值。选择 `"http"` `"https"` ←（默认）
ipa_timeout integer	指定连接的空闲超时时间（以秒为单位）。对于批量操作，您可能需要增加此值，以避免来自 IPA 服务器的超时。如果任务中未指定该值，则将使用环境变量 `IPA_TIMEOUT` 的值。如果环境变量 `IPA_TIMEOUT` 和任务中均未指定该值，则将设置默认值。默认值： `10`
ipa_user string	在 IPA 服务器上使用的管理帐户。如果任务中未指定该值，则将使用环境变量 `IPA_USER` 的值。如果环境变量 `IPA_USER` 和任务中均未指定该值，则将设置默认值。默认值： `"admin"`
state string	要确保的状态。 `"absent"` 和 `"disabled"` 的效果相同。 `"present"` 和 `"enabled"` 的效果相同。选择 `"absent"` `"disabled"` `"enabled"` `"present"` ← (默认)
validate_certs boolean	仅当 `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)