source:	fortios_report_style.py
orphan:

fortios_report_style -- Report style configuration in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
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 style 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

FortiOS Version Compatibility

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
fortios_report_style	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

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_style - Report style configuration. type: dict more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

report_style yes yes yes yes yes yes yes yes yes yes

align - Alignment. type: str choices: left, center, right, justify more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
align	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[left]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[center]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[right]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[justify]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

bg_color - Background color. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

bg_color yes yes yes yes yes yes yes yes yes yes
border_bottom - Border bottom. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

border_bottom yes yes yes yes yes yes yes yes yes yes
border_left - Border left. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

border_left yes yes yes yes yes yes yes yes yes yes
border_right - Border right. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

border_right yes yes yes yes yes yes yes yes yes yes
border_top - Border top. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

border_top yes yes yes yes yes yes yes yes yes yes
column_gap - Column gap. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

column_gap yes yes yes yes yes yes yes yes yes yes

column_span - Column span. type: str choices: none, all more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
column_span	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[none]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[all]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

fg_color - Foreground color. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

fg_color yes yes yes yes yes yes yes yes yes yes

font_family - Font family. type: str choices: Verdana, Arial, Helvetica, Courier, Times more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
font_family	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[Verdana]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[Arial]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[Helvetica]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[Courier]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[Times]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

font_size - Font size. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

font_size yes yes yes yes yes yes yes yes yes yes

font_style - Font style. type: str choices: normal, italic more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
font_style	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[normal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[italic]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

font_weight - Font weight. type: str choices: normal, bold more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
font_weight	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[normal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[bold]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

height - Height. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

height yes yes yes yes yes yes yes yes yes yes
line_height - Text line height. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

line_height yes yes yes yes yes yes yes yes yes yes
margin_bottom - Margin bottom. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

margin_bottom yes yes yes yes yes yes yes yes yes yes
margin_left - Margin left. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

margin_left yes yes yes yes yes yes yes yes yes yes
margin_right - Margin right. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

margin_right yes yes yes yes yes yes yes yes yes yes
margin_top - Margin top. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

margin_top yes yes yes yes yes yes yes yes yes yes
name - Report style name. type: str required: true more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

name yes yes yes yes yes yes yes yes yes yes

options - Report style options. type: list choices: font, text, color, align, size, margin, border, padding, column more...

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`
options	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[font]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[text]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[color]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[align]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[size]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[margin]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[border]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[padding]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[column]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

padding_bottom - Padding bottom. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

padding_bottom yes yes yes yes yes yes yes yes yes yes
padding_left - Padding left. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

padding_left yes yes yes yes yes yes yes yes yes yes
padding_right - Padding right. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

padding_right yes yes yes yes yes yes yes yes yes yes
padding_top - Padding top. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

padding_top yes yes yes yes yes yes yes yes yes yes
width - Width. type: str more...

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4

width yes yes yes yes yes yes yes yes yes yes

Notes

Note

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

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 style configuration.
    fortios_report_style:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_style:
        align: "left"
        bg_color: "<your_own_value>"
        border_bottom: "<your_own_value>"
        border_left: "<your_own_value>"
        border_right: "<your_own_value>"
        border_top: "<your_own_value>"
        column_gap: "<your_own_value>"
        column_span: "none"
        fg_color: "<your_own_value>"
        font_family: "Verdana"
        font_size: "<your_own_value>"
        font_style: "normal"
        font_weight: "normal"
        height: "<your_own_value>"
        line_height: "<your_own_value>"
        margin_bottom: "<your_own_value>"
        margin_left: "<your_own_value>"
        margin_right: "<your_own_value>"
        margin_top: "<your_own_value>"
        name: "default_name_22"
        options: "font"
        padding_bottom: "<your_own_value>"
        padding_left: "<your_own_value>"
        padding_right: "<your_own_value>"
        padding_top: "<your_own_value>"
        width: "<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_style.rst

fortios_report_style.rst

fortios_report_style -- Report style configuration in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_report_style.rst

Latest commit

History

fortios_report_style.rst

File metadata and controls

fortios_report_style -- Report style configuration in Fortinet's FortiOS and FortiGate.