openstack.cloud.dns_zone_info 模块 – 获取 DNS 区域信息

注意

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

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

要安装它，请使用： ansible-galaxy collection install openstack.cloud。您需要其他需求才能使用此模块，请参阅 需求 以了解详情。

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

概要

  • 获取 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

字符串

区域所有者的电子邮件

仅适用于主区域。

interface

别名：endpoint_type

字符串

从服务目录中获取的端点 URL 类型。

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

name

字符串

区域名称。

region_name

字符串

区域名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 日志文件的路径。如果为空，则不写入日志

timeout

整数

Ansible 应等待请求资源多长时间。

默认值： 180

ttl

整数

以秒为单位的 TTL（生存时间）值。

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: Fetch all DNS zones
  openstack.cloud.dns_zones:
    cloud: devstack

- name: Fetch DNS zones by name
  openstack.cloud.dns_zones:
    cloud: devstack
    name: ansible.test.zone.

返回值

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

键

描述

zones

列表 / 元素=字典

描述 DNS 区域的字典。

返回：当 *state* 为 present 时成功。

action

字符串

资源上正在进行的当前操作。

返回：success

示例： "CREATE"

属性

字典

关于此区域以及用户希望将区域放置到的池的信息的键值对。调度程序可以使用此信息将区域放置到正确的池中。

返回：success

示例： {"ha": "true", "tier": "gold"}

创建时间

字符串

资源创建的日期/时间。

返回：success

示例： "2014-07-07T18:25:31.275934"

description

字符串

此区域的描述。

返回：success

示例： "This is an example zone."

email

字符串

区域的电子邮件地址。用于区域的 SOA 记录中。

返回：success

示例： "[email protected]"

ID

整数

资源的 ID。

返回：success

示例： "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"

字典

指向资源和其他相关资源的链接。如果响应被分成多个页面，我们将包含一个应遵循的下一个链接以检索所有结果。

返回：success

示例： {"self": "https://127.0.0.1:9001/v2/zones/a86dba...d5e86f3ca3"}

主服务器

列表 / 元素=字符串

从中复制以获取 DNS 信息的服务器。次要区域必须指定。

返回：success

示例： ["[]"]

name

字符串

区域的 DNS 名称。

返回：success

示例： "test.test."

池ID

字符串

托管此区域的池的 ID。

返回：success

示例： "a86dba58-0043-4cc6-a1bb-69d5e86f3ca3"

项目ID

字符串

拥有此资源的项目的 ID。

返回：success

示例： "4335d1f0-f793-11e2-b778-0800200c9a66"

序列号

整数

区域的当前序列号。

返回：success

示例： 1404757531

状态

字符串

资源的状态。

返回：success

示例： "ACTIVE"

ttl

整数

区域的 TTL（生存时间）。

返回：success

示例： 7200

type

字符串

区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域是从另一个 DNS 服务器复制的。默认为 PRIMARY。

返回：success

示例： "PRIMARY"

更新时间

字符串

资源上次更新的日期/时间。

返回：success

示例： "2014-07-07T18:25:31.275934"

作者

  • OpenStack Ansible SIG