30.1. ALARM resource
Prev Chapter 30. ALARM resource Next

30.1. ALARM resource

This resource manages alarms inside Abilis CPX. It permits to send SNMP traps notifications through emails to the configured recipients. Configuring the smtp and snmp resources is needed to send emails.

30.1.1. Activating the ALARM resource

Add the resource to the Abilis system with the following command.

[17:32:07] ABILIS_CPX:a res:alarm

COMMAND EXECUTED

The ALARM resource may already exist in the system, but may not yet be active: set it active with the following command.

[17:34:00] ABILIS_CPX:s act res:alarm

COMMAND EXECUTED
[Caution]Caution

You must save the configuration and restart the Abilis to make the resource running (use the command warm start to reboot the Abilis) after adding or setting the ALARM active.

[17:35:45] ABILIS_CPX:s p alarm act:yes

COMMAND EXECUTED

[17:35:51] ABILIS_CPX:d p alarm

RES:Alarm - Not Saved (SAVE CONF), Not Refreshed (INIT) -----------------------
       ------------------------------------------------------------------------
Run    DESCR:Alarms_manager
       LOG:NO        ACT:YES  fifo-size:100    
       MAIL-ENABLE:YES
       MAIL-FROM:SYS
[Caution]Caution

Execute the initialization command init res:alarm to activate the changes made on the upper case parameters; use save conf and warm start commands to set active the changes made on the lowercase parameters.

30.1.2. ALARM resource parameters

Use the command below to display the parameters of the resource; the d p alarm ? command shows the meaning of parameters.

[17:42:10] ABILIS_CPX:d p alarm

RES:Alarm ---------------------------------------------------------------------
Run    DESCR:Alarms_manager
       LOG:NO        ACT:YES  fifo-size:100
       MAIL-ENABLE:YES
       MAIL-FROM:SYS

Meaning of the parameters:

LOG

State changes log and alarm generation [NO, D, S, A, L, T, ALL] [+E] (D: Debug Log; S: System Log; A: Alarm view; L: Local audible alarm; T: SNMP traps; +E: Extended Log of state changes).

ACT

Operation activation [NO, YES].

fifo-size

Notifications fifo size [10..500].

MAIL-ENABLE

Enable/disable e-mail sending [NO, YES].

MAIL-FROM

Sender of e-mail. From 0 up to 128 ASCII printable characters. Spaces are not allowed. Case is preserved. [SYS: the sender is the one configured in the MAIL-FROM parameter fo CTISYS resource]

The following command allows the administrator to change the configuration of the resource:

s p alarm parameter:value...

[Caution]Caution

Execute the initialization command init res:alarm to activate the changes made on the upper case parameters; use save conf and warm start commands to set active the changes made on the lowercase parameters.

30.1.3. The ALARM table

The alarm table contains the rules to monitor Abilis resources. The table can store up to 10 rules ordered by the ID parameter.

30.1.3.1. Displaying the ALARM Table (D ALARM)

This command shows the alarm table. If ID is omitted, the command shows all routings.

[16:45:15] ABILIS_CPX:_d alarm

-------------------------------------------------------------------------------
ID: |ENABLED:|MONITOR:|RES:              |ACTION:
    |MAIL-RCPT:
    |MAIL-RCPT-LIST:
-------------------------------------------------------------------------------
0    YES      TRAP     *                  MAIL
     alarms@mydomain.com
     #
-------------------------------------------------------------------------------

Meaning of parameters:

ID

Identifier of Alarms management rule [0..9] <Mandatory>.

ENABLED

Enable/disable this entry usage [NO, YES]. Default is NO.

MONITOR

Alarm/event to be monitored [NONE, TRAP]. Default is NONE.

RES

Resource for which the alarm/event is monitored or name. Default is #.

ACTION

Action to be executed when the monitored alarm/event occurs [NONE, MAIL]. Default is NONE.

MAIL-RCPT

Default e-mail recipient(s). From 0 up to 128 ASCII printable characters. Spaces are not allowed. Case is preserved. (Only for ACTION:MAIL). Default is <empty>.

MAIL_RCPT-LIST

