Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual August 23, 2010 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
C O N T E N T S Preface xiii Objectives Audience xiii xiii Conventions xiv Related Documentation xiv Obtaining Documentation and Submitting a Service Request CHAPTER 1 Overview of CTM GateWay/CORBA xx 1-1 1.1 Features of CTM GateWay/CORBA 1-3 1.2 CTM GateWay/CORBA Fault Management 1-3 1.3 Overview of CORBA Services 1-4 1.3.1 Naming Service 1-4 1.3.2 Notification Service 1-4 1.4 Information Model 1.5 IDL-Related Changes 1-7 1-8 1.6 Functionalities Not Supported in R9.2 1.
Contents 2.1.14 MDS 9000 2-22 2.1.15 Unmanaged NEs 2-22 2.2 CTM-Specific Details 2-23 2.2.1 Layer Rate 2-23 2.2.2 Inventory 2-27 2.2.3 Interfaces 2-28 2.2.4 Object Details 2-29 2.2.5 Naming Conventions 2-30 2.2.6 Programming Details 2-37 2.2.7 Provisioning Subnetwork Connections CHAPTER 3 Using CTM GateWay/CORBA Interfaces 2-39 3-1 3.1 Overview of APIs Supported by NE Type 3-2 3.2 common::Common_I 3-18 3.2.1 common::Common_I:: getCapabilities 3-18 3.3 emsMgr::EMSMgr_I 3-19 3.3.
Contents 3.3.24 deleteMultiLayerSubnetwork 3-49 3.3.25 getAllSupportedMEModels 3-50 3.4 EmsSession::EmsSession_I 3-50 3.4.1 getEventChannel 3-50 3.4.2 getManager 3-51 3.4.3 getSupportedManagers 3-52 3.5 emsSessionFactory::EmsSessionFactory_I 3.5.1 getEmsSession 3-52 3.5.2 getEmsPublicKey 3-53 3.5.3 getEmsPublicKeyPair 3-54 3-52 3.6 equipment::EquipmentInventoryMgr_I 3-55 3.6.1 getAllEquipment 3-55 3.6.2 getAllEquipmentNames 3-63 3.6.3 getAllSupportedPTPs 3-63 3.6.4 getAllSupportedPTPNames 3-71 3.6.
Contents 3.8.13 3.8.14 3.8.15 3.8.16 3.8.17 3.8.18 3.8.19 3.8.20 3.8.21 3.8.22 3.8.23 3.8.24 3.8.25 3.8.26 3.8.27 3.8.28 3.8.29 3.8.30 3.8.31 3.8.32 3.8.33 3.8.34 3.8.35 3.8.36 3.8.37 3.8.38 3.8.
Contents 3.9.13 3.9.14 3.9.15 3.9.16 3.9.17 3.9.18 3.9.19 3.9.20 3.9.21 3.9.22 3.9.23 3.9.24 3.9.25 3.9.26 3.9.27 3.9.28 3.9.29 3.9.30 3.9.31 3.9.32 3.9.33 3.9.34 3.9.35 3.9.36 3.9.37 3.9.38 3.9.39 3.9.40 3.9.41 3.9.42 3.9.43 3.9.44 3.9.
Contents 3.10.7 modifyMLVLANCustomerIDServiceID 3-188 3.10.8 getMLVLAN 3-189 3.10.9 deleteMLVLAN 3-189 3.10.10 getAllMLVLANs 3-190 3.10.11 getAllMLVLANNames 3-191 3.10.12 getAllAssociatedSNCs 3-192 3.10.13 getL2Topology 3-193 3.10.14 getAssociatedL2TopologyForSNC 3-193 3.10.15 getAssociatedL2TopologyForMLVLAN 3-194 3.10.16 createL2Topology 3-195 3.10.17 deleteL2Topology 3-203 3.10.18 modifyL2Topology 3-204 3.10.19 getAllAvailableMLEquipmentOrTPNames 3-204 3.11 E-Series VLAN Interfaces 3-205 3.11.
Contents 3.14.6 deleteProtectionGroup 3-286 3.14.7 getAssociatedProtectionGroup 3-287 3.15 session::Session_I 3-287 3.15.1 endSession 3-288 3.15.2 ping 3-288 3.16 mtnmVersion::Version_I 3-289 3.16.1 getVersion 3-289 3.17 Transmission Descriptor Interfaces 3-289 3.17.1 getAllTransmissionDescriptors 3-290 3.17.2 getAllTransmissionDescriptorsNames 3-291 3.17.3 getTransmissionDescriptor 3-292 3.17.4 getAssociatedTPs 3-292 3.17.5 createTransmissionDescriptor 3-293 3.17.6 deleteTransmissionDescriptor 3-294 3.
Contents A.4.6 A.4.7 A.4.8 A.4.9 Threshold Crossing Alert A-9 Alarm A-10 Heartbeat Event A-11 Backup Status Event A-11 A.5 Probable Cause Mapping A-12 A.5.1 TMF-Defined Probable Cause A-12 A.5.2 CTM GateWay/CORBA Mapping—EMS A-13 A.5.3 CTM GateWay/CORBA Mapping—MGX 8880/8850/8830 A-13 A.5.4 CTM GateWay/CORBA Mapping—ONS 15216 A-24 A.5.5 CTM GateWay/CORBA Mapping—ONS 15305 and ONS 15305 CTC A-26 A.5.
Contents APPENDIX C B.14 CTM R9.1-to-CTM R9.2 Migration B-12 OSS Use Cases and Client Development C-1 C.1 Use Cases to Resynchronize the NMS from the EMS C.2 Developing a CTM GateWay/CORBA Client C-4 C.2.1 Recommended Tools C-4 C.2.2 Sample Code in Java C-5 C.2.3 Running the Client C-11 C.2.4 Known Interoperability Issues When Using Orbix APPENDIX D Equipment List for NEs C-1 C-12 D-1 D.1 Equipment List for MDS 9000 D-1 D.2 Equipment List for MGX 8830/8850/8880 D.
Contents Cisco Transport Manager Release 9.
Preface This section explains the objectives, intended audience, and organization of this guide and describes the conventions that convey instructions and other information. Objectives This guide provides a detailed description of the northbound Common Object Request Broker Architecture (CORBA) interfaces supported by Cisco Transport Manager (CTM). This guide serves as a reference for developers of Operations Support System (OSS) applications that interface with CTM GateWay/CORBA Release 9.2.
Preface • Object Management Group (OMG) CORBA, notification service, and naming service • Telecommunication Management Network (TMN) architecture model Conventions This guide uses the following conventions: Caution Note Timesaver Tip Item Convention Commands and keywords boldface font Displayed session and system information screen font Information that the user must enter boldface screen font Variables that the user must supply italic screen font Menu items and button names boldface fo
Preface • Cisco Transport Manager Release 9.2 User Guide—Describes how to use the CTM software, which consists of user applications and tools for network discovery, network configuration, connection management, fault management, system administration, and security management. • Cisco Transport Manager Release 9.2 GateWay/CORBA User Guide and Programmer Manual—This guide. • Cisco Transport Manager Release 9.
Preface The following table lists the related NE hardware documentation.
Preface Table 1 Related Cisco NE Documentation (continued) Cisco Product ONS 15216 Document Title • Cisco ONS 15216 EDFA Operations Guide • Cisco ONS 15216 EDFA2 Operations Guide • Cisco ONS 15216 EDFA3 Operations Guide • Cisco ONS 15216 FlexLayer User Guide • Cisco ONS 15216 OSC-1510 User Guide • Cisco ONS 15216 System Dispersion Compensation Unit User Guide • Installing Cisco ONS 15216 100 GHz DWDM Filters • Installing Cisco ONS 15216 OADMs • Release Notes for the Cisco ONS 15216 EDFA
Preface Table 1 Related Cisco NE Documentation (continued) Cisco Product ONS 15454 SDH ONS 15454 SONET ONS 15530 ONS 15540 ESP Document Title • Cisco ONS 15454 SDH Procedure Guide • Cisco ONS 15454 DWDM Procedure Guide • Cisco ONS 15454 SDH Reference Manual • Cisco ONS 15454 SDH Software Upgrade Guide • Cisco ONS 15454 SDH Troubleshooting Guide • Cisco ONS 15454 SONET/SDH ML-Series Multilayer Ethernet Card Software Feature and Configuration Guide • Release Notes for the Cisco ONS 15454 S
Preface Table 1 Related Cisco NE Documentation (continued) Cisco Product Document Title ONS 15540 ESPx ONS 15600 SDH ONS 15600 SONET • Cisco ONS 15540 ESPx Cleaning Procedures for Fiber Optic Connections • Cisco ONS 15540 ESPx Configuration Guide and Command Reference • Cisco ONS 15540 ESPx Hardware Installation Guide • Cisco ONS 15540 ESPx MIB Quick Reference • Cisco ONS 15540 ESPx Planning and Design Guide • Cisco ONS 15540 ESPx System Alarms and Error Messages • Network Management fo
Preface • ITU-T G.826: Error performance parameters and objectives for international, constant bit rate digital paths at or above the primary rate • ITU-T G.829: Error performance events for SDH multiplex and regenerator sections • ITU-T G.831: Management Capabilities of Transport Networks based on the synchronous digital hierarchy (SDH) • ITU-T G.872: Architecture of optical transport networks • ITU-T M.3010: Principles for a Telecommunications management network • ITU-T M.
CH A P T E R 1 Overview of CTM GateWay/CORBA This chapter provides an overview of CTM GateWay/CORBA. It includes the following information: • 1.1 Features of CTM GateWay/CORBA, page 1-3 • 1.2 CTM GateWay/CORBA Fault Management, page 1-3 • 1.3 Overview of CORBA Services, page 1-4 • 1.4 Information Model, page 1-7 • 1.5 IDL-Related Changes, page 1-8 • 1.6 Functionalities Not Supported in R9.2, page 1-9 • 1.7 Summary, page 1-9 CTM is a highly advanced optical transport domain manager.
Chapter 1 • ONS 15327 • ONS 15454 SDH • ONS 15454 SONET • ONS 15530 • ONS 15540 • ONS 15600 SDH • ONS 15600 SONET Overview of CTM GateWay/CORBA The following figure illustrates the CTM GateWay/CORBA communications architecture within a service provider’s OSS environment.
Chapter 1 Overview of CTM GateWay/CORBA 1.1 Features of CTM GateWay/CORBA 1.1 Features of CTM GateWay/CORBA CTM GateWay/CORBA supports the following TM.
Chapter 1 Overview of CTM GateWay/CORBA 1.3 Overview of CORBA Services The NMS retrieves all active alarms on the EMS and on managed element objects. The NMS filters alarms based on probable cause, perceived severity, and managed element name. 1.3 Overview of CORBA Services CTM GateWay/CORBA uses two CORBA services—naming service and notification service. The naming service is required for CTM GateWay/CORBA to function.
Chapter 1 Overview of CTM GateWay/CORBA 1.3.2 Notification Service The following scenarios describe possible configurations of the naming and notification services. Scenario 1: Naming and Notification Services Installed on the CTM Server The naming and notification services are installed on the CTM server workstation as shown in the following figure.
Chapter 1 Overview of CTM GateWay/CORBA 1.3.2 Notification Service Scenario 2: Naming and Notification Services Installed on the NMS Workstation The naming and notification services are installed on the NMS workstation as shown in the following figure.
Chapter 1 Overview of CTM GateWay/CORBA 1.4 Information Model Scenario 3: Naming and Notification Services Installed on Independent Servers The naming and notification services are installed on independent servers as shown in the following figure.
Chapter 1 Overview of CTM GateWay/CORBA 1.5 IDL-Related Changes 1.5 IDL-Related Changes The following table lists the IDL-related changes that occurred between two given releases. Table 1-1 Summary of IDL-Related Changes Release Details Change From R9.1 to R9.2 No change From R9.0 to R9.1 • managedElementManager.
Chapter 1 Overview of CTM GateWay/CORBA 1.6 Functionalities Not Supported in R9.2 1.6 Functionalities Not Supported in R9.2 The following table lists the functionalities which are not supported in release 9.2. The cards or equipment in which the functionalities are not supported are also listed.
Chapter 1 Overview of CTM GateWay/CORBA 1.7 Summary Cisco Transport Manager Release 9.
CH A P T E R 2 NE- and CTM-Specific Details This chapter provides specific details about each of the NEs that CTM supports. It also provides details specific to CTM. The following sections include NE- and CTM-specific details: Note • 2.1 NE-Specific Details, page 2-1 • 2.2 CTM-Specific Details, page 2-23 In this document, the terms network element (NE) and managed element (ME) are interchangeable. Also, card and equipment strings are used interchangeably to refer to equipment. 2.
Chapter 2 NE- and CTM-Specific Details 2.1.2 ONS 15305 and ONS 15305 CTC 2.1.1.2 Topological Links Topological links are unidirectional for ONS 15216 NEs. Inter-NE links are available between all NEs in the ONS 15216 family. CTM supports links between an ONS 15216 and the following NEs at compatible layer rates: • ONS 15216 • ONS 15310 CL and ONS 15310 MA SONET • ONS 15327 (physical, SONET/SDH, and OCH) • ONS 15454 (physical, SONET/SDH, and OCH) • ONS 15600 (physical, SONET/SDH, and OCH) 2.1.
Chapter 2 NE- and CTM-Specific Details 2.1.3 ONS 15310 CL 2.1.3.2.1 Equipment Administration State The attribute name is ACTUAL_EQUIPMENT_SERVICE_STATE and is displayed in getAdditionalInfo for the equipment. Table 2-1 lists the attribute values for the administration state. Table 2-2 and Table 2-3 list the attribute values for the service state. Table 2-1 Equipment Administration State (ONS 15310 CL) Attribute Value Meaning In Service Places the entity In Service.
Chapter 2 NE- and CTM-Specific Details 2.1.3 ONS 15310 CL Table 2-3 Equipment Service State–Secondary (ONS 15310 CL) (continued) Secondary States (SST) Attribute Value Meaning Disabled (DSBLD) The entity has been manually removed from service and cannot perform its provisioned functions. All of its provisioned services are disrupted. Traffic is not carried. Loopback (LPBK) The loopback command is in effect (any loopback type). 2.1.3.
Chapter 2 NE- and CTM-Specific Details 2.1.4 ONS 15310 MA SDH 2.1.4 ONS 15310 MA SDH See the Release Notes for Cisco Transport Manager Release 9.2 for the ONS 15310 MA SDH software releases that CTM R9.2 supports. 2.1.4.1 Slots The ONS 15310 MA SDH consists of two CTX slots and four Expansion (EXP) I/O slots. 2.1.4.2 Topological Links All topological links are unidirectional or bidirectional for ONS 15310 MASDH NEs. 2.1.4.
Chapter 2 NE- and CTM-Specific Details 2.1.5 ONS 15310 MA SONET 2.1.5 ONS 15310 MA SONET See the Release Notes for Cisco Transport Manager Release 9.2 for the ONS 15310 MA SONET software releases that CTM R9.2 supports. 2.1.5.1 Slots The ONS 15310 MA SONET consists of two CTX slots and four EXP I/O slots. 2.1.5.2 Topological Links All topological links are unidirectional or bidirectional for ONS 15310 MA SONET NEs. 2.1.5.
Chapter 2 NE- and CTM-Specific Details 2.1.6 ONS 15327 information, including the actual name, and an AVC event is generated for the managed element name. The NMS listens to the AVC event for the managed element name and invokes managedElementManager::ManagedElementManager_I:: getManagedElement. 2.1.6 ONS 15327 See the Release Notes for Cisco Transport Manager Release 9.2 for the ONS 15327 software releases that CTM R9.2 supports. 2.1.6.1 Slots The ONS 15327 is a single-shelf NE with eight slots.
Chapter 2 NE- and CTM-Specific Details 2.1.6 ONS 15327 2.1.6.2.2 Equipment Service State The attribute name is ACTUAL_EQUIPMENT_SERVICE_STATE and is displayed in getAdditionalInfo for the equipment. The attribute value for the service state is the same as that shown in CTM. Table 2-5 Equipment Service State–Primary (ONS 15327) Primary States (PST-PSTQ) Attribute Value Meaning In Service–Normal (IS_NR) The entity is fully operational and performs as provisioned.
Chapter 2 NE- and CTM-Specific Details 2.1.7 ONS 15454 SDH 2.1.6.5 PTPs All PTPs are bidirectional for the ONS 15327. The ports are always in channelized mode. PTPs support In Service, Out of Service, Out of Service–Maintenance, and Auto in Service values for the service state attribute. 2.1.6.6 CTPs All CTPs are in channelized mode for the ONS 15327. Alarm monitoring cannot be turned on or off for CTPs. 2.1.6.7 SNCs XTC cards perform STS and VT1.5 switching.
Chapter 2 NE- and CTM-Specific Details 2.1.7 ONS 15454 SDH 2.1.7.3.1 Equipment Administration State The attribute name is ACTUAL_EQUIPMENT_SERVICE_STATE and is displayed in getAdditionalInfo for the equipment. Table 2-7 lists the attribute values for the administration state. Table 2-8 and Table 2-9 list the attribute values for the service state. Table 2-7 Equipment Administration State (ONS 15454 SDH) Attribute Value Meaning In Service Places the entity In Service.
Chapter 2 NE- and CTM-Specific Details 2.1.7 ONS 15454 SDH Table 2-9 Equipment Service State–Secondary (ONS 15454 SDH) (continued) Secondary States (SST) Attribute Value Meaning DSBLD (Disabled) The entity has been manually removed from service and cannot perform its provisioned functions. All of its provisioned services are disrupted. Traffic is not carried. LPBK (Loopback) The loopback command is in effect (any loopback type). 2.1.7.
Chapter 2 NE- and CTM-Specific Details 2.1.8 ONS 15454 SONET 2.1.7.10 Autodiscovery ONS 15454 SDH autodiscovery is identical to ONS 15454 SONET autodiscovery, described in 2.1.8.10 Autodiscovery, page 2-14. 2.1.8 ONS 15454 SONET See the Release Notes for Cisco Transport Manager Release 9.2 for the ONS 15454 SONET software releases that CTM R9.2 supports. 2.1.8.1 Shelves All supported ONS 15454 SONET NEs have exactly one shelf each, with the exception of the ONS 15454 SONET MSTP R7.
Chapter 2 NE- and CTM-Specific Details 2.1.8 ONS 15454 SONET 2.1.8.3.2 Equipment Service State The attribute name is ACTUAL_EQUIPMENT_SERVICE_STATE and is displayed in getAdditionalInfo for the equipment. The attribute value for the service state is the same as that shown in CTM. Table 2-11 Equipment Service State–Primary (ONS 15454 SONET) Primary States (PST-PSTQ) Attribute Value Meaning In Service–Normal (IS_NR) The entity is fully operational and performs as provisioned.
Chapter 2 NE- and CTM-Specific Details 2.1.9 ONS 15530 2.1.8.6 CTPs All CTPs are in channelized mode for the ONS 15454 SONET. Alarm monitoring cannot be turned on or off for CTPs. 2.1.8.7 SNCs One node supports a maximum of 144 bidirectional STS SNCs with an XC or Cross-Connect Virtual Tributary (XCVT) card installed or 576 bidirectional STS SNCs with a 10 Gigabit Cross-Connect (XC10G) card installed. If an XCVT or XC10G card is present, you can create a maximum of 336 bidirectional VT1.5 SNCs.
Chapter 2 NE- and CTM-Specific Details 2.1.9 ONS 15530 2.1.9.1 Slots The ONS 15530 is a single-shelf NE with 13 slots. It has a dual-CPU system with integrated switch fabric. The processor cards occupy slot 6 and slot 7. Slot 1 contains the multiplexer/demultiplexer motherboards, which are populated with optical multiplexer/demultiplexer modules.
Chapter 2 NE- and CTM-Specific Details 2.1.10 ONS 15540 • voaFilterIn • voaFilterOut • voaBypassIn • voaBypassOut • voaIn • voaOut 2.1.9.3 CTPs CTM GateWay/CORBA does not support CTPs for the ONS 15530. 2.1.9.4 SNCs CTM GateWay/CORBA does not support SNCs for the ONS 15530. 2.1.9.5 Equipment Protection 1:1 equipment protection is supported for the CPU card. 2.1.9.6 Equipment The ONS 15530 reports all field-replaceable units (FRUs) as equipment.
Chapter 2 NE- and CTM-Specific Details 2.1.10 ONS 15540 2.1.10.1 Slots The ONS 15540 is a single-shelf NE with 13 slots. The ONS 15540 is a dual-CPU system where the processor cards occupy slot 7 and slot 8. Slot 1 and slot 2 contain the multiplexer/demultiplexer motherboards, which are populated with optical multiplexer/demultiplexer modules. The remaining slots contain the line card motherboards, which are populated with transponder modules. 2.1.10.2 PTPs All PTPs are bidirectional for the ONS 15540.
Chapter 2 NE- and CTM-Specific Details 2.1.11 ONS 15600 SONET 2.1.10.4 SNCs CTM GateWay/CORBA does not support SNCs for the ONS 15540. 2.1.10.5 Equipment Protection 1:1 equipment protection is supported for CPU cards. 2.1.10.6 Equipment The ONS 15540 reports all FRUs as equipment. The chassis is also reported as equipment under the shelf equipment holder. 2.1.10.7 Topological Links Topological links are unidirectional or bidirectional for ONS 15540 NEs.
Chapter 2 NE- and CTM-Specific Details 2.1.11 ONS 15600 SONET 2.1.11.2.1 Equipment Administration State The attribute name is ACTUAL_EQUIPMENT_SERVICE_STATE and is displayed in getAdditionalInfo for the equipment. Table 2-13 lists the attribute values for the administration state. Table 2-14 and Table 2-15 list the attribute values for the service state. Table 2-13 Equipment Administration State (ONS 15600 SONET) Attribute Value Meaning In Service Places the entity In Service.
Chapter 2 NE- and CTM-Specific Details 2.1.11 ONS 15600 SONET Table 2-15 Equipment Service State–Secondary (ONS 15600 SONET) (continued) Secondary States (SST) Attribute Value Meaning Disabled (DSBLD) The entity has been manually removed from service and cannot perform its provisioned functions. All of its provisioned services are disrupted. Traffic is not carried. Loopback (LPBK) The loopback command is in effect (any loopback type). 2.1.11.
Chapter 2 NE- and CTM-Specific Details 2.1.12 ONS 15600 SDH 2.1.12 ONS 15600 SDH See the Release Notes for Cisco Transport Manager Release 9.2 for the ONS 15600 SDH software releases that CTM R9.2 supports. 2.1.12.1 Slots The ONS 15600 SDH is a single-shelf NE with 14 slots. The TSC card must occupy slot 5 or slot 10. The CXC cards are always 1+1 redundant in slots 6/7 and 8/9. Each CXC card occupies two slots. Slots 1 to 4 and 11 to 14 are reserved for optical I/O cards.
Chapter 2 NE- and CTM-Specific Details 2.1.13 MGX 8880/8850/8830 2.1.13 MGX 8880/8850/8830 See the Release Notes for Cisco Transport Manager Release 9.2 for the MGX software releases that CTM R9.2 supports. 2.1.13.1 Racks The MGX 8880/8850/8830 is a single-rack NE. 2.1.13.2 Shelves Each MGX 8880/8850/8830 NE has one shelf per rack. 2.1.13.3 Slots The MGX 8880/8850 is a single-shelf NE with 32 slots. Slots 7 and 8 are reserved for the controller (PXM45 or PXM1E) front card.
Chapter 2 NE- and CTM-Specific Details 2.2 CTM-Specific Details 2.2 CTM-Specific Details 2.2.1 Layer Rate Note The following table reports the layer rates supported by CTM. The layer rates are used for tasks such as link and circuit management, PM retrieval, port provisioning, and alarm handling. The Comments column contains further details on usage. Layer rates numbered 0 to 91 are TMF-defined, and layer rates numbered 92 and above are CTM-defined. Cisco Transport Manager Release 9.
Chapter 2 NE- and CTM-Specific Details 2.2.1 Layer Rate Table 2-16 Layer Rates Supported by CTM R9.
Chapter 2 NE- and CTM-Specific Details 2.2.1 Layer Rate Table 2-16 Layer Rates Supported by CTM R9.
Chapter 2 NE- and CTM-Specific Details 2.2.1 Layer Rate Table 2-16 Layer Rates Supported by CTM R9.
Chapter 2 NE- and CTM-Specific Details 2.2.2 Inventory Table 2-16 Layer Rates Supported by CTM R9.
Chapter 2 NE- and CTM-Specific Details 2.2.3 Interfaces • For the ONS 15454 SDH R3.4 and later, the AIE (if installed) is reported in AdditionalHolder 1. • For the ONS 15600 SONET R5.0 and later, pluggable port modules (PPMs) and pluggable I/O modules (PIMs) on ASAP cards are reported as subslots and port holders, respectively. • For the ONS 15600 SDH R8.0, PPMs and PIMs on ASAP cards are reported as subslots and port holders, respectively. • For unmanaged NEs, CTM reports only ManagedElement.
Chapter 2 NE- and CTM-Specific Details 2.2.4 Object Details 2.2.4 Object Details 2.2.4.1 Multilayer Subnetwork A subnetwork is a collection of managed elements that reflects network connectivity, in most cases. There are two ways to create a new subnetwork through the CTM client: • In the Domain Explorer window, choose File > Add Network Element(s). Choose as the GNE ID and as the subnetwork ID. CTM creates a new subnetwork and assigns a name to the new subnetwork object.
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions 2.2.4.4 Managed Element and Object Creation Event You can use the CTM client to add new managed elements. If the name of the new element is incorrect, an object creation event is generated with the incorrect name. Later, when CTM connects to the actual NE, it retrieves the correct name. CTM generates an AVC event to notify the NMS of the correct name. 2.2.
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions For example, the wavepatch0/0/0 port (which is present in slot 0, subslot 0 in the NE) is reported as /rack=1/shelf=1/slot=1/subslot=1/port=1:wavepatch0/0/0. The transparent0/0/0 port (which is present in slot 0, subslot 0 in the NE) is reported as /rack=1/shelf=1/slot=1/subslot=1/port=1:transparent0/0/0. Some PTPs, such as wdm0/0, do not have an associated port number. In these cases, the port number is set to 1.
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions Table 2-17 CTPs for STS6c, STS9c, STS18c, STS24c, and STS36c (continued) Layer Rate CTP Tuple Comments sts24c_vc4_8c /sts24c_vc4_8c=1, 2 CTP is on the edge of sts24c, STS#1, STS#25. /sts24c_vc4_8c=1-r=[1..23] CTP is not on the edge of sts24c. For example, if CTP is on STS#10, the name is /sts24c_vc4_8c=1-r=9. /sts18c_vc4_6c=1, 2 CTP is on the edge of sts18c, STS#1, STS#19. /sts18c_vc4_6c=1-r=[1..
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions Table 2-17 CTPs for STS6c, STS9c, STS18c, STS24c, and STS36c (continued) Layer Rate CTP Tuple Comments sts18c_vc4_6c /sts18c_vc4_6c=1,2 CTP is on the edge of vc4_6c, VC4#1, VC4#7. /sts18c_vc4_6c=1-r=[1..5] CTP is not on the edge of vc4_6c. For example, if CTP is on VC4#3, the name is /sts18c_vc4_6c=1-r=2. /sts24c_vc4_8c=1,2 CTP is on the edge of vc4_8c, VC4#1, VC4#9. /sts24c_vc4_8c=1-r=[1..7] CTP is not on the edge of vc4_8c.
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions For unidirectional CTP, the naming convention is to add “/direction=src or sink” in front of the name. Because the CTPs in WDM SNC are all unidirectional, the name is “/direction=src or sink/frequency=nnn.mm” for WDM SNC CTPs. Because the CTM client uses wavelengths to represent an optical channel, enter the corresponding wavelength value in the nativeEMSName field for the CTP.
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions • L-band (even) 1571.24 nm, 1572.06 nm, 1572.89 nm, 1573.71 nm, 1574.54 nm, 1575.37 nm, 1576.20 nm, 1577.03 nm, 1577.86 nm, 1578.69 nm, 1579.52 nm, 1580.35 nm, 1581.18 nm, 1582.02 nm, 1582.85 nm, 1583.69 nm, 1584.53 nm, 1585.36 nm, 1586.20 nm, 1587.04 nm, 1587.88 nm, 1588.73 nm, 1589.57 nm, 1590.41 nm, 1591.26 nm, 1592.10 nm, 1592.95 nm, 1593.79 nm, 1594.64 nm, 1595.49 nm, 1596.34 nm, 1597.19 nm, 1598.04 nm, 1598.89 nm, 1599.75 nm, 1600.
Chapter 2 NE- and CTM-Specific Details 2.2.5 Naming Conventions For the ONS 155xx family, there is a new equipment holder called a port_holder. Because the TMF determines whether or not a piece of equipment has to be in an EquipmentHolder, the port_holder is created to hold the transceiver modules that contain the PTPs. A port_holder that is present in subslot 1, slot 0 in an NE is named /rack=1/shelf=1/slot=1/sub_slot=2/port_holder=1.
Chapter 2 NE- and CTM-Specific Details 2.2.6 Programming Details 2.2.5.10 L2 Topology An L2 topology represents a point-to-point, hub-and-spoke, or Resilient Packet Ring (RPR) Layer 2 network topology. These topologies exist over the underlying Layer 1 topology, which is formed by physical topological links. Each L2 topology name is identified in the context of an EMS and has two tuples. The first tuple represents the EMS name, and the second tuple represents the nativeEMSName of the L2 topology.
Chapter 2 NE- and CTM-Specific Details 2.2.6 Programming Details 2.2.6.3 Development Environment CTM GateWay/CORBA has been developed with Java Development Kit (JDK) 1.54.2 and jacORB 2.x1.3.7 on Sun Solaris 10 and is compliant with the CORBA 2.3 specification. The OSS can use Java or the C++ IDL compiler to compile IDL files. Note If you use Java and jacORB, the CTM server installation provides JAR files for notification IDLs and TMF IDLs.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections 2.2.6.4.7 EXCPT_ACCESS_DENIED This exception indicates that an operation has resulted in a security violation. Verify that you have the required access to perform the operation. 2.2.6.4.8 EXCPT_TOO_MANY_OPEN_ITERATORS This exception indicates that the EMS has exceeded the number of iterators it can support. CTM supports 128 iterators.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections The three modes supported for SNC provisioning on Ethernet equipment are: • Single-card mode—E-series cards; VLANs can be associated during creation. • Multicard mode—E-series cards; VLANs can be associated during creation. • Linear-card mode—E-series, G-series, and ML-series cards.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections 2.2.7.2.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections Use the API getAllSrcPTP/CTP/FTPForCircuitProvisioning to retrieve the possible endpoints, taking into account the current card mode. Note You cannot change the card mode from the CTM GateWay/CORBA interface. You cannot change the card mode if there is a circuit on the card. To determine whether a CE-MR-10 card is configured for Manual or Automatic mode, use the getEquipment API, which returns the CardMode parameter.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections As opposed to the MSPP data cards and the OC cards, FTPs on ADM_10G client ports contain reference to ppm_holder as well. For example: 15454-ANSI-68-8 /rack=1/shelf=1/slot=5/ppm_holder=2/port=1 2.2.7.3 Tunnel SNC Provisioning CTM supports tunnel SNC provisioning on ONS 15310, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH NEs. The tunnel SNC must be bidirectional.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections CTP naming is identical to OCHNC SNCs: CTM GateWay/CORBA determines whether to create an OCHNC or OCHCC, depending on the layer. See 2.2.5.4 Connection Termination Point, page 2-31 for the CTP details. OCHCC must be bidirectional. CTM supports different sizes corresponding to possible payload types of transponder and muxponder client ports. A specific layer must be defined for each payload type.
Chapter 2 NE- and CTM-Specific Details 2.2.7 Provisioning Subnetwork Connections • OADM_PORT_EQPT • OPT_AMP_17_C_LINE_CARD_EQPT • OPT_AMP_L_EQPT • OPT_BST_E_EQPT • OPT_BST_EQPT • OPT_BST_L_EQPT • OPT_PRE_EQPT • OSC_CSM_CARD_EQPT • OSCM_CARD_EQPT • OSCM_PORT_EQPT • WSS_32_CARD_EQPT • WSS32_L_CARD_EQPT • WSS40_LINE_CARD_EQPT • WXC40_LINE_CARD_EQPT This type of circuit is referred to as WDM SNC.
Chapter 2 NE- and CTM-Specific Details 2.2.
CH A P T E R 3 Using CTM GateWay/CORBA Interfaces This chapter describes each interface that CTM supports, including TeleManagement Forum (TMF)-specific and Cisco-proprietary interfaces. This chapter includes the following information: Note • 3.1 Overview of APIs Supported by NE Type, page 3-2 • 3.2 common::Common_I, page 3-18 • 3.3 emsMgr::EMSMgr_I, page 3-19 • 3.4 EmsSession::EmsSession_I, page 3-50 • 3.5 emsSessionFactory::EmsSessionFactory_I, page 3-52 • 3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type 3.1 Overview of APIs Supported by NE Type The following table lists each API and the NEs that support it. Table 3-1 API No. APIs Supported by NE Type CTM GateWay/CORBA API Supported NEs 1. common::Common_I:: getCapabilities — 2.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 APIs Supported by NE Type (continued) API No. CTM GateWay/CORBA API Supported NEs 11. emsMgr::EMSMgr_I:: deleteTopologicalLink MDS 9000, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS ONS 15454-M2, ONS 15454-M6, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, unmanaged NE 12.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 APIs Supported by NE Type (continued) API No. CTM GateWay/CORBA API Supported NEs 29. emsSession::EmsSession_I:: getSupportedManagers All 30. emsSessionFactory::EmsSessionFactory_I:: getEmsSession — 31. emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKey — 32. emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKeyPair — 33.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 39.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 47. managedElementManager::ManagedElementManager_I:: ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA getAllActiveAlarms SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 48.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 56. managedElementManager::ManagedElementManager_I:: ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA SDH, getContainedPotentialTPNames ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 57.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 66. managedElementManager::ManagedElementManager_I:: ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA getAllDestPTPsForSNCProvisioning SONET, ONS 15327, OONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 67.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 75. managedElementManager::ManagedElementManager_I:: ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA getRollToPTPs SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 76.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 86. multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllEdgePoints ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET 87.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 95. multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllTopologicalLinkNames ONS 15216, ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET 96.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 104. multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addDrops ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 105.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 119. multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteRoll Release 6.0 of ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 120.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 128. multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCOnDRI ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 129.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 139. performance::PerformanceManagementMgr_I:: deleteHistoryPMDataFile ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SONET 140.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 APIs Supported by NE Type (continued) API No. CTM GateWay/CORBA API Supported NEs 148. protection::ProtectionMgr_I:: createProtectionGroup ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, ONS 15600 SDH, ONS 15600 SONET 149.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.1 Overview of APIs Supported by NE Type Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 165. multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllAssociatedSNCs ONS 15454 SDH, ONS 15454-M2 SDH, ONS 15454-M6 SDH, ONS 15454 SONET, ONS 15454-M2 SONET, ONS 15454-M6 SONET, 166.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.2 common::Common_I Table 3-1 API No. APIs Supported by NE Type (continued) CTM GateWay/CORBA API Supported NEs 182. softwareAndDataManager::SoftwareAndDataMgr_I:: restoreME All 183. softwareAndDataManager::SoftwareAndDataMgr_I:: getMERestoreStatus All 184. softwareAndDataManager::SoftwareAndDataMgr_I:: abortMERestore All 185. softwareAndDataManager::SoftwareAndDataMgr_I:: getAllSupportedMESoftwareVersions All 186.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3 emsMgr::EMSMgr_I A Capability_T value is used to identify a functionality supported by the EMS across the network management layer-element management layer (NML-EML) interface. It is a name/value pair, in which the name represents the feature/capability name and the value represents the support or nonsupport of the specified feature/capability. The EMS capabilities for this release include individual IDL operation support.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.2 getAllEMSSystemActiveAlarms The result of this operation is independent of the filtering set up by the NMS for the notification service. ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH do not send a “clear” for TCA events. TCAs are not reported in the eventList returned by this method.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.3 getAllTopLevelSubnetworks Parameters Name Type Input/Output Description excludeSev erityList notifications::PerceivedSeverityList_T In List of severities to exclude from the output event list. how_many unsigned long In Maximum number of alarms to report in the first batch. eventList notifications::EventList_T Out First batch of alarms. eventIt notifications::EventIterator_I Out Iterator to retrieve the remaining alarms.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.3 getAllTopLevelSubnetworks • string nativeEMSName – Supported. • string owner – Not supported. • Topology_T subnetworkType – Supports TOPO_SINGLETON, TOPO_CHAIN, TOPO_PSR, TOPO_OPEN_PSR, TOPO_SPRING, TOPO_OPEN_SPRING, and TOPO_MESH. • transmissionParameters::LayerRateList_T supportedRates – Not supported. • globaldefs::NVSList_T additionalInfo – Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.4 getAllTopLevelSubnetworkNames 3.3.4 getAllTopLevelSubnetworkNames Synopsis void getAllTopLevelSubnetworkNames( in unsigned long how_many, out globaldefs::NamingAttributesList_T nameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface has the same behavior as the interface described in 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.5 getAllTopLevelTopologicalLinks Parameters Name Type Input/Output Description how_many unsigned long In Maximum number of top-level topological links to return in the first batch. topoList topologicalLink::Topological LinkList_T Out First batch of top-level topological links. topoIt topologicalLink::Topological LinkIterator_I Out Iterator to retrieve the remaining top-level topological links.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.7 getTopLevelTopologicalLink Parameters Name Type Input/Output Description how_many unsigned long In Maximum number of top-level topological links to return in the first batch. nameList globaldefs::NamingAttributes List_T Out First batch of top-level topological link names. nameIt globaldefs::NamingAttributesI Out terator_I Iterator to retrieve the remaining top-level topological link names.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.8 createTopologicalLink EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a top level topological link object that does not exist in the EMS. Compliance TMF-defined. 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.8 createTopologicalLink – CTM supports CD_BI for bidirectional links. – CTM supports CD_UNI for unidirectional links. • transmissionParameters::LayerRate_T rate. For a list of supported layer rates, see 2.2.1 Layer Rate, page 2-23. • globaldefs::NamingAttributes_T aEndTP – Supported. • globaldefs::NamingAttributes_T zEndTP – Supported. • globaldefs::NVSList_T additionalCreationInfo – Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.9 createTopologicalLinkWithYCableProtection Description This interface enables an NMS to create a Y-cable topological link manually between two managed elements. A Y-cable link is a bidirectional link with one PTP source and two PTP destinations. Because of the limitation in TMF for topological links that have one PTP source and one PTP destination, CTM reports two topological links for a Y-cable link.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.10 deleteTopologicalLink • globaldefs::NamingAttributesList_T zEndTPs – Supported. It contains two PTPs on the same ME. • globaldefs::NVSList_T additionalInfo – Supported. The supported parameters are listed in the following table. Managed Element Type Parameter Name Supported Parameter Values All managed elements that support topological links linkCost Integer, 0 to 999999.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.11 modifyTopologicalLink Parameters Name Type Input/Output Description topoLinkName globaldefs::NamingAttributes_T In Name of the topological link to delete. Throws globaldefs::ProcessingFailureException EXCPT_INVALID_INPUT - Raised if input topological link name is invalid. EXCPT_ENTITY_NOT_FOUND - Raised if the specified topological link name does not exist in CTM. EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.12 getEMS CTM support for TLCreateData_T structure is as follows: • string userLabel – Supported. The value of this field is assigned to the name of the newly created topological link. • boolean forceUniqueness – CTM guarantees the uniqueness of topological link names. • string owner – Not supported. • globaldefs::ConnectionDirection_T direction – CTM supports CD_BI for bidirectional links and CD_UNI for unidirectional links.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.12 getEMS Description This interface enables an NMS to request EMS information. Parameters Name Type Input/Output Description emsInfo EMS_T Out EMS information. CTM supports EMS_T is as follows: • globaldefs::NamingAttributes_T name – EMS ID is returned as the same name that is displayed on the CTM client EMS property sheet. • string userLabel – Not supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.13 getAllL2Topologies 3.3.13 getAllL2Topologies Synopsis void getAllL2Topologies(in multiLayerSubnetwork::L2TopoType_T l2TopoType, in unsigned long how_many, out multiLayerSubnetwork::L2TopologyList_T l2TopoList, out multiLayerSubnetwork::L2TopologyIterator_I l2TopoIt) raises(globaldefs::ProcessingFailureException); Description This interface lists all L2 topologies of a particular topology type in the EMS. The L2 topology has a scope in the EMS.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.13 getAllL2Topologies LR_STS3c_and_AU4_VC4 LR_STS6c_and_VC4_2c LR_STS9c_and_VC4_3c LR_STS12c_and_VC4_4c LR_STS24c_and_VC4_8c LR_Not_Applicable (if the L2 topology contains L1 SNCs with different layer rates or if the L2 topology contains a mix of CCAT and VCAT L1 SNCs) • multiLayerSubnetwork::L2TopoType l2TopoType – The L2 topology type. Valid values are L2TopoType.PT2PT, L2TopoType.RPR, and L2TopoType.DOT17_RPR.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.14 getAllQoSTemplateNames 3.3.14 getAllQoSTemplateNames Synopsis void getAllQoSTemplateNames( in unsigned long how_many, out globaldefs::NamingAttributesList_T qosTempNameList, out globaldefs::NamingAttributesIterator_I qosTempNameIt) raises(globaldefs::ProcessingFailureException); Description This interface lists all QoS template names in the EMS. The QoSTemplate has a scope in the EMS.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.15 getAllQoSTemplates CTM support for QoSTemplate structure is as follows: • globaldefs::NamingAttributes_T templateName—Supported. This field specifies the template name. • string qos_template_description—Supported. This field specifies the description of the template. • emsMgr::TemplateType_T—TemplateType specifies the type of template. CTM supports the following types: – TemplateType_T.BEST_EFFORT – TemplateType_T.CIR_PIR – TemplateType_T.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.15 getAllQoSTemplates – multiLayerSubnetwork::ExcessAction_T excess_act—Supported. CTM supports the following values: – ExcessAction_T.EXCESS_ACTION_DISCARD – ExcessAction_T.EXCESS_ACTION_ALLOW – long pir—Supported. This field specifies the PIR value in the range of 96 to 800,000 kilobits per second. The PIR value is equal to or greater than the CIR value. – long pir_burst—Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.16 getQoSTemplate 3.3.16 getQoSTemplate Synopsis void getAllQoSTemplates( in globaldefs::NamingAttribute_T QoSTemplateName, out QoSTemplate_T qosTemp ) raises(globaldefs::ProcessingFailureException); Description This interface lists the complete QoSTemplate information for each QoSTemplate name. The QoSTemplate has a scope in the EMS. Parameters Name Type Input/Output Description qosTemplateName globaldefs::NamingAttributes_T In QoS template name.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.18 getAllEMSSystemClearedAlarms ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH The ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send a “clear” for TCA events. TCAs are not reported in the eventList that is returned by this method. ONS 15540 and ONS 15530 TCAs are reported in the eventList that is returned by this method. The ONS 15540 sends a “clear” for TCAs.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.19 createServerTrailLink Parameters Name Type Input/Output Description excludeSeverityList notifications::PerceivedSeverityList_T In List of alarm severities to exclude from the output event list. how_many unsigned long In Maximum number of alarms to report in the first batch. EventList notifications::EventList Out First batch of alarms. EventIt notifications::EventIterator_I Out Iterator to retrieve the remaining alarms.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.19 createServerTrailLink CTM support for STLCreateData_T structure is as follows: • string userLabel Not supported. The value of this field is assigned to the name of the newly created server trail link. • boolean forceUniqueness Not supported. • string owner Not supported. • globaldefs::ConnectionDirection_T direction CTM supports only CD_BI for bidirectional links.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.19 createServerTrailLink • string userLabel Not supported. • boolean forceUniqueness Not supported • string owner Not supported. • globaldefs::ConnectionDirection_T direction CTM supports only CD_BI for bidirectional links.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.20 deleteServerTrailLink Throws globaldefs::ProcessingFailureException EXCPT_INVALID_INPUT - Raised if input createData is not valid. EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service. EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. Compliance CTM-defined. 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.21 addNetworkPartition 3.3.21 addNetworkPartition Synopsis void addNetworkPartition( in string name, in string description) raises(globaldefs::ProcessingFailureException); Description This interface enables the OSS to add a new network partition. Parameters Name Type Input/Output Description name string In Network partition name. description string In Description of the new partition.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.22 addMultiLayerSubnetwork The description of each parameter is as follows: Name Type Description subnetworkName globaldefs::NamingAttributes_T New subnet partition name. userLabel string User label. nativeEMSName string EMS name. owner string Owner. subnetworkType multiLayerSubnetwork::Topology_T Subnetwork topology.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.23 deleteNetworkPartition 3.3.23 deleteNetworkPartition Synopsis void deleteNetworkPartition(in string name) raises(globaldefs::ProcessingFailureException); Description This interface enables the OSS to delete an existing network partition. Parameters Name Type Input/Output Description name string In Network partition name to delete. Throws globaldefs::ProcessingFailureException Compliance CTM-defined. 3.3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.3.25 getAllSupportedMEModels 3.3.25 getAllSupportedMEModels Synopsis void getAllSupportedMEModels(out globaldefs::NVSList_T supportedMEs) raises(globaldefs::ProcessingFailureException); Description This interface returns a list of all of the models that the EMS supports.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.4.2 getManager Parameters Name Type Input/Output Description eventChannel CosNotifyChannelAdmin::EventChannel Out Event channel that the NMS uses. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. Compliance TMF-defined. 3.4.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.4.3 getSupportedManagers 3.4.3 getSupportedManagers Synopsis void getSupportedManagers(out managerNames_T supportedManagerList) raises(globaldefs::ProcessingFailureException); Description This interface enables an NMS to request the manager interfaces that the EMS implements.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.5.2 getEmsPublicKey Description This interface enables the NMS to obtain the EmsSession_I object, which contains all managers of the EMS. CTM allows 4 to 25 concurrent login sessions and as many user profiles as required for configuring the number of concurrent login sessions. See B.8 Location of the Naming Service IOR File, page B-6 to configure the number of concurrent login sessions. The username and password must contain from 1 to 53 characters.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.5.3 getEmsPublicKeyPair Description This interface enables the NMS to obtain the string representation of the RSA public key encoded in the Base64 encoding scheme. The operation encrypts the username and password from the string representation of the RSA public key. The OSS client must use the Base64 decoders to decode the public key and get the byte[] of the public key from the decoded public key string.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6 equipment::EquipmentInventoryMgr_I Parameters Name Type Input/Output Description publicKeyModulus string Out Public key modulus string returned by CTM. publicKeyExponent string Out Public key exponent string returned by CTM. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. Compliance CTM-defined. 3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.1 getAllEquipment The EqList parameter contains a sequence of the EquipmentOrHolder_T data type, which is defined as the union of Equipment_T and EquipmentHolder_T. CTM support for Equipment_T is as follows: • globaldefs::NamingAttributes_T name – Supported. This field has four tuples. The first tuple is for EMS, the second is for ManagedElement, the third is for EquipmentHolder, and the fourth contains equipment.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.1 getAllEquipment • string installedSerialNumber – Supported when equipment is installed. • globaldefs::NVSList_T additionalInfo – Supported when equipment is installed. Common Language Equipment Identification (CLEI) code is available. CTM support for EquipmentHolder_T is as follows: • globaldefs::NamingAttributes_T name – Supported. This field has three tuples: one for EMS, one for ManagedElement, and one for EquipmentHolder name.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.1 getAllEquipment Table 3-2 Acceptable Equipment for ONS 15454 SONET Acceptable Equipment Classic Shelf M2 Shelf 1, 2, 3, 4, 5, 6, 2, 3 OPT_AMP_17_C, 12, 13, 14, 15, OPT_AMP_L, OPT_BST, 16, 17 OPT_BST_E, OPTBST_L, OPT_PRE, OPT_AMP_C,OPT_RAMP_C, OPT_RAMP_CE, 40-SMR1-C, 40-SMR2-C, TDCU-C, TDCU-F M6 Shelf 2, 3, 4, 5, 6, 7 10GE_XP, GE_XP, 10DME, 2.5G_DM, 2.5G_DMP, ADM_10G, MXP_2.5G_10E, MXP_2.5G_10G, TXPP_MR_2.5G, TXP_MR_2.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.1 getAllEquipment ONS 15216 FlexLayer Slot Number Acceptable Equipment 1, 2, 3, 4 FLA-8-channel ID Channel ID = 36.6, 44.5, 52.5, 60.6 FLB-2-channel ID Channel ID = 31.1, 32.6, 35.0, 36.6, 38.9, 40.5, 42.9, 44.5, 46.9, 48.5, 50.9, 52.5, 54.9, 56.5, 58.9, 60.6 CS-2 CS-3 CS-4 CS-SM-Y CS-MM-Y SC-4B 1, 2, 3 VOA-4 ONS 15216 DCU R2.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.2 getAllEquipmentNames 3.6.2 getAllEquipmentNames Synopsis void getAllEquipmentNames(in globaldefs::NamingAttributes_T meOrHolderName, in unsigned long how_many, out globaldefs::NamingAttributesList_T nameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface has the same behavior as the interface described in 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs Description This interface enables an NMS to request the PTPs that are directly supported by specific equipment. The PTPs that are returned are those that share their physical layer with the primary equipment (that is, they represent a port on the equipment or are connected by a fiber, wire, and so on).
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs • string owner – Not supported. • globaldefs::NamingAttributes_T ingressTrafficDescriptorName – Not supported. • globaldefs::NamingAttributes_T egressTrafficDescriptorName – Not supported. • TPType_T type – Supported. CTM supports TPT_PTP, TPT_CTP, and TPT_FTP. • TPConnectionState_T connectionState – Supported. For PTP, it is TPCS_NA; for CTP and floating termination point (FTP), it is TPCS_BI_CONNECTED.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs TP Type NE Type Valid Values Supporting Equipment and Restrictions IN_SERVICE, OUT_OF_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE (for NE R3.4.1 or later), AUTO_IN_SERVICE (for NE R3.4.1 or later) All equipment (except ML and CE cards, FCMR, and equipment that does not have PTP, such as XC, TCC2, and so on). G1000_4, G1000_2, and FCMR do not support the AUTO_IN_SERVICE value.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs TP Type NE Type Valid Values Supporting Equipment and Restrictions FrameFormat PTP ONS 15310 CL ONS 15310 MA esf, d4, unframed, auto provision fmt (only on DS1 port on XTC cards. ONS 15310) ONS 15327 ONS 15454 SONET esf, d4, unframed DS1, DS1N. ONS 15454 SONET m13, cbit, unframed, auto provision fmt DS3E, DS3NE, DS3I, DS31N, DS3. ONS 15454 SONET m13, cbit DS3XM.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs TP Type NE Type Valid Values Supporting Equipment and Restrictions ONS 15454 SONET True, False (read-only value) OC3_8, OC48 ELR, OC192 equipment only. ONS 15454 SDH True, False (read-only value) STM1_8, STM16 ELR, STM64 equipment only. ONS 15454 SONET True, False (write-only value) OC3_8, OC48 ELR, OC192 equipment only. ONS 15454 SDH True, False (write-only value) STM1_8, STM16 ELR, STM64 equipment only.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs TP Type NE Type Valid Values Supporting Equipment and Restrictions On, Off OC3. ONS 15454 SONET On, Off DS3E, DS3NE, DS3I, DS3IN, DS3XM, EC1, OC3, OC3_8, OC12_4, OC48AS, OC192. ONS 15454 SDH On, Off E3, DS3I, DS3IN, STM1E_12, OC3, OC3_8, OC12_4, OC48AS, OC192. ONS 15600 SONET On, Off OC48_16, OC192_4. ONS 15327 On, Off G1000_2. ONS 15310 CL On, Off ML2_L2L3 and ML2_MAPPER.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.3 getAllSupportedPTPs TP Type NE Type Valid Values Supporting Equipment and Restrictions On, Off FCMR (only in distance extension mode and for NE R5.0 and later). From 2 to 256, in multiples of 2 FCMR (only in distance extension mode and for NE R5.0 and later). On, Off FCMR (only in distance extension mode and for NE R5.0 and later). From 16 to 1200, in multiples of 16 FCMR (only in distance extension mode and for NE R5.0 and later).
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.4 getAllSupportedPTPNames EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object. EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not exist. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128. Compliance TMF-defined. 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.5 getAllSupportingEquipment 3.6.5 getAllSupportingEquipment Synopsis void getAllSupportingEquipment( in globaldefs::NamingAttributes_T ptpName, out EquipmentOrHolderList_T eqList) raises(globaldefs::ProcessingFailureException); Description This interface enables an NMS to request the equipment that contains a given PTP.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.7 getContainedEquipment Parameters Name Type Input/Output Description ptpName globaldefs::NamingAttributes_T In Name of the PTP for which to retrieve the supporting equipment. nameList globaldefs::NamingAttributesList_T Out List of equipment names (not equipment holders) directly implementing the PTP. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.8 getEquipment Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when equipmentHolderName does not reference an equipment holder object. EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolderName references an equipment holder that does not exist. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance TMF-defined. 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.9 provisionEquipment 3.6.9 provisionEquipment Synopsis void provisionEquipment( in EQTCreateData_T equipmentCreateData, out Equipment_T createdEquipment) raises(globaldefs::ProcessingFailureException); Description This interface enables the NMS to permanently provision a piece of equipment in an equipment holder in an ME. The result of this operation is the creation of the equipment object and all of its related objects, such as TPs.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.10 setAlarmReportingOff – Supported. • globaldefs::NVSList_T additionalInfo – Not supported. Note This interface is not applicable for configuring payloads for client ports in TXP_MR_10G. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_OBJECT_IN_USE - Raised when the equipment holder already has an expected equipment.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.11 setAlarmReportingOn EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when alarm reporting cannot be disabled for the equipment or holder. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance TMF-defined. 3.6.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.6.12 unprovisionEquipment 3.6.12 unprovisionEquipment Synopsis void unprovisionEquipment( in globaldefs::NamingAttributes_T equipmentName) raises(globaldefs::ProcessingFailureException); Description This interface enables the NMS to permanently unprovision equipment from the managed element. The successful result of this operation is the potential deletion of the equipment object and all of its related objects, such as termination points.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.7 maintenanceOps::MaintenanceMgr_I 3.7 maintenanceOps::MaintenanceMgr_I MaintenanceMgr_I is used as a handle to gain access to the maintenance operation. A handle to an instance of this interface is gained through the getManager operation in emsSession. interface MaintenanceMgr_I:common::Common_I This interface also implements the getCapabilities method.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.7.2 performMaintenanceOperation Throws globaldefs::ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service. EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when tpOrMeName does not reference a valid object. EXCPT_ENTITY_NOT_FOUND - Raised when tpOrMeName references an object that does not exist. EXCPT_NE_COMM_LOSS - Raised when communication to the ME is lost.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.7.2 performMaintenanceOperation For the ONS 15454 SONET R3.4 or later, the loopback state can be set only if the TP state is either Out of Service–Maintenance or Auto in Service. ONS 15600 SDH CTM supports only terminal and facility loopback operations for PTPs. CTM does not support loopback operations for CTPs. Loopback is supported only in the Out of Service–Maintenance state of the PTP.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8 managedElementManager::ManagedElementManager_I EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when tpName does not reference a TP. EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when the operation is denied by the ME. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance TMF-defined. 3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.2 getAllSNCs Parameters Name Type Input/Output Description meName globaldefs::NamingAttributes_T In Name of the ME for which to retrieve alarms. excludeProbCauseList notifications::ProbableCauseList_T In List of probable causes to exclude (for which events are not reported). excludeSeverityList notifications::PerceivedSeverityList_ T In List of severities to exclude from the output event list.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.2 getAllSNCs • For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment. • For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment. This interface does not report VCAT SNCs. Parameters Name Type Input/Output Description managedElementName globaldefs::NamingAttributes_T In Name of the ME whose SNCs are required.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.3 getAllManagedElements • StaticProtectionLevel_T staticProtectionLevel – Supported. For PCA circuits, the value is set to PREEMPTIBLE. • SNCType_T sncType – Not supported. • TPDataList_T aEnd – Supported. • TPDataList_T zEnd – Supported. • Reroute_T rerouteAllowed – Not supported. • NetworkRouted_T networkRouted – Not supported. • globaldefs::NVSList_T additionalInfo – Supported. Customer ID and service ID are reported if they are available.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.3 getAllManagedElements Parameters Name Type Input/Output Description how_many unsigned long In Maximum number of MEs to report in the first batch. meList managedElement::ManagedElementList_T Out First batch of MEs. meIt managedElement::ManagedElementIterator_I Out Iterator to retrieve the remaining MEs. CTM support for ManagedElement_T structure is as follows: • globaldefs::NamingAttributes_T name – Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.4 getAllManagedElementNames OperationStates EmsInSyncState UnderMaintenance False InServiceIntializing False InService True Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128. Compliance TMF-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.5 getAllPTPs 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.6 getAllPTPNames Parameters Name Type Input/Output Description managedElement Name globaldefs::NamingAttributes_T In Name of the ME for which to retrieve PTPs. tpLayerRateList transmissionParameters::LayerRateL In ist_T List of PTP layer rates for which the PTPs are retrieved. To be reported, a PTP must contain at least one of the layer rates specified. If the list is empty, all PTPs (of all rates) are returned.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.7 getContainedInUseTPs Description This interface has the same behavior as the interface described in 3.8.5 getAllPTPs, page 3-88, but returns the object names instead of the object structures. Parameters Name Type Input/Output Description managedElement globaldefs::NamingAttribute In Name s_T Name of the ME for which to retrieve PTPs. tpLayerRateList List of PTP layer rates for which PTPs are retrieved.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.7 getContainedInUseTPs Description This interface retrieves the in-use CTPs contained in a specific PTP, at specific layer rates. An in-use CTP is a CTP used by an SNC in any state (including pending) or a CTP that is terminated and mapped. Example for SONET: The NMS invokes this method on an OC3 PTP (and assumes that the NE does not have an XCVT card, so VT-level cross-connects are not possible) with an empty layerRateList.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.8 getContainedInUseTPNames 3.8.8 getContainedInUseTPNames Synopsis void getContainedInUseTPNames( in globaldefs::NamingAttributes_T tpName, in transmissionParameters::LayerRateList_T layerRateList, in unsigned long how_many, out globaldefs::NamingAttributesList_T nameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface has the same behavior as the operation described in 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.9 getContainedPotentialTPs out terminationPoint::TerminationPointList_T tpList, out terminationPoint::TerminationPointIterator_I tpIt) raises(globaldefs::ProcessingFailureException); Description This interface enables an NMS to request all of the CTPs it can support in all possible mapping configurations, at specified rates and TPs. This interface returns all potential contained CTPs for a specific TP. The TP might be a PTP or a CTP.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.10 getContainedPotentialTPNames 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.12 getManagedElement Description This interface returns a list of subnetwork names to which the ME (supplied as an input parameter) belongs. Parameters Name Type Input/Output Description managedElementName globaldefs::NamingAttributes_T In Name of the ME for which to retrieve the containing subnetwork names. subnetNames Out Names of the subnetworks to which the NE belongs.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.13 getAllCtmMEInternalPatchcord EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object. EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance TMF-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.14 setAdditionalInfo inout globaldefs::NVSList_T additionalInfo) raises(globaldefs::ProcessingFailureException); Description This interface sets attributes using the additionalInfo structure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.15 getTP Parameters Name Type Input/Output Description tpName globaldefs::NamingAttributes_T In Name of the TP to which to apply the list of modified attribute values. In/out List of attributes that must be modified, as well as the new related values to apply.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.16 getAssociatedTopologicalLinks Parameters Name Type Input/Output Description tpName globaldefs::NamingAttributes_T In Name of the TP to retrieve. tp terminationPoint::TerminationPoint_T Out Retrieved TP. For details about the TerminationPoint_T structure, see 3.6.3 getAllSupportedPTPs, page 3-63. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.17 setTPData EXCPT_INVALID_INPUT - Raised when ptpName does not reference a physical termination point object. EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.17 setTPData The SDH_SONET_SS_BITS and EnableSyncMsg parameters must be modified by invoking two separate method calls. If you try to use the same method to modify SDH_SONET_SS_BITS and EnableSyncMsg, CTM generates a processing failure exception. The setTPData interface does not apply to the following ML-series card parameters that are configurable through Cisco IOS: • Admin state, MTU size, and COS accounting for POS and Ethernet interfaces.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.18 getAllSrcPTPsForSNCProvisioning Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the TP referred to in tpInfo does not exist. EXCPT_INVALID_INPUT - Raised when tpInfo does not reference a valid CTP object. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance TMF-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.19 getAllSrcCTPsForSNCProvisioning Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.20 getAllSrcCTPsForVCATMemberSNCProvisioning Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.21 getAllDestPTPsForSNCProvisioning EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.22 getAllDestCTPsForSNCProvisioning Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the PTP does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.23 getAllDestCTPsForVCATMemberSNCProvisioning Name Type Input/Output Description tpList globaldefs::NamingAttributesList_T Out First batch of CTP names. tpIt globaldefs::NamingAttributesIterator_I Out Iterator to retrieve remaining CTP names. For a list of supported layer rates, see 2.2.1 Layer Rate, page 2-23. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.24 getAllSrcFTPsForSNCProvisioning Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the PTP does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.25 getAllDestFTPsForSNCProvisioning Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.26 forceNEResync For a list of supported layer rates, see 2.2.1 Layer Rate, page 2-23. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist. EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.27 getAllTopologicalLinksForME 3.8.27 getAllTopologicalLinksForME Synopsis void getAllTopologicalLinksForME( in globaldefs::NamingAttributes_T meName, in unsigned long how_many, out topologicalLink::TopologicalLinkList_T topoList, out topologicalLink::TopologicalLinkIterator_I topoIt) raises(globaldefs::ProcessingFailureException); Description This interface returns a list of topological links that originate or terminate on the specified managed element.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.28 getAllRolls out multiLayerSubnetwork::RollList_T rollList, out multiLayerSubnetwork::RollIterator_I rollIt) raises(globaldefs::ProcessingFailureException); Description This interface returns a list of rolls within the managed element whose name is passed as a parameter. Parameters Name Type Input/Output Description meName globaldefs::NamingAttributes_T In Name of MEs with rolls that are being queried.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.29 getAllRollNames • boolean rollValidSignal Supported. Values are TRUE or FALSE. Throws globaldefs::ProcessingFailureException EXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or in config synchronization state. EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist. EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.30 getRoll EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. Compliance CTM-defined. 3.8.30 getRoll Synopsis void getRoll( in globaldefs::NamingAttributes_T rollName, out multiLayerSubnetwork::Roll_T roll, raises(globaldefs::ProcessingFailureException); Description This interface returns the Roll_T structure for a specific roll name.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.32 getRollToCTPs out globaldefs::NamingAttributesIterator_I tpIt) raises(globaldefs::ProcessingFailureException); Description This interface returns a list of PTPs on a managed element that can be used for provisioning a roll on a specific SNC. The returned PTPs can be used to contain the rollToCTP. The SNC must be associated with the managed element on which the interface is invoked.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.33 getRollFromCTPs Parameters Name Type Input/Output Description ptpName globaldefs::NamingAttributes_T In Name of the PTP for which the list of CTPs is obtained for roll provisioning. how_many Unsigned In Maximum number of PTPs to report in the first batch. sncNames globaldefs::NamingAttributesList_T In Name of the SNC to roll over.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.34 setPortName Parameters Name Type Input/Output Description sncNames globaldefs::NamingAttributes List_T In Name of the SNC to roll over. If more than one SNC is specified, the first SNC becomes the RollFrom SNC and the second SNC becomes the RollToSNC. fixCTPName globaldefs::NamingAttributes _T In Fixed point on the roll. how_many Unsigned In Maximum number of CTPs to report in the first batch.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.35 getPortName Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when the ptpName does not refer to a valid PTP name or when it contains undefined values. EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references an object that does not exist. Compliance CTM-defined. 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.36 getAllClearedAlarms in unsigned long how_many, out notifications::EventList_T eventList, out notifications::EventIterator_I eventIt) raises(globaldefs::ProcessingFailureException); Description This interface enables an NMS to request all of the cleared and acknowledged alarms for the specified ME. Alarms that are not reported by the ME to the EMS are not reported by this operation.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.37 getAllCrossConnections 3.8.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.38 getAllSoftwareDownloadJobs Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist. EXCPT_INVALID_INPUT - Raised if managedElementName does not reference a managed element. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.8.39 setMEAdminState The following table lists descriptions of each individual parameter. Name Type Description jobId string The job ID. taskId string The task ID. taskType string The kind of task. taskOwner string The task owner. neId string The managed element name. taskStatus string The status of the task.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I Parameters Name Type Input/Output Description meName NamingAttributes_T In Name of the managed element to resynchronize. It must contain a name/value pair, where the name is ManagedElement and the value is ME Name. adminState AdminState_T In Admin state to which the managed element name changes.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.3 getAllManagedElement 3.9.3 getAllManagedElement Synopsis void getAllManagedElementNames( in globaldefs::NamingAttributes_T subnetName, in unsigned long how_many, out globaldefs::NamingAttributesList_T nameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface enables an NMS to request a list of managed elements that are associated with the specified subnetwork.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.5 getAllSubnetworkConnections Description This interface has the same behavior as the operation described in 3.9.3 getAllManagedElement, page 3-126, but instead of returning entire object structures, this operation returns their names. Parameters Name Type Input/Output Description subnetName globaldefs::NamingAttributes_T In Name of the subnetwork. how_many unsigned long In Maximum number of MEs to report in the first batch.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.6 getAllSubnetworkConnectionsWithTP This interface does not report SNCs with duplicate names or VCAT SNCs. If the CTM subnetwork contains multiple circuits with the same name, the getAllSubnetworkConnections call returns the circuit name and details for only one of the circuits. It is not possible to predict which one of the multiple circuits will have its name and details returned.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.6 getAllSubnetworkConnectionsWithTP Description This interface enables an NMS to request a list of the SNCs using the specified TP at the specified connection rates. A TP might be a PTP that requires a full list of SNCs using any of its contained CTPs. A TP might be a CTP or FTP that only requires the SNCs using that CTP or FTP. Both end CTPs and intermediate CTPs at the same layer are considered.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.7 getAllSubnetworkConnectionNames 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.9 getAllTopologicalLinks in unsigned long how_many, out globaldefs::NamingAttributesList_T nameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface has the same behavior as the operation described in 3.9.6 getAllSubnetworkConnectionsWithTP, page 3-128, but instead of returning entire object structures, this operation returns their names.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.10 getAllTopologicalLinkNames Description This interface returns a list of topological links that exist within the subnetwork whose name is passed as a parameter. Parameters Name Type Input/Output Description subnetName globaldefs::NamingAttributes_T In Name of the subnetwork. how_many unsigned long In Maximum number of topological links to return in the first batch.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.11 getMultiLayerSubnetwork Parameters Name Type Input/Output Description subnetName globaldefs::NamingAttributes_T In Name of the subnetwork. how_many unsigned long In Maximum number of topological links to return in the first batch. nameList globaldefs::NamingAttributesList_T Out First batch of topological link names. nameIt globaldefs::NamingAttributesIterator_I Out Iterator to retrieve the remaining topological link names.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.12 getCTPsAndTopologicalLinks EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object. EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references a multiLayerSubnetwork object that does not exist. Compliance TMF-defined. 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.13 getSNC Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object. EXCPT_UNABLE_TO_COMPLY – Raised when invoked on SNC on Ethernet equipment or STS-1 SNC on DS1 equipment. EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.14 getSNCsByUserLabel Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when sncName does not reference an SNC object or when sncName is not unique. EXCPT_UNABLE_TO_COMPLY – Raised when invoked on SNC on Ethernet equipment or STS-1 SNC on DS1 equipment. EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.15 getTopologicalLink Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when sncName does not reference an SNC object or when sncName is not unique. EXCPT_UNABLE_TO_COMPLY – Raised when invoked on SNC on Ethernet equipment or STS-1 SNC on DS1 equipment. EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.16 createAndActivateSNCFromUserLabel 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.16 createAndActivateSNCFromUserLabel if any one of the specified MEs or PTPs does not exist. If the NMS specifies a PTP list, CTM verifies whether PTPs are specified in pairs and each PTP of a PTP pair is associated with each end PTP of the same topological link. CTM uses the first PTP of a PTP pair as the aEnd of the topological link, and uses the second PTP of the same PTP pair as the zEnd of the topological link.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.16 createAndActivateSNCFromUserLabel Name Type Input/Output tpsToModify subnetworkConnection::TPDat In/out aList_T CTM ignores this parameter. theSNC subnetworkConnection::Subne Out tworkConnection_T Resulting SNC, with the sncState and name set. The name is set to the user label supplied in the createData structure. errorReason String Specifies the creation and/or activation error(s), if any. Out Description CTM does not support locking.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.16 createAndActivateSNCFromUserLabel For protected OCHNC and OCHCC circuits, this parameter defines only the inclusion routing constraints for the working path of the circuit. To define the constraints for the protected path, CTM provides the additional info parameters “includedProtectedME” and “excludedProtectedME.” • boolean fullRoute Not supported. • ResourceList_T neTpSncExclusions Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.16 createAndActivateSNCFromUserLabel Table 3-4 CTM-Supported Parameters for SNC Creation (continued) Name Value Description sncDescription String Description of the SNC. This value is represented in the userLabel field of the SubnetworkConnection_T structure. VLAN VLAN ID NMS must provide one or more VLAN names. The value indicates the VLAN for CTM to use for SNC creation on Ethernet equipment.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.16 createAndActivateSNCFromUserLabel Table 3-4 CTM-Supported Parameters for SNC Creation (continued) Name Value Description vapDestination String You can specify the string (ME name) representing the VAP destination drop point. usePortlessTransmux True or false If the value is true, the portless transmux card is used for the circuit.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.17 CreateAndActivateSNC Table 3-4 CTM-Supported Parameters for SNC Creation (continued) Name Value Description excludedProtectedME String Must match the name of any ManagedElement which you have requested to be excluded from the protected path of an OCHNC or OCHCC circuit. See the parameter includedProtectedME for the scenario. overlayRing String Values can be: • true—Indicates that an Overlay Ring SNC is allowed.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.18 (Deprecated) createAndActivateProtectedOchccFromUserLabel Description This interface is identical to 3.9.16 createAndActivateSNCFromUserLabel, page 3-138, except that CTM assigns the name of the created subnetwork connection. The userLabel field in SNCCreateData_T can remain blank. Even if the user label is specified, CTM ignores it and assigns a user label to the SNC. Compliance TMF-defined. 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.19 addDrops 3.9.19 addDrops Synopsis void addDrops( in globaldefs::NamingAttributes_T sncName, in globaldefs::NamingAttributesList_T zEnd) raises(globaldefs::ProcessingFailureException); Description This proprietary interface supports SNCs with multiple drops for the ONS 15310, ONS 15327, and ONS 15454. There are two steps to create an SNC with multiple drops: Step 1 Invoke the operation described in 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.20 deactivateAndDeleteSNC Compliance CTM-defined. 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.21 getVCATSNC Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field in tpsToModify is invalid. EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.21 getVCATSNC Not supported. • VCATState_T vcatState Supported. The state of the VCAT circuit is derived from the states of the member circuits in the same way as it is derived for CCAT SNCs. The values supported are: – VCATState_T.VCATS_NONEXISTENT – VCATState_T.VCATS_PENDING – VCATState_T.VCATS_ACTIVE – VCATState_T.VCATS_PARTIAL – VCATState_T.VCATS_DELETING • globaldefs::ConnectionDirection_T direction Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.22 getAllVCATSNCs – LCASMode_T. LCASMODE _NONE – LCASMode_T. LCASMODE _SWLCAS – LCASMode_T. LCASMODE _LCAS • subnetworkConnection::RoutingMode_T routingMode Supported. CTM supports the following values: – RoutingMode_T. ROUTE_COMMONFIBER – RoutingMode_T. ROUTE_INDEPENDENTFIBER • globaldefs::NVSList_T additionalInfo Supported. CustomerID and ServiceID are reported if they are available.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.23 getAllVCATSNCNames Name Type Input/Output vcatList subnetworkConnection::VCATLi Out st_T First batch of VCAT SNCs. vcatIt subnetworkConnection::VCATIt erator_I Iterator to retrieve the remaining VCAT SNCs. Out Description For details about the VCAT_T structure, see 3.9.21 getVCATSNC, page 3-150. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.24 getAllVCATMemberSNCs Name Type Input/Output Description nameList globaldefs::NamingAttributesLis Out t_T First batch of VCAT SNC names. nameIt globaldefs::NamingAttributesIter Out ator_T Iterator to retrieve the remaining VCAT SNC names. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.25 getAllVCATMemberSNCNames Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when vcatName does not reference a VCAT object. EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist. EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128. Compliance CTM-defined. 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.26 createVCAT EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128. Compliance CTM-defined. 3.9.26 createVCAT Synopsis void MultiLayerSubnetworkMgr_I::createVCAT( in subnetworkConnection::VCATSNCCreateData_T createData, out subnetworkConnection::VCAT_T vcat, out string errorReason) raises(globaldefs::ProcessingFailureException); Description This interface attempts to create a VCAT SNC.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.26 createVCAT – LCASMode_T.MODE_NONE – LCASMode_T.MODE_SWLCAS – LCASMode_T.MODE_LCAS • subnetworkConnection::RoutingMode_T routingMode Supported. CTM supports the following values: – RoutingMode_T.COMMONFIBER_ROUTED – RoutingMode_T.INDEPENDENTFIBER_ROUTED • subnetworkConnection::TPData_T aEnd Supported. CTM expects this field to be an FTP representing the information up to port level of the card involved in VCAT SNC.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.27 deleteVCAT EXCPT_UNABLE_TO_COMPLY – Raised if the VCAT SNC cannot be created and activated because FTP conflicts with another VCAT SNC or NE does not support this VCAT SNC creation. This exception is also raised when CTM cannot meet protection levels or there is no bandwidth available. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents creation of the VCAT SNC.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.29 deleteMemberSNCsFromVCAT Description This interface adds a member SNC to the VCAT that is specified in the input. CTM generates an attribute value change event for the VCAT SNC that was modified due to the addition of the new SNC(s), and an object creation event for the member L1 SNCs that were created. For each new member, you must specify an additional creation parameter called “vcatMemberId,” which is a unique number from 1 to 256.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.30 deleteAllMemberSNCFromVCAT Name Type Input/Output Description sncName globaldefs::NamingAttributesList_T In Name of the SNC(s) to delete and remove from the VCAT. vcat subnetworkConnection::VCAT_T Out Modified VCAT SNC. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when vcatName or sncName does not reference a VCAT/SNC object.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.31 getValidSubnetworkConnectionsForMerge EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when deletion of member SNC(s) from the VCAT fails. Compliance CTM-defined. 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.32 upgrade Name Type Input/Output Description how_many unsigned long In This parameter specifies the number of SNCs to pass and the SNCs that are valid for the merge operation with the master SNC. mergeableSncList subnetworkConnection::Subnetw Out orkConnectionList_T This parameter gives the list of SNCs that qualify for a merge.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.33 createRoll There is no restriction in CTM GateWay/CORBA to prevent a LOOSE MERGE operation from the OSS during a normal call. Parameters Name Type Input/Output Description details multiLayerSubnetwork::Snc UpgradeInfo_T in Upgrade info for which the list of SNCs are requested.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.33 createRoll Parameters Name Type Input/Output Description rollCreateData multiLayerSubnetwork::RollCreateData_T In Structure describing the roll to create. For details about the Roll_T structure, see 3.8.28 getAllRolls, page 3-111. CTM support for RollCreateData_T is as follows: • multiLayerSubnetwork::RollType_T rollType Supported. • multiLayerSubnetwork::RollMode_T rollMode Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.33 createRoll – UNPROTECTED – FULLY_PROTECTED – HIGHLY_PROTECTED Note • CTM does not support other values. subnetworkConnection::ProtectionEffort_T protectionEffort If the NMS requests unprotected SNC on a BLSR ring, CTM creates the SNC. The same is true for unprotected SNC on 1+1 protection. If the NMS requests EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, CTM expects a value of staticProtectionLevel of UNPROTECTED.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.34 deleteRoll Example 2: Roll Source or Destination of an SNC—Part 2 B Src Des Ne wSr B&R Figure 3-3 Src Example 3: Roll Intermediate Managed Elements or Topological Links A Span X B C D Span Y Des B&R 141673 B&R 141672 Figure 3-2 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.35 cancelRoll EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deletion of the roll. Compliance CTM-defined. 3.9.35 cancelRoll Synopsis void cancelRoll( in globaldefs::NamingAttributes_T rollName) raises(globaldefs::ProcessingFailureException); Description This interface cancels a roll task when the rollValidSignal is not received.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.37 completeRoll Parameters Name Type Input/Output Description rollName globaldefs::NamingAttributes_T In Name of the roll on which to force a valid signal. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object. EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.38 finishRoll 3.9.38 finishRoll Synopsis void completeRoll( in globaldefs::NamingAttributes_T rollName) raises(globaldefs::ProcessingFailureException); Description This interface is invoked to finish rolls. When the roll is finished, it is cleared from the rolls list and the new rolled SNC becomes active. Parameters Name Type Input/Output Description rollName globaldefs::NamingAttributes_T In Name of the roll to finish.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.40 getAllRollNames Name Type Input/Output Description rollList multiLayerSubnetwork::RollList_T Out First batch of rolls. rollIt multiLayerSubnetwork::RollIterator_I Out Iterator to retrieve remaining rolls. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when subnetwork name does not refer to a subnetwork object.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.41 getAssociatedRollNamesForSNC 3.9.41 getAssociatedRollNamesForSNC Synopsis void getAssociatedRollNamesForSNC( in globaldefs::NamingAttributes_T sncName, in unsigned long how_many, out globaldefs::NamingAttributesList rollNameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface returns all the rolls associated with the SNC.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.43 createAndActivateSNCOnDRI Parameters Name Type Input/Output Description rollName globaldefs::NamingAttributes_T In Name of roll whose associated SNC will be reported. rollFromSnc globaldefs::NamingAttributes_T Out Name of the rollFrom SNC. rollToSnc globaldefs::NamingAttributes_T Out Name of the rollTo SNC. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.43 createAndActivateSNCOnDRI Name Type Input/Output Description tpsToModify subnetworkConnection::TPDataList_T In/out CTM ignores this parameter. theSNC subnetworkConnection::SubnetworkC onnection_T Out Resulting SNC, with sncState and name set. The name is set to the user label supplied in createData structure. errorReason String Out Specifies the creation and/or activation error(s), if any.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.44 addManagedElement 3.9.44 addManagedElement Synopsis void addManagedElement(in MEAdditionData_T meData) raises(globaldefs::ProcessingFailureException); Description This interface allows the NMS to add a new managed element to the specified subnetwork. • If the operation fails, an exception is returned, and the managed element is not added to the subnetwork. • If the operation succeeds, a managed element is added to the specified subnetwork.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.44 addManagedElement • string productName—Product name of the managed element. • globaldefs::NVSList_T additionalInfo—Parameters that must be specified to the EMS to add the ME; for example, IP address, ME username, password, and any other vendor-specific proprietary data.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.9.45 deleteManagedElement Throws globaldefs::ProcessingFailureException EXCPT_INVALID_INPUT - Raised when containingSubnetworkName does not reference a valid subnetwork name. EXCPT_OBJECT_IN_USE - Raised if the managed element already exists. EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service. Compliance CTM-defined. 3.9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards 3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards CTM supports L2 topology and ML VLAN operations for the ML-series Ethernet cards in ONS 15454 SONET and ONS 15454 SDH NEs. You can create an ML VLAN in an L2 topology. An L2 topology has a collection of ML VLANs and underlying subnetwork connections to support the traffic at the optical layer.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.1 createMLVLAN CTM support for MLVLANCreateData_T structure is as follows: • int mlVlanId Supported. The ML VLAN ID used to create the ML VLAN. If it is –1, CTM assigns the ID for the ML VLAN created. CTM supports ML VLAN IDs from 1 to 4095. • string userLabel Not supported. • boolean forceUniqueness Supported. CTM always enforces the uniqueness of the ML VLAN ID. • string owner Not supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.1 createMLVLAN • multiLayerSubnetwork::L2InterfaceType_T interfaceType Specifies the interface type to be configured. CTM supports the following interface types: – L2InterfaceType_T. L2IT_FASTETHER – L2InterfaceType _T. L2IT_GIGAETHER – L2InterfaceType _T. L2IT_PORTCHANNEL • multiLayerSubnetwork::QOSPolicyData_T qosPolicyData CTM support for QOSPolicyData_T structure is described in QOSPolicyData_T.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.2 modifyMLVLANAddFrontPorts - MLVLAN name does not follow the naming convention. - QOSPolicy is specified incorrectly. EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when the ML VLAN cannot be created due to the restriction that an L2 topology can have a maximum of 4095 ML VLAN IDs. Compliance CTM-defined. 3.10.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.3 modifyMLVLANDropFrontPorts Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object or when one or more PTPs in the PTP list does not reference a PTP object.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.4 modifyMLVLANPortState EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist or when one or more PTPs in the PTP list does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when the ML VLAN cannot be modified. Compliance CTM-defined. 3.10.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.5 modifyMLVLANRSTPState EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist or when one or more PTPs in the PTP list does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when the ML VLAN cannot be modified. Compliance CTM-defined. 3.10.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.6 modifyMLVLANTPQOS EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object or when one or more PTPs in the PTP list does not reference a PTP object. EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist or when one or more PTPs in the PTP list does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.7 modifyMLVLANCustomerIDServiceID Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when one of the following conditions occurs: - The mlVlanName passed does not have the correct format for ML VLAN name. - The tpQosPolicyList contains the incorrect format for TP or QOS policy. - The tpQosPolicyList contains the same TP more than once.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.8 getMLVLAN EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object. EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist. EXCPT_UNABLE_TO_COMPLY - Raised when the ML VLAN cannot be modified. Compliance CTM-defined. 3.10.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.10 getAllMLVLANs Description This interface deletes an existing ML VLAN. CTM generates a processing failure exception if the ML VLAN deletion fails. CTM generates an object deletion event when the ML VLAN is successfully deleted. Parameters Name Type Input/Output Description mlVlanName mlVlan:MLVLAN_T In ML VLAN name to delete.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.11 getAllMLVLANNames For details about the MLVLAN_T structure, see 3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards, page 3-180. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object. EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.12 getAllAssociatedSNCs EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the EMS reaches the maximum number of iterators that it can support. Compliance CTM-defined. 3.10.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.13 getL2Topology Compliance CTM-defined. 3.10.13 getL2Topology Synopsis void getL2Topology( in globaldefs::NamingAttributes_T l2TopologyName, out multiLayerSubnetwork::L2Topology_T l2Topo) raises(globaldefs::ProcessingFailureException); Description This interface returns the L2 topology structure for a given L2 topology name.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.15 getAssociatedL2TopologyForMLVLAN Parameters Name Type Input/Output Description sncName globaldefs::NamingAttributes_T In Name of the SNC to retrieve the associated L2 topology. l2Topo multiLayerSubnetwork::L2Topology_T Out Retrieved L2 topology. For details about the L2Topology_T structure, see 3.3.13 getAllL2Topologies, page 3-35.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology EXCPT_ENTITY_NOT_FOUND - Raised when mlVlanName references an ML VLAN object that does not exist. Compliance CTM-defined. 3.10.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology will specify the M2 equipment name. The second element’s aEnd will specify the M2 equipment name and zEnd will specify the M3 equipment name. The third element’s aEnd will specify the M3 equipment name and zEnd will specify the M1 equipment name. • Mix of CCAT and VCAT SNCs in the RPR. In this case, both VCATSNCCreateDataList_T and SNCCreateDataList_T are populated and all the equipment in the two arrays is in cyclical order.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology Parameters Name Type Input/Output Description L2TopoCreateData_T multiLayerSubnetwork::L2TopoCreateData_T In Data structure defining the L2 topology to create. L2Topo multiLayerSubnetwork::L2Topology_T Out Created L2 topology. CTM support for L2TopologyCreateData_T structure is as follows: • string nativeEMSName Supported. Used as the L2 topology name.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology If the NMS specifies EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, CTM expects the value of staticProtectionLevel to be UNPROTECTED. These values indicate that CTM must create the PCA. – Reroute_T rerouteAllowed Not supported. – NetworkRouted_T networkRouted Not supported. – SNCType_T sncType Not supported. – transmissionParameters::LayerRate_T layerRate Supported. For a list of supported layer rates, see 2.2.1 Layer Rate, page 2-23.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology Name Value Description upsrRevertiveMode Revertive or nonrevertive Supported only for point-to-point L2 topology. If value is set to revertive, traffic reverts back to the working path when the conditions that diverted it to the protect path are repaired. Otherwise it remains on the protect path after the switch. upsrRevertiveTime Valid float value from 0.5 to 12, Supported only for point-to-point L2 topology.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology Name Value Description createVTAggregation True or false Applicable for VC SNCs with one or more transit nodes that do not have a VAP circuit or the existing VAP circuit is exhausted. This parameter specifies whether to create a new VAP circuit on the transit node(s). If the value specified is true, a VAP circuit is created and SNC is routed using this new VAP circuit.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology CTM support for VCATSNCCreateData_T structure for the L2 topology creation is as follows: • string userLabel Not supported. • boolean forceUniqueness CTM guarantees the uniqueness of all VCATs created in CTM. It is not guaranteed if other tools were used for VCAT SNC creation. • string owner Not supported. • globaldefs::ConnectionDirection_T direction Not supported. CTM supports CD_BI (bidirectional).
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.16 createL2Topology Supported. You can choose to specify bandwidth parameters. By default, bandwidth parameters have a zero value. If you choose to enter a specific bandwidth value, you must also specify its corresponding CoS value. The default value for all CoS values is N/A. The sum of all the bandwidth parameters must be from 1 to 99. The CoS commit value must be from 0 to 7.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.17 deleteL2Topology EXCPT_INVALID_INPUT - Raised when the input tpList is invalid or when the specified layer rate is an invalid layer rate. This exception is also raised when the user does not specify the corresponding CoS values for the bandwidth parameters specified. EXCPT_ENTITY_NOT_FOUND - Raised when the input tpList does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.10.18 modifyL2Topology 3.10.18 modifyL2Topology Synopsis void modifyL2Topology( in globaldefs::NamingAttributes_T l2TopologyName, in globaldefs::NVList_T l2ModifyData, out multiLayerSubnetwork::L2Topology_T l2Topo) raises(globaldefs::ProcessingFailureException); Description This interface provides a way to modify an L2 topology. It enables the OSS to modify the L2 topology for the bandwidth allocation parameters.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.11 E-Series VLAN Interfaces Description This interface provides a list of all available ML-series equipment names that can be used in creating an RPR L2 Topology, or a list of all available ML-series TP names that can be used in creating a point-to-point L2 topology. The returned list of ML-series equipment or TP names does not guarantee capability to create an L2 Topology.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.11.1 createVLAN 3.11.1 createVLAN Synopsis void createVLAN in globaldefs::NamingAttributes_T subnetname, in VlanId vlanId, in string name, out Vlan_T vlan) raises(globaldefs::ProcessingFailureException); Description Creates a new VLAN with an ID and name associated with the multilayer subnetwork. The scope of the VLAN is network partition wide. A network partition is a collection of the multilayer subnetwork.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.11.3 getAllVLANs Parameters Name Type Input/Output Description subnetname globaldefs::NamingAttributes_T In Multilayer subnetwork name to which this VLAN is associated. vlanId VlanId In ID of the VLAN to delete. Throws globaldefs::ProcessingFailureException EXCPT_INVALID_INPUT - Raised when a VLAN ID or subnet name is invalid. EXCPT_ENTITY_NOT_FOUND - Raised when a subnet name does not exist in the EMS.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.12 nmsSession::NmsSession_I 3.12 nmsSession::NmsSession_I The nmsSession module enables the EMS to inform the NMS of problems with notifications. When CTM fails to push an event, it notifies all connected NMSs by invoking the eventLossOccurred method on every active NmsSession_I. When the event loss period is over, CTM invokes the eventLossCleared method on NmsSession_I. Both methods are implemented by the NMS.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.12.3 alarmLossOccurred Parameters Name Type Input/Output Description errorReason string Out Error string to indicate to the NMS the reason for the failure. Throws None. Compliance CTM-defined. 3.12.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13 performance::PerformanceManagementMgr_I 3.13 performance::PerformanceManagementMgr_I This interface accesses operations that deal with performance element monitoring. A handle to an instance of this interface is gained through the getManager operation in emsSession. This interface is inherited from 3.2 common::Common_I, page 3-18. interface PerformanceManagementMgr_I:common::Common_I This interface also implements the getCapabilities method.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.2 enablePMData • GranularityList_T granularityList Supported only for enablePMData. 15min and 24h are the only valid values. If the list is empty, both 15min and 24h are considered. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised if pmTPSelectList is empty. EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.3 setTCATPParameter 3.13.3 setTCATPParameter Synopsis void setTCATPParameter(in globaldefs::NamingAttributes_T tpName, inout TCAParameters_T tcaParameters) raises(globaldefs::ProcessingFailureException); Description This interface modifies the values of TCA thresholds on a TP-layer rate measurement point. This interface can be applied to a PTP or CTP.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.3 setTCATPParameter Table 3-5 ONS 15310 CL and ONS 15310 MA SONET TCA TP ParameterName Values (continued) PTP or CTP pmParameterName Location Interval PTP PMP_INTERFACE_NAME PML_NEAR_END_RX 15 min, 24 hr PMP_INTERFACE_DIRECTION PMP_CLASS_OF_SERVICE_LEVEL PMP_POST_POLICY_PACKETS PMP_POST_POLICY_BYTES PMP_DROP_PACKETS PMP_DROP_BYTES LR_T1_and_DS1_1_5M Note VT1.5 data is retrieved using this layer rate. STS data retrieval is not supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.3 setTCATPParameter Table 3-5 PTP or CTP ONS 15310 CL and ONS 15310 MA SONET TCA TP ParameterName Values (continued) pmParameterName Location Interval LR_T3_and_DS3_45M LR_STS1_and_AU3_High_Order_VC3 LR_STS3c_and_AU4_VC4 LR_STS12c_and_VC4_4c LR_STS6c_and_VC4_2c LR_STS9c_and_VC4_3c LR_STS48c_and_VC4_16c (ONS 15310 MA) Cisco Transport Manager Release 9.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.4 getTCATPParameter Compliance TMF-defined. 3.13.4 getTCATPParameter Synopsis void getTCATPParameter( in globaldefs::NamingAttributes_T tpName, in transmissionParameters::LayerRate_T layerRate, in Granularity_T granularity, out TCAParameters_T tcaParameter) raises(globaldefs::ProcessingFailureException); Description The purpose of this operation is to retrieve the values of 15-minute or 24-hour PM thresholds on a TP/layer rate measurement point.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.5 getCTMHistoryPMData 3.13.5 getCTMHistoryPMData Synopsis public void getCTMHistoryPMData( in nmsSession::NmsSession_I client, in PMTPSelectList_T pmTPSelectList, in PMParameterNameList_T pmParameters, in globaldefs::Time_T startTime, in globaldefs::Time_T endTime) raises (globaldefs::ProcessingFailureException); Description This interface instructs the EMS to store historical PM data in a file, and to notify the NMS when the request is complete.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.5 getCTMHistoryPMData • –3—The module in the physical location is unequipped or preprovisioned. The validity status is Invalid. If the layer rate is L3_Optical_Channel (which requires a DWDM CTP), CTM uses the naming convention defined in the TMF for the CTP. The CTP format description differs depending on whether it is related to the DWDM. L3_Optical_Channel is the only layer rate that requires it.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.6 getCTMValidHistoryPMData Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_INVALID_INPUT - Raised when startTime or endTime are not valid, client is null, or pmTPSelectList is empty. EXCPT_UNABLE_TO_COMPY – Raised when more than one request is sent from the same NMS client. Compliance CTM-defined. 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.8 getTPHistoryPMData Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. Compliance CTM-defined. 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.8 getTPHistoryPMData Name Type Input/Output Description how_many unsigned long In Maximum amount of PM data to return in the first batch. pmDataList PMDataList_T Out First batch of PM data. pmIt PMDataIterator Out Iterator used to retrieve the remaining PM data. CTM support for PMData_T structure is as follows: • globaldefs::NamingAttributes_T tpName The name of the termination point.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.9 getHoldingTime Compliance CTM-defined. 3.13.9 getHoldingTime Synopsis void getHoldingTime(out HoldingTime_T holdingTime) raises(globaldefs::ProcessingFailureException); Description The NMS requests from the EMS the number of hours that it stores 15-minute and 24-hour PM data records. This interface reports the minimum time. If the EMS does not store PM data, this method reports the time supported by the NE (the minimum time of all managed NEs).
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.10 getAllCurrentPMData Description This interface enables an NMS to request a filtered set (scoped by the input parameter pmParameters) of the current PM data for a list of TP measurement points. Within the request for each measurement point, granularity (15 min, 24 hr, N/A) and location (nearEnd, farEnd, bidirectional) can be specified. The operation mode is best effort. Current data is generally marked as incomplete, as the current bin is not completed.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.13.11 getMEPMcapabilities 3.13.11 getMEPMcapabilities Synopsis void performance::PerformanceManagementMgr_I::getMEPMcapabilities globaldefs::NamingAttributes_T meName, in transmissionParameters::LayerRate_T layerRate, out PMParameterList_T pmParameterList ) raises (globaldefs::ProcessingFailureException) ( in Description This interface allows the NMS to request from the EMS the set of PM parameters supported by a particular ME at a specific layer.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.1 getAllProtectedTPNames 3.14.1 getAllProtectedTPNames Synopsis void getAllProtectedTPNames( in globaldefs::NamingAttributes_T pgName, in unsigned long how_many, out globaldefs::NamingAttributesList_T nameList, out globaldefs::NamingAttributesIterator_I nameIt) raises(globaldefs::ProcessingFailureException); Description This interface retrieves the list of PTPs that can carry protected traffic. The result is independent of the current switch status.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.2 getAllProtectionGroups Description This interface is used by the client to discover all of the protection groups currently in operation for the ME. Note that CTM does not have any protection groups for path protection. The supported protection group types are PGT_MSP_1_FOR_N, PGT_MSP_1_PLUS_1, PGT_2_FIBER_BLSR, and PGT_4_FIBER_BLSR. The following table lists default names for the protection groups when created through CTC.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.3 getProtectionGroup • ProtectionSchemeState_T protectionSchemeState Not supported. • ReversionMode_T reversionMode Supported. • transmissionParameters::LayerRate_T rate Line rate of the PTPs of the protection group. • globaldefs::NamingAttributesList_T pgpTPList Supported. • globaldefs::NVSList_T pgpParameters CTM only supports wtrTime, the values of wtrTime are in seconds.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.4 performProtectionCommand Parameters Name Type Input/Output Description pgName globaldefs::NamingAttributes_T In Name of the protection group that the client is interested in. protectiongroup ProtectionGroup_T Out Returned protection group. For details about the ProtectionGroup_T structure, see 3.14.2 getAllProtectionGroups, page 3-277.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.4 performProtectionCommand For 4-fiber span switch, it can be Ew -> Ep, Ep ->Ew, Ww -> Wp, and Wp -> Ww. CTM validates whether or not fromTp and toTp are part of same protection group. If this validation fails then it throws ProcessingFailureException with EXCPT_INVALID_INPUT. CTM always performs the command on the fromTp for PC_LOCKOUT and PC_EXERCISE. CTM also verifies if it is possible to perform the command; if not, it throws EXCPT_UNABLE_TO_COMPLY.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.4 performProtectionCommand Name Type Input/Output Description fromTp globaldefs::NamingAttributes_T In Present source of the traffic. toTp globaldefs::NamingAttributes_T In Requested source of the traffic after the command. switchData SwitchData_T Out Protection switch status of the toTp provided after the execution of the command. CTM support for SwitchData _T structure is as follows: • ProtectionType_T protectionType Supported.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.5 createProtectionGroup Compliance TMF-defined. 3.14.5 createProtectionGroup Synopsis void createProtectionGroup( in PGPCreateData_T pgpCreateData, out ProtectionGroup_THolder createdPGP) raises(globaldefs::ProcessingFailureException); Description This interface enables the NMS to permanently create a protection group in an ME. The successful result of this operation is the creation of the protection group object. The resulting object is returned.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.5 createProtectionGroup Type Parameter Name 1+1 1:N 1:1 ReversionMode_T reversionMode Could be revertive or nonrevertive ReversionMode_T. RM_REVERTIVE or ReversionMode_T. RM_NON_REVERTIVE ReversionMode_T. RM_REVERTIVE Could be revertive or nonrevertive ReversionMode_T. RM_REVERTIVE or ReversionMode_T. RM_NON_REVERTIVE Note 1:N is always revertive.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.5 createProtectionGroup Type Parameter Name 2-Fiber BLSR 4-Fiber BLSR NVList_T pgpParameters Name: WTR_TIME (reversion time) Name: WTR_TIME (reversion time) Value: Time in seconds Value: Time in seconds Name: SPRINGNodeId (Node ID) Name: SPRINGNodeId (Node ID) Value: 0–31 Value: 0–31 NVList_T additionalInfo Note • Name: SPAN_REVERSION N/A If there is no additional info, an array of zero length is passed as the input parameter.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.6 deleteProtectionGroup RM_REVERTIVE, RM_NON_REVERTIVE } Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service. EXCPT_INVALID_INPUT - Raised when equipment or TP name does not reference an equipment or TP object. EXCPT_ENTITY_NOT_FOUND - Raised when equipment or TP name references an object that does not exist.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.14.7 getAssociatedProtectionGroup EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost. Compliance CTM-defined. 3.14.7 getAssociatedProtectionGroup Synopsis void getAssociatedProtectionGroup( in globaldefs::NamingAttributes_T ptpName, out protection::ProtectionGroup_T protectionGrp) raises(globaldefs::ProcessingFailureException); Description This interface retrieves the protection group using the specified PTP name.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.15.1 endSession Each Session_I object is responsible for pinging the other Session_I object periodically to detect communication failures. CTM invokes this method on NmsSession_I every five minutes. If this call raises an exception, CTM assumes the session is no longer connected and deletes all resources allocated to it.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.16 mtnmVersion::Version_I 3.16 mtnmVersion::Version_I 3.16.1 getVersion Synopsis string getVersion(); Description This interface returns the version of the IDL that the corresponding EMS object supports. The format of the returned string is as follows: Release.Major[.Minor], where Release, Major, and Minor are digit strings. For example: Note • 2.1 indicates release 2 and major release 1 • 1.3 indicates release 1 and major release 3 x.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.17.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.17.2 getAllTransmissionDescriptorsNames Throws globaldefs::ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service. EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the EMS reaches the maximum number of iterators that it can support. Compliance None. 3.17.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.17.3 getTransmissionDescriptor 3.17.3 getTransmissionDescriptor Synopsis void getTransmissionDescriptor( in globaldefs::NamingAttributes_T tmdName, out TransmissionDescriptor_T tmd) raises (globaldefs::ProcessingFailureException); Description This interface returns the transmission descriptor structure for the given tmdName. The transmission descriptor structure contains an NVSList of traffic parameters.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.17.5 createTransmissionDescriptor This interface is introduced in CTM to comply with MTNM version 3.0. The current implementation returns a globaldefs::ProcessingFailureException stating that this API is not supported. Parameters Name Type Input/Output Description transmissionDescriptorName globaldefs::NamingAttributes_T In Name of the transmission descriptor. how_many unsigned long In Maximum number of TPs to return in the first batch.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.17.6 deleteTransmissionDescriptor Parameters Name Type Input/Output Description newTMDCreateData TMDCreateData_T In Information about the transmission descriptor to create. newTransmissionDescriptor TransmissionDescriptor_T Out Result of the creation. Throws globaldefs::ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support creation of TMDs via this interface.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18 Software and Data Manager Interface EXCPT_OBJECT_IN_USE - Raised if there are TPs that are using the transmission descriptor. EXCPT_INVALID_INPUT - Raised when input parameters are syntactically incorrect. EXCPT_ENTITY_NOT_FOUND - Raised when the transmission descriptor to delete does not exist. Compliance None. 3.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.2 getMEBackupStatus Compliance TMF-defined. 3.18.2 getMEBackupStatus Synopsis void getMEBackupStatus ( in globaldefs::NamingAttributes_T managedElementName, out BackupStatus_T backupStatus) raises(globaldefs::ProcessingFailureException); Description The NMS uses this method to obtain the current backup status of an individual ME.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.3 abortMEBackup EXCPT_INVALID_INPUT - Raised when input parameters are syntactically incorrect. EXCPT_ENTITY_NOT_FOUND - Raised when the ME does not exist. Compliance TMF-defined. 3.18.3 abortMEBackup Synopsis void abortMEBackup ( in globaldefs::NamingAttributes_T managedElementName) raises(globaldefs::ProcessingFailureException) Description This interface aborts a pending backup of ME configuration data.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.5 activateSoftwareOnME Description The NMS invokes this method to determine what configuration data backups exist in the EMS for a specified list of MEs. This interface returns a list of IDs of all configuration data backups for the specified MEs. If the list of MEs in the request is empty, the IDs of all configuration data backups are returned for all MEs. To allow the NMS to handle a large number of objects, this operation uses an iterator.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.6 revertSoftwareOnME Parameters Name Type managedElementName globaldefs::NamingAttributes_T managedElementName Input/Output Description In Name of the ME on which to activate software. Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.7 restoreME 3.18.7 restoreME Synopsis void restoreME( in globaldefs::NamingAttributes_T managedElementName, in string downloadFileName) raises(globaldefs::ProcessingFailureException) Description This asynchronous operation initiates a restore request on the specified ME. The ME configuration file to restore is obtained from the server.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.9 abortMERestore Parameters Name Type Input/Output Description managedElementName NamingAttributes_T In Name of the ME for which a restore status of configuration data is required. restoreStatus RestoreStatus_T Out Status of the configuration data restoration.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.10 getAllSupportedMESoftwareVersions Throws globaldefs::ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure. EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service. EXCPT_INVALID_INPUT - Raised when input parameters are syntactically incorrect. EXCPT_ENTITY_NOT_FOUND - Raised when the ME does not exist. EXCPT_NE_COMM_LOSS - Raised when communication to the ME is lost.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.11 downloadMESoftware • String swVersion—Version of the ME software that the NMS can manage. This string is identical to the version attribute in the ManagedElement_T structure. • globaldefs::NVSList_T additionalInfo—The EMS communicates to the NMS additional information that is not explicitly modeled. To support retrieval in batches, a SupportedMESoftwareVersionIterator_I can be defined.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.12 addSupportedMESoftwareVersion string string string string }; downLoadFileName; remoteServerAddress; ftpUserName; ftpPassword; The following table defines each parameter. Parameters Name Type Input/Output Description startTime globaldefs::Time_T In Start time of the scheduled software download. userComment string In User comments. source FileSource In Image source (FTP, TFTP, server, and so on). (See the following definition.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.12 addSupportedMESoftwareVersion in globaldefs::NamingAttributes_T emsName, in SupportedMESoftwareVersion_T versionData) raises (globaldefs::ProcessingFailureException) Description This interface allows an NMS to add a new software version to the list of supported ME software versions. Parameters Name Type Input/Output Description emsName globaldefs::NamingAttributes_T In Name of the EMS on which to add a new supported ME software version.
Chapter 3 Using CTM GateWay/CORBA Interfaces 3.18.13 getSWDownloadStatus 3.18.13 getSWDownloadStatus Synopsis void getSWDownloadStatus ( in globaldefs::NamingAttributes_T managedElementName, out BackupStatus_T backupStatus) raises(globaldefs::ProcessingFailureException) Description The NMS uses this method to obtain the current software download status of an individual ME.
A P P E N D I X A 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.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.2 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.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4 Supported Events To improve throughput, you should receive the event and forward it to another thread for processing. For example: void push_structured_event(StructuredEvent notification) { try { some_other_thread_queue.addNotification(notification); } catch (Exception ex) { // catch all exception and ignore ex.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.2 Object Deletion Table A-4 Object Creation Notifications (continued) Object Type Type Sent in remainder_of_body for Object Creation Event OT_L2TOPOLOGY MultiLayerSubnetwork::L2Topology_T OT_MLVLAN MultiLayerSubnetwork::MLVLAN_T OT_ROLL MultiLayerSubnetwork::Roll_T OT_VCAT SubnetworkConnection::VCAT_T CTM does not generate object creation events for SubnetworkConnection for the ONS 15540.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.4 State Change Event Attribute value change notifications are sent to the NMS for the objects and attributes in the following table. Table A-8 Attribute Value Change Notifications Object Type Attributes OT_EMS nativeEMSName OT_MANAGED_ELEMENT nativeEMSName—This field reflects the new managed element name if it is changed.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.4 State Change Event Table A-9 State Change Event (continued) Attribute Name Type Supported by CTM? emsTime globaldefs::Time_T Yes. neTime globaldefs::Time_T No. edgePoint boolean No. attributeList notifications::NVList_T Yes. State change event notifications are sent to the NMS for the objects and attributes in the following table.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.5 Protection Switch Table A-10 State Change Event Notifications (continued) Object Type Attributes OT_ROLL rollState—CTM supports the following values: OT_VCAT • ROLL_PENDING • ROLL_COMPLETED • ROLL_CANCELLED • ROLL_INCOMPLETE vcatState—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.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.6 Threshold Crossing Alert Table A-11 Protection Switch (continued) Attribute Name Type Supported by CTM? affectedTP globaldefs::NamingAttributes_T Yes. Note This is not defined by the TMF. String Description Note (No for ONS 15540 and ONS 15530.) This is not defined by the TMF. Yes. The value of this field is the native NE event value. A.4.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.7 Alarm 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.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.4.8 Heartbeat Event Table A-13 Alarm (continued) Attribute Name Type Supported by CTM? isPropagated boolean Yes. For the MGX 8880/8850/8830, values are assigned to this field. For all other NEs, this field is always set to False. aresFDN string Yes. 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.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5 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.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.4 CTM GateWay/CORBA Mapping—ONS 15216 A.5.4 CTM GateWay/CORBA Mapping—ONS 15216 The following table lists the alarms for the ONS 15216 OADM R2.2. Table A-18 CTM GateWay/CORBA Alarms for the ONS 15216 OADM R2.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.4 CTM GateWay/CORBA Mapping—ONS 15216 A.5.4.2 ONS 15216 EDFA3 The following table lists the alarms for the ONS 15216 EDFA3 R1.0. Table A-20 CTM GateWay/CORBA Alarms for the ONS 15216 EDFA3 R1.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.5 CTM GateWay/CORBA Mapping—ONS 15305 and ONS 15305 CTC A.5.5 CTM GateWay/CORBA Mapping—ONS 15305 and ONS 15305 CTC The following table lists the CTM GateWay/CORBA mapping for the ONS 15305 and ONS 15305 CTC.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A A.5.7 CTM GateWay/CORBA Mapping— ONS 15454-M2 and ONS 15454-M6 Notifications, Fault Management, and Probable Cause Mapping A.5.7 CTM GateWay/CORBA Mapping—ONS 15454-M2 and ONS 15454-M6 The following table lists the CTM GateWay/CORBA mapping for the ONS 15454-M2 and ONS 15454-M6.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.9 CTM GateWay/CORBA Mapping—ONS 15540 Table A-24 CTM GateWay/CORBA Mapping for the ONS 15530 (continued) TMF Mapping NE Native Probable Cause TX_FAIL Laser failure detected UNIDENTIFIED Laser wavelength deviation FCGE Card Alarms EQPT Access to card failed EQPT Access to IDPROM failed EQPT Card internal loopback failed EQPT Card internal loopback through PSC failed A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.9 CTM GateWay/CORBA Mapping—ONS 15540 Table A-25 CTM GateWay/CORBA Mapping for the ONS 15540 (continued) TMF Mapping NE Native Probable Cause EQPT Standby with lower capabilities LCMB Alarms EQPT Access to LRC failed EQPT Access to IDPROM failed UNIDENTIFIED Waveport [0...
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.10 Optical Monitoring Alarms—ONS 15530 and ONS 15540 Table A-25 CTM GateWay/CORBA Mapping for the ONS 15540 (continued) TMF Mapping NE Native Probable Cause UNIDENTIFIED Trunk laser wavelength deviation LOF GFP loss of frame delineation UNIDENTIFIED Transport layer failure UNIDENTIFIED Encapsulation mismatch path 10G MB Alarms EQPT Access to LRC failed EQPT Access to IDPROM failed UNIDENTIFIED Waveport [0...
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.
Appendix A Notifications, Fault Management, and Probable Cause Mapping A.5.12 CTM GateWay/CORBA Mapping—ONS 15600 SDH Cisco Transport Manager Release 9.
A P P E N D I X B Server Administration and Configuration This appendix includes the following information on the administration and configuration of CTM GateWay/CORBA: • B.1 Creating an OSS Client Profile for CTM GateWay/CORBA, page B-1 • B.2 Deleting an OSS Client Profile for CTM GateWay/CORBA, page B-2 • B.3 Viewing Currently Logged In CTM GateWay/CORBA OSS Users, page B-2 • B.4 Logging Out CTM GateWay/CORBA OSS Users, page B-3 • B.
Appendix B Server Administration and Configuration B.2 Deleting an OSS Client Profile for CTM GateWay/CORBA • OSS Profile Name—Name of the OSS profile. • Password—Password that the OSS client uses to log into the CTM server. The password must contain at least one special character, at least two alphabetic characters (A-Z, a-z), and at least one numeric character (0-9). Apostrophes (‘) are not accepted. • Confirm Password—Re-enter the password to confirm it.
Appendix B Server Administration and Configuration B.4 Logging Out CTM GateWay/CORBA OSS Users B.4 Logging Out CTM GateWay/CORBA OSS Users Step 1 Log into the CTM client with administrator privileges. Step 2 In the Domain Explorer window, choose Administration > GW/CORBA Users. Step 3 The GW/CORBA Users table displays a list of available OSS users. Click the Show Logged in GW CORBA Users tool.
Appendix B Server Administration and Configuration B.6 Using Multiple Naming Servers • To obtain the RSA public key from CTM, use the emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKey API. See 3.5.2 getEmsPublicKey, page 3-53. • To obtain the RSA public key pair from CTM, use the emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKeyPair API. See 3.5.3 getEmsPublicKeyPair, page 3-54.
Appendix B Server Administration and Configuration B.7 Naming Conventions for Published CTM GateWay/CORBA Objects B.7 Naming Conventions for Published CTM GateWay/CORBA Objects CTM GateWay/CORBA publishes two top-level objects: EMSSessionFactory and NotificationChannel. CTM creates these objects and registers them with the CORBA name server. CTM GateWay/CORBA creates naming contexts under the root as shown in Figure B-1. The last context in the tree must have a different name.
Appendix B Server Administration and Configuration B.8 Location of the Naming Service IOR File B.8 Location of the Naming Service IOR File The naming service IOR is located at: /opt/CiscoTransportManagerServer/openfusion/domains/OpenFusion/localhost/NameService/NameSin gleton/NameSingleton.ior B.9 Useful Debugging Utilities for Resolving Naming Service-Related Issues The following are samples of CTM commands (bundled utility programs) for debugging naming service connectivity issues.
Appendix B Server Administration and Configuration B.10 Configuring CTM GateWay/CORBA • Heartbeat for Notification Channel (min): 0 This property is the rate at which the notification service is checked. A zero entry means not to check the notification service. • Enter the maximum number of simultaneous sessions: 4 This property is the number of CTM GateWay/CORBA sessions that can be active at the same time. The range is from 4 to 25 sessions.
Appendix B Server Administration and Configuration B.11 Using the CLI to Start and Stop CTM GateWay/CORBA Tip • You do not need to change this parameter if you plan to use the notification service that is bundled with CTM GateWay/CORBA. Enter the notification service listening port number: 0 This property is used to set the port that the notification service uses to listen for incoming requests. The port number is set in the IOR for the notification service.
Appendix B Server Administration and Configuration B.12 Configuring Secure Socket Layer for CTM GateWay/CORBA B.12 Configuring Secure Socket Layer for CTM GateWay/CORBA To ensure network security, CORBA calls can be made over Secure Socket Layer (SSL). The current JacORB implementation is precompiled with JacORB security libraries. To configure SSL for CTM GateWay/CORBA, you must set up a keystore and configure the properties in the client-side jacorb.properties file.
Appendix B Server Administration and Configuration B.12.2 Generating the Client-Side Certificate B.12.2 Generating the Client-Side Certificate Note the following conventions: Step 1 • ascii_client_ks—Denotes a client-side keystore. • ascii_client_cert—Denotes a client-side certificate. • gwcorba_service_ks—Denotes a server-side keystore. • gwcorba_service_cert—Denotes a server-side certificate.
Appendix B Server Administration and Configuration B.12.
Appendix B Server Administration and Configuration B.13 Installation Program jacorb.security.ssl.client.supported_options=60 jacorb.security.ssl.client.required_options=60 jacorb.ssl.socket_factory=org.jacorb.security.ssl.sun_jsse.SSLSocketFactory jacorb.security.keystore_password= ascii_client_ks_pass jacorb.security.keystore= ascii_client_ks # Read trusted certificates from the keystore jacorb.security.jsse.trustees_from_ks=on B.
A P P E N D I X C OSS Use Cases and Client Development This appendix lists interceptors and use cases to resynchronize the NMS from the EMS. This appendix includes the following sections: • C.1 Use Cases to Resynchronize the NMS from the EMS, page C-1 • C.2 Developing a CTM GateWay/CORBA Client, page C-4 C.1 Use Cases to Resynchronize the NMS from the EMS Table C-1, Table C-2, and Table C-3 list use cases to resynchronize the NMS from the EMS.
Appendix C OSS Use Cases and Client Development C.1 Use Cases to Resynchronize the NMS from the EMS Table C-1 Use Cases to Resynchronize the NMS from the EMS (continued) Information Detail Description The NMS does the following to request information from the CTM GateWay/CORBA interface: 1. Uses the emsMgr::EMSMgr_I:: getAllEMSSystemActiveAlarms interface to request all EMS alarms. 2. Uses the emsMgr::EMSMgr_I:: getAllTopLevelSubnetworks interface to request all multilayer subnetworks in CTM.
Appendix C OSS Use Cases and Client Development C.1 Use Cases to Resynchronize the NMS from the EMS Table C-2 NMS Resynchronizes Information Specific to a Managed Element (continued) Information Detail Description The NMS does the following to request information from the CTM GateWay/CORBA interface: 1. Uses the managedElementManager::ManagedElementManager_I:: getAllActiveAlarms interface to request all current alarms on the ME. 2.
Appendix C OSS Use Cases and Client Development C.2 Developing a CTM GateWay/CORBA Client Table C-3 NMS Resynchronizes Information Specific to a Termination Point (continued) Information Detail Description The NMS does the following to request information from the CTM GateWay/CORBA interface: 1. Uses the maintenanceOps::MaintenanceMgr_I:: getActiveMaintenanceOperations interface to request all loopback information on the TP.
Appendix C OSS Use Cases and Client Development C.2.2 Sample Code in Java C.2.2 Sample Code in Java A typical CORBA client application involves the following steps: Step 1 Initialize the client connection to the object request broker (ORB). Step 2 Obtain a reference to the naming service. Step 3 Resolve the reference to EMSSessionFactory. See C.2.2.3 Get Reference to EMSSessionFactory, page C-7. Step 4 Implement NmsSession_IOperations. See C.2.2.4 Implement NmsSession_IOperations, page C-7.
Appendix C OSS Use Cases and Client Development C.2.2 Sample Code in Java import import import import import import import import import import import import org.omg.CosEventChannelAdmin.TypeError; org.omg.CosNotifyChannelAdmin.AdminLimitExceeded; org.omg.CosNotifyChannelAdmin.AdminNotFound; org.omg.CosNotifyChannelAdmin.ClientType; org.omg.CosNotifyChannelAdmin.ConsumerAdmin; org.omg.CosNotifyChannelAdmin.EventChannel; org.omg.CosNotifyChannelAdmin.EventChannelHolder; org.omg.CosNotifyChannelAdmin.
Appendix C OSS Use Cases and Client Development C.2.2 Sample Code in Java poa.the_POAManager().activate(); } catch (SystemException ex) { // Exception handling } } C.2.2.2 Get Reference to the Naming Service // Get Nameservice reference NamingContext nsRootContext = null; try { // Step 2: Get reference to the name service // Option 1: Resolve initial reference (RIR) // org.omg.CORBA.Object obj = global_orb.
Appendix C OSS Use Cases and Client Development C.2.
Appendix C OSS Use Cases and Client Development C.2.2 Sample Code in Java EmsSession_IHolder emsSessionHldr = new EmsSession_IHolder(); NmsSession_IPOATie tieobj = new NmsSession_IPOATie(mySessionImpl, poa); poa.activate_object(tieobj); NmsSession_I nmsSession_ref = tieobj._this(); if (ems_ref != null) { ems_ref.getEmsSession(user, password, nmsSession_ref, emsSessionHldr); m_emsSession = emsSessionHldr.value; } } catch (Exception ex) { // System.out.println("Could not narrow"); ex.
Appendix C OSS Use Cases and Client Development C.2.2 Sample Code in Java try { ConsumerAdmin cadmin = notifChannel.get_consumeradmin(0); } catch (AdminNotFound anfSe) { // Exception handling } C.2.2.10 Obtain ProxyPushSupplier IntHolder id = new IntHolder(); try { ProxySupplier baseSupplier = cadmin.obtain_notification_push_supplier( ClientType.STRUCTURED_EVENT, id); structuredProxyPushSupplier = StructuredProxyPushSupplierHelper.
Appendix C OSS Use Cases and Client Development C.2.3 Running the Client C.2.2.12 Connect StructuredPushConsumerImpl try { StructuredPushConsumerImpl structProxyPushConsumer = new StructuredPushConsumerImpl(); StructuredPushConsumerPOATie structuredPushConsumerTieObj = new StructuredPushConsumerPOATie (structProxyPushConsumer, poa); poa.activate_object(structuredPushConsumerTieObj); StructuredPushConsumer pushCon = structuredPushConsumerTieObj._this(); structuredProxyPushSupplier.
Appendix C OSS Use Cases and Client Development C.2.4 Known Interoperability Issues When Using Orbix C.2.4 Known Interoperability Issues When Using Orbix If you use Orbix to set the following property in the jacorb.properties file: Jacorb.compactTypecodes=0 Pay attention to the compatibility of the domain you use with Orbix. If you use an insecure domain, set the following property in the jacorb.properties file: Jacorb.security.support_ssl = off Cisco Transport Manager Release 9.
A P P E N D I X D Equipment List for NEs This appendix lists the equipment that CTM GateWay/CORBA reports for each NE type. This appendix contains the following sections: • D.1 Equipment List for MDS 9000, page D-1 • D.2 Equipment List for MGX 8830/8850/8880, page D-2 • D.3 Equipment List for ONS 15216, page D-2 • D.4 Equipment List for ONS 15305, page D-4 • D.5 Equipment List for ONS 15305 CTC, page D-4 • D.6 Equipment List for ONS 15310 CL, page D-5 • D.
Appendix D Equipment List for NEs D.2 Equipment List for MGX 8830/8850/8880 D.2 Equipment List for MGX 8830/8850/8880 The following table lists the MGX 8830, 8850, and 8880 equipment that CTM R9.2 supports.
Appendix D Equipment List for NEs D.3 Equipment List for ONS 15216 The following table lists the ONS 15216 equipment that CTM R9.2 supports.
Appendix D Equipment List for NEs D.4 Equipment List for ONS 15305 D.4 Equipment List for ONS 15305 The following table lists the ONS 15305 equipment that CTM R9.2 supports. Table D-3 Card Type E GE S CTM-Supported ONS 15305 Equipment Equipment • E100-8 • E3T3-6 • E1-8 • E1-21 • E1-63 • GE-1-LC • GE-2-LC • S1.1-8-LC • S4.1-2-LC • S4.1-4-LC • S16.1-1-LC • S1.1-2-LC D.5 Equipment List for ONS 15305 CTC The following table lists the ONS 15305 CTC equipment that CTM R9.2 supports.
Appendix D Equipment List for NEs D.6 Equipment List for ONS 15310 CL D.6 Equipment List for ONS 15310 CL The equipment name is reported by the actual managed element. The following table lists the supported equipment names. For the most current list, refer to the Cisco ONS 15310 CL user documentation for actual equipment names used by the NE. Table D-5 Card Type ML CTM-Supported ONS 15310 CL Equipment Equipment • ML2_L2L3 • ML2_MAPPER PPM PPM_1_PORT XC CTX D.
Appendix D Equipment List for NEs D.9 Equipment List for ONS 15327 Table D-7 Card Type Fillers PPM CTM-Supported ONS 15310 MA SONET Equipment (continued) Equipment • CTX-FILLER • EXP-FILLER PPM_1_PORT D.9 Equipment List for ONS 15327 The equipment name is reported by the actual managed element. The following table lists the supported equipment names. For the most current list, refer to the Cisco ONS 15327 user documentation for actual equipment names used by the NE.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.10 Equipment List for ONS 15454 SDH Table D-9 Card Type MXP MUX/DMX OPT OSC SMR STM TDCU CTM-Supported ONS 15454 SDH Equipment (continued) Equipment • MXP_2.5G_10G • MXP_2.
Appendix D Equipment List for NEs D.11 Equipment List for ONS 15454 SONET Table D-9 Card Type TXP CTM-Supported ONS 15454 SDH Equipment (continued) Equipment • TXP_MR_10G • TXP_MR_2.5G • TXPP_MR_2.5G • TXP_MR_10E • 2.5G_DM 2.5G_DMP • 32WSS • 32WSS_L • 40WSS WXC • 40WXC XC • XC • XCVT • XC10G • XCVXL_10G • XCVXC • XCVXC25G • OTU2_XP • 10GE_XP • GE_XP WSS XP D.11 Equipment List for ONS 15454 SONET The equipment name is reported by the actual managed element.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.11 Equipment List for ONS 15454 SONET Table D-10 Card Type FMEC G ML MR MSC MXP MUX/DMX OC CTM-Supported ONS 15454 SONET Equipment (continued) Equipment • FMEC_SMZ_E1 • FMEC_SMZ_E3 • FMEC_DB • FMEC_SMZ_DS1I G1000_4 • ML100T • ML1000 • ML-MR-10 • ML100X-8 • MRC-12 • MRC25G_4 • FCMR MS-ISC-100T • MXP_2.5G_10G • MXP_2.
Appendix D Equipment List for NEs D.11 Equipment List for ONS 15454 SONET Table D-10 Card Type OPT OSC SMR TDCU TXP WSS WXC XC XP CTM-Supported ONS 15454 SONET Equipment (continued) Equipment • OPT_BST • OPT_PRE • OPT_BST_E • OPT_BST_L • OPT_AML_L • OPT_AMP_17 • OPT_AMP_C • OPT_RAMP_C • OPT_RAMP_CE • OSC_CSM • OSCM • 40-SMR1-C • 40-SMR2-C • TDCU-C • TDCU-F • TXP_MR_10G • TXP_MR_2.5G • TXPP_MR_2.5G • TXP_MR_10E • 2.5G_DM 2.
Appendix D Equipment List for NEs D.12 Equipment List for ONS 15454-M2 D.12 Equipment List for ONS 15454-M2 The ONS 15454-M2 supports all equipment that is supported by the ONS 15454 MSTP system. Note ONS 15454-M2 does not support OSCM, AICs, EOL units, or ancillary units. D.13 Equipment List for ONS 15454-M6 The ONS 15454-M6 supports all equipment that is supported by the ONS 15454 MSTP system. Note ONS 15454-M6 does not support OSCM, AIC, EOL units, or ancillary units. D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.14 Equipment List for ONS 15530 Table D-11 CTM-Supported ONS 15530 Equipment (continued) Equipment Name Equipment Contained In Description cevONS155302p5GCh1112Sp cevContainerONS15530CardSlot ONS 15530 channel 11 or 12, 2.5-Gbps ITU line card MU, with splitter cevONS155302p5GCh1314Sp cevContainerONS15530CardSlot ONS 15530 channel 13 or 14, 2.
Appendix D Equipment List for NEs D.14 Equipment List for ONS 15530 Table D-11 CTM-Supported ONS 15530 Equipment (continued) Equipment Name Equipment Contained In Description cevONS155302p5GCh1920 cevContainerONS15530CardSlot ONS 15530 channel 19 or 20, 2.5-Gbps ITU line card MU, without splitter cevONS155302p5GCh2122 cevContainerONS15530CardSlot ONS 15530 channel 21 or 22, 2.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.
Appendix D Equipment List for NEs D.18 Equipment List for ONS 15600 SONET Table D-14 CTM-Supported ONS 15600 SDH Equipment Card Category Equipment ASAP ASAP_4 Controller TSC PPMs PPM_1_PORT PIM_4_PPM PIM_1_PPM STM cards STM64_4 STM16_16 STM48_4 STM64_4_DWDM STM ports STM16_PORT STM64_PORT STM1_PORT STM4_PORT XC SSXC CXC D.18 Equipment List for ONS 15600 SONET The equipment name is reported by the actual managed element. The following table lists the supported equipment names.
Appendix D Equipment List for NEs D.19 Equipment List for Unmanaged NEs Table D-15 CTM-Supported ONS 15600 SONET Equipment (continued) Card Type Equipment PPMs PIM_4_PPM PPM_1_PORT PIM_1_PPM XC SSXC CXC D.19 Equipment List for Unmanaged NEs Unmanaged NEs do not report any equipment. Cisco Transport Manager Release 9.
I N D EX connecting to CTM A 3-52 connection termination point names accessing retrieving equipment inventory event channel subnetworks 3-55 retrieving, in use 3-50 naming conventions adding retrieving 3-92 in use 3-90 2-30 multilayer subnetworks drops 3-147 L2 topologies MLVLAN 3-180 VCATs disabling reporting of 3-76 enabling reporting of 3-77 3-195 multilayer subnetworks alarms 3-156 protection groups in a managed element rolls retrieving 3-163 description 3-82 VLANs al
Index EMS alarm reports A-13 MGX 8880/8850/8830 ONS 15216 performance monitoring A-13 disconnecting a session A-24 ONS 15305 and ONS 15305 CTC ONS 15454 SONET R4.
Index QoS templates, all 3-38 subnetwork names 3-23 system active alarms G getCTMHistoryPMData 3-20 topological link names completed successfully 3-25 topological links, all top level topological links, single failed 3-23 3-43 deleting 3-46 3-208 3-26 server trail links creating 3-208 H heartbeat event enabling A-11 history PM data, saving to a file alarm reports 3-268 3-77 performance monitoring 3-211 I equipment holders IDL-related, changes provisioning unprovisioning 3-7
Index cancelling rolls managed element names completing rolls requesting information about definition 3-87 managed elements deleting protection groups from naming conventions 3-169 forcing valid signals 3-286 naming conventions information about 2-30 N 3-51 managing naming conventions client-server connection protection 3-287 2-30 connection termination point 3-276 EquipmentHolder 2-22 naming conventions D-1 L2 topology 2-22 naming conventions MDS 9000 MLVLAN 2-30 D-1 MGX 8
Index VCAT ONS 15305 2-37 naming services description naming conventions ONS 15305 and ONS 15305 CTC 1-4 on CTM server on NMS workstation NE-specific details naming conventions 1-7 ONS 15310 CL 1-6 ONS 15310 MA MGX 8880/8850/8830 ONS 15305 and ONS 15305 CTC ONS 15327 2-6 naming conventions 2-2 ONS 15327 ONS 15454 SDH 2-6 ONS 15454 SDH naming conventions 2-9 ONS 15454 SONET ONS 15454 SONET 2-12 2-14 L2 service interfaces ONS 15540 2-16 naming conventions ONS 15600 SONET unma
Index performance monitoring disabling 3-210 enabling 3-211 Q QoS templates retrieving threshold values on TPs or layer rate measurement points 3-267 physical termination point names, requesting all names, retrieving all top levels 3-89 naming conventions physical termination points naming conventions requesting all 2-37 retrieving all top levels 2-30 3-38 retrieving information 3-38 3-41 3-88 retrieving R all supported PTP names by specific equipment 3-71 that can carry protected traffi
Index to use as a subnetwork connection source CTPs and topological links subnetwork connections by user label 3-103 subnetwork connection structure 3-134 EMS information equipment 3-33 subnetwork names equipment holders description 3-73 associated with an MLVLAN topological link names, description 3-193 all 3-193 3-26 using the PTP name 3-99 running CTM GateWay/CORBA clients 3-207 C-11 3-82 managed elements 3-95 S ML-series equipment names (for RPR L2 topology) 3-204 multilayer s
Index termination point parameters termination points 3-100 software and data manager interface 3-295 starting and stopping CTM GateWay/CORBA services using CLI retrieving structure of 3-98 setting parameters for 3-100 threshold crossing alert B-8 state change event A-9 tips A-6 subnetwork connections improving notification throughput CTPs that can be used as a source TMF-defined probable cause 3-103 PTPs A-2 A-12 TMF interfaces used as a source common 3-102 requesting EMS mana
Index multilayer subnetworks 3-162 using encryption between OSS client and CTM Gateway/CORBA B-3 multiple naming servers B-4 V VCAT naming conventions 2-37 VLANs creating 3-206 deleting 3-206 retrieving list of 3-207 Cisco Transport Manager Release 9.
Index Cisco Transport Manager Release 9.