W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting module – Global FortiAnalyzer Cloud settings.

Note

This module is part of the fortinet.fortimanager collection (version 2.10.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_fortianalyzercloud_setting.

New in fortinet.fortimanager 2.1.0

Synopsis
Parameters
Notes
Examples
Return Values

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_fortianalyzercloud_setting dictionary	The top level parameters set.
__change_ip integer	Hidden attribute.
access_config aliases: access-config string	Enable/disable FortiAnalyzer access to configuration and data. Choices: `"disable"` `"enable"`
certificate string	Certificate used to communicate with FortiAnalyzer.
certificate_verification aliases: certificate-verification string	Enable/disable identity verification of FortiAnalyzer by use of certificate. Choices: `"disable"` `"enable"`
conn_timeout aliases: conn-timeout integer	FortiAnalyzer connection time-out in seconds
enc_algorithm aliases: enc-algorithm string	Configure the level of SSL protection for secure communication with FortiAnalyzer. Choices: `"high"` `"low"` `"high-medium"` `"low-medium"`
hmac_algorithm aliases: hmac-algorithm string	FortiAnalyzer IPsec tunnel HMAC algorithm. Choices: `"sha256"` `"sha1"`
interface string	Specify outgoing interface to reach server.
interface_select_method aliases: interface-select-method string	Specify how to select outgoing interface to reach server. Choices: `"auto"` `"sdwan"` `"specify"`
ips_archive aliases: ips-archive string	Enable/disable IPS packet archive logging. Choices: `"disable"` `"enable"`
max_log_rate aliases: max-log-rate integer	FortiAnalyzer maximum log rate in MBps
monitor_failure_retry_period aliases: monitor-failure-retry-period integer	Time between FortiAnalyzer connection retries in seconds
monitor_keepalive_period aliases: monitor-keepalive-period integer	Time between OFTP keepalives in seconds
preshared_key aliases: preshared-key string	Preshared-key used for auto-authorization on FortiAnalyzer.
priority string	Set log transmission priority. Choices: `"low"` `"default"`
serial any	(list) Serial numbers of the FortiAnalyzer.
source_ip aliases: source-ip string	Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.
ssl_min_proto_version aliases: ssl-min-proto-version string	Minimum supported protocol version for SSL/TLS connections Choices: `"default"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"TLSv1-3"`
status string	Enable/disable logging to FortiAnalyzer. Choices: `"disable"` `"enable"`
upload_day aliases: upload-day string	Day of week
upload_interval aliases: upload-interval string	Frequency to upload log files to FortiAnalyzer. Choices: `"daily"` `"weekly"` `"monthly"`
upload_option aliases: 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 aliases: upload-time string	Time to upload logs
vrf_select aliases: vrf-select integer	VRF ID used for connection to server.
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
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Global FortiAnalyzer Cloud settings.
      fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_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_fortianalyzercloud_setting:
          # __change_ip: <integer>
          # access_config: <value in [disable, enable]>
          # certificate: <string>
          # conn_timeout: <integer>
          # enc_algorithm: <value in [high, low, high-medium, ...]>
          # hmac_algorithm: <value in [sha256, sha1]>
          # ips_archive: <value in [disable, enable]>
          # monitor_failure_retry_period: <integer>
          # monitor_keepalive_period: <integer>
          # source_ip: <string>
          # ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          # status: <value in [disable, enable]>
          # upload_day: <string>
          # upload_interval: <value in [daily, weekly, monthly]>
          # upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
          # upload_time: <string>
          # max_log_rate: <integer>
          # priority: <value in [low, default]>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # preshared_key: <string>
          # certificate_verification: <value in [disable, enable]>
          # serial: <list or string>
          # vrf_select: <integer>

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)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_log_fortianalyzercloud_setting_module.html