fortios_report_style – Report style configuration in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • 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


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

  • ansible>=2.15


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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> v6.4.4


  • 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...
    • align - Alignment. type: str choices: left, center, right, justify more...
    • bg_color - Background color. type: str more...
    • border_bottom - Border bottom. type: str more...
    • border_left - Border left. type: str more...
    • border_right - Border right. type: str more...
    • border_top - Border top. type: str more...
    • column_gap - Column gap. type: str more...
    • column_span - Column span. type: str choices: none, all more...
    • fg_color - Foreground color. type: str more...
    • font_family - Font family. type: str choices: Verdana, Arial, Helvetica, Courier, Times more...
    • font_size - Font size. type: str more...
    • font_style - Font style. type: str choices: normal, italic more...
    • font_weight - Font weight. type: str choices: normal, bold more...
    • height - Height. type: str more...
    • line_height - Text line height. type: str more...
    • margin_bottom - Margin bottom. type: str more...
    • margin_left - Margin left. type: str more...
    • margin_right - Margin right. type: str more...
    • margin_top - Margin top. type: str more...
    • name - Report style name. type: str required: true more...
    • options - Report style options. type: list choices: font, text, color, align, size, margin, border, padding, column more...
    • padding_bottom - Padding bottom. type: str more...
    • padding_left - Padding left. type: str more...
    • padding_right - Padding right. type: str more...
    • padding_top - Padding top. type: str more...
    • width - Width. type: str more...



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


- name: Report style configuration.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
          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:, 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:
  • 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


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


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


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