fortinet.fortimanager.fmgr_system_locallog_fortianalyzer_setting – Settings for locallog to fortianalyzer.

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_system_locallog_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
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
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
system_locallog_fortianalyzer_setting
dictionary
the top level parameters set
reliable
string
    Choices:
  • disable ←
  • enable
Enable/disable reliable realtime logging.
disable - Disable reliable realtime logging.
enable - Enable reliable realtime logging.
secure-connection
string
    Choices:
  • disable ←
  • enable
Enable/disable connection secured by TLS/SSL.
disable - Disable SSL connection.
enable - Enable SSL connection.
server-ip
string
Default:
"0.0.0.0"
Remote FortiAnalyzer server IP address.
severity
string
    Choices:
  • emergency
  • alert
  • critical
  • error
  • warning
  • notification ←
  • information
  • debug
Least severity level to log.
emergency - Emergency level.
alert - Alert level.
critical - Critical level.
error - Error level.
warning - Warning level.
notification - Notification level.
information - Information level.
debug - Debug level.
status
string
    Choices:
  • disable ←
  • realtime
  • upload
Log to FortiAnalyzer status.
disable - Log to FortiAnalyzer disabled.
realtime - Log to FortiAnalyzer in realtime.
upload - Log to FortiAnalyzer at schedule time.
upload-time
string
no description
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: Settings for locallog to fortianalyzer.
     fmgr_system_locallog_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, ...]
        system_locallog_fortianalyzer_setting:
           reliable: <value in [disable, enable]>
           secure-connection: <value in [disable, enable]>
           server-ip: <value of string>
           severity: <value in [emergency, alert, critical, ...]>
           status: <value in [disable, realtime, upload]>
           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)