faz_cli_system_admin_user_dashboard – Custom dashboard widgets.
Added 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.
This module supports check mode and diff mode.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.16.0
FortiAnalyzer Version Compatibility
Supported Version Ranges: v6.2.1 -> latest
Parameters
- access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
- bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
- enable_log Enable/Disable logging for task type: bool default: False
- forticloud_access_token Access token of forticloud analyzer API users. type: str
- 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 default: "/tmp/fortianalyzer.ansible.log"
- proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
- version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
- rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
- rc_failed The rc codes list with which the conditions to fail will be overriden type: list
- 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
gather_facts: false
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_network_os: fortinet.fortianalyzer.fortianalyzer
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.