fortinet.fortios.fortios_report_chart module – Report chart widget configuration in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_report_chart
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Report chart widget configuration. |
|
Chart background. |
|
Category. Choices:
|
|
Category series of pie chart. |
|
Category series value expression. |
|
Font size of category-series title. |
|
Color palette (system will pick color automatically by default). |
|
Table column definition. |
|
Detail unit of column. |
|
Detail value of column. |
|
Footer unit of column. |
|
Footer value of column. |
|
Display name of table header. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Show detail in certain display value for certain condition. |
|
Display name. |
|
id see <a href=’#notes’>Notes</a>. |
|
Comparision operater. Choices:
|
|
Value 1. |
|
Value 2. |
|
Value type. Choices:
|
|
Comment. |
|
Bind dataset to chart. |
|
Dimension. Choices:
|
|
Drill down charts. |
|
Drill down chart name. |
|
Drill down chart ID. see <a href=’#notes’>Notes</a>. |
|
Enable/disable this drill down chart. Choices:
|
|
Favorite. Choices:
|
|
Graph type. Choices:
|
|
Enable/Disable Legend area. Choices:
|
|
Font size of legend area. |
|
Chart Widget Name |
|
Time period. Choices:
|
|
Used by monitor policy. |
|
Style. Choices:
|
|
Chart title. |
|
Font size of chart title. |
|
Chart type. Choices:
|
|
Value series of pie chart. |
|
Value series value expression. |
|
X-series of chart. |
|
X-series caption. |
|
X-series caption font size. |
|
X-series value expression. |
|
X-series label font size. |
|
X-series represent category or not. Choices:
|
|
X-series label angle. Choices:
|
|
Scale increase or decrease. Choices:
|
|
Date/time format. Choices:
|
|
Scale step. |
|
Scale unit. Choices:
|
|
X-series unit. |
|
Y-series of chart. |
|
Y-series caption. |
|
Y-series caption font size. |
|
Y-series value expression. |
|
Extra Y-series value. |
|
Allow another Y-series value Choices:
|
|
Extra Y-series legend type/name. |
|
Y-series label font size. |
|
Y-series group option. |
|
Y-series label angle. Choices:
|
|
Y-series unit. |
|
First Y-series legend type/name. |
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Report chart widget configuration.
fortinet.fortios.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 here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |