Table Of Contents
Using CTM GateWay/CORBA Interfaces
3.1 Overview of APIs Supported by NE Type
3.2 common::Common_I
3.2.1 common::Common_I:: getCapabilities
3.3 emsMgr::EMSMgr_I
3.3.1 emsMgr::EMSMgr_I:: getAllEMSAndMEActiveAlarms
3.3.2 emsMgr::EMSMgr_I:: getAllEMSSystemActiveAlarms
3.3.3 emsMgr::EMSMgr_I:: getAllTopLevelSubnetworks
3.3.4 emsMgr::EMSMgr_I:: getAllTopLevelSubnetworkNames
3.3.5 emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinks
3.3.6 emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinkNames
3.3.7 emsMgr::EMSMgr_I:: getTopLevelTopologicalLink
3.3.8 emsMgr::EMSMgr_I:: createTopologicalLink
3.3.9 emsMgr::EMSMgr_I:: createTopologicalLinkWithYCableProtection
3.3.10 emsMgr::EMSMgr_I:: deleteTopologicalLink
3.3.11 emsMgr::EMSMgr_I:: modifyTopologicalLink
3.3.12 emsMgr::EMSMgr_I:: getEMS
3.3.13 emsMgr::EMSMgr_I:: getAllL2Topologies
3.3.14 emsMgr::EMSMgr_I:: getAllQoSTemplateNames
3.3.15 emsMgr::EMSMgr_I:: getAllQoSTemplates
3.3.16 emsMgr::EMSMgr_I:: getQoSTemplate
3.3.17 emsMgr::EMSMgr_I:: getAllEMSandMEClearedAlarms
3.3.18 emsMgr::EMSMgr_I:: getAllEMSSystemClearedAlarms
3.3.19 emsMgr::EMSMgr_I:: createServerTrailLink
3.3.20 emsMgr::EMSMgr_I:: deleteServerTrailLink
3.3.21 emsMgr::EMSMgr_I:: addNetworkPartition
3.3.22 emsMgr::EMSMgr_I:: addMultiLayerSubnetwork
3.3.23 emsMgr::EMSMgr_I:: deleteNetworkPartition
3.3.24 emsMgr::EMSMgr_I:: deleteMultiLayerSubnetwork
3.3.25 emsMgr::EMSMgr_I:: getAllSupportedMEModels
3.4 emsSession::EmsSession_I
3.4.1 emsSession::EmsSession_I:: getEventChannel
3.4.2 emsSession::EmsSession_I:: getManager
3.4.3 emsSession::EmsSession_I:: getSupportedManagers
3.5 emsSessionFactory::EmsSessionFactory_I
3.5.1 emsSessionFactory::EmsSessionFactory_I:: getEmsSession
3.5.2 emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKey
3.5.3 emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKeyPair
3.6 equipment::EquipmentInventoryMgr_I
3.6.1 equipment::EquipmentInventoryMgr_I:: getAllEquipment
3.6.2 equipment::EquipmentInventoryMgr_I:: getAllEquipmentNames
3.6.3 equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPs
3.6.4 equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPNames
3.6.5 equipment::EquipmentInventoryMgr_I:: getAllSupportingEquipment
3.6.6 equipment::EquipmentInventoryMgr_I:: getAllSupportingEquipmentNames
3.6.7 equipment::EquipmentInventoryMgr_I:: getContainedEquipment
3.6.8 equipment::EquipmentInventoryMgr_I:: getEquipment
3.6.9 equipment::EquipmentInventoryMgr_I:: provisionEquipment
3.6.10 equipment::EquipmentInventoryMgr_I:: setAlarmReportingOff
3.6.11 equipment::EquipmentInventoryMgr_I:: setAlarmReportingOn
3.6.12 equipment::EquipmentInventoryMgr_I:: unprovisionEquipment
3.6.13 equipment::EquipmentInventoryMgr_I:: configureMLParameters
3.7 maintenanceOps::MaintenanceManager_I
3.7.1 maintenanceOps::MaintenanceMgr_I:: getActiveMaintenanceOperations
3.7.2 maintenanceOps::MaintenanceMgr_I:: performMaintenanceOperation
3.8 managedElementManager::ManagedElementManager_I
3.8.1 managedElementManager::ManagedElementManager_I:: getAllActiveAlarms
3.8.2 managedElementManager::ManagedElementManager_I:: getAllSNCs
3.8.3 managedElementManager::ManagedElementManager_I::
getAllManagedElements
3.8.4 managedElementManager::ManagedElementManager_I::
getAllManagedElementNames
3.8.5 managedElementManager::ManagedElementManager_I:: getAllPTPs
3.8.6 managedElementManager::ManagedElementManager_I::
getAllPTPNames
3.8.7 managedElementManager::ManagedElementManager_I::
getContainedInUseTPs
3.8.8 managedElementManager::ManagedElementManager_I::
getContainedInUseTPNames
3.8.9 managedElementManager::ManagedElementManager_I::
getContainedPotentialTPs
3.8.10 managedElementManager::ManagedElementManager_I::
getContainedPotentialTPNames
3.8.11 managedElementManager::ManagedElementManager_I::
getContainingSubnetworkNames
3.8.12 managedElementManager::ManagedElementManager_I::
getManagedElement
3.8.13 managedElementManager::ManagedElementManager_I:: getTP
3.8.14 managedElementManager::ManagedElementManager_I::
getAssociatedTopologicalLinks
3.8.15 managedElementManager::ManagedElementManager_I:: setTPData
3.8.16 managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSNCProvisioning
3.8.17 managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSNCProvisioning
3.8.18 managedElementManager::ManagedElementManager_I:: getAllSrcCTPsForVCATMemberSNCProvisioning
3.8.19 managedElementManager::ManagedElementManager_I:: getAllDestPTPsForSNCProvisioning
3.8.20 managedElementManager::ManagedElementManager_I:: getAllDestCTPsForSNCProvisioning
3.8.21 managedElementManager::ManagedElementManager_I:: getAllDestCTPsForVCATMemberSNCProvisioning
3.8.22 managedElementManager::ManagedElementManager_I:: getAllSrcFTPsForSNCProvisioning
3.8.23 managedElementManager::ManagedElementManager_I:: getAllDestFTPsForSNCProvisioning
3.8.24 managedElementManager::ManagedElementManager_I:: forceNEResync
3.8.25 managedElementManager::ManagedElementMgr_I:: getAllTopologicalLinksForME
3.8.26 managedElementManager::ManagedElementManager_I:: getAllRolls
3.8.27 managedElementManager::ManagedElementManager_I:: getAllRollNames
3.8.28 managedElementManager::ManagedElementManager_I:: getRoll
3.8.29 managedElementManager::ManagedElementManager_I:: getRollToPTPs
3.8.30 managedElementManager::ManagedElementManager_I:: getRollToCTPs
3.8.31 managedElementManager::ManagedElementManager_I:: getRollFromCTPs
3.8.32 managedElementManager::ManagedElementManager_I:: setPortName
3.8.33 managedElementManager::ManagedElementManager_I:: getPortName
3.8.34 managedElementManager::ManagedElementManager_I:: getAllClearedAlarms
3.8.35 managedElementManager::ManagedElementManager_I:: getAllCrossConnections
3.8.36 managedElementManager:: getAllSoftwareDownloadJobs
3.8.37 managedElementManager::ManagedElementMgr_I:: setMEAdminState
3.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
3.9.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllEdgePoints
3.9.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllEdgePointNames
3.9.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElement
3.9.4 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllManagedElementNames
3.9.5 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnections
3.9.6 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsWithTP
3.9.7 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNames
3.9.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesWithTP
3.9.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllTopologicalLinks
3.9.10 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllTopologicalLinkNames
3.9.11 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getMultiLayerSubnetwork
3.9.12 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getCTPsAndTopologicalLinks
3.9.13 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getSNC
3.9.14 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNCsByUserLabel
3.9.15 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getTopologicalLink
3.9.16 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
createAndActivateSNCFromUserLabel
3.9.17 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNC
3.9.18 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateProtectedOchccFromUserLabel
3.9.19 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addDrops
3.9.20 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deactivateAndDeleteSNC
3.9.21 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getVCATSNC
3.9.22 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATSNCs
3.9.23 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATSNCNames
3.9.24 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATMemberSNCs
3.9.25 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllVCATMemberSNCNames
3.9.26 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createVCAT
3.9.27 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteVCAT
3.9.28 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addMemberSNCsToVCAT
3.9.29 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteMemberSNCsFromVCAT
3.9.30 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteAllMemberSNCFromVCAT
3.9.31 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getValidSubnetworkConnectionsForMerge
3.9.32 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: upgrade
3.9.33 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createRoll
3.9.34 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteRoll
3.9.35 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: cancelRoll
3.9.36 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: forceValidSignal
3.9.37 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: completeRoll
3.9.38 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: finishRoll
3.9.39 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllRolls
3.9.40 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllRollNames
3.9.41 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedRollNamesForSNC
3.9.42 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedSNCNamesForRoll
3.9.43 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCOnDRI
3.9.44 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addManagedElement
3.9.45 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteManagedElement
3.10 nmsSession::NmsSession_I
3.10.1 nmsSession::NmsSession_I:: historyPMDataCompleted
3.10.2 nmsSession::NmsSession_I:: historyPMDataFailed
3.10.3 nmsSession::NmsSession_I:: alarmLossOccurred
3.11 performance::PerformanceManagementMgr_I
3.11.1 performance::PerformanceManagementMgr_I:: disablePMData
3.11.2 performance::PerformanceManagementMgr_I:: enablePMData
3.11.3 performance::PerformanceManagementMgr_I:: setTCATPParameter
3.11.4 performance::PerformanceManagementMgr_I:: getTCATPParameter
3.11.5 performance::PerformanceManagementMgr_I:: getCTMHistoryPMData
3.11.6 performance::PerformanceManagementMgr_I::
deleteHistoryPMDataFile
3.11.7 performance::PerformanceManagementMgr_I:: getTPHistoryPMData
3.11.8 performance::PerformanceManagementMgr_I:: getHoldingTime
3.11.9 performance::PerformanceManagementMgr_I:: getAllCurrentPMData
3.11.10 performance::PerformanceManagementMgr_I:: getMEPMcapabilities
3.12 protection::ProtectionMgr_I
3.12.1 protection::ProtectionMgr_I:: getAllProtectedTPNames
3.12.2 protection::ProtectionMgr_I:: getAllProtectionGroups
3.12.3 protection::ProtectionMgr_I:: getProtectionGroup
3.12.4 protection::ProtectionMgr_I:: performProtectionCommand
3.12.5 protection::ProtectionMgr_I:: createProtectionGroup
3.12.6 protection::ProtectionMgr_I:: deleteProtectionGroup
3.12.7 protection::ProtectionMgr_I:: getAssociatedProtectionGroup
3.13 session::Session_I
3.13.1 session::Session_I:: endSession
3.13.2 session::Session_I:: ping
3.14 mtnmVersion::Version_I
3.14.1 mtnmVersion::Version_I:: getVersion
3.15 L2 Topology and ML VLAN for ML-Series Ethernet Cards
3.15.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createMLVLAN
3.15.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANAddFrontPorts
3.15.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANDropFrontPorts
3.15.4 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANPortState
3.15.5 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANRSTPState
3.15.6 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANTPQOS
3.15.7 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANCustomerIDServiceID
3.15.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getMLVLAN
3.15.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteMLVLAN
3.15.10 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllMLVLANs
3.15.11 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllMLVLANNames
3.15.12 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAssociatedSNCs
3.15.13 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getL2Topology
3.15.14 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForSNC
3.15.15 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForMLVLAN
3.15.16 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createL2Topology
3.15.17 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteL2Topology
3.15.18 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyL2Topology
3.15.19 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAvailableMLEquipmentOrTPNames
3.16 E-Series VLAN Interfaces
3.16.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createVLAN
3.16.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteVLAN
3.16.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVLANs
3.17 Transmission Descriptor Interfaces
3.17.1 transmissionDescriptor::TransmissionDescriptorMgr_I:: getAllTransmissionDescriptors
3.17.2 transmissionDescriptor::TransmissionDescriptorMgr_I:: getAllTransmissionDescriptorsNames
3.17.3 transmissionDescriptor::TransmissionDescriptorMgr_I:: getTransmissionDescriptor
3.17.4 transmissionDescriptor::TransmissionDescriptorMgr_I:: getAssociatedTPs
3.17.5 transmissionDescriptor::TransmissionDescriptorMgr_I:: createTransmissionDescriptor
3.17.6 transmissionDescriptor::TransmissionDescriptorMgr_I:: deleteTransmissionDescriptor
3.18 Software and Data Manager Interface
3.18.1 softwareAndDataManager::SoftwareAndDataMgr_I:: backupME
3.18.2 softwareAndDataManager::SoftwareAndDataMgr_I:: getMEBackupStatus
3.18.3 softwareAndDataManager::SoftwareAndDataMgr_I:: abortMEBackup
3.18.4 softwareAndDataManager::SoftwareAndDataMgr_I:: getBackupList
3.18.5 softwareAndDataManager::SoftwareAndDataMgr_I:: activateSoftwareOnME
3.18.6 softwareAndDataManager::SoftwareAndDataMgr_I:: revertSoftwareOnME
3.18.7 softwareAndDataManager::SoftwareAndDataMgr_I:: restoreME
3.18.8 softwareAndDataManager::SoftwareAndDataMgr_I:: getMERestoreStatus
3.18.9 softwareAndDataManager::SoftwareAndDataMgr_I:: abortMERestore
3.18.10 softwareAndDataManager::SoftwareAndDataMgr_I:: getAllSupportedMESoftwareVersions
3.18.11 softwareAndDataManager::SoftwareAndDataMgr_I:: downloadMESoftware
3.18.12 softwareAndDataManager::SoftwareAndDataMgr_I:: addSupportedMESoftwareVersion
3.18.13 softwareAndDataManager::SoftwareAndDataMgr_I:: getSWDownloadStatus
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:
•
Overview of APIs Supported by NE Type
•common::Common_I
•emsMgr::EMSMgr_I
•emsSession::EmsSession_I
•emsSessionFactory::EmsSessionFactory_I
•equipment::EquipmentInventoryMgr_I
•maintenanceOps::MaintenanceManager_I
•managedElementManager::ManagedElementManager_I
•multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
•nmsSession::NmsSession_I
•performance::PerformanceManagementMgr_I
•protection::ProtectionMgr_I
•session::Session_I
•mtnmVersion::Version_I
•L2 Topology and ML VLAN for ML-Series Ethernet Cards
•E-Series VLAN Interfaces
•Transmission Descriptor Interfaces
•Software and Data Manager Interface
Note The iterator interfaces defined by the TMF are not listed here. CTM implementation of these interfaces does not deviate from the TMF definition.
3.1 Overview of APIs Supported by NE Type
The following table lists each API and the NEs that support it.
Table 3-1 APIs Supported by NE Type
API No.
|
CTM GateWay/CORBA API
|
Supported NEs
|
1
|
common::Common_I:: getCapabilities
|
—
|
2
|
emsMgr::EMSMgr_I:: getAllEMSAndMEActiveAlarms
|
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
3
|
emsMgr::EMSMgr_I:: getAllEMSSystemActiveAlarms
|
—
|
4
|
emsMgr::EMSMgr_I:: getAllTopLevelSubnetworks
|
—
|
5
|
emsMgr::EMSMgr_I:: getAllTopLevelSubnetworkNames
|
—
|
6
|
emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinks
|
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
7
|
emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinkNames
|
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
8
|
emsMgr::EMSMgr_I:: getTopLevelTopologicalLink
|
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
9
|
emsMgr::EMSMgr_I:: createTopologicalLink
|
MDS 9000, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15600 SDH, ONS 15600 SONET, unmanaged NE
|
10
|
emsMgr::EMSMgr_I:: createTopologicalLinkWithYCableProtection
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
|
11
|
emsMgr::EMSMgr_I:: deleteTopologicalLink
|
MDS 9000, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808, unmanaged NE
|
12
|
emsMgr::EMSMgr_I:: modifyTopologicalLink
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
|
13
|
emsMgr::EMSMgr_I:: getEMS
|
—
|
14
|
emsMgr::EMSMgr_I:: getAllL2Topologies
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
15
|
emsMgr::EMSMgr_I:: getAllQoSTemplateNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
16
|
emsMgr::EMSMgr_I:: getAllQoSTemplates
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
17
|
emsMgr::EMSMgr_I:: getQoSTemplate
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
18
|
emsMgr::EMSMgr_I:: getAllEMSandMEClearedAlarms
|
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
19
|
emsMgr::EMSMgr_I:: getAllEMSSystemClearedAlarms
|
All
|
20
|
emsMgr::EMSMgr_I:: createServerTrailLink
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
21
|
emsMgr::EMSMgr_I:: deleteServerTrailLink
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
22
|
emsMgr::EMSMgr_I:: addNetworkPartition
|
—
|
23
|
emsMgr::EMSMgr_I:: addMultiLayerSubnetwork
|
All
|
24
|
emsMgr::EMSMgr_I:: deleteNetworkPartition
|
—
|
25
|
emsMgr::EMSMgr_I:: deleteMultiLayerSubnetwork
|
All
|
26
|
emsMgr::EMSMgr_I:: getAllSupportedMEModels
|
All
|
27
|
emsSession::EmsSession_I:: getEventChannel
|
—
|
28
|
emsSession::EmsSession_I:: getManager
|
All
|
29
|
emsSession::EmsSession_I:: getSupportedManagers
|
All
|
30
|
emsSessionFactory::EmsSessionFactory_I:: getEmsSession
|
—
|
31
|
emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKey
|
—
|
32
|
emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKeyPair
|
—
|
33
|
equipment::EquipmentInventoryMgr_I:: getAllEquipment
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
34
|
equipment::EquipmentInventoryMgr_I:: getAllEquipmentNames
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
35
|
equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPs
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
36
|
equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPNames
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
37
|
equipment::EquipmentInventoryMgr_I:: getAllSupportingEquipment
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
38
|
equipment::EquipmentInventoryMgr_I:: getAllSupportingEquipmentNames
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
39
|
equipment::EquipmentInventoryMgr_I:: getContainedEquipment
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
40
|
equipment::EquipmentInventoryMgr_I:: getEquipment
|
MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
41
|
equipment::EquipmentInventoryMgr_I:: provisionEquipment
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
42
|
equipment::EquipmentInventoryMgr_I:: setAlarmReportingOff
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
43
|
equipment::EquipmentInventoryMgr_I:: setAlarmReportingOn
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
44
|
equipment::EquipmentInventoryMgr_I:: unprovisionEquipment
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
45
|
equipment::EquipmentInventoryMgr_I:: configureMLParameters
|
ONS 15454 SDH, ONS 15454 SONET
|
46
|
maintenanceOps::MaintenanceMgr_I:: getActiveMaintenanceOperations
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
47
|
maintenanceOps::MaintenanceMgr_I:: performMaintenanceOperation
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
48
|
managedElementManager::ManagedElementManager_I:: getAllActiveAlarms
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
49
|
managedElementManager::ManagedElementManager_I:: getAllSNCs
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
50
|
managedElementManager::ManagedElementManager_I:: getAllManagedElements
|
All
|
51
|
managedElementManager::ManagedElementManager_I:: getAllManagedElementNames
|
All
|
52
|
managedElementManager::ManagedElementManager_I:: getAllPTPs
|
MDS 9000, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
53
|
managedElementManager::ManagedElementManager_I:: getAllPTPNames
|
MDS 9000, MGX 8880/8850/8830, ONS 15216, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
54
|
managedElementManager::ManagedElementManager_I:: getContainedInUseTPs
|
ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
55
|
managedElementManager::ManagedElementManager_I:: getContainedInUseTPNames
|
ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
56
|
managedElementManager::ManagedElementManager_I:: getContainedPotentialTPs
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
57
|
managedElementManager::ManagedElementManager_I:: getContainedPotentialTPNames
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
58
|
managedElementManager::ManagedElementManager_I:: getContainingSubnetworkNames
|
All
|
59
|
managedElementManager::ManagedElementManager_I:: getManagedElement
|
All
|
60
|
managedElementManager::ManagedElementManager_I:: getTP
|
ONS 15216, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
61
|
managedElementManager::ManagedElementManager_I:: getAssociatedTopologicalLinks
|
ONS 15216, ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
62
|
managedElementManager::ManagedElementManager_I:: setTPData
|
ONS 15216, ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
63
|
managedElementManager::ManagedElementManager_I:: getAllSrcPTPsForSNCProvisioning
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
64
|
managedElementManager::ManagedElementManager_I:: getAllSrcCTPsForSNCProvisioning
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
65
|
managedElementManager::ManagedElementManager_I:: getAllDestPTPsForSNCProvisioning
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
66
|
managedElementManager::ManagedElementManager_I:: getAllDestCTPsForSNCProvisioning
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
67
|
managedElementManager::ManagedElementManager_I:: getAllSrcFTPsForSNCProvisioning
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET
|
68
|
managedElementManager::ManagedElementManager_I:: getAllDestFTPsForSNCProvisioning
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET
|
69
|
managedElementManager::ManagedElementManager_I:: forceNEResync
|
ONS 15305 CTC, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
70
|
managedElementManager::ManagedElementManager_I:: getAllTopologicalLinksForME
|
ONS 15216, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
71
|
managedElementManager::ManagedElementManager_I:: getAllRolls
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
72
|
managedElementManager::ManagedElementManager_I:: getAllRollNames
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
73
|
managedElementManager::ManagedElementManager_I:: getRoll
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
74
|
managedElementManager::ManagedElementManager_I:: getRollToPTPs
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
75
|
managedElementManager::ManagedElementManager_I:: getRollToCTPs
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
76
|
managedElementManager::ManagedElementManager_I:: getRollFromCTPs
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
77
|
managedElementManager::ManagedElementManager_I:: setPortName
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
78
|
managedElementManager::ManagedElementManager_I:: getPortName
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
79
|
managedElementManager::ManagedElementManager_I:: getAllClearedAlarms
|
ONS 15302, ONS 15305, ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
|
80
|
managedElementManager::ManagedElementManager_I:: getAllCrossConnections
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
81
|
managedElementManager:: getAllSoftwareDownloadJobs
|
—
|
82
|
managedElementManager::ManagedElementMgr_I:: setMEAdminState
|
All, except for ONS 15800, ONS 15801, ONS 15808
|
83
|
managedElementManager::ManagedElementManager_I:: getAllSrcCTPsForVCATMemberSNCProvisioning
|
ONS 15454 SDH, ONS 15454 SONET
|
84
|
managedElementManager::ManagedElementManager_I:: getAllDestCTPsForVCATMemberSNCProvisioning
|
ONS 15454 SDH, ONS 15454 SONET
|
85
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllEdgePoints
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
|
86
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllEdgePointNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET
|
87
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllManagedElement
|
All
|
88
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllManagedElementNames
|
All
|
89
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnections
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
90
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnectionsWithTP
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
91
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnectionNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
92
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnectionNamesWithTP
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
93
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllTopologicalLinks
|
ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
94
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllTopologicalLinkNames
|
ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
95
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getMultiLayerSubnetwork
|
All
|
96
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getCTPsAndTopologicalLinks
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
97
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getSNC
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
98
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getSNCsByUserLabel
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
99
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getTopologicalLink
|
ONS 15216, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SDH, ONS 15600 SONET, ONS 15800, ONS 15801, ONS 15808
|
100
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
101
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNC
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
102
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateProtectedOchccFromUserLabel
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
103
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addDrops
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
104
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deactivateAndDeleteSNC
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
105
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getVCATSNC
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
106
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATSNCs
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
107
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATSNCNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
108
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATMemberSNCs
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
109
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVCATMemberSNCNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
110
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createVCAT
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
111
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteVCAT
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
112
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addMemberSNCsToVCAT
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
113
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteMemberSNCsFromVCAT
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
114
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteAllMemberSNCFromVCAT
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
115
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getValidSubnetworkConnectionsForMerge
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
116
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: upgrade
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
117
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createRoll
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
118
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteRoll
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
119
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: cancelRoll
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
120
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: forceValidSignal
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
121
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: completeRoll
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
122
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: finishRoll
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
123
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllRolls
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
124
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllRollNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
125
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAssociatedRollNamesForSNC
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
126
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAssociatedSNCNamesForRoll
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
127
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCOnDRI
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
128
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: addManagedElement
|
All
|
129
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteManagedElement
|
All
|
130
|
nmsSession::NmsSession_I:: historyPMDataCompleted
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
131
|
nmsSession::NmsSession_I:: historyPMDataFailed
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
132
|
nmsSession::NmsSession_I:: alarmLossOccurred
|
—
|
133
|
performance::PerformanceManagementMgr_I:: disablePMData
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
134
|
performance::PerformanceManagementMgr_I:: enablePMData
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
135
|
performance::PerformanceManagementMgr_I:: setTCATPParameter
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
136
|
performance::PerformanceManagementMgr_I:: getTCATPParameter
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
137
|
performance::PerformanceManagementMgr_I:: getCTMHistoryPMData
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
138
|
performance::PerformanceManagementMgr_I:: deleteHistoryPMDataFile
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
139
|
performance::PerformanceManagementMgr_I:: getTPHistoryPMData
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
140
|
performance::PerformanceManagementMgr_I:: getHoldingTime
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
141
|
performance::PerformanceManagementMgr_I:: getAllCurrentPMData
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET
|
142
|
performance::PerformanceManagementMgr_I:: getMEPMcapabilities
|
ONS 15310 CL, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
143
|
protection::ProtectionMgr_I:: getAllProtectedTPNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
144
|
protection::ProtectionMgr_I:: getAllProtectionGroups
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
145
|
protection::ProtectionMgr_I:: getProtectionGroup
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
146
|
protection::ProtectionMgr_I:: performProtectionCommand
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
147
|
protection::ProtectionMgr_I:: createProtectionGroup
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
148
|
protection::ProtectionMgr_I:: deleteProtectionGroup
|
ONS 15305 CTC, ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
149
|
protection::ProtectionMgr_I:: getAssociatedProtectionGroup
|
ONS 15310 CL, ONS 15310 MA, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SDH, ONS 15600 SONET
|
150
|
session::Session_I:: endSession
|
—
|
151
|
session::Session_I:: ping
|
—
|
152
|
mtnmVersion::Version_I:: getVersion
|
—
|
153
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createMLVLAN
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
154
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANAddFrontPorts
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
155
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANDropFrontPorts
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
156
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANPortState
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
157
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANRSTPState
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
158
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANTPQOS
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
159
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyMLVLANCustomerIDServiceID
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
160
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getMLVLAN
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
161
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteMLVLAN
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
162
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllMLVLANs
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
163
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllMLVLANNames
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
164
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllAssociatedSNCs
|
ONS 15454 SDH, ONS 15454 SONET
|
165
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getL2Topology
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
166
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAssociatedL2TopologyForSNC
|
ONS 15454 SDH, ONS 15454 SONET
|
167
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAssociatedL2TopologyForMLVLAN
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
168
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createL2Topology
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
169
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteL2Topology
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
170
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: modifyL2Topology
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
171
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllAvailableMLEquipmentOrTPNames
|
ONS 15310 CL, ONS 15454 SDH, ONS 15454 SONET
|
172
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createVLAN
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
173
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: deleteVLAN
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
174
|
multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllVLANs
|
ONS 15310 CL, ONS 15310 MA, ONS 15454 SDH, ONS 15454 SONET
|
175
|
softwareAndDataManager::SoftwareAndDataMgr_I:: backupME
|
All
|
176
|
softwareAndDataManager::SoftwareAndDataMgr_I:: getMEBackupStatus
|
All
|
177
|
softwareAndDataManager::SoftwareAndDataMgr_I:: abortMEBackup
|
All
|
178
|
softwareAndDataManager::SoftwareAndDataMgr_I:: getBackupList
|
All
|
179
|
softwareAndDataManager::SoftwareAndDataMgr_I:: activateSoftwareOnME
|
All
|
180
|
softwareAndDataManager::SoftwareAndDataMgr_I:: revertSoftwareOnME
|
All
|
181
|
softwareAndDataManager::SoftwareAndDataMgr_I:: restoreME
|
All
|
182
|
softwareAndDataManager::SoftwareAndDataMgr_I:: getMERestoreStatus
|
All
|
183
|
softwareAndDataManager::SoftwareAndDataMgr_I:: abortMERestore
|
All
|
184
|
softwareAndDataManager::SoftwareAndDataMgr_I:: getAllSupportedMESoftwareVersions
|
All
|
185
|
softwareAndDataManager::SoftwareAndDataMgr_I:: downloadMESoftware
|
All
|
186
|
softwareAndDataManager::SoftwareAndDataMgr_I:: addSupportedMESoftwareVersion
|
All
|
187
|
softwareAndDataManager::SoftwareAndDataMgr_I:: getSWDownloadStatus
|
All
|
3.2 common::Common_I
The Common_I interface is a set of services and utilities that each manager interface inherits. CTM supports only one method from this interface.
3.2.1 common::Common_I:: getCapabilities
Synopsis
void getCapabilities(out CapabilityList_T capabilities)
raises(globaldefs::ProcessingFailureException);
Description
This interface retrieves the capabilities of the manager. All nonspecified capabilities are assumed to be unsupported.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
capabilities
|
CapabilityList_T
|
Out
|
List of capabilities of this manager object. It is a name-value pair, where the name represents the feature or capability and the value represents the support or nonsupport of the specified feature or capability.
|
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. The feature/capability name part is used to identify an IDL operation using the following convention:
module_name::interface_name::operation_name
The currently defined values are:
•Supported—The specified feature/capability is fully or partially supported across the NML-EML interface; an operation may be partially supported if not all values of the parameters are supported.
•Unsupported—The specified feature/capability is not supported across the NML-EML interface.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
TMF-defined.
3.3 emsMgr::EMSMgr_I
The EMSMgr_I interface accesses operations that deal with the EMS itself. A handle to an instance of this interface is gained through the emsSession::EmsSession_I::getManager operation in emsSession. This interface is inherited from common::Common_I.
interface EMSMgr_I:common::Common_I
This interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.3.1 emsMgr::EMSMgr_I:: getAllEMSAndMEActiveAlarms
Synopsis
void getAllEMSAndMEActiveAlarms(
in notifications::ProbableCauseList_T excludeProbCauseList,
in notifications::PerceivedSeverityList_T excludeSeverityList,
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 active alarms that are under the control of the EMS (alarms raised by the NEs and alarms raised by the EMS itself). Some alarms might be filtered out (excluded) by specifying their probable causes or severities.
Due to performance concerns, only one OSS client is allowed to invoke this operation at a time. Otherwise, CTM throws the EXCPT_UNABLE_TO_COMPLY exception.
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.
ONS 15540, ONS 15530, and ONS 15501
TCAs are reported in the eventList returned by this method. The ONS 15540 sends a "clear" for TCAs.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
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.
|
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.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS client.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.
Compliance
TMF-defined.
3.3.2 emsMgr::EMSMgr_I:: getAllEMSSystemActiveAlarms
Synopsis
void getAllEMSSystemActiveAlarms(
in notifications::PerceivedSeverityList_T excludeSeverityList,
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 active alarms for the EMS. Some alarms can be filtered out (excluded) by specifying their severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
excludeSeverityList
|
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.
|
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.3.3 emsMgr::EMSMgr_I:: getAllTopLevelSubnetworks
Synopsis
void getAllTopLevelSubnetworks(
in unsigned long how_many,
out multiLayerSubnetwork::SubnetworkList_T sList,
out multiLayerSubnetwork::SubnetworkIterator_I sIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to request all subnetworks that are under the control of the EMS.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
how_many
|
unsigned long
|
In
|
Maximum number of subnetworks to return in the first batch.
|
sList
|
multiLayerSubnetwork::SubnetworkList_T
|
Out
|
First batch of subnetworks.
|
sIt
|
multiLayerSubnetwork::SubnetworkIterator_I
|
Out
|
Iterator to retrieve the remaining subnetworks.
|
CTM support for MultiLayerSubnetwork_T is as follows:
•globaldefs::NamingAttributes_T name
–Supported. This field contains two tuples. The first tuple identifies the EMS. The second tuple is the same as nativeEMSName. The naming convention is described in 2.2.5.1 Multilayer Subnetwork, page 2-37.
•string userLabel
–Supported.
•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.
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.3.4 emsMgr::EMSMgr_I:: 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 emsMgr::EMSMgr_I:: getAllTopLevelSubnetworks, but instead of returning entire object structures, this interface returns their names.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
how_many
|
unsigned long
|
In
|
Maximum number of subnetworks to return in the first batch.
|
sList
|
globaldefs::NamingAttributesList_T
|
Out
|
First batch of subnetwork names.
|
sIt
|
globaldefs::NamingAttributesIterator_I
|
Out
|
Iterator to retrieve the remaining subnetwork names.
|
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.3.5 emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinks
Synopsis
void getAllTopLevelTopologicalLinks(
in unsigned long how_many,
out topologicalLink::TopologicalLinkList_T topoList,
out topologicalLink::TopologicalLinkIterator_I topoIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to request all of the top-level topological links that are under the control of the EMS. A top-level topological link is a topological link in which the endpoints of the topological link exist in two different multilayer subnetworks.
If a link that is under the control of the EMS is removed from the NE, the provType parameter is reported as INVALID.
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::TopologicalLinkList_T
|
Out
|
First batch of top-level topological links.
|
topoIt
|
topologicalLink::TopologicalLinkIterator_I
|
Out
|
Iterator to retrieve the remaining top-level topological links.
|
CTM support for TopologicalLink_T structure is as follows:
•globaldefs::NamingAttributes_T name
–Supported. This field has two tuples. The first tuple is for the EMS. The second is for the topological link. The value in the second tuple is the same as the nativeEMSName field except for the Y-cable links, which have "::1" and "::2" appended to the nativeEMSName to identify the two legs of the Y-cable link.
•string userLabel
–Not supported.
•string nativeEMSName
–Supported. For more information, see 2.2.5 Naming Conventions, page 2-36.
•string owner
–Not supported.
•globaldefs::ConnectionDirection_T direction. CTM supports CD_BI for bidirectional links and CD_UNI for unidirectional links
•transmissionParameters::LayerRate_T rate. Supported. Possible values are:
–LR_DSR_OC3_STM1 (for physical links)
–LR_DSR_OC12_STM4 (for physical links)
–LR_DSR_OC48_STM16 (for physical links)
–LR_DSR_OC192_STM64 (for physical links)
–LR_Physical_2_5_Giabit_ITU (for WDM physical links)
–LR_Physical_10_Giabit_ITU (for WDM physical links)
–LR_Line_OC3_STS3_and_ MS_STM1 (for SONET/SDH links)
–LR_Line_OC12_STS12_and_ MS_STM4 (for SONET/SDH links)
–LR_Line_OC48_STS48_and_ MS_STM16 (for SONET/SDH links)
–LR_Line_OC192_STS192_and_ MS_STM64 (for SONET/SDH links)
–LR_OCH_2_5_Giabit_ITU (for WDM OCH links)
–LR_OCH_10_Giabit_ITU (for WDM OCH links)
–LR_Optical_Transmission_Section (for OTS links)
–LR_Optical_Multiplex_Section (for OMS links)
–LR_Not_Applicable (for Layer 2 and server trail links)
–LR_SONET_SDH_Composite (for special links automatically created by CTC, and used for SONET/SDH circuit routing through DWDM transponder cards)
•globaldefs::NamingAttributes_T aEndTP
–Supported.
•globaldefs::NamingAttributes_T zEndTP
–Supported.
•globaldefs::NVSList_T additionalInfo
–Supported parameters are listed in the following table.
Managed Element Type
|
Parameter Name
|
Supported Parameter Values
|
All managed elements that support topological links
|
provType
|
AUTODISCOVERED
MANUAL
UNMANAGED
PATCHCORD
|
All managed elements that support topological links
|
linkStatus
|
LINK_VALID
LINK_INVALID
|
All managed elements that support topological links
|
linkProtectionType
|
PROT_ONE_PLUS_ONE
PROT_BLSR_2F
PROT_BLSR_4F
PROT_BLSR_2F_PCA
PROT_BLSR_4F_PCA
PROT_PCA
PROT_TUNNEL
PROT_UNPROTECTED
PROT_UNKNOWN
PROT_NOT_APPLICABLE
PROT_PARTIALLY_PROTECTED
PROT_YCABLE
|
All managed elements that support topological links
|
linkCost
|
Integer, 0 to 1024
|
ONS 15530 and ONS 15540
|
connectionType
|
Inter-NE, Intra-NE.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
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.3.6 emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinkNames
Synopsis
void getAllTopLevelTopologicalLinkNames(
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 emsMgr::EMSMgr_I:: getAllTopLevelTopologicalLinks, but instead of returning entire object structures, this interface returns their names.
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::NamingAttributesList_T
|
Out
|
First batch of top-level topological link names.
|
nameIt
|
globaldefs::NamingAttributesIterator_I
|
Out
|
Iterator to retrieve the remaining top-level topological link names.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
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.3.7 emsMgr::EMSMgr_I:: getTopLevelTopologicalLink
Synopsis
void getTopLevelTopologicalLink(
in globaldefs::NamingAttributes_T topoLinkName,
out topologicalLink::TopologicalLink_T topoLink)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to request the top-level topological link if its name is under the control of the EMS.
If a link that is under the control of the EMS is removed from the NE, the ProvType parameter is reported as INVALID.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
topoLinkName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the topological link.
|
topoLink
|
TopologicalLink::TopologicalLink_T
|
Out
|
Top-level topological link.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a top level topological
link object.
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.8 emsMgr::EMSMgr_I:: createTopologicalLink
Synopsis
void createTopologicalLink(
in topologicalLink::TLCreateData_T createData,
out topologicalLink::TopologicalLink_T topologicalLink)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to create a topological link manually between two MEs. CTM supports topological link creation between MEs belonging to the same multilayer subnetwork. If CTM autodiscovers a topological link between two endpoints on which a manually created link exists, CTM overwrites the manually created topological link information with the autodiscovered topological link information. CTM generates an attribute value change event when a manually created link is overwritten with autodiscovered topological link information. CTM supports topological link creation between two unmanaged NEs, and also between a managed NE and an unmanaged NE. CTM ignores the topological link layer rate if the topological link creation is between two unmanaged NEs.
CTM generates an object creation event notification when a new topological link is created.
Note•TLCreateData_T is a CTM-defined data structure. The TMF proposed this structure and included it in the TMF 3.0 specification.
•CTM creates topological links between two PTPs even if there are no existing physical link connections in the network. To enable traffic through the link, the NMS must ensure physical link connectivity and enable SDCC on the topological link.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
createData
|
topologicalLink::TLCreateData_T
|
In
|
Data structure containing details for creating new topological links.
|
topologicalLink
|
topologicalLink::TopologicalLink_T
|
Out
|
Created topological link information.
|
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. For patchcord links, CTM assigns the link name. The user label that is passed as input is ignored for patchcord links.
•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.
–CTM supports CD_UNI for unidirectional links.
•transmissionParameters::LayerRate_T rate. Supported layer rates are:
–LR_DSR_OC3_STM1 (for physical links)
–LR_DSR_OC12_STM4 (for physical links)
–LR_DSR_OC48_STM16 (for physical links)
–LR_DSR_OC192_STM64 (for physical links)
–LR_Physical_2_5_Gigabit_ITU (for WDM physical links)
–LR_Physical_10_Gigabit_ITU (for WDM physical links)
–LR_Physical_40_Gigabit_ITU (for WDM physical links)
–LR_Line_OC3_STS3_and_MS_STM1 (for SONET/SDH links)
–LR_Line_OC12_STS12_and_MS_STM4 (for SONET/SDH links)
–LR_Line_OC48_STS48_and_MS_STM16 (for SONET/SDH links)
–LR_Line_OC192_STS192_and_MS_STM64 (for SONET/SDH links)
–LR_OCH_2_5_Gigabit_ITU (for WDM OCH links)
–LR_OCH_10_Gigabit_ITU (for WDM OCH links)
–LR_Optical_Transmission_Section (for OTS links)
–LR_Optical_Multiplex_Section (for OMS links)
•globaldefs::NamingAttributes_T aEndTP
–Supported.
•globaldefs::NamingAttributes_T zEndTP
–Supported.
•globaldefs::NVSList_T additionalCreationInfo
–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
|
linkProtectionType
|
PROT_ONE_PLUS_ONE.
|
All managed elements that support topological links
|
linkCost
|
Integer, 1 to 2147483647.
|
All managed elements that support topological links
|
provType
|
MANUAL (default value) and PATCHCORD.
|
•globaldefs::sSrlgGroupList_T srlgGroupListValue
–Supported. This field holds the shared risk link group (SRLG) group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.
EXCPT_INVALID_INPUT - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
CTM-defined. This interface is already proposed in TMF and will be included in TMF Release 3.0.
3.3.9 emsMgr::EMSMgr_I:: createTopologicalLinkWithYCableProtection
Synopsis
void createTopologicalLinkWithYCableProtection(
in topologicalLink::MTLCreateData_T createData,
out topologicalLink::TopologicalLink_T topologicalLink)
raises(globaldefs::ProcessingFailureException);
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. These two topological links have the same nativeEMSName. See 2.2.5.8 Topological Link, page 2-43 for the naming convention for the Y-cable topological link object name. The destination of the Y-cable link must be on a DWDM card on an ONS 15454 SONET/SDH or on an ONS 155xx NE.
CTM generates two object creation event notifications when a new Y-cable topological link is created.
The topological link returned by this method is one leg of the Y-cable.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
createData
|
topologicalLink:MTLCreateData_T
|
In
|
Data structure containing details for creating a new Y-cable topological link.
|
topologicalLink
|
topologicalLink::TopologicalLink_T
|
Out
|
One leg of the created Y-cable topological link information.
|
CTM support for MTLCreateData_T structure is as follows:
•string userLabel
–Supported. The value of this field is assigned to the nativeEMSName of the newly created topological link.
•boolean forceUniqueness
–CTM guarantees the uniqueness of topological link names.
•string owner
–Not supported.
•globaldefs::ConnectionDirection_T direction
–Supports only CD_BI for bidirectional links.
•transmissionParameters::LayerRate_T rate. Supported layer rates are:
–LR_Physical_2_5_Gigabit_ITU
–LR_Physical_10_Gigabit_ITU
–LR_DSR_OC3_STM1
–LR_DSR_OC12_STM4
–LR_DSR_OC48_STM16
–LR_DSR_OC192_STM64
•globaldefs::NamingAttributesList_T aEndTPs
–Supported. It contains only one PTP.
•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, 1 to 2147483647.
|
All managed elements that support topological links
|
provType
|
MANUAL (default value) and PATCHCORD.
|
•globaldefs::sSrlgGroupList_T srlgGroupListValue
–Supported. This field holds the SRLG group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.
EXCPT_INVALID_INPUT - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
CTM-defined.
3.3.10 emsMgr::EMSMgr_I:: deleteTopologicalLink
Synopsis
void deleteTopologicalLink(
in globaldefs::NamingAttributes_T topoLinkName)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to delete a topological link manually between two managed elements. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if an attempt is made to delete an autodiscovered topological link or if the topological link cannot be deleted in the current state. CTM generates an object deletion event notification when a topological link is deleted.
Note•CTM deletes topological links between two PTPs even if there is a physical link connection in the network. The NMS must ensure the disabling of the SDCC, the deletion of all circuits carried through the link, and the removal of the physical link connectivity.
•Patchcord links are deleted twice. The first delete operation forces the link to become invalid but the link information is still present in the CTM database. The second delete operation removes the link information from the CTM database.
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.
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised if an attempt is made to delete an auto-discovered
topological link.
Compliance
CTM-defined. This interface is already proposed in TMF and will be included TMF Release 3.0.
3.3.11 emsMgr::EMSMgr_I:: modifyTopologicalLink
Synopsis
void modifyTopologicalLink(
in topologicalLink::TLCreateData_T newTLCreateData,
out topologicalLink::TopologicalLink_T newTopologicalLink )
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to modify the following parameters of the existing topological links:
•Cost attribute (modifiable only for SONET and SDH links)
•SRLG values (modifiable only for SONET and SDH links)
Note The modifyTopologicalLink method is not supported for links with patchcord provisioning.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
createData
|
topologicalLink::TLCreateData_T
|
In
|
Data structure containing details for creating a new topological link.
|
topologicalLink
|
topologicalLink::TopologicalLink_T
|
Out
|
Created topological link information.
|
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.
•transmissionParameters::LayerRate_T rate. Supported layer rates are:
–LR_DSR_OC3_STM1 (for physical links)
–LR_DSR_OC12_STM4 (for physical links)
–LR_DSR_OC48_STM16 (for physical links)
–LR_DSR_OC192_STM64 (for physical links)
–LR_Physical_2_5_Gigabit_ITU (for WDM physical links)
–LR_Physical_10_Gigabit_ITU (for WDM physical links)
–LR_Line_OC3_STS3_and_ MS_STM1 (for SONET/SDH links)
–LR_Line_OC12_STS12_and_ MS_STM4 (for SONET/SDH links)
–LR_Line_OC48_STS48_and_ MS_STM16 (for SONET/SDH links)
–LR_Line_OC192_STS192_and_ MS_STM64 (for SONET/SDH links)
–LR_OCH_2_5_Giabit_ITU (for WDM OCH links)
–LR_OCH_10_Giabit_ITU (for WDM OCH links)
–LR_Optical_Transmission_Section (for OTS links)
–LR_Optical_Multiplex_Section (for OMS links)
•globaldefs::NamingAttributes_T aEndTP
–Supported.
•globaldefs::NamingAttributes_T zEndTP
–Supported.
•globaldefs::NVSList_T additionalCreationInfo
–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
|
linkProtectionType
|
PROT_ONE_PLUS_ONE.
|
All managed elements that support topological links
|
linkCost
|
int, 1 - 2147483647.
|
•globaldefs::sSrlgGroupList_T srlgGroupListValue
–Supported. This field holds the SRLG group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are supported only for SONET/SDH topological links.
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.12 emsMgr::EMSMgr_I:: getEMS
Synopsis
void getEMS(out EMS_T emsInfo)
raises(globaldefs::ProcessingFailureException);
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.
•string nativeEMSName
–CTM returns the EMS ID that is displayed on the CTM client EMS property sheet.
•string owner
–Not supported.
•string emsVersion
–CTM returns 8.5.
•string type
–CTM returns "Cisco Systems/Cisco Transport Manager."
•globaldefs::NVSList_T additionalInfo
–Not supported.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
TMF-defined.
3.3.13 emsMgr::EMSMgr_I:: 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. CTM supports only Resilient Packet Ring (RPR) and point-to-point L2 topology types.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
l2TopoType
|
MultiLayerSubnetwork::L2TopoType_T
|
In
|
Type of L2 topologies to return.
|
how_many
|
unsigned long
|
In
|
Maximum number of L2 topologies to return in the first batch.
|
l2TopoList
|
multiLayerSubnetwork::L2TopologyList_T
|
Out
|
List of available L2 topologies in this multilayer subnetwork.
|
l2TopoIt
|
multiLayerSubnetwork::L2TopologyIterator_I
|
Out
|
Iterator used to retrieve the remaining L2 topologies.
|
CTM support for L2Topology_T structure is as follows:
•globaldefs::NamingAttributes_T name
–Supported. The field contains two tuples. The first tuple contains a value for EMS. The second tuple contains the L2 topology name.
•string userLabel
–Not supported.
•string nativeEMSName
–Supported. The L2 topology name is reported.
•string owner
–Not supported.
•L2TopoLayerRate_T layerRate
–Supported. This represents the total capacity of the L2 topology. L2TopoLayerRate_T contains the following information:
•LayerRate_T layerRate—Represents the layer rate of the SNCs. For VCAT, represents the layer rate of the member SNCs.
•Unsigned long numberOfVcatMembers—Represents the number of members in each SNC of an L2 topology consisting of all VCAT SNCs. In all other cases, it contains a value less than one and should be ignored.
•Supported layer rates are:
LR_STS1_and_AU3_High_Order_VC3
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.
•multiLayerSubnetwork::L2TopoState topoState
–The L2 topology state. Valid values are L2TopoState.COMPLETE and L2TopoState.INCOMPLETE.
•multiLayerSubnetwork::L2TopoOperState
–The operational state of the L2 topology. Valid values are L2TopoOperState.IS, L2TopoOperState.ISPARTIAL, and L2TopoOperState.OOS.
•multiLayerSubnetwork::L2TopoSyncState topoSyncState
–The current L2 topology synchronization state. Valid values for L2TopoSyncState are:
•L2TopoSyncState. NEEDED
•L2TopoSyncState. INPROGRESS
•L2TopoSyncState. COMPLETE
•L2TopoSyncState. PARTIALLY_COMPLETE
•L2TopoSyncState. FAILED
•L2TopoSyncState. L2SERVICENOTREADY
•globaldefs::NVSList_T additionalInfo
–Supported.
–If the topology type is DOT17_RPR, the bandwidth parameter values return the absolute bandwidth reserved for the class of traffic. The return value is similar to 250 (Class A). The number 250 indicates 250 Mbps bandwidth reserved for Class A-type traffic. Multicast bandwidth parameters are not supported for this type of topology. If no values are defined for class types, the following default values are returned:
•ClassSpMgmt: C
•ClassCommitted: C
•ClassBestEffort: C
•ClassAvvidControl: B
•ClassAvvidVoiceVideo: A
•ClassAReservedBandwidth: 0
•ClassA1Bandwidth: 10
•ClassBCommittedBandwidth: 10
•SpMgmtCoS: 6, 7
•CommittedCoS: 1, 2
•AvvidVoiceVideoCoS: 5
• AvvidControlCoS: 3
•CosCommit: 2
–The bandwidth parameters SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth, SpMgmtCoS, CommittedCoS, AvvidVoiceVideoCoS, AvvidControlCoS, and the CoS value CosCommit are supported. Either all or none of these parameters are passed. Each of the bandwidth parameters (SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, and AvvidControlBandwidth) is from 1 to 96; the sum of all four bandwidth parameters is from 1 to 99. The CoS commit value is from 0 to 7. If none of these parameters is passed, CTM takes the following default values:
•SpMgmtBandwidth: 5
•CommittedBandwidth: 80
•BestEffortBandwidth: 10
•AvvidControlBandwidth: 4
•SpMgmtCoS: 6, 7
•CommittedCoS: 1, 2
•AvvidVoiceVideoCoS: 5
•AvvidControlCoS: 3
•CosCommit: 2
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised when an l2TopoType is invalid.
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
CTM-defined.
3.3.14 emsMgr::EMSMgr_I:: 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.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
how_many
|
unsigned long
|
In
|
Maximum number of qosTempNames to return in the first batch.
|
qosTempNameList
|
globaldefs::NamingAttributesList_T
|
Out
|
First batch of names.
|
qosTempNameIt
|
globaldefs::NamingAttributesIterator_I
|
Out
|
Iterator used to retrieve the remaining names.
|
Throws
globaldefs::ProcessingFailureException
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
CTM-defined.
3.3.15 emsMgr::EMSMgr_I:: getAllQoSTemplates
Synopsis
in unsigned long how_many,
out QoSTemplateList_T qosTempList
out QoSTemplateIterator_I qosTempIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface lists all QoS templates in the EMS. The QoSTemplate has a scope in the EMS.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
how_many
|
unsigned long
|
In
|
Maximum number of qosTempNames to return in the first batch.
|
qosTempList
|
QoSTemplateList_T
|
Out
|
First batch of QoS templates.
|
qosTempIt
|
QoSTemplateIterator_I
|
Out
|
Iterator used to retrieve the remaining QoS templates.
|
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.ADVANCED
•QOSPolicy_T policy—Supported. This field specifies the QoS policy for the template.
•QOSPolicy_T is defined as follows:
–string policy_name—Supported. This field specifies the policy name for the QoS.
–QoSClassList_T qosClass—Supported. This field provides a list of QoS classes for the policy.
Each QoSClass_T has the following members:
•multiLayerSubnetwork::MatchProtocolList_T classification—Supported. Each MatchProtocol_T is defined as:
•Classification_T matchTraffic—Specifies the traffic classification. CTM supports the following classifications:
Classification_T.MATCH_ANY
Classification_T.MATCH_DSCP
Classification_T.MATCH_IP
Classification_T.MATCH_COS
string value—This field is a string value. Multiple values are separated by spaces.
•string class_name—Supported. This field specifies the name of the QoS class.
•QoSPolicer_T policer—Supported. This field specifies the policer to use.
•QoSPolicer_T structure has the following members:
–multiLayerSubnetwork::CIRType_T cir_type—Supported. This field specifies the type of CIR (line rate or rate limited). CTM defines the following values:
–CIRType_T.CIR_RATE
–CIRType_T.CIR_LINE
–long cir—Supported. This field specifies the CIR value in the range of 96 to 800,000 kilobits per second.
–long cir_burst—Supported. This field specifies the CIR burst value in the range of 8000 to 64000 bytes.
–multiLayerSubnetwork::COSMarking_T cir_cos—Supported. Specifies the type of CoS marking for the CIR. CTM supports the following values:
–COSMarking_T.COSMARKING_MARK_COS
–COSMarking_T.COSMARKING_TRUST
–long cir_cos_val—Supported. This field specifies the CIR CoS value.
–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. This field specifies the PIR burst value in the range of 8000 to 64000 bytes. The PIR burst value is equal to or greater than the CIR burst value.
–multiLayerSubnetwork::COSMarking_T pir_cos—Supported. This field specifies the type of CoS marking for PIR. CTM supports the following values:
•COSMarking_T.COSMARKING_MARK_COS
•COSMarking_T.COSMARKING_TRUST
–long pir_cos_value—Supported. This field specifies the PIR COS value.
–multiLayerSubnetwork::ViolateAction_T violate_act—Supported. CTM supports the following values:
–ViolateAction_T.VIOLATE_ACTION_DISCARD
–ViolateAction_T.VIOLATE_ACTION_ALLOW
–long violate_cos_val—Supported. This field specifies the violated COS value.
–multiLayerSubnetwork::BesteffortType_T beff_type—Supported. CTM supports the following values for best effort type:
•BestEffortType_T.BEST_EFFORT_RATE
•BestEffortType_T.BEST_EFFORT_LINE
–long beff_rate—Supported. This field specifies the maximum rate of best effort in the range of 96 to 800,000 kilobits per second.
–long beff_rate_burst—Supported. This field is in the range of 8000 to 64000 bytes.
•multiLayerSubnetwork::MatchOption_T operator—Supported. CTM supports the following Match option:
–MatchOption_T.MATCH_OPTION_OR
–MatchOption_T.MATCH_OPTION_AND
Note CTM always uses MatchOption_T.MATCH_OPTION_AND.
Throws
globaldefs::ProcessingFailureException
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
CTM-defined.
3.3.16 emsMgr::EMSMgr_I:: getQoSTemplate
Synopsis
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.
|
qosTemp
|
QoSTemplate_T
|
Out
|
QoS template with the complete information.
|
For details about the QoSTemplate_T structure, see emsMgr::EMSMgr_I:: getAllQoSTemplateNames.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when the QoSTemplate name is not valid.
EXCPT_ENTITY_NOT_FOUND - Raised when the QoSTemplate name does not exist on the EMS.
Compliance
CTM-defined.
3.3.17 emsMgr::EMSMgr_I:: getAllEMSandMEClearedAlarms
Synopsis
void getAllEMSandMEClearedAlarms(
in notifications::ProbableCauseList_T excludeProbCauseList,
in notifications::PerceivedSeverityList_T excludeSeverityList,
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 that are under the control of the EMS (both alarms raised by the NEs and alarms raised by the EMS itself). Some alarms may be filtered out (excluded) by specifying their probable causes or severities.
Due to performance concerns, this operation is restricted to enable only one OSS client to access it at one time. Otherwise, CTM throws the EXCPT_UNABLE_TO_COMPLY exception.
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 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, ONS 15530, and ONS 15501
TCAs are reported in the eventList that is returned by this method. The ONS 15540 sends a "clear" for TCAs.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
excludeProbCauseList
|
notifications::ProbableCauseList_T
|
In
|
List of probable alarm causes to exclude from the output event list.
|
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.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS Client.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.
Compliance
CTM-defined.
3.3.18 emsMgr::EMSMgr_I:: getAllEMSSystemClearedAlarms
Synopsis
void getAllEMSSystemClearedAlarms(
in notifications::PerceivedSeverityList_T excludeSeverityList,
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 that are for the EMS itself. Some alarms may be filtered out (excluded) by specifying their severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
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.
|
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
CTM-defined.
3.3.19 emsMgr::EMSMgr_I:: createServerTrailLink
Synopsis
void createServerTrailLink(
in serverTrailLink::STLCreateData_T createData
out serverTrailLink::ServerTrailLink_T serverTrailLink)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to create a server trail link manually between two MEs. CTM supports the server trail link creation between MEs belonging to the same multilayer subnetwork. CTM generates an object creation event notification when a new server trail link is created.
Note•STLCreateData_T is a CTM-defined data structure. The TMF proposed this structure and included it in the TMF 3.0 specification.
•CTM creates the server trail link between two CTPs even if there are no existing physical link connections in the network.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
createData
|
serverTrailLink::STLCreateData_T
|
In
|
Data structure containing details for creating a new server trail link.
|
serverTrailLink
|
serverTrailLink::ServerTrailLink_T
|
Out
|
Created server trail link information.
|
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.
•transmissionParameters::LayerRate_T rate
Supported layer rates are:
–LR_STS1_and_AU3_High_Order_VC3
–LR_STS3c_and_AU4_VC4
–LR_STS12c_and_VC4_4c
–LR_STS24c_and_VC4_8c
–LR_STS48c_and_VC4_16c
–LR_STS192c_and_VC4_64c
•globaldefs::NamingAttributes_T aEndCTP
Supported.
•globaldefs::NamingAttributes_T zEndCTP
Supported.
•globaldefs::NVSList_T additionalCreationInfo
Supported. The supported parameters are listed in the following table.
Managed Element Type
|
Parameter Name
|
Supported Parameter Values
|
All managed elements that support ServerTrailLink
|
serverTrailLinkProtectionType
|
PREEMPTIBLE, UNPROTECTED, FULLY_PROTECTED.
|
All managed elements that support ServerTrailLink
|
linkCost
|
Integer, 1 to 2147483647.
|
All managed elements that support ServerTrailLink
|
linkCount
|
Integer, 1 to 1024.
|
•globaldefs::sSrlgGroupList_T srlgGroupListValue
Supported. This field holds the SRLG group values. This is an optional parameter that you can include in the SRLG group during the link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH server trail links.
CTM support for ServerTrailLink_T structure is as follows:
•globaldefs::NamingAttributes_T name
Supported. This field has two tuples. The first tuple is for EMS. The second one is for ServerTrailLink. The value in the second tuple is the same as the nativeEMSName field.
•string userLabel
Not supported.
•boolean forceUniqueness
Not supported
•string owner
Not supported.
•globaldefs::ConnectionDirection_T direction
CTM supports only CD_BI for bidirectional links.
•transmissionParameters::LayerRate_T rate
Supported layer rates are:
–LR_STS1_and_AU3_High_Order_VC3
–LR_STS3c_and_AU4_VC4
–LR_STS12c_and_VC4_4c
–LR_STS24c_and_VC4_8c
–LR_STS48c_and_VC4_16c
–LR_STS192c_and_VC4_64c
•globaldefs::NamingAttributes_T aEndTP
Supported. The CTP for the serverTrailLink aEnd.
•globaldefs::NamingAttributes_T zEndTP
Supported. The CTP for the serverTrailLink zEnd.
•globaldefs::NVSList_T additionalCreationInfo
Supported. The supported parameters are listed in the following table.
Managed Element Type
|
Parameter Name
|
Supported Parameter Values
|
All managed elements that support ServerTrailLink
|
serverTrailLinkProtectionType
|
PREEMPTIBLE, UNPROTECTED, FULLY_PROTECTED.
|
All managed elements that support ServerTrailLink
|
linkCost
|
int, 1 - 2147483647.
|
All managed elements that support ServerTrailLink
|
linkCount
|
int, 1 - 1024.
|
•globaldefs::sSrlgGroupList_T srlgGroupListValue
Supported. This field holds the SRLG group values. This is an optional parameter that you can include in the SRLG group during the link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH server trail links.
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.20 emsMgr::EMSMgr_I:: deleteServerTrailLink
Synopsis
void deleteServerTrailLink(
in globaldefs::NamingAttributes_T serverTrailLinkName)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to delete a server trail link manually between two MEs. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if the server trail link cannot be deleted in the current state. CTM generates an object deletion event notification when a server trail link is deleted.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
serverTrailLinkName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the server trail link to delete.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INVALID_INPUT - Raised if input the server trail link name is invalid.
EXCPT_ENTITY_NOT_FOUND - Raised if the specified server trail link name does not exist in
CTM.
EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete a server trail which cannot
be deleted.
Compliance
CTM-defined.
3.3.21 emsMgr::EMSMgr_I:: 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.
|
Throws
globaldefs::ProcessingFailureException
Compliance
CTM-defined.
3.3.22 emsMgr::EMSMgr_I:: addMultiLayerSubnetwork
Synopsis
void addMultiLayerSubnetwork(in MultiLayerSubnetworkCreateData _T subnetCreateData)
raises(globaldefs::ProcessingFailureException);
Description
This interface allows the NMS to add a new multilayer subnetwork. Upon successful addition, the EMS generates an object creation event for the multilayer subnetwork object.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
subnetCreateData
|
MultiLayerSubnetworkCreateData _T
|
In
|
MultiLayerSubnetwork input data.
|
The structure for MultiLayerSubnetworkCreateData _T is as follows:
struct MultiLayerSubnetworkCreateData_T
globaldefs::NamingAttributes_T subnetworkName;
multiLayerSubnetwork::Topology_T subnetworkType;
globaldefs::NVSList_T additionalInfo ;
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.
|
additionalInfo
|
globaldefs::NVSList_T
|
The NMS uses the additionalInfo attribute to communicate to the EMS any other information required to create the multiLayerSubnetwork.
|
enum Topology_T { TOPO_SINGLETON, TOPO_CHAIN, TOPO_PSR,
TOPO_OPEN_PSR, TOPO_SPRING, TOPO_OPEN_SPRING, TOPO_MESH };
The structure of Additional Info is as follows:
Name
|
Value
|
Description
|
Mandatory or Optional
|
NETWORK PARTITION
|
subnetwork name
|
Name of the network partition where the subnet is added.
|
Mandatory
|
Type
|
subnetwork type
|
Subnet type.
|
Mandatory (see the following values)
|
The parameter name "Type" in additionalInfo can have the following values:
•SONET
•SDH
•OTHER
•UNKNOWNSUBNETTYPE (the default value if a value other than the three preceding values is specified)
Throws
globaldefs::ProcessingFailureException
Compliance
CTM-defined.
3.3.23 emsMgr::EMSMgr_I:: 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.24 emsMgr::EMSMgr_I:: deleteMultiLayerSubnetwork
Synopsis
void deleteMultiLayerSubnetwork(in globaldefs::NamingAttributes_T subnetworkName)
raises(globaldefs::ProcessingFailureException);
Description
This interface allows the NMS to delete an existing subnetwork. Successful operation requires the EMS to generate an object deletion event.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
subnetworkName
|
globaldefs::NamingAttributes_T
|
In
|
Subnet name to delete.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_ENTITY_NOT_FOUND- Raised if the multilayer subnetwork is not found.
EXCPT_UNABLE_TO_COMPLY- Raised if the EMS cannot comply.
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.3.25 emsMgr::EMSMgr_I:: 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. A model's structure has the following form:
•name = "ModelName"
•value = meModel
Parameters
Name
|
Type
|
Input/Output
|
Description
|
supportedMEs
|
NVSList_THolder
|
Out
|
List of all of the supported model names.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
CTM-defined.
3.4 emsSession::EmsSession_I
The emsSession module enables the client to query the EMS to determine the manager interfaces that the EMS supports. The NMS retrieves an instance of the required manager interface objects. This interface is inherited from session::Session_I.
interface EmsSession_I:session::Session_I
3.4.1 emsSession::EmsSession_I:: getEventChannel
Synopsis
out CosNotifyChannelAdmin::EventChannel eventChannel)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to access the event channel to receive notifications. CTM publishes the name of the notification channel through the naming service. You can use the naming service to get the corresponding object reference.
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.2 emsSession::EmsSession_I:: getManager
Synopsis
out common::Common_I managerInterface)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to access the specified manager interface.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
managerName
|
string
|
In
|
Class or type of manager object that the client wants.
|
managerInterface
|
common::Common_I
|
Out
|
The actual object returned implements the specified manager interface. However, it is returned as a Common_I object, so the operation can be generic. The client narrows the returned object to the correct object type.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_NOT_IMPLEMENTED - This exception indicates that the EMS does not support the
manager.
EXCPT_INTERNAL_ERROR - This exception indicates a nonspecific internal EMS failure.
Compliance
TMF-defined.
3.4.3 emsSession::EmsSession_I:: 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.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
supportedManagerList
|
managerNames_T
|
Out
|
List of manager names supported in the form managerName, where managerName is one of the following defined manager strings for CTM:
•EMS
•ManagedElement
•MultiLayerSubnetwork
•EquipmentInventory
•PerformanceManagement
•Maintenance
•Protection
•Software
|
Throws
None.
Compliance
TMF-defined.
3.5 emsSessionFactory::EmsSessionFactory_I
A single instance of the EmsSessionFactory_I is the entry point to the EMS. The NMS uses this object reference to connect to CTM. This interface implements the version interface and returns the server IDL version. It is inherited from mtnmVersion::Version_I.
interface EmsSessionFactory_I:mtnmVersion::Version_I
3.5.1 emsSessionFactory::EmsSessionFactory_I:: getEmsSession
Synopsis
void getEmsSession(in string user,
in nmsSession::NmsSession_I client,
out emsSession::EmsSession_I emsSessionInterface)
raises(globaldefs::ProcessingFailureException);
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.
This interface can also accept the encrypted username and password. To enable encryption on the username and password, check the Enable encryption for username and password check box in the CTM client Control Panel for the CTM GateWay/CORBA service. CTM then decrypts the username and password accordingly.
To encrypt the username and password, you must use the RSA algorithm with the public key or the public key pair provided by CTM. To obtain the CTM public key, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey API. To obtain the CTM public key pair, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair API.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
user
|
string
|
In
|
User or application that is trying to access the server. This user must have a profile created in CTM.
|
password
|
string
|
In
|
Password for the user application.
|
client
|
nmsSession::NmsSession_I
|
In
|
Handle to the NMS NmsSession_I object, to which the returned EmsSession_I object must be associated.
|
emsSessionInterface
|
emsSession::EmsSession_I
|
Out
|
CORBA Interoperable Object Reference (IOR) for the EmsSession_I interface.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of a nonspecific internal EMS failure.
EXCPT_INVALID_INPUT - Raised when the client is invalid or when the length of the username
or password passed is not within the permissible limits (1-53).
EXCPT_ACCESS_DENIED - Raised in the following cases:
When all the eight login sessions are used up.
When the user name specified does not exist.
Or in case of any other security violation.
Compliance
TMF-defined.
3.5.2 emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKey
Synopsis
void getEmsPublicKey(out string publicKey)
raises(globaldefs::ProcessingFailureException);
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. The byte[] corresponding to the public key represents the key in its primary encoded format; in this case, X.509 SubjectPublicKeyInfo.
You can create the RSA public key using this byte array and cryptographic libraries. Use this key to encrypt the username and password. Bouncy Castle Provider is an example of a security provider that you can use to create the RSA public key.
The public key is then used to encrypt the username and password. Before passing the encrypted password to CTM for login, the OSS client must encode the encrypted username and password using the Base64 encoder to get the string equivalent of the encrypted data.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
publicKey
|
string
|
Out
|
Public key string returned by CTM.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
Compliance
CTM-defined.
3.5.3 emsSessionFactory::EmsSessionFactory_I:: getEmsPublicKeyPair
Synopsis
void getEmsPublicKeyPair(out string publicKeyModulus,
out string publicKeyExponent)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables the NMS to obtain the string representation of the RSA public key pair (in the modulus and exponent forms) from CTM for encrypting the username and password.
The OSS client must convert the string representation of the public key modulus and public key exponent into a nonnegative integer and create an RSA public key using cryptographic libraries. Crypto++ is one of the security providers available.
Before passing the encrypted password to CTM for login, the OSS client must use the Base64 encoder to encode the encrypted username and password. This provides the string equivalent of the encrypted data.
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.6 equipment::EquipmentInventoryMgr_I
This interface accesses operations that deal with equipment. A handle to an instance of this interface is gained through the getManager operation in emsSession. This interface is inherited from common::Common_I.
interface EquipmentInventoryMgr_I:common::Common_I
This interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.6.1 equipment::EquipmentInventoryMgr_I:: getAllEquipment
Synopsis
void getAllEquipment(in globaldefs::NamingAttributes_T meOrHolderName,
in unsigned long how_many,
out EquipmentOrHolderList_T eqList,
out EquipmentOrHolderIterator_I eqIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables an NMS to request all of the equipment and equipment holders contained in a managed element or equipment holder.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
meOrHolderName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the ME or equipment holder for which to retrieve contained equipment and equipment holders.
|
how_many
|
unsigned long
|
In
|
Maximum number of EquipmentOrHolder_Ts to return in the first batch.
|
eqList
|
EquipmentOrHolderList_T
|
Out
|
First batch of EquipmentOrHolder_Ts.
|
eqIt
|
EquipmentOrHolderIterator_I
|
Out
|
Iterator used to retrieve the remaining EquipmentOrHolder_Ts.
|
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. The value of the fourth tuple is the same as the value in the nativeEMSName field.
•string userLabel
–Not supported.
•string nativeEMSName
–Supported. The naming convention is described in 2.2.5.7 Equipment Holder, page 2-42.
•string owner
–Not supported.
•boolean alarmReportingIndicator
–Supported for ONS 15327 and ONS 15454 only.
•ServiceState_T serviceState
–Not supported.
•EquipmentObjectType_T expectedEquipmentObjectType
–MGX 8880/8850/8830—All values listed in Table D-1 on page D-2 are supported.
–ONS 15216—All values listed in Table D-2 on page D-3 are supported.
–ONS 15302—All values listed in Table D-4 on page D-4 are supported.
–ONS 15305 and ONS 15305 CTC—All values listed in Table D-5 on page D-4 and Table D-6 on page D-5 are supported.
–ONS 15310 CL—All values listed in Table D-7 on page D-5 are supported.
–ONS 15310 MA—All values listed in Table D-8 on page D-6 are supported.
–ONS 15327—All values listed in Table D-9 on page D-6 are supported.
–ONS 15454 SDH—All values listed in Table D-10 on page D-7 are supported.
–ONS 15454 SONET—All values listed in Table D-11 on page D-9 are supported.
–ONS 15501—All values listed in Table D-12 on page D-12 are supported.
–ONS 15530—All values listed in Table D-13 on page D-12 are supported.
–ONS 15540—All values listed in Table D-14 on page D-25 and Table D-15 on page D-32 are supported.
–ONS 15600 SDH—All values listed in Table D-16 on page D-34 are supported.
–ONS 15600 SONET—All values listed in Table D-17 on page D-34 are supported.
–ONS 15800, ONS 15801—All values listed in Table D-18 on page D-35 are supported.
–ONS 15808—All values listed in Table D-19 on page D-37 are supported.
•EquipmentObjectType_T installedEquipmentObjectType
–Supported. The value reported by the NE is inserted in this field.
•string installedPartNumber
–Supported when equipment is installed.
•string installedVersion
–Supported when equipment is installed.
•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.
•string userLabel
–Not supported.
•string nativeEMSName
–Supported. The naming convention is defined in 2.2.5.7 Equipment Holder, page 2-42.
•string owner
–Not supported.
• boolean alarmReportingIndicator
–Not supported.
• EquipmentHolderType_T holderType
–Supported values are additionalHolder, rack, shelf, and slot.
–For the ONS 15600 and ONS 15600 SDH, valid values are rack, shelf, slot, sub_slot, and ppm_holder.
–For the ONS 15310 CL and ONS 15310 MA, valid values are rack, shelf, slot, subslot, and ppm_holder.
–For the ONS 15540 and ONS 15530, valid values are rack, shelf, slot, sub_slot, and ppm_holder.
–For the ONS 15454 SONET and ONS 15454 SDH, valid values are rack, shelf, slot, ppm_holder, and port.
–For the ONS 15501, valid values are rack and shelf.
–For all equipment supporting SFP modules, valid values are rack, shelf, slot, sub_slot, and port_holder.
–For the MGX 8880/8850/8830, valid values are rack, shelf, slot, sub_slot, and peripheral_holder.
• globaldefs::NamingAttributes_T expectedOrInstalledEquipment
–Supported. If the slot is empty and not preprovisioned for equipment, this field is empty.
• EquipmentObjectTypeList_T acceptableEquipmentTypeList
–Supported.
–Not supported for ONS 15501, ONS 15530, and ONS 15540.
ONS 15454 SONET Slot Number
(All Releases)
|
Acceptable Equipment
|
9
|
AIC
|
8, 10
|
XC, XCVT
|
7, 11
|
TCC
|
3, 15
|
DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, ETH100, ETH1000, OC3, OC12, EC1
|
1, 2, 4, 14, 16, 17
|
DS1, DS3, DS3E, DS3XM, ETH100, ETH1000, OC3, OC12, EC1
|
5, 6, 12, 13
|
DS1, DS3, DS3E, DS3XM, ETH100, ETH1000, OC3, OC12, EC1, OC48
|
ONS 15454 SONET R4.1 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
TXP_G1000_41
|
ONS 15454 SONET R5.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, 2.5G SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, DS3XM_12, DS3_EC1_48, ML2_EXIGE, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP
|
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
|
MUX32_O, DMX32_O, WSS_32, DMX32_R1
|
8, 10
|
OSCM
|
7, 11
|
TCC2P
|
ONS 15454 SONET R6.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, 2.5G SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, DS3XM_12, DS3_EC1_48, ML2_EXIGE, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP, DS1_E1_56, MRC_12,OPT_BST_E, 2.5-10G_Muxponder, 10G_MR_Transponder, ML-100X-8
|
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
|
MUX32_O, DMX32_O, WSS_32, DMX32_R1
|
8, 10
|
OSCM, XCVXC, XCVXC25G
|
7, 11
|
TCC2P
|
5, 6, 12, 13
|
OC192_XFP
|
ONS 15454 SONET R7.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
CE-1000, MS-ISC-100T
OPT_AMP_L, OPT_BST, OPT_BST_E, OPTBST_L, OPT_PRE
10DME, 2.5G_DM, 2.5G_DMP, MXP_2.5G_10E, MXP_2.5G_10G, TXPP_MR_2.5G, TXP_MR_2.5G, TXP_MR_10E, TXP_MR_10G, TXP_MR_2.5G
32DMX, 32DMX_L, 32DMX_O, 32MUX_O, 32_WSS, 32WSS_L, 4MD
AD_1B, AD_1C, AD_2C, AD_4B, AD_4C
MMU, OSC-CSM
|
1, 2, 16, 17
|
DS1, DS1_E1_56, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, OC12, OC3_4
|
4, 14
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, OC12, OC3_4
|
5, 6, 12, 13
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, OC12, OC3_4, OC48
|
3, 15
|
DS1, DS1N, DS3, DS3E, DS3XM, DS3XM_12, DS3IN, DS3N, DS3NE, ETH100, ETH1000, MRC_12, OC12, OC3_4
|
7, 11
|
TCC
|
8, 10
|
OSCM, XC, XC10G, XCVT, XCVXC_10G
|
9
|
AIC
|
ONS 15454 SONET R8.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
ML-MR
OPT_AMP_17_C, OPT_AMP_L, OPT_BST, OPT_BST_E, OPTBST_L, OPT_PRE
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.5G, TXP_MR_10E, TXP_MR_10G, TXP_MR_2.5G
32DMX, 32DMX_L, 32DMX_O, 32MUX_O, 32_WSS, 32WSS_L, 4MD, 40DMX, 40MUX, 40WSS, 4MD
40WXC
AD_1B, AD_1C, AD_2C, AD_4B, AD_4C
MMU, OSC-CSM
|
1, 2, 4, 14, 16, 17
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, MRC25G_4, OC12, OC3_4, OC12_4, OC3_8, OC48
|
3, 15
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS1N, DS3IN, DS3N, DS3NE, ETH100, ETH1000, MRC_12, MRC25G_4, OC12, OC3_4, OC12_4, OC3_8, OC48
|
5, 16, 12, 13
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, MRC25G_4, OC12, OC3_4, OC48, OC192, OC192_XFP
|
7, 11
|
TCC, TCC2
|
8, 10
|
OSCM, XC10G
|
9
|
AIC, AICI
|
ONS 15454 SONET R8.5 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
OPT_AMP_17_C, OPT_AMP_L, OPT_BST, OPT_BST_E, OPTBST_L, OPT_PRE, OPT_AMP_C
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.5G, TXP_MR_10E, TXP_MR_10G, TXP_MR_2.5G
32DMX, 32DMX_L, 32DMX_O, 32MUX_O, 32_WSS, 32WSS_L, 4MD, 40DMX, 40MUX, 40WSS, 4MD
40WXC
AD_1B, AD_1C, AD_2C, AD_4B, AD_4C
MMU, OSC-CSM
|
1, 2, 4, 14, 16, 17
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, MRC25G_4, OC12, OC3_4, OC12_4, OC3_8, OC48
|
3, 15
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS1N, DS3IN, DS3N, DS3NE, ETH100, ETH1000, MRC_12, MRC25G_4, OC12, OC3_4, OC12_4, OC3_8, OC48
|
5, 16, 12, 13
|
DS1, DS3, DS3E, DS3XM, DS3XM_12, DS3I, ETH100, ETH1000, MRC_12, MRC25G_4, OC12, OC3_4, OC48, OC192, OC192_XFP
|
7, 11
|
TCC, TCC2
|
8, 10
|
XC10G, OSCM
|
9
|
AIC, AICI
|
ONS 15454 SDH Slot Number (All Releases)
|
Acceptable Equipment
|
9
|
AIC
|
8, 10
|
XC10G
|
7, 11
|
TCCI
|
1, 2, 4, 14, 16, 17
|
E1, DS3I, E3, STM1, STM4, STM16, ETH100, ETH1000, G1000_4
|
3, 15
|
E1, E1N, DS3I, DS3IN, E3, STM1, STM4, STM16, ETH100, ETH1000, G1000_4
|
6, 12
|
ETH100, ETH1000, G1000_4, STM1, STM4, STM16, STM64
|
5, 13
|
E1, E3, DS3I, ETH100, ETH1000, G1000_4, STM1, STM4, STM16, STM64
|
23
|
ALM_PWR
|
24
|
CRFT_TMG
|
18, 19, 20, 21, 22, 25, 26, 27, 28, 29
|
FMEC_SMZ_E1, FMEC_SMZ_E3, FMEC_DB
|
ONS 15454 SDH R5.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP
|
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
|
MUX32_O, DMX32_O, WSS_32, DMX32_R1
|
8, 10
|
OSCM
|
ONS 15454 SDH R6.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP, MRC_12, OPT_BST_E, 2.5-10G_Muxponder, 10G_MR_Transponder, ML-100X-8, CE-100T-8
|
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
|
MUX32_O, DMX32_O, WSS_32, DMX32_R1
|
8, 10
|
OSCM, XCVXC, XCVXC25G
|
5, 6, 12, 13
|
STM64_XFP
|
1, 2, 3, 4, 5, 13, 14, 15, 16, 17
|
DS1I
|
18, 19, 20, 21, 22, 30, 31, 32, 33, 34
|
FMEC_SMZ_DS1I
|
ONS 15454 SDH R7.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
CE-1000, MS-ISC-100T
OPT_AMP_L, OPT_BST, OPT_BST_E, OPTBST_L, OPT_PRE
10DME, 2.5G_DM, 2.5G_DMP, MXP_2.5G_10E, MXP_2.5G_10G, TXPP_MR_2.5G, TXP_MR_2.5G, TXP_MR_10E, TXP_MR_10G, TXP_MR_2.5G
32DMX, 32DMX_L, 32DMX_O, 32MUX_O, 32_WSS, 32WSS_L, 4MD
AD_1B, AD_1C, AD_2C, AD_4B, AD_4C
MMU, OSC-CSM
|
1, 2, 4, 14, 16, 17
|
DS3I, E1, E1_42, E3, ETH100, ETH1000, MRC_12, STM1_4, STM16, STM4, STM1E_12, STM4_4, STM1_8
|
3, 15
|
E1_42, E3, DS3IN, E1N, ETH100, ETH1000, MRC_12, STM1_4, STM16, STM4, STM1E_12, STM4_4, STM1_8
|
5, 13
|
DS3I, E1, E1_42, E3, ETH100, ETH1000, MRC_12, STM1_4, STM16, STM4, STM64, STM64_XFP
|
6, 12
|
ETH100, ETH1000, MRC_12, STM1_4, STM16, STM4, STM64, STM64_XFP
|
7, 11
|
TCC
|
8, 10
|
XCVXL_10G
|
9
|
AICI
|
ONS 15454 SDH R8.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
ML-MR
OPT_AMP_17_C, OPT_AMP_L, OPT_BST, OPT_BST_E, OPT_BST_L, OPT_PRE
10GE_XP, GE_XP, 10DME, 2.5G_DM, 2.5G_DMP, MXP_2.5G_10E, MXP_2.5G_10G, TXPP_MR_2.5G, TXP_MR_2.5G, TXP_MR_10E, TXP_MR_10G, TXP_MR_2.5G
32DMX, 32DMX_L, 32DMX_O, 32MUX_O, 32_WSS, 32WSS_L, 4MD, 40DMX, 40MUX, 40WSS, 4MD, 40WXC
AD_1B, AD_1C, AD_2C, AD_4B, AD_4C
MMU, OSC-CSM
|
1, 2, 4, 14, 16, 17
|
DS3I, E3, E1_42, STM1E_12, STM1_8, STM4_4, ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4
|
3, 15
|
E3, DS3IN, E1_42, STM1E_12, STM1_8, STM4_4, ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4
|
5, 13
|
DS3I, E3, ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4, STM64, STM64_XFP
|
6, 12
|
ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4, STM64, STM64_XFP
|
7, 11
|
TCC, TCC2
|
8, 10
|
OSCM, XCVXC_10G, XC10G, XCVXL_10G, XCVXL_2.5, XCVXL_10G
|
9
|
AICI
|
ONS 15454 SDH R8.5 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
OPT_AMP_17_C, OPT_AMP_L, OPT_BST, OPT_BST_E, OPTBST_L, OPT_PRE, OPT_AMP_C
10GE_XP, GE_XP, 10DME, 2.5G_DM, 2.5G_DMP, MXP_2.5G_10E, MXP_2.5G_10G, TXPP_MR_2.5G, TXP_MR_2.5G, TXP_MR_10E, TXP_MR_10G, TXP_MR_2.5G, ADM_10G
32DMX, 32DMX_L, 32DMX_O, 32MUX_O, 32_WSS, 32WSS_L, 4MD, 40DMX, 40MUX, 40WSS, 4MD, 40WXC
AD_1B, AD_1C, AD_2C, AD_4B, AD_4C
MMU, OSC-CSM
ML1000, ML100T, ML-100X-8, ML-MR-10, CE-MR-10, CE-100T-8, CE-1000-4 (only when XC10G, XCVXL-10G is installed in slot 8 or 10)
|
1, 2, 4, 14, 16, 17
|
DS3I, E3, E1_42, STM1E_12, STM1_8, STM4_4, ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4
|
3, 15
|
E3, DS3IN, E1_42, STM1E_12, STM1_8, STM4_4, ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4
|
5, 13
|
DS3I, E3, ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4, STM64, STM64_XFP
|
6, 12
|
ETH100, ETH1000, MRC12, MRC25G_12, STM1_4, STM16, STM4, STM64, STM64_XFP
|
7, 11
|
TCC, TCC2
|
8, 10
|
XCVXC_10G, XC10G, XCVXL_10G, XCVXL_2.5, XCVXL_10G, OSCM
|
9
|
AICI
|
ONS 15327 Slot Number (All Releases)
|
Acceptable Equipment
|
7, 8
|
MIC
|
5, 6
|
XTC
|
1, 2, 3, 4
|
ETH100, OC12, OC48
|
ONS 15327 R3.4 and Later Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4
|
G1000_2
|
ONS 15800 Slot Number
|
Acceptable Equipment
|
151
|
CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S
|
13-14 (see footnote 1)
|
LSM-W
|
16 (see footnote 1)
|
IOC-W
|
17
|
SCF-W and BAT
|
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
|
For any other supported module, see D.18 Equipment List for ONS 15800 and ONS 15801, page D-35
|
ONS 15801 Slot Number
|
Acceptable Equipment
|
131
|
CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S
|
11-12 (see (1) below)
|
LSM-W
|
14 (see (1) below)
|
IOC-W
|
15
|
SCF-W and BAT
|
1, 2, 3, 4, 5, 6, 7, 8, 9, 10
|
For any other supported module, see D.18 Equipment List for ONS 15800 and ONS 15801, page D-35
|
ONS 15808 Slot Number
|
Acceptable Equipment
|
131
|
CMP, CMP-S
|
11-121
|
OSCM
|
141
|
AIU
|
15
|
SCU and PL
|
1, 2, 3, 4, 5, 6, 7, 8, 9, 10
|
Any other supported module (see D.19 Equipment List for ONS 15808, page D-37)
|
ONS 15302 Slot Number
|
Acceptable Equipment
|
1
|
E1-12
|
2
|
S1.1-2-SC
|
3
|
E100-4
|
4
|
WAN-4 and WAN-1
|
ONS 15216 DCU Slot Number
|
Acceptable Equipment
|
1, 2
|
• DCU-100(100 ps/nm)
• DCU-350(350 ps/nm)
•DCU-450(450 ps/nm)
• DCU-550(550 ps/nm)
•DCU-750(750 ps/nm)
• DCU-950(ps/nm)
•DCU-1150(1150 ps/nm)
•DCU-E-200 (200 ps/nm)
•DCU-E-350 (350 ps/nm)
•DCU-L-300 (300 ps/nm)
•DCU-L-600 (600 ps/nm)
•DCU-L-700 (700 ps/nm)
•DCU-L-800 (800 ps/nm)
•DCU-L-1000 (1000 ps/nm)
•DCU-L-1100 (1100 ps/nm)
• DCU-DS-L-100 (100 ps/nm)
•DCU-DS-L-200 (200 ps/nm)
•DCU-DS-L-300 (300 ps/nm)
|
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 15600 SONET R1.3 Slot Number
|
Acceptable Equipment
|
5, 10
|
TXC
|
6/7, 8/9
|
CXC
|
1, 2, 3, 4, 11, 12, 13, 14
|
OC48_16, OC192_4
|
ONS 15600 SONET R5.0 Slot Number
|
Acceptable Equipment
|
5, 10
|
TXC
|
6/7, 8/9
|
SSXC
|
1, 2, 3, 4, 11, 12, 13, 14
|
OC48_16, OC192_4, OC48_32
|
1, 2, 3, 4, 11, 12, 13, 14
|
ASAP
|
ONS 15600 SONET R8.0 Slot Number
|
Acceptable Equipment
|
5, 10
|
TXC
|
6/7, 8/9
|
SSXC
|
1, 2, 3, 4, 11, 12, 13, 14
|
OC48_16, OC192_4, OC48_32
|
1, 2, 3, 4, 11, 12, 13, 14
|
ASAP, OC192_4_DWDM
|
ONS 15600 SDH R1.4 Slot Number
|
Acceptable Equipment
|
5, 10
|
TXC
|
6/7, 8/9
|
CXC
|
1, 2, 3, 4, 11, 12, 13, 14
|
STM16_16, STM64_4
|
ONS 15600 SDH R8.0 Slot Number
|
Acceptable Equipment
|
5,10
|
TXC
|
6/7, 8/9
|
SSXC
|
1, 2, 3, 4, 11, 12, 13, 14
|
OC48_16, OC192_4, OC48_32
|
1, 2, 3, 4, 11, 12, 13, 14
|
ASAP, STM64_4_DWDM
|
ONS 15310 MA R7.0 Slot Number
|
Acceptable Equipment
|
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
|
ML-100T-8, CE-100T-8
|
ONS 15310 MA R8.0 Slot Number
|
Acceptable Equipment
|
3, 4
|
CTX-2500, CTX-FILLER
|
1, 2, 5, 6
|
DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3, DS3-EC-6
|
1, 2, 5, 6
|
CE-100T-8, ML-100T-8, EXP-FILLER
|
Compliance
TMF-defined.
3.6.2 equipment::EquipmentInventoryMgr_I:: 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 equipment::EquipmentInventoryMgr_I:: getAllEquipment, but returns the object names instead of returning the entire object.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
meOrHolderName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the ME or equipment holder for which to retrieve contained equipment and equipment holders.
|
how_many
|
unsigned long
|
In
|
Maximum number of EquipmentOrHolder_Ts to return in the first batch.
|
nameList
|
globaldefs::NamingAttributesList_T
|
Out
|
First batch of names.
|
nameIt
|
globaldefs::NamingAttributesIterator_I
|
Out
|
Iterator to retrieve the remaining names.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when meOrHolderName does not reference a managed element or
an equipment holder.
EXCPT_ENTITY_NOT_FOUND - Raised when managedElementOrEquipmentName 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.3 equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPs
Synopsis
void getAllSupportedPTPs(
in globaldefs::NamingAttributes_T equipmentName,
in unsigned long how_many,
out terminationPoint::TerminationPointList_T tpList,
out terminationPoint::TerminationPointIterator_I tpIt)
raises(globaldefs::ProcessingFailureException);
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).
If the equipment is protection equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the supported PTPs.
•ONS 15454 SONET: CTM returns OC-n, DS1, DS3, EC-1, fibre channel, and front Ethernet ports.
•ONS 15454 SDH: CTM returns STM-n (OC-n), E1, E3, DS3I, STM1E, fibre channel, and front Ethernet ports.
•ONS 15327: CTM returns OC-n, DS1, DS3, and Ethernet ports.
•ONS 15800, ONS 15801, and ONS 15808: CTM returns all the supported PTPs for specific ONS 158xx equipment.
•ONS 15540: CTM returns client, wave, wavepatch, filter, wdm, filterband, filtergroup, oscfilter, wavepassthrough, fastEthernet, TenGigEthernetPhy, and sonet-sdh as potential PTPs.
•ONS 15530: CTM returns all the supported PTPs for ONS 15530.
•ONS 15501: CTM returns In-Port and Out-Port.
•ONS 15216: CTM returns all the supported PTPs for ONS 15216, if there is a topological link associated with the NE.
•ONS 15600 SONET: CTM returns OC-n ports.
•ONS 15600 SDH: CTM returns STM-n ports.
•ONS 15302, ONS 15305, and ONS 15305 CTC: CTM returns WAN, SDH, and PDH ports.
•ONS 15310 CL and ONS 15310 MA: CTM returns OC-n, DS1, DS3, and Ethernet ports.
•MGX 8880/8850/8830: CTM returns the physical service module cards ports (DS1, DS3, and SONET/SDH).
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the equipment for which to retrieve supported PTPs.
|
how_many
|
unsigned long
|
In
|
Maximum number of PTPs to report in the first batch.
|
tpList
|
terminationPoint::TerminationPointList_T
|
Out
|
First batch of PTPs.
|
tpIt
|
terminationPoint::TerminationPointIterator_I
|
Out
|
Iterator used to retrieve the remaining PTPs.
|
CTM support for TerminationPoint_T structure is as follows:
•globaldefs::NamingAttributes_T name
–Supported. This field contains three tuples for PTP and four tuples for CTP as defined by the TMF. The third tuple contains positional information for the PTP. The naming convention is described in 2.2.5.3 Physical Termination Point, page 2-37, 2.2.5.4 Connection Termination Point, page 2-38, and 2.2.5.5 Floating Termination Point, page 2-42.
•string userLabel
–Not supported.
•string nativeEMSName
–Supported.
•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 FTP it is TPCS_BI_CONNECTED.
•TerminationMode_T tpMappingMode
–Not supported.
•Directionality_T direction
–Supported. PTPs always report D_BIDIRECTIONAL. For the ONS 155xx, D_SOURCE and D_SINK are also supported.
•transmissionParameters::LayeredParameterList_T transmissionParams
–Supported. Layer rate is supported for PTP, CTP, and FTP.
CTM supports the following parameters for PTP.
TP Type
|
NE Type
|
Valid Values
|
Supporting Equipment and Restrictions
|
AlarmReporting
|
PTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
ONS 15454 SDH
ONS 15600 SONET
ONS 15600 SDH
|
On, Off
|
All equipment (except equipment that does not have PTP, such as XC, TCC2, CXC, and so on).
|
ServiceState
|
PTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
ONS 15454 SDH
ONS 15600 SONET
ONS 15600 SDH
|
—
|
All equipment (except ML and CE cards, FCMR, and the equipment that does not have PTP, such as XC, TCC2, and so on).
|
AdminState
|
PTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
|
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)
Down, Up
|
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.
Down and Up are valid values shown for ML-series cards.
For CE-series and E-series Ethernet cards, valid values are In Service, Auto In Service, Out of Service, and Out of Service by Maintenance.
SERV_NA is not a valid value for any card.
|
ONS 15600
|
IN_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE, OUT_OF_SERVICE (for NE R5.0 or later), AUTO_IN_SERVICE (for NE R5.0 or later)
|
All equipment (except equipment that does not have PTP, such as CXC and so on).
|
ONS 15454 SDH
ONS 15600 SDH
|
UNLOCKED
LOCKED, DISABLED
LOCKED, MAINTENANCE
UNLOCKED, AUTO_IN_SERVICE
|
All equipment (except ML and CE cards, and equipment that does not have PTP, such as XC, TCC2, and so on). FCMR does not support the UNLOCKED, AUTO_IN_SERVICE value.
The ONS 15600 SDH does not support LOCKED, DISABLED and UNLOCKED, AUTO IN SERVICE.
|
LineCode
|
PTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
|
ami, b8zs
|
DS1 port on XTC and CTX cards.
|
ONS 15454 SONET
|
ami, b8zs
|
DS1, DS1N.
|
ONS 15310 CL
ONS 15310 MA
ONS 15454 SONET
|
b3zs
|
DS3E, DS3NE, DS3XM, DS3I, DS3IN,DS3, DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3, ONS 15310 CL and ONS 15310 MA DS3 ports on CTX cards.
|
ONS 15454 SDH
|
hdb3
|
E1, E1N, E1_42.
|
ONS 15454 SDH
|
b3zs
|
DS3I, DS31N.
|
FrameFormat
|
PTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
|
esf, d4, unframed, auto provision fmt (only on ONS 15310)
|
DS1 port on XTC cards.
|
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.
|
ONS 15454 SDH
|
e1_mf, e1_crcmf, e1_unframed
|
E1, E1N, E1_42.
|
ONS 15310 CL
ONS 15310 MA
|
m13, cbit, unframed
|
DS3 port on CTX cards.
|
ONS 15454 SDH
|
m13, cbit, unframed, auto provision fmt
|
DS3I, DS31N.
|
SDH_SONET_SS_BITS
|
PTP
|
ONS 15454 SONET
|
SDH, SONET
|
OC-n equipment.
|
ONS 15454 SDH
|
SDH
|
STM-n equipment.
|
EnableSyncMsg
|
PTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
ONS 15600 SONET
|
On, Off
|
OC-n equipment.
|
ONS 15454 SDH
ONS 15600 SDH,
|
On, Off
|
STM-n equipment.
|
ALSMode
|
PTP
|
ONS 15454 SONET
|
DISABLED, AUTO, MANUAL, MANUAL_RESTART_FOR_TEST
|
OC3_8, OC48 ELR, OC192 equipment only.
|
ONS 15454 SDH
|
DISABLED, AUTO, MANUAL, MANUAL_RESTART_FOR_TEST
|
STM1_8, STM16 ELR, STM64 equipment only.
|
PulseWidth
|
PTP
|
ONS 15454 SONET
|
Float value from 2.0 to 100.0
|
OC3_8, OC48 ELR, OC192 equipment only.
|
ONS 15454 SDH
|
Float value from 2.0 to 100.0
|
STM1_8, STM16 ELR, STM64 equipment only.
|
RecoveryInterval
|
PTP
|
ONS 15454 SONET
|
Integer value from 100 to 300
|
OC3_8, OC48 ELR, OC192 equipment only.
|
ONS 15454 SDH
|
Integer value from 100 to 300
|
STM1_8, STM16 ELR, STM64 equipment only.
|
HasLaserBeenShutdown
|
PTP
|
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.
|
RestartLaser
|
PTP
|
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.
|
IPPMMonitor
|
CTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
ONS 15454 SONET
ONS 15600 SONET
ONS 15600 SDH
|
On, Off
|
STS CTPs on OC-n cards.
|
ONS 15454 SDH
|
On, Off
|
VC4 CTPs on STM-n cards.
|
TrailTraceActualTx
|
CTP
|
ONS 15454 SONET
|
Free-format string
|
DS3E, DS3NE, DS3XM, DS3I, DS31N.
|
ONS 15454 SDH
|
Free-format string
|
E3, DS3I, DS3IN, STM1E_12.
|
TrailTraceExpectedRx
|
CTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
|
Free-format string
|
OC3.
|
ONS 15454 SONET
|
Free-format string
|
DS3E, DS3NE, DS3I, DS3IN, DS3XM, EC1, OC3, OC3_8, OC12_4, OC48AS, OC192.
|
ONS 15454 SDH
|
Free-format string
|
E3, DS3I, DS3IN, STM1E_12, OC3, OC3_8, OC12_4, OC48AS, OC192.
|
ONS 15600 SONET
ONS 15600 SDH
|
Free-format string
|
OC48_16, OC192_4.
|
FTP
|
ONS 15327
|
Free-format string
|
G1000_2.
|
ONS 15310 CL
ONS 15310 MA
|
Free-format string
|
ML2_MAPPER and ML2_L2L3.
|
ONS 15454 SONET
ONS 15454 SDH
|
Free-format string
|
G1000_4, ML-series, and CE-series cards (except G1000; for all other cards it is supported only for R5.0 and later).
|
TrailTraceMonitor
|
CTP
|
ONS 15310 CL
ONS 15310 MA
ONS 15327
|
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
ONS 15600 SDH
|
On, Off
|
OC48_16, OC192_4.
|
FTP
|
ONS 15327
|
On, Off
|
G1000_2.
|
ONS 15310 CL
ONS 15310 MA
|
On, Off
|
ML2_L2L3 and ML2_MAPPER.
|
ONS 15454 SONET
ONS 15454 SDH
|
On, Off
|
G1000_4, ML-series, and CE-series cards (except G1000; for all other cards it is supported only for R5.0 and later).
|
XCLoopBack
|
CTP
|
ONS 15327
ONS 15454 SONET
ONS 15600 SONET
ONS 15600 SDH
|
On, Off
|
STS CTPs on OC-n cards when line loopback is not set on the containing PTP.
|
ONS 15454 SDH
|
On, Off
|
VC4 CTPs on STM-n cards when line loopback is not set on the containing PTP.
|
PortMediaType
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
UNDEFINED, FibreChannel-1Gbps, FibreChannel-2Gbps, FICON-1Gbps, and FICON-2Gbps
|
FCMR (for NE R5.0 and later).
|
Link Recovery
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
On, Off
|
FCMR (for NE R5.0 and later).
|
No. of Superblocks
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
From 4 to 32
|
FCMR (for NE R5.0 and later).
|
Enable Distance Extension
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
On, Off
|
FCMR (only in distance extension mode and for NE R5.0 and later).
|
Auto Detect Credits
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
On, Off
|
FCMR (only in distance extension mode and for NE R5.0 and later).
|
Number Credits
|
PTP
|
ONS 15454 SONET, ONS 15454 SDH
|
From 2 to 256, in multiples of 2
|
FCMR (only in distance extension mode and for NE R5.0 and later).
|
Autoadjust GFP Buffer Threshold
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
On, Off
|
FCMR (only in distance extension mode and for NE R5.0 and later).
|
GFP Buffers Available
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
From 16 to 1200, in multiples of 16
|
FCMR (only in distance extension mode and for NE R5.0 and later).
|
Ingress Idle Filtering
|
PTP
|
ONS 15454 SONET
ONS 15454 SDH
|
On, Off
|
FCMR (only in distance extension mode and for NE R5.0 and later).
|
MaxFrameSize
|
|
PTP
|
ONS 15454
|
From 2148 to 2172
|
FCMR (only in distance extension mode).
|
FrameFormat
|
CTP
|
ONS 15454
|
Auto provision fmt, esf, d4, and unframed
|
DS3XM_12.
|
FDLMode
|
CTP
|
ONS 15454
|
T1.403 and BFDL
|
DS3XM_12.
|
DetectedLineType
|
PTP
|
ONS 15454
|
Read-only value
|
DS3E.
|
Note If TrailTraceMonitor is off for a given CTP or FTP, CTM does not return TrailTraceActualRx in transmissionParams.
•TPProtectionAssociation_T tpProtectionAssociation
–Not supported.
•boolean edgePoint
–Supported. For CTP and FTP, the value must be False.
•globaldefs::NVSList_T additionalInfo
–Not supported.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
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.4 equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPNames
Synopsis
void getAllSupportedPTPNames(
in globaldefs::NamingAttributes_T equipmentName,
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 equipment::EquipmentInventoryMgr_I:: getAllSupportedPTPs, but returns the object names instead of returning the entire object.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the equipment for which to retrieve supported PTPs.
|
how_many
|
unsigned long
|
In
|
Maximum number of PTPs to report in the first batch.
|
nameList
|
obaldefs::NamingAttributesList_T
|
Out
|
First batch of PTP names.
|
nameIt
|
globaldefs::NamingAttributesIterator_I
|
Out
|
Iterator to retrieve the remaining PTP names.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
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.5 equipment::EquipmentInventoryMgr_I:: 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.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
ptpName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the PTP for which to retrieve supporting equipment.
|
eqList
|
EquipmentOrHolderList_T
|
Out
|
List of equipment (not equipment holders) that directly implements the PTP.
|
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For details about both structures, see equipment::EquipmentInventoryMgr_I:: getAllEquipment.
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP 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.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.
Compliance
TMF-defined.
3.6.6 equipment::EquipmentInventoryMgr_I:: getAllSupportingEquipmentNames
Synopsis
void getAllSupportingEquipmentNames(
in globaldefs::NamingAttributes_T ptpName,
out globaldefs::NamingAttributesList_T nameList)
raises(globaldefs::ProcessingFailureException);
Description
This interface has the same behavior as the operation described in equipment::EquipmentInventoryMgr_I:: getAllSupportingEquipment, but returns the object name instead of returning the entire object.
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.
EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP 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.
EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.
Compliance
TMF-defined.
3.6.7 equipment::EquipmentInventoryMgr_I:: getContainedEquipment
Synopsis
void getContainedEquipment(
in globaldefs::NamingAttributes_T equipmentHolderName,
out EquipmentOrHolderList_T equipmentOrHolderList)
raises(globaldefs::ProcessingFailureException);
Description
This interface returns the equipment and equipment holders that a specific equipment holder contains. This interface differs from getAllEquipment in that it looks only at the next level of the containment hierarchy.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentHolderName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the equipment holder for which to retrieve the directly contained equipment and equipment holders.
CTM also accepts the ME name as a value for this parameter.
|
equipmentOrHolderList
|
EquipmentOrHolderList_T
|
Out
|
Directly contained equipment and equipment holders.
|
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For details about both structures, see equipment::EquipmentInventoryMgr_I:: getAllEquipment.
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.8 equipment::EquipmentInventoryMgr_I:: getEquipment
Synopsis
void getEquipment(in globaldefs::NamingAttributes_T equipmentOrHolderName,
out EquipmentOrHolder_T equip)
raises(globaldefs::ProcessingFailureException);
Description
This interface returns the equipment or equipment holder for specific equipment or equipment holder names.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentOrHolderName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the equipment or equipment holder to retrieve.
|
equip
|
EquipmentOrHolder_T
|
Out
|
Returned equipment or equipment holder.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or
an equipment holder.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an equipment or
equipment holder that does not exist.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
Compliance
TMF-defined.
3.6.9 equipment::EquipmentInventoryMgr_I:: provisionEquipment
Synopsis
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. The resulting object is returned.
The equipment holder that contains the equipment must exist. The equipment object can already exist, but the equipment holder must not have expected equipment already provisioned.
If the equipment is provisioned successfully, CTM generates a state change event on the holder state change and an object creation event for the equipment, and pushes them to the event channel.
It is important to note that the ONS 15454 SONET detects new equipment and provisions it automatically, provided that the equipment holder (slot) is empty and is not preprovisioned for another module type.
The equipment must be from the acceptableEquipmentTypeList of the slots. If these slots are selected to provision any other type of card, CTM returns the EXCPT_UNABLE_TO_COMPLY exception.
PPMs and PIMs can also be provisioned using this interface.
It is not necessary to know the subtypes of the OC-n card at the time of provisioning. When equipment is actually installed, CTM reports the subtype in the name field of the equipment.
For the ONS 15600 SONET and ONS 15600 SDH, each CXC or SSXC card occupies two slots (slots 6 and 7 or slots 8 and 9), and the NMS can specify any one of the slots to provision a CXC or SSXC card.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentCreateData
|
EQTCreateData_T
|
In
|
Data that describes the equipment to create.
|
createdEquipment
|
Equipment_T
|
Out
|
Resulting created equipment.
|
CTM support for EQTCreateData_T structure is as follows:
•string userLabel
–Not supported.
•boolean forceUniqueness
–Not supported.
•string owner
–Not supported.
•EquipmentObjectType_T expectedEquipmentObjectType
–This parameter must take one of the values for equipment described in equipment::EquipmentInventoryMgr_I:: getAllEquipment.
•globaldefs::NamingAttributes_T equipmentHolderName
–Supported.
•globaldefs::NVSList_T additionalInfo
–Not supported.
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.
EXCPT_INVALID_INPUT - Raised when equipmentHolder does not reference an equipmentHolder
object.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolder references an object that does not
exist.
EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be created at the NE.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
Compliance
TMF-defined.
3.6.10 equipment::EquipmentInventoryMgr_I:: setAlarmReportingOff
Synopsis
void setAlarmReportingOff(
in globaldefs::NamingAttributes_T equipmentOrHolderName)
raises(globaldefs::ProcessingFailureException);
Description
This interface disables alarm reporting on a piece of equipment. If successful, CTM sends a warning alarm notification.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentOrHolderName
|
Globaldefs::NamingAttributes_T
|
In
|
Equipment on which to deactivate alarm reporting.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or
holder.
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.11 equipment::EquipmentInventoryMgr_I:: setAlarmReportingOn
Synopsis
void setAlarmReportingOn(
in globaldefs::NamingAttributes_T equipmentOrHolderName)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables alarm reporting on a piece of equipment.
The default setting for alarmReporting is "on." If the alarmReporting status is off, it indicates that a warning alarm has been raised for it. CTM generates a cleared warning alarm if successful.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentOrHolderName
|
globaldefs::NamingAttributes_T
|
In
|
Equipment on which to activate alarm reporting.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or
holder.
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.12 equipment::EquipmentInventoryMgr_I:: 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.
The ONS 15454 SONET does not allow a user to unprovision a piece of equipment that is in use (SNC is created on this equipment). However, if the equipment is present in the slot and is not in use, it can be unprovisioned. If the equipment is not physically removed from the slot and new equipment is not provisioned in the same slot, the NE redetects the equipment in approximately 1 minute. If the equipment is not physically removed from the slot and new equipment of a different type is provisioned in the same slot, the NE generates an equipment mismatch alarm.
If the equipment is unprovisioned successfully, CTM generates a state change event on the holder state change and an object deletion event for the equipment, and pushes them to the event channel.
The ONS 15454 reserves slots 7 and 11 for TCC. One of these slots has an in-service TCC card. If the NMS invokes unprovisionEquipment on this equipment, CTM throws the EXCPT_UNABLE_TO_COMPLY exception.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the equipment to unprovision.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.
EXCPT_OBJECT_IN_USE - Deletion is rejected because equipment resources are in use.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not
exist.
EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be unprovisioned at the NE.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
Compliance
TMF-defined.
3.6.13 equipment::EquipmentInventoryMgr_I:: configureMLParameters
Synopsis
void configureMLParameters(
in globaldefs::NamingAttributes_T equipmentOrHolderName,
in globaldefs::NVSList_T paramList
raises(globaldefs::ProcessingFailureException);
Description
This interface enables provisioning of Fast Ethernet and POS configuration parameters on ML cards. The operation is performed on a best-effort basis. CTM does not validate the parameter names or values that are passed to the API. This interface is supported only on ML cards.
If the operation is unsuccessful, CTM returns a processing failure exception.
This interface lets you configure the following POS parameters:
•Interface state—Denotes the administration state of the POS interface. Valid values are "shut" and "no shut."
•MTU size—Configures the maximum transport unit of the Ethernet packets. The valid range for MTU size is from 64 to 9000; the default is 1500.
•Framing type—Indicates the Layer 2 encapsulation format: high-level data link control (HDLC) or Point-to-Point Protocol (PPP).
Note Framing type can be configured only on ONS 15310 ML-100T-8 cards.
•CoS Accounting—When enabled, allows the L2 CoS to initiate counting packets on an interface. This CoS accounting feature can be enabled or disabled.
•All POS parameters can be configured for all POS ports.
•CTM GateWay/CORBA lets you provision the following parameters on Fast Ethernet ports:
–Interface state—Denotes the administration state of the Fast Ethernet ports. Valid values are "shut" and "no shut."
–MTU size—Configures the maximum transport units of the Ethernet packets. The valid range for MTU size is from 64 to 9000; the default is 1500.
–Speed—Configures the speed operation. The only permissible value is "auto." Setting this value to "auto" enables the automatic speed configuration.
–Duplex—Must be set to "auto" for ML1000T cards. ML100T cards support the following options:
auto—Enables autoduplex configuration.
full—Forces full-duplex operation.
half—Forces half-duplex operation.
–Flow control—Must be performed on send packets. Valid values are:
desired—Allows, but does not require flow-control packets on ports.
off—Disables flow-control packets on ports.
on—Enables flow-control packets on ports (works only with policing).
Note Bandwidth and delay cannot be configured from CTM GateWay/CORBA.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
equipmentOrHolderName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the equipment holder for the ML card.
|
paramList
|
globaldefs::NVSList_T
|
In
|
Parameter list in the name/value pair. For example, to set the MTU size to 64, name=MTU size and value=64.
|
Throws
globaldefs::ProcessingFailureException
EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference a valid object.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does
not exist.
EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.
EXCPT_UNABLE_TO_COMPLY - Raised when CTM fails to configure the ML card parameters as
requested.
Compliance
CTM-defined.
3.7 maintenanceOps::MaintenanceManager_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. Operations described in the following subsections are returned to the NMS when it invokes getCapabilities.
3.7.1 maintenanceOps::MaintenanceMgr_I:: getActiveMaintenanceOperations
Synopsis
void getActiveMaintenanceOperations(
in globaldefs::NamingAttributes_T tpOrMeName,
in unsigned long how_many,
out CurrentMaintenanceOperationList_T
currentMaintenanceOpeationList,
out CurrentMaintenanceOperationIterator_I cmoIt)
raises(globaldefs::ProcessingFailureException);
Description
This interface enables the NMS to query the EMS to determine if any persistent maintenance commands have been invoked. This query is supported for PTP, CTP, and ME objects.
Parameters
Name
|
Type
|
Input/Output
|
Description
|
tpOrMeName
|
globaldefs::NamingAttributes_T
|
In
|
Name of the PTP, CTP, or ME.
|
how_many
|
unsigned long
|
In
|
Maximum number of maintenance operations to return in the first batch.
|
currentMaintenanceOpeationList
|
CurrentMaintenanceOperationList_T
|
Out
|
First batch of maintenance operations.
|
cmoIt
|
CurrentMaintenanceOperationIterator_I
|
Out
|
Iterator to access the remaining maintenance operations.
|
CTM support for CurrentMaintenan
