fortinet.fortios.fortios_report_dataset 模块 – 在 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_dataset。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改报表功能和数据集类别来配置 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"

report_dataset

字典

报表数据集配置。

field

列表 / 元素=字典

字段。

displayname

字符串

显示名称。

id

整数 / 必需

字段 ID（1 到 SQL 结果中的列数）。请参阅 <a href=’#notes’>说明</a>。

name

字符串

名称。

type

字符串

字段类型。

选择

  • "text"

  • "integer"

  • "double"

name

字符串 / 必需

名称。

parameters

列表 / 元素=字典

参数。

data_type

字符串

数据类型。

选择

  • "text"

  • "integer"

  • "double"

  • "long-integer"

  • "date-time"

display_name

字符串

显示名称。

field

字符串

SQL 字段名称。

id

整数 / 必需

参数 ID（1 到 SQL 结果中的列数）。请参阅 <a href=’#notes’>说明</a>。

policy

整数

由监视策略使用。

query

字符串

SQL 查询语句。

state

字符串 / 必需

指示是否创建或删除对象。

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

说明

注意

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

  • 该模块支持 check_mode。

示例

- name: Report dataset configuration.
  fortinet.fortios.fortios_report_dataset:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_dataset:
          field:
              -
                  displayname: "<your_own_value>"
                  id: "5"
                  name: "default_name_6"
                  type: "text"
          name: "default_name_8"
          parameters:
              -
                  data_type: "text"
                  display_name: "<your_own_value>"
                  field: "<your_own_value>"
                  id: "13"
          policy: "2147483647"
          query: "<your_own_value>"

返回值

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

键

描述

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)