openstack.cloud.recordset 模块 – 管理 OpenStack DNS 记录集

注意

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

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

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

要在剧本中使用它，请指定：openstack.cloud.recordset。

概要

  • 管理 OpenStack DNS 记录集。可以创建、删除或更新记录集。只能更新 _records_、_description_ 和 _ttl_ 值。

要求

以下要求需要在执行此模块的主机上满足。

  • 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

字符串

记录集的描述

interface

别名：endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ←（默认）

name

字符串 / 必需

记录集的名称。它必须以 DNS 区域的名称结尾。

records

列表 / elements=字符串

记录集定义列表。

当 _state=present_ 时是必需的。

recordset_type

字符串

记录集类型

当 _state=present_ 时是必需的。

选项

  • "a"

  • "aaaa"

  • "mx"

  • "cname"

  • "txt"

  • "ns"

  • "srv"

  • "ptr"

  • "caa"

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ←（默认）

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

资源应该是存在还是不存在。

选项

  • "present" ←（默认）

  • "absent"

timeout

整数

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

默认值： 180

ttl

整数

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

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，默认为 true。

选项

  • false

  • true

wait

布尔值

Ansible 是否应该等待直到请求的资源完成。

选项

  • false

  • true ←（默认）

zone

字符串 / 必需

管理记录集的区域的名称或 ID

注意

注意

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

  • 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

# Create a recordset named "www.example.net."
- openstack.cloud.recordset:
    cloud: mycloud
    state: present
    zone: example.net.
    name: www.example.net.
    recordset_type: "a"
    records: ['10.1.1.1']
    description: test recordset
    ttl: 3600

# Update the TTL on existing "www.example.net." recordset
- openstack.cloud.recordset:
    cloud: mycloud
    state: present
    zone: example.net.
    name: www.example.net.
    recordset_type: "a"
    records: ['10.1.1.1']
    ttl: 7200

# Delete recordset named "www.example.net."
- openstack.cloud.recordset:
    cloud: mycloud
    state: absent
    zone: example.net.
    name: www.example.net.

返回值

通用返回值记录在这里，以下是此模块特有的字段。

键

描述

recordset

字典

描述记录集的字典。

返回： 当state为 ‘present’ 时，成功返回。

action

字符串

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

返回： 总是

created_at

字符串

区域创建的时间戳

返回： 总是

description

字符串

记录集描述

返回： 总是

示例： "测试描述"

id

字符串

唯一的记录集 ID

返回： 成功

示例： "c1c530a3-3619-46f3-b0f6-236927b2618c"

字典

与资源相关的链接

返回： 总是

name

字符串

记录集名称

返回： 总是

示例： "www.example.net."

project_id

字符串

记录集所属项目的 ID

返回： 总是

records

列表 / elements=字符串

记录集记录

返回： 总是

示例： ["10.0.0.1"]

status

字符串

记录集状态

有效值包括 `PENDING_CREATE`、`ACTIVE`、`PENDING_DELETE`、`ERROR`

返回： 总是

ttl

整数

区域 TTL 值

返回： 总是

示例： 3600

type

字符串

记录集类型

有效值包括 `A`、`AAAA`、`MX`、`CNAME`、`TXT`、`NS`、`SSHFP`、`SPF`、`SRV`、`PTR`

返回： 总是

示例： "A"

zone_id

字符串

此记录集所属的区域的 ID

返回： 总是

示例： "9508e177-41d8-434e-962c-6fe6ca880af7"

zone_name

字符串

此记录集所属的区域的名称

返回： 总是

示例： "example.com."

作者

  • OpenStack Ansible SIG