community.general.ipa_dnszone 模块 – 管理 FreeIPA DNS 区域

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.general

要在 playbook 中使用它,请指定: community.general.ipa_dnszone

概要

  • 使用 IPA API 添加和删除 IPA DNS 区域

参数

参数

注释

allowsyncptr

布尔值

在 community.general 4.3.0 中添加

允许在区域中同步正向和反向记录。

选项

  • false ← (默认)

  • true

dynamicupdate

布尔值

将动态更新应用于区域。

选项

  • false ← (默认)

  • true

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"

  • "present" ← (默认)

validate_certs

布尔值

这仅在 ipa_prothttps 时适用。

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

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

选项

  • false

  • true ← (默认)

zone_name

字符串 / 必需

需要管理的 DNS 区域名称。

属性

属性

支持

描述

check_mode

支持:完全支持

可以在check_mode模式下运行,并返回更改状态预测,而无需修改目标。

diff_mode

支持:不支持

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

示例

- name: Ensure dns zone is present
  community.general.ipa_dnszone:
    ipa_host: spider.example.com
    ipa_pass: Passw0rd!
    state: present
    zone_name: example.com

- name: Ensure dns zone is present and is dynamic update
  community.general.ipa_dnszone:
    ipa_host: spider.example.com
    ipa_pass: Passw0rd!
    state: present
    zone_name: example.com
    dynamicupdate: true

- name: Ensure that dns zone is removed
  community.general.ipa_dnszone:
    zone_name: example.com
    ipa_host: localhost
    ipa_user: admin
    ipa_pass: topsecret
    state: absent

- name: Ensure dns zone is present and is allowing sync
  community.general.ipa_dnszone:
    ipa_host: spider.example.com
    ipa_pass: Passw0rd!
    state: present
    zone_name: example.com
    allowsyncptr: true

返回值

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

描述

区域

字典

IPA API返回的DNS区域。

返回值:始终返回

作者

  • Fran Fitzpatrick (@fxfitz)