Triggers

From ISPWiki
Jump to: navigation, search

Overview

This module allows to inform administrators and start scripts automatically when certain events occur in DCImanager. After you enable the module in the left menu, you will see the "Triggers" modules with 2 sections:

  • "Triggers" - a list of triggers.
  • "History" - trigger fire history with event and trigger parameters.
Adding a new trigger

You need to create a trigger, select the type and subtype, specify the parameter values, and select actions that the system will perform when the event occurs.

You can set a number of values of the same type not to create several similar triggers. With the "Warehouse" type, the system can check partial case insensitive correspondence of the equipment type/model/name.

Actions

When an event occurs, the system may email the notification, run the script, perform both actions, or only one of them.

Email notifications

Complete the following steps to enable emails:

  1. Configure the server in the "Mail notifications" module
 If you use public mail serves (eg. gmail.com, mail.ru, yandex.ru, etc.) you may have problems with blocking of mailing similar to spam, so we recommend that you set up your own mail server to ensure the notifications will be sent
  1. On the trigger edit form select an admin who will receive notifications.
  2. The administrators should specify their email addresses in the user settings form, request the email confirmation, and confirm the email address.

By default the system sends notifications only when an event takes place. But the module configuration form you can select the "Notification upon status recovery"check box, and the system will also send the notification after the issue is resolved.

The notification language is taken from the mail recipient settings.

Staring the script

Scripts are kept in the scripts sub-directory of the unprivileged user, and are running with his permissions. You can select a script from the list or create a new one. Event parameters separated by spaces are passed into the script:

e.g. if the trigger fired when connection with a switch was lost and several switches are specified, the event parameter will look like this "equipment=8", where 8 is the identifier of the switch associated with the trigger. If the trigger has two and more parameters (e.g. switch and port), both parameters will be passed space separated. This allows to create more flexible scripts to handle events.

Fire history

In this section you can see a detailed list of fired triggers.

Trigger history


In the "Status" column you can see the information about performed operations (notification/script)

Clicking "Details" will show the detailed information about all parameters of the selected event.

History details