fortinet.fortios.fortios_system_ddns 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 DDNS。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_ddns。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 ddns 类别来配置 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_ddns

字典

配置 DDNS。

addr_type

字符串

DDNS 更新中接口地址的地址类型。

选项

  • "ipv4"

  • "ipv6"

bound_ip

字符串

绑定的 IP 地址。

clear_text

字符串

启用/禁用使用明文连接。

选项

  • "disable"

  • "enable"

ddns_auth

字符串

启用/禁用您的 DDNS 服务器的 TSIG 身份验证。

选项

  • "disable"

  • "tsig"

ddns_domain

字符串

您的完全限定域名。例如，yourname.ddns.com。

ddns_key

字符串

DDNS 更新密钥（base 64 编码）。

ddns_keyname

字符串

DDNS 更新密钥名称。

ddns_password

字符串

DDNS 密码。

ddns_server

字符串

选择 DDNS 服务提供商。

选项

  • "dyndns.org"

  • "dyns.net"

  • "tzo.com"

  • "vavic.com"

  • "dipdns.net"

  • "now.net.cn"

  • "dhs.org"

  • "easydns.com"

  • "genericDDNS"

  • "FortiGuardDDNS"

  • "noip.com"

ddns_server_addr

列表 / 元素=字典

通用 DDNS 服务器 IP/FQDN 列表。

addr

字符串 / 必填

服务器的 IP 地址或 FQDN。

ddns_server_ip

字符串

通用 DDNS 服务器 IP。

ddns_sn

字符串

DDNS 序列号。

ddns_ttl

整数

DDNS 数据包的生存时间。

ddns_username

字符串

DDNS 用户名。

ddns_zone

字符串

您的域名区域（例如，DDNS.com）。

ddnsid

整数 / 必填

DDNS ID。请参阅 <a href=’#notes’>注释</a>。

monitor_interface

列表 / 元素=字典

被监控的接口。

interface_name

字符串 / 必填

接口名称。源 system.interface.name。

server_type

字符串

DDNS 服务器的地址类型。

选项

  • "ipv4"

  • "ipv6"

ssl_certificate

字符串

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

update_interval

整数

DDNS 更新间隔（60 - 2592000 秒，0 表示默认）。

use_public_ip

字符串

启用/禁用使用公共 IP 地址。

选项

  • "disable"

  • "enable"

vdom

字符串

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

默认值： "root"

注释

注意

  • 我们强烈建议您使用自己的值作为 ddnsid，而不是 0，虽然 “0” 是一个特殊占位符，允许后端为对象分配最新的可用编号，但它确实存在限制。请在问答中查找更多详细信息。

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

  • 该模块支持 check_mode。

示例

- name: Configure DDNS.
  fortinet.fortios.fortios_system_ddns:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_ddns:
          addr_type: "ipv4"
          bound_ip: "<your_own_value>"
          clear_text: "disable"
          ddns_auth: "disable"
          ddns_domain: "<your_own_value>"
          ddns_key: "<your_own_value>"
          ddns_keyname: "<your_own_value>"
          ddns_password: "<your_own_value>"
          ddns_server: "dyndns.org"
          ddns_server_addr:
              -
                  addr: "<your_own_value>"
          ddns_server_ip: "<your_own_value>"
          ddns_sn: "<your_own_value>"
          ddns_ttl: "300"
          ddns_username: "<your_own_value>"
          ddns_zone: "<your_own_value>"
          ddnsid: "<you_own_value>"
          monitor_interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          server_type: "ipv4"
          ssl_certificate: "<your_own_value> (source certificate.local.name)"
          update_interval: "300"
          use_public_ip: "disable"

返回值

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

键

描述

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)