fortinet.fortios.fortios_system_dns_database 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 DNS 数据库。

注意

此模块是 fortinet.fortios 集合(版本 2.3.8)的一部分。

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_dns_database

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 dns_database 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值都需要在使用前调整到数据源。已使用 FOS v6.0.0 进行测试

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选择

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果存在多个属性,则以斜杠字符分隔。

用 member_path 标记的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时,将忽略 state 选项。

选择

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选择

  • "present"

  • "absent"

system_dns_database

字典

配置 DNS 数据库。

allow_transfer

列表 / elements=字符串

DNS 区域传输 IP 地址列表。

authoritative

字符串

启用/禁用权威区域。

选择

  • "enable"

  • "disable"

contact

字符串

此区域的管理员的电子邮件地址。您可以仅指定用户名,例如 admin,或完整的电子邮件地址,例如 admin@test.com。仅使用用户名时,电子邮件的域将是此区域。

dns_entry

列表 / elements=字典

DNS 条目。

canonical_name

字符串

主机的规范名称。

hostname

字符串

主机的名称。

id

整数 / 必需

DNS 条目 ID。请参阅 <a href='#notes'>注释</a>。

ip

字符串

主机的 IPv4 地址。

ipv6

字符串

主机的 IPv6 地址。

preference

整数

DNS 条目首选项(0 - 65535,最高首选项 = 0)。

status

字符串

启用/禁用资源记录状态。

选择

  • "enable"

  • "disable"

ttl

整数

此条目的生存时间(0 到 2147483647 秒)。

type

字符串

资源记录类型。

选择

  • "A"

  • "NS"

  • "CNAME"

  • "MX"

  • "AAAA"

  • "PTR"

  • "PTR_V6"

domain

字符串

域名。

forwarder

列表 / elements=字符串

DNS 区域转发器 IP 地址列表。

forwarder6

字符串

转发器 IPv6 地址。

ip_master

字符串

主 DNS 服务器的 IP 地址。此主 DNS 服务器中的条目会导入到 DNS 区域中。

ip_primary

字符串

主 DNS 服务器的 IP 地址。此主 DNS 服务器中的条目会导入到 DNS 区域中。

name

字符串 / 必需

区域名称。

primary_name

字符串

此区域的默认 DNS 服务器的域名。

rr_max

整数

资源记录的最大数量(10 - 65536,0 表示无限)。

source_ip

字符串

转发到 DNS 服务器的源 IP。

source_ip6

字符串

转发到 DNS 服务器的 IPv6 源 IP 地址。

source_ip_interface

字符串

指定接口的 IP 地址作为源 IP 地址。源 system.interface.name。

status

字符串

启用/禁用此 DNS 区域。

选择

  • "enable"

  • "disable"

ttl

整数

此 DNS 区域的条目的默认生存时间值(0 - 2147483647 秒)。

type

字符串

区域类型(primary 直接管理条目,secondary 从其他区域导入条目)。

选择

  • "primary"

  • "secondary"

  • "master"

  • "slave"

view

字符串

区域视图(public 为公共客户端提供服务,shadow 为内部客户端提供服务)。

选择

  • "shadow"

  • "public"

  • "shadow-ztna"

  • "proxy"

vdom

字符串

虚拟域,在之前定义的域中。vdom 是 FortiGate 的虚拟实例,可以配置为不同的单元并使用。

默认: "root"

注释

注意

  • 已弃用旧版 fortiosapi,httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure DNS databases.
  fortinet.fortios.fortios_system_dns_database:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_dns_database:
          allow_transfer: "<your_own_value>"
          authoritative: "enable"
          contact: "<your_own_value>"
          dns_entry:
              -
                  canonical_name: "<your_own_value>"
                  hostname: "myhostname"
                  id: "9"
                  ip: "<your_own_value>"
                  ipv6: "<your_own_value>"
                  preference: "10"
                  status: "enable"
                  ttl: "0"
                  type: "A"
          domain: "<your_own_value>"
          forwarder: "<your_own_value>"
          forwarder6: "<your_own_value>"
          ip_master: "<your_own_value>"
          ip_primary: "<your_own_value>"
          name: "default_name_21"
          primary_name: "<your_own_value>"
          rr_max: "16384"
          source_ip: "84.230.14.43"
          source_ip_interface: "<your_own_value> (source system.interface.name)"
          source_ip6: "<your_own_value>"
          status: "enable"
          ttl: "86400"
          type: "primary"
          view: "shadow"

返回值

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

描述

build

字符串

FortiGate 镜像的构建号

返回: 总是

示例: "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 的方法

返回: 总是

示例: "PUT"

http_status

字符串

上次应用操作时 FortiGate 给出的最后结果

返回: 总是

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主键(id)

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回: 总是

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回: 总是

示例: "webfilter"

revision

字符串

内部修订号

返回: 总是

示例: "17.0.2.10658"

serial

字符串

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回: 总是

示例: "success"

vdom

字符串

使用的虚拟域

返回: 总是

示例: "root"

version

字符串

FortiGate 的版本

返回: 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)