fortinet.fortimanager.fmgr_system_alertevent module – Alert events.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_alertevent
.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to alert_destination. Alert destination. |
|
Sender email address to use in alert emails. |
|
Deprecated, please rename it to smtp_name. SMTP server name. |
|
Deprecated, please rename it to snmp_name. SNMP trap name. |
|
Deprecated, please rename it to syslog_name. Syslog server name. |
|
Recipient email address to use in alert emails. |
|
Destination type. mail - Send email alert. snmp - Send SNMP trap. syslog - Send syslog message. Choices:
|
|
Deprecated, please rename it to enable_generic_text. Enable/disable generic text match. enable - Enable setting. disable - Disable setting. Choices:
|
|
Deprecated, please rename it to enable_severity_filter. Enable/disable alert severity filter. enable - Enable setting. disable - Disable setting. Choices:
|
|
Deprecated, please rename it to event_time_period. Time period 1 - 1 hour. 3 - 3 hours. 6 - 6 hours. 12 - 12 hours. 24 - 1 day. 72 - 3 days. 168 - 1 week. Choices:
|
|
Deprecated, please rename it to generic_text. Text that must be contained in a log to trigger alert. |
|
Alert name. |
|
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. Choices:
|
|
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. Choices:
|
|
Deprecated, please rename it to severity_level_comp. Log severity threshold comparison criterion. Choices:
|
|
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. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
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
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |