User Tools

Site Tools


dashlet:opennmsoutages

Dashlet: OpenNMSOutages

Gets all outages from an OpenNMS setup using the OpenNMS REST API and shows it on the dashboard.

supported OpenNMS versions

The dashlet was tested with the following OpenNMS versions:

  • 16
  • 15
  • 14
  • 1.12
  • 1.10

:!: It does not work with OpenNMS version 1.8 and below.

configuration example

<dashlet class="DashletOpenNMSOutages" refresh="30000">
      <parameter key="title" value="OpenNMS Outages in category Cisco" />
      <parameter key="restUrl" value="http://10.0.1.106:8980/opennms/rest" />
      <parameter key="restUser" value="admin" />
      <parameter key="restPassword" value="admin" />
      <parameter key="outagesCategory" value="router" />
      <parameter key="outagesCategory" value="switch" />
      <parameter key="linkUrlBase" value="http://10.0.1.106:8980/opennms" />
      <parameter key="maxEntries" value="10" />
</dashlet>

parameters

parameterdescriptionmandatoryavailable in version
titleheadline shown on the dashlet yes 0.1
restUrlURL of the REST API of your OpenNMS setup yes 0.1
restUserUsername for the OpenNMS REST API yes 0.1
restPasswordPassword for the OpenNMS REST API yes 0.1
linkUrlBaseDefines the OpenNMS base URL to use for links no 0.1
outagesCategoryIf defined, the dashlet shows only outages of nodes of the given surveillance category. Since version 0.2, you can define multiple outagesCategory lines and check, if a node is included in one or more of the given categories no 0.1
maxEntriesIf defined, show only maxEntries entries on the dashlet no 0.1
createAlarmscreate alarms for new outage records no 0.3
alarmMinTimecreate alarms only, if they exists for alarmMinTime seconds no 0.3
alarmMaxTimecreate alarms only, if they exists for less than alarmMaxTime seconds. This value should be higher than alarmMinTime + refreshInterval of the dashlet no 0.3
dashlet/opennmsoutages.txt · Last modified: 2017/07/24 11:55 (external edit)