fortinet.fortios.fortios_system_vdom_dns 模块 – 配置 Fortinet FortiOS 和 FortiGate 中非管理型 VDOM 的 DNS 服务器。

注意

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

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

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

要在剧本中使用它,请指定: fortinet.fortios.fortios_system_vdom_dns

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备,允许用户设置和修改系统功能和 vdom_dns 类别。示例包括所有参数,在使用前需要将值调整为数据源。已在 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"

system_vdom_dns

字典

配置非管理型 VDOM 的 DNS 服务器。

alt_primary

字符串

备用主 DNS 服务器。这不用作故障转移 DNS 服务器。

alt_secondary

字符串

备用次要 DNS 服务器。这不用作故障转移 DNS 服务器。

dns_over_tls

字符串

启用/禁用/强制执行 DNS over TLS。

选项

  • "disable"

  • "enable"

  • "enforce"

interface

字符串

指定到达服务器的出站接口。来源 system.interface.name。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

ip6_primary

字符串

VDOM 的主 IPv6 DNS 服务器 IP 地址。

ip6_secondary

字符串

VDOM 的次要 IPv6 DNS 服务器 IP 地址。

primary

字符串

VDOM 的主 DNS 服务器 IP 地址。

protocol

列表 / 元素=字符串

DNS 传输协议。

选项

  • "cleartext"

  • "dot"

  • "doh"

secondary

字符串

VDOM 的次要 DNS 服务器 IP 地址。

server_hostname

列表 / 元素=字典

DNS 服务器主机名列表。

hostname

字符串 / 必需

以空格分隔的 DNS 服务器主机名列表(最多 4 个域)。

server_select_method

字符串

指定如何优先考虑已配置的服务器。

选项

  • "least-rtt"

  • "failover"

source_ip

字符串

与 DNS 服务器通信的源 IP。

ssl_certificate

字符串

SSL 连接的本地证书名称。来源 certificate.local.name。

vdom_dns

字符串

启用/禁用为当前 VDOM 配置 DNS 服务器。

选项

  • "enable"

  • "disable"

vdom

字符串

虚拟域,在先前定义的那些域中。VDOM 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。

默认值: "root"

备注

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行剧本的首选方法。

示例

- name: Configure DNS servers for a non-management VDOM.
  fortinet.fortios.fortios_system_vdom_dns:
      vdom: "{{ vdom }}"
      system_vdom_dns:
          alt_primary: "<your_own_value>"
          alt_secondary: "<your_own_value>"
          dns_over_tls: "disable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ip6_primary: "<your_own_value>"
          ip6_secondary: "<your_own_value>"
          primary: "<your_own_value>"
          protocol: "cleartext"
          secondary: "<your_own_value>"
          server_hostname:
              -
                  hostname: "myhostname"
          server_select_method: "least-rtt"
          source_ip: "84.230.14.43"
          ssl_certificate: "<your_own_value> (source certificate.local.name)"
          vdom_dns: "enable"

返回值

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

描述

build

字符串

FortiGate 映像的版本号

返回: 始终

示例: "1547"

http_method

字符串

最后用于将内容置备到 FortiGate 的方法

返回: 始终

示例: "PUT"

http_status

字符串

FortiGate 在最后一次应用的操作中给出的最后结果

返回: 始终

示例: "200"

mkey

字符串

最后一次调用 FortiGate 时使用的主密钥 (id)

返回: 成功

示例: "id"

name

字符串

用于完成请求的表名称

返回: 始终

示例: "urlfilter"

路径

字符串

用于完成请求的表路径

返回: 始终

示例: "webfilter"

版本号

字符串

内部版本号

返回: 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果指示

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

版本

字符串

FortiGate 版本

返回: 始终

示例: "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪宾 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)