fortios_report_theme – Report themes configuration in Fortinet’s FortiOS and FortiGate

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis

This module is able to configure a FortiGate or FortiOS 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.2

Requirements

The below requirements are needed on the host that executes this module.

fortiosapi>=0.9.8

Parameters

Parameter		Choices/Defaults	Comments
host - / required			FortiOS or FortiGate ip address.
https boolean		no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol
password -		Default: ""	FortiOS or FortiGate password.
report_theme -		Default: null	Report themes configuration
	bullet-list-style -		Bullet list style.
	column-count -	1 2 3	Report page column count.
	default-html-style -		Default HTML report style.
	default-pdf-style -		Default PDF report style.
	graph-chart-style -		Graph chart style.
	heading1-style -		Report heading style.
	heading2-style -		Report heading style.
	heading3-style -		Report heading style.
	heading4-style -		Report heading style.
	hline-style -		Horizontal line style.
	image-style -		Image style.
	name - / required		Report theme name.
	normal-text-style -		Normal text style.
	numbered-list-style -		Numbered list style.
	page-footer-style -		Report page footer style.
	page-header-style -		Report page header style.
	page-orient -	portrait landscape	Report page orientation.
	page-style -		Report page style.
	report-subtitle-style -		Report subtitle style.
	report-title-style -		Report title style.
	state -	present absent	Indicates whether to create or remove the object
	table-chart-caption-style -		Table chart caption style.
	table-chart-even-row-style -		Table chart even row style.
	table-chart-head-style -		Table chart head row style.
	table-chart-odd-row-style -		Table chart odd row style.
	table-chart-style -		Table chart style.
	toc-heading1-style -		Table of contents heading style.
	toc-heading2-style -		Table of contents heading style.
	toc-heading3-style -		Table of contents heading style.
	toc-heading4-style -		Table of contents heading style.
	toc-title-style -		Table of contents title style.
username - / required			FortiOS or FortiGate username.
vdom -		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"
  tasks:
  - name: Report themes configuration
    fortios_report_theme:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      report_theme:
        state: "present"
        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.8/modules/fortios_report_theme_module.html