fortinet.fortios.fortios_report_layout 模块 – 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_layout。

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_layout

字典

报表布局配置。

body_item

列表 / 元素=字典

配置报表正文项。

chart

字符串

报表项图表名称。

chart_options

列表 / 元素=字符串

报表图表选项。

选择

  • "include-no-data"

  • "hide-title"

  • "show-caption"

column

整数

报表章节列号。

content

字符串

报表项文本内容。

description

字符串

描述。

drill_down_items

字符串

控制如何显示向下钻取图表。

drill_down_types

字符串

控制是否组合来自父级的键。

hide

字符串

启用/禁用报表中隐藏项目。

选择

  • "enable"

  • "disable"

id

整数 / 必需

报表项 ID。请参阅 说明。

img_src

字符串

报表项图像文件名。

list

列表 / 元素=字典

配置报表列表项。

content

字符串

列表条目内容。

id

整数 / 必需

列表条目 ID。请参阅 说明。

list_component

字符串

报表项列表组件。

选择

  • "bullet"

  • "numbered"

misc_component

字符串

报表项杂项组件。

选择

  • "hline"

  • "page-break"

  • "column-break"

  • "section-start"

parameters

列表 / 元素=字典

参数。

id

整数 / 必需

ID。请参阅 说明。

name

字符串

与数据集中定义的参数字段匹配的字段名称。

value

字符串

替换数据集中定义的相应参数字段的值。

style

字符串

报表项样式。

table_caption_style

字符串

表格图表标题样式。

table_column_widths

字符串

报表项表格列宽。

table_even_row_style

字符串

表格图表偶数行样式。

table_head_style

字符串

表格图表标题样式。

table_odd_row_style

字符串

表格图表奇数行样式。

text_component

字符串

报表项文本组件。

选择

  • "text"

  • "heading1"

  • "heading2"

  • "heading3"

title

字符串

报表章节标题。

top_n

整数

顶部的值。

type

字符串

报表项类型。

选择

  • "text"

  • "image"

  • "chart"

  • "misc"

cutoff_option

字符串

截止选项是运行时还是自定义。

选择

  • "run-time"

  • "custom"

cutoff_time

字符串

生成报表的自定义截止时间（格式 = hh:mm）。

day

字符串

生成报表的每周计划天数。

选择

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

description

字符串

描述。

email_recipients

字符串

生成报表的电子邮件收件人。

email_send

字符串

启用/禁用生成报表后发送电子邮件。

选择

  • "enable"

  • "disable"

format

列表 / 元素=字符串

报表格式。

选择

  • "pdf"

max_pdf_report

整数

一次要保留的最大 PDF 报表数量（最早的报表将被覆盖）。

name

字符串 / 必选

报表布局名称。

选项

列表 / 元素=字符串

报表布局选项。

选择

  • "include-table-of-content"

  • "auto-numbering-heading"

  • "view-chart-as-heading"

  • "show-html-navbar-before-heading"

  • "dummy-option"

页面

字典

配置报表页面。

column_break_before

列表 / 元素=字符串

在标题之前自动进行报表页面分栏。

选择

  • "heading1"

  • "heading2"

  • "heading3"

页脚

字典

配置报表页面页脚。

footer_item

列表 / 元素=字典

配置报表页脚项目。

content

字符串

报表项文本内容。

description

字符串

描述。

id

整数 / 必需

报表项 ID。请参阅 说明。

img_src

字符串

报表项图像文件名。

style

字符串

报表项样式。

type

字符串

报表项类型。

选择

  • "text"

  • "image"

style

字符串

报表页脚样式。

页眉

字典

配置报表页面页眉。

header_item

列表 / 元素=字典

配置报表页眉项目。

content

字符串

报表项文本内容。

description

字符串

描述。

id

整数 / 必需

报表项 ID。请参阅 说明。

img_src

字符串

报表项图像文件名。

style

字符串

报表项样式。

type

字符串

报表项类型。

选择

  • "text"

  • "image"

style

字符串

报表页眉样式。

选项

列表 / 元素=字符串

报表页面选项。

选择

  • "header-on-first-page"

  • "footer-on-first-page"

page_break_before

列表 / 元素=字符串

在标题之前自动进行报表页面分页。

选择

  • "heading1"

  • "heading2"

  • "heading3"

纸张

字符串

报表页面纸张。

选择

  • "a4"

  • "letter"

schedule_type

字符串

报表计划类型。

选择

  • "demand"

  • "daily"

  • "weekly"

style_theme

字符串

报表样式主题。

副标题

字符串

报表副标题。

时间

字符串

生成报表的计划时间（格式 = hh:mm）。

title

字符串

报表标题。

状态

字符串 / 必选

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

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Report layout configuration.
  fortinet.fortios.fortios_report_layout:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_layout:
          body_item:
              -
                  chart: "<your_own_value>"
                  chart_options: "include-no-data"
                  column: "2147483647"
                  content: "<your_own_value>"
                  description: "<your_own_value>"
                  drill_down_items: "<your_own_value>"
                  drill_down_types: "<your_own_value>"
                  hide: "enable"
                  id: "12"
                  img_src: "<your_own_value>"
                  list:
                      -
                          content: "<your_own_value>"
                          id: "16"
                  list_component: "bullet"
                  misc_component: "hline"
                  parameters:
                      -
                          id: "20"
                          name: "default_name_21"
                          value: "<your_own_value>"
                  style: "<your_own_value>"
                  table_caption_style: "<your_own_value>"
                  table_column_widths: "<your_own_value>"
                  table_even_row_style: "<your_own_value>"
                  table_head_style: "<your_own_value>"
                  table_odd_row_style: "<your_own_value>"
                  text_component: "text"
                  title: "<your_own_value>"
                  top_n: "0"
                  type: "text"
          cutoff_option: "run-time"
          cutoff_time: "<your_own_value>"
          day: "sunday"
          description: "<your_own_value>"
          email_recipients: "<your_own_value>"
          email_send: "enable"
          format: "pdf"
          max_pdf_report: "31"
          name: "default_name_41"
          options: "include-table-of-content"
          page:
              column_break_before: "heading1"
              footer:
                  footer_item:
                      -
                          content: "<your_own_value>"
                          description: "<your_own_value>"
                          id: "49"
                          img_src: "<your_own_value>"
                          style: "<your_own_value>"
                          type: "text"
                  style: "<your_own_value>"
              header:
                  header_item:
                      -
                          content: "<your_own_value>"
                          description: "<your_own_value>"
                          id: "58"
                          img_src: "<your_own_value>"
                          style: "<your_own_value>"
                          type: "text"
                  style: "<your_own_value>"
              options: "header-on-first-page"
              page_break_before: "heading1"
              paper: "a4"
          schedule_type: "demand"
          style_theme: "<your_own_value>"
          subtitle: "<your_own_value>"
          time: "<your_own_value>"
          title: "<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)