faz_cli_system_report_setting – Report settings.¶
New in version 2.10.
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.9.0
FortiAnalyzer Version Compatibility¶
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| cli_system_report_setting | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- 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
- cli_system_report_setting - Report settings. type: dict
- aggregate-report - Enable/disable including a group report along with the per-device reports. type: str choices: [disable, enable] default: disable more...
- capwap-port - Exclude capwap traffic by port. type: int default: 5246 more...
- capwap-service - Exclude capwap traffic by service. type: str more...
- exclude-capwap - Exclude capwap traffic. type: str choices: [disable, by-port, by-service] default: by-port more...
- hcache-lossless - Usableness of ready-with-loss hcaches. type: str choices: [disable, enable] default: disable more...
- ldap-cache-timeout - LDAP cache timeout in minutes, default 60, 0 means not use cache. type: int default: 60 more...
- max-table-rows - Maximum number of rows can be generated in a single table. type: int default: 10000 more...
- report-priority - Priority of sql report. type: str choices: [high, low, auto] default: auto more...
- template-auto-install - The language used for new ADOMs (default = default). type: str choices: [default, english] default: default more...
- week-start - Day of the week on which the week starts. type: str choices: [sun, mon] default: sun more...
- max-rpt-pdf-rows - Maximum number of rows can be generated in a single pdf. type: int default: 100000 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¶
- collections:
- fortinet.fortianalyzer
connection: httpapi
hosts: fortianalyzer-inventory
tasks:
- faz_cli_system_report_setting:
cli_system_report_setting:
aggregate-report: disable
capwap-port: <value of integer>
capwap-service: <value of string>
exclude-capwap: <value in [disable, by-port, by-service]>
hcache-lossless: disable
ldap-cache-timeout: <value of integer>
max-table-rows: <value of integer>
report-priority: <value in [high, low, auto]>
template-auto-install: <value in [default, english]>
week-start: <value in [sun, mon]>
name: Report settings.
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict