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

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_chart

dictionary

报告图表小部件配置。

background

string

图表背景。

category

string

类别。

选项

  • "misc"

  • "traffic"

  • "event"

  • "virus"

  • "webfilter"

  • "attack"

  • "spam"

  • "dlp"

  • "app-ctrl"

  • "vulnerability"

category_series

dictionary

饼图的类别系列。

databind

string

类别系列值表达式。

font_size

integer

类别系列标题的字体大小。

color_palette

string

颜色调色板（默认情况下，系统会自动选择颜色）。

column

list / elements=dictionary

表格列定义。

detail_unit

string

列的详细单位。

detail_value

string

列的详细值。

string

列的页脚单位。

string

列的页脚值。

header_value

string

表格标题的显示名称。

id

integer / required

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

mapping

list / elements=dictionary

在特定条件下以特定显示值显示详细信息。

displayname

string

显示名称。

id

integer / required

id 请参阅 <a href=’#notes’>注释</a>。

op

string

比较运算符。

选项

  • "none"

  • "greater"

  • "greater-equal"

  • "less"

  • "less-equal"

  • "equal"

  • "between"

value1

string

值 1。

value2

string

值 2。

value_type

string

值类型。

选项

  • "integer"

  • "string"

comments

string

注释。

dataset

string

将数据集绑定到图表。

dimension

string

维度。

选项

  • "2D"

  • "3D"

drill_down_charts

list / elements=dictionary

向下钻取图表。

chart_name

string

向下钻取图表名称。

id

integer / required

向下钻取图表 ID。请参阅 <a href=’#notes’>注释</a>。

status

string

启用/禁用此向下钻取图表。

选项

  • "enable"

  • "disable"

favorite

string

收藏夹。

选项

  • "no"

  • "yes"

graph_type

string

图表类型。

选项

  • "none"

  • "bar"

  • "pie"

  • "line"

  • "flow"

legend

string

启用/禁用图例区域。

选项

  • "enable"

  • "disable"

legend_font_size

integer

图例区域的字体大小。

name

string / required

图表小部件名称

period

string

时间段。

选项

  • "last24h"

  • "last7d"

policy

integer

由监视器策略使用。

style

string

样式。

选项

  • "auto"

  • "manual"

title

string

图表标题。

title_font_size

integer

图表标题的字体大小。

type

string

图表类型。

选项

  • "graph"

  • "table"

value_series

dictionary

饼图的值系列。

databind

string

值系列值表达式。

x_series

dictionary

图表的 X 轴系列。

caption

string

X 轴系列标题。

caption_font_size

integer

X 轴系列标题字体大小。

databind

string

X 轴系列值表达式。

font_size

integer

X 轴系列标签字体大小。

is_category

string

X 轴系列是否表示类别。

选项

  • "yes"

  • "no"

label_angle

string

X 轴系列标签角度。

选项

  • "45-degree"

  • "vertical"

  • "horizontal"

scale_direction

string

刻度增加或减少。

选项

  • "decrease"

  • "increase"

scale_format

string

日期/时间格式。

选项

  • "YYYY-MM-DD-HH-MM"

  • "YYYY-MM-DD HH"

  • "YYYY-MM-DD"

  • "YYYY-MM"

  • "YYYY"

  • "HH-MM"

  • "MM-DD"

scale_step

integer

刻度步长。

scale_unit

string

刻度单位。

选项

  • "minute"

  • "hour"

  • "day"

  • "month"

  • "year"

unit

string

X 轴系列单位。

y_series

dictionary

图表的 Y 轴系列。

caption

string

Y 轴系列标题。

caption_font_size

integer

Y 轴系列标题字体大小。

databind

string

Y 轴系列值表达式。

extra_databind

string

额外的 Y 轴系列值。

extra_y

string

允许另一个 Y 轴系列值

选项

  • "enable"

  • "disable"

extra_y_legend

string

额外的 Y 轴系列图例类型/名称。

font_size

integer

Y 轴系列标签字体大小。

group

string

Y 轴系列分组选项。

label_angle

string

Y 轴系列标签角度。

选项

  • "45-degree"

  • "vertical"

  • "horizontal"

unit

string

Y 轴系列单位。

y_legend

string

第一个 Y 轴系列图例类型/名称。

state

string / required

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

选项

  • "present"

  • "absent"

vdom

string

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

默认值： "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Report chart widget configuration.
  fortinet.fortios.fortios_report_chart:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_chart:
          background: "<your_own_value>"
          category: "misc"
          category_series:
              databind: "<your_own_value>"
              font_size: "10"
          color_palette: "<your_own_value>"
          column:
              -
                  detail_unit: "<your_own_value>"
                  detail_value: "<your_own_value>"
                  footer_unit: "<your_own_value>"
                  footer_value: "<your_own_value>"
                  header_value: "<your_own_value>"
                  id: "15"
                  mapping:
                      -
                          displayname: "<your_own_value>"
                          id: "18"
                          op: "none"
                          value_type: "integer"
                          value1: "<your_own_value>"
                          value2: "<your_own_value>"
          comments: "<your_own_value>"
          dataset: "<your_own_value>"
          dimension: "2D"
          drill_down_charts:
              -
                  chart_name: "<your_own_value>"
                  id: "28"
                  status: "enable"
          favorite: "no"
          graph_type: "none"
          legend: "enable"
          legend_font_size: "2147483647"
          name: "default_name_34"
          period: "last24h"
          policy: "2147483647"
          style: "auto"
          title: "<your_own_value>"
          title_font_size: "2147483647"
          type: "graph"
          value_series:
              databind: "<your_own_value>"
          x_series:
              caption: "<your_own_value>"
              caption_font_size: "10"
              databind: "<your_own_value>"
              font_size: "10"
              is_category: "yes"
              label_angle: "45-degree"
              scale_direction: "decrease"
              scale_format: "YYYY-MM-DD-HH-MM"
              scale_step: "32767"
              scale_unit: "minute"
              unit: "<your_own_value>"
          y_series:
              caption: "<your_own_value>"
              caption_font_size: "10"
              databind: "<your_own_value>"
              extra_databind: "<your_own_value>"
              extra_y: "enable"
              extra_y_legend: "<your_own_value>"
              font_size: "10"
              group: "<your_own_value>"
              label_angle: "45-degree"
              unit: "<your_own_value>"
              y_legend: "<your_own_value>"

返回值

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

键

描述

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)