JMS event classes

The following table lists the JMS event classes. Each class name is a link to an event message example.

Table B-2: JMS event classes

Event class	Description
AlarmStatusChangeEvent	Indicates an alarm status change
AttributeValueChangeEvent	Indicates a change to one or more parameter in the database
DBActivityEvent example	Indicates database switchover or failover activity
DBConnectionStateChangeEvent example	Indicates a change in the database connection state
DBErrorEvent example	Indicates a new database error or the correction of an earlier error
DBProxyStateChangeEvent example	Indicates a database proxy status change
DeployerEvent example	Indicates the success or failure of an asynchronous deployment request; is available only in XML topics
EventVessel example	Indicates that the message is an event vessel that contains one or more events
ExceptionEventXMLFormat example	Indicates the occurrence of an exception
FileAvailableEvent example	Indicates that a file is available for retrieval; applies to asynchronous and synchronous findToFile requests
IncrementalRequestEvent example	Generated for activity related to generic.GenericObject.triggerIncrementalRequest
KeepAliveEvent example	A keep-alive message that is sent periodically to ensure that the server is running and can communicate with the OSS client
LogFileAvailableEvent example	Indicates that an accounting statistics file is ready for retrieval
LogRemoteFileAvailableEvent example	Notify Call Trace data file availability on the NE, not on NFM-P. The event includes the filename, NE FTP server IP address, and the NE ID.
ObjectCreationEvent example	Identifies a newly created object; contains the object details
ObjectDeletionEvent example	Identifies a newly deleted object; contains the object details
PolicyDistributionEvent example	Indicates the status of a policy distribution task to NEs. If the request is from XML API, a task monitor is added to the distribute task. Once the task is completed, the event is sent. The maximum number of sites per event is 1000. As a result, there may be multiple completed events, each with up to 1000 sites.
RelationshipChangeEvent example	Indicates that a relationship has changed between objects
ScriptExecutionEvent example	Indicates script execution by an OSS or GUI client. If specified, the message is sent only to the client that executed the script. Identifies script execution success or failure, the result full name, and the location of the file that contains the result.
StateChangeEvent	Indicates a server change, such as reloaded alarm information or changed alarm count An example of an important state change event is the SystemInfoEvent, which is sent each time an OSS client creates a new subscription or connects to a subscription.
StatsEvent example	Indicates statistics-collection activity; includes the statistics type, collection time, and the NE identifier, and marks the start or end of polling for an NE, as indicated by the <state> parameter
TerminateClientSessionEvent example	Identifies a client session to close for security reasons
XMLFilterChangeEvent example	Indicates a successful XML filter change, as requested by the OSS client

AlarmStatusChangeEvent

Figure B-1: AlarmStatusChangeEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138396703631</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>AlarmStatusChange</MTOSI_objectType>

         <MTOSI_NTType>NT_ATTRIBUTE_VALUE_CHANGE</MTOSI_NTType>

         <ALA_category>FAULT</ALA_category>

         <ALA_allomorphic>TiEvent</ALA_allomorphic>

         <MTOSI_objectName>svc-mgr:service-3:10.1.1.143</MTOSI_objectName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <alarmStatusChangeEvent>

            <objectFullName>svc-mgr:service-3:10.1.1.143</objectFullName>

            <attribute>

               <attributeName>alarmStatus</attributeName>

               <value>2</value>

            </attribute>

         </alarmStatusChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

AttributeValueChangeEvent

Figure B-2, AttributeValueChange message example shows a JMS message example for the AttributeValueChangeEvent class. An AttributeValueChangeEvent consists of a pointer with a list of changed attributes; the event includes the old and new attribute values. For enum and bitmask attribute types, the message includes the old and new text strings associated with the old and new attribute values, as shown in the example.

For more information about the attributes, or parameters, of specific classes, see the XML API Reference. For parameters that are enumerators, the integer value is used for AttributeValueChangeEvents, while the string value is used in ObjectCreationEvents.

