- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# fortios_report_style – Report style 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 (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.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 | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
report_style dictionary | Default: null | Report style configuration.
| align string | Choices: left center right justify | Alignment.
| bg_color string |  | Background color.
| border_bottom string |  | Border bottom.
| border_left string |  | Border left.
| border_right string |  | Border right.
| border_top string |  | Border top.
| column_gap string |  | Column gap.
| column_span string | Choices: none all | Column span.
| fg_color string |  | Foreground color.
| font_family string | Choices: Verdana Arial Helvetica Courier Times | Font family.
| font_size string |  | Font size.
| font_style string | Choices: normal italic | Font style.
| font_weight string | Choices: normal bold | Font weight.
| height string |  | Height.
| line_height string |  | Text line height.
| margin_bottom string |  | Margin bottom.
| margin_left string |  | Margin left.
| margin_right string |  | Margin right.
| margin_top string |  | Margin top.
| name string / required |  | Report style name.
| options string | Choices: font text color align size margin border padding column | Report style options.
| padding_bottom string |  | Padding bottom.
| padding_left string |  | Padding left.
| padding_right string |  | Padding right.
| padding_top string |  | Padding top.
| state string | Choices: present absent | Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
| width string |  | Width.
ssl_verify boolean added in 2.9 | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9 | Choices: present absent | 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 style configuration.
        fortios_report_style:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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 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.