Asentria SiteBoss 530 User Manual
94
Action List
An action list is a text string that specifies what the unit should do upon an event. It's comprised of a list of keywords
and parameters separated by semicolon. Each keyword specifies a certain action and has its own parameter set,
which is enclosed in parentheses.
For example, the keyword
trap
has a parameter <
ipaddress or index
>, and has syntax
trap(ipaddress or index)
in an
action list. This keyword means send an SNMP trap to the specified parameter. If the parameter is an IP address then
that address is the trap destination. If the parameter is an index then it uses the address specified in the
corresponding index # for Hostname/IP Address in the Action Definitions menu. (This IP action setting list is
action.ip
, so trap(1) means send a trap to the address in setting
action.ip[1]
.)
•
Cancel: cancel(
idname
)
Cancel any running action list identified by
idname
.
•
Dialup Pager: dpage(index)
Send a pager callout via modem; index is the phone number configured with
action.page.number
•
Dispatcher: dispatch(
phone#
or
index
)
Send a Dispatcher alarm via modem;
index
is the phone number configured with
action.call.number
.
E.g.,
action.call.number[index]
.
•
Email: email(
or
index
)
Send an email to the address specified by
;
index
is the email address configured with
action.email
•
Group: group(
groupname
)
Identify this action list as part of a group identified by
groupname
; not currently used. In a future version this
will be used to cancel or postpone groups of action lists.
•
ID: id(
idname
)
Identify this action list by
idname
.
•
Inform: inform(
ipaddress or index
)
Send an SNMP inform to a specific IP address or
index
which refers to an IP address or host name configured
in the Action Definitions menu.
•
Malert: malert(
phone# or index
)
Send an malert (Asentria Alarm via modem); the parameters are the same as for the dispatch keyword.
•
Modem: modem(
phone# or index
)
Make the unit dial a phone number and start a login session (to the unit's command processor) with the
answering machine. The parameters are the same as for the dispatch keyword.
•
Postpone: postpone(
idname, seconds
)
Postpone an already-running action list identified by
idname
for a duration specified by
seconds
.
•
Pause: pause(
seconds
)
Pause operation for a duration specified by
seconds
.
•
Relay: relay(action, EventSensor, point)
Put a relay in a certain state specified by
action
.
°
action
: one of the following two words, by case-insensitive exact match or partial unambiguous
match:
active
or
inactive
. “Active” always means to energize the relay.
°
EventSensor
: the number of the EventSensor that has the specified relay, where it is the same as
that referred to by the index in an EventSensor key (e.g., 1 in
event.sensor[1].*
for the first
external EventSensor) as well as that referred to by the SNMP esIndex object.
°
point
: the number of the relay (1-based) on the specified EventSensor. E.g., this is the same number x in
"
event.sensor[1].relay[x].*"
Summary of Contents for SiteBoss 530
Page 6: ......
