fortinet.fortimanager.fmgr_system_alertevent – Alert events.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr system alertevent module


fortinet.fortimanager.fmgr_system_alertevent – Alert events.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 Choices/Defaults Comments

bypass_validation

boolean

  • no

  • yes

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

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

  • present
  • absent

the directive to create, update or delete an object

system_alertevent

dictionary

the top level parameters set

alert-destination

list / elements=string

no description

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

  • mail

  • snmp
  • syslog

Destination type.

mail - Send email alert.

snmp - Send SNMP trap.

syslog - Send syslog message.

enable-generic-text

list / elements=string

  • enable
  • disable

no description

enable-severity-filter

list / elements=string

  • enable
  • disable

no description

event-time-period

string

  • 0.5

  • 1
  • 3
  • 6
  • 12
  • 24
  • 72
  • 168

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.

generic-text

string

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

name

string

Alert name.

num-events

string

  • 1

  • 5
  • 10
  • 50
  • 100

Minimum number of events required within time period.

1 - 1 event.

5 - 5 events.

10 - 10 events.

50 - 50 events.

100 - 100 events.

severity-filter

string

  • high

  • medium-high
  • medium
  • medium-low
  • low

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.

severity-level-comp

list / elements=string

  • string of >=
  • string of =
  • string of <=

no description

severity-level-logs

list / elements=string

  • no-check
  • information
  • notify
  • warning
  • error
  • critical
  • alert
  • emergency

no description

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

Default:

300

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



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 here, the following are the fields unique to this module:

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_alertevent_module.html