TXT list of e-mail recipients [#, ListName] (Only for ACTION:MAIL). Default is <empty>.

30.1.3.2. Adding an ALARM (A ALARM)

This command adds a new alarm to the table with ID:xx, setting the indicated parameters to the specified values. Unspecified parameters are set to default values.The table can store up to 10 rules, so the ID parameter must be in the range [0...9].

[18:06:34] ABILIS_CPX:a alarm id:0 enabled:yes monitor:trap res:* action:mail mail-rcpt:alarms@mydomain.com

COMMAND EXECUTED

[18:09:03] ABILIS_CPX:d alarm id:0

- Not Saved (SAVE CONF) -------------------------------------------------------
-------------------------------------------------------------------------------
ID: |ENABLED:|MONITOR:|RES:              |ACTION:
    |MAIL-RCPT:
    |MAIL-RCPT-LIST:
-------------------------------------------------------------------------------
0    YES      TRAP     *                  MAIL
     alarms@mydomain.com
     #
-------------------------------------------------------------------------------
[Warning]Warning

Changes made on the ALARM table are immediately active. Remeber to save the configuration (save conf).

30.1.3.3. Deleting an ALARM (C ALARM)

It clears the alarm with the specified ID.

[18:33:33] ABILIS_CPX:d alarm

-------------------------------------------------------------------------------
ID: |ENABLED:|MONITOR:|RES:              |ACTION:
    |MAIL-RCPT:
    |MAIL-RCPT-LIST:
-------------------------------------------------------------------------------
0    YES      TRAP     *                  MAIL
     alarms@mydomain.com
     #
-------------------------------------------------------------------------------

[18:33:36] ABILIS_CPX:c alarm id:0

COMMAND EXECUTED

[18:34:00] ABILIS_CPX:d alarm

ALARM TABLE IS EMPTY
[Warning]Warning

Changes made on the ALARM table are immediately active. Remeber to save the configuration (save conf).

30.1.3.4. Modifying the ALARM Table (S ALARM)

This command sets the parameters of the rule identified by “ID:xx” to their new values. The syntax of the command is: s alarm id:xxx [par:value].

[18:38:54] ABILIS_CPX:d alarm

- Not Saved (SAVE CONF) -------------------------------------------------------
-------------------------------------------------------------------------------
ID: |ENABLED:|MONITOR:|RES:              |ACTION:
    |MAIL-RCPT:
    |MAIL-RCPT-LIST:
-------------------------------------------------------------------------------
2    NO       TRAP     *                  MAIL
     alarms@mydomain.com
     #
-------------------------------------------------------------------------------

[18:38:58] ABILIS_CPX:s alarm id:2 enabled:yes

COMMAND EXECUTED

[18:41:42] ABILIS_CPX:d alarm

- Not Saved (SAVE CONF) -------------------------------------------------------
-------------------------------------------------------------------------------
ID: |ENABLED:|MONITOR:|RES:              |ACTION:
    |MAIL-RCPT:
    |MAIL-RCPT-LIST:
-------------------------------------------------------------------------------
2    YES      TRAP     *                  MAIL
     alarms@mydomain.com
     #
-------------------------------------------------------------------------------
[Warning]Warning

Changes made on the ALARM table are immediately active. Remeber to save the configuration (save conf).

30.1.4. ALARM diagnostic and statistics

30.1.4.1. ALARM diagnostic

The following command is used to display the diagnostics of the ALARM resource:

d d alarm

it shows the state of the resource (STATE), the state of the email sending (MAIL-ENABLED), the number of notifications inside the FIFO (CUR-FIFO), the maximum number of notifications inside the FIFO (PEAK-FIFO), the maximum number of notifications which can be managed by the FIFO (MAX-FIFO).

[12:13:10] ABILIS_CPX:d d alarm

RES:Alarm ---------------------------------------------------------------------
       Alarms_manager                                                          
       STATE:ACTIVE    MAIL-ENABLED:YES
       CUR-FIFO:0      PEAK-FIFO:1      MAX-FIFO:100

30.1.4.2. ALARM statistics

The following commands are used to display the statistics of the ALARM resource:

d s alarm

it shows the statistics of the ALARM resource like: the number of received notifications (ALARM), the number of notifications successfully inserted in the FIFO (ALARM-SUCC), the number of notifications not inserted in the FIFO because the it's full (ALARM-OVR), the number of notifications not inserted in the FIFO for any other reason, the number of trap notifications extracted from FIFO (TRAP), the number of notifications successfully managed (TRAP-SUCC), the number of discarded notifications because they don't match any rule (TRAP-DISC), the number of sent mails (MAIL), the number of successfully sent mails (MAIL-SUCC), the number of mails (MAIL-FAIL) whose sendig is failed.

[12:14:52] ABILIS_CPX:d s alarm

RES:Alarm ---------------------------------------------------------------------
       Alarms_manager                                                          
       --- Cleared 0 days 00:39:03 ago, on 05/05/2011 at 11:36:38 -------------
       -----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
       ALARM      |          1|          1|ALARM-OVR  |          0|           |
       ALARM-SUCC |          1|          1|ALARM-FAIL |          0|          0|
       TRAP       |          1|           |MAIL       |           |          1|
       TRAP-SUCC  |          1|           |MAIL-SUCC  |           |          1|
       TRAP-DISC  |          0|           |MAIL-FAIL  |           |          0|
       ------------------------------------------------------------------------
Prev Up Next
Chapter 30. ALARM resource Home Chapter 31. UPNP - Universal Plug and Play