fortios_report_theme – Report themes configuratio 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.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - 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. type: str required: False choices: present, absent
- report_theme - Report themes configuration type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- bullet_list_style - Bullet list style. type: str
- column_count - Report page column count. type: str choices: 1, 2, 3
- default_html_style - Default HTML report style. type: str
- default_pdf_style - Default PDF report style. type: str
- graph_chart_style - Graph chart style. type: str
- heading1_style - Report heading style. type: str
- heading2_style - Report heading style. type: str
- heading3_style - Report heading style. type: str
- heading4_style - Report heading style. type: str
- hline_style - Horizontal line style. type: str
- image_style - Image style. type: str
- name - Report theme name. type: str required: True
- normal_text_style - Normal text style. type: str
- numbered_list_style - Numbered list style. type: str
- page_footer_style - Report page footer style. type: str
- page_header_style - Report page header style. type: str
- page_orient - Report page orientation. type: str choices: portrait, landscape
- page_style - Report page style. type: str
- report_subtitle_style - Report subtitle style. type: str
- report_title_style - Report title style. type: str
- table_chart_caption_style - Table chart caption style. type: str
- table_chart_even_row_style - Table chart even row style. type: str
- table_chart_head_style - Table chart head row style. type: str
- table_chart_odd_row_style - Table chart odd row style. type: str
- table_chart_style - Table chart style. type: str
- toc_heading1_style - Table of contents heading style. type: str
- toc_heading2_style - Table of contents heading style. type: str
- toc_heading3_style - Table of contents heading style. type: str
- toc_heading4_style - Table of contents heading style. type: str
- toc_title_style - Table of contents title style. type: str
Examples¶
- 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>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3