community.general.dnsimple_info 模块 – 从 DNSimple API 获取基本信息

注意

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

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

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

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

community.general 4.2.0 中的新增功能

概要 

从 DNSimple API 检索现有记录和域名。

参数 

参数	注释
account_id 字符串 / 必需	要查询的帐户 ID。
api_key 字符串 / 必需	要使用的 API 密钥。
name 字符串	要从中检索信息的域名。如果指定，则将返回与此域名关联的所有关联记录。如果未指定，则将返回与帐户 ID 关联的所有域名。
record 字符串	要查找的记录。如果指定，则只返回此记录，而不是所有记录。
sandbox 布尔值	是否使用沙箱环境。选项 `false` ← (默认) `true`

属性 

属性	支持	描述
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: Get all domains from an account
  community.general.dnsimple_info:
    account_id: "1234"
    api_key: "1234"

- name: Get all records from a domain
  community.general.dnsimple_info:
    name: "example.com"
    account_id: "1234"
    api_key: "1234"

- name: Get all info from a matching record
  community.general.dnsimple_info:
    name: "example.com"
    record: "subdomain"
    account_id: "1234"
    api_key: "1234"

返回值 

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

键	描述
dnsimple_domain_info 列表 / 元素=字典	返回与提供的帐户 ID 关联的所有域名的字典列表。返回：当 `name` 未指定时成功示例： `[{"account_id": 1234, "created_at": "2021-10-16T21:25:42Z", "id": 123456, "last_transferred_at": null, "name": "example.com", "reverse": false, "secondary": false, "updated_at": "2021-11-10T20:22:50Z"}]`
account_id 整数	帐户 ID。返回：成功
created_at 字符串	创建域名条目时的日期。返回：成功
id 整数	条目的 ID。返回：成功
last_transferred_at 字符串	域名被转移的日期，如果没有则为空。返回：成功
name 字符串	记录的名称。返回：成功
reverse 布尔值	是否是反向区域记录。返回：成功
updated_at 字符串	更新域名条目时的日期。返回：成功
dnsimple_record_info 列表 / 元素=字典	返回与提供的记录匹配的字典列表。返回：当 `name` 和 `record` 被指定时成功示例： `[{"content": "1.2.3.4", "created_at": "2021-11-15T23:55:51Z", "id": 123456, "name": "catheadbiscuit", "parent_id": null, "priority": null, "regions": ["global"], "system_record": false, "ttl": 3600, "type": "A", "updated_at": "2021-11-15T23:55:51Z", "zone_id": "example.com"}]`
content 字符串	返回记录的内容。返回：成功
created_at 字符串	创建域名条目时的日期。返回：成功
id 整数	条目的 ID。返回：成功
name 字符串	记录的名称。返回：成功
parent_id 整数	父记录或 null。返回：成功
priority 字符串	记录的优先级设置。返回：成功
regions 列表 / 元素=字符串	记录可用的区域列表。返回：成功
system_record 布尔值	是否为系统记录。返回：成功
ttl 整数	记录 TTL（生存时间）。返回：成功
type 字符串	记录类型。返回：成功
updated_at 字符串	更新域名条目时的日期。返回：成功
zone_id 字符串	记录关联的区域ID。返回：成功
dnsimple_records_info 列表 / 元素=字典	返回一个字典列表，包含所提供域的所有记录。返回：当指定`name`但未指定`record`时返回成功示例： `[{"content": "ns1.dnsimple.com admin.dnsimple.com", "created_at": "2021-10-16T19:07:34Z", "id": 12345, "name": "catheadbiscuit", "parent_id": null, "priority": null, "regions": ["global"], "system_record": true, "ttl": 3600, "type": "SOA", "updated_at": "2021-11-15T23:55:51Z", "zone_id": "example.com"}]`
content 字符串	返回记录的内容。返回：成功
created_at 字符串	创建域名条目时的日期。返回：成功
id 整数	条目的 ID。返回：成功
name 字符串	记录的名称。返回：成功
parent_id 整数	父记录或 null。返回：成功
priority 字符串	记录的优先级设置。返回：成功
regions 列表 / 元素=字符串	记录可用的区域列表。返回：成功
system_record 布尔值	是否为系统记录。返回：成功
ttl 整数	记录 TTL（生存时间）。返回：成功
type 字符串	记录类型。返回：成功
updated_at 字符串	更新域名条目时的日期。返回：成功
zone_id 字符串	记录关联的区域ID。返回：成功

作者

Edward Hilgendorf (@edhilgendorf)