fortinet.fortimanager.fmgr_system_alertevent module – Alert events.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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 version 2.10: of fortinet.fortimanager

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

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_alertevent

dictionary

the top level parameters set

alert-destination

list / elements=string

Alert-Destination.

from

string

Sender email address to use in alert emails.

smtp-name

string

SMTP server name.

snmp-name

string

SNMP trap name.

syslog-name

string

Syslog server name.

to

string

Recipient email address to use in alert emails.

type

string

Destination type.

mail - Send email alert.

snmp - Send SNMP trap.

syslog - Send syslog message.

Choices:

  • mail ← (default)

  • snmp

  • syslog

enable-generic-text

list / elements=string

Enable/disable generic text match.

Choices:

  • enable

  • disable

enable-severity-filter

list / elements=string

Enable/disable alert severity filter.

Choices:

  • enable

  • disable

event-time-period

string

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.

Choices:

  • 0.5 ← (default)

  • 1

  • 3

  • 6

  • 12

  • 24

  • 72

  • 168

generic-text

string

Text that must be contained in a log to trigger alert.

name

string

Alert name.

num-events

string

Minimum number of events required within time period.

1 - 1 event.

5 - 5 events.

10 - 10 events.

50 - 50 events.

100 - 100 events.

Choices:

  • 1 ← (default)

  • 5

  • 10

  • 50

  • 100

severity-filter

string

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:

  • high ← (default)

  • medium-high

  • medium

  • medium-low

  • low

severity-level-comp

list / elements=string

Log severity threshold comparison criterion.

Choices:

  • >=

  • =

  • <=

severity-level-logs

list / elements=string

Log severity threshold level.

Choices:

  • no-check

  • information

  • notify

  • warning

  • error

  • critical

  • alert

  • emergency

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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: fortimanager00
  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
        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: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the alert events
     fmgr_fact:
       facts:
           selector: 'system_alertevent'
           params:
               alert-event: ''

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)