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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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 - Global FortiAnalyzer settings. type: dict
- certificate - Certificate used to communicate with FortiAnalyzer. type: str
- conn-timeout - FortiAnalyzer connection time-out in seconds (for status and log buffer). type: int
- enc-algorithm - Enable/disable sending FortiAnalyzer log data with SSL encryption. type: str choices: [default, high, low, disable, high-medium, low-medium]
- hmac-algorithm - FortiAnalyzer IPsec tunnel HMAC algorithm. type: str choices: [sha256, sha1]
- ips-archive - Enable/disable IPS packet archive logging. type: str choices: [disable, enable]
- monitor-failure-retry-period - Time between FortiAnalyzer connection retries in seconds (for status and log buffer). type: int
- monitor-keepalive-period - Time between OFTP keepalives in seconds (for status and log buffer). type: int
- reliable - Enable/disable reliable logging to FortiAnalyzer. type: str choices: [disable, enable]
- 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]
- upload-day - Day of week (month) to upload logs. type: str
- upload-interval - Frequency to upload log files to FortiAnalyzer. type: str choices: [daily, weekly, monthly]
- upload-option - Enable/disable logging to hard disk and then uploading to FortiAnalyzer. type: str choices: [store-and-upload, realtime, 1-minute, 5-minute]
- upload-time - Time to upload logs (hh:mm). type: str
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: Global FortiAnalyzer settings.
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>
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