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。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定： fortinet.fortios.fortios_report_chart。

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_chart

字典

报表图表小部件配置。

background

字符串

图表背景。

category

字符串

类别。

选项

  • "misc"

  • "traffic"

  • "event"

  • "virus"

  • "webfilter"

  • "attack"

  • "spam"

  • "dlp"

  • "app-ctrl"

  • "vulnerability"

category_series

字典

饼图的类别系列。

databind

字符串

类别系列值表达式。

font_size

整数

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

color_palette

字符串

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

column

列表 / 元素=字典

表格列定义。

detail_unit

字符串

列的详细单位。

detail_value

字符串

列的详细值。

字符串

列的页脚单位。

字符串

列的页脚值。

header_value

字符串

表格标题的显示名称。

id

整数 / 必需

ID。参见 备注。

mapping

列表 / 元素=字典

根据特定条件显示特定显示值中的详细信息。

displayname

字符串

显示名称。

id

整数 / 必需

ID 参见 备注。

op

字符串

比较运算符。

选项

  • "none"

  • "greater"

  • "greater-equal"

  • "less"

  • "less-equal"

  • "equal"

  • "between"

value1

字符串

值 1。

value2

字符串

值 2。

value_type

字符串

值类型。

选项

  • "integer"

  • "string"

comments

字符串

注释。

dataset

字符串

将数据集绑定到图表。

dimension

字符串

维度。

选项

  • "2D"

  • "3D"

drill_down_charts

列表 / 元素=字典

向下钻取图表。

chart_name

字符串

向下钻取图表名称。

id

整数 / 必需

向下钻取图表 ID。参见 备注。

status

字符串

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

选项

  • "enable"

  • "disable"

favorite

字符串

收藏。

选项

  • "no"

  • "yes"

graph_type

字符串

图表类型。

选项

  • "none"

  • "bar"

  • "pie"

  • "line"

  • "flow"

legend

字符串

启用/禁用图例区域。

选项

  • "enable"

  • "disable"

legend_font_size

整数

图例区域的字体大小。

name

字符串 / 必需

图表小部件名称

period

字符串

时间段。

选项

  • "last24h"

  • "last7d"

policy

整数

由监控策略使用。

style

字符串

样式。

选项

  • "auto"

  • "manual"

title

字符串

图表标题。

title_font_size

整数

图表标题的字体大小。

type

字符串

图表类型。

选项

  • "graph"

  • "table"

value_series

字典

饼图的值系列。

databind

字符串

值系列值表达式。

x_series

字典

图表X轴系列。

标题

字符串

X轴系列标题。

标题字体大小

整数

X轴系列标题字体大小。

databind

字符串

X轴系列值表达式。

font_size

整数

X轴系列标签字体大小。

is_category

字符串

X轴系列是否代表类别。

选项

  • "yes"

  • "no"

标签角度

字符串

X轴系列标签角度。

选项

  • “45度”

  • “垂直”

  • “水平”

刻度方向

字符串

刻度递增或递减。

选项

  • “递减”

  • “递增”

刻度格式

字符串

日期/时间格式。

选项

  • “YYYY-MM-DD-HH-MM”

  • "YYYY-MM-DD "HH"

  • “YYYY-MM-DD”

  • “YYYY-MM”

  • “YYYY”

  • “HH-MM”

  • “MM-DD”

刻度步长

整数

刻度步长。

刻度单位

字符串

刻度单位。

选项

  • “分钟”

  • “小时”

  • “天”

  • “月”

  • “年”

单位

字符串

X轴系列单位。

y_series

字典

图表Y轴系列。

标题

字符串

Y轴系列标题。

标题字体大小

整数

Y轴系列标题字体大小。

databind

字符串

Y轴系列值表达式。

extra_databind

字符串

额外的Y轴系列值。

extra_y

字符串

允许另一个Y轴系列值

选项

  • "enable"

  • "disable"

extra_y_legend

字符串

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

font_size

整数

Y轴系列标签字体大小。

分组

字符串

Y轴系列分组选项。

标签角度

字符串

Y轴系列标签角度。

选项

  • “45度”

  • “垂直”

  • “水平”

单位

字符串

Y轴系列单位。

y_legend

字符串

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

状态

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在之前定义的那些域中。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

字符串

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"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪滨 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)