Figure B-2: AttributeValueChange message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138123820148</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>netw.NetworkElement</MTOSI_objectType>

         <MTOSI_NTType>NT_ATTRIBUTE_VALUE_CHANGE</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic>netw.NetworkElement</ALA_allomorphic>

         <MTOSI_objectName>network:10.1.186.218</MTOSI_objectName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <attributeValueChangeEvent>

            <objectFullName>network:10.1.186.218</objectFullName>

            <attribute>

               <attributeName>resyncStatus</attributeName>

               <newValue>

                  <int>7</int>

               </newValue>

               <newValueString>requested</newValueString>

               <oldValue>

                  <int>4</int>

               </oldValue>

               <oldValueString>failed</oldValueString>

            </attribute>

            <attribute>

               <attributeName>lastTimeResyncStarted</attributeName>

               <newValue>

                  <long>1138123819632</long>

               </newValue>

               <oldValue>

                  <long>1138123519629</long>

               </oldValue>

            </attribute>

         </attributeValueChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

DBActivityEvent example

Figure B-3: DBActivityEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138395709210</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>DBActivityEvent</MTOSI_objectType>

         <MTOSI_NTType>NT_STATE_CHANGE</MTOSI_NTType>

         <ALA_category>DATABASE</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <dbActivityEvent>

            <state>failoverEnd</state>

         </dbActivityEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

DBConnectionStateChangeEvent example

Figure B-4: DBConnectionStateChangeEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138395709210</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>DBConnectionStateChangeEvent</MTOSI_objectType>

         <MTOSI_NTType>NT_STATE_CHANGE</MTOSI_NTType>

         <ALA_category>DATABASE</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <dbConnectionStateChangeEvent>

            <state>connectionUp</state>

         </dbConnectionStateChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

DBErrorEvent example

Figure B-5: DBErrorEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138395709210</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>DBErrorEvent</MTOSI_objectType>

         <MTOSI_NTType>NT_STATE_CHANGE</MTOSI_NTType>

         <ALA_category>DATABASE</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <dbErrorEvent>

            <state>clear</state>

            <error />

         </dbErrorEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

DBProxyStateChangeEvent example

Figure B-6: DBProxyStateChangeEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138395709210</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>DBProxyStateChangeEvent</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>DATABASE</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <dbProxyStateChangeEvent>

            <state>databaseProxyPrimaryUp</state>

         </dbProxyStateChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

DeployerEvent example

Figure B-7: DeployerEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1165863370530</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>DeployerEvent</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <deployerEvent>

            <requestID>JMS_client@n</requestID>

            <successList>

               <deployerId>Default.DeployerBank:depl-486</deployerId>

            </successList>

            <failedList>

               <deployerId>Default.DeployerBank:depl-487</deployerId>

            </failedList>

         </deployerEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

EventVessel example

Figure B-8: EventVessel message example

<?xml version="1.0" encoding="UTF-8"?>

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>EventVessel</eventName>

         <ALA_category>GENERAL</ALA_category>

         <ALA_vesselSize>3</ALA_vesselSize>

         <ALA_isVessel>true</ALA_isVessel>

         <MTOSI_osTime>1308318280367</MTOSI_osTime>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <ALA_eventName>EventVessel</ALA_eventName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <eventVessel>

            <attributeValueChangeEvent>

               <objectFullName>faultManager:network@192.168.101.13|alarm-31-4-24

</objectFullName>

               <attribute>

                  <attributeName>numberOfOccurencesSinceClear</attributeName>

                  <newValue>

                     <long>3</long>

                  </newValue>

                  <oldValue>

                     <long>2</long>

                  </oldValue>

               </attribute>

            </attributeValueChangeEvent>

            <statsEvent>

               <state>begin</state>

               <networkElement>192.168.101.13</networkElement>

               <statsType>accounting</statsType>

               <time>1308256029287</time>

            </statsEvent>

            <statsEvent>

               <state>end</state>

               <networkElement>192.168.101.13</networkElement>

               <statsType>accounting</statsType>

               <time>1308256029302</time>

            </statsEvent>

         </eventVessel>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

ExceptionEventXMLFormat example

