fortinet.fortios.fortios_report_theme 模块 – 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_theme

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_theme

字典

报表主题配置

bullet_list_style

字符串

项目符号列表样式。

column_count

字符串

报表页面列数。

选项

  • "1"

  • "2"

  • "3"

default_html_style

字符串

默认HTML报表样式。

default_pdf_style

字符串

默认PDF报表样式。

graph_chart_style

字符串

图表样式。

heading1_style

字符串

报表标题样式。

heading2_style

字符串

报表标题样式。

heading3_style

字符串

报表标题样式。

heading4_style

字符串

报表标题样式。

hline_style

字符串

水平线样式。

image_style

字符串

图像样式。

name

字符串 / 必需

报表主题名称。

normal_text_style

字符串

普通文本样式。

numbered_list_style

字符串

编号列表样式。

字符串

报表页面页脚样式。

page_header_style

字符串

报表页面页眉样式。

page_orient

字符串

报表页面方向。

选项

  • "portrait"

  • "landscape"

page_style

字符串

报表页面样式。

report_subtitle_style

字符串

报表副标题样式。

report_title_style

字符串

报表标题样式。

table_chart_caption_style

字符串

表格图表标题样式。

table_chart_even_row_style

字符串

表格图表偶数行样式。

table_chart_head_style

字符串

表格图表表头行样式。

table_chart_odd_row_style

字符串

表格图表奇数行样式。

table_chart_style

字符串

表格图表样式。

toc_heading1_style

字符串

目录标题样式。

toc_heading2_style

字符串

目录标题样式。

toc_heading3_style

字符串

目录标题样式。

toc_heading4_style

字符串

目录标题样式。

toc_title_style

字符串

目录标题样式。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认: "root"

注释

注意

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

  • 此模块支持check_mode。

示例

- name: Report themes configuration
  fortinet.fortios.fortios_report_theme:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_theme:
          bullet_list_style: "<your_own_value>"
          column_count: "1"
          default_html_style: "<your_own_value>"
          default_pdf_style: "<your_own_value>"
          graph_chart_style: "<your_own_value>"
          heading1_style: "<your_own_value>"
          heading2_style: "<your_own_value>"
          heading3_style: "<your_own_value>"
          heading4_style: "<your_own_value>"
          hline_style: "<your_own_value>"
          image_style: "<your_own_value>"
          name: "default_name_14"
          normal_text_style: "<your_own_value>"
          numbered_list_style: "<your_own_value>"
          page_footer_style: "<your_own_value>"
          page_header_style: "<your_own_value>"
          page_orient: "portrait"
          page_style: "<your_own_value>"
          report_subtitle_style: "<your_own_value>"
          report_title_style: "<your_own_value>"
          table_chart_caption_style: "<your_own_value>"
          table_chart_even_row_style: "<your_own_value>"
          table_chart_head_style: "<your_own_value>"
          table_chart_odd_row_style: "<your_own_value>"
          table_chart_style: "<your_own_value>"
          toc_heading1_style: "<your_own_value>"
          toc_heading2_style: "<your_own_value>"
          toc_heading3_style: "<your_own_value>"
          toc_heading4_style: "<your_own_value>"
          toc_title_style: "<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)