This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

FindAlarmByKey

FindAlarmByKey(key): Alarm

Find alarm by key

Table 1. Parameters

key

String

Alarm key

Return

Alarm object with exactly matching key, or null if no active alarm has this key.

alarm = FindAlarmByKey("NODE_DOWN_0x000023A2"); //Will find alarm with key "NODE_DOWN_0x000023A2"
println(alarm.key); //Will print key "NODE_DOWN_0x000023A2"
println(alarm.message); //Will print alarm message, for example "Node down"