Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_report_theme.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
| enable_log boolean |
| Enable/Disable logging for task. | |
| report_theme dictionary | Report themes configuration | ||
| bullet_list_style string | Bullet list style. | ||
| column_count string |
| Report page column count. | |
| default_html_style string | Default HTML report style. | ||
| default_pdf_style string | Default PDF report style. | ||
| graph_chart_style string | Graph chart style. | ||
| heading1_style string | Report heading style. | ||
| heading2_style string | Report heading style. | ||
| heading3_style string | Report heading style. | ||
| heading4_style string | Report heading style. | ||
| hline_style string | Horizontal line style. | ||
| image_style string | Image style. | ||
| name string / required | Report theme name. | ||
| normal_text_style string | Normal text style. | ||
| numbered_list_style string | Numbered list style. | ||
| page_footer_style string | Report page footer style. | ||
| page_header_style string | Report page header style. | ||
| page_orient string |
| Report page orientation. | |
| page_style string | Report page style. | ||
| report_subtitle_style string | Report subtitle style. | ||
| report_title_style string | Report title style. | ||
| table_chart_caption_style string | Table chart caption style. | ||
| table_chart_even_row_style string | Table chart even row style. | ||
| table_chart_head_style string | Table chart head row style. | ||
| table_chart_odd_row_style string | Table chart odd row style. | ||
| table_chart_style string | Table chart style. | ||
| toc_heading1_style string | Table of contents heading style. | ||
| toc_heading2_style string | Table of contents heading style. | ||
| toc_heading3_style string | Table of contents heading style. | ||
| toc_heading4_style string | Table of contents heading style. | ||
| toc_title_style string | Table of contents title style. | ||
| state string / required |
| Indicates whether to create or remove the object. | |
| vdom string | Default: "root" | 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. | |
Note
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Report themes configuration
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>"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build string | always | Build number of the fortigate image Sample: 1547 |
| http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
| http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
| mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
| name string | always | Name of the table used to fulfill the request Sample: urlfilter |
| path string | always | Path of the table used to fulfill the request Sample: webfilter |
| revision string | always | Internal revision number Sample: 17.0.2.10658 |
| serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
| status string | always | Indication of the operation's result Sample: success |
| vdom string | always | Virtual domain used Sample: root |
| version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_report_theme_module.html