This resource manages alarms inside Abilis CPX. It permits to send SNMP traps notifications, Digital or Analog Input/Output line variation through emails or SMS to the configured recipients. Configuring the SMTP and SNMP resources is needed to send emails.
Important | |
---|---|
The SMTP resource requires a separate licence in CPX. |
For sending SMS is needed to have a UMTSBOX or CELLKEY device and to configure also the CTISMS resource.
Important | |
---|---|
The CTISMS resource requires a separate licence in CPX. |
It permits also to make an automatic call with the announcement of the current notification. The call is made from the CTIDISA resource. Configuring the CTIDISA call-back is needed to receive the voice notification to the phone. The played message in this call is the WELCOME and/or the INITDIAL, please see Section 53.8, “Message files”.
Important | |
---|---|
The CTIDISA resource requires a separate licence in CPX. |
Tip | |
---|---|
Interesting chapters: Chapter 33, SMTP - Simple Mail Transfer Protocol; Section 53.6, “Example of Call Back configuration”; Chapter 55, CTISMS - CTI SMS 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 | |
---|---|
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-FROM:AUTO (alarm@abilis_cpx) MAIL-RCPT:# MAIL-BODY:STANDARD -- SMS ----------------------------------------------------------------- SMS-SENDER:CP-PI SMS-CDO:# -- Disa Voice Call ----------------------------------------------------- DISA-USER:# DISA-SERVICE:# DISA-CDO:# DISA-CGO:#
Caution | |
---|---|
Execute the initialization command init 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. |
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-FROM:AUTO (alarm@abilis_cpx)
MAIL-RCPT:#
MAIL-BODY:STANDARD
-- SMS -----------------------------------------------------------------
SMS-SENDER:CP-PI SMS-CDO:#
-- Disa Voice Call -----------------------------------------------------
DISA-USER:# DISA-SERVICE:#
DISA-CDO:# DISA-CGO:#
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-FROM
Sender of e-mail. "SYS" or "AUTO" or a valid e-mail address.
SYS
: the mail sender configured in
CTISYS 'MAIL-SENDER' is used;
AUTO
: a fixed value is used (e.g.
alarm@<cp-prompt>);
e-mail address
: max 128 ASCII
characters. Space not allowed.
MAIL-RCPT
Default e-mail recipient(s). # or max 128 ASCII characters. Space not allowed.
MAIL-BODY
Default e-mail body type [STANDARD
,
SMS-LIKE
].
SMS-SENDER
Text to be used as sender in SMS messages [CP-PI, SYSNAME, R-ID], where:
CP-PI
: is the current value of
Control Port 'PI' parameter;
SYSNAME
: is the current value of
General 'SYSNAME' parameter;
R-ID
: is the current value of IP
Router 'R-ID' parameter.
SMS-CDO
Default Outgoing called number for SMS. # or max 20 digits optionally preceded by TON [u, i, n, o, s, h, c] and/or NP [x, e, d, t, l, p] attributes.
Tip | |
---|---|
Interesting chapter: Section 75.25, “Sending Alarm through SMS”. |
DISA-USER
Name of an existing CtiDisa user for DISA CallBack. # or max 16 ASCII characters. Space not allowed. If the user is not configured, the (!) mark is displayed beside the name.
DISA-SERVICE
Name of an existing CtiDisa service for DISA CallBack. # or max 16 ASCII characters. Space not allowed. If the service is not configured, the (!) mark is displayed beside the name.
DISA-CDO
Outgoing called number for DISA CallBack. # or max 20 digits optionally preceded by TON [u, i, n, o, s, h, c] and/or NP [x, e, d, t, l, p] attributes. See also HELP ISDN ATTRIBUTES.
DISA-CGO
Outgoing calling number for DISA CallBack. # or max 20 digits optionally preceded by TON [u, i, n, o, s, h, c] and/or NP [x, e, d, t, l, p] and/or PI [a, r, m, q] and/or SI [y, v, w, z] attributes. See also HELP ISDN ATTRIBUTES.
The following command allows the administrator to change the configuration of the resource:
s p alarm
parameter
:value
...
Caution | |
---|---|
Execute the initialization command init 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. |
The alarm table contains the rules to monitor Abilis resources. The table can store up to 20 rules ordered by the ID parameter.
This command shows the alarm table. If ID is omitted, the command shows all routings.
[16:45:15] ABILIS_CPX:d alarm
-------------------------------------------------------------------------------
ID: |[DESCR:]
|ENABLED:|RES: |IO: |TRIGGER: |ACTION:
|MAIL-RCPT:
|MAIL-RCPT-LIST:
|MAIL-BODY:
|SMS-CDO:
|DISA-USER: |DISA-SERVICE:
|DISA-CDO: |DISA-CGO:
-------------------------------------------------------------------------------
0 YES Ip-3 TRAP MAIL
- MAIL -------------------------------------------------------------------
alarms@mydomain.com
#
SYS
-------------------------------------------------------------------------------
Meaning of parameters:
ID
Identifier of Alarms management rule [0..19].
ENABLED
Enable/disable this entry usage [NO, YES]. Default is NO.
RES
Resource for which the alarm/event is monitored.
#
or *
or
type-nnn
or type-*
or
CtiP-nnn
or CtiP-*
or the
name of a CPX resources list between single . Default is
#
. (e.g. *
or
Ip-*
or CtiP-541
or
Eth-1
or MFIO
or
'mylist')
IO
Input/output line for which the alarm/event is monitored:
#
: None Input/Output line;
for GPIO:
D-IN-n
or
D-OUT-n
, where 'n
'
can be [1..16, *];
A-IN-n
, where
'n
' can be [1..8, *];
for MFIO: D-IN-n
or
D-OUT-n
, where 'n
' can
be [1..7, *];
for RIO:
D-IN-n
or
D-OUT-n
, where 'n
'
can be [1..16, *];
A-IN-n
or
A-OUT-n
, where 'n
'
can be [1..8, *];
for RVS: D-IN-n
or
D-OUT-n
, where 'n
' can
be [1..4, *].
Caution | |
---|---|
Only for Gpio/MfIo/Rio/Rvs resources. |
Tip | |
---|---|
Interesting chapter: Chapter 16, IOBOX. |
TRIGGER
Alarm/event to be monitored [NONE
: None
event type, TRAP
: Snmp TRAP sent,
ALARM-ON
: Alarm switched ON,
ALARM-OFF
: Alarm switched OFF,
ALARM-*
: Alarm switched ON/OFF,
ON
: Digital Input/Output Line state ON,
OFF
: Digital Input/Output Line state OFF,
LOW
: Analog Input/Output Line state LOW,
NORMAL
: Analog Input/Output Line state
NORMAL, HIGH
: Analog Input/Output Line state
HIGH, *
: Input/Output Line state
ON/OFF/LOW/NORMAL/HIGH]. 'ON', 'OFF', '*' are allowed only for
Digital lines; 'LOW', 'NORMAL', 'HIGH', '*' are allowed only for
Analog lines.
Caution | |
---|---|
|
ACTION
Action to be executed when the monitored alarm/event
occurs [NONE
: No action has to be executed.
The rule will be ignored; MAIL
: E-mail must
be sent; DISA-CB
: CTIDisa call-back must be
sent; SMS
: SMS must be sent.]. Values can be
joined using "," operator.
Caution | |
---|---|
|
MAIL-RCPT
E-mail recipient(s). "SYS" or "#" or 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>.
MAIL-BODY
E-mail body type [SYS
,
STANDARD
, SMS-LIKE
]. Only
for ACTION
:MAIL
.
SMS-CDO
Outgoing called number for SMS. "SYS" or "#" or up to 20
digits optionally preceded by TON [u, i, n, o, s, h, c] and/or
NP [x, e, d, t, l, p] attributes or the name of an IN list between single quotes
(e.g. 'mylist'). Only for
ACTION
:SMS
.
Tip | |
---|---|
Interesting chapter: Section 75.25, “Sending Alarm through SMS”. |
DISA-USER
Name of an existing CtiDisa user for DISA CallBack. SYS or
# or max 16 ASCII characters. Space not allowed. If the user is
not configured, the (!) mark is displayed beside the name. Only
for ACTION
:DISA-CB
.
DISA-SERVICE
Name of an existing CtiDisa service for DISA CallBack. SYS
or # or max 16 ASCII characters. Space not allowed. If the
service is not configured, the (!) mark is displayed beside the
name. Only for
ACTION
:DISA-CB
.
DISA-CDO
Outgoing called number for DISA CallBack. SYS or # or max
20 digits optionally preceded by TON [u, i, n, o, s, h, c]
and/or NP [x, e, d, t, l, p] attributes. See also HELP ISDN
ATTRIBUTES. Only for
ACTION
:DISA-CB
.
DISA-CGO
Outgoing calling number for DISA CallBack. SYS or # or max
20 digits optionally preceded by TON [u, i, n, o, s, h, c]
and/or NP [x, e, d, t, l, p] and/or PI [a, r, m, q] and/or SI
[y, v, w, z] attributes. See also HELP ISDN ATTRIBUTES. Only for
ACTION
:DISA-CB
.
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 20 rules, so the
ID
parameter must be in the range [0...19].
[18:06:34] ABILIS_CPX:a alarm id:0 enabled:yes trigger:trap res:* action:mail mail-rcpt:alarms@mydomain.com
COMMAND EXECUTED [18:09:03] ABILIS_CPX:d alarm id:0
- Not Saved (SAVE CONF), Not Refreshed (INIT) --------------------------------- ------------------------------------------------------------------------------- ID: |[DESCR:] |ENABLED:|RES: |IO: |TRIGGER: |ACTION: |MAIL-RCPT: |MAIL-RCPT-LIST: |MAIL-BODY: |SMS-CDO: |DISA-USER: |DISA-SERVICE: |DISA-CDO: |DISA-CGO: ------------------------------------------------------------------------------- 0 YES * # TRAP MAIL - MAIL ------------------------------------------------------------------- alarms@mydomain.com # SYS -------------------------------------------------------------------------------
Warning | |
---|---|
To activate the changes made on the ALARM table, execute the initialization command init alarm. Remember to save the configuration (save conf). |
Tip | |
---|---|
Interesting chapters: Section 75.24, “Sending Alarm through a call”; Section 75.25, “Sending Alarm through SMS”; Section 16.5.1, “Activation of the alarms for the MFIO/GPIO”. |
This command adds a new alarm to the alarm table only for resource TRFA.
[18:06:34] ABILIS_CPX:a alarm id:1 enabled:yes trigger:trap res:trfa action:mail mail-rcpt:alarms@mydomain.com
COMMAND EXECUTED [18:09:03] ABILIS_CPX:d alarm id:1
- Not Saved (SAVE CONF), Not Refreshed (INIT) --------------------------------- ------------------------------------------------------------------------------- ID: |[DESCR:] |ENABLED:|RES: |IO: |TRIGGER: |ACTION: |MAIL-RCPT: |MAIL-RCPT-LIST: |MAIL-BODY: |SMS-CDO: |DISA-USER: |DISA-SERVICE: |DISA-CDO: |DISA-CGO: ------------------------------------------------------------------------------- 1 YES TRFA # TRAP MAIL - MAIL ------------------------------------------------------------------- alarms@mydomain.com # SYS -------------------------------------------------------------------------------
Warning | |
---|---|
To activate the changes made on the ALARM table, execute the initialization command init alarm. Remember to save the configuration (save conf). |
Tip | |
---|---|
To configure a TRFA Trap, refer to: Section 46.2, “TRFA Traps” |
It clears the alarm with the specified ID.
[18:33:33] ABILIS_CPX:d alarm
------------------------------------------------------------------------------- ID: |[DESCR:] |ENABLED:|RES: |IO: |TRIGGER: |ACTION: |MAIL-RCPT: |MAIL-RCPT-LIST: |MAIL-BODY: |SMS-CDO: |DISA-USER: |DISA-SERVICE: |DISA-CDO: |DISA-CGO: ------------------------------------------------------------------------------- 0 YES * # TRAP MAIL - MAIL ------------------------------------------------------------------- alarms@mydomain.com # SYS ------------------------------------------------------------------------------- [18:33:36] ABILIS_CPX:c alarm id:0
COMMAND EXECUTED [18:34:00] ABILIS_CPX:d alarm
------------------------------------------------------------------------------- ID: |[DESCR:] |ENABLED:|RES: |IO: |TRIGGER: |ACTION: |MAIL-RCPT: |MAIL-RCPT-LIST: |MAIL-BODY: |SMS-CDO: |DISA-USER: |DISA-SERVICE: |DISA-CDO: |DISA-CGO: ------------------------------------------------------------------------------- *** ALARM TABLE IS EMPTY ***
Warning | |
---|---|
To activate the changes made on the ALARM table, execute the initialization command init alarm. Remember to save the configuration (save conf). |
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), Not Refreshed (INIT) --------------------------------- ------------------------------------------------------------------------------- ID: |[DESCR:] |ENABLED:|RES: |IO: |TRIGGER: |ACTION: |MAIL-RCPT: |MAIL-RCPT-LIST: |MAIL-BODY: |SMS-CDO: |DISA-USER: |DISA-SERVICE: |DISA-CDO: |DISA-CGO: ------------------------------------------------------------------------------- 2 NO * # TRAP MAIL - MAIL ------------------------------------------------------------------- alarms@mydomain.com # SYS ------------------------------------------------------------------------------- [18:38:58] ABILIS_CPX:s alarm id:2 enabled:yes
COMMAND EXECUTED [18:41:42] ABILIS_CPX:d alarm
- Not Saved (SAVE CONF), Not Refreshed (INIT) --------------------------------- ------------------------------------------------------------------------------- ID: |[DESCR:] |ENABLED:|RES: |IO: |TRIGGER: |ACTION: |MAIL-RCPT: |MAIL-RCPT-LIST: |MAIL-BODY: |SMS-CDO: |DISA-USER: |DISA-SERVICE: |DISA-CDO: |DISA-CGO: ------------------------------------------------------------------------------- 2 YES * # TRAP MAIL - MAIL ------------------------------------------------------------------- alarms@mydomain.com # SYS -------------------------------------------------------------------------------
Warning | |
---|---|
To activate the changes made on the ALARM table, execute the initialization command init alarm. Remember to save the configuration (save conf). |
This command reports the current situation of the ALARM resource:
[12:13:10] ABILIS_CPX:d d alarm
RES:Alarm ---------------------------------------------------------------------
Alarms_manager
STATE:ACTIVE
RULES-CUR:5 RULES-ACT:2 RULES-MAX:20
FIFO-CUR:0 FIFO-PEAK:15 FIFO-MAX:100
The meaning:
STATE
The ALARM driver state:
INACTIVE
- configuration parameter
ACT
:NO
.
ACTIVE
- fully ready to
work.
RULES-CUR
Rules currently present in the Alarm rules table.
RULES-ACT
Valid/usable rules currently present in the Alarm rules
table. Valid/usable rule is a rule where
ENABLED
:YES
, the
RES
field is not set to
NONE
, the MONITOR
field is
not set to NONE
and the
ACTION
field is not set to
NONE
.
RULES-MAX
Max number of configurable rules.
FIFO-CUR
Notifications currently present in the FIFO.
FIFO-PEAK
The peak number of notifications in the FIFO.
FIFO-MAX
The maximum number of notifications that can be present in the FIFO.
This command can help to understand what is happening, in case of troubles:
[12:14:52] ABILIS_CPX:d s alarm
RES:Alarm ---------------------------------------------------------------------
Alarms_manager
--- Cleared 4 days 23:19:26 ago, on 11/10/2017 at 14:24:04 -------------
-----------|---INPUT---|--OUTPUT---|-----------|---INPUT---|--OUTPUT---|
ALARM | 329| 329|ALARM-OVR | 0| |
ALARM-SUCC | 329| 327|ALARM-FAIL | 0| 2|
------------------------------------------------------------------------
-----------+-----------+-----------+-----------|
Trigger | Succ. | Fail | Total |
-----------+-----------+-----------+-----------|
TRAP | 3| 0| 3|
ALARM-ON | 1| 0| 1|
ALARM-OFF | 1| 0| 1|
ON | 149| 0| 149|
OFF | 173| 2| 175|
LOW | 0| 0| 0|
NORMAL | 0| 0| 0|
HIGH | 0| 0| 0|
-----------+-----------+-----------+-----------|
Action | Succ. | Fail | Total |
-----------+-----------+-----------+-----------|
MAIL | 2| 0| 2|
DISA-CB | 0| 0| 0|
SMS | 0| 0| 0|
-----------+-----------+-----------+------------
With reference to the shown interval of time («Cleared 4 days 23:19:26 ago») these counters show the number of:
ALARM | IN - alarm notifications received. OUT - alarm notifications managed. |
ALARM-SUCC | IN - alarm notifications received and inserted into the FIFO. OUT - alarm notifications managed with success. |
ALARM-OVR | Alarm notifications received but discarded because the FIFO is full. |
ALARM-FAIL | IN - alarm notifications received but discarded for other reasons. OUT - alarm notifications managed but failed. |
TRAP | SNMP trap notifications: Succ. :
notifications for which the action was executed.
Fail : notifications discarded (No rule, no
res, no action,...). Total : notifications
received. |
ALARM-ON/OFF | ALARM-ON/OFF notifications:
Succ. : notifications for which the action
was executed. Fail : notifications discarded
(No rule, no res, no action,...). Total :
notifications received. |
ON/OFF | IO-ON/OFF notifications:
Succ. : notifications for which the action
was executed. Fail : notifications discarded
(No rule, no res, no action,...). Total :
notifications received. |
LOW/NORMAL/HIGH | IO-LOW/NORMAL/HIGH notifications:
Succ. : notifications for which the action
was executed. Fail : notifications discarded
(No rule, no res, no action,...). Total :
notifications received. |
MAIL | Mail messages: Succ. : messages sent.
Fail : messages NOT sent.
Total : notifications that request mail
sending. |
DISA-CB | Disa Call Back: Succ. : Disa Call
Back executed. Fail : Disa Call Back NOT
executed. Total : notifications that request
Disa Call Back execution. |
SMS | SMS: Succ. : SMS sent.
Fail : SMS NOT sent.
Total : notifications that request SMS
sending. |
Type the following command to view the commands allowed:
[15:36:09] ABILIS_CPX:debug res:alarm
RES:Alarm ---------------------------------------------------------------------
Alarms_manager
BufferLength:64512 Date/Time:16/10/2017 14:09:03 TraceTime:431070847
USAGE:
LSN == 0 : This help message
LSN == 1 : Alarms manager statistics
LSN == 2 : Display alarms trace information.
LSN == 3 : Display only alarms/event for which a matching rule
has been found.
LSN == 3 CMD:ALL : Display full alarms trace content.
LSN == 3 CMD:CLR : Clear alarms trace
LSN == 101 : ALARM-ON simulation from Ctip-31
LSN == 102 : ALARM-OFF simulation from Ip-1
LSN == 103 : IO-ON simulation from GPIO-1 IO:D-IN-8
LSN == 104 : IO-OFF simulation from MFIO-1 IO:D-OUT-3
LSN == 105 : IO-LOW simulation from GPIO-1 IO:A-IN-2
LSN == 106 : IO-NORMAL simulation from GPIO-1 IO:A-OUT-1
LSN == 107 : IO-HIGH simulation from GPIO-1 IO:A-IN-16
LSN == 108 : IO-ON simulation from RIO-1 IO:D-IN-8
LSN == 109 : IO-OFF simulation from RIO-1 IO:D-OUT-3
LSN == 110 : IO-LOW simulation from RIO-1 IO:A-IN-2
LSN == 111 : IO-NORMAL simulation from RIO-1 IO:A-OUT-1
LSN == 112 : IO-HIGH simulation from RIO-1 IO:A-IN-16
LSN == 113 : TRFA Ip trap: Ip-1 Throughput OUT 5Min Threshold Reached
LSN == 114 : TRFA Ip trap: Ip-50 Ttaffic TOT Month Threshold Reached
LSN == 115 : TRFA Cti trap, user:admin 5Min. Busy (In) Threshold Reached
LSN == 116 : TRFA Cti trap, service:serv5 Now Waiting Threshold Reached
LSN == 117 : TRFA Cti trap, number:prova Now Waiting Threshold Reached
LSN == 118 : TRFA Cti trap, user:admin 5Min. Busy (In) Threshold Left
LSN == 119 : TRFA Cti trap, service:serv5 Now Waiting Threshold Left
LSN == 120 : TRFA Cti trap, number:prova Now Waiting Threshold Left
Note | |
---|---|
To use these commands you need to have administrator or super user rights. |
Type the following command to display only alarms/event for which a matching rule has been found:
[15:44:23] ABILIS_CPX:debug res:alarm lsn:3
RES:Alarm ---------------------------------------------------------------------
Alarms_manager
BufferLength:64512 Date/Time:16/10/2017 14:13:08 TraceTime:431316294
Legend of possible 'Result' values and meanings:
- No rule : no rule found matching received notification.
- Ok : rule found, executed action successful.
- Fail : rule found, executed action failure.
- Bad : rule found with incomplete/bad content. Action not executed.
-------------------+------------------+-------+----+----------------+--------------
Loc. Date and Time |Res/Ctip [IO] |Trigger|Rule|Action(s) |Result(s)
-------------------+------------------+-------+----+----------------+--------------
16/10/2017 14:10:55|MfIo D-OUT-2 |ON | 1 |MAIL |Ok
Type the following command to display full alarms trace content:
[15:48:19] ABILIS_CPX:debug res:alarm lsn:3 cmd:all
RES:Alarm ---------------------------------------------------------------------
Alarms_manager
BufferLength:64512 Date/Time:16/10/2017 14:13:58 TraceTime:431366376
Legend of possible 'Result' values and meanings:
- No rule : no rule found matching received notification.
- Ok : rule found, executed action successful.
- Fail : rule found, executed action failure.
- Bad : rule found with incomplete/bad content. Action not executed.
-------------------+------------------+-------+----+----------------+--------------
Loc. Date and Time |Res/Ctip [IO] |Trigger|Rule|Action(s) |Result(s)
-------------------+------------------+-------+----+----------------+--------------
16/10/2017 13:44:32|MfIo D-IN-4 |ON | -- | |No rule
16/10/2017 13:50:07|MfIo D-IN-4 |OFF | -- | |No rule
16/10/2017 14:10:55|MfIo D-OUT-2 |ON | 1 |MAIL |Ok
16/10/2017 14:10:57|MfIo D-OUT-2 |OFF | -- | |No rule
16/10/2017 14:12:13|Ip-1 |ALM-ON | -- | |No rule
16/10/2017 14:12:56|Ip-1 |ALM-OFF| -- | |No rule