Class OnmsAlarm

Represents an OpenNMS alarm.

Implements

Constructors

constructor

Properties

ackTime? ackUser? affectedNodeCount? count? description? detailsPage? firstEventTime? id? journal? lastEvent? location? logMessage? managedObjectInstance? managedObjectType? nodeId? nodeLabel? operatorInstructions? parameters? reductionKey? relatedAlarms? service? severity? sticky? suppressedBy? suppressedTime? suppressedUntil? troubleTicket? troubleTicketLink? troubleTicketState? type? uei?

Accessors

isAcknowledged isSituation lastEventTime urlValue

Constructors

constructor

Properties

OptionalackTime

ackTime?: Moment

the time this alarm was acknowledged

OptionalackUser

ackUser?: string

the user that acknowledged this alarm

OptionalaffectedNodeCount

affectedNodeCount?: number

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

Optionalcount

count?: number

the number of times this alarm has triggered

Optionaldescription

description?: string

the alarm's description

OptionaldetailsPage

detailsPage?: string

link to the alarm details page on the source instance

OptionalfirstEventTime

firstEventTime?: Moment

the first time an event has triggered this alarm

Optionalid

id?: number

the alarm ID

Optionaljournal

journal?: OnmsMemo

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

OptionallastEvent

lastEvent?: OnmsEvent

the most recent event that triggered this alarm

Optionallocation

location?: string

which location the alarm originated from

OptionallogMessage

logMessage?: string

the alarm's log message

OptionalmanagedObjectInstance

managedObjectInstance?: string

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

OptionalmanagedObjectType

managedObjectType?: string

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

OptionalnodeId

nodeId?: number

the node's ID associated with this alarm

OptionalnodeLabel

nodeLabel?: string

the node's label associated with this alarm

OptionaloperatorInstructions

operatorInstructions?: string

operator instructions

Optionalparameters

parameters?: OnmsParm[]

the parameters emitted with this alarm's event

OptionalreductionKey

reductionKey?: string

the alarm's reduction key

OptionalrelatedAlarms

relatedAlarms?: OnmsAlarmSummary[]

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

Optionalservice

service?: OnmsServiceType

the service associated with the event

Optionalseverity

severity?: OnmsSeverity

the alarm's severity

Optionalsticky

sticky?: OnmsMemo

sticky memo - a note associated with this specific alarm instance

OptionalsuppressedBy

suppressedBy?: string

who the alarm was suppressed by

OptionalsuppressedTime

suppressedTime?: Moment

when the alarm was suppressed

OptionalsuppressedUntil

suppressedUntil?: Moment

when the alarm will stop being suppressed

OptionaltroubleTicket

troubleTicket?: string

the trouble ticket ID associated with this alarm

OptionaltroubleTicketLink

troubleTicketLink?: string

the link to the trouble ticket system if defined

OptionaltroubleTicketState

troubleTicketState?: OnmsTroubleTicketState

the state of the trouble ticket associated with this alarm

Optionaltype

type?: OnmsAlarmType

the alarm's type

Optionaluei

uei?: string

the UEI of the event associated with this alarm

Accessors

isAcknowledged

isSituation

lastEventTime

  • get lastEventTime(): Moment

  • the most recent time the event has triggered this alarm

    Returns Moment

urlValue

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors