Alarm messages

Overview

An OSS needs to subscribe to JMS in order to receive the notification of new alarms or changes to existing alarms; for example, escalation, de-escalation, acknowledgement, or recurrence. See Alarm-specific header properties in JMS message filtering for information about properties that are common to all JMS events. See Table 4-3, Event header properties, alarm events for properties that are specific to fault messages.

When an alarm is raised, the NFM-P sends a JMS message with an fm.AlarmInfo structure. The following figure shows a message example for a new alarm. The fields of the AlarmInfo correspond to the properties of the new fm.AlarmObject. See the XML API Reference for fm.AlarmInfo and fm.AlarmObject information.

Figure 11-1: New alarm message example

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>ObjectCreation</eventName>

         <ALA_category>FAULT</ALA_category>

         <ALA_isCorr>false</ALA_isCorr>

         <ALA_isVessel>false</ALA_isVessel>

         <ALA_alarmType>equipmentAlarm</ALA_alarmType>

         <ALA_allomorphic>fm.AlarmObject</ALA_allomorphic>

         <MTOSI_NTType>NT_ALARM</MTOSI_NTType>

         <MTOSI_serviceAffecting>false</MTOSI_serviceAffecting>

         <MTOSI_probableCause>inoperableEquipment</MTOSI_probableCause>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <MTOSI_aliasNameList>EquipmentDown</MTOSI_aliasNameList>

         <ALA_OLC>2</ALA_OLC>

         <MTOSI_osTime>1315841370394</MTOSI_osTime>

         <MTOSI_objectName>faultManager:network@198.51.100.47@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-32|alarm-10-3-8</MTOSI_objectName>

         <MTOSI_perceivedSeverity>major</MTOSI_perceivedSeverity>

         <ALA_span>:2:</ALA_span>

         <MTOSI_objectType>fm.AlarmObject</MTOSI_objectType>

         <ALA_eventName>ObjectCreation</ALA_eventName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <objectCreationEvent>

            <fm.AlarmInfo>

               <severity>major</severity>

               <previousSeverity>indeterminate</previousSeverity>

               <originalSeverity>major</originalSeverity>

               <highestSeverity>major</highestSeverity>

               <probableCause>8</probableCause>

               <alarmName>10</alarmName>

               <type>3</type>

               <affectedObjectFullName>network:198.51.100.47:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-32</affectedObjectFullName>

               <affectedObjectClassName>equipment.PhysicalPort</affectedObjectClassName>

               <isAcknowledged>false</isAcknowledged>

               <wasAcknowledged>false</wasAcknowledged>

               <acknowldegedBy>N/A</acknowldegedBy>

               <clearedBy>N/A</clearedBy>

               <deletedBy>N/A</deletedBy>

               <firstTimeDetected>1315841369120</firstTimeDetected>

               <lastTimeDetected>1315841369120</lastTimeDetected>

               <lastTimeSeverityChanged>0</lastTimeSeverityChanged>

               <lastTimeCleared>0</lastTimeCleared>

               <lastTimePromoted>0</lastTimePromoted>

               <lastTimeDemoted>0</lastTimeDemoted>

               <lastTimeEscalated>0</lastTimeEscalated>

               <lastTimeDeEscalated>0</lastTimeDeEscalated>

               <lastTimeAcknowledged>0</lastTimeAcknowledged>

               <frequency>0</frequency>

               <occurences>N/A</occurences>

               <numberOfOccurences>1</numberOfOccurences>

               <numberOfOccurencesSinceClear>1</numberOfOccurencesSinceClear>

               <numberOfOccurencesSinceAck>0</numberOfOccurencesSinceAck>

               <isServiceAffecting>false</isServiceAffecting>

               <additionalText>N/A</additionalText>

               <operatorAssignedUrgency>indeterminate</operatorAssignedUrgency>

               <urgencyAssignedBy>N/A</urgencyAssignedBy>

               <relatedObjects>

                  <null/>

               </relatedObjects>

               <affectingObjects>

                  <null/>

               </affectingObjects>

               <subscriberId>0</subscriberId>

               <nodeId>198.51.100.47</nodeId>

               <nodeName>sim20_47</nodeName>

               <affectedObjectDisplayedName>Port 1/1/32</affectedObjectDisplayedName>

               <applicationDomain>Physical Equipment</applicationDomain>

               <displayedClass>PhysicalPort</displayedClass>

               <alarmClassTag>equipment.EquipmentDown</alarmClassTag>

               <affectedObjectClassIndex>87</affectedObjectClassIndex>

               <affectedObjectInstanceIndex>2018</affectedObjectInstanceIndex>

               <deployerName/>

               <deployerId>0</deployerId>

               <requestId>N/A</requestId>

               <requestUser>N/A</requestUser>

               <correlatingAlarm>N/A</correlatingAlarm>

               <isImplicitlyCleared>true</isImplicitlyCleared>

               <numberOfCorrelatedAlarms>0</numberOfCorrelatedAlarms>

               <olcState>inService</olcState>

               <objectFullName>faultManager:network@198.51.100.47@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-32|alarm-10-3-8</objectFullName>

               <objectClassName>fm.AlarmObject</objectClassName>

               <allomorphicClassName>fm.AlarmObject</allomorphicClassName>

               <objectId>606777272</objectId>

               <displayedName>Port 1/1/32 - network@198.51.100.47@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-32|alarm-10-3-8</displayedName>

               <lifeCycleState>1</lifeCycleState>

               <deploymentState>0</deploymentState>

               <neId>198.51.100.47</neId>

               <spanObjectPointer>node-198.51.100.47</spanObjectPointer>

               <parentClassName>fm.FaultManager</parentClassName>

               <unsetProperties/>

            </fm.AlarmInfo>

         </objectCreationEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

