fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_locallog_fortianalyzer3_setting Settings for locallog to fortianalyzer. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_setting (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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: Settings for locallog to fortianalyzer. fortinet.fortimanager.fmgr_system_locallog_fortianalyzer3_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, ...] system_locallog_fortianalyzer3_setting: reliable: <value in [disable, enable]> secure_connection: <value in [disable, enable]> server_ip: <string> severity: <value in [emergency, alert, critical, ...]> status: <value in [disable, realtime, upload]> upload_time: <list or string> server: <string> peer_cert_cn: <string>
rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int system_locallog_fortianalyzer3_setting: description: The top level parameters set. required: false suboptions: peer-cert-cn: description: Deprecated, please rename it to peer_cert_cn. Certificate common name of remote fortianalyzer. type: str reliable: choices: - disable - enable description: - Enable/disable reliable realtime logging. - disable - Disable reliable realtime logging. - enable - Enable reliable realtime logging. type: str secure-connection: choices: - disable - enable description: - Deprecated, please rename it to secure_connection. - Enable/disable connection secured by TLS/SSL. - disable - Disable SSL connection. - enable - Enable SSL connection. type: str server: description: Remote FortiAnalyzer server FQDN, hostname, or IP address type: str server-ip: description: Deprecated, please rename it to server_ip. Remote FortiAnalyzer server IP address. type: str severity: choices: - emergency - alert - critical - error - warning - notification - information - debug description: - Least severity level to log. - emergency - Emergency level. - alert - Alert level. - critical - Critical level. - error - Error level. - warning - Warning level. - notification - Notification level. - information - Information level. - debug - Debug level. type: str status: choices: - disable - realtime - upload description: - Log to FortiAnalyzer status. - disable - Log to FortiAnalyzer disabled. - realtime - Log to FortiAnalyzer in realtime. - upload - Log to FortiAnalyzer at schedule time. type: str upload-time: description: (list) Deprecated, please rename it to upload_time. Time to upload local log files type: raw type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list