fortios_report_theme – Report themes configuration in Fortinet’s FortiOS and FortiGate
New in version 2.8.
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and theme category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
Requirements
The below requirements are needed on the host that executes this module.
- fortiosapi>=0.9.8
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host
string
|
FortiOS or FortiGate IP address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol.
|
|
password
string
|
Default:
""
|
FortiOS or FortiGate password.
|
|
report_theme
dictionary
|
Default:
null
|
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.
|
||
state
string
|
|
Deprecated
Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.
Indicates whether to create or remove the object.
|
|
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.
|
||
ssl_verify
boolean
added in 2.9
|
|
Ensures FortiGate certificate must be verified by a proper CA.
|
|
state
string
added in 2.9
|
|
Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
|
|
username
string
|
FortiOS or FortiGate username.
|
||
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.
|
Notes
Note
- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook
Examples
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Report themes configuration fortios_report_theme: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" 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>"
Return Values
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
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_report_theme_module.html