source:	fortios_report_style.py
orphan:

fortios_report_style -- Report style configuration 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 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.14

Tips

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

FortiOS Version Compatibility

	Supported Version Ranges
fortios_report_style	`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_style - Report style configuration. type: dict more...

Supported Version Ranges

report_style v6.0.0 -> v6.4.4

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

Supported Version Ranges

align v6.0.0 -> v6.4.4

[left] v6.0.0 -> latest
[center] v6.0.0 -> latest
[right] v6.0.0 -> latest
[justify] v6.0.0 -> latest
bg_color - Background color. type: str more...

Supported Version Ranges

bg_color v6.0.0 -> v6.4.4
border_bottom - Border bottom. type: str more...

Supported Version Ranges

border_bottom v6.0.0 -> v6.4.4
border_left - Border left. type: str more...

Supported Version Ranges

border_left v6.0.0 -> v6.4.4
border_right - Border right. type: str more...

Supported Version Ranges

border_right v6.0.0 -> v6.4.4
border_top - Border top. type: str more...

Supported Version Ranges

border_top v6.0.0 -> v6.4.4
column_gap - Column gap. type: str more...

Supported Version Ranges

column_gap v6.0.0 -> v6.4.4
column_span - Column span. type: str choices: none, all more...

Supported Version Ranges

column_span v6.0.0 -> v6.4.4

[none] v6.0.0 -> latest
[all] v6.0.0 -> latest
fg_color - Foreground color. type: str more...

Supported Version Ranges

fg_color v6.0.0 -> v6.4.4
font_family - Font family. type: str choices: Verdana, Arial, Helvetica, Courier, Times more...

Supported Version Ranges

font_family v6.0.0 -> v6.4.4

[Verdana] v6.0.0 -> latest
[Arial] v6.0.0 -> latest
[Helvetica] v6.0.0 -> latest
[Courier] v6.0.0 -> latest
[Times] v6.0.0 -> latest
font_size - Font size. type: str more...

Supported Version Ranges

font_size v6.0.0 -> v6.4.4
font_style - Font style. type: str choices: normal, italic more...

Supported Version Ranges

font_style v6.0.0 -> v6.4.4

[normal] v6.0.0 -> latest
[italic] v6.0.0 -> latest
font_weight - Font weight. type: str choices: normal, bold more...

Supported Version Ranges

font_weight v6.0.0 -> v6.4.4

[normal] v6.0.0 -> latest
[bold] v6.0.0 -> latest
height - Height. type: str more...

Supported Version Ranges

height v6.0.0 -> v6.4.4
line_height - Text line height. type: str more...

Supported Version Ranges

line_height v6.0.0 -> v6.4.4
margin_bottom - Margin bottom. type: str more...

Supported Version Ranges

margin_bottom v6.0.0 -> v6.4.4
margin_left - Margin left. type: str more...

Supported Version Ranges

margin_left v6.0.0 -> v6.4.4
margin_right - Margin right. type: str more...

Supported Version Ranges

margin_right v6.0.0 -> v6.4.4
margin_top - Margin top. type: str more...

Supported Version Ranges

margin_top v6.0.0 -> v6.4.4
name - Report style name. type: str required: true more...

Supported Version Ranges

name v6.0.0 -> v6.4.4

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

	Supported Version Ranges
options	`v6.0.0 -> v6.4.4`
[font]	`v6.0.0 -> latest`
[text]	`v6.0.0 -> latest`
[color]	`v6.0.0 -> latest`
[align]	`v6.0.0 -> latest`
[size]	`v6.0.0 -> latest`
[margin]	`v6.0.0 -> latest`
[border]	`v6.0.0 -> latest`
[padding]	`v6.0.0 -> latest`
[column]	`v6.0.0 -> latest`

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

Supported Version Ranges

padding_bottom v6.0.0 -> v6.4.4
padding_left - Padding left. type: str more...

Supported Version Ranges

padding_left v6.0.0 -> v6.4.4
padding_right - Padding right. type: str more...

Supported Version Ranges

padding_right v6.0.0 -> v6.4.4
padding_top - Padding top. type: str more...

Supported Version Ranges

padding_top v6.0.0 -> v6.4.4
width - Width. type: str more...

Supported Version Ranges

width v6.0.0 -> v6.4.4

Notes

Note

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

Examples

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

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

	Supported Version Ranges
align	`v6.0.0 -> v6.4.4`
[left]	`v6.0.0 -> latest`
[center]	`v6.0.0 -> latest`
[right]	`v6.0.0 -> latest`
[justify]	`v6.0.0 -> latest`

	Supported Version Ranges
column_span	`v6.0.0 -> v6.4.4`
[none]	`v6.0.0 -> latest`
[all]	`v6.0.0 -> latest`

	Supported Version Ranges
font_family	`v6.0.0 -> v6.4.4`
[Verdana]	`v6.0.0 -> latest`
[Arial]	`v6.0.0 -> latest`
[Helvetica]	`v6.0.0 -> latest`
[Courier]	`v6.0.0 -> latest`
[Times]	`v6.0.0 -> latest`

	Supported Version Ranges
font_style	`v6.0.0 -> v6.4.4`
[normal]	`v6.0.0 -> latest`
[italic]	`v6.0.0 -> latest`

	Supported Version Ranges
font_weight	`v6.0.0 -> v6.4.4`
[normal]	`v6.0.0 -> latest`
[bold]	`v6.0.0 -> latest`

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.