fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_admin_user_dashboard Custom dashboard widgets. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_system_admin_user_dashboard (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Custom dashboard widgets. fortinet.fortimanager.fmgr_system_admin_user_dashboard: bypass_validation: false user: ansible-test state: present system_admin_user_dashboard: column: 1 diskio-content-type: util # <value in [util, iops, blks]> diskio-period: 1hour # <value in [1hour, 8hour, 24hour]> log-rate-period: 1hour # <value in [2min , 1hour, 6hours]> log-rate-topn: 5 # <value in [1, 2, 3, ...]> log-rate-type: device # <value in [log, device]> moduleid: 10 name: ansible-test-dashboard num-entries: 10 refresh-interval: 0 res-cpu-display: "each" # <value in [average , each]> res-period: 10min # <value in [10min , hour, day]> res-view-type: history # <value in [real-time , history]> status: open # <value in [close, open]> tabid: 1 time-period: 1hour # <value in [1hour, 8hour, 24hour]> widget-type: sysres # <value in [top-lograte, sysres, sysinfo, ...]>
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the dashboard widgets fortinet.fortimanager.fmgr_fact: facts: selector: "system_admin_user_dashboard" params: user: "ansible-test" dashboard: "your_value"
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 rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int 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: - Deprecated, please rename it to diskio_content_type. - 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: - Deprecated, please rename it to diskio_period. - 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: - Deprecated, please rename it to log_rate_period. - 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: - Deprecated, please rename it to log_rate_topn. - 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: - Deprecated, please rename it to log_rate_type. - 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. required: true type: int name: description: Widget name. type: str num-entries: description: Deprecated, please rename it to num_entries. Number of entries. type: int refresh-interval: description: Deprecated, please rename it to refresh_interval. Widgets refresh interval. type: int res-cpu-display: choices: - average - each description: - Deprecated, please rename it to res_cpu_display. - Widgets CPU display type. - average - Average usage of CPU. - each - Each usage of CPU. type: str res-period: choices: - 10min - hour - day description: - Deprecated, please rename it to res_period. - Widgets data period. - 10min - Last 10 minutes. - hour - Last hour. - day - Last day. type: str res-view-type: choices: - real-time - history description: - Deprecated, please rename it to res_view_type. - 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: - Deprecated, please rename it to time_period. - 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: - Deprecated, please rename it to widget_type. - 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 FortiManager version. returned: complex type: list