fortinet.fortimanager.fmgr_devprof_system_ntp 模块 – 配置系统 NTP 信息。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_devprof_system_ntp。

fortinet.fortimanager 1.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，这些参数和值需要在使用前调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ← (默认)

  • true

devprof

字符串 / 必需

请求的 URL 中的参数 (devprof)。

devprof_system_ntp

字典

设置的顶层参数。

authentication

字符串

启用/禁用身份验证。

选择

  • "disable"

  • "enable"

interface

任意

（列表）

支持元变量

FortiGate 接口

key

任意

（列表）身份验证的密钥。

key_id

别名: key-id

整数

身份验证的密钥 ID。

key_type

别名: key-type

字符串

身份验证的密钥类型

选择

  • "MD5"

  • "SHA1"

  • "SHA256"

ntpserver

列表 / 元素=字典

Ntpserver。

authentication

字符串

启用/禁用 MD5 身份验证。

选择

  • "disable"

  • "enable"

id

整数

NTP 服务器 ID。

interface

字符串

指定用于连接到服务器的传出接口。

interface_select_method

别名: interface-select-method

字符串

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

选择

  • "auto"

  • "sdwan"

  • "specify"

ip_type

别名: ip-type

字符串

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

选择

  • "IPv6"

  • "IPv4"

  • "Both"

key

任意

（列表）MD5 身份验证的密钥。

key_id

别名: key-id

整数

身份验证的密钥 ID。

key_type

别名: key-type

字符串

选择 NTP 身份验证类型。

选择

  • "SHA1"

  • "SHA256"

  • "MD5"

ntpv3

字符串

启用以使用 NTPv3 而不是 NTPv4。

选择

  • "disable"

  • "enable"

server

字符串

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

ntpsync

字符串

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

选择

  • "disable"

  • "enable"

server_mode

别名: server-mode

字符串

启用/禁用 FortiGate NTP 服务器模式。

选择

  • "disable"

  • "enable"

source_ip

别名: source-ip

字符串

支持元变量

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

source_ip6

别名: source-ip6

字符串

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

syncinterval

整数

NTP 同步间隔

type

字符串

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

选择

  • "fortiguard"

  • "custom"

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

覆盖底层 Json RPC 请求的方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是 global 和包括 root 的其他值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最长时间（以秒为单位）。

默认值: 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如 “var-name” 之类的参数更改为 “var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可以帮助完成这项工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure system NTP information.
      fortinet.fortimanager.fmgr_devprof_system_ntp:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_system_ntp:
          ntpserver:
            -
              authentication: <value in [disable, enable]>
              id: <integer>
              key: <list or string>
              key_id: <integer>
              ntpv3: <value in [disable, enable]>
              server: <string>
              interface: <string>
              interface_select_method: <value in [auto, sdwan, specify]>
              ip_type: <value in [IPv6, IPv4, Both]>
              key_type: <value in [SHA1, SHA256, MD5]>
          ntpsync: <value in [disable, enable]>
          source_ip6: <string>
          syncinterval: <integer>
          type: <value in [fortiguard, custom]>
          authentication: <value in [disable, enable]>
          key: <list or string>
          key_id: <integer>
          key_type: <value in [MD5, SHA1, SHA256]>
          interface: <list or string>
          server_mode: <value in [disable, enable]>
          source_ip: <string>

返回值

通用返回值已在此处记录 这里，以下是此模块独有的字段

键

描述

meta

字典

请求的结果。

返回: 总是

request_url

字符串

完整的请求 URL。

返回: 总是

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 总是

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 总是

response_message

字符串

API 响应的描述性消息。

返回: 总是

示例: "OK."

system_information

字典

目标系统的信息。

返回: 总是

rc

整数

请求的状态。

返回: 总是

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复合型

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)