Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlarmDAO

Data access for OnmsAlarm objects.

Hierarchy

Index

Constructors

constructor

Accessors

filterProcessor

http

Methods

acknowledge

  • acknowledge(alarm: number | OnmsAlarm, user?: string): Promise<void>
  • Acknowledge an alarm.

    version

    ReST v1+

    Parameters

    • alarm: number | OnmsAlarm
    • Optional user: string

      The user to ack the alarm as. (Only administrators have the right to do this.)

    Returns Promise<void>

clear

  • clear(alarm: number | OnmsAlarm): Promise<void>

closeTicket

  • closeTicket(alarm: number | OnmsAlarm): Promise<void>

createTicket

  • createTicket(alarm: number | OnmsAlarm): Promise<void>

escalate

  • escalate(alarm: number | OnmsAlarm): Promise<void>

find

get

Protected getApiVersion

  • getApiVersion(): number

Protected getCount

  • getCount(data: any): number
  • A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.

    Parameters

    • data: any

    Returns number

setTTicketId

  • setTTicketId(alarm: number | OnmsAlarm, ticketId: string): Promise<void>
  • Associate a ticket ID with the alarm.

    version

    ReST v1+

    Parameters

    Returns Promise<void>

setTTicketState

Protected toDate

  • toDate(from: any): Moment | undefined

Protected toNumber

  • toNumber(from: any): number | undefined

triggerTicketUpdate

  • triggerTicketUpdate(alarm: number | OnmsAlarm): Promise<void>
  • Notify OpenNMS it should fetch updated ticket state for an alarm from the remote ticketing system.

    version

    ReST v2

    Parameters

    Returns Promise<void>

unacknowledge

  • unacknowledge(alarm: number | OnmsAlarm): Promise<void>

Generated using TypeDoc