fortinet.fortimanager.fmgr_system_admin_user_dashboard module – no description
Note
This module is part of the fortinet.fortimanager collection (version 2.1.7).
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 1.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 |
|---|---|
Choices:
|
|
Enable/Disable logging for task Choices:
|
|
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 |
|
no description Default: |
|
no description no description no description no description Choices:
|
|
no description no description no description no description Choices:
|
|
no description no description no description no description Choices:
|
|
no description no description no description no description no description no description Choices:
|
|
no description no description no description Choices:
|
|
no description Default: |
|
no description |
|
no description Default: |
|
no description Default: |
|
no description no description no description Choices:
|
|
no description no description no description no description Choices:
|
|
no description no description no description Choices:
|
|
no description no description no description Choices:
|
|
no description Default: |
|
no description no description no description no description Choices:
|
|
no description no description no description no description no description no description no description no description no description no description no description no description no description no description no description no description no description 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
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: fortimanager00
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
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: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the dashboard widgets
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 full url requested Returned: always Sample: |
|
The status of api request Returned: always Sample: |
|
The descriptive message of the api response Returned: always Sample: |