opennms/src/model/OnmsAlarm.ts

Client API for the OpenNMS network monitoring platform

import {Moment} from 'moment';

import {IHasUrlValue} from '../api/IHasUrlValue';
import {OnmsAlarmType} from './OnmsAlarmType';
import {OnmsAlarmSummary} from './OnmsAlarmSummary';
import {OnmsEvent} from './OnmsEvent';
import {OnmsParm} from './OnmsParm';
import {OnmsServiceType} from './OnmsServiceType';
import {OnmsSeverity} from './OnmsSeverity';
import {OnmsTroubleTicketState} from './OnmsTroubleTicketState';
import {OnmsMemo} from './OnmsMemo';

/**
 * Represents an OpenNMS alarm.
 * @category Model
 */
export class OnmsAlarm implements IHasUrlValue {
  /** the alarm ID */
  public id?: number;

  /** the number of times this alarm has triggered */
  public count?: number;

  /** the user that acknowledged this alarm */
  public ackUser?: string;

  /** the time this alarm was acknowledged */
  public ackTime?: Moment;

  /** the UEI of the event associated with this alarm */
  public uei?: string;

  /** the alarm's severity */
  public severity?: OnmsSeverity;

  /** the alarm's type */
  public type?: OnmsAlarmType;

  /** the alarm's description */
  public description?: string;

  /** the first time an event has triggered this alarm */
  public firstEventTime?: Moment;

  /** the most recent event that triggered this alarm */
  public lastEvent?: OnmsEvent;

  /** the alarm's log message */
  public logMessage?: string;

  /** which location the alarm originated from */
  public location?: string;

  /** the alarm's reduction key */
  public reductionKey?: string;

  /** the trouble ticket ID associated with this alarm */
  public troubleTicket?: string;

  /** the state of the trouble ticket associated with this alarm */
  public troubleTicketState?: OnmsTroubleTicketState;

  /** the link to the trouble ticket system if defined */
  public troubleTicketLink?: string;

  /** the node's ID associated with this alarm */
  public nodeId?: number;

  /** the node's label associated with this alarm */
  public nodeLabel?: string;

  /** the service associated with the event */
  public service?: OnmsServiceType;

  /** when the alarm was suppressed */
  public suppressedTime?: Moment;

  /** when the alarm will stop being suppressed */
  public suppressedUntil?: Moment;

  /** who the alarm was suppressed by */
  public suppressedBy?: string;

  /** the parameters emitted with this alarm's event */
  public parameters?: OnmsParm[];

  /** relatedAlarms - A list of alarms related to this alarm/situation */
  public relatedAlarms?: OnmsAlarmSummary[];

  /** managedObjectType - the type associated with this alarm if it is a situation */
  public managedObjectType?: string;

  /** managedObjectInstance - the instance associated with this alarm if it is a situation */
  public managedObjectInstance?: string;

  /** sticky memo - a note associated with this specific alarm instance */
  public sticky?: OnmsMemo;

  /** journal memo - a note associated with the reduction key for this alarm */
  public journal?: OnmsMemo;

  /** operator instructions */
  public operatorInstructions?: string;

  /** If this alarm is a Situation, the number of Nodes affected by its RelatedAlarms, a value of 1 otherwise */
  public affectedNodeCount?: number;

  /** the most recent time the event has triggered this alarm */
  public get lastEventTime() {
    if (this.lastEvent && this.lastEvent.time) {
      return this.lastEvent.time;
    }
    return undefined;
  }

  /** link to the alarm details page on the source instance */
  public detailsPage?: string;

  /** whether the alarm has been acknowledged */
  public get isAcknowledged() {
    return this.ackTime !== undefined && this.ackTime !== null;
  }

  /** whether the alarm is a situation */
  public get isSituation() {
    return this.relatedAlarms && this.relatedAlarms.length > 0;
  }

  /** @inheritdoc */
  public get urlValue() {
    return String(this.id);
  }

}