-
Cisco Transport Manager GateWay/CORBA User's Guide and Programmer Manual, 7.2
-
Preface
-
Chapter 1: Overview of CTM GateWay/CORBA
-
Chapter 2: NE- and CTM-Specific Details
-
Chapter 3: Using CTM GateWay/CORBA Interfaces
-
Appendix A: Notifications, Fault Management, and Probable Cause Mapping
-
Appendix B: Server Administration and Configuration
-
Appendix C: OSS Client Development and Use Cases
-
Appendix D: ONS 15501, ONS 15530, and ONS 15540 Equipment List
-
Table Of Contents
Using CTM GateWay/CORBA Interfaces
3.1.1 common::Common_I::getCapabilities
3.2.1 emsMgr::EMSMgr_I::getAllEMSAndMEActiveAlarms
3.2.2 emsMgr::EMSMgr_I::getAllEMSSystemActiveAlarms
3.2.3 emsMgr::EMSMgr_I::getAllTopLevelSubnetworks
3.2.4 emsMgr::EMSMgr_I::getAllTopLevelSubnetworkNames
3.2.5 emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks
3.2.6 emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinkNames
3.2.7 emsMgr::EMSMgr_I::getTopLevelTopologicalLink
3.2.8 emsMgr::EMSMgr_I::createTopologicalLink
3.2.9 emsMgr::EMSMgr_I::createTopologicalLinkWithYCableProtection
3.2.10 emsMgr::EMSMgr_I::deleteTopologicalLink
3.2.11 emsMgr::EMSMgr_I::modifyTopologicalLink
3.2.12 emsMgr::EMSMgr_I::getEMS
3.2.13 emsMgr::EMSMgr_I::getAllL2Topologies
3.2.14 emsMgr::EMSMgr_I::getAllQoSTemplateNames
3.2.15 emsMgr::EMSMgr_I::getAllQoSTemplates
3.2.16 emsMgr::EMSMgr_I::getQoSTemplate
3.2.17 emsMgr::EMSMgr_I::getAllEMSandMEClearedAlarms
3.2.18 emsMgr::EMSMgr_I::getAllEMSSystemClearedAlarms
3.2.19 emsMgr::EMSMgr_I::createServerTrailLink
3.2.20 emsMgr::EMSMgr_I::deleteServerTrailLink
3.2.21 emsMgr::EMSMgr_I::addManagedElement
3.2.22 emsMgr::EMSMgr_I::addNetworkPartition
3.2.23 emsMgr::EMSMgr_I::addMultiLayerSubnetwork
3.2.24 emsMgr::EMSMgr_I::deleteAndPurgeManagedElement
3.2.25 emsMgr::EMSMgr_I::deleteNetworkPartition
3.2.26 emsMgr::EMSMgr_I::deleteMultiLayerSubnetwork
3.2.27 emsMgr::EMSMgr_I::addSWVersion
3.2.28 emsMgr::EMSMgr_I::getAllSupportedMESoftwareVersions
3.3.1 emsSession::EmsSession_I::getEventChannel
3.3.2 emsSession::EmsSession_I::getManager
3.3.3 emsSession::EmsSession_I::getSupportedManagers
3.4 emsSessionFactory::EmsSessionFactory_I
3.4.1 emsSessionFactory::EmsSessionFactory_I::getEmsSession
3.4.2 emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey
3.4.3 emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair
3.5 equipment::EquipmentInventoryMgr_I
3.5.1 equipment::EquipmentInventoryMgr_I::getAllEquipment
3.5.2 equipment::EquipmentInventoryMgr_I::getAllEquipmentNames
3.5.3 equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs
3.5.4 equipment::EquipmentInventoryMgr_I::getAllSupportedPTPNames
3.5.5 equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
3.5.6 equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
Names3.5.7 equipment::EquipmentInventoryMgr_I::getContainedEquipment
3.5.8 equipment::EquipmentInventoryMgr_I::getEquipment
3.5.9 equipment::EquipmentInventoryMgr_I::provisionEquipment
3.5.10 equipment::EquipmentInventoryMgr_I::setAlarmReportingOff
3.5.11 equipment::EquipmentInventoryMgr_I::setAlarmReportingOn
3.5.12 equipment::EquipmentInventoryMgr_I::unprovisionEquipment
3.5.13 equipment::EquipmentInventoryMgr_I::configureMLParameters
3.6 maintenanceOps::MaintenanceManager_I
3.6.1 maintenanceOps::MaintenanceMgr_I::getActiveMaintenanceOperations
3.6.2 maintenanceOps::MaintenanceMgr_I::performMaintenanceOperation
3.7 managedElementManager::ManagedElementManager_I
3.7.1 managedElementManager::ManagedElementManager_I::getAllActiveAlarms
3.7.2 managedElementManager::ManagedElementManager_I::getAllSNCs
3.7.3 managedElementManager::ManagedElementManager_I::
getAllManagedElements3.7.4 managedElementManager::ManagedElementManager_I::
getAllManagedElementNames3.7.5 managedElementManager::ManagedElementManager_I::getAllPTPs
3.7.6 managedElementManager::ManagedElementManager_I::
getAllPTPNames3.7.7 managedElementManager::ManagedElementManager_I::
getContainedInUseTPs3.7.8 managedElementManager::ManagedElementManager_I::
getContainedInUseTPNames3.7.9 managedElementManager::ManagedElementManager_I::
getContainedPotentialTPs3.7.10 managedElementManager::ManagedElementManager_I::
getContainedPotentialTPNames3.7.11 managedElementManager::ManagedElementManager_I::
getContainingSubnetworkNames3.7.12 managedElementManager::ManagedElementManager_I::
getManagedElement3.7.13 managedElementManager::ManagedElementManager_I::getTP
3.7.14 managedElementManager::ManagedElementManager_I::
getAssociatedTopologicalLinks3.7.15 managedElementManager::ManagedElementManager_I::setTPData
3.7.16 managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSNCProvisioning3.7.17 managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSNCProvisioning3.7.18 managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSNCProvisioning3.7.19 managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSNCProvisioning3.7.20 managedElementManager::ManagedElementManager_I::
getAllSrcFTPsForSNCProvisioning3.7.21 managedElementManager::ManagedElementManager_I::
getAllDestFTPsForSNCProvisioning3.7.22 managedElementManager::ManagedElementManager_I::
forceNEResync3.7.23 managedElementManager::ManagedElementManager_I::
getAllTopologicalLinksForME3.7.24 managedElementManager::ManagedElementManager_I::
getAllRolls3.7.25 managedElementManager::ManagedElementManager_I::
getAllRollNames3.7.26 managedElementManager::ManagedElementManager_I::
getRoll3.7.27 managedElementManager::ManagedElementManager_I::
getRollToPTPs3.7.28 managedElementManager::ManagedElementManager_I::
getRollToCTPs3.7.29 managedElementManager::ManagedElementManager_I::
getRollFromCTPs3.7.30 managedElementManager::ManagedElementManager_I::setPortName
3.7.31 managedElementManager::ManagedElementManager_I::getPortName
3.7.32 managedElementManager::ManagedElementManager_I::
getAllClearedAlarms3.7.33 managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSTProvisioning3.7.34 managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSTProvisioning3.7.35 managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSTProvisioning3.7.36 managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSTProvisioning3.7.37 managedElementManager::ManagedElementManager_I::
getAllCrossConnections3.7.38 managedElementManager::DownloadMESoftware
3.7.39 managedElementManager::getAllSoftwareDownloadJobs
3.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
3.8.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllEdgePoints
3.8.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllEdgePointNames3.8.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElement3.8.4 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllManagedElementNames
3.8.5 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnections3.8.6 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsWithTP3.8.7 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNames3.8.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesWithTP3.8.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinks
3.8.10 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllTopologicalLinkNames3.8.11 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getMultiLayerSubnetwork3.8.12 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getCTPsAndTopologicalLinks
3.8.13 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNC3.8.14 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNCsByUserLabel3.8.15 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getTopologicalLink3.8.16 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
createAndActivateSNCFromUserLabel3.8.17 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createAndActivateSNC
3.8.18 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addDrops
3.8.19 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deactivateAndDeleteSNC
3.8.20 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC
3.8.21 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCs
3.8.22 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCNames
3.8.23 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATMemberSNCs
3.8.24 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllVCATMemberSNCNames3.8.25 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createVCAT
3.8.26 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteVCAT
3.8.27 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addMemberSNCsToVCAT
3.8.28 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteMemberSNCsFromVCAT3.8.29 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteAllMemberSNCFromVCAT3.8.30 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getValidSubnetworkConnectionsForMerge3.8.31 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::upgrade
3.8.32 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createRoll
3.8.33 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteRoll
3.8.34 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::cancelRoll
3.8.35 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::forceValidSignal
3.8.36 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::completeRoll
3.8.37 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::finishRoll
3.8.38 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllRolls
3.8.39 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllRollNames
3.8.40 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedRollNamesForSNC3.8.41 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedSNCNamesForRoll3.8.42 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createAndActivateSNCOnDRI
3.9.1 nmsSession::NmsSession_I::historyPMDataCompleted
3.9.2 nmsSession::NmsSession_I::historyPMDataFailed
3.10 performance::PerformanceManagementMgr_I
3.10.1 performance::PerformanceManagementMgr_I::disablePMData
3.10.2 performance::PerformanceManagementMgr_I::enablePMData
3.10.3 performance::PerformanceManagementMgr_I::setTCATPParameter
3.10.4 performance::PerformanceManagementMgr_I::getTCATPParameter
3.10.5 performance::PerformanceManagementMgr_I::getCTMHistoryPMData
3.10.6 performance::PerformanceManagementMgr_I::
deleteHistoryPMDataFile3.10.7 performance::PerformanceManagementMgr_I::getTPHistoryPMData
3.10.8 performance::PerformanceManagementMgr_I::getHoldingTime
3.10.9 performance::PerformanceManagementMgr_I::getAllCurrentPMData
3.11 protection::ProtectionMgr_I
3.11.1 protection::ProtectionMgr_I::getAllProtectedTPNames
3.11.2 protection::ProtectionMgr_I::getAllProtectionGroups
3.11.3 protection::ProtectionMgr_I::getProtectionGroup
3.11.4 protection::ProtectionMgr_I::performProtectionCommand
3.11.5 protection::ProtectionMgr_I::createProtectionGroup
3.11.6 protection::ProtectionMgr_I::deleteProtectionGroup
3.11.7 protection::ProtectionMgr_I::getAssociatedProtectionGroup
3.12.1 session::Session_I::endSession
3.12.2 session::Session_I::ping
3.13.1 mtnmVersion::Version_I::getVersion
3.14 L2 Topology and MLVLAN for ML-Series Ethernet Cards
3.14.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN
3.14.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANAddFrontPorts3.14.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANDropFrontPorts3.14.4 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANPortState3.14.5 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyMLVLANRSTPState
3.14.6 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyMLVLANTPQOS
3.14.7 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANCustomerIDServiceID3.14.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getMLVLAN
3.14.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteMLVLAN
3.14.10 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANs
3.14.11 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANNames
3.14.12 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAssociatedSNCs3.14.13 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getL2Topology
3.14.14 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForSNC3.14.15 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForMLVLAN3.14.16 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2
Topology3.14.17 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteL2Topology3.14.18 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyL2Topology3.14.19 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAvailableMLEquipmentOrTPNames3.15.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createVLAN
3.15.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteVLAN
3.15.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVLANs
Using CTM GateWay/CORBA Interfaces
The following sections describe each interface that CTM supports, including TeleManagement Forum (TMF)-specific and Cisco-proprietary interfaces. These interfaces are:
•
emsSessionFactory::EmsSessionFactory_I
•
•
•
•
•
•
Note
3.1 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.1.1 common::Common_I::getCapabilities
Synopsis
void getCapabilities(out CapabilityList_T capabilities)raises(globaldefs::ProcessingFailureException);Description
This service retrieves the capabilities of the manager. All nonspecified capabilities are assumed to be unsupported.
Parameters
A Capability_T value is used to identify a functionality supported by the EMS across the 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 as follows:
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
TMF-defined.
3.2 emsMgr::EMSMgr_I
The EMSMgr_I interface accesses operations that deal with the Element Management System (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_IThis interface implements the getCapabilities method. Operations described in the following sections are returned to the network management system (NMS) when it invokes getCapabilities.
3.2.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 operation 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 an 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
Cisco ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for the TCA events. The TCAs are not reported in the eventList returned by this method.
ONS 15540, ONS15530, and ONS 15501
TCAs are also reported in the eventList returned by this method as ONS 15540 sends a "clear" for the threshold crossing alarms.
ONS 15800, ONS 15801, and ONS 15808
ONS 15800, ONS 15801, and ONS 15808 alarms that are retrieved using the CTM GateWay/CORBA have OT_EQUIPMENT as the object_type field.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 maximum number of iterators has reached 128.Compliance
TMF-defined.
3.2.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 operation 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
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.2.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 enables an NMS to request all subnetworks that are under the control of the EMS.
Parameters
CTM support for MultiLayerSubnetwork_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.2.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 operation has exactly the same behavior as the operation described in emsMgr::EMSMgr_I::getAllTopLevelSubnetworks, but instead of returning the entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.2.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 operation 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 end-points of the topological link exist in two different multilayer subnetworks.
If the link is under the control of the EMS and then removed from the NE, the ProvType parameter is reported as INVALID.
Parameters
CTM support for TopologicalLink_T structure is as follows:
•
–
•
–
•
–
•
–
•
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.2.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 operation has exactly the same behavior as the operation described in emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks, but instead of returning the entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.2.7 emsMgr::EMSMgr_I::getTopLevelTopologicalLink
Synopsis
void getTopLevelTopologicalLink(in globaldefs::NamingAttributes_T topoLinkName,out topologicalLink::TopologicalLink_T topoLink)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request the top-level topological link given that its name is under the control of the EMS.
If the link is under the control of the EMS and then removed from the NE, the ProvType parameter is reported as INVALID.
Parameters
topoLinkName
globaldefs::NamingAttributes_T
In
Name of the topological link
topoLink
TopologicalLink::TopologicalLink_T
Out
Top-level topological link
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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.2.8 emsMgr::EMSMgr_I::createTopologicalLink
Synopsis
void createTopologicalLink(in topologicalLink::TLCreateData_T createData,out topologicalLink::TopologicalLink_T topologicalLink)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to create a topological link manually between two ManagedElements. CTM supports topological link creation between MEs belonging to the same multiLayer subnetwork. If CTM auto discovers a topological link between two end-points on which a manually created link exists, then CTM overwrites the manually created topological link information with the autodiscovered topological link information. CTM generates an AttributeValueChange event when a manually created link is overwritten with auto discovered 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 ObjectCreation event notification when a new topological link is created.
Note
Note
Note
This operation is supported for CRS-1, ONS 15216, ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, ONS 15600 SDH, ONS155xx, and unmanaged NEs.
Parameters
CTM support for TLCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.EXCPT_INVALID_INPUT - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined. This interface is already proposed in TMF and will be included in TMF Release 3.0.
3.2.9 emsMgr::EMSMgr_I::createTopologicalLinkWithYCableProtection
Synopsis
void createTopologicalLinkWithYCableProtection(in topologicalLink::MTLCreateData_T createData,out topologicalLink::TopologicalLink_T topologicalLink)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to create a Y-Cable topological link manually between two ManagedElements. A Y-Cable link is a bidirectional link with one PTP source and two PTP destinations. Because of the limitation in TMF for TopologicalLinks having one PTP source and one PTP destination, CTM will report two TopologicalLinks for a Y-Cable link. These two topological links will have the same nativeEMSName. See 2.2.5.8 TopologicalLink, page 2-70 for the naming convention for the Y-Cable TopologicalLink object name. The destination of the Y-Cable link must be on a DWDM card on an ONS15454SONET/SDH or on an ONS155xx NE.
CTM generates two ObjectCreationEvent notifications when a new Y-Cable topological link is created.
The TopologicalLink returned from this method is one leg of the Y-Cable.
This interface is supported for ONS 15454 SONET, ONS 15454 SDH, and ONS155xx NEs.
Parameters
CTM support for MTLCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.EXCPT_INVALID_INPUT - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.2.10 emsMgr::EMSMgr_I::deleteTopologicalLink
Synopsis
void deleteTopologicalLink(in globaldefs::NamingAttributes_T topoLinkName)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to delete a topological link manually between two ManagedElements. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if an attempt was made to delete an autodiscovered topological link or if the topological link could not be deleted in the current state. CTM generates an ObjectDeletion event notification when a topological link is deleted.
Note
This operation is supported for CRS-1, ONS 15216, ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS155xx, ONS 15600 SONET, ONS 15600 SDH, and unmanaged NEs.
Parameters
topoLinkName
globaldefs::NamingAttributes_T
In
The name of the topological link to be deleted
Throws
globaldefs::ProcessingFailureExceptionEXCPT_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 EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete an auto-discovered topological linkCompliance
CTM-defined. This interface is already proposed in TMF and will be included TMF Release 3.0.
3.2.11 emsMgr::EMSMgr_I::modifyTopologicalLink
Synopsis
void modifyTopologicalLink(in topologicalLink::TLCreateData_T newTLCreateData,out topologicalLink::TopologicalLink_T newTopologicalLink)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to modify some of the parameters of the existing topological links. The following parameters can be modified using modifyTopologicalLink API.
•
•
•
Parameters
CTM support for TLCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.EXCPT_INVALID_INPUT - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.2.12 emsMgr::EMSMgr_I::getEMS
Synopsis
void getEMS(out EMS_T emsInfo)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request the EMS information.
Parameters
CTM supports EMS_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
TMF-defined.
3.2.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 EMS. CTM supports only Resilient Packet Ring (RPR) and point-to-point L2 topology types.
Note
Parameters
CTM support for L2Topology_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
•
•
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 mix of CCAT and VCAT L1 SNCs)
•
–
•
–
•
–
•
–
•
•
•
•
•
•
•
–
–
•
•
•
•
•
•
•
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when a l2TopoType is invalid.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
CTM-defined.
3.2.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 QoSTemplate names in the EMS. The QoSTemplate has a scope in EMS.
CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
CTM-defined.
3.2.15 emsMgr::EMSMgr_I::getAllQoSTemplates
Synopsis
void getAllQoSTemplatesin unsigned long how_many,out QoSTemplateList_T qosTempListout QoSTemplateIterator_I qosTempIt)raises(globaldefs::ProcessingFailureException);Description
This interface lists all QoSTemplate in the EMS. The QoSTemplate has a scope in EMS.
CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.
Parameters
CTM support for QoSTemplate structure is as follows:
•
•
•
–
–
–
•
•
–
–
Each QoSClass_T has the following members:
•
•
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 should be separated by spaces.
•
•
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
•
–
–
–
–
–
–
•
•
–
–
•
–
–
Note
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
CTM-defined.
3.2.16 emsMgr::EMSMgr_I::getQoSTemplate
Synopsis
void getAllQoSTemplates(in globaldefs::NamingAttribute_T QoSTemplateName,out QoSTemplate_T qosTemp )raises(globaldefs::ProcessingFailureException);Description
This interface lists the complete QoSTemplate information given the QoSTemplate name. The QoSTemplate has a scope in EMS.
CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.
Parameters
qosTemplateName
globaldefs::NamingAttributes_T
In
QoS template name
qosTemp
QoSTemplate_T
Out
QoS template giving the complete information
For details on QoSTemplate_T structure, see emsMgr::EMSMgr_I::getAllQoSTemplateNames.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when QoSTemplate name is not valid.EXCPT_ENTITY_NOT_FOUND - Raised when QoSTemplate name does not exist on the EMS.Compliance
CTM-defined.
3.2.17 emsMgr::EMSMgr_I::getAllEMSandMEClearedAlarms
Synopsis
void getAllEMSandMEClearedAlarms(in notifications::ProbableCauseList_T excludeProbCauseList,in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_manyout notifications::EventList_T eventList,out notifications::EventIterator_I eventIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request all of the cleared and acknowledged alarms that are under the control of this EMS (both those raised by the NEs and those 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 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 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310
Cisco ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 do not send a "clear" for TCA events. Therefore, TCAs are not reported in the eventList that is returned by this method.
ONS 15540, ONS15530, and ONS 15501
TCAs are also reported in the eventList that is returned by this method as ONS 15540 sends a "clear" for threshold crossing alarms.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 maximum number of iterators has reached 128.Compliance
CTM-defined.
3.2.18 emsMgr::EMSMgr_I::getAllEMSSystemClearedAlarms
Synopsis
void getAllEMSSystemClearedAlarms(in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_manyout notifications::EventList_T eventList,out notifications::EventIterator_I eventIt)raises(globaldefs::ProcessingFailureException);Description
This operation 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
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.2.19 emsMgr::EMSMgr_I::createServerTrailLink
Synopsis
void createServerTrailLink(in serverTrailLink::STLCreateData_T createDataout serverTrailLink::ServerTrailLink_T serverTrailLink)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to create a ServerTrail link manually between two ManagedElements. CTM supports the ServerTrail link creation between ManagedElements belonging to the same multiLayer subnetwork. CTM generates an ObjectCreation Event notification when a new ServerTrail link is created.
Note
Note
Parameters
CTM support for STLCreateData_T structure is as follows:
•
Not supported. The value of this field is assigned to the name of the newly created ServerTrailLink.
•
Not supported.
•
Not supported.
•
CTM will support only CD_BI for bidirectional links.
•
Supported layer rates are:
–
–
–
–
–
–
•
Supported.
•
Supported.
•
Supported. The supported parameters are listed in the table below.
•
Supported. This field holds the SRLG group values. This is an optional parameter 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 serverTrailLinks.
CTM support for ServerTrailLink_T structure is as follows:
•
Supported. This field will have 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.
•
Not supported.
•
Not supported
•
Not supported.
•
CTM will support only CD_BI for bidirectional links.
•
Supported layer rates are:
–
–
–
–
–
–
•
Supported. The CTP for the serverTrailLink aEnd.
•
Supported. The CTP for the serverTrailLink zEnd.
•
Supported. The supported parameters are listed in the table below.
•
Supported. This field holds the SRLG group values. This is an optional parameter 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 serverTrailLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised if input createData is not valid.EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.2.20 emsMgr::EMSMgr_I::deleteServerTrailLink
Synopsis
void deleteServerTrailLink(in globaldefs::NamingAttributes_T serverTrailLinkName)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to delete a serverTrail Link manually between two ManagedElements. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if the server trail link cannot be deleted in the current state. CTM generates an ObjectDeletion Event notification when a serverTrail link is deleted.
This operation is supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600 SONET, ONS 15600 SDH, and ONS 15310 NEs.
Parameters
serverTrailLinkName
globaldefs::NamingAttributes_T
In
The name of the serverTrail link to be deleted
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised if input serverTrail link name is invalid.EXCPT_ENTITY_NOT_FOUND - Raised if the specified serverTrail link name does not exist in CTM.EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete a serverTrail which cannot be deleted.Compliance
CTM-defined.
3.2.21 emsMgr::EMSMgr_I::addManagedElement
Synopsis
void addManagedElement(in MEAdditionData_T neData)raises(globaldefs::ProcessingFailureException);Description
This operation enables the OSS to add a network element. All types of elements are supported except MGX and IOX.
Parameters
neData
MEAdditionData_T
in
Input data needed for the addition of the Network Element
The structure of MEAdditionalData_T is as follows:
struct MEAdditionData_T{MEModel model;string ipadd;string nwPartitionName;string multiLayerSubnetworkName;string neUsername;string nePasswd;string neLocationName;string neDescription;string snmpCommunityString;string neVendorName;boolean isGNE;};The description of each field is as follows:
enum MEModel{CISCO_ONS_15327, CISCO_ONS_15454, CISCO_ONS_15540_ESP, CISCO_ONS_15540_ESPx,CISCO_ONS_15530, CISCO_ONS_15501, CISCO_ONS_15800, CISCO_ONS_15801, CISCO_ONS_15808,CISCO_ONS_15454_SDH, CISCO_ONS_15216_EDFA2, CISCO_ONS_15216_OADM,CISCO_ONS_15216_DWDM_Filter, CISCO_ONS_15600, CISCO_ONS_15600_SDH, CISCO_ONS_15216_OSC,CISCO_ONS_15216_DCU, CISCO_ONS_15302, CISCO_ONS_15305, CISCO_ONS_15305_CTC,CISCO_ONS_15216_FlexLayer, Not_Managed_Other_Vendor, CISCO_ONS_15216_EDFA3,CISCO_ONS_15310_CL, CISCO_CRS_1, CISCO_XR_12000, CISCO_CAT_6509, CISCO_ONS_15216_EDFA1,CISCO_MDS_9000, CISCO_MGX_8880_8850, CISCO_ONS_15310MA,CISCO_7600};Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.22 emsMgr::EMSMgr_I::addNetworkPartition
Synopsis
void addNetworkPartition(in string name, in string description) raises(globaldefs::ProcessingFailureException);Description
This API enables the OSS to add a new network partition.
Parameters
name
string
In
Network partition name
description
string
In
Description for the new partition
Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.23 emsMgr::EMSMgr_I::addMultiLayerSubnetwork
Synopsis
void addMultiLayerSubnetwork(in MultiLayerSubnetworkData_T npData)raises(globaldefs::ProcessingFailureException);This API enables the OSS to add a new subnet partition.
Parameters
npData
MultiLayerSubnetworkData_T
—
—
in
Subnet partition data
—
—
The structure for SubNetworkPartitionData_T is as follows:
struct MultiLayerSubnetworkData_T{string name;string title;string userLabel;SubNetType_T type;SubnetToplogy_T topology;string npId;};The description of each parameter is as follows:
enum SubNetType_T{ SONET, SDH, OTHER, UNKNOWNSUBNETTYPE};enum SubnetToplogy_T{OTHER_SUBNET_TYPE, POINT_TO_POINT, LINEAR, UPSR, SNC, BLSR, MSSP, OPEN_UPSR, OPEN_SNC, HYBRID, MESH, SINGLETON, UNKNOWN_SUBNET_TYPE};Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.24 emsMgr::EMSMgr_I::deleteAndPurgeManagedElement
Synopsis
boolean deleteAndPurgeManagedElement(in string neName) raises(globaldefs::ProcessingFailureException);Description
This API enables the OSS to delete a NE.
Parameters
Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.25 emsMgr::EMSMgr_I::deleteNetworkPartition
Synopsis
void deleteNetworkPartition(in string name) raises(globaldefs::ProcessingFailureException);This API enables the OSS to delete an existing network partition.
Parameters
Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.26 emsMgr::EMSMgr_I::deleteMultiLayerSubnetwork
Synopsis
void deleteMultiLayerSubnetwork(in string subnetworkName)raises(globaldefs::ProcessingFailureException);Description
This API enables the OSS to delete an existing network partition.
Parameters
Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.27 emsMgr::EMSMgr_I::addSWVersion
Synopsis
void addSWVersion (in SoftwareVersionTable_T versionData) raises(globaldefs::ProcessingFailureException);Description
This API enables the OSS to add a new software version to the supported NE version table.
Parameters
versionData
SoftwareVersionTable_T
In
The input details for the addition of a new software version
struct SoftwareVersionTable_T{NEModel model;string olderSWVersion;string newSWVersion;string versionName;};Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.2.28 emsMgr::EMSMgr_I::getAllSupportedMESoftwareVersions
Synopsis
void getAllSupportedMESoftwareVersions(in unsigned long how_many,out SupportedMESoftwareVersionList_T versionList,out SupportedMESoftwareVersionIterator_I versionIt)raises(globaldefs::ProcessingFailureException);Description
This API enables the OSS to add a new software version to the supported NE version table.
Parameters
struct SupportedMESoftwareVersion_T{string model;string swversion;string versionName;};typedef sequence<SupportedMESoftwareVersion_T> SupportedMESoftwareVersionList_T;interface SupportedMESoftwareVersionIterator_I{boolean next_n(in unsigned long how_many,out SupportedMESoftwareVersionList_T neVersionList)raises (globaldefs::ProcessingFailureException);unsigned long getLength()raises(globaldefs::ProcessingFailureException);void destroy()raises(globaldefs::ProcessingFailureException);};Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.3 emsSession::EmsSession_I
The emsSession module enables the client to query the EMS to determine the manager interfaces the EMS is supporting. The NMS retrieves an instance of the needed manager interface objects. This interface is inherited from session::Session_I.
interface EmsSession_I:session::Session_I3.3.1 emsSession::EmsSession_I::getEventChannel
Synopsis
void getEventChannel(out CosNotifyChannelAdmin::EventChannel eventChannel)raises(globaldefs::ProcessingFailureException);Description
This operation 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
eventChannel
CosNotifyChannelAdmin::EventChannel
Out
Event channel that the NMS uses
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - This exception indicates a non-specific internal EMS failure.Compliance
TMF-defined.
3.3.2 emsSession::EmsSession_I::getManager
Synopsis
void getManager(in string managerName,out common::Common_I managerInterface)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to access the specified manager interface.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - This exception indicates that the EMS does not support the manager.EXCPT_INTERNAL_ERROR - This exception indicates a non-specific internal EMS failure.Compliance
TMF-defined.
3.3.3 emsSession::EmsSession_I::getSupportedManagers
Synopsis
void getSupportedManagers(out managerNames_T supportedManagerList)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request the manager interfaces that the EMS implements.
Parameters
Throws
None.
Compliance
TMF-defined.
3.4 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_I3.4.1 emsSessionFactory::EmsSessionFactory_I::getEmsSession
Synopsis
void getEmsSession(in string user,in string password,in nmsSession::NmsSession_I client,out emsSession::EmsSession_I emsSessionInterface)raises(globaldefs::ProcessingFailureException);Description
This operation 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 Naming Service IOR File, page B-6 for configuring the number of concurrent login sessions. The username and password must contain between 1 and 53 characters.
This operation 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
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of a non-specific internal EMS failure.EXCPT_INVALID_INPUT - Raised when client is invalid or when the length of User name 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.4.2 emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey
Synopsis
void getEmsPublicKey(out string publicKey)raises(globaldefs::ProcessingFailureException);Description
This operation 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 RSApublic 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
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.4.3 emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair
Synopsis
void getEmsPublicKeyPair(out string publicKeyModulus,out string publicKeyExponent)raises(globaldefs::ProcessingFailureException);Description
This operation 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
publicKeyModulus
string
Out
The public key modulus string returned by CTM.
publicKeyExponent
string
Out
The public key exponent string returned by CTM.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.5 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_IThis interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.5.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 operation enables an NMS to request all of the equipment and equipment holders contained in a managed element or equipment holder.
Parameters
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 forEquipment_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
•
–
•
–
•
–
•
–
CTM support for EquipmentHolder_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
–
•
–
•
–
–
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
G1000_4
(Only when XC10G is installed in slot 8 or 10)
1, 2, 3, 4, 14, 15, 16, 17
OC12_4
(Only when XC10G is installed in slot 8 or 10)
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
TXP_G1000_41
1 The same physical card as was supported in the previous release, but with a different software image.
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
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
MUX32_O, DMX32_O1
8, 10
OSCM
1, 2, 4, 5, 6, 12, 13, 14, 16, 17
DS3I
3, 15
DS3I, DS3IN
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
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
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
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, 2.5-10G_Muxponder, 10G_MR_Transponder, OPT_BST_E
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
MUX32_O, DMX32_O, WSS_32, DMX32_R1
8, 10
OSCM
7, 11
TCC2P
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
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
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
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17
G1000_41
1 Same physical card as supported in previous release but with different software image
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
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
MUX32_O, DMX32_O1
8, 10
OSCM
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.
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
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.
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, 2.5-10G_Muxponder, 10G_MR_Transponder, OPT_BST_E
1, 2, 3, 4, 5, 12, 13, 14, 15, 16
MUX32_O, DMX32_O, WSS_32, DMX32_R1
8, 10
OSCM
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.
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
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
1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.
ONS 15327 supports the following value for all releases:
151
CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S
13-142
LSM-W
163
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 2.2.5.6.17 ONS 15800 and ONS 15801, page 2-63
1 This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see 2.2.5.6.17 ONS 15800 and ONS 15801, page 2-63) can be inserted into the slot.
2 Same as (1).
3 Same as (1).
ONS 15801 supports the following values
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 2.2.5.6.17 ONS 15800 and ONS 15801, page 2-63
1 This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see 2.2.5.6.17 ONS 15800 and ONS 15801, page 2-63) can be inserted into the slot
ONS 15808 supports the following values
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 2.2.5.6.18 ONS 15808, page 2-65)
1 This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see 2.2.5.6.18 ONS 15808, page 2-65) can be inserted into the slot.
ONS 15302 supports the following values
ONS 15305 and ONS 15305 CTC support the following values:
1, 2, 3, 4
All equipment listed in 2.2.5.6.6 ONS 15305 and ONS 15305 CTC, page 2-54
ONS 15216 supports the following values
ONS 15600 support the following values:
5, 10
TXC
6/7, 8/9
CXC
1, 2, 3, 4, 11, 12, 13, 14
OC48_16, OC192_4
5, 10
TXC
6/7, 8/9
SSXC [new cross-connect card]
1, 2, 3, 4, 11, 12, 13, 14
OC48_16, OC192_4, OC48_32
1, 2, 3, 4, 11, 12, 13, 14
ASAP
5, 10
TXC
6/7, 8/9
CXC
1, 2, 3, 4, 11, 12, 13, 14
STM16_16, STM64_4
3, 4
CTX-2500 and CTX-FILLER
1, 2, 5, 6
DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3, and DS3-EC-6
1, 2, 5, 6
CE-100T-8, ML2-100T-8, and EXP-FILLER
Compliance
TMF-defined.
3.5.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 operation has exactly the same behavior as the operation described in equipment::EquipmentInventoryMgr_I::getAllEquipment, but returns the object names instead of returning the entire object.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.5.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 operation 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.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Parameters
CTM support for TerminationPoint_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
CTM supports the following parameters for PTP
Note
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.5.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 operation has exactly the same behavior as the operation described in equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs, but returns the object names instead of returning the entire objects.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators (128) has been reached.Compliance
TMF-defined.
3.5.5 equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
Synopsis
void getAllSupportingEquipment(in globaldefs::NamingAttributes_T ptpName,out EquipmentOrHolderList_T eqList)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request the equipment that contains this PTP.
Parameters
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For further details on both structures, see equipment::EquipmentInventoryMgr_I::getAllEquipment.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.5.6 equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
NamesSynopsis
void getAllSupportingEquipmentNames(in globaldefs::NamingAttributes_T ptpName,out globaldefs::NamingAttributesList_T nameList)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment, but returns the object names instead of returning the entire objects.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.5.7 equipment::EquipmentInventoryMgr_I::getContainedEquipment
Synopsis
void getContainedEquipment(in globaldefs::NamingAttributes_T equipmentHolderName,out EquipmentOrHolderList_T equipmentOrHolderList)raises(globaldefs::ProcessingFailureException);Description
This operation returns the equipment and equipment holders that a specific equipment holder contains. This operation differs from getAllEquipment in that it looks only at the next level of the containment hierarchy.
Parameters
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For further details on both structures, see equipment::EquipmentInventoryMgr_I::getAllEquipment.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 communications to managedElement is lost.Compliance
TMF-defined.
3.5.8 equipment::EquipmentInventoryMgr_I::getEquipment
Synopsis
void getEquipment(in globaldefs::NamingAttributes_T equipmentOrHolderName,out EquipmentOrHolder_T equip)raises(globaldefs::ProcessingFailureException);Description
This service returns the equipment or equipment holder for specific equipment or equipment holder name.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 managedElement is lost.Compliance
TMF-defined.
3.5.9 equipment::EquipmentInventoryMgr_I::provisionEquipment
Synopsis
void provisionEquipment(in EQTCreateData_T equipmentCreateData,out Equipment_T createdEquipment)raises(globaldefs::ProcessingFailureException);Description
This operation 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 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 StateChangeEvent on the holder state change and an ObjectCreationEvent for the equipment, and pushes them to the event channel.
It is important to note that Cisco ONS 15454 SONET detects new equipment and provisions it automatically, provided that the equipment holder (slot) is empty and 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.
In 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.
This operation is supported only for the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15310 CL, ONS 15310 MA, ONS 15600, and ONS 15600 SDH.
Parameters
equipmentCreateData
EQTCreateData_T
In
Data that describes the equipment to create
createdEquipment
Equipment_T
Out
The resulting created equipment
CTM support for EQTCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 managedElement is lost.Compliance
TMF-defined.
3.5.10 equipment::EquipmentInventoryMgr_I::setAlarmReportingOff
Synopsis
void setAlarmReportingOff(in globaldefs::NamingAttributes_T equipmentOrHolderName)raises(globaldefs::ProcessingFailureException);Description
This operation disables alarm reporting on a piece of equipment. The CTM sends a warning alarm notification if successful.
This operation is supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, ONS 15310 MA, and ONS 15310 CL.
Parameters
equipmentOrHolderName
Globaldefs::NamingAttributes_T
In
The equipment on which to deactivate alarm reporting
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 managedElement is lost.Compliance
TMF-defined.
3.5.11 equipment::EquipmentInventoryMgr_I::setAlarmReportingOn
Synopsis
void setAlarmReportingOn(in globaldefs::NamingAttributes_T equipmentOrHolderName)raises(globaldefs::ProcessingFailureException);Description
This operation 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.
This operation is supported for the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, ONS 15310 MA, and ONS 15310 CL.
Parameters
equipmentOrHolderName
globaldefs::NamingAttributes_T
In
The equipment on which to activate alarm reporting
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Rraised 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 managedElement is lost.Compliance
TMF-defined.
3.5.12 equipment::EquipmentInventoryMgr_I::unprovisionEquipment
Synopsis
void unprovisionEquipment(in globaldefs::NamingAttributes_T equipmentName)raises(globaldefs::ProcessingFailureException);Description
This operation 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 its related objects, such as termination points.
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 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 one 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 StateChangeEvent on the holder state change and an ObjectDeletionEvent for the equipment, and pushes them to the event channel.
ONS 15454 reserves Slot 7 and 11 for TCC. One of these slots will have an IN SERVICE TCC card. If the NMS invokes unprovisionEquipment on this equipment, CTM throws the EXCPT_UNABLE_TO_COMPLY exception.
This operation is supported only for the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15310 MA, ONS 15600 SDH, and ONS 15310 CL.
Parameters
equipmentName
globaldefs::NamingAttributes_T
In
The name of the equipment to be unprovisioned
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific 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 managedElement is lost.Compliance
TMF-defined.
3.5.13 equipment::EquipmentInventoryMgr_I::configureMLParameters
Synopsis
void configureMLParameters(in globaldefs::NamingAttributes_T equipmentOrHolderName,in globaldefs::NVSList_T paramListraises(globaldefs::ProcessingFailureException);Description
This operation enables provisioning of fast Ethernet and POS configuration parameters on the ML cards. The operation is performed on a best-effort basis and CTM will not validate the parameter names and the values being passed to the API.
If the operation is unsuccessful, CTM throws a ProcessingFailureException.
This operation enables the user to configure the following POS parameters:
•
•
•
Note
•
•
•
–
–
–
–
•
•
•
–
•
•
•
Note
This operation is supported only on ML cards.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failureEXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference a valid objectEXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does not existEXCPT_NE_COMM_LOSS - Raised when communications to the managed element is lostEXCPT_UNABLE_TO_COMPLY - Raised when CTM fails to configure the ML card parameters as requested.Compliance
CTM-defined.
3.6 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_IThis interface also implements the getCapabilities method. Operations described in the following subsections are returned to the NMS when it invokes getCapabilities.
3.6.1 maintenanceOps::MaintenanceMgr_I::getActiveMaintenanceOperations
Synopsis
void getActiveMaintenanceOperations(in globaldefs::NamingAttributes_T tpOrMeName,in unsigned long how_many,out CurrentMaintenanceOperationList_TcurrentMaintenanceOpeationList,out CurrentMaintenanceOperationIterator_I cmoIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables the NMS to query the EMS to determine if any persistent maintenance commands have been invoked. This query is supported for the PTP, CTP, or ME object.
This operation is supported only for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, ONS 15310 MA, and ONS 15310 CL.
Parameters
CTM support for CurrentMaintenanceOperation structure is as follows:
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if EMS does not support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpOrMeName does not reference a valid object.EXCPT_ENTITY_NOT_FOUND - Raised when tpOrMeName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the ME is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.6.2 maintenanceOps::MaintenanceMgr_I::performMaintenanceOperation
Synopsis
void performMaintenanceOperation(in CurrentMaintenanceOperation_T maintenanceOperation,in MaintenanceOperationMode_T maintenanceOperationMode)raises(globaldefs::ProcessingFailureException);Description
This operation enables the NMS to operate and release the maintenance commands that are supported by a TP.
This operation is only supported for the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, ONS 15310 MA, and ONS 15310 CL.
ONS 15310 CL and ONS 15310 MA
CTM supports only terminal and facility loopback operations for electrical and OCn PTPs.
CTM does not support loopback operations for CTPs.
ONS 15327 SONET
CTM supports only terminal and facility loopback operations for DSn and OCn PTPs.
CTM does not support loopback operations for CTPs.
For NE Release 3.4 or later of the ONS 15327 SONET, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.
ONS 15454 SDH
CTM supports only terminal and facility loopback operations for PTPs.
CTM does not support loopback operations for CTPs.
For NE Release 3.4 or later of the ONS 15454, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.
ONS 15454 SONET
CTM supports only terminal and facility loopback operations for DSn, OCn, EC1, 10G-transponder, 10G-muxponder, and G1000_4 (NE release 4.1 and later) PTPs.
Only facility loopback is supported for DS1 CTPs on DX3XM cards.
Only terminal loopback is supported on G1000_4 for NE releases earlier than R4.1.
For NE Release 3.4 or later of the ONS 15454 SONET, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.
ONS 15600 SDH
CTM supports only terminal and facility loopback operations for PTPs.
CTM does not support loopback operations for CTPs.
Loopback is supported only in the Out of Service-Maintenance state of the PTP.
CTM ignores the MaintenanceOperation_T value in CurrentMaintenanceOperation_T structure, if MaintenanceOperationMode_T is set to MOM_RELEASE.
ONS 15600 SONET
CTM supports only facility and payload loopback operations for PTPs.
CTM does not support loopback operations for CTPs.
Loopback is supported only in the Out of Service-Maintenance state of the PTP.
CTM ignores the MaintenanceOperation_T value in CurrentMaintenanceOperation_T structure, if MaintenanceOperationMode_T is set to MOM_RELEASE.
Parameters
CTM support for CurrentMaintenanceOperation_T structure is as follows:
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a TP.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the operation is denied by the ME.EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.Compliance
TMF-defined.
3.7 managedElementManager::ManagedElementManager_I
This interface accesses operations that deal with MEs and TPs. A handle to an instance of this interface is gained through the getManager operation in emsSession.
interface ManagedElementManager_I:common::Common_IThis interface also implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.7.1 managedElementManager::ManagedElementManager_I::getAllActiveAlarms
Synopsis
void getAllActiveAlarms(in globaldefs::NamingAttributes_T meName,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 operation enables an NMS to request all active alarms for the specified ME, excluding alarms that the ME does not report to CTM. Some alarms can be filtered out (excluded) by specifying their probable causes or severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL
The ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600 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 also reported in the eventList returned by this method as ONS 15540, ONS 15530, and ONS 15501 send "clear" for the threshold crossing alarms.
ONS 15800, ONS 15801, and ONS 15808
ONS 15800, ONS 15801, and ONS 15808 alarms that are retrieved using CTM GateWay/CORBA have OT_EQUIPMENT as the object_type field.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when meName does not reference a managed element object or excludeProbCauseList contains undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when meName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.2 managedElementManager::ManagedElementManager_I::getAllSNCs
Synopsis
void getAllSNCs(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SNCIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request all SNCs that originate on, terminate on, or transit through a given ME.
•
•
•
•
This method will not report VCAT SNCs.
CTM supports this operation only for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
Parameters
CTM support for SubnetworkConnection_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
Note
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element.EXCPT_ENTITY_NOT_FOUND - Raised when meName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.3 managedElementManager::ManagedElementManager_I::
getAllManagedElementsSynopsis
void getAllManagedElements(in unsigned long how_many,out managedElement::ManagedElementList_T meList,out managedElement::ManagedElementIterator_I meIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request details about all MEs that are under the control of ManagedElementMgr_I.
Parameters
CTM support for ManagedElement_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
CTM will support the following layer rates:
–
LR_T1_and_DS1_1_5M
LR_T3_and_DS3_45M
LR_VT1_5_and_TU11_VC11
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS6c_and_VC4_2c
LR_STS12c_and_VC4_4c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c (Supported on ONS 15454 Release 3.1 or later)
LR_STS9c_and_VC4_3c (Supported on ONS 15454 Release 3.2 or later, and ONS 15327 Release 3.3 or later)
LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later, and ONS 15327 Release 3.3 or later)
–
LR_E1_2M (Supported on ONS 15454 SDH Release 4.0 or later)
LR_E3_34M (Supported on ONS 15454 SDH Release 4.0 or later)
LR_T3_and_DS3_45M (Supported on ONS 15454 SDH Release 4.0 or later)
LR_VT2_and_TU12_VC12 (Supported on ONS 15454 SDH Release 4.0 or later)
LR_Low_Order_TU3_VC3 (Supported on ONS 15454 SDH Release 4.0 or later)
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS24c_and_VC4_8c
LR_STS18c_and_VC4_6c (Supported on ONS 15454, 15327, and ONS 15454 SDH Release 5.0 or later)
LR_STS36c_and_VC4_12c (Supported on ONS 15454, 15327, and ONS 15454 SDH Release 5.0 or later)
–
LR_Section_OC3_STS3_and_RS_STM1
LR_Section_OC12_STS12_and_RS_STM4
LR_Section_OC48_STS48_and_RS_STM16
LR_Line_OC3_STS3_and_MS_STM1
LR_Line_OC12_STS12_and_MS_STM4
LR_Line_OC48_STS48_and_MS_STM16
LR_Optical_Channel
LR_Optical_Multiplex_Section
LR_Optical_Transmission_Section
LR_ESCON
LR_Fast_Ethernet
LR_FC_100_1063M
LR_FDDI
LR_FICON
LR_Gigabit_Ethernet
LR_SYSPLEX_ISC_COMP
LR_SYSPLEX_ISC_PEER
LR_SYSPLEX_TIMER_ETR
LR_SYSPLEX_TIMER_CLO
LR_Ten_Gigabit_Ethernet
LR_PHYSICAL_OPTICAL
–
All layer rates supported by the ONS15540
LR_PHYSICAL_ELECTRICAL
–
LR_Optical_Channel
LR_Optical_Multiplex_Section
LR_Optical_Transmission_Section
LR_PHYSICAL_OPTICAL
–
LR_PHYSICAL_OPTICAL
–
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
–
Not supported.
–
Not supported.
•
Supported. Two parameters is sent in this field:
–
–
PreProvisioned
False
InServiceSyncConfiguration
False
OutOfService
False
UnderMaintenance
False
InServiceIntializing
False
InService
True
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.4 managedElementManager::ManagedElementManager_I::
getAllManagedElementNamesSynopsis
void getAllManagedElementNames(in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has the same behavior as managedElementManager::ManagedElementManager_I:: getAllManagedElements, but instead of returning the entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.5 managedElementManager::ManagedElementManager_I::getAllPTPs
Synopsis
void getAllPTPs(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRateList_T tpLayerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This operation allows an NMS to request all PTPs on a specific ME that contain one or more NMS-specified PTP layer rates, and that are capable of supporting one or more NMS-specified connection layer rates. If no PTPs match the layer constraints, an empty list is returned. A PTP is returned regardless of connectivity to other MEs or position in the subnetwork. (Both PTPs at the subnetwork edge and PTPs that are internal to the subnetwork are reported.)
For PTPs on protection equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the PTPs.
This method also returns a list of front Ethernet ports on an ML-series card on the specified ManagedElement.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Parameters
For details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
CTM supports the following layer rates:
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
•
–
–
–
–
•
–
•
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.6 managedElementManager::ManagedElementManager_I::
getAllPTPNamesSynopsis
void getAllPTPNames(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRateList_T tpLayerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in managedElementManager::ManagedElementManager_I::getAllPTPs, but instead of returning the entire object structures, this operation returns their names.
CTM supports this operation only for CRS-1, ONS 15454 SONET, ONS 15454 SDH, ONS 15310 MA, ONS 15310 CL, ONS 15327, ONS 15600, ONS 15600 SDH, ONS 15540, ONS 15302, ONS 15305, ONS 15305 CTC, ONS 158xx, and XR 12000 NEs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.7 managedElementManager::ManagedElementManager_I::
getContainedInUseTPsSynopsis
void getContainedInUseTPs(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This service retrieves the in-use CTPs contained in a specific PTP, at specific layer rates. An in-use CTP is a CTP used by an SNC in any state (including pending) or a CTP that is terminated and mapped.
Example for SONET: The NMS invokes this method on an OC3 PTP (and assumes that the NE does not have an XCVT card, so VT-level cross-connects are not possible) with an empty layerRateList.
•
•
Example for SDH: The NMS invokes this method on an STM1 PTP (and assumes that the NE does not have an XC10G card, so VC12-level cross-connects are not possible) with an empty layerRateList.
•
•
Note
Parameters
For details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
CTM supports the following layer rates for layerRateList parameters:
•
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.8 managedElementManager::ManagedElementManager_I::
getContainedInUseTPNamesSynopsis
void getContainedInUseTPNames(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in managedElementManager::ManagedElementManager_I:: getContainedInUseTPs, but instead of returning the entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.9 managedElementManager::ManagedElementManager_I::
getContainedPotentialTPsSynopsis
void getContainedPotentialTPs(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request all the CTPs it can support in all possible mapping configurations, at specified rates and TPs. This service returns all potential contained CTPs for a specific TP. The TP might be a PTP or a CTP. If the layerRateList is empty, contained CTPs at all flexible and static LayerRates are returned.
Note
For example (on an ONS 15454 SONET NE), the NMS invokes this method on an OC-3 PTP (assuming that the NE does not have an XCVT card, so VT-level cross-connects are not possible) with an empty layerRateList. Regardless of the number of SNCs, CTM returns four CTPs: three at STS-1 layer rate and one at STS3c layer rate.
Parameters
For details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
CTM supports the following layer rates for the layerRateList parameter:
•
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object.EXCPT_TP_INVALID_ENDPOINT - Raised when tpName refers to a PTP (and all contained potential CTPs) which is part of Topological Link.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.10 managedElementManager::ManagedElementManager_I::
getContainedPotentialTPNamesSynopsis
void getContainedPotentialTPNames(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object.EXCPT_TP_INVALID_ENDPOINT - Raised when tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.7.11 managedElementManager::ManagedElementManager_I::
getContainingSubnetworkNamesSynopsis
void getContainingSubnetworkNames(in globaldefs::NamingAttributes_T managedElementName,out globaldefs::NamingAttributesList_T subnetNames)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of subnetwork names to which the ME (supplied as an input parameter) belongs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.7.12 managedElementManager::ManagedElementManager_I::
getManagedElementSynopsis
void getManagedElement(in globaldefs::NamingAttributes_T managedElementName,out managedElement::ManagedElement_T me)raises(globaldefs::ProcessingFailureException);Description
This operation returns the Managed Element for a specific managed element name.
Parameters
managedElementName
globaldefs::NamingAttributes_T
In
Name of the ME to retrieve
me
managedElement::ManagedElement_T
Out
The retrieved ME
For details on ManagedElement_T structure, see managedElementManager::ManagedElementManager_I:: getAllManagedElements.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to the managed element is lost.Compliance
TMF-defined.
3.7.13 managedElementManager::ManagedElementManager_I::getTP
Synopsis
void getTP(in globaldefs::NamingAttributes_T tpName,out terminationPoint::TerminationPoint_T tp)raises(globaldefs::ProcessingFailureException);Description
This operation returns the TP structure for a specific TP name.
For the PTP on protection equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of that PTP.
Parameters
tpName
globaldefs::NamingAttributes_T
In
Name of the TP to retrieve
tp
terminationPoint::TerminationPoint_T
Out
Retrieved TP
For details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a termination point object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a TP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.7.14 managedElementManager::ManagedElementManager_I::
getAssociatedTopologicalLinksSynopsis
void getAssociatedTopologicalLinks(in globaldefs::NamingAttributes_T ptpName,out topologicalLink::TopologicalLink_T topologicalLinks)raises(globaldefs::ProcessingFailureException);Description
This operation enables the NMS to pass the TP name. CTM supports multilayer topological links and returns a list of topological links through the TP.
CTM reports all the physical optical and manual topological links.
Note
Parameters
For details on TopologicalLink_T structure, see emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when ptpName does not reference a physical termination point object.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.15 managedElementManager::ManagedElementManager_I::setTPData
Synopsis
void setTPData(in subnetworkConnection::TPData_T tpInfo,out terminationPoint::TerminationPoint_T modifiedTP)raises(globaldefs::ProcessingFailureException);Description
This service allows the NMS to set parameters on a specific TP. The results tell the NMS which modifications succeeded.
CTM supports the following parameters for CTPs:
•
•
•
•
•
To completely remove path trace, the NMS must set TrailTraceMonitor to Off and TrailTraceExpectedRx to an empty string in one call.
If the NMS sends only TrailTraceExpectedRx, CTM sets TrailTraceMonitor to On and sets the value of the expected string. If TrailTraceExpectedRx contains an empty string as the only parameter in the call, CTM changes TrailTraceMonitor to On and sets the expected string to an empty string. To completely remove the path trace, the NMS must set TrailTraceMonitor to Off and set TrailTraceExpectedRx to an empty string in one call.
CTM supports supports the following parameters for PTPs:
•
•
•
•
•
•
•
SDH_SONET_SS_BITS parameter can be modified only when EnableSyncMsg is Off. EnableSyncMsg can be set to On only if SDH_SONET_SS_BITS is set to SONET.
SDH_SONET_SS_BITS and EnableSyncMsg parameters must be modified by invoking two separate method calls: both SDH_SONET_SS_BITS and EnableSyncMsg.
Note
CTM throws ProcessingFailureException when such an attempt is made.
CTM also supports the following automatic laser shutdown parameters (on PTP). These parameters are not defined by TMF.
•
•
•
•
If the equipment is the protecting equipment in a 1_For_N protection group, CTM sets the PTPs on the equipment to AlarmReporting.
CTM supports the following parameters for FTPs:
•
•
For valid values for each parameter, see Table 3-1 in equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
You must use the CTM client to set other TP parameters.
Note
Invoking this method from the NMS is a synchronous call.
Parameters
tpInfo
subnetworkConnection::TPData_T
In
Details about required modifications
modifiedTP
terminationPoint::TerminationPoint_T
Out
Result of modification
For details of TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
CTM support for TPData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the TP referred to in tpInfo does not exist.EXCPT_INVALID_INPUT - Raised when tpInfo does not reference a valid CTP object.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.7.16 managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSNCProvisioningSynopsis
void getAllSrcPTPsForSNCProvisioning(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns a list of PTP names that can be used as the source of an SNC to create on a given ME. The NMS must specify the layer rate and the direction of the SNC to create. This method does not reserve resources for SNC creation; rather, this method returns a PTP name list based on current resource availability. The actual SNC creation might still fail.
Note
Parameters
CTM supports the following layer rate values:
•
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managedElement does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.17 managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSNCProvisioningSynopsis
void getAllSrcCTPsForSNCProvisioning(in globaldefs::NamingAttributes_T ptpName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns a list of CTP names that can be used as the source of an SNC to create on a given ME. The NMS must specify the layer rate and the direction of the SNC to create. This method does not reserve resources for SNC creation; rather, this method returns a CTP name list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as aEnd in the SNCCreateData_T parameter of the createAndActivateSNCFromUserLabel method described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel.
Note
Parameters
CTM supports the following layer rate values:
•
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managedElement does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.18 managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSNCProvisioningSynopsis
void getAllDestPTP namesForSNCProvisioning(in globaldefs::NamingAttributes_T managedElementName,in globaldefs::NamingAttributes_T srcCTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T ptpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns a list of PTP names that can be used as the destination of an SNC to create on a given ME. The NMS must specify the source CTP name, layer rate, and the direction of the SNC to create. This method does not reserve resources for SNC creation; rather, this method returns a PTP name list based on current resource availability. The actual SNC creation might still fail.
Note
Parameters
CTM supports the following layer rate values:
•
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the ptp does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.19 managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSNCProvisioningSynopsis
void getAllDestCTP namesForSNCProvisioning(in globaldefs::NamingAttributes_T ptpName,in globaldefs::NamingAttributes_T srcCTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T ctpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns a list of CTP names that can be used as the destination of an SNC to created on a given PTP. The NMS must specify the source CTP name (or source FTP name, in the case of VC3 port grouping circuits that have the source on E3, DS3I, or DS3IN cards), layer rate, and the direction of the SNC to create. This method does not reserve resources for SNC creation. Rather, this method returns a CTP list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as zEnd in SNCCreateData_T parameter of multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel.
Note
Parameters
CTM supports the following layer rate values:
•
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the ptp does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.20 managedElementManager::ManagedElementManager_I::
getAllSrcFTPsForSNCProvisioningSynopsis
void getAllSrcFTPsForSNCProvisioning(in globaldefs::NamingAttributes_T meName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException)Description
This method returns the list of FTP names that can be used as the source of an SNC to be created on a given managed element. The NMS must specify the layer rate of the SNC that is created. This method does not reserve resources for the SNC creation; it only returns the FTP name list based on resource availability at that particular time. It is possible that the actual SNC creation might fail. Values returned by this list can be used as aEnd in the SNCCreateData_T parameter of the createAndActivateSNCFromUserLabel method described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel.
This method is supported only for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, and ONS 15310 NEs.
Parameters
CTM supports the following layer rate values:
•
•
•
•
•
•
•
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managedElement does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.21 managedElementManager::ManagedElementManager_I::
getAllDestFTPsForSNCProvisioningSynopsis
void getAllDestFTPsForSNCProvisioning(in globaldefs::NamingAttributes_T meName,in globaldefs::NamingAttributes_T srcTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns the list of FTP names that can be used as the destination of an SNC to create on a specific managed element. The NMS must specify the source TP (CTP or FTP) name and layer rate of the SNC to create. This method does not reserve resources for the SNC creation. It only returns the FTP name list based on resource availability at that particular time. It is possible that the actual SNC creation might fail. Values returned by this list can be used as zEnd in the SNCCreateData_T parameter of the createAndActivateSNCFromUserLabel method described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel.
This method is supported only for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, and ONS 15310 NEs.
Parameters
CTM supports the following layer rate values:
•
•
•
•
•
•
•
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managedElement does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.22 managedElementManager::ManagedElementManager_I::
forceNEResyncSynopsis
void forceNEResync(in globaldefs::NamingAttributes_T meNameraises(globaldefs::ProcessingFailureException);Description
This method forces CTM to resynchronize the inventory and alarms of the specified ManagedElement. This method is an asynchronous call and return after basic validation. The ManagedElement is then queued for resynchronization. CTM generates a StateChange event indicating that the emsInSyncState has changed to False. Upon successful completion of resynchronization, CTM generates a StateChange event indicating that the emsInSyncState attribute has changed to True. An entry is made in the CTM error log if the resynchronization fails.
Note
Parameters
meName
globaldefs::NamingAttributes_T
In
Name of the ManagedElement to be resynched
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the ManagedElement is in the intial poll state or if the ManagedElement is already in the resynchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the ManagedElement does not exist.EXCPT_INVALID_INPUT - Raised if the ManagedElement name is invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.7.23 managedElementManager::ManagedElementManager_I::
getAllTopologicalLinksForMESynopsis
void getAllTopologicalLinksForME(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out topologicalLink::TopologicalLinkList_T topoList,out topologicalLink::TopologicalLinkIterator_I topoIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of TopologicalLinks originating or terminating on the specified ManagedElement.
Note
Parameters
For details on TopologicalLink_T structure, see emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.7.24 managedElementManager::ManagedElementManager_I::
getAllRollsSynopsis
void getAllRolls(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out multiLayerSubnetwork::RollList_T rollList,out multiLayerSubnetwork::RollIterator_I rollIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of rolls within the managed element whose name is passed as a parameter.
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
Parameters
Cisco MSM supports Roll_T as follows:
•
Supported. It will contain three tuples: the first tuple contains the EMS name, the second tuple theManagedElement name, and the third tuple the nativeEMSName of this roll.
•
Not supported.
•
Supported. Each roll has a unique name assigned by the Cisco MSM.
•
Not supported.
•
Supported. Possible values are AUTO or MANUAL.
•
Supported. The name of the rollFrom SNC.
•
Supported. The name of the rollTo SNC.
•
Supported. This is name of CTP that is rolled over.
•
Supported. The CTP to which the rollFromCTPName CTP is rolled over.
•
Supported. The following values are supported:
–
–
–
–
•
Supported. It can be TRUE or FALSE.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the ManagedElement is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the ManagedElement does not exist.EXCPT_INVALID_INPUT - Raised if the ManagedElement name is invalid.EXCPT_NE_COMM_LOSS - Raised when communications to ManagedElement is lostEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.7.25 managedElementManager::ManagedElementManager_I::
getAllRollNamesSynopsis
void getAllRollNames(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out globaldefs::NamingAttributesList nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns the list of roll names within the managed element whose name is passed as a parameter.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the ManagedElement is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the ManagedElement does not exist.EXCPT_INVALID_INPUT - Raised if the ManagedElement name is invalid.EXCPT_NE_COMM_LOSS - Raised when communications to ManagedElement is lost.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.7.26 managedElementManager::ManagedElementManager_I::
getRollSynopsis
void getRoll(in globaldefs::NamingAttributes_T rollName,out multiLayerSubnetwork::Roll_T roll,raises(globaldefs::ProcessingFailureException);Description
This operation returns the Roll_T structure for a specific roll name.
Note
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll
Roll
multiLayerSubnetwork::Roll_T
Out
roll object
CTM support for Roll_T is described in managedElementManager::ManagedElementManager_I:: getAllRolls.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the ManagedElement is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the roll does not exist.EXCPT_INVALID_INPUT - Raised if the roll Name is invalid.EXCPT_NE_COMM_LOSS - Raised when communications to ManagedElement is lost.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.7.27 managedElementManager::ManagedElementManager_I::
getRollToPTPsSynopsis
void getRollToPTPs (in globaldefs::NamingAttributes_T meName,in globaldefs::NamingAttributesList_T sncNames,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of PTPs on a Managed Element that can be used for provisioning a roll on a specific SNC; the returned PTPs can be used to contain the rollToCTP. The SNC must be associated with the Managed Element on which the interface is invoked.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the ManagedElement is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the ManagedElement does not exist.EXCPT_INVALID_INPUT - Raised if the ManagedElement name is invalid.EXCPT_NE_COMM_LOSS - Raised when communications to ManagedElement is lost.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.7.28 managedElementManager::ManagedElementManager_I::
getRollToCTPsSynopsis
void getRollToCTPs(in globaldefs::NamingAttributes_T ptpName,in globaldefs::NamingAttributesList_T sncNames,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of CTPs contained in the PTP. This list can be used for roll provisioning as the rollToCTP for a given SNC. The list of PTPs can be obtained by using the operation defined in managedElementManager::ManagedElementManager_I:: getRollToPTPs.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the ManagedElement is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the ManagedElement does not exist.EXCPT_INVALID_INPUT - Raised if the ManagedElement name is invalid.EXCPT_NE_COMM_LOSS - Raised when communications to ManagedElement is lost.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.7.29 managedElementManager::ManagedElementManager_I::
getRollFromCTPsSynopsis
void getRollFromCTPs(in globaldefs::NamingAttributes_T meName,in globaldefs::NamingAttributesList_T sncNames,in globaldefs::NamingAttributes_T fixCTPName,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 of ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
This interface returns a list of rollFromCTPNames after selecting the fixed point of the roll. This is needed for UPSR SNCs and SNCs that have a secondary source, as multiple rollFromCTP values are possible.
This interface also returns the list of CTPs that can be used to populate the rollFromCTP data structure in the RollCreateData_T data structure.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the cancellation of rolling operation.EXCPT_UNABLE_TO_COMPLY - Raised when the roll cannot be created.Compliance
CTM-defined.
3.7.30 managedElementManager::ManagedElementManager_I::setPortName
Synopsis
void setPortName(in globaldef::NamningAttributes_T ptpName,in string portName,out string newPortName)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to set a name for the selected port. The PTP specified as input identifies the port. The port name is set to the value passed in through the portName parameter.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when the ptpName does not refer to a valid PTP name or when it contains undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references an object that does not exist.Compliance
CTM-defined.
3.7.31 managedElementManager::ManagedElementManager_I::getPortName
Synopsis
void setPortName(in globaldef::NamningAttributes_T ptpName,out string PortName)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to get a name for the selected port. The PTP specified as input identifies the port. The resulting port name is used as the argument parameter.
Parameters
ptpName
globaldefs::NamingAttributesList_T
In
Name of the PTP whose name needs to be set.
portName
String
Out
The port name specified for the input PTP.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when the ptpName does not refer to a valid PTP name or when it contains undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references an object that does not exist.Compliance
CTM-defined.
3.7.32 managedElementManager::ManagedElementManager_I::
getAllClearedAlarmsSynopsis
void getAllClearedAlarms(in globaldefs::NamingAttributes_T meName,in notifications::ProbablyCauseList_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 operation enables an NMS to request all the cleared and acknowledged alarms for the specified ME. Alarms that are not reported by the ME to the EMS are not reported by this operation. Some alarms may be filtered out by specifying the probable cause of the severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL
The ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, 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, ONS 15530, and ONS 15501 send a "clear" for threshold crossing alarms.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when meName does not reference a managed element object or excludeProbCauseList contains undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when meName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.7.33 managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSTProvisioningSynopsis
void getAllSrcPTPsForSTProvisioning(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRate_T layerRate,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns the list of PTP names that can be used as source of a server trail to create on a given managed element. The NMS must specify the layer rate server trail to create. This method does not reserve resources for the server trail creation. It only returns the PTP name list based on resource availability at that particular time. The actual server trail creation might fail.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managedElement does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.34 managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSTProvisioningSynopsis
void getAllSrcCTPsForSTProvisioning(in globaldefs::NamingAttributes_T ptpName,in transmissionParameters::LayerRate_T layerRate,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns the list of CTP names that can be used as source of a server trail to create on a given PTP. The NMS must specify the layer rate of the STC to create. This method does not reserve resources for the server trail creation. It only returns the CTP name list based on resource availability at that particular time. The actual server trail creation might fail. Values returned by this list can be used as aEnd in the STCreateData_T parameter of the createServerTrailLink method described in emsMgr::EMSMgr_I::createServerTrailLink.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managedElement does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.35 managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSTProvisioningSynopsis
void getAllDestPTPsForSTProvisioning(in globaldefs::NamingAttributes_T managedElementName,in globaldefs::NamingAttributes_T srcCTPName,in transmissionParameters::LayerRate_T layerRate,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns the list of PTP names that can be used as the destination of a server trail to create on a given managed element. The NMS must specify the source CTP name and the layer rate of the server trail to create. This method does not reserve resources for the server trail creation. It just returns the PTP name list based on resource availability at that particular time. The actual server trail creation might fail.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the ptp does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.36 managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSTProvisioningSynopsis
void getAllDestCTPsForSTProvisioning(in globaldefs::NamingAttributes_T ptpName,in globaldefs::NamingAttributes_T srcTPName,in transmissionParameters::LayerRate_T layerRate,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This method returns the list of CTP names that can be used as the destination of a server trail to create on a given PTP. The NMS must specify the source CTP name and layer rate of the server trail to be created. This method does not reserve resources for the server trail creation. It only returns the CTP name list based on resource availability at that particular time. The actual server trail creation might fail. Values returned by this list can be used as zEnd in the STCCreateData_T parameter of the createServerTrailLink method described in emsMgr::EMSMgr_I::createServerTrailLink.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the ptp does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.7.37 managedElementManager::ManagedElementManager_I::
getAllCrossConnectionsSynopsis
void getAllCrossConnections(in globaldefs::NamingAttributes_T m anagedElementName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::CrossConnectList_T ccList,out subnetworkConnection::CCIterator_I ccIt)raises(globaldefs::ProcessingFailureException);Description
This method returns the list of cross-connections on the ManagedElement.
Note
Parameters
A cross connect represents a connection within a single managed element. This structure is primarily used in the specification of routes.
CTM support for CrossConnection_T structure is as follows:
•
Will always be true. CTM will only return CrossConnections for SNC that are in the state SNCState_T.SNCS_ACTIVE state or the SNCState_T.SNCS_PARTIAL state. It determines whether or not the cross-connection in the ME is active.
•
Directionality_T of the cross-connection. CTM returns CD_UNI or CD_BI.
•
CTM always returns ST_SIMPLE.
•
List of TP names at the aEnd of the cross-connection.
•
List of TP names at the zEnd of the cross-connection.
•
This attribute enables the communication from the EMS to the NMS for additional information not explicitly modeled. It is a read-only attribute. CTM does not return any additional information.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_INVALID_INPUT - Raised if managedElementName does not reference a managed element.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
TMF-defined.
3.7.38 managedElementManager::DownloadMESoftware
Synopsis
void DownloadMESoftware(in SWDownloadData data);raises(globaldefs::ProcessingFailureException);Description
This method schedules a software download on a network element.
Parameters
data
SWDownloadData
in
Various input parameters needed to schedule a software download (see the definition below)
struct SWDownloadData{unsigned long year;unsigned long month;unsigned long day;unsigned long hour;unsigned long minute;string userComment;FileSource source;string neName;string downLoadFileName;string remoteServerAddress;string ftpUserName;string ftpPassword;};The following table lists descriptions of each individual parameter
The following is the definition of file source:
enum FileSource{FROM_LOCAL, FROM_SERVER, FROM_REMOTE, FROM_FTP};CTM GateWay/CORBA does not support software download from the local machine.
Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.7.39 managedElementManager::getAllSoftwareDownloadJobs
Synopsis
void getAllSoftwareDownloadJobs(in unsigned long how_many,out JobMonitorList_T jobList)raises(globaldefs::ProcessingFailureException);Description
This operation retrieves the status of all scheduled and completed software download jobs.
Parameters
typedef sequence<JobMonitorData_T> JobMonitorList_T;struct JobMonitorData_T{unsigned long jobId;unsigned long taskId;string taskType;string taskOwner;string neId;string taskStatus;string creationTime;string scheduledTime;string startTime;string endTime;string displayInformation;string userComments;string additionalComments;};The following table lists descriptions of each individual parameter
Throws
globaldefs::ProcessingFailureExceptionCompliance
CTM-defined.
3.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
The multiLayerSubnetworkMgr_I operation is used to gain access to subnetworks and their respective operations. 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 ManagedElementManager_I:common::Common_ImultiLayerSubnetworkMgr_I also implements the getCapabilities method. Operations described in following subsections are returned to the NMS when it invokes getCapabilities.
3.8.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllEdgePoints
Synopsis
void getAllEdgePoints(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T tpLayerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request a list of edge termination points for the specified subnetwork at one or more of the NMS-specified layers that are capable of containing CTPs that can be connected at one or more of the NMS-specified connection layer rates.
CTM reports the PTPs that are not part of the topological link.
Note
Parameters
For details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object, or tpLayerRateList or connectionLayerRateList contain undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllEdgePointNamesSynopsis
getAllEdgePointNamesvoid getAllEdgePointNames(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T layerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request a list of edge termination points for the specified subnetwork at one or more of the NMS-specified layers that are capable of containing CTPs that can be connected at one or more of the NMS-specified connection layer rates.
CTM reports the PTPs that are not part of the topological link.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object or tpLayerRateList or connectionLayerRateList contain undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElementSynopsis
void getAllManagedElementNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request a list of ManagedElements that are associated with the specified subnetwork.
Parameters
For details of ManagedElement_T structure, see managedElementManager::ManagedElementManager_I:: getAllManagedElements.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.4 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllManagedElementNames
Synopsis
void getAllManagedElementNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllManagedElement, but instead of returning the entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.5 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsSynopsis
void getAllSubnetworkConnections(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SNCIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request a list of SNCs for the specified subnetwork at the specified connection rates.
•
•
•
This method does not report duplicate names on SNCs or VCAT SNCs.
Note
Note
•
•
Parameters
For details of SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference an multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references object which does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.6 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsWithTPSynopsis
void getAllSubnetworkConnectionsWithTP(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SNCIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request a list of the SNCs using the specified TP at the specified connection rates. A TP might be a PTP that requires a full list of SNCs using any of its contained CTPs. A TP might be a CTP or FTP that only requires the SNCs using that CTP or FTP. Both end CTPs and intermediate CTPs at the same layer are considered. In all cases, only SNCs that also match the specified connection rate filter are returned.
•
•
This method does not report SNCs with duplicate names.
Note
Note
Parameters
For details of SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised if tpName does not reference a terminationPoint object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.7 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesSynopsis
void getAllSubnetworkConnectionNames(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnections, but instead of returning the entire object structures, this operation returns their names.
Note
Note
•
•
Parameters
For details of SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference an multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references object which does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesWithTPSynopsis
void getAllSubnetworkConnectionNamesWithTP(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnectionsWithTP, but instead of returning the entire object structures, this operation returns their names.
Note
Parameters
For details of SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised if tpName does not reference a terminationPoint object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinks
Synopsis
void getAllTopologicalLinks(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out topologicalLink::TopologicalLinkList_T topoList,out topologicalLink::TopologicalLinkIterator_I topoIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of topological links that exist within the subnetwork whose name is passed as a parameter.
Note
Parameters
For details of TopologicalLink_T structure, see emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.10 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllTopologicalLinkNamesSynopsis
void getAllTopologicalLinkNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation has exactly the same behavior as the operation described in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinks, but instead of returning the entire object structures, this operation returns their names.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.8.11 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getMultiLayerSubnetworkSynopsis
void getMultiLayerSubnetwork(in globaldefs::NamingAttributes_T subnetName,out MultiLayerSubnetwork_T subnetwork)raises(globaldefs::ProcessingFailureException);Description
This operation returns a subnetwork given a subnetwork name.
Parameters
subnetName
globaldefs::NamingAttributes_T
in
Name of the subnetwork.
subnetwork
MultiLayerSubnetwork_T
out
Subnetwork structure returned.
For details of MultiLayerSubnetwork_T structure, see emsMgr::EMSMgr_I::getAllTopLevelSubnetworks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references a multiLayerSubnetwork object that does not exist.Compliance
TMF-defined.
3.8.12 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getCTPsAndTopologicalLinks
Synopsis
void getCTPsAndTopologicalLinks(in globaldefs::NamingAttributes_T sncName,out terminationPoint::TerminationPointList_T ctpList,out topologicalLink::TopologicalLinkList_T topologicalLinkList)raises(globaldefs::ProcessingFailureException);Description
The NMS provides the SNC name, and CTM returns two unordered lists: one list for all CTPs/FTPs and another for all topological links. CTM reports topological links and CTPs/FTPs of the working path for a 1+1, 2-fiber BLSR, or 4-fiber BLSR protected SNC. CTM reports topological links and CTPs/FTPs of both the working and protect paths for a UPSR SNC. An SNC with the source or destination on Ethernet equipment is also supported.
•
•
•
•
This method does not report VCAT SNCs.
The ProcessingFailureException is thrown with the EXCPT_UNABLE_TO_COMPLY exception in all of the above-listed conditions.
Note
Parameters
For details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.
For details on TopologicalLink_T structure, see emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_UNABLE_TO_COMPLY - Raised when invoked on SNC on Etherent Equipment or STS1 SNC on DS1 equipment.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.8.13 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNCSynopsis
void getSNC(in globaldefs::NamingAttributes_T sncName,out subnetworkConnection::SubnetworkConnection_T snc)raises(globaldefs::ProcessingFailureException);Description
This operation returns the SubnetworkConnection structure for the SNC whose name is supplied as a parameter.
•
•
•
•
This method does not report VCAT SNCs.
The ProcessingFailureException is thrown with the EXCPT_UNABLE_TO_COMPLY exception in all of the above-listed conditions.
Note
Parameters
sncName
globaldefs::NamingAttributes_T
in
Name of the subnetwork connection.
snc
subnetworkConnection::SubnetworkConnection_T
out
The SNC structure retrieved.
For details on SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not reference a subnetworkConnection object or when sncName is not unique.EXCPT_UNABLE_TO_COMPLY - Raised when invoked on SNC on Ethernet Equipment or STS1 SNC on DS1 equipment.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.8.14 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNCsByUserLabelSynopsis
void getSNC(in string userLabel,out subnetworkConnection::SubnetworkConnection_T snc)raises(globaldefs::ProcessingFailureException);Description
This operation returns the SubnetworkConnection structure for the SNC whose name is supplied as a parameter.
•
•
•
•
This method will not report VCAT SNCs.
ProcessingFailureException is thrown with the EXCPT_UNABLE_TO_COMPLY exception in all of the above-listed conditions.
Note
Parameters
userLabel
String
in
Name of the subnetwork connection.
snc
subnetworkConnection::SubnetworkConnection_T
out
The SNC structure retrieved.
For details on SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not reference a subnetworkConnection object or when sncName is not unique.EXCPT_UNABLE_TO_COMPLY - Raised when invoked on SNC on Ethernet Equipment or STS1 SNC on DS1 equipment.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.8.15 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getTopologicalLinkSynopsis
void getTopologicalLink(in globaldefs::NamingAttributes_T topoLinkName,out topologicalLink::TopologicalLink_T topoLink)raises(globaldefs::ProcessingFailureException);Description
This operation returns a topological link. CTM reports all autodiscovered and manual topological links.
Note
Parameters
For details on TopologicalLink_T structure, see emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a subnetwork topological link object.EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a subnetwork topological link object that does not exist.Compliance
TMF-defined.
3.8.16 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
createAndActivateSNCFromUserLabelSynopsis
void createAndActivateSNCFromUserLabel(in subnetworkConnection::SNCCreateData_T createData,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This operation provides a way to create and activate a subnetwork connection in one command. It is CTM-specific and not TMF-defined. According to TMF, the SNC name is assigned by the EMS when it creates SNC. However, if NMS wants to control the SNC name, it must use this method. The NMS provides the name of the SNC in the userLabel field of the SNCCreateData input parameter. CTM uses the userLabel value and assign it to the name of the new SNC. CTM also verifies the uniqueness of the name. The operation fails if an SNC with the same name as the userLabel exists. This is an asynchronous operation. Successful completion of this operation only guarantees delivery of the creation request to CTM. Operation on CTPs of this SNC might still fail.
Optionally, you can also provide a description for the SNC by entering it in the additionalCreationInfo field.
CTM cleans up resources if SNC creation fails. For example, if CTM fails to create SNC on the destination node, CTM also cleans up resources on the source node.
If the OCn port is configured for SDH, CTM can create the SNC. CTM supports only those layer rates supported by the NE. However, IPPM and J1 path tracing are not supported for CTPs of this SNC.
FTPs can be used as A ends and Z ends of the SNCs. A typical use of FTP is to create an SNC on Ethernet equipment, create a tunnel SNC, or create a VAP/LAP circuit. See 2.2.7 Provisioning Subnetwork Connections, page 2-73 for more information.
Creating SNCs between ONS 15327 nodes or ONS 15310, and between ONS 15600 nodes is identical to creating SNCs between ONS 15454 nodes. It is also possible to create SNCs among ONS 15327, ONS 15454, and ONS 15600 nodes.
CTM supports protection channel access (PCA). PCA SNCs are unprotected. For details on PCA, see the NE documentation.
You can provide a description for the SNC. Enter the description in the additionalCreationInfo field.
To create a dual-ring interconnect SNC, set the staticProtectionLevel value in createData to HIGHLY_PROTECTED. Use the CTC or CTM client to modify the Hold-off Timer attribute for this SNC.
The following types of circuit creation are not supported:
•
•
•
In addition to specifying SNC creation parameters using SNCCreateData_T structure, the NMS can provide a partial or complete list of MEs or both end PTPs of a topological link to be included or excluded in the SNC route during SNC creation. The NMS can specify only one type of object name list during the SNC creation. CTM throws a ProcessingFailureException if the NMS-specified list is not homogeneous. CTM throws a ProcessingFailureException with EXCPT_ENTITY_NOT_FOUND as the error reason if any one of the specified MEs or PTPs does not exist. If the NMS specifies a PTP list, CTM verifies whether PTPs are specified in pairs and each PTP of a PTP pair is associated with each end PTP of the same topological link. CTM uses the first PTP of a PTP pair as the aEnd of the topological link, and uses the second PTP of the same PTP pair as the zEnd of the topological link. CTM attempts to route the SNC from the aEnd PTP of a PTP pair to the zEnd PTP of the same pair on a topological link. CTM throws a ProcessingFailureException if the SNC cannot be routed from the specified aEnd PTP to the zEnd PTP of a topological link. The NMS then must interchange the aEnd PTP and zEnd PTP specified, or provide a different PTP pair, or delete the PTP pair from the include or exclude list. CTM throws a ProcessingFailureException if at least one PTP is not associated with a topological link. The NMS must ensure that the sequence of the object name list conforms to the sequence of the objects existing in the network. CTM throws a ProcessingFailureException if the sequence is nonconforming.
In addition to specifying SNC creation parameters using SNCCreateData_T structure, the NMS can provide a complete list of CTP pairs representing the complete route of the SNC. Each CTP pair represents the two end-points of one span in the SNC route. A span represents a partial route of an SNC with the end-points specified on the end-points of a topological link. CTM processes the input list in CTP pairs. CTM assumes each pair represents the two end-points of a span, and the CTP native names are the same for the two end-points (the STS numbers are the same for each CTP pair). The NMS must ensure that the sequence of spans represented by the CTP pairs conforms to the sequence existing in the network. CTM throws a ProcessingFailureException if the sequence is nonconforming.
If you create a SubnetworkConnection with at least one end-point on ML-series equipment, CTM identifies the SNC for a new Layer 2 Point-to-Point topology. CTM creates a new Layer 2 Point-to-Point topology and an ObjectCreationEvent is generated to notify for the creation of a new L2 Point-to-Point topology in CTM.
CTM provides support for the creation of open-ended UPSR circuits. There are two types of SNC that can be created in order to create an open-ended UPSR circuit.
If there are one source point and two destination end-points, NMS has to specify the source point in SNCCreateData_T.aEnd, and the two destination end-points have to be in SNCCreateData_T.zEnd.
For two source points and one destination point, NMS must specify two source points in SNCCreateData_T.aEnd and one destination end-point in SNCCreateData_T.zEnd.
CTM supports optical channel SNC creation on WDM cards through this method. See 2.2.7.4 SNC Provisioning on WDM Equipment, page 2-76 for detailed information. The sncSize field in additionalCreationInfo is used to specify the size of the optical channel SNC.
CTM supports OCH trail SNC creation on DWDM transponder/muxponder cards or ITU-T Line cards through a DWDM network. See 2.2.7.4 SNC Provisioning on WDM Equipment, page 2-76 for details.
For the ONS 15454 SONET, this operation enables you to create an end-to-end STS1 circuit using the portless transmux interfaces of the transmux card as an intermediate connection point. Information about the high-density portless transmux card (DS3XM-12) can be provided using the usePortlessTransmux, portlessTransmuxMeName, portlessTransmuxSlot, and isSourceDS3MappedSTS attributes in the additionalCreationInfo field.
Note
Parameters
CTM does not support locking.
For details of SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
CTM support for SNCCreateData_T structure is as follows:
•
Supported. The value in this field is assigned to the name of the newly created SNC.
•
CTM guarantees the uniqueness of SNCs if they are all created by CTM. CTM cannot guarantee the uniqueness if any other tool has been used instead.
•
Not supported.
•
CTM supports CD_UNI (unidirectional), CD_BI (bidirectional), CD_UNI_EW (unidirectional East to West), CD_UNI_WE (unidirectional West to East), CD_BI_EW (bidirectional East to West), and CD_BI_WE (bidirectional West to East).
•
CTM supports UNPROTECTED, FULLY_PROTECTED, and HIGHLY_PROTECTED. CTM does not support any other value.
•
CTM supports all values defined by TMF.
If the NMS requests an unprotected SNC on a BLSR ring, CTM creates the SNC. The same is true for an unprotected SNC on 1+1 protection.
The NMS specifies EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, CTM expects the value of staticProtectionLevel to be UNPROTECTED. These values indicate that CTM must create PCA.
•
Not supported.
•
Not supported.
•
Not supported.
•
CTM supports the following layer rates:
–
LR_T1_and_DS1_1_5M
LR_T3_and_DS3_45M
LR_VT1_5_and_TU11_VC11
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c (Supported on ONS 15454 Release 3.1 or later)
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c (Supported on ONS 15454 Release 3.2 or later, and ONS 15327 Release 3.3 or later)
LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later, and ONS 15327 Release 3.3 or later)
LR_STS18c_and_VC4_6c (Supported on ONS 15454 Release 5.0 or later, and ONS 15327 Release 5.0 or later)
LR_STS36c_and_VC4_12c (Supported on ONS 15454 Release 5.0 or later, and ONS 15327 Release 5.0 or later)
LR_Optical_Channel (for WDM OCH NC and OCH)
LR_ESCON (for WDM OCHCC)
LR_ETR (for WDM OCHCC)
LR_Gigabit_Ethernet (for WDM OCHCC)
LR_Ten_Gigabit_Ethernet (for WDM OCHCC)
LR_FICON_1G (for WDM OCHCC)
LR_FICON_2G (for WDM OCHCC)
LR_FC_100_1063M (for WDM OCHCC)
LR_FC_200_2125M (for WDM OCHCC)
LR_D1_Video (for WDM OCHCC)
LR_SYSPLEX_ISC_COMP (for WDM OCHCC)
LR_SYSPLEX_ISC_PEER (for WDM OCHCC)
LR_DSR_OC3_STM1 (for WDM OCHCC)
LR_DSR_OC12_STM4 (for WDM OCHCC)
LR_DSR_OC48_STM16 (for WDM OCHCC)
LR_DSR_OC192_STM64 (for WDM OCHCC)
LR_10_GFC (for WDM OCHCC)
LR_4_GFC (for WDM OCHCC)
LR_FICON_4G (for WDM OCHCC)
LR_ISC3_PEER_1G (for WDM OCHCC)
LR_ISC3_PEER_2G (for WDM OCHCC)
LR_HDTV (for WDM OCHCC)
LR_DV_6000 (for WDM OCHCC)
LR_PASS_TROUGH (for WDM OCHCC)
–
LR_E1_2M (Supported on ONS 15454 SDH Release 4.0 or later)
LR_E3_34M (Supported on ONS 15454 SDH Release 4.0 or later)
LR_T3_and_DS3_45M (Supported on ONS 15454 SDH Release 4.0 or later)
LR_VT2_and_TU12_VC12 (Supported on ONS 15454 SDH Release 4.0 or later)
LR_Low_Order_TU3_VC3 (Supported on ONS 15454 SDH Release 4.0 or later)
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS48c_and_VC4_16c
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS24c_and_VC4_8c
LR_STS18c_and_VC4_6c
LR_STS36c_and_VC4_12c
LR_STS192c_and_VC4_64c
LR_Optical_Channel (for WDM OCH NC)
LR_ESCON (for WDM OCHCC)
LR_ETR (for WDM OCHCC)
LR_Gigabit_Ethernet (for WDM OCHCC)
LR_Ten_Gigabit_Ethernet (for WDM OCHCC)
LR_FICON_1G (for WDM OCHCC)
LR_FICON_2G (for WDM OCHCC)
LR_FC_100_1063M (for WDM OCHCC)
LR_FC_200_2125M (for WDM OCHCC)
LR_D1_Video (for WDM OCHCC)
LR_SYSPLEX_ISC_COMP (for WDM OCHCC)
LR_SYSPLEX_ISC_PEER (for WDM OCHCC)
LR_DSR_OC3_STM1 (for WDM OCHCC)
LR_DSR_OC12_STM4 (for WDM OCHCC)
LR_DSR_OC48_STM16 (for WDM OCHCC)
LR_DSR_OC192_STM64 (for WDM OCHCC)
LR_10_GFC (for WDM OCHCC)
LR_4_GFC (for WDM OCHCC)
LR_FICON_4G (for WDM OCHCC)
LR_ISC3_PEER_1G (for WDM OCHCC)
LR_ISC3_PEER_2G (for WDM OCHCC)
LR_HDTV (for WDM OCHCC)
LR_DV_6000 (for WDM OCHCC)
LR_PASS_TROUGH (for WDM OCHCC)
–
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
–
LR_Physical_10_Gigabit_ITU = 107
LR_Physical_40_Gigabit_ITU = 150
•
Not supported.
•
Supported. CTM expects a list of ManagedElement names or the PTP names at the endpoints of the TopologicalLink or the CTP name pair representing the end-points of the span to include in the SubnetworkConnection route.
•
Not supported.
•
Supported. CTM expects a list of ManagedElement names or the PTP names at the endpoints of the TopologicalLink to exclude from the SubnetworkConnection route.
•
Supported. CTM expects at least one valid CTP or FTP in this list. At most, two valid CTPs can be in the list.
•
Supported. CTM expects at least one valid CTP or FTP in this list. At most, two valid CTPs can be in the list.
•
This list can be used to provide additional parameters for SNC creation. Table 3-1 provides additional CTM-supported parameters for SNC creation. For more information, refer to the ONS 15454 SONET user documentation.
CTM does not support tolerableImpact (GradesOfImpact_T). Circuits created on ONS 15454 and ONS 15327 do not impact existing traffic.
CTM does not support emsFreedomLevel (EMSFreedomLevel_T). CTM has full control of SNC creation.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when a field of createData is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when fields of createData reference objects that do not exist.EXCPT_UNABLE_TO_COMPLY - Raised if the SNC cannot be created and activated because CTP conflicts with other SNC or NE does not support this SNC creation. This exception will also be raised when CTM cannot meet protection level or there is no bandwidth available.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents creation of the SNC.EXCPT_USERLABEL_IN_USE - Raised when the userLabel uniqueness constraint is not met.Compliance
CTM-defined.
Examples
Because SNC creation is an extremely complex configuration, sample configurations are provided in the following subsections.
3.8.16.1 Creating DS3 SNC in a Single ONS 15454 Node
As shown in Figure 3-1, the ONS 15454 node has DS3 card installed in slot number 4 and OC48 card installed in slot number 13. There are 12 DS3 ports available on DS3 card and one OC48 port available on OC 48 card.
Figure 3-1 Creating DS-3 SNC Originating and Terminating on the Same Node
To create SNC from port number 1 of DS3 card and drop it to first STS of OC48, NMS must write code similar to the following:
// Assuming that eference to MultiLayerSubnetworkMgr_I is already available// in subnetworkMgrSNCCreateData_T createData = new SNCCreateData_T();createData.userLabel = new String("Test DS3 Circuit");createData.forceUniqueness = true;// createData.owner is not supported by CTM// Bidirectional SNCcreateData.direction = ConnectionDirection.CD_BI;// Unprotected SNCcreateData.staticProtectionLevel =StaticProtectionLevel_T.UNPROTECTED;// CTM does not support any other valuecreateData.protectionEffort =ProtectionEffort_T.EFFORT_SAME_OR_BETTER;// createData.rerouteAllowed, createData.networkRouted and// createData.sndType are not supported by CTMcreateData.layerRate = 4; // LR_T3_and_DS3_45M// createData.ccInclusions, createData.neTpInclusions,// createData.fullRoute and createData.neTpSncExclusions// are not supported by CTMNameAndStringValue_T emsName = new NameAndStringValue_T("EMS","San Jose Site");NameAndStringValue_T meName = new NameAndStringValue_T("ManagedElement","CTM-MSP-1");NameAndStringValue_T aEndPTPName =new NameAndStringValue_T("PTP", "/rack=1/shelf=1/slot=4/port=1");NameAndStringValue_T aEndCTPName = new NameAndStringValue_T("CTP", "/ds3=1");NameAndStringValue_T zEndPTPName =new NameAndStringValue_T("PTP", "/rack=1/shelf=1/slot=13/port=1");//for STS slot 1 on OC48 portNameAndStringValue_T zEndCTPName = new NameAndStringValue_T("CTP", "/sts1_au3-j=1-k=1");NameAndStringValue_T[][]createData.aEnd = new NameAndStringValue_T[1][];createData.aEnd[0] = new NameAndStringValue_T[4];createData.aEnd[0][0] = emsName;createData.aEnd[0][1] = meName;createData.aEnd[0][2] = aEndPTPName;createData.aEnd[0][3] = zEndCTPName;NameAndStringValue_T[][] createData.zEnd = new NameAndStringValue_T[1][];createData.zEnd[0] = new NameAndStringValue_T[4];createData.zEnd[0][0] = emsName;createData.zEnd[0][1] = meName;createData.zEnd[0][2] = zEndPTPName;createData.zEnd[0][3] = zEndCTPName;// CTM does not support this parameter// but to avoid marshalling error, allocate array// of zero length.createData.additionalCreationInfo = new NameAndStringValue_T[0];// Not supported by CTM but to avoid// marshalling error, allocating objectGradesOfImpact_T tolerableImpact = new GradesOfImpact_T();EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();// Not modifying any TPsTPDataList_Tholder tpsToModify = new TPDataList_Tholder();SubnetworkConnection_Tholder theSNC = new SubnetworkConnection_Tholder();StringHolder errorReason = new StringHolder();try {subnetworkMgr.createAndActivateSNCFromUserLabel(createData,tolerableImpact,emsFreedomLevel,tpsToModify,theSNC,errorReason);} catch(ProcessingFailureException) {// Exception handling code}3.8.16.2 Creating DS3 Protected SNC Through 2Fiber BLSR and 1+1 Configuration
Figure 3-2 shows a configuration where ManagedElements Node A, Node B, and Node C form the 2-fiber BLSR ring. All nodes are ONS 15454 nodes. Node C is connected to Node D through the OC-48 line, which has 1+1 protection.
Figure 3-2 Creating SNC Through 2-Fiber BLSR and 1+1 Configuration
The NMS tries to create an SNC from Node A to Node D. The DS3 is dropped at source NE Node A on slot number 4 and port number 1. The SNC destination is on OC12 port on Node D.
// Assuming that eference to MultiLayerSubnetworkMgr_I is already available// in subnetworkMgrSNCCreateData_T createData = new SNCCreateData_T();createData.userLabel = new String("Test DS3 Circuit");createData.forceUniqueness = true;// createData.owner is not supported by CTM// Bidirectional SNCcreateData.direction = ConnectionDirection.CD_BI;// Unprotected SNCcreateData.staticProtectionLevel = StaticProtectionLevel_T.FULLY_PROTECTED;// CTM does not support any other valuecreateData.protectionEffort = ProtectionEffort_T.EFFORT_SAME_OR_BETTER;// createData.rerouteAllowed, createData.networkRouted and// createData.sndType are not supported by CTMcreateData.layerRate = 4; // LR_T3_and_DS3_45M// createData.ccInclusions, createData.neTpInclusions,// createData.fullRoute and createData.neTpSncExclusions// are not supported by CTMNameAndStringValue_T emsName = new NameAndStringValue_T("EMS","San Jose Site");NameAndStringValue_T aEndMEName = new NameAndStringValue_T("ManagedElement","NodeA");NameAndStringValue_T aEndPTPName = new NameAndStringValue_T("PTP", "/rack=1/shelf=1/slot=4/port=1");NameAndStringValue_T aEndCTPName = new NameAndStringValue_T("CTP", "/ds3=1");NameAndStringValue_T zEndMEName = new NameAndStringValue_T("ManagedElement","NodeD");NameAndStringValue_T zEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=12/port=1");//for STS slot 2 on OC12 portNameAndStringValue_T zEndCTPName = new NameAndStringValue_T("CTP", "/sts1_au3-j=1-k=2");NameAndStringValue_T[][]createData.aEnd = new NameAndStringValue_T[1][];createData.aEnd[0] = new NameAndStringValue_T[4];createData.aEnd[0][0] = emsName;createData.aEnd[0][1] = aEndMEName;createData.aEnd[0][2] = aEndPTPName;createData.aEnd[0][3] = aEndCTPName;NameAndStringValue_T[][] createData.zEnd = new NameAndStringValue_T[1][];createData.zEnd[0] = new NameAndStringValue_T[4];createData.zEnd[0][0] = emsName;createData.zEnd[0][1] = zEndMEName;createData.zEnd[0][2] = zEndPTPName;createData.zEnd[0][3] = zEndCTPName;// CTM does not support this parameter// but to avoid marshalling error, allocate array// of zero length.createData.additionalCreationInfo = new NameAndStringValue_T[0];// Not supported by CTM but to avoid// marshalling error, allocating objectGradesOfImpact_T tolerableImpact = new GradesOfImpact_T();EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();// Not modifying any TPsTPDataList_Tholder tpsToModify = new TPDataList_Tholder();SubnetworkConnection_Tholder theSNC = new SubnetworkConnection_Tholder();StringHolder errorReason = new StringHolder();try {subnetworkMgr.createAndActivateSNCFromUserLabel(createData,tolerableImpact,emsFreedomLevel,tpsToModify,theSNC,errorReason);} catch(ProcessingFailureException) {// Exception handling code}.Figure 3-3 Topology Used for Manual Routing Examples
3.8.16.3 Creating Unprotected DS3 SNC by Specifying ManagedElement(s) to Include/Exclude
This example uses the topology specified in Figure 3-3. The NMS creates an SNC from San Jose to San Francisco. The DS-3 is dropped at source NE San Jose on slot 4, port 1. The SNC destination is an OC-12 port on San Francisco. The NMS routes the SNC through NE Fremont but does not use NE Livermore.
// Assuming that reference to MultiLayerSubnetworkMgr_I is already available in subnetworkMgrSNCCreateData_T createData = new SNCCreateData_T();createData.userLabel = new String("Test DS3 SNC Manual");createData.forceUniqueness = true;// createData.owner is not supported by CTM// Bidirectional SNCcreateData.direction = ConnectionDirection.CD_BI;// Unprotected SNCcreateData.staticProtectionLevel = StaticProtectionLevel_T.FULLY_PROTECTED;// CTM does not support any other valuecreateData.protectionEffort = ProtectionEffort_T.EFFORT_SAME_OR_BETTER;// createData.rerouteAllowed, createData.networkRouted and// createData.sndType are not supported by CTMcreateData.layerRate = 4; // LR_T3_and_DS3_45M//createData.ccInclusions, createData.fullRoute//not supported in CTM//specify one of the intermediate NEs to be considered for//inclusion in SNC route.createData.neTpInclusions = new NameAndStringValue_T[1][];createData.neTpInclusions[0] = new NameAndStringValue_T[2];createData.neTpInclusions[0][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[0][1] = new NameAndStringValue_T("ManagedElement","Fremont");//specify the list of intermediate NEs that should not be used//as part of SNC route.createData.neTpSncExclusions = new NameAndStringValue_T[1][];createData.neTpSncExclusions[0] = new NameAndStringValue_T[2];createData.neTpSncExclusions[0][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpSncExclusions[0][1] =new NameAndStringValue_T("ManagedElement","Livermore");NameAndStringValue_T emsName = new NameAndStringValue_T("EMS","San Jose Site");NameAndStringValue_T aEndMEName = new NameAndStringValue_T("ManagedElement","SanJose");NameAndStringValue_T aEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=4/port=1");NameAndStringValue_T aEndCTPName = new NameAndStringValue_T("CTP", "/ds3=1");NameAndStringValue_T zEndMEName =new NameAndStringValue_T("ManagedElement","SanFrancisco");NameAndStringValue_T zEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=12/port=1");//for STS slot 2 on OC12 portNameAndStringValue_T zEndCTPName = new NameAndStringValue_T("CTP", "/sts1_au3-j=1-k=2");NameAndStringValue_T[][]createData.aEnd =new NameAndStringValue_T[1][];createData.aEnd[0] = new NameAndStringValue_T[4];createData.aEnd[0][0] = emsName;createData.aEnd[0][1] = aEndMEName;createData.aEnd[0][2] = aEndPTPName;createData.aEnd[0][3] = aEndCTPName;NameAndStringValue_T[][] createData.zEnd = new NameAndStringValue_T[1][];createData.zEnd[0] = new NameAndStringValue_T[4];createData.zEnd[0][0] = emsName;createData.zEnd[0][1] = zEndMEName;createData.zEnd[0][2] = zEndPTPName;createData.zEnd[0][3] = zEndCTPName;// CTM does not support this parameter// but to avoid marshalling error, allocate array// of zero length.createData.additionalCreationInfo = new NameAndStringValue_T[0];// Not supported by CTM but to avoid// marshalling error, allocating objectGradesOfImpact_T tolerableImpact = new GradesOfImpact_T();EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();// Not modifying any TPsTPDataList_Tholder tpsToModify = new TPDataList_Tholder();SubnetworkConnection_Tholder theSNC = new SubnetworkConnection_Tholder();StringHolder errorReason = new StringHolder();try {subnetworkMgr.createAndActivateSNCFromUserLabel(createData,tolerableImpact,emsFreedomLevel,tpsToModify,theSNC,errorReason);} catch(ProcessingFailureException) {// Exception handling code}3.8.16.4 Creating Unprotected DS3 SNC by Specifying a List of PTP Pairs Representing End Points of a TopologicalLink to Include/Exclude
This example uses the topology specified in Figure 3-3. The NMS creates an SNC from San Jose to San Francisco. A DS-3 is dropped at the source NE San Jose on slot 4, port 1. The SNC destination is an OC-12 port on San Francisco. The NMS routes the SNC to include the topological link between NE San Jose and NE Fremont (San Jose slot 6/port 1 and Fremont slot 5/port 1), but does not include the topological link between NE Fremont and NE Oakland (Fremont slot 5/port 1 and Oakland slot 5/port 1).
// Assuming that reference to MultiLayerSubnetworkMgr_I is already available in subnetworkMgrSNCCreateData_T createData = new SNCCreateData_T();createData.userLabel = new String("Test DS3 SNC Manual");createData.forceUniqueness = true;// createData.owner is not supported by CTM// Bidirectional SNCcreateData.direction = ConnectionDirection.CD_BI;// Unprotected SNCcreateData.staticProtectionLevel = StaticProtectionLevel_T.FULLY_PROTECTED;// CTM does not support any other valuecreateData.protectionEffort = ProtectionEffort_T.EFFORT_SAME_OR_BETTER;// createData.rerouteAllowed, createData.networkRouted and// createData.sndType are not supported by CTMcreateData.layerRate = 4; // LR_T3_and_DS3_45M//createData.ccInclusions, createData.fullRoute//not supported in CTM//specify list of the intermediate ptp pairs representing the//topologicallinks to be considered for//inclusion in SNC route.//one link corresponds to two ports.createData.neTpInclusions = new NameAndStringValue_T[2][];createData.neTpInclusions[0] = new NameAndStringValue_T[3];createData.neTpInclusions[0][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[0][1] = new NameAndStringValue_T("ManagedElement","SanJose");createData.neTpInclusions[0][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=6/port=1");createData.neTpInclusions[1] = new NameAndStringValue_T[3];createData.neTpInclusions[1][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[1][1] = new NameAndStringValue_T("ManagedElement","Fremont");createData.neTpInclusions[1][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");//specify the list of intermediate ptp pairs representing//topologicallinks that should not be used//as part of SNC route.createData.neTpSncExclusions = new NameAndStringValue_T[2][];createData.neTpSncExclusions[0] = new NameAndStringValue_T[3];createData. neTpSncExclusions = new NameAndStringValue_T[2][];createData. neTpSncExclusions [0] = new NameAndStringValue_T[3];createData. neTpSncExclusions [0][0] = new NameAndStringValue_T("EMS","San Jose Site");createData. neTpSncExclusions [0][1] =new NameAndStringValue_T("ManagedElement","Fremont");createData. neTpSncExclusions [0][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData. neTpSncExclusions[1] = new NameAndStringValue_T[3];createData. neTpSncExclusions[1][0] = new NameAndStringValue_T("EMS","San Jose Site");createData. neTpSncExclusions[1][1] =new NameAndStringValue_T("ManagedElement","Oakland");createData. neTpSncExclusions[1][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");NameAndStringValue_T emsName = new NameAndStringValue_T("EMS","San Jose Site");NameAndStringValue_T aEndMEName = new NameAndStringValue_T("ManagedElement","SanJose");NameAndStringValue_T aEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=4/port=1");NameAndStringValue_T aEndCTPName = new NameAndStringValue_T("CTP", "/ds3=1");NameAndStringValue_T zEndMEName =new NameAndStringValue_T("ManagedElement","SanFrancisco");NameAndStringValue_T zEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=12/port=1");//for STS slot 2 on OC12 portNameAndStringValue_T zEndCTPName = new NameAndStringValue_T("CTP", "/sts1_au3-j=1-k=2");NameAndStringValue_T[][]createData.aEnd = new NameAndStringValue_T[1][];createData.aEnd[0] = new NameAndStringValue_T[4];createData.aEnd[0][0] = emsName;createData.aEnd[0][1] = aEndMEName;createData.aEnd[0][2] = aEndPTPName;createData.aEnd[0][3] = aEndCTPName;NameAndStringValue_T[][] createData.zEnd = new NameAndStringValue_T[1][];createData.zEnd[0] = new NameAndStringValue_T[4];createData.zEnd[0][0] = emsName;createData.zEnd[0][1] = zEndMEName;createData.zEnd[0][2] = zEndPTPName;createData.zEnd[0][3] = zEndCTPName;// CTM does not support this parameter// but to avoid marshalling error, allocate array// of zero length.createData.additionalCreationInfo = new NameAndStringValue_T[0];// Not supported by CTM but to avoid// marshalling error, allocating objectGradesOfImpact_T tolerableImpact = new GradesOfImpact_T();EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();// Not modifying any TPsTPDataList_Tholder tpsToModify = new TPDataList_Tholder();SubnetworkConnection_Tholder theSNC = new SubnetworkConnection_Tholder();StringHolder errorReason = new StringHolder();try {subnetworkMgr.createAndActivateSNCFromUserLabel(createData,tolerableImpact,emsFreedomLevel,tpsToModify,theSNC,errorReason);} catch(ProcessingFailureException) {// Exception handling code}3.8.16.5 Creating Unprotected DS3 SNC by Specifying CTPs to Include
This example uses the topology specified in Figure 3-3. The NMS creates an SNC from San Jose to San Francisco. A DS-3 is dropped at the source NE San Jose on slot 4 and port 1. The SNC destination is an OC-12 port on San Francisco. The NMS specifies the complete route of the SNC. The NMS must specify all the CTP pairs to be included as part of SNC. Each CTP belongs to a PTP, which is one end-point of the topological link through which the SNC is to be routed. The NMS must specify all the CTP pairs from San Jose to Fremont, Fremont to Livermore, Livermore to Oakland, and Oakland to San Francisco. The NMS uses "ctp=/sts1_au3-j=1-k=2" (sts=2) on all the intermediate end-points.
// Assuming that reference to MultiLayerSubnetworkMgr_I is already available in subnetworkMgrSNCCreateData_T createData = new SNCCreateData_T();createData.userLabel = new String("Test DS3 SNC Manual");createData.forceUniqueness = true;// createData.owner is not supported by CTM// Bidirectional SNCcreateData.direction = ConnectionDirection.CD_BI;// Unprotected SNCcreateData.staticProtectionLevel = StaticProtectionLevel_T.FULLY_PROTECTED;// CTM does not support any other valuecreateData.protectionEffort = ProtectionEffort_T.EFFORT_SAME_OR_BETTER;// createData.rerouteAllowed, createData.networkRouted and// createData.sndType are not supported by CTMcreateData.layerRate = 4; // LR_T3_and_DS3_45M//createData.ccInclusions, createData.fullRoute//not supported in CTM//specify list of the intermediate ctp pairs at the end-points of a topological link to be considered for//inclusion in SNC route.//PAIR #1createData.neTpInclusions = new NameAndStringValue_T[8][];createData.neTpInclusions[0] = new NameAndStringValue_T[2];createData.neTpInclusions[0][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[0][1] = new NameAndStringValue_T("ManagedElement","SanJose");createData.neTpInclusions[0][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=6/port=1");createData.neTpInclusions[0][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");createData.neTpInclusions[1] = new NameAndStringValue_T[2];createData.neTpInclusions[1][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[1][1] = new NameAndStringValue_T("ManagedElement","Fremont");createData.neTpInclusions[1][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[1][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");//PAIR #2createData.neTpInclusions[2] = new NameAndStringValue_T[2];createData.neTpInclusions[2][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[2][1] = new NameAndStringValue_T("ManagedElement","Fremont");createData.neTpInclusions[2][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[2][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");createData.neTpInclusions[3] = new NameAndStringValue_T[2];createData.neTpInclusions[3][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[3][1] = new NameAndStringValue_T("ManagedElement","Livermore");createData.neTpInclusions[3][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[3][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");//PAIR #3createData.neTpInclusions[4] = new NameAndStringValue_T[2];createData.neTpInclusions[4][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[4][1] = new NameAndStringValue_T("ManagedElement","Livermore");createData.neTpInclusions[4][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[4][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");createData.neTpInclusions[5] = new NameAndStringValue_T[2];createData.neTpInclusions[5][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[5][1] = new NameAndStringValue_T("ManagedElement","Oakland");createData.neTpInclusions[5][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[5][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");//PAIR #4createData.neTpInclusions[6] = new NameAndStringValue_T[2];createData.neTpInclusions[6][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[6][1] = new NameAndStringValue_T("ManagedElement","Oakland");createData.neTpInclusions[6][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[6][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");createData.neTpInclusions[7] = new NameAndStringValue_T[2];createData.neTpInclusions[7][0] = new NameAndStringValue_T("EMS","San Jose Site");createData.neTpInclusions[7][1] =new NameAndStringValue_T("ManagedElement","SanFrancisco");createData.neTpInclusions[7][2] =new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=5/port=1");createData.neTpInclusions[7][3] = new NameAndStringValue_T("CTP","/sts1_au3-j=1-k=2");//specify exclusion list not supported for specifying CTP pairs.createData.neTpSncExclusions = new NameAndStringValue_T[0][];NameAndStringValue_T emsName = new NameAndStringValue_T("EMS","San Jose Site");NameAndStringValue_T aEndMEName = new NameAndStringValue_T("ManagedElement","SanJose");NameAndStringValue_T aEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=4/port=1");NameAndStringValue_T aEndCTPName = new NameAndStringValue_T("CTP", "/ds3=1");NameAndStringValue_T zEndMEName =new NameAndStringValue_T("ManagedElement","SanFrancisco");NameAndStringValue_T zEndPTPName = new NameAndStringValue_T("PTP","/rack=1/shelf=1/slot=12/port=1");//for STS slot 2 on OC12 portNameAndStringValue_T zEndCTPName = new NameAndStringValue_T("CTP", "/sts1_au3-j=1-k=2");NameAndStringValue_T[][]createData.aEnd = new NameAndStringValue_T[1][];createData.aEnd[0] = new NameAndStringValue_T[4];createData.aEnd[0][0] = emsName;createData.aEnd[0][1] = aEndMEName;createData.aEnd[0][2] = aEndPTPName;createData.aEnd[0][3] = aEndCTPName;NameAndStringValue_T[][] createData.zEnd = new NameAndStringValue_T[1][];createData.zEnd[0] = new NameAndStringValue_T[4];createData.zEnd[0][0] = emsName;createData.zEnd[0][1] = zEndMEName;createData.zEnd[0][2] = zEndPTPName;createData.zEnd[0][3] = zEndCTPName;// CTM does not support this parameter// but to avoid marshalling error, allocate array// of zero length.createData.additionalCreationInfo = new NameAndStringValue_T[0];// Not supported by CTM but to avoid// marshalling error, allocating objectGradesOfImpact_T tolerableImpact = new GradesOfImpact_T();EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();// Not modifying any TPsTPDataList_Tholder tpsToModify = new TPDataList_Tholder();SubnetworkConnection_Tholder theSNC = new SubnetworkConnection_Tholder();StringHolder errorReason = new StringHolder();try {subnetworkMgr.createAndActivateSNCFromUserLabel(createData,tolerableImpact,emsFreedomLevel,tpsToModify,theSNC,errorReason);} catch(ProcessingFailureException) {// Exception handling code}3.8.17 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createAndActivateSNC
Synopsis
void createAndActivateSNCFromUserLabel(in subnetworkConnection::SNCCreateData_T createData,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This operation is exactly identical to multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel, except that the CTM assigns the name of the created Subnetwork Connection. The userLabel field in the SNCCreateData_T can be left blank. Even if the userLabel is specified, CTM would ignore the userLabel, and assign a userLabel to the SNC.
Compliance
TMF-defined.
3.8.18 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addDrops
Synopsis
void addDrops(in globaldefs::NamingAttributes_T sncName,in globaldefs::NamingAttributesList_T zEnd)raises(globaldefs::ProcessingFailureException);Description
This proprietary interface supports SNCs with multiple drops for the ONS 15454, ONS 15327, and ONS 15310. There are two steps to creating an SNC with multiple drops:
Step 1
Step 2
Note
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or layer rate of any CTP does not match with SNC layer.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised if any of the CTP is in use by other SNC. This exception will also be raised when there is no bandwidth available.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the deactivation of the SNC.Compliance
CTM-defined.
3.8.19 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deactivateAndDeleteSNC
Synopsis
void deactivateAndDeleteSNC(in globaldefs::NamingAttributes_T sncName,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This operation provides a way to deactivate and then delete a subnetwork connection in one operation.
CTM removes resources allocated to this SNC from each node. Successful completion of this operation guarantees only delivery of the deletion request to CTM. The NMS should wait for an OBJECT_DELETION event for the SNC.
CTM performs this operation in two steps:
1.
2.
CTM does not delete any SNC that has at least one TP on ML-series equipment. CTM will delete such an SNC as a clean-up operation when the L2 topology using the SNC is deleted. CTM throws ProcessingFailureException, EXCPT_UNABLE_TO_COMPLY if you try to delete such SNCs.
Note
Parameters
For details of SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field in tpsToModify is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the deactivation of the SNC.Compliance
TMF-defined.
3.8.20 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC
Synopsis
void MultiLayerSubnetworkMgr_I::getVCATSNC(in globaldefs::NamingAttributes_T vcatName,out subnetworkConnection::VCAT_T vcat) raises(globaldefs::ProcessingFailureException);Description
This operation returns the VCAT structure for the VCAT SNC whose name is supplied as an argument. The VCAT SNCs are supported on the following equipment types:
•
•
Note
Parameters
vcatName
globaldefs::NamingAttributes_T
in
Name of VCAT SNC.
vcat
subnetworkConnection::VCAT_T
out
The VCAT structure.
CTM support for VCAT_T is as follows:
•
Supported. This field will contain two tuples. The first tuple contains the value for the EMS. The second tuple contains the VCAT name, which is the same as the nativeEMSName. The value of the name field in the last tuple is VCATSubnetworkConnection
•
Supported.
•
Supported. Name supplied by the user at creation time will be reported.
•
Not supported.
•
Supported. The state of the VCAT circuit is derived from the states of the member circuits in the same way as it is derived for CCAT SNCs. The values supported are:
–
–
–
–
–
•
Supported. This field represents the direction of the VCAT and not the member L1 SNCs.
CTM supports CD_UNI (unidirectional) and CD_BI (bidirectional). Current release supports only CD_BI.
•
Supported. Current release supports only symmetric VCAT SNCs.
–
–
•
Supported. This field represents the total capacity the VCAT SNC can carry in the forward direction. If the VCAT is symmetrical, then it represents the capacity both in forward and backward direction. To represent the total capacity of a VCAT SNC, VCATLayerRate_T contains the following information:
–
–
The LayerRates supported for VCAT SNCs are:
LR_VT1_5_and_TU11_VC11
LR_Low_Order_TU3_VC3 (for ONS 15454 SDH)
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
•
Supported. This field represents the total capacity the VCAT SNC can carry in the backward direction. If the VCAT is symmetrical, then this field must be ignored. The LayerRates supported for VCAT SNCs are:
–
–
–
–
–
•
Supported. This field represents the rate of each member circuit.
•
Supported. This is a FTP representing the port at the aEnd.
•
Supported. This is a FTP representing the port at the zEnd.
•
Not supported.
•
Supported. CTM supports the following values:
–
–
–
•
Supported. CTM supports the following values:
–
–
•
Supported. CustomerID and ServiceID are reported if they are available.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not refer to a VCAT SNC object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.Compliance
CTM-defined.
3.8.21 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCs
Synopsis
void MultiLayerSubnetworkMgr_I::getAllVCATSNCs(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::VCATList_T vcatList,out subnetworkConnection::VCATIterator_I vcatIt) raises(globaldefs::ProcessingFailureException);Description
This operation returns all the VCAT SNCs in the specified multilayer subnetwork. This operation returns only the VCAT SNCs.
Note
Parameters
For details on the VCAT_T structure, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference an multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references object which does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.8.22 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCNames
Synopsis
void MultiLayerSubnetworkMgr_I::getAllVCATSNCNames(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns the names of all the VCAT SNCs in the specified Multilayer Subnetwork. This operation returns only the VCAT SNC names.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference an multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references object which does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.8.23 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATMemberSNCs
Synopsis
void MultiLayerSubnetworkMgr_I::getAllMemberVCATSNCs(in globaldefs::NamingAttributes_T vcatName,in boolean isTransmit,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SubnetworkConnectionIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns all the member SNCs for the VCAT SNC.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference an VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references object which does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.8.24 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllVCATMemberSNCNamesSynopsis
void MultiLayerSubnetworkMgr_I::getAllVCATMemberSNCNames(in globaldefs::NamingAttributes_T vcatName,boolean isTransmit,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns the names of all the member SNCs for a given VCAT SNC.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference an VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references object which does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.8.25 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createVCAT
Synopsis
void MultiLayerSubnetworkMgr_I::createVCAT(in subnetworkConnection::VCATSNCCreateData_T createData,out subnetworkConnection::VCAT_T vcat,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This operation attempts to create a VCAT SNC.
CTM generates an object creation event for the VCAT SNC that was created and for the individual Layer 1 SNCs.
Note
Parameters
CTM support for VCATSNCCreateData_T structure is as follows:
•
Supported. Value assigned to this field is the name of the new VCAT.
•
CTM guarantees the uniqueness of all VCATs created by CTM. CTM does not guarantee uniqueness if any other tool is used for VCAT SNC creation.
•
Not supported.
•
CTM supports only CD_BI (bidirectional).
•
Supported. In CTM R7.1, only symmetric VCAT SNCs are supported. If set to true, all members have to be bidirectional L1 SNCs, and the VCAT layer rate is the same for both directions. If set to false, all members are unidirectional L1 SNCs, and the supported VCAT layer rate on either direction can be different.
The supported VCAT layer rate on either direction can be different.
•
Supported. CTM supports the following values:
–
–
–
•
Supported. CTM supports the following values:
–
–
•
Supported. CTM expects this field to be a FTP representing the information up to port level of the card involved in VCAT SNC.
•
Supported. CTM expects this field to be a FTP representing the information up to port level of the card involved in VCAT SNC.
•
Supported. At least one member L1 SNC must be created at the time of VCAT SNC creation. CTM expects user to specify the create data information required to create the L1 SNC(s) in this data structure. For complete information on SNCCreateData_T structure, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel. For every L1 SNC, you must specify an additionalCreationParamemter vcatMemberId, which must contain a unique value between 1 to 256.
•
This list can be used to provide additional parameters for VCAT creation. CTM supports the following values:
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when a field of createData is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when fields of createData reference objects that do not exist.EXCPT_UNABLE_TO_COMPLY - Raised if the VCAT SNC cannot be created and activated because FTP conflicts with other VCAT SNC or NE does not support this VCAT SNC creation. This exception will also be raised when CTM cannot meet protection level or there is no bandwidth available.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents creation of the VCAT SNC.EXCPT_USERLABEL_IN_USE - Raised when the userLabel uniqueness constraint is not met.Compliance
CTM-defined.
3.8.26 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteVCAT
Synopsis
void deleteVCAT(in globaldefs::NamingAttributes_T vcatName) raises(globaldefs::ProcessingFailureException);Description
This operation deletes the VCAT specified in the input. CTM generates an object deletion event for the VCAT SNC that was deleted and for the individual Layer 1 SNCs that were deleted.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference an VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references object which does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when deletion of the VCAT SNC fails.Compliance
CTM-defined.
3.8.27 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addMemberSNCsToVCAT
Synopsis
void addMemberSNCsToVCAT(in globaldefs::NamingAttributes_T vcatName,in subnetworkConnection::SNCCreateDataList_T sncData,out subnetworkConnection::VCAT_T vcat)raises(globaldefs::ProcessingFailureException);Description
This operation adds a member SNC to the VCAT that is specified in the input. CTM generates an attribute value change event for the VCAT SNC that was modified due to the addition of the new SNC(s), and an object creation event for the member L1 SNCs there were created.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference an VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references object which does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when addition of a member SNC(s) to the VCAT fails.Compliance
CTM-defined.
3.8.28 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteMemberSNCsFromVCATSynopsis
void deleteMemberSNCsFromVCAT(in globaldefs::NamingAttributes_T vcatName,in globaldefs::NamingAttributesList_T sncName,out subnetworkConnection::VCAT_T vcat)raises(globaldefs::ProcessingFailureException);Description
This operation deletes a member SNC from the VCAT specified in the input. CTM generates an attribute value change event for the VCAT SNC that was modified due to the deletion of the member SNC, and an object deletion event for the member L1 SNC that was deleted.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName or sncName do not reference an VCAT/SNC object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName or sncName references objects which do not exist.EXCPT_UNABLE_TO_COMPLY - Raised when deletion of member SNC(s) to the VCAT fails.Compliance
CTM-defined.
3.8.29 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteAllMemberSNCFromVCATSynopsis
void deleteAllMemberSNCFromVCAT(in globaldefs::NamingAttributes_T vcatName,in boolean isForward)raises( globaldefs::ProcessingFailureException );Description
This operation deletes all member SNCs in the VCAT group that is specified during input. If boolean value is set to true, then all member SNCs in the transmit direction are deleted. If boolean value is set to false, then all member SNCs in the receive direction are deleted. For symmetrical VCAT, this value is ignored; all member circuits in both transmit and receive directions are deleted. CTM generates an attribute value change for the VCAT SNC modified due to the deletion of member SNC(s), and an object deletion event for the member L1 SNCs deleted.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference an VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references object which does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when deletion of member SNC(s) to the VCAT fails.Compliance
CTM-defined.
3.8.30 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getValidSubnetworkConnectionsForMergeSynopsis
void getValidSubnetworkConnectionsForUpgrade(in multiLayerSubnetwork::SncUpgradeInfo_T details,in multiLayerSubnetwork::SncFilterCriteria_T filterCriteria,in globaldefs::NamingAttributes_T masterSncName,in globaldefs::NamingAttributesList_T candidateSncList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T mergeableSncList,out subnetworkConnection::SNCIterator_I sncIt )raises(globaldefs::ProcessingFailureException);Description
This operation is used to get the list of SNCs for the Merge operation. The SncFilterCriteria specifies the SNCs that are requested. These SNCs are lined up. The master SNC name specifies the name of the SNC with which the candidates are to be merged. The how_many parameter gives the list of SNCs that will be returned.
Note
Parameters
enum SncUpgradeType_T {MERGE,RECONFIGURE};enum SncOperationType_T {STRICT_MERGE,LOOSE_MERGE,NONE};enum SncFilterCriteria_T {LINED_UP,NO_FILTER};struct SncUpgradeInfo_T {SncUpgradeType_T upgradeType;SncOperationType_T operationType;};Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.8.31 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::upgrade
Synopsis
void upgrade(in multiLayerSubnetwork::SncUpgradeInfo_T details,in globaldefs::NamingAttributes_T masterSncName,in globaldefs::NamingAttributesList_T upgradableSncNameList,out string resultString )raises(globaldefs::ProcessingFailureException);Description
This operation is used to either merge or configure a list of SNCs to the SNC given in the masterSNCNAme. This operation supports STRICT MERGE and LOOSE MERGE as operation types from the OSS. The LOOSE MERGE option in SncUpgradeInfo_T is given only if a strict operation has failed and a processing failure exception with EXCPT_STRICT_MERGE_FAILED is received by the OSS.
There is no restriction in CTM GateWay/CORBA to prevent a LOOSE MERGE operation type from the OSS during a normal call.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_STRICT_MERGE_FAILED - Raised when a strict merge operation from OSS has failed. The OSS should make use of this exception to issue a Loose merge call.Compliance
CTM-defined.
3.8.32 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createRoll
Synopsis
void createRoll(in multiLayerSubnetwork::RollCreateData_T rollCreateData)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 and later of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
CTM supports roll creation on optical CTPs. Electrical CTPs and FTPs are not supported for bridge and roll creation.
CTM generates an Object Creation event for the roll created and subnetwork connections created as part of the roll creation. The subnetwork connections that are created as part of the roll creation will be named as nativeEMSName of the SNC appended with _ROLL** where ** is a number.
The creation of bridge and roll is an asynchronous process. If the operation fails, CTM cleans up all resources. For example, if CTM fails to create a bridge and roll on one node, it also cleans up resources on other nodes.
Parameters
rollCreateData
multiLayerSubnetwork::RollCreateData_T
in
Structure describing roll to be created
For details on Roll_T, see managedElementManager::ManagedElementManager_I:: getAllRolls.
CTM support for RollCreateData_T is as follows:
•
Supported.
•
Supported.
•
Supported. This refers to the name of the SNC that needs to be rolled partially or fully. If two SNCs are specified, the first SNC will be the RollFromSNC and the second SNC will be the RollToSNC.
•
Supported. This refers to the fully qualified name of the CTP of the SNC. This CTP is the fixed point of the roll. In cases where the rollType is DUAL, there will be two fixed points in the roll. The first fixCTP indicates the first fixed point in the roll object and the second fixCTP indicates the second fixed point of the roll.
•
Supported. This refers to the fully qualified name of the CTP of the SNC. This CTP is either the source or destination or any other associated CTP of the SNC. In cases where the rollType is DUAL, the first element in the array indicates the first rollFromCTP point and the second element in the array indicates the second rollFromCTP point.
Note
•
Supported. This refers to the fully qualified name of the CTP on which the roll should be done. In cases where the rollType is DUAL, the first element in the array indicates the first rollToCTP point and the second element in the array indicates the second rollToCTP point.
•
Supported. CTM expects a list of managed element names or PTP name of the endpoint of a topological link or CTP name pair representing the end-points of the span to be included in the subnetwork connection route. If the OSS specifies a CTP pair in the neTpInclusions, it is mandated that the entire path for the subnetwork connection be specified.
•
Supported. CTM expects a list of managed element names or PTP name of the endpoint of a topological link representing the end-points of the span to be excluded in the subnetwork connection route.
•
CTM supports the following for the subnetwork connection that is created as part of the roll creation:
–
–
–
Note
•
If NMS requests unprotected SNC on a BLSR ring, CTM will create SNC. The same is true for unprotected SNC on 1+1 protection.
If NMS requests EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, CTM expects a value of staticProtectionLevel of UNPROTECTED. These values indicate that CTM has to create PCA.
CTM support for Roll_T is described in managedElementManager::ManagedElementManager_I:: getAllRolls.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field in rollCreateData is invalid, or the data does not conform to roll creation rules.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the deactivation of the SNC.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
Scenarios: Roll Creation
Figure 3-4 Example 1: Roll Source or Destination of an SNC—Part 1
Figure 3-5 Example 2: Roll Source or Destination of an SNC—Part 2
Figure 3-6 Example 3: Roll Intermediate Managed Elements or Topological Links
3.8.33 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteRoll
Synopsis
void deleteRoll(in globaldefs::NamingAttributes_T rollname)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
CTM generates an Object Deletion event for the deleted roll object. CTM also generates Object Deletion events for the SNCs that are deleted.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll that has to be deleted
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the deletion of the roll.Compliance
CTM-defined.
3.8.34 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::cancelRoll
Synopsis
void cancelRoll(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
This operation can be used to cancel a roll task when the rollValidSignal is not received. For more information on canceling a roll task, see the Network Element documentation.
Parameters
rollName
globaldefs::NamingAttributes_T
in
Name of the roll that has to be canceled
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a Roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the cancellation of Rolling operation.EXCPT_UNABLE_TO_COMPLY - Raised when the Roll cannot be created.Compliance
CTM-defined.
3.8.35 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::forceValidSignal
Synopsis
void forceValidSignal(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
This operation runs on both the automatic and manual rolls.
Parameters
rollName
globaldefs::NamingAttributes_T
in
Name of the roll on which valid signal has to be forced.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a Roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.8.36 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::completeRoll
Synopsis
void completeRoll(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
This operation must run on manual rolls (RollMode_T.MANUAL).
CTM generates a State Change event on the completion of the roll.
Parameters
rollName
globaldefs::NamingAttributes_T
in
Name of the roll which has to be completed
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the deactivation of the SNC.Compliance
CTM-defined.
3.8.37 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::finishRoll
Synopsis
void completeRoll(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
This interface might be invoked to finish rolls. When the roll is finished, it is cleared from the rolls list and the new rolled SNC becomes active.
Parameters
rollName
globaldefs::NamingAttributes_T
in
Name of the roll that has to be finished
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost and this prevents the deactivation of the SNC.Compliance
CTM-defined.
3.8.38 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllRolls
Synopsis
void getAllRolls(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out multiLayerSubnetwork::RollList_T rollList,out multiLayerSubnetwork::RollIterator_I rollIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of rolls within the subnetwork whose name is passed as a parameter.
CTM supports this operation only for Release 6.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 NEs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetwork name does not refer to a Subnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetwork references an object that does not exist.Compliance
CTM-defined.
3.8.39 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllRollNames
Synopsis
void getAllRollNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation returns a list of roll names within the subnetwork whose name is passed as a parameter.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetwork name does not refer to a Subnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetwork references an object that does not exist.Compliance
CTM-defined.
3.8.40 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedRollNamesForSNCSynopsis
void getAssociatedRollNamesForSNC(in globaldefs::NamingAttributes_T sncName,in unsigned long how_many,out globaldefs::NamingAttributesList rollNameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns all the rolls associated with the SNC.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.Compliance
CTM-defined.
3.8.41 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedSNCNamesForRollSynopsis
void getAssociatedSNCNamesForRoll(in globaldefs::NamingAttributes_T rollName,out globaldefs::NamingAttributes_T rollFromSnc,out globaldefs::NamingAttributes_T rollToSnc)raises(globaldefs::ProcessingFailureException);Description
CTM supports this operation only for Release 5.0 of the ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, and ONS 15600 SDH NEs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.Compliance
CTM-defined.
3.8.42 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createAndActivateSNCOnDRI
Synopsis
void createAndActivateSNCOnDRI(in subnetworkConnection::DRISNCCreateData_T createData,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This structure was introduced to provide BLSR-DRI protection support. This structure is not defined by TMF. This structure is similar to createAndActivateSNCOnUserLabel (see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getSNCsByUserLabel for more details) except that a new field, driNode, has been added.
Parameters
The structure of DRISNCCreateData_T is as follows:
struct DRISNCCreateData_T{subnetworkConnection::SNCCreateData_T createData,subnetworkConnection::DRINodesList_T nodeList,};typedef sequence <DRINodes_T> DRINodesList_T;The structure of DRINodes_T is as follows:
struct DRINodes_T{globalDefs::DRIType_T type,boolean isSecPCA;DriNodePairList_T nodePairList;globaldefs::NamingAttributesList requiredRings;}typedef sequence <DRINodePair_T> DRINodePairList_T;struct DRINodePair_T{globaldefs::NamingAttributes_T PrimaryME;globaldefs::NamingAttributes_T SecondaryME}CTM support for DriNode_T structure is as follows:
•
This field defines integer values that categorize the BLSR-DRI as traditional or nontraditional BLSR-DRI. In CTM type = 0 means it is a dummy node, 1 = traditional. and 2 = nontraditional.
•
This field indicates whether or not the RIP option is supported.
•
This structure holds the primary and secondary nodes. The sDriNodePair structure is as follows:
–
–
–
Compliance
CTM-defined.
3.9 nmsSession::NmsSession_I
The nmsSession module enables the EMS to inform the NMS of problems with the notifications. When CTM fails to push an event, it notifies all connected NMSs by invoking the eventLossOccurred method on every active NmsSession_I. When the event loss period is over, CTM invokes the eventLossCleared method on NmsSession_I.
Both methods are implemented by the NMS.
NmsSession also implements all methods defined in session::Session_I.
CTM requires that NmsSession implement two new methods that are used by CTM to notify NmsSession that the call to getCTM HistoryPMData method has either failed or succeed.
3.9.1 nmsSession::NmsSession_I::historyPMDataCompleted
Synopsis
void historyPMDataCompleted(in string fileName)Description
When getCTMHistoryPMData completes successfully, CTM invokes this method on the NMS session. At that time, NMS can retrieve the performance monitoring (PM) file from the CTM server.
Parameters
fileName
string
In
Name of the file created by CTM in response to the getCTMHistoryPMData call made by the NMS. This name is the absolute path on CTM server.
Throws
None.
Compliance
CTM-defined.
3.9.2 nmsSession::NmsSession_I::historyPMDataFailed
Synopsis
void historyPMDataFailed(out string errorReason)Description
When getCTMHistoryPMData fails, CTM invokes this method on the NMS session. Errors encountered by CTM are stored in the errorReason parameter.
Parameters
errorReason
string
Out
Error string to indicate to the NMS the reason of the failure
Throws
None.
Compliance
CTM-defined.
3.10 performance::PerformanceManagementMgr_I
This interface accesses operations that deal with performance element monitoring. A handle to an instance of this interface is gained through the getManager operation in emsSession. This interface is inherited from common::Common_I.
interface PerformanceManagementMgr_I:common::Common_IThis interface also implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.10.1 performance::PerformanceManagementMgr_I::disablePMData
Synopsis
void disablePMData(in PMTPSelectList_T pmTPSelectList,out PMTPSelectList_T failedTPSelectList)raises(globaldefs::ProcessingFailureException);Description
This operation instructs the EMS to turn off PM data collection for a list of measurement points. Disabling is done on a best-effort basis. If PM could not be disabled for a subset of cases in the PMTPSelectList, a list identifying this subset is returned. PM collection involves collection of historical PM data. If this method is called between PM collection intervals, PM data for that interval is not collected. There are no incomplete collection periods.
Example
For PM collection intervals T-15min, T, T + 15min an so on, and a disablePMData call at T + 3min, the PM data is only collected up to and including interval T. T + 15min interval PM data is not collected.
If PM collection was never started for this TP, the operation is considered successful.
Parameters
CTM provide the following support for the PMTPSelect_T structure for this method:
•
The name of the object to which this selection applies. CTM only supports ManagedElement name in this field.
•
Not supported.
•
Not supported.
•
Supported only for enablePMData. 15 minute and 24 hour are the only valid values. If it is an empty list, both 15 minute and 24 hour are considered.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised if pmTPSelectList is empty.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.10.2 performance::PerformanceManagementMgr_I::enablePMData
Synopsis
void enablePMData(in PMTPSelectList_T pmTPSelectList,out PMTPSelectList_T failedTPSelectList)raises(globaldefs::ProcessingFailureException);Description
This operation instructs the EMS to enable (turn on) PM data collection for a list of measurement points. Enabling is done on best-effort basis. If PM could not be enabled for a subset of cases in the pmTPSelectList, a list identifying this subset is returned. PM collection does not start immediately as required by TMF. There are no incomplete collection periods. If PM collection was already on for a TP, the operation is considered successful.
Parameters
For details on PMTPSelect_T structure, see performance::PerformanceManagementMgr_I::disablePMData.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised if pmTPSelectList is empty.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.10.3 performance::PerformanceManagementMgr_I::setTCATPParameter
Synopsis
void setTCATPParameter(in globaldefs::NamingAttributes_T tpName,inout TCAParameters_T tcaParameters)raises(globaldefs::ProcessingFailureException);Description
This operation modifies the values of TCA thresholds on a TP-layer rate measurement point. This operation can be applied to a PTP or CTP. The NMS specifies the TP and layer rate, the granularity, and the values of one or more TCA thresholds to modify. The operation mode is best-effort. If no TCA value is set, the default value is active.
If CTM fails to set TCA parameters, an exception is thrown. A successful return of this operation guarantees that all values are set. If a parameter fails, the remaining parameters are unchanged. CTM does not send events or updates when TCA parameters are changed. It also does not validate the range of PM parameter values.
Note
NMS always makes synchronous calls to this method.
Parameters
CTM support for TCAParameters_T structure is as follows:
•
CTM supports the following layer rates:
–
LR_T1_and_DS1_1_5M
LR_T3_and_DS3_45M
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS24c_and_VC4_8c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c (only on ONS 15454 SONET)
LR_Section_OC1_STS1_and_RS_STM0
LR_Line_OC1_STS1_and_MS_STM0
LR_Section_OC3_STS3c_and_ RS_STM1
LR_Section_OC12_STS12c_and_ RS_STM4
LR_Section_OC48_STS48c_and_ RS_STM16
LR_Section_OC192_STS192c_and_ RS_STM64 (ONLY on ONS 15454 SONET)
LR_Line_OC3_STS3_and_ MS_STM1
LR_Line_OC12_STS12_and_ MS_STM4
LR_Line_OC48_STS48_and_ MS_STM16
LR_Line_OC192_STS192_and_ MS_STM64 (ONLY on ONS 15454 SONET)
–
LR_E1_2M
LR_E3_34M
LR_T3_and_DS3_45M
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS24c_and_VC4_8c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c
LR_Section_OC3_STS3c_and_ RS_STM1
LR_Section_OC12_STS12c_and_ RS_STM4
LR_Section_OC48_STS48c_and_ RS_STM16
LR_Section_OC192_STS192c_and_ RS_STM64
LR_Line_OC3_STS3_and_ MS_STM1
LR_Line_OC12_STS12_and_ MS_STM4
LR_Line_OC48_STS48_and_ MS_STM16
LR_Line_OC192_STS192_and_ MS_STM64
–
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
LR_Section_OC48_STS48c_and_ RS_STM16
LR_Section_OC192_STS192c_and_ RS_STM64
LR_Line_OC48_STS48_and_ MS_STM16
LR_Line_OC192_STS192_and_ MS_STM64
•
CTM supports 15 minute (15min) and 24 hour (24h).
•
This is a sequence of PMThresholdValue_T. It contains the the PMParameterName_T pmParameterName field.
CTM supports the NE PM values listed in Table 3-2, Table 3-3, Table 3-4, Table 3-5, Table 3-6, and Table 3-7.
•
CTM supports PML_NEAR_END_Rx and PML_FAR_END_Rx.
•
CTM supports only TWM_HIGH.
•
Not supported.
•
Supported. The NE accepts only integer values. Therefore, CTM rounds off floating point values to the biggest lower integer. The maximum value supported is 9999999.
•
Not supported.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised if tpName does not reference a terminationPoint object or at least one field of tcaParameters is not valid.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.10.4 performance::PerformanceManagementMgr_I::getTCATPParameter
Synopsis
void getTCATPParameter(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRate_T layerRate,in Granularity_T granularity,out TCAParameters_T tcaParameter)raises(globaldefs::ProcessingFailureException);Description
The purpose of this operation is to retrieve the values of 15-minute or 24-hour PM thresholds on a TP/layer rate measurement point. The operation is best-effort. Results are returned in the out parameter of this operation. The operation can be applied to either a PTP or CTP. The NMS requests the TCA parameters for the particular TP and granularity specified.
Note
Parameters
For a list of supported layer rates and parameter values, see performance::PerformanceManagementMgr_I::setTCATPParameter.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference an terminationPoint object or layerRateList contains undefined rates or Granularity contains an undefined value.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is losT.Compliance
TMF-defined.
3.10.5 performance::PerformanceManagementMgr_I::getCTMHistoryPMData
Synopsis
public void getCTMHistoryPMData(in nmsSession::NmsSession_I client,in PMTPSelectList_T pmTPSelectList,in PMParameterNameList_T pmParameters,in globaldefs::Time_T startTime,in globaldefs::Time_T endTime)raises(globaldefs::ProcessingFailureException);Description
This operation instructs the EMS to store history PM data into a file, and to notify the NMS when the request is complete. Within the request a list of TP/layerRate measurement points and a time frame are specified. For each measurement point, the granularity (15-minute, 24-hour) and location (PML_NEAR_END_RX, PML_FAR_END_RX) can be specified. A filtered set (scoped by the input parameter pmParameters) of PM parameters collected for a particular TP/layerRate measurement point for the specified granularity, location, and time window is made available.
Measurement intervals and the given time frame are considered as half-open intervals to the right (that is, startTime <= t < endTime).
Performance monitoring data on multiple TPs of multiple MEs is transferred in one data file. The PM file format is defined by the TMF. CTM creates the file under the <CTMS_home>/pmData/<username>/ directory. CTM generates a unique filename. This file is kept for six hours after CTM finishes writing the requested PM data. After six hours, the file is deleted. When CTM GateWay/CORBA restarts, it retrieves a list of all existing PM files and deletes them after six hours.
This is an asynchronous operation. Once CTM receives the request, it validates it and the call returns. In the background, CTM begins writing to the file. Upon successful completion, it notifies the NMS session by invoking nmsSession::NmsSession_I::historyPMDataCompleted. If CTM fails to create this file or write into the file, the NMS is notified by invoking nmsSession::NmsSession_I::historyPMDataFailed.
CTM allows only one request from each NMS session at a time.
For ONS 15454 SDH NEs, this operation is not supported on low-order STM-path, but is supported on E3 and DS3 cards, path parameters.
For the DS1 module, this operation is not supported on STS/HO path, but is supported on VT data (SONET) and VC11 data (SDH).
For the E1 module, this operation is not supported on STS/HO path, but is supported on VT data (SONET) and VC12 data (SDH).
For the E3 module, this operation is not supported on HO path, but is supported on VC3 data (SDH).
For the DS3 module, this operation is not supported on HO path, but is supported on VC3 data (SDH). This operation is supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600, and ONS 15600 SDH NEs. CTM raises an EXCPT_UNABLE_TO_COMPLY exception if another request comes from a session for which one request is already in progress. At any given time, CTM has a maximum of eight such requests. This restriction is imposed because multiple requests downgrade the CTM database performance and have an adverse impact on CTM.
Relevance of the validity status for historical PM data and the one-to-one mapping from PM data on the EMS (CTM) to CTM GateWay/CORBA:
•
•
•
Parameters
client
nmsSession::NmsSession_I
In
Reference to NMSSession. It cannot be null and it must be registered with CTM using emsSessionFactory::EmsSessionFactory_I::getEmsSession.
CTM notifies this client about the completion or failure using methods defined in nmsSession::NmsSession_I::historyPMDataCompleted and nmsSession::NmsSession_I::historyPMDataFailed.
pmTPSelectList
PMTPSelectList_T
In
This parameter specifies which history PM data to return. This list cannot be empty.
pmParameters
PMParameterNameList_T
In
This parameter specifies which PM parameters within the scope of the pmTPSelectList shall be contained in the file. An empty list means to store all supported parameters. The returned parameters are best effort; that is, among the parameters specified, only the subset of supported parameters will be stored.
startTime
globaldefs::Time_T
In
Specifies the start of the time window for collection (included).
endTime
globaldefs::Time_T
In
Specifies the end of the time window for collection (excluded).
CTM support for PMTPSelect_T structure for this method is as follows:
•
The name of the object to which this selection applies. CTM supports only ManagedElement, PTP, or CTP name in this field. Note that ManagedElement must be in CTM's management domain. For example, if you change the name of the ME but you pass the old name to this call, no data is written to the file.
•
CTM will support the following layer rates:
–
LR_T1_and_DS1_1_5M
LR_T3_and_DS3_45M
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS24c_and_VC4_8c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c (ONLY on ONS 15454 SONET)
LR_Section_OC3_STS3c_and_ RS_STM1
LR_Section_OC12_STS12c_and_ RS_STM4
LR_Section_OC48_STS48c_and_ RS_STM16
LR_Section_OC192_STS192c_and_ RS_STM64 (ONLY on ONS 15454 SONET)
LR_Line_OC3_STS3_and_ MS_STM1
LR_Line_OC12_STS12_and_ MS_STM4
LR_Line_OC48_STS48_and_ MS_STM16
LR_Line_OC192_STS192_and_ MS_STM64 (ONLY on ONS 15454 SONET)
LR_PHYSICAL_OPTICAL,
LR_POS_100M, (ONLY on ONS 15310 CL, ONS 15310 MA, and ONS 15454 SONET)
LR_POS_GIGABIT, (ONLY on ONS 15310 CL and ONS 15454 SONET)
LR_Fast_Ethernet
LR_Gigabit_Ethernet
LR_COS_100M, (ONLY on ONS 15310 CL, ONS 15310 MA, and ONS 15454 SONET)
LR_COS_Gigabit, (ONLY on ONS 15310 CL and ONS 15454 SONET)
LR_Physical_10_Gigabit_ITU, (ONLY on ONS 15454 SONET)
LR_Physical_2_5_Gigabit_ITU, (ONLY on ONS 15454 SONET)
LR_Optical_Channel, (ONLY on ONS 15454 SONET)
LR_Optical_Multiplex_Section, (ONLY on ONS 15454 SONET)
LR_Optical_Transmission_Section (ONLY on ONS 15454 SONET)
LR_Optical_Transport_Section (ONLY on ONS 15454 SONET)
LR_Optical_Transport_Path (ONLY on ONS 15454 SONET)
LR_Optical_Transport_FEC (ONLY on ONS 15454 SONET)
LR_FC_100_1063M, (ONLY on ONS 15454 SONET)
LR_FC_200_2125M, (ONLY on ONS 15454 SONET)
LR_FICON_1G (ONLY on ONS 15454 SONET)
LR_FICON_2G, (ONLY on ONS 15454 SONET)
LR_8b10b_2_5_Gigabit (ONLY on ONS 15454 SONET)
LR_E1_2M (ONLY on ONS15454SONET)
LR_GFP_Multirate (ONLY on ONS 15310 and ONS15454SONET)
LR_Optical_Transport_EFEC (ONLY on ONS15454SONET)
LR_OCH_ISC_COMPAT (ONLY on ONS15454SONET)
–
LR_E1_2M
LR_E3_34M
LR_T3_and_DS3_45M
LR_STS3c_and_AU4_VC4
LR_STS12c_and_VC4_4c
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS24c_and_VC4_8c
LR_STS48c_and_VC4_16c
LR_STS192c_and_VC4_64c
LR_Section_OC3_STS3c_and_ RS_STM1
LR_Section_OC12_STS12c_and_ RS_STM4
LR_Section_OC48_STS48c_and_ RS_STM16
LR_Section_OC192_STS192c_and_ RS_STM64
LR_Line_OC3_STS3_and_ MS_STM1
LR_Line_OC12_STS12_and_ MS_STM4
LR_Line_OC48_STS48_and_ MS_STM16
LR_Line_OC192_STS192_and_ MS_STM64
LR_Physical_10_Gigabit_ITU
LR_Physical_2_5_Gigabit_ITU
LR_Optical_Channel
LR_Optical_Multiplex_Section
LR_Optical_Transmission_Section
LR_E4_140M
LR_8b10b_2_5_Gigabit
LR_FC_100_1063M
LR_FC_200_2125M
LR_FICON_1G
LR_FICON_2G
LR_Optical_Transport_FEC
LR_Optical_Transport_Path
LR_Optical_Transport_Section
LR_COS_100M
LR_COS_Gigabit
LR_POS_100M
LR_POS_Gigabit
LR_Fast_Ethernet
LR_Gigabit_Ethernet
LR_GFP_Multirate
LR_T1_and_DS1_1_5M
LR_Optical_Transport_EFEC
LR_OCH_ISC_COMPAT
–
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
LR_Section_OC48_STS48c_and_ RS_STM16
LR_Section_OC192_STS192c_and_ RS_STM64
LR_Line_OC48_STS48_and_ MS_STM16
LR_Line_OC192_STS192_and_ MS_STM64
LR_PHYSICAL_OPTICAL
LR_Gigabit_Ethernet (ONLY on ONS 15600)
LR_POS_Gigabit (ONLY on ONS 15600)
•
It only supports PML_NEAR_END_Rx and PML_FAR_END_Rx.
•
15 minute and 24 hour are supported. If this list is empty, data for all granularities is reported.
CTM supports the pmParameter values listed in Table 3-8, Table 3-9, Table 3-10, Table 3-11, Table 3-12, Table 3-13, and Table 3-14.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when startTime or endTime are not valid or client is null or pmTPSelectList is empty.EXCPT_UNABLE_TO_COMPY - Raised when more than one requests are sent from same NMS client.Compliance
CTM-defined.
3.10.6 performance::PerformanceManagementMgr_I::
deleteHistoryPMDataFileSynopsis
public void deleteHistoryPMDataFile(in string fileName)raises(globaldefs::ProcessingFailureException);Description
The NMS can delete the PM data file by invoking this method explicitly. In this case, CTM does not wait for six hours to delete the file. This frees up valuable disk space on the CTM server. It is highly recommended that NMS invoke this method as soon as it retrieves the PM data file from the CTM.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.10.7 performance::PerformanceManagementMgr_I::getTPHistoryPMData
Synopsis
void getTPHistoryPMData(in PMTPSelectList_T pmTPSelectList,in PMParameterNameList_T pmParameters,in globaldefs::Time_T startTime,in globaldefs::Time_T endTime,in unsigned long how_many,out PMDataList_T pmDataList,out PMDataIterator_I pmIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables the NMS to request a filtered set (scoped by the input parameter pmParameters) of the history PM data for a list of TP measurement points. Within the request for each measurement point, granularity (15 min, 24 hr, NA) and location (nearEnd and/or farEnd and/or bidirectional) can be specified. The operation mode is best effort. CTM only supports 24 buckets (6 hours) for 15 min PM. If the NMS requests older history data, CTM throws the EXCPT_NOT_IMPLEMENTED exception. CTM also throws this exception if the NMS requests history data for 24 hour PM.
This operation uses an iterator so that the NMS can deal with a large number of objects.
Note
For a list of supported layer rates and PM parameters, with the exception of ONS 15302, ONS 15305, and ONS 15305 CTC, see performance::PerformanceManagementMgr_I::getCTMHistoryPMData. The list for ONS 15302, ONS 15305, and ONS 15305 CTC is given in this section.
Parameters
CTM support for PMData_T structure is as follows:
•
The name of the termination point.
•
Layer of the collected PM data.
CTM supports the following layer rates for ONS 15302, ONS 15305, and ONS 15305 CTC (see performance::PerformanceManagementMgr_I::getCTMHistoryPMData for the list that applies to other supported NEs).
–
LR_Line_OC3_STS3_and_MS_STM1
LR_Section_OC3_STS3_and_RS_STM1
LR_STS3c_and_AU4_VC4
LR_VT2_and_TU12_VC12
–
LR_Line_OC12_STS12_and_MS_STM4
LR_Line_OC3_STS3_and_MS_STM1
LR_Line_OC48_STS48_and_MS_STM16
LR_Low_Order_TU3_VC3
LR_Section_OC12_STS12_and_RS_STM4
LR_Section_OC3_STS3_and_RS_STM1
LR_Section_OC48_STS48_and_RS_STM16
LR_STS3c_and_AU4_VC4
LR_VT2_and_TU12_VC12
•
Identifies whether this is 15 min or 24 hr data. Only 15 min is supported.
CTM supports the following values for the operation. For CTM support for ONS 15302, ONS 15305, and ONS 15305 CTC, see performance::PerformanceManagementMgr_I::getCTMHistoryPMData for values related to other supported NEs.
CTM supports the pmParamater values listed in Table 3-15 and Table 3-16.
•
ME time at which PM measurement was obtained from the ME.
•
PM values
•
–
Represents the name of the PM measure.
–
CTM supports PML_NEAR_END_Rx and PML_FAR_END_Rx.
–
Value of parameter.
–
Not supported.
–
CTM supports the following string values:
Valid—If the PM data value is valid.
Invalid—If the PM data value is not valid or not available.
Throws
EXCPT_NOT_IMPLEMENTED - Raised when NMS queries history data older than 6 hours for 15 min buckets or 24 hour PM.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when any input parameter is not well formed.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
CTM-defined.
3.10.8 performance::PerformanceManagementMgr_I::getHoldingTime
Synopsis
void getHoldingTime(out HoldingTime_T holdingTime)raises(globaldefs::ProcessingFailureException);Description
EMS is requested to tell the NMS how many hours the PM data records (24 hr/15 min) are held in the EMS. This is the minimum time. If EMS does not store PM data, it is the time supported in the NE (minimum time of all managed NEs).
Note
Parameters
CTM support for HoldingTime_T structure is as follows:
•
Minimum store time in hours for 24-hour data. CTM reports 0 if the PM data holding is indefinite.
•
Minimum store time in hours for 15-minute data. CTM reports 0 if the PM data holding is indefinite.
Throws
EXCPT_NOT_IMPLEMENTED - Raised if EMS is unable to support this service.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_NE_COMM_LOSS - Raised if communication is down to an NE and holding time cannot be retrieved.Compliance
TMF-defined.
3.10.9 performance::PerformanceManagementMgr_I::getAllCurrentPMData
Synopsis
void getAllCurrentPMData(in PMTPSelectList_T pmTPSelectList,in PMParameterNameList_T pmParameters,in unsigned long how_many,out PMDataList_T pmDataList,out PMDataIterator_I pmIt)raises(globaldefs::ProcessingFailureException);Description
This operation enables an NMS to request a filtered set (scoped by the input parameter pmParameters) of the current PM data for a list of TP measurement points. Within the request for each measurement point, granularity (15 min, 24 hr, N/A) and location (nearEnd and/or farEnd and/or bidirectional) can be specified.
Current data is generally marked as incomplete, as the current bin is not completed. If no PM data are available as specified, an empty list is returned.
This operation uses an iterator in order to allow CTM to deal with a large number of objects.
For a list of supported layer rates and PM parameters, see performance::PerformanceManagementMgr_I::getCTMHistoryPMData.
Note
Parameters
For detail of PMData_T structure, see performance::PerformanceManagementMgr_I::getTPHistoryPMData.
Throws
EXCPT_NOT_IMPLEMENTED - Raised when this operation is not supported by the EMS or not supported for a ME type.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when any input parameter is not well formed.EXCPT_NE_COMM_LOSS - Raised when communications to the NE is down.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
TMF-defined.
3.11 protection::ProtectionMgr_I
A handle to an instance of this interface is gained through the getManager operation in emsSession::EmsSession_I. This interface is inherited from common::Common_I.
interface ProtectionMgr_I: common::Common_IIt also implements the getCapabilities method. Operations described in the following subsections are returned to NMS when it invokes getCapabilities.
CTM supports 1:N equipment protection, 1+1 port protection, 2-fiber BLSR, and 4-fiber BLSR protection groups. 1:1 equipment protection is a special case of 1:N equipment protection where N=1.
3.11.1 protection::ProtectionMgr_I::getAllProtectedTPNames
Synopsis
void getAllProtectedTPNames(in globaldefs::NamingAttributes_T pgName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This operation retrieves the list of PTPs that can carry protected traffic for a protection group. The result is independent of the current switch status. The user can enter the name. If there is more than one protection group with the same name, CTM throws the ProcessingFailureException UNABLE_TO_COMPLY.
This operation is only supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600, and ONS 15600 SDH NEs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when pgName does not reference a protectionGroup object.EXCPT_ENTITY_NOT_FOUND - Raised when pgName references object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.11.2 protection::ProtectionMgr_I::getAllProtectionGroups
Synopsis
void getAllProtectionGroups(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out ProtectionGroupList_T pgList,out ProtectionGroupIterator_I pgpIt)raises(globaldefs::ProcessingFailureException);Description
This operation is used by the client to discover all of the protection groups currently in operation for the ME. Note that CTM does not have any protection group for UPSR.
The supported protection group types are PGT_MSP_1_FOR_N, PGT_MSP_1_PLUS_1, PGT_2_FIBER_BLSR, and PGT_4_FIBER_BLSR.
Default names for the protection groups when created through CTC are as follows:
If the PGP configuration is 4-fiber BLSR, there are three protection groups reported for this configuration: two PGT_1_FOR_N component groups and one PGT_4_FIBER_BLSR group.
ONS 15600 only supports PGT_MSP_1_PLUS_1 protection group.
This operation is only supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
Parameters
CTM support for ProtectionGroup_T structure is as follows:
•
Supported. This field contains three tuples. The first tuple contains the EMS name; the second tuple contains the ME name; and the last tuple contains the nativeEMSName of this protection group.
•
Not supported.
•
Supported. The name is reported by the NE. It is Ring Id for 2_FIBER_BLSR and 4_FIBER_BLSR. It is <Ring Id>-EAST or <Ring Id>-WEST for the two component groups of 4-fiber BLSR PGP.
•
Not supported.
•
Supported.
•
Not supported.
•
Supported.
•
Line rate of the PTPs of the protection group.
•
Supported.
•
CTM only supports wtrTime, the values of wtrTime are in seconds.
•
CTM supports BIDIRECTIONAL for 1_PLUS_1 protection group. The values are true and false.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when meName does not reference a managedElement object.EXCPT_ENTITY_NOT_FOUND - Raised when meName references object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
TMF-defined.
3.11.3 protection::ProtectionMgr_I::getProtectionGroup
Synopsis
void getProtectionGroup(in globaldefs::NamingAttributes_T pgName,out ProtectionGroup_T protectionGroup)raises(globaldefs::ProcessingFailureException);Description
This operation is used to get the current status of a protectionGroup. This service is needed so that even if a filter is established, the NMS can query the status of a protection group. If there is more than one protection group with the same name, CTM throws the ProcessingFailureException UNABLE_TO_COMPLY.
This operation is only supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
Parameters
For details on ProtectionGroup_T see protection::ProtectionMgr_I::getAllProtectionGroups.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when protectionGroupName does not reference a protectionGroup.EXCPT_ENTITY_NOT_FOUND - Raised when meName references object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
TMF-defined.
3.11.4 protection::ProtectionMgr_I::performProtectionCommand
Synopsis
void performProtectionCommand(in ProtectionCommand_T protectionCommand,in globaldefs::NamingAttributes_T reliableSinkCtpOrGroupName,in globaldefs::NamingAttributes_T fromTp,in globaldefs::NamingAttributes_T toTp,out SwitchData_T switchData)raises(globaldefs::ProcessingFailureException);Description
This service is used to execute a protection switch. The protection switch can be performed through a protection switch command on a protection group. CTM requests the EMS to move the traffic received from the fromTP to the toTP. The same command is used to clear all existing commands. If there is more than one protection group with the same name, CTM throws the ProcessingFailureException UNABLE_TO_COMPLY.
A protection switch command is used to change the flow of traffic from working to protect or from protect to working entity. All entities that are represented as working entities before the switch will continue to be represented as working entities after the switch. Similarly, all entities that are represented as protect entities before the switch will continue be represented as protect entities after the switch.
For 4-fiber SONET/SDH SPrings, the span switch is performed on the PGT_MSP_1_FOR_N component protection group, and the ring switch on the PGT_4_FIBER_BLSR group. For example, if the switch is on east span, the PGP name should be <Ring Id>-EAST.
For 2-fiber ring switch, it can be either E -> W or W -> E.
For 4-fiber ring switch, it can be Ew (east working) -> Wp (west protecting), Ep -> Ww, Ww -> Ep, and Wp -> Ew.
For 4-fiber span switch, it can be Ew -> Ep, Ep ->Ew, Ww -> Wp, and Wp -> Ww.
CTM validates whether or not fromTp and toTp are part of same protection group. If this validation fails then it throws ProcessingFailureException with EXCPT_INVALID_INPUT. CTM always performs the command on the fromTp for PC_LOCKOUT and PC_EXERCISE. CTM also verifies if it is possible to perform the command; if not, it throws EXCPT_UNABLE_TO_COMPLY.
This operation is only supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
Parameters
CTM support for SwitchData _T structure is as follows:
•
Supported. CTM always reports PT_MSP_APS.
•
Supported. CTM always reports SR_MANUAL.
•
The layer that this switch is relevant to.
•
Identifies the protection group for which protection switch status is being reported.
•
This is the TP that is protected.
–
–
–
–
•
toTp will be reported by CTM.
•
Not supported.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when reliableSinkCtpOrGroupName, fromTp, or toTp reference objects of the correct type, but that are invalid in the context of this operation.EXCPT_ENTITY_NOT_FOUND - Raised when reliableSinkCtpOrGroupName references a CTP or PG object that does not exist, or when fromTp or toTp references a CTP object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised if the EMS is unable to perform the operation.EXCPT_NE_COMM_LOSS - Raised when communications to the managed element is lost.Compliance
TMF-defined.
3.11.5 protection::ProtectionMgr_I::createProtectionGroup
Synopsis
void createProtectionGroup(in PGPCreatData_T pgpCreateData,out ProtectionGroup_THolder createdPGP)raises(globaldefs::ProcessingFailureException);Description
This operation enables the NMS to permanently create a protection group in an ME. The successful result of this operation is the creation of the protection group object. The resulting object is returned. CTM generates an ObjectCreationEvent on successful creation of the protection group.
This operation is only supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs. CTM only supports the creation of 1_PLUS_1, 1_FOR_N, 2-fiber BLSR, and 4-fiber BLSR protection groups.
Note
pgCreateData
PGPCreateData_T
In
The data that describes the protection group to create
createdPGP
ProtectionGroup_T
In
The resulting created protection group
Parameters
CTM support for PGPCreateData_T structure is as follows:
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - This exception is raised in case of non-specific EMS internal failure.EXCPT_NOT_IMPLEMENTED - This exception is raised if the EMS cannot support this service.EXCPT_INVALID_INPUT - This exception is raised when equipment or TP name does not reference an equipment or TP object.EXCPT_ENTITY_NOT_FOUND - This exception is raised when equipment or TP name references objects that does not exist.EXCPT_UNABLE_TO_COMPLY - This exception is raised when the protection group cannot be created.EXCPT_NE_COMM_LOSS - This exception is raised when communication to the ME is lost.Compliance
CTM-defined.
3.11.6 protection::ProtectionMgr_I::deleteProtectionGroup
Synopsis
void deleteProtectionGroup(in globaldefs::NamingAttributes_T pgpName)raises(globaldefs::ProcessingFailureException);Description
This operation allows the NMS to permanently delete a protection group from the ME. The successful result of this operation is the potential deletion of the protection group object. CTM generates an ObjectDeletionEvent on successful deletion of protection group. CTM supports deletion of all protection group types. If there is more than one protection group with the same name, CTM throws the ProcessingFailureException UNABLE_TO_COMPLY.
This operation is only supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
pgpName
globaldefs::NamingAttributes_T
In
The name of the protection group to delete
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_NOT_IMPLEMENTED - Raised if EMS does not support this service.EXCPT_INVALID_INPUT - Raised when pgpName does not reference a protection group object.EXCPT_ENTITY_NOT_FOUND - Raised when pgpName references object which does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the protection group cannot be deleted at the NE.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.11.7 protection::ProtectionMgr_I::getAssociatedProtectionGroup
Synopsis
void deleteProtectionGroup(in globaldefs::NamingAttributes_T pgpName)out protection::ProtectionGroup_T protectionGrp)raises(globaldefs::ProcessingFailureException);Description
This interface is used to retrieve the protection group using the specified PTP name. The PTP name specified can be either the working PTP or the protect PTP.
This operation is only supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL NEs.
Parameters
For details on ProtectionGroup_T, see protection::ProtectionMgr_I::getAllProtectionGroups.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP.EXCPT_ENTITY_NOT_FOUND - Raised when PTP name references object which does not exist.EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.Compliance
CTM-defined.
3.12 session::Session_I
The Session_I interface provides capabilities for managing the client-server connection. It enables either a client or a server to detect communication loss with the associated party. There are two Session_I objects for each communication session between an NMS and an EMS. One Session_I object is maintained on the NMS and the other Session_I object is maintained on the EMS. The Session_I object maintained on the EMS is actually an EmsSession_I, while the Session_I object maintained on the NMS is actually an NmsSession_I (both inherit from Session_I).
Each Session_I object is responsible for pinging the other Session_I object periodically to detect communication failures. CTM invokes this method on NmsSession_I every five minutes. CTM assumes the session is no longer connected and deletes all resources allocated to it if an exception was raised.
Attributes
readonly attribute Session_I associatedSession;This attribute contains a reference to the Session_I on the NMS/EMS associated with the object. This attribute can be checked to verify the NmsSession_I/EmsSession_I association is still valid (particularly in case of communication failures).
3.12.1 session::Session_I::endSession
Synopsis
oneway void endSession();Description
This operation enables a controlled disconnect between parties.
Parameters
None.
Throws
None.
Compliance
TMF-defined.
3.12.2 session::Session_I::ping
Synopsis
void ping();Description
This operation enables the detection of communication loss. CTM pings the NMS every five minutes.
Parameters
None.
Throws
None.
Compliance
TMF-defined.
3.13 mtnmVersion::Version_I
3.13.1 mtnmVersion::Version_I::getVersion
Synopsis
string getVersion();Description
This service returns the version of the IDL that the corresponding EMS object supports.
The format of the returned string is as follows:
Release.Major[.Minor], where Release, Major, and Minor are digit strings.
For example:
•
•
Note
Parameters
None.
Return Value
stringThrows
None.
Compliance
TMF-defined.
3.14 L2 Topology and MLVLAN for ML-Series Ethernet Cards
CTM R7.1 supports L2 Topology and MLVLAN operations for the ML-Series Ethernet cards in ONS 15454 SONET and ONS 15454 SDH releases. You can create an MLVLAN in a L2 Topology. An L2 topology has a collection of MLVLANs and underlying subnetwork connections to support the traffic at the optical layer.
Figure 3-7 show the relationship diagram for various L2 service objects.
Figure 3-7 L2 Service Object Relationship Diagram
CTM supports L2 service interfaces for ONS 15454 SONET and ONS 15454 SDH R4.1 and later.
3.14.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN
Synopsis
void createMLVLAN(in String protocol,in globaldefs::NamingAttributes_T l2TopologyName,in multiLayerSubnetwork::MLVLANCreateData_T mlVlanCreateData,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
Creates a new MLVLAN for a given L2 topology. ObjectCreationEvent is generated when an MLVLAN is successfully created. CTM supports a maximum of 4095 MLVLANs for a L2 topology.
This interface creates a new MLVLAN for a given L2 topology. An ObjectCreationEvent is generated when an MLVLAN is successfully created. CTM supports a maximum of 4095 MLVLANs for an L2 topology.
Note
Parameters
CTM support for MLVLANCreateData_T structure is as follows:
•
Supported. The MLVLAN ID to be used to create the MLVLAN. If it is -1, then CTM assigns the ID for the MLVLAN created. CTM supports MLVLAN ID ranging from 1 to 4095.
•
Not supported.
•
Supported. CTM always enforces the uniqueness of MLVLAN ID.
•
Not supported.
•
Supported. A list of front Ethernet ports associated with the MLVLAN.
Each MLVLANTPData_T structure has the following members:
•
Specifies the front Ethernet port name.
•
Specifies the port type to be configured. CTM supports the following port types:
–
–
•
Specifies the connection type to be configured for the specified port type. If the port type is L2PortType_T.UNI, the following connection types are supported:
–
–
–
If the port type is L2PortType_T.L2PT_NNI then the following connection types are supported:
–
If the connection type is not L2ConnectionType_T.L2CT_QINQ, you can specify the RSTP values.
•
NMS can enable or disable the RSTP state for a non-QinQ drop. CTM supports two port states
–
–
For a QinQ drop this value is ignored if specified.
•
NMS can enable a service or disable a port. CTM support two port states:
–
–
•
CTM support for QOSPolicyData_T structure is described at QOSPolicyData_T.
•
The user VLAN id to be associated with this MLVLAN. If the connection type is L2ConnectionType_T.L2CT_DOT1Q, the valid port VLAN range is 2 - 4096. If the connection type is L2ConnectionType_T.L2CT_UNTAGGED, the port VLAN is ignored.
•
Supported. You can specify CustomerID and ServiceID.
CTM support for MLVLAN_T structure is as follows:
•
Supported. This field contains three tuples. The first tuple has the EMS value. The second tuple has the L2 topology name. The third tuple has the MLVLAN ID that is the same as nativeEMSName.
•
Not supported.
•
Supported. MLVLAN ID is reported.
•
Not supported.
•
Supported. Specifies the list of all front Ethernet ports and associated service type.
If the port type on a port cannot be determined, CTM represents the port type as L2PortType_T.L2PT_UNKNOWN.
If the connection type for a MLVLAN on a port cannot be determined, CTM represents the connection type as L2ConnectionType_T.L2CT_UNKNOWN.
•
Supported. Valid Values are MLVLANState_T.COMPLETE and MLVLANState_T.INCOMPLETE. State Change event is generated if the vlanState changes.
•
Supported. CustomerID and ServiceID are reported.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when one of the following conditions occurs:-l2TopologyName does not reference an L2Topology object.-MLVLAN name does not follow the naming convention.-QOSPolicy is incorrectly specified.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the MLVLAN cannot be created due to the restriction that an L2 topology can only have a maximum of 4095 MLVLAN IDs.Compliance
CTM-defined.
3.14.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANAddFrontPortsSynopsis
void modifyMLVLANAddFrontPorts(in globaldefs::NamingAttributes_T mlVlanName,in multiLayerSubnetwork::MLVLANTPDataList_T tpList,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface adds additional front ports to the existing MVLAN. An AttributeChangeEvent is reported when the front ports are successfully added. CTM does not specify which attribute of the MLVLAN has changed. The NMS must obtain updated MLVLAN_T structure information. If the addition of any of the front ports to MLVLAN fails, CTM generates a ProcessingFailureException. The NMS user must requery the MLVLAN information to obtain the new set of parameters associated with the MLVLAN.
Note
Parameters
For details on MLVLAN_T, MLVLANTPData_T structures, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object or when one or more PTP in the PTP list does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist or when one or more PTP in the PTP list does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the MLVLAN cannot be modified.Compliance
CTM-defined.
3.14.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANDropFrontPortsSynopsis
void modifyMLVLANDropFrontPorts(in globaldefs::NamingAttributes_T mlVlanName,in globaldefs::NamingAttributesList_T tpList,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface drops front ports associated with an existing MLVLAN. An AttributeChangeEvent is reported when the front ports are dropped from the MLVLAN. CTM does not specify which attribute of the MLVLAN has changed. The NMS needs to obtain updated MLVLAN_T structure information. If removal of any front ports associated with the MLVLAN fails, CTM generates a ProcessingFailureException. NMS user has to requery the MLVLAN information to obtain the new set of parameters associated with the MLVLAN.
Note
Parameters
For details on MLVLAN_T structures, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object or when one or more PTP in the PTP list does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist or when one or more PTP in the PTP list does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the MLVLAN cannot be modified.Compliance
CTM-defined.
3.14.4 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANPortStateSynopsis
void modifyMLVLANPortState(in globaldefs::NamingAttributes_T mlVlanName,in multiLayerSubnetwork::MLVLANPortStateList_T tpPortStateList,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface enables or disables specified MLVLAN traffic on the specified list of front ports. An AttributeChangeEvent is reported when one of the MLVLAN parameters is modified. CTM does not specify which attribute of the MLVLAN has changed. The NMS needs to obtain updated MLVLAN_T structure information. If modification of any of the MLVLAN port states fails, CTM generates a ProcessingFailureException. The NMS user has to requery the MLVLAN information to obtain the new set of parameters associated with the MLVLAN.
Note
Parameters
For details on MLVLAN_T structures, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
CTM support for MLVLANTPPortState_T structure is as follows:
•
The front Ethernet port name used by this MLVLAN.
•
The portState is applicable only to the specified MLVLAN. The supported states are:
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object or when one or more PTP in the PTP list does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist or when one or more PTP in the PTP list does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the MLVLAN cannot be modified.Compliance
CTM-defined.
3.14.5 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyMLVLANRSTPState
Synopsis
void modifyMLVLANRSTPState(in globaldefs::NamingAttributes_T mlVlanName,in multiLayerSubnetwork::MLVLANTPrstpStateList_T tpRstpStateList,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface enables or disables specified MLVLAN traffic on the specified list of drop ports. An Attribute Change event is reported when a MLVlan parameter is modified. CTM does not specify which attribute of the MLVLAN has changed. NMS must obtain updated MLVLAN_T structure information. If the modification of a MLVLAN RSTP state fails, CTM generates a ProcessingFailureException. You must issue another query for the MLVLAN information to obtain the new set of parameters associated with the MLVLAN.
Note
Parameters
For details on MLVLAN_T structures, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
CTM support for MLVLANRSTPState_T structure is as follows:
•
The front Ethernet port name used by this MLVLAN.
•
The rstpState is applicable only to the specified non-QinQ drops of the MLVLAN. The supported states are:
–
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object or when one or more PTP in the PTP list does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist or when one or more PTP in the PTP list does not exist.EXCPT_QINQ - Raised when the connection type of the drop port for which RSTP state has to be enabled/disables is QinQ.EXCPT_UNABLE_TO_COMPLY - Raised when the MLVLAN cannot be modified.Compliance
CTM-defined.
3.14.6 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyMLVLANTPQOS
Synopsis
void modifyMLVLANTPQOS(in globaldefs::NamingAttributes_T mlVlanName,in multiLayerSubnetwork::MLVLANTPQOSPolicyList_T tpQosPolicyList,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface modifies the QoS policies of a list of termination points in the specified MLVLAN. An AttributeChangeEvent is reported for each call to this API, even if more than one TP QoS policy has been modified. CTM does not specify which attribute of the MLVLAN has changed. NMS must obtain updated MLVLAN_T structure. Modification of any QoS policy is done on a best effort basis. If modification of any part of the QOSPolicy fails, CTM generates a ProcessingFailureException. The NMS user must requery the MLVLAN information to get the new set of parameters associated with the MLVLAN.
Note
Parameters
For details on MLVLAN_T and QOSPolicy_T structures, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
CTM support for MLVLANTPQOSPolicy_T structure is as follows:
•
The front Ethernet port name used by this MLVLAN for which the QoS policy is to be modified.
•
Refer to QOSPolicyData_T
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when one of the following conditions occur:-mlVlanName passed is not in proper format for MLVLAN name.-tpQosPolicyList contains improper format for TP or QOS policy.-tpQosPolicyList contains the same TP more than once.EXCPT_ENTITY_NOT_FOUND - Raised when one of the following conditions occur:-mlVlanName passed is does not reference an MLVLAN object.-tpQosPolicyList contains TPs that do not reference valid objects.EXCPT_UNABLE_TO_COMPLY - Raised when the QOS policy cannot be modified.Compliance
CTM-defined.
3.14.7 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANCustomerIDServiceIDSynopsis
void modifyMLVLANCustomerIDServiceID(in globaldefs::NamingAttributes_T mlVlanName,in multiLayerSubnetwork::NVSList_T ids,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface modifies the CustomerID and/or ServiceID associated with an existing MLVLAN. An AttributeChangeEvent is reported when CustomerID and/or ServiceID is modified. CTM does not specify which attribute of the MLVLAN has changed. The NMS needs to get an updated MLVLAN_T structure information. If modification of CustomerID or ServiceID fails, CTM generates a ProcessingFailureException. The NMS user has to requery the MLVLAN information to get the new set of parameters associated with the MLVLAN.
Note
Parameters
For details on MLVLAN_T structures, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the MLVLAN cannot be modified.Compliance
CTM-defined.
3.14.8 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getMLVLAN
Synopsis
void getMLVLAN(in globaldefs::NamingAttributes_T mlVlanName,out multiLayerSubnetwork::MLVLAN_T mlVlan)raises(globaldefs::ProcessingFailureException);Description
This interface reports the complete MLVLAN information for a specified MLVLAN name.
Note
Parameters
mlVlanName
globaldefs::NamingAttributes_T
In
The mlVlan name for which the MLVLAN is to be obtained.
mlVlan
MultiLayerSubnetwork::MLVLAN_T
Out
MLVLAN_T structure.
For details on MLVLAN_T structure, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when MLVLAN name is not valid.EXCPT_ENTITY_NOT_FOUND - Raised when MLVLAN name does not exist on the L2Topology.Compliance
CTM-defined.
3.14.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteMLVLAN
Synopsis
void deleteMLVLAN(in globaldefs::NamingAttributes_T mlVlanName)raises(globaldefs::ProcessingFailureException);Description
This interface deletes an existing MLVLAN. CTM generates a ProcessingFailureException if the MLVLAN deletion fails. CTM generates an ObjectDeletionEvent when the MLVLAN is successfully deleted.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when mlVlanName does not reference an MLVLAN object.EXCPT_ENTITY_NOT_FOUND - Raised when mlVlanName references an MLVLAN object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when mlVlan deletion fails.Compliance
CTM-defined.
3.14.10 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANs
Synopsis
void getAllMLVLANs(in globaldefs::NamingAttributes_T l2TopologyName,in unsigned long how_many,out multiLayerSubnetwork::MLVLANList_T mlVlanList,out multiLayerSubnetwork::MLVLANIterator_I mlVlanIt)raises(globaldefs::ProcessingFailureException);Description
This interface lists all MLVLANs for the L2 topology. The NMS user has to specify the L2 topology name. CTM returns a list of all MLVLANs associated with the L2 topology specified.
Note
Parameters
For details on MLVLAN_T structure, see L2 Topology and MLVLAN for ML-Series Ethernet Cards.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
CTM-defined.
3.14.11 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANNames
Synopsis
void getAllMLVLANNames(in globaldefs::NamingAttributes_T l2TopologyName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface lists all the MLVLAN names for the L2 topology.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can support has been reached.Compliance
CTM-defined.
3.14.12 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAssociatedSNCsSynopsis
void getAllAssociatedSNCs(in globaldefs::NamingAttributes_T l2TopologyName,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SNCIterator_I sncIt,out subnetworkConnection::VCATList_T vcatList,out subnetworkConnection::VCATIterator_I vcatIt)raises(globaldefs::ProcessingFailureException);Description
This interface allows CTM to report all the underlying Layer 1 SONET/SDH SNCs that are being used by the specified L2 topology.
Note
Parameters
For details on SubnetworkConnection_T structure, see managedElementManager::ManagedElementManager_I::getAllSNCs.
For details on the VCAT_T structure, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.Compliance
CTM-defined.
3.14.13 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getL2Topology
Synopsis
void getL2Topology(in globaldefs::NamingAttributes_T l2TopologyName,out multiLayerSubnetwork::L2Topology_T l2Topo)raises(globaldefs::ProcessingFailureException);Description
This operation returns the L2 topology structure for the given L2 topology name.
Parameters
l2TopologyName
globaldefs::NamingAttributes_T
In
The name of the L2 topology to retrieve.
l2Topo
multiLayerSubnetwork::L2Topology_T
Out
The retrieved L2 topology.
For details on L2Topology_T structure, see emsMgr::EMSMgr_I::getEMS.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2Topology object that does not exist.Compliance
CTM-defined.
3.14.14 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForSNCSynopsis
void getAssociatedL2TopologyForSNC(in globaldefs::NamingAttributes_T sncName,out multiLayerSubnetwork::L2Topology_T l2Topo)raises(globaldefs::ProcessingFailureException);Description
This operation returns the L2 topology structure associated with a given subnetworkConnection name. CTM reports the L2 topology using the specified Layer 1 SNC. CTM returns an empty L2Topology_T structure if the SNC name specified is currently not associated with any L2 topology in the EMS.
Parameters
For details on L2Topology_T structure, see emsMgr::EMSMgr_I::getAllL2Topologies.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not reference a SubnetworkConnetion object.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references a SubnetworkConnection object that does not exist.Compliance
CTM-defined.
3.14.15 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForMLVLANSynopsis
void getAssociatedL2TopologyForMLVLAN(in globaldefs::NamingAttributes_T mlVlanName,out multiLayerSubnetwork::L2Topology_T l2Topo)raises(globaldefs::ProcessingFailureException);Description
This operation returns the L2 topology structure associated with a given MLVLAN name. CTM returns an empty L2Topology_T structure if the MLVLAN name specified is currently not associated with any L2 topology in the EMS.
Parameters
For details on L2Topology_T structure, see emsMgr::EMSMgr_I::getAllL2Topologies.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when mlVlanName does not reference an MLVLAN object.EXCPT_ENTITY_NOT_FOUND - Raised when mlVlanName references an MLVLAN object that does not exist.Compliance
CTM-defined.
3.14.16 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2
TopologySynopsis
void createL2Topology(in multiLayerSubnetwork::L2TopoCreateData_T createData,out multiLayerSubnetwork::L2Topology_T l2Topo)raises(globaldefs::ProcessingFailureException);Description
This operation provides a way to create a L2 topology, including all the optical SNCs associated with it. The user must associate MLVLANs using the interface method defined in multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN. CTM creates a L2 topology within the same MultiLayerSubnetwork. If NMS specifies L2 topology createData with MEs belonging to a different MultiLayerSubnetwork, CTM throws the ProcessingFailureException EXCPT_UNABLE_TO_COMPLY.
CTM supports point-to-point, hub-and-spoke, and Resilient Packet Ring (RPR) topologies. However, CTM supports the creation of only RPR and point-to-point topologies. CTM treats a hub-and-spoke topology as multiple point-to-point topologies.
This is an asynchronous operation. CTM returns this method after all requests for creating the underlying SNCs are complete. CTM autodiscovers an L2 topology based on the L1 SNCs created. CTM generates OCE for all the L1 SNCs created. CTM also generates L2 topology OCE after the L2 Topology is autodiscovered.
To create an RPR topology, you must specify the complete list of ML-series and/or ML2 (L2/L3) equipment names to be involved in it. RPR consists of all ML-series equipment or all ML2 (L2/L3) equipment or a combination of ML and ML2 (L2/L3) equipment. To create point-to-point topology, you must specify the end TPs of the underlying L1 SNC that needs to be created.
During the L2 topology creation, if any part of the underlying L1 SNC creation fails, CTM generates a ProcessingFailureException. However, CTM autodiscovers the L2 topology in INCOMPLETE state if any SNC was created before the failure occurred. Either the NMS creates the remaining L1 SNCs that failed explicitly, using the interface described in "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section to complete the L2 Topology, or the NMS deletes the L2 topology and recreates the L2 topology using this operation.
For RPR topology, the NMS must specify all the equipment to be involved, in cyclical order and in pairs. There are three different scenarios:
•
•
•
For example, if the NMS is trying to create an RPR topology involving three ML-series cards (M1, M2, and M3) and the SNC between M1-M2 and M3-M1 is of type CCAT and M2-M3 is of type VCAT, then NMS must specify:
–
–
For point-to-point topology, NMS specifies either CCATSNCCreateData_T or VCATSNCCreatedata_T. For creating CCAT point-to-point topology, CCATSNCCreateData_T is populated and VCATSNCCreateData_T is empty. For creating VCAT point-to-point L2 topology, VCATSNCCreateData_T is populated and CCATSNCCreateData_T is empty.
In addition to specifying SNC creation parameters using the SNCCreateData_T structure for each SNC in the L2 topology, NMS can provide a partial or complete list of managed elements, or of both end PTPs of a topological link that is included or excluded in the SubnetworkConnection route during SubnetworkConnection creation. The NMS can specify only one type of object name list during the SubnetworkConnection creation. CTM throws a ProcessingFailureException if the NMS-specified list is not homogenous. CTM throws Processing FailureException with EXCPT_ENTITY_NOT_FOUND as the error reason if any one of the specified managed elements or PTPs does not exist. If the NMS specifies a PTP list, CTM verifies if the PTPs are specified in pairs and each PTP in a pair is associated with each end PTP of the same topological link. CTM uses the first PTP of a pair as the aEnd of the topological link and uses the second PTP of the same pair as the zEnd of the topological link. CTM attempts to route the SNC from aEnd PTP of a PTP pair to zEnd PTP of the same pair on a topological link. CTM throws ProcessingFailureException if SNC cannot be routed from the specified aEnd PTP to the zEnd PTP of a topological link. NMS then must interchange the aEnd and zEnd PTPs specified, provide a different PTP pair, or delete the PTP pair from the include or exclude list. CTM throws ProcessingFailureException if at least one PTP is not associated with a topological link. NMS must ensure that the sequence of the object name list conforms to the sequence of the objects existing in the network. CTM throws ProcessingFailureException if the sequence is nonconforming.
CTM R7.1 does not support the creation of L2 Topology in which SNCs have more than one source point and destination endpoint in SNCCreateData_T.aEnd or SNCCreateData_T.zEnd.
CTM supports the creation of L2 topology containing VCAT SNCs. For point-to-point topology, either the CCAT SNC or VCAT SNC is specified. PRP topology can consist of both CCAT and VCAT SNCs.
Note
Parameters
CTM support for L2TopologyCreateData_T structure is as follows:
•
Supported. Used as the L2 topology name.
•
Not supported
•
Guarantees the uniqueness if all L2 topologies are created by CTM only. If any other tool is used for L2 topology creation, CTM does not guarantee uniqueness.
•
Not supported.
•
Not supported. LayerRate is specified as part of SNCCreateData_T an and VCAT SNCCreateData_T structure
•
The type of the L2 topology. Valid values are L2TopoType.PT2PT and L2TopoType.RPR.
•
Supported.
CTM support for SNCCreateData_T structure for the L2 topology creation is as follows:
–
Not supported.
–
Not supported.
–
Not supported.
–
Not supported. CTM always creates CD_BI (bidirectional) circuit.
–
Supported. CTM will support UNPROTECTED and FULLY_PROTECTED.
–
CTM supports all values defined by TMF.
If NMS requests Unprotected SNC on BLSR ring, CTM creates the SNC. The same is true for unprotected SNC on 1+1 protection.
If NMS specifies EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, CTM expects the value of staticProtectionLevel to be UNPROTECTED. These values indicate that CTM must create a PCA.
–
Not supported.
–
Not supported.
–
Not supported.
–
Supported. CTM supports the following the L2 topology layer rates:
ONS 15454 SONET
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
ONS15454SDH
LR_Low_Order_TU3_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
•
Not supported.
•
Supported. CTM expects a list of ME or PTP names at the endpoints of the topological link, or the CTP name pair representing the endpoints of the span, to be included in the SubnetworkConnection route.
•
–
•
Supported. CTM expects a list of ME or PTP names at the endpoints of the topological link to be excluded in the SubnetworkConnection route.
•
Supported. If the topology is RPR, you specify an ML-series equipment name to be used for creating the L2 Topology. If the topology is point-to-point, you specify the aEnd TP name. Point-to-point topology can be created with one end-point on the ML-series equipment and the other end-point on ML-series, G-series, or OCn equipment.
•
Supported. If the topology is RPR, you specify an ML-series equipment name to be used for creating the L2 topology. If the topology is point-to-point, you specify the zEnd TP name. Point-to-point topology can be created with one end-point on the ML-series equipment and the other end-point on ML-series, G-series, or OCn equipment.
•
Supported. This list can be used to provide additional parameters for SNC creation. CTM supports the following values.
Parameters
•
Supported.
CTM support for VCATSNCCreateData_T structure for the L2 topology creation is as follows:
•
Not supported.
•
CTM guarantees the uniqueness of all VCATs created in CTM. It is not guaranteed if other tools were used for VCAT SNC creation.
•
Not supported.
•
Not supported. CTM will support CD_BI (bidirectional).
•
Supported. Only symmetric VCAT SNCs are supported. If set to true, all members have to be bidirectional L1 SNCs. The VCAT layer rate is the same in both directions. If set to false, all members are unidirectional L1 SNCs.
•
Supported. CTM supports the following values:
–
–
–
•
Supported. CTM supports the following values:
–
–
•
Supported. If the topology is an RPR topology, user specifies an ML-series equipment name to be used for creating the L2 topology. If the topology is a point-to-point topology, CTM expects this field to be an FTP representing the information up to the slot level of the card involved in the VCAT SNC.
•
Supported. If the topology is an RPR topology, user specifies an ML-series equipment name to be used for creating the L2 topology. If the topology is a point-to-point topology, CTM expects this field to be an FTP representing the information up to the slot level of the card involved in the VCAT SNC.
•
Supported. At least one L1 SNC should be created at the time of VCAT SNC creation. CTM expects the user to specify the create data information required to create the L1 SNCs in the data structure.
•
Not supported.
•
Not supported. StaticProtectionLevel is specified as part of SNCCreateData_T and VCATSNCCreateData_T structure.
•
Supported. You can choose to specify bandwidth parameters. By default, bandwidth parameters have a zero value. If you choose to enter a specific bandwidth value, then you must also specify its corresponding CoS value. The default value for all CoS values is N/A. The sum of all the bandwidth parameters must be between 1 and 99. CoS commit value must be in the range 0-7. The following are the supported bandwidth parameters (Group1Bandwidth and Group2Bandwidth are multicast bandwidth parameters, and their corresponding CoS values are Group1CoS and Group2CoS):
–
–
–
–
–
–
–
–
–
–
–
–
–
Caution
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when one or more input tpList is invalid or when the specified layer rate is an invalid layer rate. This is also thrown when the user does not specify the corresponding CoS values for the bandwidth parameters specified.EXCPT_ENTITY_NOT_FOUND - Raised when one or more input tpList is does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when a layer rate is not supported for L2Topology creation or when CTM cannot create the L2Topology for the specified layer rate. Raised if the VCAT SNC cannot be created and activated because CTP conflicts with other VCAT SNC or NE does not support this VCAT SNC creation.EXCPT_OBJECT_IN_USE - Raised when the specified L2Topology already exists.EXCPT_NE_COMM_LOSS - Raised when one the ManagedElement specified as part of L2Topology creation is not reachable.Compliance
CTM-defined.
3.14.17 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteL2TopologySynopsis
void deleteL2Topology(in globaldefs::NamingAttributes_T l2TopologyName)raises(globaldefs::ProcessingFailureException);Description
This interface provides a method to delete an L2 topology and all the SNCs associated with it. If there are any MLVLANs associated with the L2 topology when this interface method is invoked, CTM throws a ProcessingFailureException. The NMS must ensure that there are no MLVLANs associated with the L2 topology, to ensure that the L2 topology is successfully deleted.
Note
Parameters
l2TopologyName
globaldefs::NamingAttributes_T
In
The name of the L2 topology to be deleted.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not refer to an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when l2TopologyName specified has MLVLAN associated with it.EXCPT_UNABLE_TO_COMPLY - Raised when one or more of the ManagedElement associated with the specified L2Topology is not accessible.Compliance
CTM-defined.
3.14.18 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyL2TopologySynopsis
void modifyL2Topology(in globaldefs::NamingAttributes_T l2TopologyName,in globaldefs::NVList_T l2ModifyData,out multiLayerSubnetwork::L2Topology_T l2Topo)raises(globaldefs::ProcessingFailureException);Description
This operation provides a way to modify an L2 topology. It enables the OSS to modify the L2 topology for the bandwidth allocation parameters. For more information on the bandwidth allocation and CoS commit parameters, see multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2 Topology. This interface is used when the L2 topology is discovered, but it cannot be used when the L2 topology synchronization state is L2TopoSyncState.L2NOTREADY.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when l2TopologyName does not refer to an L2Topology object.EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when one or more of the ManagedElement associated with the specified L2Topology is not accessible.Compliance
CTM-defined.
3.14.19 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAvailableMLEquipmentOrTPNamesSynopsis
void getAllAvailableMLEquipmentOrTPNames(in globaldefs::NamingAttributesList_T managedElementList,in multiLayerSubnetwork::L2TopoType_T topoType,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface provides a list of all available ML-series equipment names that can be used in creating an RPR L2 Topology, or a list of all available ML-series TP names that can be used in creating a point-to-point L2 topology. The returned list of ML-series equipment or TP names does not guarantee capability to create an L2 Topology. The list of ML-series equipment or TP names indicates the equipment or TP that is not participating in an L2 topology at this time.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.EXCPT_INVALID_INPUT - Raised when any of the ManagedElement names does not refer to a ManagedElement object.EXCPT_ENTITY_NOT_FOUND - Raised when any of the ManagedElements does not exist in CTM.Compliance
CTM-defined.
3.15 E-Series VLAN Interfaces
VLAN is required for single-card mode or multicard mode Ethernet SNC creation on E-series cards for ONS 15327 and ONS 15454 NEs. CTM provides methods to create and delete VLAN. In CTM, VLAN is created within a subnetwork and is available to all objects of a subnetwork in EMS. Each VLAN is described by a unique name, an ID, and the name of the multilayer subnetwork. A network partition can contain more than one multilayer subnetwork. VLAN names and IDs are unique within the network partition.
typedef long VlanId;struct Vlan_T {VlanId id;string name;globaldefs::NamingAttributes_T subnetname;};3.15.1 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createVLAN
Synopsis
void createVLAN(in globaldefs::NamingAttributes_T subnetname,in VlanId vlanId,in string name,out Vlan_T vlan)raises(globaldefs::ProcessingFailureException);Description
Creates a new VLAN with an id and name associated with the multiLayer subnetwork.
The scope of VLAN is network partition wide. A network partition is a collection of the multilayer subnetwork.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when a vlanId or subnetname is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when a subnetname does not exist in ems.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.15.2 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteVLAN
Synopsis
void deleteVLAN(in globaldefs::NamingAttributes_T subnetname,in VlanId vlanId)raises(globaldefs::ProcessingFailureException);Description
This method deletes an existing VLAN with a VLAN ID associated with the multiLayer subnetwork.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when a vlanId or subnetname is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when a subnetname does not exist in ems.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
3.15.3 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVLANs
Synopsis
void getAllVLANs(in globaldefs::NamingAttributes_T subnetname,out VlanList_T vlanList)raises(globaldefs::ProcessingFailureException);Description
This method returns a list of all VLANs for the multiLayer subnetwork. All the VLANs for the network partition that contain the multiLayer subnetwork are reported.
Note
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when a subnetname is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when a subnetname does not exist in ems.EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.Compliance
CTM-defined.
