fortinet.fortios.fortios_system_ntp 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置系统 NTP 信息。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

system_ntp

字典

配置系统 NTP 信息。

authentication

字符串

启用/禁用身份验证。

选项

  • "enable"

  • "disable"

interface

列表 / 元素=字典

启用了 NTP 服务器模式的 FortiGate 接口。您网络上的设备可以联系这些接口以获取 NTP 服务。

interface_name

字符串 / 必需

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

key

字符串

用于身份验证的密钥。

key_id

整数

用于身份验证的密钥 ID。

key_type

字符串

用于身份验证的密钥类型（MD5、SHA1、SHA256）。

选项

  • "MD5"

  • "SHA1"

  • "SHA256"

ntpserver

列表 / 元素=字典

配置 FortiGate 以连接到任何可用的第三方 NTP 服务器。

authentication

字符串

启用/禁用身份验证。

选项

  • "enable"

  • "disable"

id

整数 / 必需

NTP 服务器 ID。请参阅 <a href=’#notes’>注释</a>。

interface

字符串

指定用于到达服务器的传出接口。源 system.interface.name。

interface_select_method

字符串

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

选项

  • "auto"

  • "sdwan"

  • "specify"

ip_type

字符串

选择连接到 IPv4 或/和 IPv6 NTP 服务器。

选项

  • "IPv6"

  • "IPv4"

  • "Both"

key

字符串

用于 MD5(NTPv3)/SHA1(NTPv4)/SHA256(NTPv4) 身份验证的密钥。

key_id

整数

用于身份验证的密钥 ID。

key_type

字符串

选择 NTP 身份验证类型。

选项

  • "MD5"

  • "SHA1"

  • "SHA256"

ntpv3

字符串

启用以使用 NTPv3 而不是 NTPv4。

选项

  • "enable"

  • "disable"

server

字符串

NTP 服务器的 IP 地址或主机名。

ntpsync

字符串

启用/禁用通过与 NTP 服务器同步来设置 FortiGate 系统时间。

选项

  • "enable"

  • "disable"

server_mode

字符串

启用/禁用 FortiGate NTP 服务器模式。您的 FortiGate 将成为您网络上其他设备的 NTP 服务器。FortiGate 将 NTP 请求中继到其配置的 NTP 服务器。

选项

  • "enable"

  • "disable"

source_ip

字符串

用于与 NTP 服务器通信的源 IP 地址。

source_ip6

字符串

用于与 NTP 服务器通信的源 IPv6 地址。

syncinterval

整数

NTP 同步间隔（1 - 1440 分钟）。

type

字符串

使用 FortiGuard NTP 服务器或任何其他可用的 NTP 服务器。

选项

  • "fortiguard"

  • "custom"

vdom

字符串

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

默认值： "root"

注释

注意

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

示例

- name: Configure system NTP information.
  fortinet.fortios.fortios_system_ntp:
      vdom: "{{ vdom }}"
      system_ntp:
          authentication: "enable"
          interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          key: "<your_own_value>"
          key_id: "0"
          key_type: "MD5"
          ntpserver:
              -
                  authentication: "enable"
                  id: "11"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  ip_type: "IPv6"
                  key: "<your_own_value>"
                  key_id: "0"
                  key_type: "MD5"
                  ntpv3: "enable"
                  server: "192.168.100.40"
          ntpsync: "enable"
          server_mode: "enable"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          syncinterval: "60"
          type: "fortiguard"

返回值

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

键

描述

构建

字符串

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)