fortinet.fortios.fortios_log_fortiguard_setting 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiCloud 日志记录。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

执行此模块的主机需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

log_fortiguard_setting

字典

配置到 FortiCloud 的日志记录。

access_config

字符串

启用/禁用 FortiCloud 对配置和数据的访问。

选项

  • "enable"

  • "disable"

conn_timeout

整数

FortiGate Cloud 连接超时（以秒为单位）。

enc_algorithm

字符串

配置用于与 FortiCloud 安全通信的 SSL 保护级别。

选项

  • "high-medium"

  • "high"

  • "low"

interface

字符串

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

interface_select_method

字符串

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

选项

  • "auto"

  • "sdwan"

  • "specify"

max_log_rate

整数

FortiCloud 最大日志速率（MBps）（0 = 无限制）。

priority

字符串

设置日志传输优先级。

选项

  • "default"

  • "low"

source_ip

字符串

用于连接 FortiCloud 的源 IP 地址。

ssl_min_proto_version

字符串

SSL/TLS 连接的最低支持协议版本。

选项

  • "default"

  • "SSLv3"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "TLSv1-3"

status

字符串

启用/禁用到 FortiCloud 的日志记录。

选项

  • "enable"

  • "disable"

upload_day

字符串

每周滚动日志的天数。

upload_interval

字符串

将日志文件上传到 FortiCloud 的频率。

选项

  • "daily"

  • "weekly"

  • "monthly"

upload_option

字符串

配置如何将日志消息发送到 FortiCloud。

选项

  • "store-and-upload"

  • "realtime"

  • "1-minute"

  • "5-minute"

upload_time

字符串

滚动日志的每日时间 (hh:mm)。

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

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

member_state

字符串

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

指定 member_state 时，将忽略状态选项。

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

注意

注意

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

示例

- name: Configure logging to FortiCloud.
  fortinet.fortios.fortios_log_fortiguard_setting:
      vdom: "{{ vdom }}"
      log_fortiguard_setting:
          access_config: "enable"
          conn_timeout: "10"
          enc_algorithm: "high-medium"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          max_log_rate: "0"
          priority: "default"
          source_ip: "84.230.14.43"
          ssl_min_proto_version: "default"
          status: "enable"
          upload_day: "<your_own_value>"
          upload_interval: "daily"
          upload_option: "store-and-upload"
          upload_time: "<your_own_value>"

返回值

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

键

描述

build

字符串

fortigate 镜像的构建编号

返回： 始终

示例： "1547"

http_method

字符串

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

返回： 始终

示例： "PUT"

http_status

字符串

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

返回： 始终

示例： "200"

mkey

字符串

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

返回： 成功

示例： "id"

name

字符串

用于满足请求的表的名称

返回： 始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回： 始终

示例: "webfilter"

修订版本

字符串

内部修订号

返回： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回： 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例: "root"

版本

字符串

FortiGate 的版本

返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)