fmgr_devprof_log_fortianalyzer_setting – Global FortiAnalyzer settings.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.5 7.0.0 7.2.0
devprof_log_fortianalyzer_setting yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • adom - The parameter in requested url type: str required: true
  • devprof - The parameter in requested url type: str required: true
  • devprof_log_fortianalyzer_setting - no description type: dict
    • certificate - Certificate used to communicate with FortiAnalyzer. type: str more...
    • conn-timeout - FortiAnalyzer connection time-out in seconds (for status and log buffer). type: int more...
    • enc-algorithm - Enable/disable sending FortiAnalyzer log data with SSL encryption. type: str choices: [default, high, low, disable, high-medium, low-medium] more...
    • hmac-algorithm - FortiAnalyzer IPsec tunnel HMAC algorithm. type: str choices: [sha256, sha1] more...
    • ips-archive - Enable/disable IPS packet archive logging. type: str choices: [disable, enable] more...
    • monitor-failure-retry-period - Time between FortiAnalyzer connection retries in seconds (for status and log buffer). type: int more...
    • monitor-keepalive-period - Time between OFTP keepalives in seconds (for status and log buffer). type: int more...
    • reliable - Enable/disable reliable logging to FortiAnalyzer. type: str choices: [disable, enable] more...
    • ssl-min-proto-version - Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3, TLSv1-3] more...
    • upload-day - Day of week (month) to upload logs. type: str more...
    • upload-interval - Frequency to upload log files to FortiAnalyzer. type: str choices: [daily, weekly, monthly] more...
    • 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...
    • upload-time - Time to upload logs (hh:mm). type: str more...
    • access-config - Enable/disable FortiAnalyzer access to configuration and data. type: str choices: [disable, enable] more...
    • certificate-verification - Enable/disable identity verification of FortiAnalyzer by use of certificate. type: str choices: [disable, enable] more...
    • max-log-rate - FortiAnalyzer maximum log rate in MBps (0 = unlimited). type: int more...
    • priority - Set log transmission priority. type: str choices: [low, default] more...
    • interface - Specify outgoing interface to reach server. type: str more...
    • interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
    • preshared-key - Preshared-key used for auto-authorization on FortiAnalyzer. type: str more...

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: no description
     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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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