fortinet.fortimanager.fmgr_system_admin_user_dashboard – Custom dashboard widgets.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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		Choices/Defaults	Comments
bypass_validation boolean		no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		present absent	the directive to create, update or delete an object
system_admin_user_dashboard dictionary			the top level parameters set
	column integer	Default: 0	Widgets column ID.
	diskio-content-type string	util ← iops blks	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.
	diskio-period string	1hour ← 8hour 24hour	Disk I/O Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour.
	log-rate-period string	2min 1hour 6hours	Log receive monitor widgets data period. 2min - 2 minutes. 1hour - 1 hour. 6hours - 6 hours.
	log-rate-topn string	1 2 3 4 5 ←	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.
	log-rate-type string	log device ←	Log receive monitor widgets statistics breakdown options. log - Show log rates for each log type. device - Show log rates for each device.
	moduleid integer	Default: 0	Widget ID.
	name string		Widget name.
	num-entries integer	Default: 10	Number of entries.
	refresh-interval integer	Default: 300	Widgets refresh interval.
	res-cpu-display string	average ← each	Widgets CPU display type. average - Average usage of CPU. each - Each usage of CPU.
	res-period string	10min hour day	Widgets data period. 10min - Last 10 minutes. hour - Last hour. day - Last day.
	res-view-type string	real-time history	Widgets data view type. real-time - Real-time view. history - History view.
	status string	close open ←	Widgets opened/closed state. close - Widget closed. open - Widget opened.
	tabid integer	Default: 0	ID of tab where widget is displayed.
	time-period string	1hour ← 8hour 24hour	Log Database Monitor widgets data period. 1hour - 1 hour. 8hour - 8 hour. 24hour - 24 hour.
	widget-type string	top-lograte sysres sysinfo licinfo jsconsole sysop alert statistics rpteng raid logrecv devsummary logdb-perf logdb-lag disk-io log-rcvd-fwd	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.
user string / required			the parameter (user) in requested url
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Custom dashboard widgets.
     fmgr_system_admin_user_dashboard:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        user: <your own value>
        state: <value in [present, absent]>
        system_admin_user_dashboard:
           column: <value of integer>
           diskio-content-type: <value in [util, iops, blks]>
           diskio-period: <value in [1hour, 8hour, 24hour]>
           log-rate-period: <value in [2min, 1hour, 6hours]>
           log-rate-topn: <value in [1, 2, 3, ...]>
           log-rate-type: <value in [log, device]>
           moduleid: <value of integer>
           name: <value of string>
           num-entries: <value of integer>
           refresh-interval: <value of integer>
           res-cpu-display: <value in [average, each]>
           res-period: <value in [10min, hour, day]>
           res-view-type: <value in [real-time, history]>
           status: <value in [close, open]>
           tabid: <value of integer>
           time-period: <value in [1hour, 8hour, 24hour]>
           widget-type: <value in [top-lograte, sysres, sysinfo, ...]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_admin_user_dashboard_module.html