fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting – Global FortiAnalyzer settings.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
devprof
string / required
the parameter (devprof) in requested url
devprof_log_fortianalyzer_setting
dictionary
the top level parameters set
certificate
string
Certificate used to communicate with FortiAnalyzer.
conn-timeout
integer
FortiAnalyzer connection time-out in seconds (for status and log buffer).
enc-algorithm
string
    Choices:
  • default
  • high
  • low
  • disable
  • high-medium
  • low-medium
Enable/disable sending FortiAnalyzer log data with SSL encryption.
hmac-algorithm
string
    Choices:
  • sha256
  • sha1
FortiAnalyzer IPsec tunnel HMAC algorithm.
ips-archive
string
    Choices:
  • disable
  • enable
Enable/disable IPS packet archive logging.
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:
  • disable
  • enable
Enable/disable reliable logging to FortiAnalyzer.
ssl-min-proto-version
string
    Choices:
  • default
  • TLSv1
  • TLSv1-1
  • TLSv1-2
  • SSLv3
Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).
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).
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request
response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)