community.general.ipa_host 模块 – 管理 FreeIPA 主机

注意

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

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

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

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

概要

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

参数

参数

注释

description

字符串

此主机的描述。

force

布尔值

即使不在 DNS 中也强制使用主机名。

选择

  • false

  • true

force_creation

布尔值

在 community.general 9.5.0 中添加

如果 state=disabled 或 state=enabled，但不存在，则创建主机。

选择

  • false

  • true ← (默认)

fqdn

别名：name

字符串 / 必需

完全限定域名。

不能更改，因为它是唯一标识符。

ip_address

字符串

使用此 IP 地址将主机添加到 DNS。

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 keytab 进行身份验证。

如果 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"

mac_address

别名: macaddress

列表 / 元素=字符串

此主机的硬件 MAC 地址列表。

如果省略此选项，则不会检查或更改 MAC 地址。

如果传递一个空列表，则将删除所有已分配的 MAC 地址。

已分配但未传递的 MAC 地址将被删除。

ns_hardware_platform

别名: nshardwareplatform

字符串

主机硬件平台（例如，“Lenovo T61”）

ns_host_location

别名: nshostlocation

字符串

主机位置（例如，“Lab 2”）

ns_os_version

别名: nsosversion

字符串

主机操作系统和版本（例如，“Fedora 9”）

random_password

布尔值

生成一个随机密码，用于批量注册。

选择

  • false

  • true

state

字符串

要确保的状态。

选择

  • "absent"

  • "disabled"

  • "enabled"

  • "present" ← (默认)

update_dns

布尔值

如果设置为 true 并且 state=absent，则会删除由 FreeIPA DNS 管理的主机的 DNS 记录。

此选项对 “absent” 以外的状态无效。

选择

  • false

  • true

user_certificate

别名: usercertificate

列表 / 元素=字符串

Base64 编码的服务器证书列表。

如果省略此选项，则不会检查或更改证书。

如果传递一个空列表，则将删除所有已分配的证书。

已分配但未传递的证书将被删除。

validate_certs

布尔值

仅当 ipa_prot 为 https 时适用。

如果设置为 false，则不会验证 SSL 证书。

仅在个人控制的使用自签名证书的站点上才应将其设置为 false。

选择

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 中运行，并返回已更改状态预测，而无需修改目标。

diff_mode

支持: 无

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

示例

- name: Ensure host is present
  community.general.ipa_host:
    name: host01.example.com
    description: Example host
    ip_address: 192.168.0.123
    ns_host_location: Lab
    ns_os_version: CentOS 7
    ns_hardware_platform: Lenovo T61
    mac_address:
    - "08:00:27:E3:B1:2D"
    - "52:54:00:BD:97:1E"
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Generate a random password for bulk enrolment
  community.general.ipa_host:
    name: host01.example.com
    description: Example host
    ip_address: 192.168.0.123
    state: present
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    random_password: true

- name: Ensure host is disabled
  community.general.ipa_host:
    name: host01.example.com
    state: disabled
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

- name: Ensure that all user certificates are removed
  community.general.ipa_host:
    name: host01.example.com
    user_certificate: []
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

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

- name: Ensure host and its DNS record is absent
  community.general.ipa_host:
    name: host01.example.com
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    update_dns: true

返回值

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

键

描述

host

字典

IPA API 返回的主机。

返回: 总是

host_diff

列表 / 元素=字符串

不同并且会更改的选项列表

返回: 如果检查模式并发现差异

作者

  • Thomas Krahn (@Nosmoht)