fortios_log_fortianalyzer3_setting – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.¶
New in version 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_fortianalyzer3 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_log_fortianalyzer3_setting | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- log_fortianalyzer3_setting - Global FortiAnalyzer settings. type: dict more...
- __change_ip - Hidden attribute. type: int more...
- access_config - Enable/disable FortiAnalyzer access to configuration and data. type: str choices: enable, disable more...
- certificate - Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. type: str more...
- certificate_verification - Enable/disable identity verification of FortiAnalyzer by use of certificate. type: str choices: enable, disable more...
- conn_timeout - FortiAnalyzer connection time-out in seconds (for status and log buffer). type: int more...
- enc_algorithm - Configure the level of SSL protection for secure communication with FortiAnalyzer. type: str choices: high-medium, high, low more...
- faz_type - Hidden setting index of FortiAnalyzer. type: int more...
- hmac_algorithm - OFTP login hash algorithm. type: str choices: sha256, sha1 more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- ips_archive - Enable/disable IPS packet archive logging. type: str choices: enable, disable more...
- max_log_rate - FortiAnalyzer maximum log rate in MBps (0 = unlimited). type: int more...
- mgmt_name - Hidden management name of FortiAnalyzer. type: str more...
- monitor_failure_retry_period - Time between FortiAnalyzer connection retries in seconds (for status and log buffer). type: int more...
- monitor_keepalive_period - Time between OFTP keepalives in seconds (for status and log buffer). type: int more...
- preshared_key - Preshared-key used for auto-authorization on FortiAnalyzer. type: str more...
- priority - Set log transmission priority. type: str choices: default, low more...
- reliable - Enable/disable reliable logging to FortiAnalyzer. type: str choices: enable, disable more...
- serial - Serial numbers of the FortiAnalyzer. type: list member_path: serial:name more...
- name - Serial Number. type: str required: true more...
- server - The remote FortiAnalyzer. type: str more...
- source_ip - Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. type: str more...
- ssl_min_proto_version - Minimum supported protocol version for SSL/TLS connections . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3 more...
- status - Enable/disable logging to FortiAnalyzer. type: str choices: enable, disable more...
- upload_day - Day of week (month) to upload logs. type: str more...
- upload_interval - Frequency to upload log files to FortiAnalyzer. type: str choices: daily, weekly, monthly more...
- upload_option - Enable/disable logging to hard disk and then uploading to FortiAnalyzer. type: str choices: store-and-upload, realtime, 1-minute, 5-minute more...
- upload_time - Time to upload logs (hh:mm). type: str more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Global FortiAnalyzer settings.
fortios_log_fortianalyzer3_setting:
vdom: "{{ vdom }}"
log_fortianalyzer3_setting:
__change_ip: "127"
access_config: "enable"
certificate: "<your_own_value> (source certificate.local.name)"
certificate_verification: "enable"
conn_timeout: "10"
enc_algorithm: "high-medium"
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"
preshared_key: "<your_own_value>"
priority: "default"
reliable: "enable"
serial:
-
name: "default_name_22"
server: "192.168.100.40"
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>"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3