Notifications, Fault Management, and Probable
Cause Mapping
This appendix includes information on CTM GateWay/CORBA’s notifications, fault management, and
probable cause mapping. This appendix includes the following sections:
• A.1 Overview of Notifications, page A-1
• A.2 Resolving the Notification Service, page A-2
• A.3 Tips to Improve Notification Throughput, page A-2
• A.4 Supported Events, page A-3
• A.5 Probable Cause Mapping, page A-12
A.1 Overview of Notifications
APPENDIX
A
The notification service forwards all fault notifications received from managed NEs to the network
management system (NMS). The notification service also forwards object creation, object deletion,
attribute change, protection switch, and threshold crossing alert (TCA) events. TMF 814 defines the
structure and format of attributes for all events and alarms.
The CTM server and the Operations Support System (OSS) host must have Domain Name System (DNS)
enabled in order to receive notifications. OSS clients running behind a firewall must configure an IIOP
listening port to enable the TCP connection with the notification server. CTM must configure the
notification service listening port number to allow OSS clients to communicate with the notification
service.
CTM creates the notification channel with the QoS parameters shown in the following table.
Ta b le A- 1Q o S P a ra m et e r s f o r the Notification Channel
ParameterValue
ConnectionReliabilityBestEffort
StartTimeSupportedfalse
OrderPolicyFifoOrder
DiscardPolicyFifoOrder
MaxEventsPerConsumer
1. The MaxEventsPerConsumer value is configurable. To modify this value, see B.8 Location of the Naming Service IOR File, page B-6. All other
parameter values are defined by the TMF and cannot be changed.
1
10000
OL-14253-01
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
A-1
Appendix A Notifications, Fault Management, and Probable Cause Mapping
Resolving the Notification Service
CTM sets the RejectNewEvents administration property of the channel to true, as defined by the TMF.
Every notification that CTM generates has the QoS parameters listed in the following table. These
parameter values are defined by the TMF and cannot be changed.
Table A-2QoS Parameters for Notifications
ParameterValue
EventReliabilityBestEffort
PriorityDefaultPriority
Timeout30 minutes for alarms and TCAs; 24 hours for all other notifications
The NMS retrieves all active alarms on the Element Management System (EMS) and on managed
element objects. The NMS filters alarms based on probable cause and managed element name.
CTM GateWay/CORBA forwards CTM-specific alarms to the NMS.
For NE-related alarms, CTM inserts the original probable cause in the alarm’s nativeProbableCause
field. The TMF-mapped probable cause is available in the probableCause field.
A.2 Resolving the Notification Service
CTM GateWay/CORBA can integrate with external notification services. When CTM GateWay/CORBA
starts, a reference to EventNotifyChannelFactory is resolved. CTM GateWay/CORBA makes the
following attempts to resolve the object:
1. Resolve initial references with the default service name of NotificationService to resolve the object.
You can change the service name by setting the corbagw.notification.ServiceName property in the
corbagw.properties file.
2. Resolve the object through the naming service. The default naming service entry is
services.NotifyChannelFactory. You can change the naming service entry by setting the
corbagw.notification.NamingContext property in the corbagw.properties file.
3. Resolve the object directly through the Interoperable Object Reference (IOR). You can change the
URL of the IOR file by setting the corbagw.notification.FactoryIORFile property in the
corbagw.properties file. The default location for the IOR file is
file://localhost/CTM_baseDir/cfg/NotificationService.ior. You can specify a URL that points to a
remote web server.
A.3 Tips to Improve Notification Throughput
While CTM GateWay/CORBA and the bundled notification server are developed and tuned to provide
high throughput, you might want to take additional steps to improve throughput and avoid any loss of
notifications. You should implement the StructuredPushConsumer interface defined by the Object
Management Group (OMG) and implement the push_structured_event method. The notification server
invokes this method on the NMS.
A-2
CautionBecause all CORBA calls are blocking, the notification server thread blocks until the
push_structured_event method completes. If you try to perform a time-consuming task before the
method completes, you will block the notification server.
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
OL-14253-01
Appendix A Notifications, Fault Management, and Probable Cause Mapping
To improve throughput, you should receive the event and forward it to another thread for processing.
Object TypeType Sent in remainder_of_body for Object Creation Event
OT_L2TOPOLOGYMultiLayerSubnetwork::L2Topology_T
OT_MLVLANMultiLayerSubnetwork::MLVLAN_T
OT_ROLLMultiLayerSubnetwork::Roll_T
OT_VCATSubnetworkConnection::VCAT_T
CTM does not generate object creation events for SubnetworkConnection for the ONS 15540.
CTM cannot give the object name for object creation events for ONS 15501, ONS 15530, and
ONS 15540 equipment.
For the MGX 8880/8850/8830, CTM generates object creation events for the object types
OT_MANAGED_ELEMENT and OT_EQUIPMENT.
NoteThe number of equipment holders for NEs supported by CTM is constant. To reduce traffic between
CTM and the NMS, CTM does not generate object creation events for equipment holders. The number
of PTPs on equipment is also constant. Therefore, CTM generates only object creation events for
equipment.
A.4.2 Object Deletion
The following table lists the object deletion types and attributes.
Table A-5Object Deletion
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and sequence of the notification ID are not
guaranteed.
objectNameglobaldefs::NamingAttributes_TYes.
objectTypenotifications::ObjectType_TYes.
emsTimeglobaldefs::Time_TYes.
neTimeglobaldefs::Time_TNo.
edgePointbooleanNo.
Object deletion notifications are sent to the NMS for the objects in the following table.
Table A-6Object Deletion Notifications
Object TypeType Sent in remainder_of_body for Object Deletion Event
Object TypeType Sent in remainder_of_body for Object Deletion Event
OT_EQUIPMENTequipment::Equipment_T
OT_PROTECTION_GROUPprotection::ProtectionGroup_T
OT_L2TOPOLOGYMultiLayerSubnetwork::L2Topology_T
OT_MLVLANMultiLayerSubnetwork::MLVLAN_T
OT_ROLLMultiLayerSubnetwork::Roll_T
OT_VCATSubnetworkConnection::VCAT_T
CTM does not generate object deletion events for SubnetworkConnection for the ONS 15501,
ONS 15530, and ONS 15540.
For the MGX 8880/8850/8830, CTM generates object deletion events for the object types
OT_MANAGED_ELEMENT and OT_EQUIPMENT.
NoteThe number of equipment holders for all NEs supported by CTM is constant. To reduce traffic between
CTM and the NMS, CTM does not generate object deletion events for equipment holders. The number
of PTPs on equipment is also constant. Therefore, CTM generates only object deletion events for
equipment.
Supported Events
A.4.3 Attribute Value Change
The following table lists the attribute value change (AVC) types and attributes.
Table A-7Attribute Value Change
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and sequence of the notification ID are
not guaranteed.
objectNameglobaldefs::NamingAttributes_TYes.
objectTypenotifications::ObjectType_TYes.
emsTimeglobaldefs::Time_TYes.
neTimeglobaldefs::Time_TNo.
edgePointbooleanNo.
attributeListnotifications::NVList_TYes.
OL-14253-01
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
A-5
Appendix A Notifications, Fault Management, and Probable Cause Mapping
Supported Events
Attribute value change notifications are sent to the NMS for the objects and attributes in the following
table.
Table A-8Attribute Value Change Notifications
Object TypeAttributes
OT_EMSnativeEMSName
OT_MANAGED_ELEMENTnativeEMSName—This field reflects the new managed element name if it is
changed.
location
version
productName
OT_MULTILAYER_SUBNETWORKNativeEMSName
OT_TOPOLOGICAL_LINK
OT_SUBNETWORK_CONNECTION
OT_L2TOPOLOGYNativeEMSName
OT_MLVLANNone
1
None
2
None
NoteThis event notifies the NMS that the VLAN was updated.
OT_ROLLNone
NoteThis event notifies the NMS that the roll was updated.
OT_VCATNone
NoteThis event notifies the NMS that the VCAT changed.
1. The OT_TOPOLOGICAL_LINK event notifies the NMS that some attribute of the topological link changed.
2. The OT_SUBNETWORK_CONNECTION event is generated only when CTM fails to delete an SNC and it remains in the same state.
Note• CTM does not generate AVC events for SubnetworkConnection for the ONS 15501, ONS 15530,
and ONS 15540.
• For the MGX 8880/8850/8830, CTM generates AVC events for the object types
OT_MANAGED_ELEMENT and OT_EMS.
A.4.4 State Change Event
The following table lists the state change event types and attributes.
Table A-9State Change Event
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and sequence of the notification ID are not
guaranteed.
objectNameglobaldefs::NamingAttributes_TYes.
objectTypenotifications::ObjectType_TYes.
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
A-6
OL-14253-01
Appendix A Notifications, Fault Management, and Probable Cause Mapping
Table A-9State Change Event (continued)
Attribute NameTypeSupported by CTM?
emsTimeglobaldefs::Time_TYes.
neTimeglobaldefs::Time_TNo.
edgePointbooleanNo.
attributeListnotifications::NVList_TYes.
State change event notifications are sent to the NMS for the objects and attributes in the following table.
Table A-10State Change Event Notifications
Object TypeAttributes
OT_MANAGED_ELEMENTcommunicationState—CTM supports the following values:
• CS_AVAILABLE
• C S _ U N AVA I L A B L E
emsInSyncState—CTM supports the following values:
• True
Supported Events
• False
OT_EQUIPMENT_HOLDERholderState—State change. CTM supports the following values:
• EMPTY
• INSTALLED_AND_EXPECTED
• EXPECTED_AND_NOT_INSTALLED
• MISMATCH_OF_INSTALLED_AND_EXPECTED
OT_SUBNETWORK_CONNECTION
1
sncState—CTM supports the following values:
• SNCS_DELETING
• SNCS_PARTIAL
• SNCS_ACTIVE
OT_L2TOPOLOGYL2TopoState—CTM supports the following values:
• L2TS_COMPLETE
• L2TS_INCOMPLETE
topoInSyncState—CTM supports the following values:
• true
• false
OT_MLVLANvlanState—CTM supports the following values:
• VLS_COMPLETE
OL-14253-01
• VLS_INCOMPLETE
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
A-7
Appendix A Notifications, Fault Management, and Probable Cause Mapping
OT_ROLLrollState—CTM supports the following values:
• ROLL_PENDING
• ROLL_COMPLETED
• ROLL_CANCELLED
• ROLL_INCOMPLETE
OT_VCATvcatState—CTM supports the following values:
• VCATS_DELETING
• VCATS_PARTIAL
• VCAT_ACTIVE
1. The OT_SUBNETWORK_CONNECTION event is generated only when CTM changes the SNC. If CTC or any other tool is used to change the SNC,
CTM does not report this event.
CTM does not generate state change events for EquipmentHolder and SubnetworkConnection for the
ONS 15501, ONS 15530, and ONS 15540.
For the MGX 8880/8850/8830, CTM generates state change events for the object types
OT_MANAGED_ELEMENT and OT_EQUIPMENT_HOLDER.
A.4.5 Protection Switch
The following table lists the protection switch types and attributes. The protection switch event is not
supported for MGX 8880/8850/8830 NEs.
Table A-11Protection Switch
Attribute NameTypeSupported by CTM?
notificationIdStringYes. The uniqueness and the sequence of the
notification ID are not guaranteed.
emsTimeglobaldefs::Time_TYes.
neTimeglobaldefs::Time_TNo.
ProtectionTypeprotection::ProtectionType_TNo.
switchReasonprotection::switchReason_TNo.
layerRatetransmissionParameters::LayerRate_TNo.
groupNameglobaldefs::NamingAttributes_TNo.
(Yes for ONS 15540 and ONS 15530.)
protectedTPglobaldefs::NamingAttributes_TNo.
(Yes for ONS 15540 and ONS 15530.)
switchAwayFromTPglobaldefs::NamingAttributes_TYes for ONS 15540 and ONS 15530.
switchToTPglobaldefs::NamingAttributes_TNo.
A-8
(Yes for ONS 15540 and ONS 15530.)
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
OL-14253-01
Appendix A Notifications, Fault Management, and Probable Cause Mapping
Table A-11Protection Switch (continued)
Attribute NameTypeSupported by CTM?
affectedTP
globaldefs::NamingAttributes_TYes.
Supported Events
NoteThis is not defined by the
(No for ONS 15540 and ONS 15530.)
TMF.
Description
NoteThis is not defined by the
TMF.
StringYes.
The value of this field is the native NE event
value.
A.4.6 Threshold Crossing Alert
The following table lists the TCA types and attributes. This event is not supported for ONS 15501,
ONS 15530, ONS 15540, and MGX 8880/8850/8830 NEs because TCAs are reported as alarms.
Table A-12Threshold Crossing Alert
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and the sequence of the
Always set to
PerceivedSeverity_T.PS_INDETERMINATE.
layerRatetransmissionParameters::LayerRate_TYes.
granularityGranularity_TYes.
pmParameterNamePMParameterName_TYes.
NoteIf the NE does not report the location, this
pmLocationPMLocation_TYes.
NoteIf the NE does not report the location, this
thresholdTypePMThresholdType_T No.
valuefloatYes.
unitstringNo.
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
OL-14253-01
field is empty.
field is empty.
A-9
Appendix A Notifications, Fault Management, and Probable Cause Mapping
Supported Events
A.4.7 Alarm
The following table lists the most common alarm messages.
If there is an alarm on an STS/VC4 CTP utilizing all ports of a DS1/E1 card, the alarm is reported with
the containing PTP as port 127. If an STS/VC4 SNC exists with one of the drop CTPs of the SNC using
all ports on a DS1/E1 card, and if there is an alarm on the STS CTP, CTM reports the port number of the
containing PTP as 127.
Ta b l e A - 1 3A l a r m
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and sequence of the notification
ID are not guaranteed.
objectNameglobaldefs::NamingAttributes_TYes.
nativeEMSNamestringYes.
nativeProbableCausestringYes.
NoteIn case of external condition alarms, the string
value of the condition type is appended to this
field.
objectTypenotifications::ObjectType_TYes.
emsTimeglobaldefs::Time_TYes.
neTimeglobaldefs::Time_TYes.
isClearablebooleanYes. The value is always set to True.
layerRatetransmissionParameters::LayerRate_TYes.
NoteNot supported for ONS 15501, ONS 15530,
and ONS 15540 NEs.
probableCausestringYes.
probableCauseQualifierstringYes. CTM provides the same value as in the
If the alarmed object is OC-n PTP, CTM also includes
SDH_SONET_SS_BITS in this list.
CTM provides the IP address for ME-related alarms.
CTM provides the ME name when the object type is
OT_EMS and the alarm is ME-related.
CTM provides the affected object when the object
type is OT_EMS and the nativeProbableCause is
“Server Monitor Threshold Crossed.”
A-10
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
OL-14253-01
Appendix A Notifications, Fault Management, and Probable Cause Mapping
Supported Events
Table A-13Alarm (continued)
Attribute NameTypeSupported by CTM?
isPropagatedbooleanYes. For the MGX 8880/8850/8830, values are
assigned to this field. For all other NEs, this field is
always set to False.
aresFDNstringYes.
A.4.8 Heartbeat Event
CTM generates a periodic heartbeat event and pushes the event to the notification channel. By default,
this function is disabled. You can configure the interval value through the CTM Control Panel. If the
interval value is set to 0, the heartbeat event is disabled. By monitoring this event, the northbound
interface client knows whether the notification service is active. The type_name field contains the
NT_HEART_BEAT value under the fixed_header for this type of event. Filterable_data has only one
field, which is shown in the following table.
Table A-14Heartbeat Event
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and sequence of the notification ID are not guaranteed.
A.4.9 Backup Status Event
The backup status event contains details about changes to a managed element’s backup status.
Table A-15Backup Status Event
Attribute NameTypeSupported by CTM?
notificationIdstringYes. The uniqueness and sequence of the notification ID are not
guaranteed.
emsTimeglobaldefs::Time_TYes. The time when the EMS reported the event.
neTimeglobaldefs::Time_TYes. The time provided by the NE. If the NE does not report time,
this field is optional or reports an empty string.
backupStatussoftwareManager::BackupStatus_TYes. The backup status of the managed element.
meNameglobaldefs::NamingAttributes_TYes. The name of the managed element from which the backup
was taken.
OL-14253-01
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
A-11
Probable Cause Mapping
A.5 Probable Cause Mapping
A.5.1 TMF-Defined Probable Cause
The following report lists the probable causes defined by the TMF:
"UNIDENTIFIED": for alarms that do not match any other string below. EMS shall in this
case fill out the additional text field as much as possible.
"AIS": alarm indication signal
"AMS": Alternate modulation signal
"AU-AIS": AU alarm indication signal
"BER_SD": signal degrade (includes receiver degrade)
"BER_SF": signal fail (includes receiver failure and excessive BER)
"DCC_FAILURE": Data Communication Channel Failure
"EMS": EMS system alarm
"EMS_ALM_LOSS": The 1st notification that the EMS may supply after 1 or more notifications
for protection switch, TCA, alarm, or file transfer status have been discarded by the EMS
while other events have not been discarded
"EMS_LIFECYCLE_LOSS": The 1st notification that an EMS may supply after 1 or more events
of type OC/OD/AVC/SC/RC have been discarded by the EMS
"EMS_ALM_AND_LIFECYCLE_LOSS": The 1st notification that an EMS may supply after 1 or more
notifications for protection switch, TCA, alarm, or file transfer status, and 1 or more
events of type OC/OD/AVC/SC/RC have been discarded by the EMS
"EQPT": equipment alarm
"ENV": Environmental/external cause
"FOP_APS": failure of APS protocol
"LCD": Loss of Cell Delineation (from TC Adaptor part of ATM NI)
"LOF": loss of frame (when distinguished from LOS)
"LOM": loss of multiframe (SDH only, since not an alarm in GR-253)
"LOP": loss of pointer
"LOS": loss of signal
"MS-AIS": MS alarm indication signal
"OSC-AIS": Optical Supervisory Channel alarm indication signal
"OSC_BER_SF": Optical Supervisory Channel signal fail/RX fail/excessive BER
"OSC_FERF": Optical Supervisory Channel Far End Receive Failure
"OSC_LOF": Optical Supervisory Channel Loss of Frame
"OSC_LOS": Optical Supervisory Channel Loss of Signal
"OSC_SD": Optical Supervisory Channel signal degrade
"PLM": payload label mismatch (when reported as an alarm)
"RAI": remote alarm indication (sometimes reported as RDI)
"SECURITY_VIOLATION": security violation
"SSF": server signal fail
"TCM-AIS": Tandem Connection Sink - Incoming Alarm Indication Signal
"TCM-LOS": Tandem Connection Sink - Loss of Tandem Connection Signal
"TCM-OAI": Tandem Connection Sink - Outgoing Defect Indication (same/similar to Alarm
Indication)
"TCM-RAI": Tandem Connection Sink - Remote Defect Indication (same/similar to Alarm
Indication)
"TCM-SD": Tandem Connection Sink - Signal Degrade
"TCM-SSF": Tandem Connection Sink - Server Signal Fail
"TCM-TIM": Connection Sink - Trace Identifier Mismatch
"TCM-UNEQ": Tandem Connection Sink - Unequipped
"TIM": trace identifier mismatch (when reported as an alarm)
"TU-AIS": TU alarm indication signal
"TX_DEGRADE": transmitter degrade, including laser degrade
"TX_FAIL": transmitter failure, including laser failure
"UAT": Unavailable Time
"UNEQ": payload unequipped
"VC-AIS": VCL/VCC TP Alarm Indication Signal
"VC-RDI": VCL/VCC TP Remote Defect Indication
"VP-AIS": VPL/VPC TP Alarm Indication Signal
Appendix A Notifications, Fault Management, and Probable Cause Mapping
A-12
Cisco Transport Manager Release 8.5 GateWay/CORBA User Guide and Programmer Manual
OL-14253-01
Appendix A Notifications, Fault Management, and Probable Cause Mapping
"VP-RDI": VPL/VPC TP Remote Defect Indication
A.5.2 CTM GateWay/CORBA Mapping—EMS
The following table lists the CTM GateWay/CORBA mapping for the EMS.