fmgr_system_alertevent – Alert events.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- system_alertevent - Alert events. type: dict
- alert-destination - No description for the parameter type: array
- from - Sender email address to use in alert emails. type: str
- smtp-name - SMTP server name. type: str
- snmp-name - SNMP trap name. type: str
- syslog-name - Syslog server name. type: str
- to - Recipient email address to use in alert emails. type: str
- type - Destination type. type: str choices: [mail, snmp, syslog] default: mail
- enable-generic-text - No description for the parameter type: array choices: [enable, disable]
- enable-severity-filter - No description for the parameter type: array choices: [enable, disable]
- event-time-period - Time period (hours). type: str choices: [0.5, 1, 3, 6, 12, 24, 72, 168] default: 0.5
- generic-text - Text that must be contained in a log to trigger alert. type: str
- name - Alert name. type: str
- num-events - Minimum number of events required within time period. type: str choices: [1, 5, 10, 50, 100] default: 1
- severity-filter - Required log severity to trigger alert. type: str choices: [high, medium-high, medium, medium-low, low] default: high
- severity-level-comp - No description for the parameter type: array choices: [string of >=, string of =, string of <=]
- severity-level-logs - No description for the parameter type: array choices: [no-check, information, notify, warning, error, critical, alert, emergency]
Notes¶
Note
- 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Alert events.
fmgr_system_alertevent:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
state: <value in [present, absent]>
system_alertevent:
alert-destination:
-
from: <value of string>
smtp-name: <value of string>
snmp-name: <value of string>
syslog-name: <value of string>
to: <value of string>
type: <value in [mail, snmp, syslog]>
enable-generic-text:
- enable
- disable
enable-severity-filter:
- enable
- disable
event-time-period: <value in [0.5, 1, 3, ...]>
generic-text: <value of string>
name: <value of string>
num-events: <value in [1, 5, 10, ...]>
severity-filter: <value in [high, medium-high, medium, ...]>
severity-level-comp:
- string of >=
- string of =
- string of <=
severity-level-logs:
- no-check
- information
- notify
- warning
- error
- critical
- alert
- emergency
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict