faz_cli_system_alertevent – Alert events.
Added in version 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.nameCorresponding 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.
Synopsis
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiAnalyzer Version Compatibility
Supported Version Ranges: v6.2.1 -> latest
Parameters
- 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
- state The directive to create, update or delete an object type: str required: true choices: present, absent
- cli_system_alertevent Alert events. type: dict
- alert_destination type: list of dict
more...
- from Sender email address to use in alert emails. type: str more...
- smtp_name SMTP server name. type: str more...
- snmp_name SNMP trap name. type: str more...
- syslog_name Syslog server name. type: str more...
- to Recipient email address to use in alert emails. type: str more...
- type Destination type. type: str choices: [mail, snmp, syslog] default: mail more...
- enable_generic_text Enable/disable generic text match. type: list elements: str choices: [enable, disable] more...
- enable_severity_filter Enable/disable alert severity filter. type: list elements: str choices: [enable, disable] more...
- event_time_period Time period (hours). type: str choices: [0.5, 1, 3, 6, 12, 24, 72, 168] default: 0.5 more...
- generic_text Text that must be contained in a log to trigger alert. type: str more...
- name Alert name. type: str more...
- num_events Minimum number of events required within time period. type: str choices: [1, 5, 10, 50, 100] default: 1 more...
- severity_filter Required log severity to trigger alert. type: str choices: [high, medium-high, medium, medium-low, low] default: high more...
- severity_level_comp Log severity threshold comparison criterion. type: list elements: str choices: [>=, =, <=] more...
- severity_level_logs Log severity threshold level. type: list elements: str choices: [no-check, information, notify, warning, error, critical, alert, emergency] more...
Notes
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
Examples
- name: Example playbook
connection: httpapi
hosts: fortianalyzers
tasks:
- name: Alert events.
fortinet.fortianalyzer.faz_cli_system_alertevent:
cli_system_alertevent:
event_time_period: 1
generic_text: "an event aleryed"
name: fooevent
num_events: 5
severity_filter: high
severity_level_comp:
- ">="
severity_level_logs:
- no-check
state: present
vars:
ansible_network_os: fortinet.fortianalyzer.fortianalyzer
ansible_httpapi_port: 443
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
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:
- 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
Status
This module is not guaranteed to have a backwards compatible interface.