fortinet.fortimanager.fmgr_system_admin_user_dashboard module – Custom dashboard widgets.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_admin_user_dashboard
.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Widgets column ID. |
|
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. Choices:
|
|
Deprecated, please rename it to diskio_period. Disk I/O Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour. Choices:
|
|
Deprecated, please rename it to log_rate_period. Log receive monitor widgets data period. 2min - 2 minutes. 1hour - 1 hour. 6hours - 6 hours. Choices:
|
|
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. Choices:
|
|
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. Choices:
|
|
Widget ID. |
|
Widget name. |
|
Deprecated, please rename it to num_entries. Number of entries. |
|
Deprecated, please rename it to refresh_interval. Widgets refresh interval. |
|
Deprecated, please rename it to res_cpu_display. Widgets CPU display type. average - Average usage of CPU. each - Each usage of CPU. Choices:
|
|
Deprecated, please rename it to res_period. Widgets data period. 10min - Last 10 minutes. hour - Last hour. day - Last day. Choices:
|
|
Deprecated, please rename it to res_view_type. Widgets data view type. real-time - Real-time view. history - History view. Choices:
|
|
Widgets opened/closed state. close - Widget closed. open - Widget opened. Choices:
|
|
ID of tab where widget is displayed. |
|
Deprecated, please rename it to time_period. Log Database Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour. Choices:
|
|
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. Choices:
|
|
The parameter (user) in requested url. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |