fortinet / fortinet.fortianalyzer / 1.4.0 / module / faz_cli_system_alertevent Alert events. | "added in version" 1.0.0 of fortinet.fortianalyzer" Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortianalyzer.faz_cli_system_alertevent (1.4.0) — module
Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0
collections: - name: fortinet.fortianalyzer version: 1.4.0
This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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_httpapi_port: 443 ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false
state: choices: - present - absent description: The directive to create, update or delete an object required: true type: str log_path: default: /tmp/fortianalyzer.ansible.log description: - 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.log required: false type: str rc_failed: description: the rc codes list with which the conditions to fail will be overriden elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: the rc codes list with which the conditions to succeed will be overriden elements: int required: false type: list proposed_method: choices: - set - update - add description: The overridden method for the underlying Json RPC request required: false type: str bypass_validation: default: false description: only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters required: false type: bool cli_system_alertevent: description: The top level parameters set. required: false suboptions: alert-destination: description: no description elements: dict suboptions: from: description: Sender email address to use in alert emails. type: str smtp-name: description: SMTP server name. type: str snmp-name: description: SNMP trap name. type: str syslog-name: description: Syslog server name. type: str to: description: Recipient email address to use in alert emails. type: str type: choices: - mail - snmp - syslog description: - Destination type. - mail - Send email alert. - snmp - Send SNMP trap. - syslog - Send syslog message. type: str type: list enable-generic-text: choices: - enable - disable description: no description elements: str type: list enable-severity-filter: choices: - enable - disable description: no description elements: str type: list event-time-period: choices: - '0.5' - '1' - '3' - '6' - '12' - '24' - '72' - '168' description: - Time period (hours). - 0.5 - 30 minutes. - 1 - 1 hour. - 3 - 3 hours. - 6 - 6 hours. - 12 - 12 hours. - 24 - 1 day. - 72 - 3 days. - 168 - 1 week. type: str generic-text: description: Text that must be contained in a log to trigger alert. type: str name: description: Alert name. type: str num-events: choices: - '1' - '5' - '10' - '50' - '100' description: - Minimum number of events required within time period. - 1 - 1 event. - 5 - 5 events. - 10 - 10 events. - 50 - 50 events. - 100 - 100 events. type: str severity-filter: choices: - high - medium-high - medium - medium-low - low description: - Required log severity to trigger alert. - high - High level alert. - medium-high - Medium-high level alert. - medium - Medium level alert. - medium-low - Medium-low level alert. - low - Low level alert. type: str severity-level-comp: choices: - '>=' - '=' - <= description: no description elements: str type: list severity-level-logs: choices: - no-check - information - notify - warning - error - critical - alert - emergency description: no description elements: str type: list type: dict forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str
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 fortianalyzer version. returned: complex type: list