fortinet.fortios.fortios_log_fortianalyzer_override_setting module – Override FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_log_fortianalyzer_override_setting.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer feature and override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Override FortiAnalyzer settings. |
|
Hidden attribute. |
|
Enable/disable FortiAnalyzer access to configuration and data. Choices:
|
|
Alternate FortiAnalyzer. |
|
Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. |
|
Enable/disable identity verification of FortiAnalyzer by use of certificate. Choices:
|
|
FortiAnalyzer connection time-out in seconds (for status and log buffer). |
|
Configure the level of SSL protection for secure communication with FortiAnalyzer. Choices:
|
|
Enable/disable this FortiGate unit to fallback to the primary FortiAnalyzer when it is available. Choices:
|
|
Hidden setting index of FortiAnalyzer. |
|
OFTP login hash algorithm. Choices:
|
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Enable/disable IPS packet archive logging. Choices:
|
|
FortiAnalyzer maximum log rate in MBps (0 = unlimited). |
|
Hidden management name of FortiAnalyzer. |
|
Time between FortiAnalyzer connection retries in seconds (for status and log buffer). |
|
Time between OFTP keepalives in seconds (for status and log buffer). |
|
Enable/disable overriding FortiAnalyzer settings or use global settings. Choices:
|
|
Preshared-key used for auto-authorization on FortiAnalyzer. |
|
Set log transmission priority. Choices:
|
|
Enable/disable reliable logging to FortiAnalyzer. Choices:
|
|
Serial numbers of the FortiAnalyzer. |
|
Serial Number. |
|
The remote FortiAnalyzer. |
|
Mandatory CA on FortiGate in certificate chain of server. Source certificate.ca.name vpn.certificate.ca.name. |
|
Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. |
|
Minimum supported protocol version for SSL/TLS connections . Choices:
|
|
Enable/disable logging to FortiAnalyzer. Choices:
|
|
Day of week (month) to upload logs. |
|
Frequency to upload log files to FortiAnalyzer. Choices:
|
|
Enable/disable logging to hard disk and then uploading to FortiAnalyzer. Choices:
|
|
Time to upload logs (hh:mm). |
|
Enable/disable use of management VDOM IP address as source IP for logs sent to FortiAnalyzer. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Override FortiAnalyzer settings.
fortinet.fortios.fortios_log_fortianalyzer_override_setting:
vdom: "{{ vdom }}"
log_fortianalyzer_override_setting:
__change_ip: "127"
access_config: "enable"
alt_server: "<your_own_value>"
certificate: "<your_own_value> (source certificate.local.name)"
certificate_verification: "enable"
conn_timeout: "10"
enc_algorithm: "high-medium"
fallback_to_primary: "enable"
faz_type: "2147483647"
hmac_algorithm: "sha256"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
max_log_rate: "0"
mgmt_name: "<your_own_value>"
monitor_failure_retry_period: "5"
monitor_keepalive_period: "5"
override: "enable"
preshared_key: "<your_own_value>"
priority: "default"
reliable: "enable"
serial:
-
name: "default_name_25"
server: "192.168.100.40"
server_cert_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
use_management_vdom: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |