fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting module – Global FortiAnalyzer settings.

Note

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

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

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

access_token

string

The token to access FortiManager without using username and password.

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:

  • false ← (default)

  • true

devprof

string / required

The parameter (devprof) in requested url.

devprof_log_fortianalyzer_setting

dictionary

The top level parameters set.

__change_ip

integer

Hidden attribute.

access-config

string

Deprecated, please rename it to access_config. Enable/disable FortiAnalyzer access to configuration and data.

Choices:

  • "disable"

  • "enable"

alt-server

string

Deprecated, please rename it to alt_server. Alt server.

certificate

string

Certificate used to communicate with FortiAnalyzer.

certificate-verification

string

Deprecated, please rename it to certificate_verification. Enable/disable identity verification of FortiAnalyzer by use of …

Choices:

  • "disable"

  • "enable"

conn-timeout

integer

Deprecated, please rename it to conn_timeout. FortiAnalyzer connection time-out in seconds

enc-algorithm

string

Deprecated, please rename it to enc_algorithm. Enable/disable sending FortiAnalyzer log data with SSL encryption.

Choices:

  • "default"

  • "high"

  • "low"

  • "disable"

  • "high-medium"

  • "low-medium"

fallback-to-primary

string

Deprecated, please rename it to fallback_to_primary. Enable/disable this FortiGate unit to fallback to the primary FortiAn…

Choices:

  • "disable"

  • "enable"

hmac-algorithm

string

Deprecated, please rename it to hmac_algorithm. FortiAnalyzer IPsec tunnel HMAC algorithm.

Choices:

  • "sha256"

  • "sha1"

interface

string

Specify outgoing interface to reach server.

interface-select-method

string

Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

ips-archive

string

Deprecated, please rename it to ips_archive. Enable/disable IPS packet archive logging.

Choices:

  • "disable"

  • "enable"

max-log-rate

integer

Deprecated, please rename it to max_log_rate. FortiAnalyzer maximum log rate in MBps

monitor-failure-retry-period

integer

Deprecated, please rename it to monitor_failure_retry_period. Time between FortiAnalyzer connection retries in seconds

monitor-keepalive-period

integer

Deprecated, please rename it to monitor_keepalive_period. Time between OFTP keepalives in seconds

preshared-key

string

Deprecated, please rename it to preshared_key. 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"

serial

any

(list) Serial numbers of the FortiAnalyzer.

server

string

The remote FortiAnalyzer.

server-cert-ca

string

Deprecated, please rename it to server_cert_ca. Mandatory CA on FortiGate in certificate chain of server.

source-ip

string

Deprecated, please rename it to source_ip. Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.

ssl-min-proto-version

string

Deprecated, please rename it to ssl_min_proto_version. Minimum supported protocol version for SSL/TLS connections

Choices:

  • "default"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1-3"

status

string

Enable/disable logging to FortiAnalyzer.

Choices:

  • "disable"

  • "enable"

upload-day

string

Deprecated, please rename it to upload_day. Day of week

upload-interval

string

Deprecated, please rename it to upload_interval. Frequency to upload log files to FortiAnalyzer.

Choices:

  • "daily"

  • "weekly"

  • "monthly"

upload-option

string

Deprecated, please rename it to upload_option. Enable/disable logging to hard disk and then uploading to FortiAnalyzer.

Choices:

  • "store-and-upload"

  • "realtime"

  • "1-minute"

  • "5-minute"

upload-time

string

Deprecated, please rename it to upload_time. Time to upload logs

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Global FortiAnalyzer settings.
      fortinet.fortimanager.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: <string>
          conn_timeout: <integer>
          enc_algorithm: <value in [default, high, low, ...]>
          hmac_algorithm: <value in [sha256, sha1]>
          ips_archive: <value in [disable, enable]>
          monitor_failure_retry_period: <integer>
          monitor_keepalive_period: <integer>
          reliable: <value in [disable, enable]>
          ssl_min_proto_version: <value in [default, TLSv1, TLSv1-1, ...]>
          upload_day: <string>
          upload_interval: <value in [daily, weekly, monthly]>
          upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
          upload_time: <string>
          access_config: <value in [disable, enable]>
          certificate_verification: <value in [disable, enable]>
          max_log_rate: <integer>
          priority: <value in [low, default]>
          interface: <string>
          interface_select_method: <value in [auto, sdwan, specify]>
          preshared_key: <string>
          alt_server: <string>
          fallback_to_primary: <value in [disable, enable]>
          server_cert_ca: <string>
          serial: <list or string>
          source_ip: <string>
          status: <value in [disable, enable]>
          __change_ip: <integer>
          server: <string>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)