- source
faz_cli_system_locallog_fortianalyzer_setting.py
- orphan
1.0.0
Warning
Starting in version 2.0.0, all variables will be named in the underscore naming convention.
- Possible variable names before 2.0.0:
variable-name
,variable name
,variable.name
- Corresponding variable names since 2.0.0:
variable_name
FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiAnalyzer device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.2.1 -> latest
- access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
- bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
- enable_log Enable/Disable logging for task type: bool default: False
- forticloud_access_token Access token of forticloud analyzer API users. type: str
- log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
- proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
- version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
- rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
- rc_failed The rc codes list with which the conditions to fail will be overriden type: list
- cli_system_locallog_fortianalyzer_setting Settings for locallog to fortianalyzer. type: dict
- reliable Enable/disable reliable realtime logging. type: str choices: [disable, enable] default: disable more...
Supported Version Ranges:
v6.2.1 -> latest
- secure_connection Enable/disable connection secured by TLS/SSL. type: str choices: [disable, enable] default: disable more...
Supported Version Ranges:
v6.2.1 -> latest
- server Remote FortiAnalyzer server FQDN, hostname, or IP address type: str more...
Supported Version Ranges:
v6.2.1 -> latest
- severity Least severity level to log. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] default: notification more...
Supported Version Ranges:
v6.2.1 -> latest
- status Log to FortiAnalyzer status. type: str choices: [disable, realtime, upload] default: disable more...
Supported Version Ranges:
v6.2.1 -> latest
- upload_time Time to upload local log files (hh:mm). type: str elements: str more...
Supported Version Ranges:
v6.2.1 -> latest
- peer_cert_cn Certificate common name of remote fortianalyzer. type: str more...
Supported Version Ranges:
v7.0.3 -> latest
Note
- 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
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Settings for locallog to fortianalyzer.
fortinet.fortianalyzer.faz_cli_system_locallog_fortianalyzer_setting:
cli_system_locallog_fortianalyzer_setting:
reliable: disable
secure_connection: disable
# server: <value of string>
# severity: <value in [emergency, alert, critical, ...]>
status: disable
# upload_time: <value of string>
vars:
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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:
- meta The result of the request. returned: always type: dict
- 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_data The data body of the api response. returned: optional type: list or dict
- response_message The descriptive message of the api response. returned: always type: str sample: OK
- system_information The information of the target system. returned: always type: dict
- rc The status the request. returned: always type: int sample: 0
- version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Maxx Liu (@MaxxLiu22)
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)