fortinet.fortios.fortios_log_fortianalyzer3_setting – Global FortiAnalyzer settings in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_log_fortianalyzer3_setting.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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

Requirements

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

Parameters

Parameter			Choices/Defaults	Comments
access_token string				Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean			Choices: no ← yes	Enable/Disable logging for task.
log_fortianalyzer3_setting dictionary				Global FortiAnalyzer settings.
	__change_ip integer			Hidden attribute.
	access_config string		Choices: enable disable	Enable/disable FortiAnalyzer access to configuration and data.
	certificate string			Certificate used to communicate with FortiAnalyzer. Source certificate.local.name.
	certificate_verification string		Choices: enable disable	Enable/disable identity verification of FortiAnalyzer by use of certificate.
	conn_timeout integer			FortiAnalyzer connection time-out in seconds (for status and log buffer).
	enc_algorithm string		Choices: high-medium high low	Enable/disable sending FortiAnalyzer log data with SSL encryption.
	faz_type integer			Hidden setting index of FortiAnalyzer.
	hmac_algorithm string		Choices: sha256 sha1	FortiAnalyzer IPsec tunnel HMAC algorithm.
	interface string			Specify outgoing interface to reach server. Source system.interface.name.
	interface_select_method string		Choices: auto sdwan specify	Specify how to select outgoing interface to reach server.
	ips_archive string		Choices: enable disable	Enable/disable IPS packet archive logging.
	max_log_rate integer			FortiAnalyzer maximum log rate in MBps (0 = unlimited).
	mgmt_name string			Hidden management name of FortiAnalyzer.
	monitor_failure_retry_period integer			Time between FortiAnalyzer connection retries in seconds (for status and log buffer).
	monitor_keepalive_period integer			Time between OFTP keepalives in seconds (for status and log buffer).
	preshared_key string			Preshared-key used for auto-authorization on FortiAnalyzer.
	priority string		Choices: default low	Set log transmission priority.
	reliable string		Choices: enable disable	Enable/disable reliable logging to FortiAnalyzer.
	serial list / elements=string			Serial numbers of the FortiAnalyzer.
		name string / required		Serial Number.
	server string			The remote FortiAnalyzer.
	source_ip string			Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.
	ssl_min_proto_version string		Choices: default SSLv3 TLSv1 TLSv1-1 TLSv1-2	Minimum supported protocol version for SSL/TLS connections .
	status string		Choices: enable disable	Enable/disable logging to FortiAnalyzer.
	upload_day string			Day of week (month) to upload logs.
	upload_interval string		Choices: daily weekly monthly	Frequency to upload log files to FortiAnalyzer.
	upload_option string		Choices: store-and-upload realtime 1-minute 5-minute	Enable/disable logging to hard disk and then uploading to FortiAnalyzer.
	upload_time string			Time to upload logs (hh:mm).
vdom string			Default: "root"	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.

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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: "3"
        access_config: "enable"
        certificate: "<your_own_value> (source certificate.local.name)"
        certificate_verification: "enable"
        conn_timeout: "7"
        enc_algorithm: "high-medium"
        faz_type: "9"
        hmac_algorithm: "sha256"
        interface: "<your_own_value> (source system.interface.name)"
        interface_select_method: "auto"
        ips_archive: "enable"
        max_log_rate: "14"
        mgmt_name: "<your_own_value>"
        monitor_failure_retry_period: "16"
        monitor_keepalive_period: "17"
        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 here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate Sample: v5.6.3

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_log_fortianalyzer3_setting_module.html