Figure B-9: ExceptionEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1174926836987</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>aengr.Policy</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName>Access Egress:2100</MTOSI_objectName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <ExceptionEventXMLFormat>

            <className>aengr.Policy</className>

            <operation>distribute on node 10.168.1.91</operation>

            <objectName>Access Egress:2100</objectName>

            <requestID>JMS_client@n</requestID>

            <errorMessage>[ app: autoconfigChild ] [ class: aengr.Policy ] [ instance: network:10.168.1.91:Access Egress:2100 ] [ descr: invalid action bitmask: 3 : Object deletion is in progress, the object cannot be configured :Parent = network:10.168.1.91:Access Egress:2100: child = queue-1 ]</errorMessage>

         </ExceptionEventXMLFormat>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

FileAvailableEvent example

Figure B-10: FileAvailableEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138129016027</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>FileAvailableEvent</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <fileAvailableEvent>

            <fileName>equipmentPhysicalPort.xml</fileName>

         </fileAvailableEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

IncrementalRequestEvent example

Figure B-11: IncrementalRequestEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>IncrementalRequestEvent</eventName>

         <ALA_category>GENERAL</ALA_category>

         <ALA_OLC>0</ALA_OLC>

         <ALA_isVessel>false</ALA_isVessel>

         <ALA_allomorphic/>

         <MTOSI_osTime>1276545012449</MTOSI_osTime>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <MTOSI_objectName/>

         <ALA_clientId/>

         <MTOSI_objectType>IncrementalRequestEvent</MTOSI_objectType>

         <ALA_eventName>IncrementalRequestEvent</ALA_eventName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <IncrementalRequestEvent>

            <requestID>JMS_client@n</requestID>

            <incrementalAction>RE_EVAL_MSAPS_ON_MSAP_POLICY</incrementalAction>

            <serviceType>default</serviceType>

            <status>finished</status>

            <originalParam>

               <string>msapPolicy:msappolicy</string>

            </originalParam>

            <payload>

               <boolean>true</boolean>

            </payload>

         </IncrementalRequestEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

KeepAliveEvent example

Figure B-12: KeepAliveEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1137166251642</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>KeepAliveEvent</MTOSI_objectType>

         <MTOSI_NTType>NT_HEARTBEAT</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <keepAliveEvent />

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

LogFileAvailableEvent example

Figure B-13: LogFileAvailableEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>LogFileAvailable</eventName>

         <MTOSI_osTime>1184770068031</MTOSI_osTime>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <MTOSI_objectType>LogFileAvailableEvent</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <logFileAvailableEvent>

            <fileName>client_directory\NE_IP_address_1184770068031.xml</fileName>

            <serverIpAddress>server_IP_address</serverIpAddress>

            <routerId>NE_IP_address</routerId>

         </logFileAvailableEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

LogRemoteFileAvailableEvent example

Figure B-14: LogRemoteFileAvailableEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>LogRemoteFileAvailable</eventName>

         <ALA_isVessel>false</ALA_isVessel>

         <MTOSI_objectType>LogRemoteFileAvailableEvent</MTOSI_objectType>

         <JMSXDeliveryCount>0</JMSXDeliveryCount>

         <ALA_allomorphic />

         <ALA_OLC>0</ALA_OLC>

         <ALA_category>GENERAL</ALA_category>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_eventName>LogRemoteFileAvailable</ALA_eventName>

         <MTOSI_osTime>1527258136621</MTOSI_osTime>

         <MTOSI_objectName/>

         <ALA_clientId/>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <logRemoteFileAvailableEvent>

            <fileName>/shared/restfm/traces/IMSI_12345678901_TRACE-ID_13_2018-05-25-17-22-14-125.pcap</fileName>

            <serverIpAddress>203.0.113.12</serverIpAddress>

            <neId>203.0.113.12</neId>

         </logRemoteFileAvailableEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

ObjectCreationEvent example

