fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_alertevent Alert events. | "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_alertevent (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 hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Alert events. fortinet.fortimanager.fmgr_system_alertevent: bypass_validation: false state: present system_alertevent: enable-generic-text: - enable - disable enable-severity-filter: - enable - disable event-time-period: 1 # <value in [0.5, 1, 3, ...]> name: ansible-test-sysalert num-events: 1 # <value in [1, 5, 10, ...]> severity-filter: high # <value in [high, medium-high, medium, ...]> # severity-level-comp: # - <= severity-level-logs: - no-check - information - notify - warning - error - critical - alert - emergency
- name: Gathering fortimanager facts hosts: fortimanagers gather_facts: false connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Retrieve all the alert events fortinet.fortimanager.fmgr_fact: facts: selector: "system_alertevent" params: alert-event: "your_value"
state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str 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 system_alertevent: description: The top level parameters set. required: false suboptions: alert-destination: description: Deprecated, please rename it to alert_destination. Alert-Destination. elements: dict suboptions: from: description: Sender email address to use in alert emails. type: str smtp-name: description: Deprecated, please rename it to smtp_name. SMTP server name. type: str snmp-name: description: Deprecated, please rename it to snmp_name. SNMP trap name. type: str syslog-name: description: Deprecated, please rename it to syslog_name. 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: - Deprecated, please rename it to enable_generic_text. - Enable/disable generic text match. - enable - Enable setting. - disable - Disable setting. elements: str type: list enable-severity-filter: choices: - enable - disable description: - Deprecated, please rename it to enable_severity_filter. - Enable/disable alert severity filter. - enable - Enable setting. - disable - Disable setting. elements: str type: list event-time-period: choices: - '0.5' - '1' - '3' - '6' - '12' - '24' - '72' - '168' description: - Deprecated, please rename it to event_time_period. - Time period - '0.' - 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: Deprecated, please rename it to generic_text. Text that must be contained in a log to trigger alert. type: str name: description: Alert name. required: true type: str num-events: choices: - '1' - '5' - '10' - '50' - '100' description: - Deprecated, please rename it to num_events. - 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: - Deprecated, please rename it to severity_filter. - 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: Deprecated, please rename it to severity_level_comp. Log severity threshold comparison criterion. elements: str type: list severity-level-logs: choices: - no-check - information - notify - warning - error - critical - alert - emergency description: - Deprecated, please rename it to severity_level_logs. - Log severity threshold level. - no-check - Do not check severity level for this log type. - information - Information level. - notify - Notify level. - warning - Warning level. - error - Error level. - critical - Critical level. - alert - Alert level. - emergency - Emergency level. elements: str type: list type: dict 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
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