The following figure shows an attribute value change for a recurring alarm. Each time that the alarm recurs, the number of occurrences (both absolute and since the last clear) increment and the time last detected is updated. The following figure shows the old and new values for each of the fields. See also AttributeValueChangeEvent in Appendix B, JMS events.

Figure 11-2: Recurring alarm message example, attribute value change

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>AttributeValueChange</eventName>

         <ALA_category>FAULT</ALA_category>

         <ALA_OLC>2</ALA_OLC>

         <ALA_isVessel>false</ALA_isVessel>

         <ALA_allomorphic>fm.AlarmObject</ALA_allomorphic>

         <MTOSI_osTime>1316464116127</MTOSI_osTime>

         <MTOSI_NTType>NT_ALARM</MTOSI_NTType>

         <MTOSI_objectName>faultManager:network@3.3.3.3@router-1@ospf-v2@areaSite-0.0.0.0@interface-18|alarm-40-11-43-packetSourceIpAddress=10.1.3.6</MTOSI_objectName>

         <ALA_span>:2:</ALA_span>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <MTOSI_objectType>fm.AlarmObject</MTOSI_objectType>

         <ALA_eventName>AttributeValueChange</ALA_eventName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <attributeValueChangeEvent>

            <objectFullName>faultManager:network@3.3.3.3@router-1@ospf-v2@areaSite-0.0.0.0@interface-18|alarm-40-11-43-packetSourceIpAddress=10.1.3.6</objectFullName>

            <attribute>

               <attributeName>numberOfOccurencesSinceClear</attributeName>

               <newValue>

                  <long>3490</long>

               </newValue>

               <oldValue>

                  <long>3489</long>

               </oldValue>

            </attribute>

            <attribute>

               <attributeName>lastTimeDetected</attributeName>

               <newValue>

                  <long>1316464116127</long>

               </newValue>

               <oldValue>

                  <long>1316463991997</long>

               </oldValue>

            </attribute>

            <attribute>

               <attributeName>numberOfOccurences</attributeName>

               <newValue>

                  <long>3490</long>

               </newValue>

               <oldValue>

                  <long>3489</long>

               </oldValue>

            </attribute>

         </attributeValueChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

Use subject to agreed restrictions on disclosure and use.