faz_cli_system_admin_user_dashboard – Custom dashboard widgets.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiAnalyzer device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiAnalyzer Version Compatibility¶
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| cli_system_admin_user_dashboard | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- 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
- user - The parameter in requested url type: str required: true
- cli_system_admin_user_dashboard - Custom dashboard widgets. type: dict
- column - Widgets column ID. type: int default: 0 more...
- diskio-content-type - Disk I/O Monitor widgets chart type. type: str choices: [util, iops, blks] default: util more...
- diskio-period - Disk I/O Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
- log-rate-period - Log receive monitor widgets data period. type: str choices: [2min , 1hour, 6hours] more...
- log-rate-topn - Log receive monitor widgets number of top items to display. type: str choices: [1, 2, 3, 4, 5] default: 5 more...
- log-rate-type - Log receive monitor widgets statistics breakdown options. type: str choices: [log, device] default: device more...
- moduleid - Widget ID. type: int default: 0 more...
- name - Widget name. type: str more...
- num-entries - Number of entries. type: int default: 10 more...
- refresh-interval - Widgets refresh interval. type: int default: 300 more...
- res-cpu-display - Widgets CPU display type. type: str choices: [average , each] default: average more...
- res-period - Widgets data period. type: str choices: [10min , hour, day] default: 10min more...
- res-view-type - Widgets data view type. type: str choices: [real-time , history] default: history more...
- status - Widgets opened/closed state. type: str choices: [close, open] default: open more...
- tabid - ID of tab where widget is displayed. type: int default: 0 more...
- time-period - Log Database Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
- widget-type - Widget type. type: str choices: [top-lograte, sysres, sysinfo, licinfo, jsconsole, sysop, alert, statistics, rpteng, raid, logrecv, devsummary, logdb-perf, logdb-lag, disk-io, log-rcvd-fwd] more...
Notes¶
Note
- 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¶
- collections:
- fortinet.fortianalyzer
connection: httpapi
hosts: fortianalyzer-inventory
tasks:
- faz_cli_system_admin_user_dashboard:
cli_system_admin_user_dashboard:
name: foodashboard
res-view-type: history
status: open
tabid: 1
time-period: 1hour
widget-type: top-lograte
state: present
user: fooadminuser
name: Custom dashboard widgets.
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict