faz_cli_system_admin_user_dashboard – Custom dashboard widgets.
New in version 1.0.0.
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
Possible variable names before 2.0.0:
variable-name,variable name,variable.nameCorresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiAnalyzer Version Compatibility
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
||
| None | True | True | True | None | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
6.4.13 |
6.4.14 |
| None | True | True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
7.0.10 |
7.0.11 |
|||
| True | True | True | True | True | True | True | True | True | True | True | True | |||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
||||||||||
| True | True | True | True | True | ||||||||||
7.4.0 |
7.4.1 |
7.4.2 |
||||||||||||
| True | True | True |
Parameters
- access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
- log_path - 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.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- user - The parameter in requested url type: str required: true
- cli_system_admin_user_dashboard - Custom dashboard widgets. type: dict
- column - Widgets column ID. type: int default: 0 more...
- diskio_content_type - Disk I/O Monitor widgets chart type. type: str choices: [util, iops, blks] default: util more...
- diskio_period - Disk I/O Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
- log_rate_period - Log receive monitor widgets data period. type: str choices: [2min , 1hour, 6hours] more...
- log_rate_topn - Log receive monitor widgets number of top items to display. type: str choices: [1, 2, 3, 4, 5] default: 5 more...
- log_rate_type - Log receive monitor widgets statistics breakdown options. type: str choices: [log, device] default: device more...
- moduleid - Widget ID. type: int default: 0 more...
- name - Widget name. type: str more...
- num_entries - Number of entries. type: int default: 10 more...
- refresh_interval - Widgets refresh interval. type: int default: 300 more...
- res_cpu_display - Widgets CPU display type. type: str choices: [average , each] default: average more...
- res_period - Widgets data period. type: str choices: [10min , hour, day] default: 10min more...
- res_view_type - Widgets data view type. type: str choices: [real-time , history] default: history more...
- status - Widgets opened/closed state. type: str choices: [close, open] default: open more...
- tabid - ID of tab where widget is displayed. type: int default: 0 more...
- time_period - Log Database Monitor widgets data period. type: str choices: [1hour, 8hour, 24hour] default: 1hour more...
- widget_type - Widget type. type: str choices: [top-lograte, sysres, sysinfo, licinfo, jsconsole, sysop, alert, statistics, rpteng, raid, logrecv, devsummary, logdb-perf, logdb-lag, disk-io, log-rcvd-fwd] more...
Notes
Note
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
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
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request. returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list
Status
This module is not guaranteed to have a backwards compatible interface.