fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting module – Global FortiAnalyzer settings.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

devprof

string / required

the parameter (devprof) in requested url

devprof_log_fortianalyzer_setting

dictionary

the top level parameters set

access-config

string

Enable/disable FortiAnalyzer access to configuration and data.

Choices:

  • disable

  • enable

certificate

string

Certificate used to communicate with FortiAnalyzer.

certificate-verification

string

Enable/disable identity verification of FortiAnalyzer by use of certificate.

Choices:

  • disable

  • enable

conn-timeout

integer

FortiAnalyzer connection time-out in seconds (for status and log buffer).

enc-algorithm

string

Enable/disable sending FortiAnalyzer log data with SSL encryption.

Choices:

  • default

  • high

  • low

  • disable

  • high-medium

  • low-medium

hmac-algorithm

string

FortiAnalyzer IPsec tunnel HMAC algorithm.

Choices:

  • sha256

  • sha1

interface

string

Specify outgoing interface to reach server.

interface-select-method

string

Specify how to select outgoing interface to reach server.

Choices:

  • auto

  • sdwan

  • specify

ips-archive

string

Enable/disable IPS packet archive logging.

Choices:

  • disable

  • enable

max-log-rate

integer

FortiAnalyzer maximum log rate in MBps (0 = unlimited).

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

Set log transmission priority.

Choices:

  • low

  • default

reliable

string

Enable/disable reliable logging to FortiAnalyzer.

Choices:

  • disable

  • enable

ssl-min-proto-version

string

Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).

Choices:

  • default

  • TLSv1

  • TLSv1-1

  • TLSv1-2

  • SSLv3

upload-day

string

Day of week (month) to upload logs.

upload-interval

string

Frequency to upload log files to FortiAnalyzer.

Choices:

  • daily

  • weekly

  • monthly

upload-option

string

Enable/disable logging to hard disk and then uploading to FortiAnalyzer.

Choices:

  • store-and-upload

  • realtime

  • 1-minute

  • 5-minute

upload-time

string

Time to upload logs (hh:mm).

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Global FortiAnalyzer settings.
     fmgr_devprof_log_fortianalyzer_setting:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_log_fortianalyzer_setting:
           certificate: <value of string>
           conn-timeout: <value of integer>
           enc-algorithm: <value in [default, high, low, ...]>
           hmac-algorithm: <value in [sha256, sha1]>
           ips-archive: <value in [disable, enable]>
           monitor-failure-retry-period: <value of integer>
           monitor-keepalive-period: <value of integer>
           reliable: <value in [disable, enable]>
           ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
           upload-day: <value of string>
           upload-interval: <value in [daily, weekly, monthly]>
           upload-option: <value in [store-and-upload, realtime, 1-minute, ...]>
           upload-time: <value of string>
           access-config: <value in [disable, enable]>
           certificate-verification: <value in [disable, enable]>
           max-log-rate: <value of integer>
           priority: <value in [low, default]>
           interface: <value of string>
           interface-select-method: <value in [auto, sdwan, specify]>
           preshared-key: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)