:source: fmgd_report_chart.py
:orphan:
.. _fmgd_report_chart:
fmgd_report_chart -- Report chart widget configuration.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- report_chart - Report chart widget configuration. type: dict
- background Chart background. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- category Category. type: str choices: [traffic, event, virus, webfilter, attack, spam, dlp, app-ctrl, misc, vulnerability]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- category_series (Alias name: category-series) Category series. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- databind Category series value expression. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- font_size (Alias name: font-size) Font size of category-series title. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- color_palette (Alias name: color-palette) Color palette (system will pick color automatically by default). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- column Column. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- detail_unit (Alias name: detail-unit) Detail unit of column. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- detail_value (Alias name: detail-value) Detail value of column. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- footer_unit (Alias name: footer-unit) Footer unit of column. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- footer_value (Alias name: footer-value) Footer value of column. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- header_value (Alias name: header-value) Display name of table header. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mapping Mapping. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- displayname Display name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- op Comparision operater. type: str choices: [none, greater, greater-equal, less, less-equal, equal, between]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- value_type (Alias name: value-type) Value type. type: str choices: [string, integer]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- value1 Value 1. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- value2 Value 2. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- comments Comment. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dataset Bind dataset to chart. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dimension Dimension. type: str choices: [2D, 3D]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- drill_down_charts (Alias name: drill-down-charts) Drill down charts. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- chart_name (Alias name: chart-name) Drill down chart name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Drill down chart id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Enable/disable this drill down chart. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- favorite Favorite. type: str choices: [no, yes]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- graph_type (Alias name: graph-type) Graph type. type: str choices: [bar, line, pie, none, flow]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- legend Enable/disable legend area. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- legend_font_size (Alias name: legend-font-size) Font size of legend area. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Chart widget name type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- period Time period. type: str choices: [last24h, last7d]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- policy Policy. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- style Style. type: str choices: [auto, manual]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- title Chart title. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- title_font_size (Alias name: title-font-size) Font size of chart title. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- type Chart type. type: str choices: [graph, table]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- value_series (Alias name: value-series) Value series. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- databind Value series value expression. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- x_series (Alias name: x-series) X series. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- caption X-series caption. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- caption_font_size (Alias name: caption-font-size) X-series caption font size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- databind X-series value expression. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- font_size (Alias name: font-size) X-series label font size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- is_category (Alias name: is-category) X-series represent category or not. type: str choices: [no, yes]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- label_angle (Alias name: label-angle) X-series label angle. type: str choices: [45-degree, vertical, horizontal]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- scale_direction (Alias name: scale-direction) Scale increase or decrease. type: str choices: [decrease, increase]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- scale_format (Alias name: scale-format) Date/time format. type: str choices: [YYYY-MM-DD-HH-MM, YYYY-MM-DD, HH, YYYY-MM, YYYY, HH-MM, MM-DD]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- scale_step (Alias name: scale-step) Scale step. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- scale_unit (Alias name: scale-unit) Scale unit. type: str choices: [minute, hour, day, month, year]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- unit X-series unit. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- y_series (Alias name: y-series) Y series. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- caption Y-series caption. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- caption_font_size (Alias name: caption-font-size) Y-series caption font size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- databind Y-series value expression. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- extra_databind (Alias name: extra-databind) Extra y-series value. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- extra_y (Alias name: extra-y) Allow another y-series value type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- extra_y_legend (Alias name: extra-y-legend) Extra y-series legend type/name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- font_size (Alias name: font-size) Y-series label font size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- group Y-series group option. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- label_angle (Alias name: label-angle) Y-series label angle. type: str choices: [45-degree, vertical, horizontal]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- unit Y-series unit. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- y_legend (Alias name: y-legend) First y-series legend type/name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Notes
-----
.. note::
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Report chart widget configuration.
fortinet.fmgdevice.fmgd_report_chart:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
report_chart:
name: "your value" # Required variable, string
# background:
# category:
# category_series:
# databind:
# font_size:
# color_palette:
# column:
# - detail_unit:
# detail_value:
# footer_unit:
# footer_value:
# header_value:
# id:
# mapping:
# - displayname:
# id:
# op:
# value_type:
# value1:
# value2:
# comments:
# dataset:
# dimension:
# drill_down_charts:
# - chart_name:
# id:
# status:
# favorite:
# graph_type:
# legend:
# legend_font_size:
# period:
# policy:
# style:
# title:
# title_font_size:
# type:
# value_series:
# databind:
# x_series:
# caption:
# caption_font_size:
# databind:
# font_size:
# is_category:
# label_angle:
# scale_direction:
# scale_format:
# scale_step:
# scale_unit:
# unit:
# y_series:
# caption:
# caption_font_size:
# databind:
# extra_databind:
# extra_y:
# extra_y_legend:
# font_size:
# group:
# label_angle:
# unit:
# y_legend:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)