fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting module – Global FortiAnalyzer settings.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
The parameter (devprof) in requested url. |
|
The top level parameters set. |
|
Hidden attribute. |
|
Enable/disable FortiAnalyzer access to configuration and data. Choices:
|
|
Alt server. |
|
Certificate used to communicate with FortiAnalyzer. |
|
Enable/disable identity verification of FortiAnalyzer by use of certificate. Choices:
|
|
FortiAnalyzer connection time-out in seconds |
|
Enable/disable sending FortiAnalyzer log data with SSL encryption. Choices:
|
|
Enable/disable this FortiGate unit to fallback to the primary FortiAnalyzer when it is available. Choices:
|
|
FortiAnalyzer IPsec tunnel HMAC algorithm. Choices:
|
|
Specify outgoing interface to reach server. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Enable/disable IPS packet archive logging. Choices:
|
|
FortiAnalyzer maximum log rate in MBps |
|
Time between FortiAnalyzer connection retries in seconds |
|
Time between OFTP keepalives in seconds |
|
Preshared-key used for auto-authorization on FortiAnalyzer. |
|
Set log transmission priority. Choices:
|
|
Enable/disable reliable logging to FortiAnalyzer. Choices:
|
|
(list) Serial numbers of the FortiAnalyzer. |
|
The remote FortiAnalyzer. |
|
Mandatory CA on FortiGate in certificate chain of server. |
|
Source IPv4 or IPv6 address used to communicate with FortiAnalyzer. |
|
Minimum supported protocol version for SSL/TLS connections Choices:
|
|
Enable/disable logging to FortiAnalyzer. Choices:
|
|
Day of week |
|
Frequency to upload log files to FortiAnalyzer. Choices:
|
|
Enable/disable logging to hard disk and then uploading to FortiAnalyzer. Choices:
|
|
Time to upload logs |
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |