fortinet.fortios.fortios_report_setting 模块 – 在 Fortinet FortiOS 和 FortiGate 中配置报告设置。

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortios.fortios_report_setting。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

在执行此模块的主机上需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

string

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

enable_log

boolean

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

选项

  • false ← (默认)

  • true

member_path

string

要操作的成员属性路径。

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

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

member_state

string

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

当指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

report_setting

dictionary

报告设置配置。

fortiview

string

启用/禁用历史 FortiView。

选项

  • "enable"

  • "disable"

pdf_report

string

启用/禁用 PDF 报告。

选项

  • "enable"

  • "disable"

report_source

list / elements=string

报告日志源。

选项

  • "forward-traffic"

  • "sniffer-traffic"

  • "local-deny-traffic"

top_n

integer

要填充的项目数 (1000 - 20000)。

web_browsing_threshold

integer

Web 浏览时间计算阈值（3 - 15 分钟）。

vdom

string

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

默认: "root"

注释

注意

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

示例

- name: Report setting configuration.
  fortinet.fortios.fortios_report_setting:
      vdom: "{{ vdom }}"
      report_setting:
          fortiview: "enable"
          pdf_report: "enable"
          report_source: "forward-traffic"
          top_n: "1000"
          web_browsing_threshold: "3"

返回值

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

键

描述

build

string

Fortigate 镜像的构建号

返回: 总是

示例: "1547"

http_method

string

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

返回: 总是

示例: "PUT"

http_status

string

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

返回: 总是

示例: "200"

mkey

string

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

返回: 成功

示例: "id"

name

string

用于满足请求的表名称

返回: 总是

示例: "urlfilter"

path

string

用于满足请求的表的路径

返回: 总是

示例: "webfilter"

revision

string

内部修订号

返回: 总是

示例: "17.0.2.10658"

serial

string

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

status

string

指示操作的结果

返回: 总是

示例: "success"

vdom

string

使用的虚拟域

返回: 总是

示例: "root"

version

string

FortiGate 的版本

返回: 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)