Figure B-15: ObjectCreationEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138128165344</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>aclfilter.MacFilterEntry</MTOSI_objectType>

         <MTOSI_NTType>NT_OBJECTCREATION</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic>aclfilter.MacFilterEntry</ALA_allomorphic>

         <MTOSI_objectName>MAC Filter:3:entry-1</MTOSI_objectName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <objectCreationEvent>

            <aclfilter.MacFilterEntry>

               <frameType>unspecified</frameType>

               <sourceMacAddress>10-00-00-00-00-10</sourceMacAddress>

               <sourceMacAddressMask>00-00-00-00-00-00</sourceMacAddressMask>

               <destinationMacAddress>10-00-00-00-00-10</destinationMacAddress>

               <destinationMacAddressMask>00-00-00-00-00-00</destinationMacAddressMask>

               <dot1pValue>notSet</dot1pValue>

               <dot1pMask>unspecified</dot1pMask>

               <ethernetType>-1</ethernetType>

               <dsap>-1</dsap>

               <dsapMask>-1</dsapMask>

               <ssap>-1</ssap>

               <ssapMask>-1</ssapMask>

               <snapPid>-1</snapPid>

               <snapOui>off</snapOui>

               <action>default</action>

               <logId>0</logId>

               <administrativeState>notInService</administrativeState>

               <containingPolicyDisplayedName>ACL Mac Filter 2</containingPolicyDisplayedName>

               <containingPolicyId>3</containingPolicyId>

               <policyType>macAcl</policyType>

               <isLocal>false</isLocal>

               <siteId>0.0.0.0</siteId>

               <siteName>N/A</siteName>

               <displayedName>Filter 10-00-00-00-00-10</displayedName>

               <description>Filter Entry # 1</description>

               <id>1</id>

               <globalPolicy>N/A</globalPolicy>

               <deploymentState>0</deploymentState>

               <objectFullName>MAC Filter:3:entry-1</objectFullName>

               <name>Filter 10-00-00-00-00-10</name>

               <selfAlarmed>false</selfAlarmed>

               <children-Set />

            </aclfilter.MacFilterEntry>

         </objectCreationEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

ObjectDeletionEvent example

Figure B-16: ObjectDeletionEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>ObjectDeletion</eventName>

         <MTOSI_osTime>1224518670453</MTOSI_osTime>

         <ALA_clientId/>

         <MTOSI_NTType>NT_OBJECTDELETION</MTOSI_NTType>

         <MTOSI_objectType>equipment.PhysicalPort</MTOSI_objectType>

         <ALA_category>EQUIPMENT</ALA_category>

         <ALA_isVessel>false</ALA_isVessel>

         <ALA_allomorphic>equipment.PhysicalPort</ALA_allomorphic>

         <ALA_eventName>ObjectDeletion</ALA_eventName>

         <ALA_span>:0:</ALA_span>

         <MTOSI_objectName>network:15.1.1.89:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-53</MTOSI_objectName>

         <ALA_OLC>2</ALA_OLC>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <objectDeletionEvent>

            <objectFullName>network:15.1.1.89:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-53</objectFullName>

         </objectDeletionEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

PolicyDistributionEvent example

Figure B-17: PolicyDistributionEvent message example

<PolicyDistributeEvent isAlarm="no">

   <properties>

      <eventName>PolicyDistributeStatusEvent</eventName>

      <ALA_OLC>0</ALA_OLC>

      <ALA_category>GENERAL</ALA_category>

      <ALA_isVessel>false</ALA_isVessel>

      <MTOSI_osTime>1365047500446</MTOSI_osTime>

      <ALA_allomorphic/>

      <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

      <MTOSI_objectName>rpCommunity:testcommunity</MTOSI_objectName>

      <ALA_clientId>JMS_client@n</ALA_clientId>

      <MTOSI_objectType>rp.Community</MTOSI_objectType>

      <ALA_eventName>PolicyDistributeStatusEvent</ALA_eventName>

   </properties>

   <Body>

      <PolicyDistributeEventXMLFormat>

         <className>rp.Community</className>

         <operation>distribute</operation>

         <objectFullName>rpCommunity:testcommunity</objectFullName>

         <DistributionStatus>

            <policy.DistributeSiteStatus>

               <siteId>198.51.100.43</siteId>

               <status>Failed</status>

            </policy.DistributeSiteStatus>

            <policy.DistributeSiteStatus>

               <siteId>198.51.100.83</siteId>

               <status>Succeeded</status>

            </policy.DistributeSiteStatus>

         </DistributionStatus>

      </PolicyDistributeEventXMLFormat>

   </Body>

</PolicyDistributeEvent>

RelationshipChangeEvent example

