fortinet.fortios.fortios_report_layout module – Report layout configuration in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_report_layout.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and layout category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Report layout configuration. |
|
Configure report body item. |
|
Report item chart name. |
|
Report chart options. Choices:
|
|
Report section column number. |
|
Report item text content. |
|
Description. |
|
Control how drill down charts are shown. |
|
Control whether keys from the parent being combined or not. |
|
Enable/disable hide item in report. Choices:
|
|
Report item ID. see <a href=’#notes’>Notes</a>. |
|
Report item image file name. |
|
Configure report list item. |
|
List entry content. |
|
List entry ID. see <a href=’#notes’>Notes</a>. |
|
Report item list component. Choices:
|
|
Report item miscellaneous component. Choices:
|
|
Parameters. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Field name that match field of parameters defined in dataset. |
|
Value to replace corresponding field of parameters defined in dataset. |
|
Report item style. |
|
Table chart caption style. |
|
Report item table column widths. |
|
Table chart even row style. |
|
Table chart head style. |
|
Table chart odd row style. |
|
Report item text component. Choices:
|
|
Report section title. |
|
Value of top. |
|
Report item type. Choices:
|
|
Cutoff-option is either run-time or custom. Choices:
|
|
Custom cutoff time to generate report (format = hh:mm). |
|
Schedule days of week to generate report. Choices:
|
|
Description. |
|
Email recipients for generated reports. |
|
Enable/disable sending emails after reports are generated. Choices:
|
|
Report format. Choices:
|
|
Maximum number of PDF reports to keep at one time (oldest report is overwritten). |
|
Report layout name. |
|
Report layout options. Choices:
|
|
Configure report page. |
|
Report page auto column break before heading. Choices:
|
|
Configure report page footer. |
|
Configure report footer item. |
|
Report item text content. |
|
Description. |
|
Report item ID. see <a href=’#notes’>Notes</a>. |
|
Report item image file name. |
|
Report item style. |
|
Report item type. Choices:
|
|
Report footer style. |
|
Configure report page header. |
|
Configure report header item. |
|
Report item text content. |
|
Description. |
|
Report item ID. see <a href=’#notes’>Notes</a>. |
|
Report item image file name. |
|
Report item style. |
|
Report item type. Choices:
|
|
Report header style. |
|
Report page options. Choices:
|
|
Report page auto page break before heading. Choices:
|
|
Report page paper. Choices:
|
|
Report schedule type. Choices:
|
|
Report style theme. |
|
Report subtitle. |
|
Schedule time to generate report (format = hh:mm). |
|
Report title. |
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- 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>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |