openstack.cloud.dns_zone 模块 – 管理 OpenStack DNS 区域。

注意

此模块是 openstack.cloud 集合 (版本 2.3.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：openstack.cloud.dns_zone。

概要

• 创建、删除或更新 OpenStack DNS 区域。

要求

执行此模块的主机需要以下要求。

• python >= 3.6

• openstacksdk >= 1.0.0

参数

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。
auth 字典	包含云的认证插件策略所需的认证信息的字典。对于默认的 *password* 插件，这将包含 *auth_url*、*username*、*password*、*project_name* 和有关域的任何信息（例如，*user_domain_name* 或 *project_domain_name*），如果云支持它们的话。对于其他插件，此参数需要包含该认证插件所需的所有参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的认证插件的名称。如果云使用密码认证以外的其他认证方式，则应在此处指示插件的名称，并相应地更新 *auth* 参数的内容。
ca_cert 别名：cacert 字符串	CA 证书捆绑包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名：cert 字符串	客户端证书的路径，用作 SSL 事务的一部分。
client_key 别名：key 字符串	客户端密钥的路径，用作 SSL 事务的一部分。
cloud 任意	要操作的命名云或云配置。如果 *cloud* 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 *auth* 和 *auth_type* 提供默认值。如果提供了 *auth* 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 *cloud* 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。
description 字符串	区域描述。
email 字符串	区域所有者的电子邮件。 仅当 *type* 为 primary 时适用。
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。 选项 "admin" "internal" "public" ← (默认)
masters 列表 / 元素=字符串	主名称服务器 仅当 *type* 为 secondary 时适用。
name 字符串 / 必需	DNS 区域的名称。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选项 "INFO" ← (默认) "DEBUG"
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
state 字符串	区域应该是 present 还是 absent。 选项 "present" ← (默认) "absent"
timeout 整数	ansible 应该等待请求的资源多长时间。 默认值： 180
ttl 整数	以秒为单位的 TTL（生存时间）值。
type 别名：zone_type 字符串	区域类型。 此属性无法更新。 选项 "primary" "secondary"
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。 在 Ansible 2.3 之前，默认为 true。 选项 false true
wait 布尔值	ansible 是否应等到请求的资源完成。 选项 false true ← (默认)

备注

注意

• 可以使用标准的 OpenStack 环境变量（例如 OS_USERNAME），而不是提供显式值。

• 认证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息可在 https://docs.openstack.org/openstacksdk/ 找到。

示例

- name: Create DNS zone example.net.
  openstack.cloud.dns_zone:
    cloud: mycloud
    state: present
    name: example.net.
    type: primary
    email: [email protected]
    description: Test zone
    ttl: 3600

- name: Set TTL on DNS zone example.net.
  openstack.cloud.dns_zone:
    cloud: mycloud
    state: present
    name: example.net.
    ttl: 7200

- name: Delete zone example.net.
  openstack.cloud.dns_zone:
    cloud: mycloud
    state: absent
    name: example.net.

返回值

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

键	描述
zone 字典	描述区域的字典。 返回：当 *state* 为 present 时成功。
action 字符串	资源上正在进行的当前操作。 返回：成功 示例： "CREATE"
attributes 字典	有关此区域以及用户希望将区域放置其中的池的信息的键值对。调度程序可以使用此信息将区域放置在正确的池中。 返回：成功 示例： {"ha": "true", "tier": "gold"}
created_at 字符串	资源创建时间。 返回：成功 示例： "2014-07-07T18:25:31.275934"
description 字符串	此区域的描述。 返回：成功 示例： "这是一个示例区域。"
email 字符串	区域的电子邮件地址。用于区域的 SOA 记录。 返回：成功 示例： "[email protected]"
id 整数	资源ID。 返回：成功 示例： "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
links 字典	指向资源和其他相关资源的链接。当响应被分成多页时，我们将包含一个 next 链接，应按照该链接检索所有结果。 返回：成功 示例： {"self": "https://127.0.0.1:9001/v2/zones/a86dba...d5e86f3ca3"}
masters 列表 / 元素=字符串	用于获取 DNS 信息的从属服务器。次要区域必须配置。 返回：成功 示例： ["[]"]
name 字符串	区域的 DNS 名称。 返回：成功 示例： "test.test."
pool_id 字符串	托管此区域的池的 ID。 返回：成功 示例： "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"
project_id 字符串	拥有此资源的项目的 ID。 返回：成功 示例： "4335d1f0-f793-11e2-b778-0800200c9a66"
serial 整数	区域的当前序列号。 返回：成功 示例： 1404757531
status 字符串	资源的状态。 返回：成功 示例： "ACTIVE"
ttl 整数	区域的 TTL（生存时间）。 返回：成功 示例： 7200
type 字符串	区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域是从另一个 DNS 服务器复制的。默认为 PRIMARY。 返回：成功 示例： "PRIMARY"
updated_at 字符串	资源最后更新的日期/时间。 返回：成功 示例： "2014-07-07T18:25:31.275934"

作者

• OpenStack Ansible SIG

集合链接

• 问题追踪器
• 代码库 (源代码)