Figure B-18: RelationshipChangeEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138386054650</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>epipe.Epipe</MTOSI_objectType>

         <MTOSI_NTType>ALA_RELATIONSHIPCHANGE</MTOSI_NTType>

         <ALA_category>SERVICE</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName>svc-mgr:service-3</MTOSI_objectName>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <relationshipChangeEvent>

            <objectFullName>svc-mgr:service-3</objectFullName>

            <relationship>

               <changeType>added</changeType>

               <fromObjectName>svc-mgr:service-3</fromObjectName>

               <fromObjectClass>epipe.Epipe</fromObjectClass>

               <toObjectName>subscriber:1</toObjectName>

               <toObjectClass>subscr.Subscriber</toObjectClass>

            </relationship>

         </relationshipChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

ScriptExecutionEvent example

Figure B-19: ScriptExecutionEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1173717919050</MTOSI_osTime>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <MTOSI_objectType>ScriptExecutionEvent</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <scriptExecutionEvent>

            <targetScriptResultFullName>script-manager:script-4:target-script-6:target-script-result-1173467653236</targetScriptResultFullName>

            <fileName>scriptResult/target-script-6_1173467653236.txt</fileName>

            <status>Unknown</status>

            <errorMessage>Trying to connect to an already connected session.</errorMessage>

            <failedCommands />

         </scriptExecutionEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

StateChangeEvent

Table B-3: State change events

Event type	Description
AlarmInformationLoaded	Sent to indicate a change in the status of the alarm list; see the XML schema for the possible status values
AlarmCountChanged	Sent when the number of alarms crosses above or below the maximum number of alarms defined in the server configuration
JmsMissedEvents	Sent to inform both durable and non-durable subscribers that events have been missed
SystemInfoEvent	Sent each time a client connects to a new subscription, or reconnects to an existing durable subscription

Figure B-20: JmsMissedEvents message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>JmsMissedEvents</eventName>

         <MTOSI_osTime>1222891102168</MTOSI_osTime>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <MTOSI_objectType>StateChangeEvent</MTOSI_objectType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_isVessel>false</ALA_isVessel>

         <ALA_allomorphic/>

         <ALA_eventName>JmsMissedEvents</ALA_eventName>

         <MTOSI_objectName/>

         <ALA_OLC>0</ALA_OLC>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <stateChangeEvent>

            <eventName>JmsMissedEvents</eventName>

            <state>jmsMissedEvents</state>

         </stateChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

The following table lists the properties in a System Information StateChangeEvent message.

Table B-4: StateChangeEvent SystemInfoEvent properties

Property name	Description
jmsStartTime	UNIX time of most recent JMS-server restart; long integer
sysPrimaryIp	IP address or hostname (if client hostname was configured via samconfig) of primary main server; string¹
sysStandbyIp	IP address or hostname (if client peer-server hostname was configured via samconfig) of standby main server in redundant NFM-P deployment; string¹
sysStartTime	UNIX time of most recent main-server restart; long integer
sysType	NFM-P system type; string, value is redundant or standalone

Notes:

When not using hostnames in a NAT environment, the public IP address(es) are used.

The SystemInfoEvent is sent to a JMS client’s subscription after the OSS establishes a JMS connection with the NFM-P.

The SystemInfoEvent sysPrimaryIp tells the OSS which NFM-P server is the current primary. An OSS with a durable JMS subscription should initiate retrieval of inventory or alarms using HTTP if any of the following occurs:

The current sysPrimaryIp in the SystemInfoEvent is different from that of the last recorded sysPrimaryIp.
The jmsStartTime or sysStartTime in the SystemInfoEvent are different from the last recorded jmsStartTime and sysStartTime.

See Recommended durable JMS client operation for more information about the recommended start-up procedure for an OSS with a durable JMS subscription to the XML API.

