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

Note

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

To install it use: ansible-galaxy collection install fortinet.fortios.

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

New in version 2.8: of fortinet.fortios

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 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.
log_fortianalyzer_setting dictionary			Global FortiAnalyzer settings.
	__change_ip integer		Hidden attribute.
	certificate string		Certificate used to communicate with FortiAnalyzer. Source certificate.local.name.
	conn_timeout integer		FortiAnalyzer connection time-out in seconds (for status and log buffer).
	enc_algorithm string	Choices: high-medium high low disable	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.
	ips_archive string	Choices: enable disable	Enable/disable IPS packet archive logging.
	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).
	reliable string	Choices: enable disable	Enable/disable reliable logging to FortiAnalyzer.
	server string		The remote FortiAnalyzer.
	source_ip string		Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.
	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_fortianalyzer_setting:
      vdom:  "{{ vdom }}"
      log_fortianalyzer_setting:
        __change_ip: "3"
        certificate: "<your_own_value> (source certificate.local.name)"
        conn_timeout: "5"
        enc_algorithm: "high-medium"
        faz_type: "7"
        hmac_algorithm: "sha256"
        ips_archive: "enable"
        mgmt_name: "<your_own_value>"
        monitor_failure_retry_period: "11"
        monitor_keepalive_period: "12"
        reliable: "enable"
        server: "192.168.100.40"
        source_ip: "84.230.14.43"
        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)