faz_cli_system_fortiview_setting – FortiView 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_fortiview_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_fortiview_setting - FortiView settings. type: dict
- not-scanned-apps - Include/Exclude Not. type: str choices: [exclude, include] default: include more...
- resolve-ip - Enable or disable resolving IP address to hostname in FortiView. type: str choices: [disable, enable] default: disable more...
- data-source - Data soure of the fortiview query. type: str choices: [auto, cache-only, log-and-cache] default: auto 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_fortiview_setting:
cli_system_fortiview_setting:
not-scanned-apps: exclude
resolve-ip: disable
name: FortiView 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