Figure B-21: SystemInfoEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>SystemInfoEvent</eventName>

         <MTOSI_osTime>1224527204299</MTOSI_osTime>

         <ALA_clientId>JMS_client@n</ALA_clientId>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <MTOSI_objectType>StateChangeEvent</MTOSI_objectType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_isVessel>false</ALA_isVessel>

         <ALA_allomorphic/>

         <ALA_eventName>SystemInfoEvent</ALA_eventName>

         <MTOSI_objectName/>

         <ALA_OLC>0</ALA_OLC>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <stateChangeEvent>

            <eventName>SystemInfoEvent</eventName>

            <state>systemInfo</state>

            <sysStandbyIp>192.168.182.253</sysStandbyIp>

            <sysPrimaryIp>192.168.169.94</sysPrimaryIp>

            <jmsStartTime>1224525628189</jmsStartTime>

            <sysStartTime>1224525628189</sysStartTime>

            <sysType>Redundant</sysType>

         </stateChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

StatsEvent example

Figure B-22: StatsEvent message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1170864259082</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>StatsEvent</MTOSI_objectType>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_category>STATISTICS</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <statsEvent>

            <state>end</state>

            <networkElement>10.1.200.71</networkElement>

            <statsType>accounting</statsType>

            <time>1170864259082</time>

         </statsEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

TerminateClientSessionEvent example

Figure B-23, TerminateClientSession message example shows a JMS message example for the TerminateClientSessionEvent class.

Note: The JMS message terminateClientSessionEvent is broadcast to all sessions.

Figure B-23: TerminateClientSession message example

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <MTOSI_osTime>1138395709210</MTOSI_osTime>

         <ALA_clientId />

         <MTOSI_objectType>TerminateClientSession</MTOSI_objectType>

         <MTOSI_NTType>NT_STATE_CHANGE</MTOSI_NTType>

         <ALA_category>GENERAL</ALA_category>

         <ALA_allomorphic />

         <MTOSI_objectName />

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <terminateClientSessionEvent>

            <clientId>ossi@1</clientId>

         </terminateClientSessionEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>

XMLFilterChangeEvent example

Figure B-24: XMLFilterChangeEvent message example

<?xml version="1.0" encoding="UTF-8"?>

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

   <SOAP:Header>

      <header xmlns="xmlapi_1.0">

         <eventName>XMLFilterChangeEvent</eventName>

         <ALA_isVessel>false</ALA_isVessel>

         <MTOSI_objectType>XMLFilterChangeEvent</MTOSI_objectType>

         <JMSXDeliveryCount>0<JMSXDeliveryCount>

         <ALA_allomorphic/>

         <ALA_OLC>0</ALA_OLC>

         <ALA_category>GENERAL</ALA_category>

         <MTOSI_NTType>ALA_OTHER</MTOSI_NTType>

         <ALA_eventName>XMLFilterChangeEvent</ALA_eventName>

         <MTOSI_osTime>1536329823494</MTOSI_osTime>

         <MTOSI_objectName/>

         <ALA_clientId>AdvancedJMSFilter@1</ALA_clientId>

      </header>

   </SOAP:Header>

   <SOAP:Body>

      <jms xmlns="xmlapi_1.0">

         <xmlFilterChangeEvent>

            <filter-Set>

               <filter>

                  <or>

                     <equal name="className" value="fm.AlarmObject"/>

                     <equal name="className" value="fm.AlarmNoteObject"/>

                  <or>

               <filter>

            </filter-Set>

            <resultFilter-Set>

               <resultFilter class="fm.AlarmNoteObject">

                  <attribute>isAckNote</attribute>

                  <attribute>objectFullName</attribute>

                  <attribute>status</attribute>

               </resultFilter>

               <resultFilter class="fm.AlarmObject">

                  <attribute>severity</attribute>

                  <attribute>affectedObjectFullName</attribute>

                  <attribute>numberOfOccurences</attribute>

                  <attribute>alarmClassTag</attribute>

                  <attribute>firstTimeDetected</attribute>

                  <attribute>additionalText</attribute>

                  <attribute>operatorAssignedUrgency</attribute>

                  <attribute>alarmName</attribute>

                  <attribute>objectFullName</attribute>

                  <attribute>acknowldegedBy</attribute>

               </resultFilter>

            <resultFilter-Set>

            <extraTags>

               </tag name="MTOSI_osTime"/>

               </tag name="fullClassName"/>

               </tag name="ALA_category"/>

            </extraTags>

         </xmlFilterChangeEvent>

      </jms>

   </SOAP:Body>

</SOAP:Envelope>