community.general.memset_zone 模块 – 创建和删除 Memset DNS 区域

注意

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

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

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

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

概要

  • 管理 Memset 帐户中的 DNS 区域。

参数

参数

注释

api_key

字符串 / 必需

从 Memset 控制面板获取的 API 密钥。

force

布尔值

强制删除区域及其包含的所有区域域名/区域记录。

选项

  • false ← (默认)

  • true

name

别名:nickname

字符串 / 必需

区域昵称;通常与主域名相同。确保此值的字符数不超过 250 个。

state

字符串 / 必需

指示所需资源状态。

选项

  • "absent"

  • "present"

ttl

整数

区域中创建的所有记录的默认 TTL。这必须是从 https://www.memset.com/apidocs/methods_dns.html#dns.zone_create 获取的有效整数。

选项

  • 0 ← (默认)

  • 300

  • 600

  • 900

  • 1800

  • 3600

  • 7200

  • 10800

  • 21600

  • 43200

  • 86400

属性

属性

支持

描述

check_mode

支持:完全支持

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

diff_mode

支持:不支持

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

备注

注意

  • 区域可以被认为是域的逻辑组,所有这些域共享相同的 DNS 记录(即,它们指向相同的 IP)。需要通过 Memset 客户控制面板生成的 API 密钥,并具有以下最小范围 - dns.zone_createdns.zone_deletedns.zone_list

示例

# Create the zone 'test'
- name: Create zone
  community.general.memset_zone:
    name: test
    state: present
    api_key: 5eb86c9196ab03919abcf03857163741
    ttl: 300
  delegate_to: localhost

# Force zone deletion
- name: Force delete zone
  community.general.memset_zone:
    name: test
    state: absent
    api_key: 5eb86c9196ab03919abcf03857163741
    force: true
  delegate_to: localhost

返回值

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

描述

memset_api

复杂类型

来自 Memset API 的区域信息

返回:当 state == present 时

domains

列表 / 元素=字符串

此区域中的域名列表

返回:始终返回

示例: []

id

字符串

区域 ID

返回:始终返回

示例: "b0bb1ce851aeea6feeb2dc32fe83bf9c"

nickname

字符串

区域名称

返回:始终返回

示例: "example.com"

records

列表 / 元素=字符串

此区域中域的 DNS 记录列表

返回:始终返回

示例: []

ttl

整数

此区域中域的默认 TTL

返回:始终返回

示例: 300

作者

  • Simon Weald (@glitchcrab)