• Public
  • Public/Protected
  • All

Represents an OpenNMS alarm.


  • OnmsAlarm





ackTime?: Moment

the time this alarm was acknowledged

ackUser?: string

the user that acknowledged this alarm

affectedNodeCount?: number

If this alarm is a Situation, the number of Nodes affected by its RelatedAlarms, a value of 1 otherwise

count?: number

the number of times this alarm has triggered

description?: string

the alarm's description

detailsPage?: string

link to the alarm details page on the source instance

firstEventTime?: Moment

the first time an event has triggered this alarm

id?: number

the alarm ID

journal?: Model.OnmsMemo

journal memo - a note associated with the reduction key for this alarm

lastEvent?: Model.OnmsEvent

the most recent event that triggered this alarm

location?: string

which location the alarm originated from

logMessage?: string

the alarm's log message

managedObjectInstance?: string

managedObjectInstance - the instance associated with this alarm if it is a situation

managedObjectType?: string

managedObjectType - the type associated with this alarm if it is a situation

nodeId?: number

the node's ID associated with this alarm

nodeLabel?: string

the node's label associated with this alarm

operatorInstructions?: string

operator instructions

parameters?: Model.OnmsParm[]

the parameters emitted with this alarm's event

reductionKey?: string

the alarm's reduction key

relatedAlarms?: Model.OnmsAlarmSummary[]

relatedAlarms - A list of alarms related to this alarm/situation

the service associated with the event

severity?: Model.OnmsSeverity

the alarm's severity

sticky?: Model.OnmsMemo

sticky memo - a note associated with this specific alarm instance

suppressedBy?: string

who the alarm was suppressed by

suppressedTime?: Moment

when the alarm was suppressed

suppressedUntil?: Moment

when the alarm will stop being suppressed

troubleTicket?: string

the trouble ticket ID associated with this alarm

troubleTicketLink?: string

the link to the trouble ticket system if defined

troubleTicketState?: Model.OnmsTroubleTicketState

the state of the trouble ticket associated with this alarm

the alarm's type

uei?: string

the UEI of the event associated with this alarm


  • get isAcknowledged(): boolean
  • get isSituation(): boolean
  • get lastEventTime(): Moment
  • get urlValue(): string

Generated using TypeDoc