opennms
Version:
Client API for the OpenNMS network monitoring platform
866 lines • 44.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OnmsAlarm | OpenNMS.js</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">OpenNMS.js</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="onmsalarm.html">OnmsAlarm</a>
</li>
</ul>
<h1>Class OnmsAlarm</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Represents an OpenNMS alarm.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">OnmsAlarm</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ihasurlvalue.html" class="tsd-signature-type">IHasUrlValue</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#acktime" class="tsd-kind-icon">ack<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#ackuser" class="tsd-kind-icon">ack<wbr>User</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#affectednodecount" class="tsd-kind-icon">affected<wbr>Node<wbr>Count</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#count" class="tsd-kind-icon">count</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#detailspage" class="tsd-kind-icon">details<wbr>Page</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#firsteventtime" class="tsd-kind-icon">first<wbr>Event<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#journal" class="tsd-kind-icon">journal</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#lastevent" class="tsd-kind-icon">last<wbr>Event</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#location" class="tsd-kind-icon">location</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#logmessage" class="tsd-kind-icon">log<wbr>Message</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#managedobjectinstance" class="tsd-kind-icon">managed<wbr>Object<wbr>Instance</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#managedobjecttype" class="tsd-kind-icon">managed<wbr>Object<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#nodeid" class="tsd-kind-icon">node<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#nodelabel" class="tsd-kind-icon">node<wbr>Label</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#operatorinstructions" class="tsd-kind-icon">operator<wbr>Instructions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#parameters" class="tsd-kind-icon">parameters</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#reductionkey" class="tsd-kind-icon">reduction<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#relatedalarms" class="tsd-kind-icon">related<wbr>Alarms</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#service" class="tsd-kind-icon">service</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#severity" class="tsd-kind-icon">severity</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#sticky" class="tsd-kind-icon">sticky</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#suppressedby" class="tsd-kind-icon">suppressed<wbr>By</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#suppressedtime" class="tsd-kind-icon">suppressed<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#suppresseduntil" class="tsd-kind-icon">suppressed<wbr>Until</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#troubleticket" class="tsd-kind-icon">trouble<wbr>Ticket</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#troubleticketlink" class="tsd-kind-icon">trouble<wbr>Ticket<wbr>Link</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#troubleticketstate" class="tsd-kind-icon">trouble<wbr>Ticket<wbr>State</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="onmsalarm.html#uei" class="tsd-kind-icon">uei</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="onmsalarm.html#issituation" class="tsd-kind-icon">is<wbr>Situation</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="onmsalarm.html#lasteventtime" class="tsd-kind-icon">last<wbr>Event<wbr>Time</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="onmsalarm.html#urlvalue" class="tsd-kind-icon">url<wbr>Value</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="acktime" class="tsd-anchor"></a>
<h3>ack<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">ack<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Moment</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L28">model/OnmsAlarm.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the time this alarm was acknowledged</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ackuser" class="tsd-anchor"></a>
<h3>ack<wbr>User</h3>
<div class="tsd-signature tsd-kind-icon">ack<wbr>User<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L25">model/OnmsAlarm.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the user that acknowledged this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="affectednodecount" class="tsd-anchor"></a>
<h3>affected<wbr>Node<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">affected<wbr>Node<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L106">model/OnmsAlarm.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If this alarm is a Situation, the number of Nodes affected by its RelatedAlarms, a value of 1 otherwise</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="count" class="tsd-anchor"></a>
<h3>count</h3>
<div class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L22">model/OnmsAlarm.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the number of times this alarm has triggered</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="description" class="tsd-anchor"></a>
<h3>description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L40">model/OnmsAlarm.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the alarm's description</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="detailspage" class="tsd-anchor"></a>
<h3>details<wbr>Page</h3>
<div class="tsd-signature tsd-kind-icon">details<wbr>Page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L117">model/OnmsAlarm.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>link to the alarm details page on the source instance</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="firsteventtime" class="tsd-anchor"></a>
<h3>first<wbr>Event<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">first<wbr>Event<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Moment</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L43">model/OnmsAlarm.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the first time an event has triggered this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L19">model/OnmsAlarm.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the alarm ID</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="journal" class="tsd-anchor"></a>
<h3>journal</h3>
<div class="tsd-signature tsd-kind-icon">journal<span class="tsd-signature-symbol">:</span> <a href="onmsmemo.html" class="tsd-signature-type">OnmsMemo</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L100">model/OnmsAlarm.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>journal memo - a note associated with the reduction key for this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="lastevent" class="tsd-anchor"></a>
<h3>last<wbr>Event</h3>
<div class="tsd-signature tsd-kind-icon">last<wbr>Event<span class="tsd-signature-symbol">:</span> <a href="onmsevent.html" class="tsd-signature-type">OnmsEvent</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L46">model/OnmsAlarm.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the most recent event that triggered this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="location" class="tsd-anchor"></a>
<h3>location</h3>
<div class="tsd-signature tsd-kind-icon">location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L52">model/OnmsAlarm.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>which location the alarm originated from</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="logmessage" class="tsd-anchor"></a>
<h3>log<wbr>Message</h3>
<div class="tsd-signature tsd-kind-icon">log<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L49">model/OnmsAlarm.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the alarm's log message</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="managedobjectinstance" class="tsd-anchor"></a>
<h3>managed<wbr>Object<wbr>Instance</h3>
<div class="tsd-signature tsd-kind-icon">managed<wbr>Object<wbr>Instance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L94">model/OnmsAlarm.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>managedObjectInstance - the instance associated with this alarm if it is a situation</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="managedobjecttype" class="tsd-anchor"></a>
<h3>managed<wbr>Object<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">managed<wbr>Object<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L91">model/OnmsAlarm.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>managedObjectType - the type associated with this alarm if it is a situation</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="nodeid" class="tsd-anchor"></a>
<h3>node<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">node<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L67">model/OnmsAlarm.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the node's ID associated with this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="nodelabel" class="tsd-anchor"></a>
<h3>node<wbr>Label</h3>
<div class="tsd-signature tsd-kind-icon">node<wbr>Label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L70">model/OnmsAlarm.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the node's label associated with this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="operatorinstructions" class="tsd-anchor"></a>
<h3>operator<wbr>Instructions</h3>
<div class="tsd-signature tsd-kind-icon">operator<wbr>Instructions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L103">model/OnmsAlarm.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>operator instructions</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="parameters" class="tsd-anchor"></a>
<h3>parameters</h3>
<div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <a href="onmsparm.html" class="tsd-signature-type">OnmsParm</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L85">model/OnmsAlarm.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the parameters emitted with this alarm's event</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="reductionkey" class="tsd-anchor"></a>
<h3>reduction<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">reduction<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L55">model/OnmsAlarm.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the alarm's reduction key</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="relatedalarms" class="tsd-anchor"></a>
<h3>related<wbr>Alarms</h3>
<div class="tsd-signature tsd-kind-icon">related<wbr>Alarms<span class="tsd-signature-symbol">:</span> <a href="onmsalarmsummary.html" class="tsd-signature-type">OnmsAlarmSummary</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L88">model/OnmsAlarm.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>relatedAlarms - A list of alarms related to this alarm/situation</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="service" class="tsd-anchor"></a>
<h3>service</h3>
<div class="tsd-signature tsd-kind-icon">service<span class="tsd-signature-symbol">:</span> <a href="onmsservicetype.html" class="tsd-signature-type">OnmsServiceType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L73">model/OnmsAlarm.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the service associated with the event</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="severity" class="tsd-anchor"></a>
<h3>severity</h3>
<div class="tsd-signature tsd-kind-icon">severity<span class="tsd-signature-symbol">:</span> <a href="onmsseverity.html" class="tsd-signature-type">OnmsSeverity</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L34">model/OnmsAlarm.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the alarm's severity</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="sticky" class="tsd-anchor"></a>
<h3>sticky</h3>
<div class="tsd-signature tsd-kind-icon">sticky<span class="tsd-signature-symbol">:</span> <a href="onmsmemo.html" class="tsd-signature-type">OnmsMemo</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L97">model/OnmsAlarm.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>sticky memo - a note associated with this specific alarm instance</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="suppressedby" class="tsd-anchor"></a>
<h3>suppressed<wbr>By</h3>
<div class="tsd-signature tsd-kind-icon">suppressed<wbr>By<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L82">model/OnmsAlarm.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>who the alarm was suppressed by</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="suppressedtime" class="tsd-anchor"></a>
<h3>suppressed<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">suppressed<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Moment</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L76">model/OnmsAlarm.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>when the alarm was suppressed</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="suppresseduntil" class="tsd-anchor"></a>
<h3>suppressed<wbr>Until</h3>
<div class="tsd-signature tsd-kind-icon">suppressed<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Moment</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L79">model/OnmsAlarm.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>when the alarm will stop being suppressed</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="troubleticket" class="tsd-anchor"></a>
<h3>trouble<wbr>Ticket</h3>
<div class="tsd-signature tsd-kind-icon">trouble<wbr>Ticket<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L58">model/OnmsAlarm.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the trouble ticket ID associated with this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="troubleticketlink" class="tsd-anchor"></a>
<h3>trouble<wbr>Ticket<wbr>Link</h3>
<div class="tsd-signature tsd-kind-icon">trouble<wbr>Ticket<wbr>Link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L64">model/OnmsAlarm.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the link to the trouble ticket system if defined</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="troubleticketstate" class="tsd-anchor"></a>
<h3>trouble<wbr>Ticket<wbr>State</h3>
<div class="tsd-signature tsd-kind-icon">trouble<wbr>Ticket<wbr>State<span class="tsd-signature-symbol">:</span> <a href="onmstroubleticketstate.html" class="tsd-signature-type">OnmsTroubleTicketState</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L61">model/OnmsAlarm.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the state of the trouble ticket associated with this alarm</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="onmsalarmtype.html" class="tsd-signature-type">OnmsAlarmType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L37">model/OnmsAlarm.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the alarm's type</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="uei" class="tsd-anchor"></a>
<h3>uei</h3>
<div class="tsd-signature tsd-kind-icon">uei<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L31">model/OnmsAlarm.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the UEI of the event associated with this alarm</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="issituation" class="tsd-anchor"></a>
<h3>is<wbr>Situation</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isSituation<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L120">model/OnmsAlarm.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>whether the alarm is a situation</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="lasteventtime" class="tsd-anchor"></a>
<h3>last<wbr>Event<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> lastEventTime<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L109">model/OnmsAlarm.ts:109</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the most recent time the event has triggered this alarm</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="urlvalue" class="tsd-anchor"></a>
<h3>url<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> urlValue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/model/OnmsAlarm.ts#L124">model/OnmsAlarm.ts:124</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="onmsalarm.html" class="tsd-kind-icon">Onms<wbr>Alarm</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#acktime" class="tsd-kind-icon">ack<wbr>Time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#ackuser" class="tsd-kind-icon">ack<wbr>User</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#affectednodecount" class="tsd-kind-icon">affected<wbr>Node<wbr>Count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#count" class="tsd-kind-icon">count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#detailspage" class="tsd-kind-icon">details<wbr>Page</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#firsteventtime" class="tsd-kind-icon">first<wbr>Event<wbr>Time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#journal" class="tsd-kind-icon">journal</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#lastevent" class="tsd-kind-icon">last<wbr>Event</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#location" class="tsd-kind-icon">location</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#logmessage" class="tsd-kind-icon">log<wbr>Message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#managedobjectinstance" class="tsd-kind-icon">managed<wbr>Object<wbr>Instance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#managedobjecttype" class="tsd-kind-icon">managed<wbr>Object<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#nodeid" class="tsd-kind-icon">node<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#nodelabel" class="tsd-kind-icon">node<wbr>Label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#operatorinstructions" class="tsd-kind-icon">operator<wbr>Instructions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#parameters" class="tsd-kind-icon">parameters</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#reductionkey" class="tsd-kind-icon">reduction<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#relatedalarms" class="tsd-kind-icon">related<wbr>Alarms</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#service" class="tsd-kind-icon">service</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#severity" class="tsd-kind-icon">severity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#sticky" class="tsd-kind-icon">sticky</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#suppressedby" class="tsd-kind-icon">suppressed<wbr>By</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#suppressedtime" class="tsd-kind-icon">suppressed<wbr>Time</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#suppresseduntil" class="tsd-kind-icon">suppressed<wbr>Until</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#troubleticket" class="tsd-kind-icon">trouble<wbr>Ticket</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#troubleticketlink" class="tsd-kind-icon">trouble<wbr>Ticket<wbr>Link</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#troubleticketstate" class="tsd-kind-icon">trouble<wbr>Ticket<wbr>State</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="onmsalarm.html#uei" class="tsd-kind-icon">uei</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="onmsalarm.html#issituation" class="tsd-kind-icon">is<wbr>Situation</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="onmsalarm.html#lasteventtime" class="tsd-kind-icon">last<wbr>Event<wbr>Time</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="onmsalarm.html#urlvalue" class="tsd-kind-icon">url<wbr>Value</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>