Technical ReferencesTable of ContentsNotice2Table of Contents3List of Tables9Updates for Version 3.013Updates for Version 3.513Overview14FIS Template14Data Types14Interfaces16Operations17Exceptions19Notifications19Alarms and Probable Causes19Usage of the Probable Cause Qualifier20Threshold Crossing Alerts (TCAs)21AVCs, Object Creation/Deletion and Other Notifications22Alarm Severity Assignment Profile (v3.0)23Data Types23Interfaces23Notifications24Call SNC Module (v3.5)24Data Types24Interfaces26Notifications26Common Module26Data Types26Interfaces26Notifications27EmsMgr Module27Data Types27Interfaces28Notifications29EMS Session Module29Data Types29Interfaces29Notifications29EmsSessionFactory29Data Types29Interfaces30Notifications30Equipment Module30Data Types30Interfaces33Notifications34FlowDomain Module34Data Types34Interfaces38Notifications39FlowDomainFragment Module39Data Types39Interfaces41Notifications41Globaldefs Module42Data Types42Interfaces42Notifications42GuiCutThrough Module42Data Types42Interfaces43Notifications43MaintenanceOperations Module43Data Types43Interfaces43Notifications44Managed Element Module44Data Types44Interfaces45Notifications45ManagedElementManager Module45Data Types45Interfaces45Notifications46MLSNPP Module46Data Types46Interfaces47Notifications47MLSNPP Link Module47Data Types47Interfaces48Notifications48MTNM Version Module49Data Types49Interfaces49Notifications49MultiLayerSubnetwork Module49Data Types49Interfaces50Notifications53NMS Session Module53Data Types53Interfaces53Notifications53Notifications Module54Data Types54Interfaces54Notifications54Performance Module54Data Types54Interfaces56Notifications57Protection Module57Data Types57Interfaces58Notifications59Session Module59Data Types59Interfaces59Notifications59SoftwareAndDataManager Module (v3.0)59Data Types59Interfaces59Notifications60Subnetwork Connection Module60Data Types60Interfaces68Notifications68Termination Point Module68Data Types68Interfaces71Notifications71Topological Link Module72Data Types72Interfaces73Notifications73Traffic Conditioning Profile Module (v3.5)73Data Types73Interfaces74Notifications75TrafficDescriptor Module75Data Types75Interfaces76Notifications76Transmission Descriptor Module (v3.0)76Data Types76Interfaces78Notifications79Transmission Parameters Module79Data Types79Interfaces79Notifications79Miscellaneous79Version of CORBA and CORBA Services79Usage of the OMG Notification Service80Proprietary LayerRates81SNC Type Transitions Related to the ModifySNC Operation82Iterator Implementation Issues85Timing Issues85Implementation-specific Use Cases87EMS Subnetwork Configuration87Usage of the Various Resource Names88SNC State Representations – Modes90Mode A90Mode B91Mode C91Mode D91Example Probable Cause Template91Mapping of MTNM Services States to Other Models93Mapping to Telcordia State Model (GR-1093-CORE)93Mapping to ITU-T States95Usage of Network Access Domains (NADs)95Root Cause Alarm Indication96FTP Examples96Size: 1.23 MBPages: 115Language: EnglishOpen manual
Developer's GuideTable of ContentsAbout This Document131 Overview of Cisco Prime Optical GateWay/CORBA131.1 Hardware Modifications151.2 Features of GateWay/CORBA151.3 GateWay/CORBA Fault Management161.4 Overview of CORBA Services161.4.1 Naming Service161.4.2 Notification Service161.5 Information Model181.6 IDL-Related Changes181.7 Functionalities Not Supported in Prime Optical 10.3201.8 Summary212 NE- and Cisco Prime Optical-Specific Details222.1 NE-Specific Details222.1.1 ONS 15216222.1.2 ONS 15305 and ONS 15305 CTC222.1.3 ONS 15310 CL232.1.4 ONS 15310 MA SDH252.1.5 ONS 15310 MA SONET262.1.6 ONS 15327272.1.7 ONS 15454 SDH292.1.8 ONS 15454 SONET312.1.9 ONS NCS2K SDH342.1.10 ONS NCS2K SONET342.1.11 ONS 15600 SONET342.1.12 ONS 15600 SDH362.1.13 Carrier Packet Transport 200/600 SONET/SDH372.1.14 Unmanaged NEs372.2 Prime Optical-Specific Details372.2.1 Layer Rate372.2.2 Inventory412.2.3 Interfaces422.2.4 Object Details432.2.5 Naming Conventions442.2.6 Programming Details572.2.7 Provisioning Subnetwork Connections583 Using GateWay/CORBA Interfaces733.1 Overview of APIs Supported by NE Type733.2 common::Common_I1183.2.1 common::Common_I:: getCapabilities1183.3 emsMgr::EMSMgr_I1193.3.1 TMF 3.0 Alarm Data Structures and Parameters1193.3.2 AlarmAndTCAIDList_T1193.3.3 TCAId_T1193.3.4 AlarmOrTCAIdentifier_T1203.3.5 acknowledgeAlarms120unacknowledgeAlarms121getAllEMSAndMEUnacknowledgedActiveAlarms122getAllEMSSystemUnacknowledgedActiveAlarms123setAdditionalInfo1233.3.10 getAllEMSAndMEActiveAlarms1243.3.11 getAllEMSSystemActiveAlarms1253.3.12 getAllTopLevelSubnetworks1263.3.13 getAllTopLevelSubnetworkNames1273.3.14 getAllTopLevelTopologicalLinks1283.3.15 getAllTopLevelTopologicalLinkNames1303.3.16 getTopLevelTopologicalLink1303.3.17 createTopologicalLink1313.3.18 createTopologicalLinkWithYCableProtection1343.3.19 deleteTopologicalLink1353.3.20 modifyTopologicalLink1363.3.21 getEMS1373.3.22 getAllL2Topologies1383.3.23 getAllQoSTemplateNames1413.3.24 getAllQoSTemplates1413.3.25 getQoSTemplate1433.3.26 getAllEMSandMEClearedAlarms1443.3.27 getAllEMSSystemClearedAlarms1453.3.28 Passive Unit EMS Alarms1463.3.29 createServerTrailLink1463.3.30 deleteServerTrailLink1483.3.31 addNetworkPartition1493.3.32 addMultiLayerSubnetwork1493.3.33 deleteNetworkPartition1503.3.34 deleteMultiLayerSubnetwork1513.3.35 getAllSupportedMEModels151EmsSession::EmsSession_I152getEventChannel152GetManager152getSupportedManagers153emsSessionFactory::EmsSessionFactory_I153getEmsSession154getEmsPublicKey155getEmsPublicKeyPair155equipment::EquipmentInventoryMgr_I156getAllEquipment156getAllEquipmentNames164getAllSupportedPTPs165getAllSupportedPTPNames181getAllSupportingEquipment182getAllSupportingEquipmentNames183getContainedEquipment183getEquipment184provisionEquipment1913.6.10 setAlarmReportingOff1923.6.11 setAlarmReportingOn1933.6.12 unprovisionEquipment194maintenanceOps::MaintenanceMgr_I195getActiveMaintenanceOperations195performMaintenanceOperation196managedElementManager::ManagedElementManager_I198getAllActiveAlarms198getAllSNCs199getAllManagedElements200getAllManagedElementNames203getAllPTPs203getAllPTPNames205getContainedInUseTPs206getContainedInUseTPNames207getContainedPotentialTPs2083.8.10 getContainedPotentialTPNames2093.8.11 getContainingSubnetworkNames2103.8.12 getManagedElement2113.8.13 getAllCTMMEInternalPatchcord2113.8.14 setAdditionalInfo2123.8.15 getTP2143.8.16 getAssociatedTopologicalLinks2153.8.17 setTPData2163.8.18 getAllSrcPTPsForSNCProvisioning2193.8.19 getAllSrcCTPsForSNCProvisioning2203.8.20 getAllSrcCTPsForVCATMemberSNCProvisioning2213.8.21 getAllDestPTPsForSNCProvisioning2213.8.22 getAllDestCTPsForSNCProvisioning2233.8.23 getAllDestCTPsForVCATMemberSNCProvisioning2243.8.24 getAllSrcFTPsForSNCProvisioning2243.8.25 getAllDestFTPsForSNCProvisioning2253.8.26 forceNEResync2273.8.27 getAllTopologicalLinksForME2273.8.28 getAllRolls2283.8.29 getAllRollNames2293.8.30 getRoll2303.8.31 getRollToPTPs2313.8.32 getRollToCTPs2313.8.33 getRollFromCTPs2323.8.34 setPortName2333.8.35 getPortName2343.8.36 getAllClearedAlarms2353.8.37 getAllCrossConnections2363.8.38 getAllSoftwareDownloadJobs2373.8.39 setMEAdminState238multiLayerSubnetwork::MultiLayerSubnetworkMgr_I239getAllEdgePoints239getAllEdgePointNames241getAllManagedElement242getAllManagedElementNames242getAllSubnetworkConnections243getAllSubnetworkConnectionsWithTP245getAllSubnetworkConnectionNames246getAllSubnetworkConnectionNamesWithTP247getAllTopologicalLinks2483.9.10 getAllTopologicalLinkNames2493.9.11 getMultiLayerSubnetwork2493.9.12 getCTPsAndTopologicalLinks2503.9.13 getSNC2513.9.14 getSNCsByUserLabel2523.9.15 getTopologicalLink2533.9.16 createAndActivateSNCFromUserLabel2543.9.17 CreateAndActivateSNC2653.9.18 (Deprecated) createAndActivateProtectedOchccFromUserLabel2653.9.19 addDrops2663.9.20 deactivateAndDeleteSNC2673.9.21 getVCATSNC2683.9.22 getAllVCATSNCs2703.9.23 getAllVCATSNCNames2713.9.24 getAllVCATMemberSNCs2723.9.25 getAllVCATMemberSNCNames2733.9.26 createVCAT2743.9.27 deleteVCAT2763.9.28 addMemberSNCsToVCAT2773.9.29 deleteMemberSNCsFromVCAT2773.9.30 deleteAllMemberSNCFromVCAT2783.9.31 getValidSubnetworkConnectionsForMerge2793.9.32 upgrade2813.9.33 createRoll2823.9.34 deleteRoll2843.9.35 cancelRoll2853.9.36 forceValidSignal2853.9.37 completeRoll2863.9.38 finishRoll2863.9.39 getAllRolls2873.9.40 getAllRollNames2883.9.41 getAssociatedRollNamesForSNC2883.9.42 getAssociatedSNCNamesForRoll2893.9.43 createAndActivateSNCOnDRI2903.9.44 addManagedElement2913.9.45 deleteManagedElement296L2 Topology and ML VLAN for ML-Series Ethernet Cards2963.10.1 createMLVLAN2973.10.2 modifyMLVLANAddFrontPorts2993.10.3 modifyMLVLANDropFrontPorts3003.10.4 modifyMLVLANPortState3013.10.5 modifyMLVLANRSTPState3023.10.6 modifyMLVLANTPQOS3033.10.7 modifyMLVLANCustomerIDServiceID3043.10.8 getMLVLAN3053.10.9 deleteMLVLAN3063.10.10 getAllMLVLANs3063.10.11 getAllMLVLANNames3073.10.12 getAllAssociatedSNCs3083.10.13 getL2Topology3093.10.14 getAssociatedL2TopologyForSNC3103.10.15 getAssociatedL2TopologyForMLVLAN3103.10.16 createL2Topology3113.10.17 deleteL2Topology3193.10.18 modifyL2Topology3203.10.19 getAllAvailableMLEquipmentOrTPNames321E-Series VLAN Interfaces3223.11.1 createVLAN3223.11.2 deleteVLAN3233.11.3 getAllVLANs3233.11.4 modifySNC324nmsSession::NmsSession_I3273.12.1 historyPMDataCompleted3273.12.2 historyPMDataFailed3283.12.3 operationInfo3283.12.4 alarmLossOccurred328performance::PerformanceManagementMgr_I3293.13.1 disablePMData3293.13.2 enablePMData3303.13.3 setTCATPParameter3313.13.4 getTCATPParameter3923.13.5 getCTMHistoryPMData3933.13.6 getCTMValidHistoryPMData3953.13.7 deleteHistoryPMDataFile3963.13.8 getTPHistoryPMData3963.13.9 getHoldingTime3993.13.10 getAllCurrentPMData4003.13.11 getMEPMcapabilities4013.13.12 Passive Unit EMS PM402protection::ProtectionMgr_I4023.14.1 getAllProtectedTPNames4023.14.2 getAllProtectionGroups4033.14.3 getProtectionGroup4053.14.4 performProtectionCommand4053.14.5 createProtectionGroup4083.14.6 deleteProtectionGroup4113.14.7 getAssociatedProtectionGroup4123.15 session::Session_I4133.15.1 endSession4133.15.2 ping4133.16 mtnmVersion::Version_I4143.16.1 getVersion4143.17 cpoEmsManager:: CpoEmsManager_I4143.17.1 getAllEMSAndMEUnacknowledgedActiveAlarms4143.18 cpoManagedElementManager_I:: CpoManagedElementManager_I4153.18.1 getAllUnacknowledgedActiveAlarms4153.19 Transmission Descriptor Interfaces4163.19.1 getAllTransmissionDescriptors4173.19.2 getAllTransmissionDescriptorsNames4183.19.3 getTransmissionDescriptor4193.19.4 getAssociatedTPs4193.19.5 createTransmissionDescriptor4203.19.6 deleteTransmissionDescriptor4213.20 Software and Data Manager Interface4223.20.1 backupME4223.20.2 getMEBackupStatus4233.20.3 abortMEBackup4243.20.4 getBackupList4243.20.5 activateSoftwareOnME4253.20.6 revertSoftwareOnME4263.20.7 restoreME4263.20.8 getMERestoreStatus4273.20.9 abortMERestore4283.20.10 getAllSupportedMESoftwareVersions4283.20.11 downloadMESoftware4303.20.12 addSupportedMESoftwareVersion4313.20.13 getSWDownloadStatus4324.1 Understanding Key Concepts434Ethernet Virtual Circuit434Connectionless Port Termination Point437Matrix Flow Domain438Flow Domain439EVC Flow Domain Fragment439Link Aggregation440MPLS and MPLS-TP441MPLS-TP Tunnel442MPLS-TP LSP4434.1.10 Pseudowire4434.1.11 Pseudowire Flow Domain Fragment4444.2 Interface Managers4444.3 Entity Characteristics446Entity Naming446Entity Iterators447Entity Notifications4494.4 Supported Provisioning Interfaces4584.5 EVC Provisioning Interfaces460CPTP Provisioning Interfaces460MFD Provisioning Interfaces463Flow Domain Provisioning Interfaces470EVC FDFr Provisioning Interfaces477Link Aggregation Provisioning Interfaces487Traffic Conditioning Profile Provisioning Interfaces4934.6 MPLS-TP Provisioning Interfaces502MPLS-TP Tunnel Provisioning Interfaces502MPLS-TP LSP Provisioning Interfaces508MPLS-TP Protection (Provisioning)512BFD Template, Node ID, and Label Range Provisioning Interface5134.7 Pseudowire Provisioning Interfaces514Pseudowire FDFr Provisioning Interfaces514Pseudowire Mixed Configuration (Provisioning)525Pseudowire Class and Loopback Provisioning Interface525Pseudowire QoS Provisioning Interface5294.8 Supported Inventory Interfaces5304.9 EVC Inventory Interfaces532CPTP Inventory Interfaces532MFD Inventory Interfaces535Flow Domain Inventory Interfaces538EVC FDFr Inventory Interfaces540Link Aggregation Inventory Interfaces545Common Inventory Interface549Traffic Conditioning Profile Inventory Interfaces5504.10 MPLS-TP Inventory Interfaces5504.10.1 MPLS-TP Tunnel Inventory Interfaces5514.10.2 MPLS-TP LSP Inventory Interfaces5544.10.3 MPLS-TP Tunnel Link Inventory Interfaces5574.10.4 MPLS-TP LSP Route Inventory Interfaces5584.10.5 MPLS-TP Protection (Inventory)561Inventory Interface5614.11 Pseudowire Inventory Interfaces5634.11.1 Pseudowire FDFr Inventory Interfaces5634.11.2 Pseudowire Class, Loopback, and QoS Policy Inventory Interface5724.12 Alarm Summaries5754.12.1 Alarm Summary Example—Channel Group Port5754.12.2 Pseudowire Alarm Event Example5764.12.3 MPLS-TP Tunnel Alarm Event Example5774.12.4 Channel Group Alarm Event Example5784.13 Error Messages5794.13.1 MPLS-TP Tunnel Error Messages5794.13.2 LSP Error Messages5794.13.3 Pseudowire Error Messages5804.13.4 EVC Error Messages5814.13.5 FD, MFD, and CPTP Error Messages5815.1 Overview of Notifications5835.2 Resolving the Notification Service5845.3 Tips to Improve Notification Throughput5845.4 Supported Events584Object Creation585Object Deletion585Attribute Value Change586SubnetworkConnection Name Change - AttributeValueChange591State Change Event592Protection Switch593Threshold Crossing Alert594Alarm595Heartbeat Event5965.4.10 Backup Status Event5965.5 Probable Cause Mapping596TMF-Defined Probable Cause596GateWay/CORBA Mapping—EMS598GateWay/CORBA Mapping—ONS 15216598GateWay/CORBA Mapping—ONS 15305 and ONS 15305 CTC599200 SDH, CPT 600, and CPT 600 SDH602and CPT 600 SDH618GateWay/CORBA Mapping—PTS619GateWay/CORBA Mapping—ONS 15600 SONET620GateWay/CORBA Mapping—ONS 15600 SDH6276.1 Creating an OSS Client Profile for GateWay/CORBA6356.2 Deleting an OSS Client Profile for GateWay/CORBA6366.3 Viewing Currently Logged In GateWay/CORBA OSS Users636Logging Out GateWay/CORBA OSS Users636Unsupported Events637Using Encryption Between the OSS Client and GateWay/CORBA637Using Multiple Naming Servers638Naming Conventions for Published GateWay/CORBA Objects638Location of the Naming Service IOR File639Useful Debugging Utilities for Resolving Naming Service-Related Issues639Configuring GateWay/CORBA640Using the CLI to Start and Stop GateWay/CORBA642Configuring Secure Socket Layer for GateWay/CORBA6426.13.1 Generating the Server-Side Certificate6426.13.2 Generating the Client-Side Certificate6436.13.3 Adding the Client-Side Certificate to the Server-Side Keystore6446.13.4 Adding the Server-Side Certificate to the Client-Side Keystore6456.13.5 Configuring the Client-Side Properties6456.14 Installation Program6466.15 Cisco Prime Optical 10.0-to-Cisco Prime Optical 10.3 Migration6467 OSS Use Cases and Client Development6477.1 Use Cases to Resynchronize the NMS from the EMS6477.2 Developing a GateWay/CORBA Client650Recommended Tools650Sample Code in Java651Running the Client659Known Interoperability Issues When Using Orbix6598 Equipment List for NEs6618.1 Equipment List for ONS 152166618.2 Equipment List for ONS 153056628.3 Equipment List for ONS 15305 CTC6628.4 Equipment List for ONS 15310 CL6638.5 Equipment List for ONS 15310 MA SDH6638.6 Equipment List for ONS 15310 MA SONET6638.7 Equipment List for ONS 153276648.8 Equipment List for ONS 15454 SDH6648.9 Equipment List for ONS 15454 SONET6668.10 Equipment List for ONS 15454-M26698.11 Equipment List for ONS 15454-M66708.12 Equipment List for CPT 200, CPT 200 SDH, CPT 600, and CPT 600 SDH6708.13 Equipment List for ONS 15600 SDH6718.14 Equipment List for ONS 15600 SONET6718.15 Equipment List for Unmanaged NEs6728.16 CRS1 and CRS3 NEs6728.17 Equipment List for ONS NCS2K SONET and ONS NCS2K SDH6729 Layered Parameters and Layer Rates67610 Payloads and Layer Rates Matrix68211 PTP dataRate attribute68712 Related Documentation68813 Obtaining Documentation and Submitting a Service Request688Size: 24.6 MBPages: 688Language: EnglishOpen manual
Installation GuideTable of Contents1 About This Guide2Assumptions and Limitations of This Guide22 Installation Requirements2System Requirements3Server Requirements3Disk Space and Partition Requirements4ctm_backup Directory Size6Ports and Protocols6Client-Server Communication Ports and Protocols7Client-Database Communication Ports and Protocols7Client-NE Communication Ports and Protocols7OSS CORBA Client Communication (Northbound) Ports and Protocols7Server-Database Communication Ports and Protocols8Loopback Connections (Server to Server) Ports and Protocols8Southbound Communication Ports and Protocols8TCP Ports for SOCKS Proxy Server11Client Requirements113 Preparing for Installation12Enabling SSH on the Prime Optical Server and Database Workstation12Configuring yum13Before You Begin13Preparing the Environment for a Single-Server Installation14Before You Begin144 Installing Prime Optical15Preparing the Server for Prime Optical Installation15Installing Prime Optical on the Server15Explanations of Fields in the Installation Wizard17Verifying the Installation195 Uninstalling Prime Optical196 Next Steps19Launching the Client19Password Complexity Rules20Configuring a SOCKS Server21Getting Started with Prime Optical21Creating a Prime Optical User Account22Configuring a User for Server-to-NE Connection22(Optional) Configuring Automatic Alarm Acknowledgement22Enabling Automatic NE Backup22Verifying NE Automatic Backup23Verifying NE Support237 Related Documentation238 Obtaining Documentation and Submitting a Service Request23Size: 408 KBPages: 24Language: EnglishOpen manual
