source:	fortios_report_chart.py
orphan:

fortios_report_chart -- Report chart widget 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 chart 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

Tips

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

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_chart	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_chart - Report chart widget 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_chart yes yes yes yes yes yes yes yes yes yes

background - Chart background. 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

background yes yes yes yes yes yes yes yes yes yes

category - Category. type: str choices: misc, traffic, event, virus, webfilter, attack, spam, dlp, app-ctrl, vulnerability 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`
category	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[misc]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[traffic]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[event]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[virus]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[webfilter]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[attack]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[spam]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[dlp]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[app-ctrl]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[vulnerability]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

category_series - Category series of pie chart. 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

category_series yes yes yes yes yes yes yes yes yes yes

databind - Category series value expression. 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

databind yes yes yes yes yes yes yes yes yes yes
font_size - Font size of category-series title. type: int 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

color_palette - Color palette (system will pick color automatically by default). 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

color_palette yes yes yes yes yes yes yes yes yes yes
column - Table column definition. type: list member_path: column:id 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 yes yes yes yes yes yes yes yes yes yes

detail_unit - Detail unit of column. 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

detail_unit yes yes yes yes yes yes yes yes yes yes
detail_value - Detail value of column. 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

detail_value yes yes yes yes yes yes yes yes yes yes
footer_unit - Footer unit of column. 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

footer_unit yes yes yes yes yes yes yes yes yes yes
footer_value - Footer value of column. 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

footer_value yes yes yes yes yes yes yes yes yes yes
header_value - Display name of table header. 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

header_value yes yes yes yes yes yes yes yes yes yes
id - ID. see Notes. type: int 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

id yes yes yes yes yes yes yes yes yes yes
mapping - Show detail in certain display value for certain condition. type: list member_path: column:id/mapping:id 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

mapping yes yes yes yes yes yes yes yes yes yes

displayname - Display name. 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

displayname yes yes yes yes yes yes yes yes yes yes
id - id see Notes. type: int 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

id yes yes yes yes yes yes yes yes yes yes

op - Comparision operater. type: str choices: none, greater, greater-equal, less, less-equal, equal, between 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`
op	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[none]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[greater]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[greater-equal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[less]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[less-equal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[equal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[between]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

value_type - Value type. type: str choices: integer, string 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`
value_type	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[integer]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[string]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

value1 - Value 1. 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

value1 yes yes yes yes yes yes yes yes yes yes
value2 - Value 2. 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

value2 yes yes yes yes yes yes yes yes yes yes

comments - Comment. 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

comments yes yes yes yes yes yes yes yes yes yes
dataset - Bind dataset to chart. 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

dataset yes yes yes yes yes yes yes yes yes yes

dimension - Dimension. type: str choices: 2D, 3D 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`
dimension	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[2D]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[3D]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

drill_down_charts - Drill down charts. type: list member_path: drill_down_charts:id 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

drill_down_charts yes yes yes yes yes yes yes yes yes yes

chart_name - Drill down chart name. 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

chart_name yes yes yes yes yes yes yes yes yes yes
id - Drill down chart ID. see Notes. type: int 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

id yes yes yes yes yes yes yes yes yes yes

status - Enable/disable this drill down chart. type: str choices: enable, disable 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`
status	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

favorite - Favorite. type: str choices: no, yes 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`
favorite	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[no]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[yes]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

graph_type - Graph type. type: str choices: none, bar, pie, line, flow 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`
graph_type	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[none]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[bar]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[pie]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[line]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[flow]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

legend - Enable/Disable Legend area. type: str choices: enable, disable 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`
legend	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

legend_font_size - Font size of legend area. type: int 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

legend_font_size yes yes yes yes yes yes yes yes yes yes
name - Chart Widget 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

period - Time period. type: str choices: last24h, last7d 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`
period	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[last24h]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[last7d]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

policy - Used by monitor policy. type: int 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

policy yes yes yes yes yes yes yes yes yes yes

style - Style. type: str choices: auto, manual 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`
style	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[auto]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[manual]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

title - Chart title. 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

title yes yes yes yes yes yes yes yes yes yes
title_font_size - Font size of chart title. type: int 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

title_font_size yes yes yes yes yes yes yes yes yes yes

type - Chart type. type: str choices: graph, table 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`
type	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[graph]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[table]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

value_series - Value series of pie chart. 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

value_series yes yes yes yes yes yes yes yes yes yes

databind - Value series value expression. 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

databind yes yes yes yes yes yes yes yes yes yes

x_series - X-series of chart. 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

x_series yes yes yes yes yes yes yes yes yes yes

caption - X-series caption. 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

caption yes yes yes yes yes yes yes yes yes yes
caption_font_size - X-series caption font size. type: int 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

caption_font_size yes yes yes yes yes yes yes yes yes yes
databind - X-series value expression. 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

databind yes yes yes yes yes yes yes yes yes yes
font_size - X-series label font size. type: int 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

is_category - X-series represent category or not. type: str choices: yes, no 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`
is_category	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[yes]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[no]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

label_angle - X-series label angle. type: str choices: 45-degree, vertical, horizontal 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`
label_angle	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[45-degree]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[vertical]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[horizontal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

scale_direction - Scale increase or decrease. type: str choices: decrease, increase 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`
scale_direction	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[decrease]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[increase]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

scale_format - Date/time format. type: str choices: YYYY-MM-DD-HH-MM, YYYY-MM-DD HH, YYYY-MM-DD, YYYY-MM, YYYY, HH-MM, MM-DD 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`
scale_format	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[YYYY-MM-DD-HH-MM]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[YYYY-MM-DD HH]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[YYYY-MM-DD]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[YYYY-MM]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[YYYY]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[HH-MM]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[MM-DD]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

scale_step - Scale step. type: int 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

scale_step yes yes yes yes yes yes yes yes yes yes

scale_unit - Scale unit. type: str choices: minute, hour, day, month, year 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`
scale_unit	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[minute]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[hour]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[day]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[month]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[year]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

unit - X-series unit. 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

unit yes yes yes yes yes yes yes yes yes yes

y_series - Y-series of chart. 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

y_series yes yes yes yes yes yes yes yes yes yes

caption - Y-series caption. 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

caption yes yes yes yes yes yes yes yes yes yes
caption_font_size - Y-series caption font size. type: int 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

caption_font_size yes yes yes yes yes yes yes yes yes yes
databind - Y-series value expression. 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

databind yes yes yes yes yes yes yes yes yes yes
extra_databind - Extra Y-series value. 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

extra_databind yes yes yes yes yes yes yes yes yes yes

extra_y - Allow another Y-series value type: str choices: enable, disable 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`
extra_y	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

extra_y_legend - Extra Y-series legend type/name. 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

extra_y_legend yes yes yes yes yes yes yes yes yes yes
font_size - Y-series label font size. type: int 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
group - Y-series group option. 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

group yes yes yes yes yes yes yes yes yes yes

label_angle - Y-series label angle. type: str choices: 45-degree, vertical, horizontal 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`
label_angle	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[45-degree]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[vertical]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
[horizontal]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

unit - Y-series unit. 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

unit yes yes yes yes yes yes yes yes yes yes
y_legend - First Y-series legend type/name. 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

y_legend 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 chart widget configuration.
    fortios_report_chart:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_chart:
        background: "<your_own_value>"
        category: "misc"
        category_series:
            databind: "<your_own_value>"
            font_size: "10"
        color_palette: "<your_own_value>"
        column:
         -
            detail_unit: "<your_own_value>"
            detail_value: "<your_own_value>"
            footer_unit: "<your_own_value>"
            footer_value: "<your_own_value>"
            header_value: "<your_own_value>"
            id:  "15"
            mapping:
             -
                displayname: "<your_own_value>"
                id:  "18"
                op: "none"
                value_type: "integer"
                value1: "<your_own_value>"
                value2: "<your_own_value>"
        comments: "<your_own_value>"
        dataset: "<your_own_value>"
        dimension: "2D"
        drill_down_charts:
         -
            chart_name: "<your_own_value>"
            id:  "28"
            status: "enable"
        favorite: "no"
        graph_type: "none"
        legend: "enable"
        legend_font_size: "2147483647"
        name: "default_name_34"
        period: "last24h"
        policy: "2147483647"
        style: "auto"
        title: "<your_own_value>"
        title_font_size: "2147483647"
        type: "graph"
        value_series:
            databind: "<your_own_value>"
        x_series:
            caption: "<your_own_value>"
            caption_font_size: "10"
            databind: "<your_own_value>"
            font_size: "10"
            is_category: "yes"
            label_angle: "45-degree"
            scale_direction: "decrease"
            scale_format: "YYYY-MM-DD-HH-MM"
            scale_step: "32767"
            scale_unit: "minute"
            unit: "<your_own_value>"
        y_series:
            caption: "<your_own_value>"
            caption_font_size: "10"
            databind: "<your_own_value>"
            extra_databind: "<your_own_value>"
            extra_y: "enable"
            extra_y_legend: "<your_own_value>"
            font_size: "10"
            group: "<your_own_value>"
            label_angle: "45-degree"
            unit: "<your_own_value>"
            y_legend: "<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_chart.rst

fortios_report_chart.rst

fortios_report_chart -- Report chart widget configuration in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_report_chart.rst

Latest commit

History

fortios_report_chart.rst

File metadata and controls

fortios_report_chart -- Report chart widget configuration in Fortinet's FortiOS and FortiGate.