fortinet.fortios.fortios_report_style 模块 – 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_style。

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_style

字典

报表样式配置。

align

字符串

对齐方式。

选项

  • "left"

  • "center"

  • "right"

  • "justify"

bg_color

字符串

背景颜色。

border_bottom

字符串

下边框。

border_left

字符串

左边框。

border_right

字符串

右边框。

border_top

字符串

上边框。

column_gap

字符串

列间距。

column_span

字符串

列跨度。

选项

  • "none"

  • "all"

fg_color

字符串

前景色。

font_family

字符串

字体系列。

选项

  • "Verdana"

  • "Arial"

  • "Helvetica"

  • "Courier"

  • "Times"

font_size

字符串

字体大小。

font_style

字符串

字体样式。

选项

  • "normal"

  • "italic"

font_weight

字符串

字体粗细。

选项

  • "normal"

  • "bold"

height

字符串

高度。

line_height

字符串

文本行高。

margin_bottom

字符串

下边距。

margin_left

字符串

左边距。

margin_right

字符串

右边距。

margin_top

字符串

上边距。

name

字符串 / 必需

报表样式名称。

options

列表 / 元素=字符串

报表样式选项。

选项

  • "font"

  • "text"

  • "color"

  • "align"

  • "size"

  • "margin"

  • "border"

  • "padding"

  • "column"

padding_bottom

字符串

下内边距。

padding_left

字符串

左内边距。

padding_right

字符串

右内边距。

padding_top

字符串

上内边距。

width

字符串

宽度。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Report style configuration.
  fortinet.fortios.fortios_report_style:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_style:
          align: "left"
          bg_color: "<your_own_value>"
          border_bottom: "<your_own_value>"
          border_left: "<your_own_value>"
          border_right: "<your_own_value>"
          border_top: "<your_own_value>"
          column_gap: "<your_own_value>"
          column_span: "none"
          fg_color: "<your_own_value>"
          font_family: "Verdana"
          font_size: "<your_own_value>"
          font_style: "normal"
          font_weight: "normal"
          height: "<your_own_value>"
          line_height: "<your_own_value>"
          margin_bottom: "<your_own_value>"
          margin_left: "<your_own_value>"
          margin_right: "<your_own_value>"
          margin_top: "<your_own_value>"
          name: "default_name_22"
          options: "font"
          padding_bottom: "<your_own_value>"
          padding_left: "<your_own_value>"
          padding_right: "<your_own_value>"
          padding_top: "<your_own_value>"
          width: "<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)

  • 米格尔·安赫尔·穆诺兹 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)