fmgr_system_alertevent – Alert events.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.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 FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- system_alertevent - Alert events. type: dict
- alert_destination (Alias name: alert-destination) Alert-destination. type: list
more...
- from Sender email address to use in alert emails. type: str more...
- smtp_name (Alias name: smtp-name) Smtp server name. type: str more...
- snmp_name (Alias name: snmp-name) Snmp trap name. type: str more...
- syslog_name (Alias name: 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 (Alias name: enable-generic-text) Enable/disable generic text match. type: list choices: [enable, disable] more...
- enable_severity_filter (Alias name: enable-severity-filter) Enable/disable alert severity filter. type: list choices: [enable, disable] more...
- event_time_period (Alias name: event-time-period) Time period (hours). type: str choices: [0.5, 1, 3, 6, 12, 24, 72, 168] default: 0.5 more...
- generic_text (Alias name: generic-text) Text that must be contained in a log to trigger alert. type: str more...
- name Alert name. type: str more...
- num_events (Alias name: num-events) Minimum number of events required within time period. type: str choices: [1, 5, 10, 50, 100] default: 1 more...
- severity_filter (Alias name: severity-filter) Required log severity to trigger alert. type: str choices: [high, medium-high, medium, medium-low, low] default: high more...
- severity_level_comp (Alias name: severity-level-comp) Log severity threshold comparison criterion. type: list choices: [>=, =, <=] more...
- severity_level_logs (Alias name: severity-level-logs) Log severity threshold level. type: list choices: [no-check, information, notify, warning, error, critical, alert, emergency] more...
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
- 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: 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 FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.