3 alarms module command line syntax, 3xe d – GAI-Tronics VoIP Telephone Software Configuration Guide User Manual

Page 75

Advertising
background image

GAI-TRONICS

VoIP Telephone Configuration Guide

Page 75 of 88

9.3

ALARMS Module Command Line Syntax

Action

Verb

Parameters

Comment

1 2 3

SET

ALARM[1-

20]

REPORT

[ ON | OFF|

NONE]

This command specifies if an alarm will be generated on
assertion of an alarm condition only (ON) , on removal of the
alarm condition only (OFF) or on either event (ON+OFF) or
not at all (NONE)

ONTIME [0-

30000]

This command assigns alarm activation De-bounce Period to a
specific alarm number. The alarm event must be present at the
start and at the end of the de-bounce Period before the alarm
status will be signalled using e-mail or syslog messaging (If
enabled).
The period is specified in seconds and can take a value of 0 –
30,000. A value of 0 indicates that there is no de-bounce
period for this alarm type and a message will be generated
immediately the alarm event is detected.

OFFTIME [0-30000]

This command assigns an alarm removal De-bounce Period to
a specific alarm number. The alarm event must be absent at
the start and at the end of the de-bounce period before the
alarm clearance will be signalled using e-mail or syslog
messaging (if enabled).
The period is specified in seconds and can take a value of 0 –
30,000. A value of 0 indicates that there is no de-bounce
period for this alarm type and a message will be generated
immediately the alarm event is detected.

MSG “text”

This command replaces the default text message ALARM
ǻ<alarm_number>
with the text entered as Parameter 3.
The text is delineated by Quote marks and is a maximum of 40
characters. The status <on/off> is appended to the end of the
text. If the “text” value is blank , the default message is
reinstated.

SYSLOG

[ ON |

OFF]

This command enables or disables SYSLOG reporting for the
selected alarm number. This command will also set STATUS
reporting if not already applied.

MAIL

[ ON |
OFF ]

This command enables or disables SMTP reporting for the
selected alarm number. This command will also set STATUS
reporting if not already applied.

SHOW ALL

This command displays the current settings of the alarm
module. It also shows status information for the alarms.
An alarm can be :-

a)

ON - the alarm is in the up condition

b)

OFF – the alarm is in the down condition

c)

PENDING ON – the alarm has occurred but not
reached the end its de-bounce period

d)

PENDING OFF- the alarm has been cleared but not
yet been signalled

3XE

D

Advertising