fortios_log_fortianalyzer3_override_setting.rst

source:	fortios_log_fortianalyzer3_override_setting.py
orphan:

fortios_log_fortianalyzer3_override_setting -- Override FortiAnalyzer settings in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_log_fortianalyzer3_override_setting	v6.2.0 -> latest

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_override_setting - Override FortiAnalyzer settings. type: dict more...

  	Supported Version Ranges
  log_fortianalyzer3_override_setting	v6.2.0 -> latest

• __change_ip - Hidden attribute. type: int more...

  	Supported Version Ranges
  __change_ip	v6.2.3 -> v6.2.3

• access_config - Enable/disable FortiAnalyzer access to configuration and data. type: str choices: enable, disable more...

  	Supported Version Ranges
  access_config	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• alt_server - Alternate FortiAnalyzer. type: str more...

  	Supported Version Ranges
  alt_server	v7.4.1 -> latest

• certificate - Certificate used to communicate with FortiAnalyzer. Source certificate.local.name. type: str more...

  	Supported Version Ranges
  certificate	v6.2.0 -> latest

• certificate_verification - Enable/disable identity verification of FortiAnalyzer by use of certificate. type: str choices: enable, disable more...

  	Supported Version Ranges
  certificate_verification	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• conn_timeout - FortiAnalyzer connection time-out in seconds (for status and log buffer). type: int more...

  	Supported Version Ranges
  conn_timeout	v6.2.0 -> latest

• enc_algorithm - Configure the level of SSL protection for secure communication with FortiAnalyzer. type: str choices: high-medium, high, low more...

  	Supported Version Ranges
  enc_algorithm	v6.2.0 -> latest
  [high-medium]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest

• fallback_to_primary - Enable/disable this FortiGate unit to fallback to the primary FortiAnalyzer when it is available. type: str choices: enable, disable more...

  	Supported Version Ranges
  fallback_to_primary	v7.4.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• faz_type - Hidden setting index of FortiAnalyzer. type: int more...

  	Supported Version Ranges
  faz_type	v6.2.3 -> v6.2.3

• hmac_algorithm - OFTP login hash algorithm. type: str choices: sha256, sha1 more...

  	Supported Version Ranges
  hmac_algorithm	v6.2.0 -> latest
  [sha256]	v6.0.0 -> latest
  [sha1]	v6.2.0 -> v7.4.0

• interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...

  	Supported Version Ranges
  interface	v6.2.7 -> v6.4.0	v6.4.4 -> latest

• interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...

  	Supported Version Ranges
  interface_select_method	v6.2.7 -> v6.4.0	v6.4.4 -> latest
  [auto]	v6.0.0 -> latest
  [sdwan]	v6.0.0 -> latest
  [specify]	v6.0.0 -> latest

• ips_archive - Enable/disable IPS packet archive logging. type: str choices: enable, disable more...

  	Supported Version Ranges
  ips_archive	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• max_log_rate - FortiAnalyzer maximum log rate in MBps (0 = unlimited). type: int more...

  	Supported Version Ranges
  max_log_rate	v6.2.0 -> latest

• mgmt_name - Hidden management name of FortiAnalyzer. type: str more...

  	Supported Version Ranges
  mgmt_name	v6.2.3 -> v6.2.3

• monitor_failure_retry_period - Time between FortiAnalyzer connection retries in seconds (for status and log buffer). type: int more...

  	Supported Version Ranges
  monitor_failure_retry_period	v6.2.0 -> latest

• monitor_keepalive_period - Time between OFTP keepalives in seconds (for status and log buffer). type: int more...

  	Supported Version Ranges
  monitor_keepalive_period	v6.2.0 -> latest

• override - Enable/disable overriding FortiAnalyzer settings or use global settings. type: str choices: enable, disable more...

  	Supported Version Ranges
  override	v6.2.3 -> v6.2.3
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• preshared_key - Preshared-key used for auto-authorization on FortiAnalyzer. type: str more...

  	Supported Version Ranges
  preshared_key	v7.0.0 -> latest

• priority - Set log transmission priority. type: str choices: default, low more...

  	Supported Version Ranges
  priority	v6.2.0 -> latest
  [default]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest

• reliable - Enable/disable reliable logging to FortiAnalyzer. type: str choices: enable, disable more...

  	Supported Version Ranges
  reliable	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• serial - Serial numbers of the FortiAnalyzer. type: list member_path: serial:name more...

  	Supported Version Ranges
  serial	v6.2.0 -> latest

• name - Serial Number. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• server - The remote FortiAnalyzer. type: str more...

  	Supported Version Ranges
  server	v6.2.0 -> latest

• source_ip - Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. type: str more...

  	Supported Version Ranges
  source_ip	v6.2.0 -> latest

• 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...

  	Supported Version Ranges
  ssl_min_proto_version	v6.2.0 -> latest
  [default]	v6.0.0 -> latest
  [SSLv3]	v6.0.0 -> latest
  [TLSv1]	v6.0.0 -> latest
  [TLSv1-1]	v6.0.0 -> latest
  [TLSv1-2]	v6.0.0 -> latest
  [TLSv1-3]	v7.2.0 -> latest

• status - Enable/disable logging to FortiAnalyzer. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• upload_day - Day of week (month) to upload logs. type: str more...

  	Supported Version Ranges
  upload_day	v6.2.0 -> latest

• upload_interval - Frequency to upload log files to FortiAnalyzer. type: str choices: daily, weekly, monthly more...

  	Supported Version Ranges
  upload_interval	v6.2.0 -> latest
  [daily]	v6.0.0 -> latest
  [weekly]	v6.0.0 -> latest
  [monthly]	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  upload_option	v6.2.0 -> latest
  [store-and-upload]	v6.0.0 -> latest
  [realtime]	v6.0.0 -> latest
  [1-minute]	v6.0.0 -> latest
  [5-minute]	v6.0.0 -> latest

• upload_time - Time to upload logs (hh:mm). type: str more...

  	Supported Version Ranges
  upload_time	v6.2.0 -> latest

• use_management_vdom - Enable/disable use of management VDOM IP address as source IP for logs sent to FortiAnalyzer. type: str choices: enable, disable more...

  	Supported Version Ranges
  use_management_vdom	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

Notes

Note

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

Examples

- name: Override FortiAnalyzer settings.
  fortinet.fortios.fortios_log_fortianalyzer3_override_setting:
      vdom: "{{ vdom }}"
      log_fortianalyzer3_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"
          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: 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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.