source:	fortios_report_theme.py
orphan:

fortios_report_theme -- Report themes configuratio in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
Tips
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_report_theme	`v6.0.0 -> v6.4.4`

Parameters

access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
enable_log - Enable/Disable logging for task. type: bool required: false default: 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
member_path - Member attribute path to operate on. type: str
member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
report_theme - Report themes configuration type: dict more...

Supported Version Ranges

report_theme v6.0.0 -> v6.4.4

bullet_list_style - Bullet list style. type: str more...

Supported Version Ranges

bullet_list_style v6.0.0 -> v6.4.4
column_count - Report page column count. type: str choices: 1, 2, 3 more...

Supported Version Ranges

column_count v6.0.0 -> v6.4.4

[1] v6.0.0 -> latest
[2] v6.0.0 -> latest
[3] v6.0.0 -> latest
default_html_style - Default HTML report style. type: str more...

Supported Version Ranges

default_html_style v6.0.0 -> v6.4.4
default_pdf_style - Default PDF report style. type: str more...

Supported Version Ranges

default_pdf_style v6.0.0 -> v6.4.4
graph_chart_style - Graph chart style. type: str more...

Supported Version Ranges

graph_chart_style v6.0.0 -> v6.4.4
heading1_style - Report heading style. type: str more...

Supported Version Ranges

heading1_style v6.0.0 -> v6.4.4
heading2_style - Report heading style. type: str more...

Supported Version Ranges

heading2_style v6.0.0 -> v6.4.4
heading3_style - Report heading style. type: str more...

Supported Version Ranges

heading3_style v6.0.0 -> v6.4.4
heading4_style - Report heading style. type: str more...

Supported Version Ranges

heading4_style v6.0.0 -> v6.4.4
hline_style - Horizontal line style. type: str more...

Supported Version Ranges

hline_style v6.0.0 -> v6.4.4
image_style - Image style. type: str more...

Supported Version Ranges

image_style v6.0.0 -> v6.4.4
name - Report theme name. type: str required: true more...

Supported Version Ranges

name v6.0.0 -> v6.4.4
normal_text_style - Normal text style. type: str more...

Supported Version Ranges

normal_text_style v6.0.0 -> v6.4.4
numbered_list_style - Numbered list style. type: str more...

Supported Version Ranges

numbered_list_style v6.0.0 -> v6.4.4
page_footer_style - Report page footer style. type: str more...

Supported Version Ranges

page_footer_style v6.0.0 -> v6.4.4
page_header_style - Report page header style. type: str more...

Supported Version Ranges

page_header_style v6.0.0 -> v6.4.4
page_orient - Report page orientation. type: str choices: portrait, landscape more...

Supported Version Ranges

page_orient v6.0.0 -> v6.4.4

[portrait] v6.0.0 -> latest
[landscape] v6.0.0 -> latest
page_style - Report page style. type: str more...

Supported Version Ranges

page_style v6.0.0 -> v6.4.4
report_subtitle_style - Report subtitle style. type: str more...

Supported Version Ranges

report_subtitle_style v6.0.0 -> v6.4.4
report_title_style - Report title style. type: str more...

Supported Version Ranges

report_title_style v6.0.0 -> v6.4.4
table_chart_caption_style - Table chart caption style. type: str more...

Supported Version Ranges

table_chart_caption_style v6.0.0 -> v6.4.4
table_chart_even_row_style - Table chart even row style. type: str more...

Supported Version Ranges

table_chart_even_row_style v6.0.0 -> v6.4.4
table_chart_head_style - Table chart head row style. type: str more...

Supported Version Ranges

table_chart_head_style v6.0.0 -> v6.4.4
table_chart_odd_row_style - Table chart odd row style. type: str more...

Supported Version Ranges

table_chart_odd_row_style v6.0.0 -> v6.4.4
table_chart_style - Table chart style. type: str more...

Supported Version Ranges

table_chart_style v6.0.0 -> v6.4.4
toc_heading1_style - Table of contents heading style. type: str more...

Supported Version Ranges

toc_heading1_style v6.0.0 -> v6.4.4
toc_heading2_style - Table of contents heading style. type: str more...

Supported Version Ranges

toc_heading2_style v6.0.0 -> v6.4.4
toc_heading3_style - Table of contents heading style. type: str more...

Supported Version Ranges

toc_heading3_style v6.0.0 -> v6.4.4
toc_heading4_style - Table of contents heading style. type: str more...

Supported Version Ranges

toc_heading4_style v6.0.0 -> v6.4.4
toc_title_style - Table of contents title style. type: str more...

Supported Version Ranges

toc_title_style v6.0.0 -> v6.4.4

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Report themes configuration
  fortinet.fortios.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

Status

This module is not guaranteed to have a backwards compatible interface.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_report_theme.rst

fortios_report_theme.rst

fortios_report_theme -- Report themes configuratio in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

	Supported Version Ranges
column_count	`v6.0.0 -> v6.4.4`
[1]	`v6.0.0 -> latest`
[2]	`v6.0.0 -> latest`
[3]	`v6.0.0 -> latest`

	Supported Version Ranges
default_html_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
numbered_list_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
page_orient	`v6.0.0 -> v6.4.4`
[portrait]	`v6.0.0 -> latest`
[landscape]	`v6.0.0 -> latest`

	Supported Version Ranges
report_subtitle_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
report_title_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
table_chart_caption_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
table_chart_even_row_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
table_chart_head_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
table_chart_odd_row_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
toc_heading1_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
toc_heading2_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
toc_heading3_style	`v6.0.0 -> v6.4.4`

	Supported Version Ranges
toc_heading4_style	`v6.0.0 -> v6.4.4`

Files

fortios_report_theme.rst

Latest commit

History

fortios_report_theme.rst

File metadata and controls

fortios_report_theme -- Report themes configuratio in Fortinet's FortiOS and FortiGate.