REST Resources

/api/space/opennms/alarms/{alarm-id}

Alarms are indications of an abnormal condition that needs attention. They allow you to manage network performance and faults. Alarms draw your focus to the resources that needs attention and act as escalation notifications to optimize the performance of the network.

The following operations are supported on this resource:

  • GET - Get alarm by id.
GET /alarms/{alarm-id} Version 1

This API is used to retrieve information about all the alarms.

Sample Usage

GET /alarms/{alarm-id}


  • Accept Headers:
    application/vnd.net.juniper.space.opennms+xml;version=1

  • Sample Output XML:

    <alarm type="1" count="1" id="201" severity="MAJOR">
       <description>CPU load average threshold upper limit exceeded. 1 min Load Average too high (= 5.83).</description>
       <parms>.1.3.6.1.2.1.88.2.1.1.0=CPU LA trigger(OctetString,text);.1.3.6.1.2.1.88.2.1.2.0=(OctetString,text);.1.3.6.1.2.1.88.2.1.3.0=(OctetString,text);.1.3.6.1.2.1.88.2.1.4.0=.1.3.6.1.4.1.2021.10.1.100.1(ObjectIdentifier,text);.1.3.6.1.2.1.88.2.1.5.0=1(Int32,text);.1.3.6.1.4.1.2021.10.1.2.1=Load-1(OctetString,text);.1.3.6.1.4.1.2021.10.1.101.1=1 min Load Average too high (%61 5.83)(OctetString,text)</parms>
       <firstEventTime>2017-03-17T09:30:04Z</firstEventTime>
       <ipAddress>192.168.26.27</ipAddress>
       <lastEvent display="Y" log="Y" id="5862" severity="MAJOR">
          <createTime>2017-03-17T09:30:04.376Z</createTime>
          <description>CPU load average threshold upper limit exceeded. 1 min Load Average too high (= 5.83).</description>
          <host>space-000c29e5a276</host>
          <logMessage>CPU load average threshold upper limit exceeded. 1 min Load Average too high (= 5.83).</logMessage>
          <parms>.1.3.6.1.2.1.88.2.1.1.0=CPU LA trigger(OctetString,text);.1.3.6.1.2.1.88.2.1.2.0=(OctetString,text);.1.3.6.1.2.1.88.2.1.3.0=(OctetString,text);.1.3.6.1.2.1.88.2.1.4.0=.1.3.6.1.4.1.2021.10.1.100.1(ObjectIdentifier,text);.1.3.6.1.2.1.88.2.1.5.0=1(Int32,text);.1.3.6.1.4.1.2021.10.1.2.1=Load-1(OctetString,text);.1.3.6.1.4.1.2021.10.1.101.1=1 min Load Average too high (%61 5.83)(OctetString,text)</parms>
          <snmp>.1.3.6.1.2.1.88.2,undefined,v2,1,6,juniper123</snmp>
          <snmpHost>192.168.26.27</snmpHost>
          <source>trapd</source>
          <time>2017-03-17T09:30:04Z</time>
          <uei>uei.opennms.org/traps/SPACE-PLATFORM-MIB/jnxSpaceCPULARising</uei>
          <ipAddress>192.168.26.27</ipAddress>
          <nodeId>3</nodeId>
          <nodeLabel>space-000c29e5a276</nodeLabel>
       </lastEvent>
       <lastEventTime>2017-03-17T09:30:04Z</lastEventTime>
       <logMessage>CPU load average threshold upper limit exceeded. 1 min Load Average too high (= 5.83).</logMessage>
       <nodeId>3</nodeId>
       <nodeLabel>space-000c29e5a276</nodeLabel>
       <reductionKey>uei.opennms.org/traps/SPACE-PLATFORM-MIB/jnxSpaceCPULARising::3:Load-1</reductionKey>
       <suppressedTime>2017-03-17T09:30:04Z</suppressedTime>
       <suppressedUntil>2017-03-17T09:30:04Z</suppressedUntil>
       <uei>uei.opennms.org/traps/SPACE-PLATFORM-MIB/jnxSpaceCPULARising</uei>
       <x733ProbableCause>0</x733ProbableCause>
    </alarm>

    • Access Control

    The following capabilities are required to access this API: cap_fmpm_Alarm