dux_fortinet / dux_fortinet.fortianalyzer_dev / 1.4.0 / module / faz_cli_system_admin_user_dashboard Custom dashboard widgets. | "added in version" 1.0.0 of dux_fortinet.fortianalyzer_dev" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydux_fortinet.fortianalyzer_dev.faz_cli_system_admin_user_dashboard (1.4.0) — module
Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0
collections: - name: dux_fortinet.fortianalyzer_dev version: 1.4.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook connection: httpapi hosts: fortianalyzers tasks: - name: Custom dashboard widgets. fortinet.fortianalyzer.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 vars: ansible_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
user: description: The parameter (user) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object required: true type: str log_path: default: /tmp/fortianalyzer.ansible.log description: - The path to save log. Used if enable_log is true. - Please use absolute path instead of relative path. - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str cli_system_admin_user_dashboard: description: The top level parameters set. required: false suboptions: column: description: Widgets column ID. type: int diskio-content-type: choices: - util - iops - blks description: - Disk I/O Monitor widgets chart type. - util - bandwidth utilization. - iops - the number of I/O requests. - blks - the amount of data of I/O requests. type: str diskio-period: choices: - 1hour - 8hour - 24hour description: - Disk I/O Monitor widgets data period. - 1hour - 1 hour. - 8hour - 8 hour. - 24hour - 24 hour. type: str log-rate-period: choices: - '2min ' - 1hour - 6hours description: - Log receive monitor widgets data period. - 2min - 2 minutes. - 1hour - 1 hour. - 6hours - 6 hours. type: str log-rate-topn: choices: - '1' - '2' - '3' - '4' - '5' description: - Log receive monitor widgets number of top items to display. - 1 - Top 1. - 2 - Top 2. - 3 - Top 3. - 4 - Top 4. - 5 - Top 5. type: str log-rate-type: choices: - log - device description: - Log receive monitor widgets statistics breakdown options. - log - Show log rates for each log type. - device - Show log rates for each device. type: str moduleid: description: Widget ID. type: int name: description: Widget name. type: str num-entries: description: Number of entries. type: int refresh-interval: description: Widgets refresh interval. type: int res-cpu-display: choices: - 'average ' - each description: - Widgets CPU display type. - average - Average usage of CPU. - each - Each usage of CPU. type: str res-period: choices: - '10min ' - hour - day description: - Widgets data period. - 10min - Last 10 minutes. - hour - Last hour. - day - Last day. type: str res-view-type: choices: - 'real-time ' - history description: - Widgets data view type. - real-time - Real-time view. - history - History view. type: str status: choices: - close - open description: - Widgets opened/closed state. - close - Widget closed. - open - Widget opened. type: str tabid: description: ID of tab where widget is displayed. type: int time-period: choices: - 1hour - 8hour - 24hour description: - Log Database Monitor widgets data period. - 1hour - 1 hour. - 8hour - 8 hour. - 24hour - 24 hour. type: str widget-type: choices: - top-lograte - sysres - sysinfo - licinfo - jsconsole - sysop - alert - statistics - rpteng - raid - logrecv - devsummary - logdb-perf - logdb-lag - disk-io - log-rcvd-fwd description: - Widget type. - top-lograte - Log Receive Monitor. - sysres - System resources. - sysinfo - System Information. - licinfo - License Information. - jsconsole - CLI Console. - sysop - Unit Operation. - alert - Alert Message Console. - statistics - Statistics. - rpteng - Report Engine. - raid - Disk Monitor. - logrecv - Logs/Data Received. - devsummary - Device Summary. - logdb-perf - Log Database Performance Monitor. - logdb-lag - Log Database Lag Time. - disk-io - Disk I/O. - log-rcvd-fwd - Log receive and forwarding Monitor. type: str type: dict
meta: contains: request_url: description: The full url requested returned: always sample: /sys/login/user type: str response_code: description: The status of api request returned: always sample: 0 type: int response_data: description: The api response returned: always type: list response_message: description: The descriptive message of the api response returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: complex type: list