Table Of Contents

Using CTM GateWay/CORBA Interfaces

3.1  common::Common_I

3.1.1  common::Common_I::getCapabilities

3.2  emsMgr::EMSMgr_I

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.3  emsSession::EmsSession_I

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::getEmsPublicKey

3.4.2  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair

3.4.3  emsSessionFactory::EmsSessionFactory_I::getEmsSession

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
Names

3.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.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::
getAllManagedElements

3.7.4  managedElementManager::ManagedElementManager_I::
getAllManagedElementNames

3.7.5  managedElementManager::ManagedElementManager_I::getAllPTPs

3.7.6  managedElementManager::ManagedElementManager_I::
getAllPTPNames

3.7.7  managedElementManager::ManagedElementManager_I::
getContainedInUseTPs

3.7.8  managedElementManager::ManagedElementManager_I::
getContainedInUseTPNames

3.7.9  managedElementManager::ManagedElementManager_I::
getContainedPotentialTPs

3.7.10  managedElementManager::ManagedElementManager_I::
getContainedPotentialTPNames

3.7.11  managedElementManager::ManagedElementManager_I::
getContainingSubnetworkNames

3.7.12  managedElementManager::ManagedElementManager_I::
getAllTopologicalLinksForME

3.7.13  managedElementManager::ManagedElementManager_I::
getManagedElement

3.7.14   managedElementManager::ManagedElementManager_I::getTP

3.7.15  managedElementManager::ManagedElementManager_I::
getAssociatedTopologicalLinks

3.7.16  managedElementManager::ManagedElementManager_I::setTPData

3.7.17  managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSNCProvisioning

3.7.18  managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSNCProvisioning

3.7.19  managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSNCProvisioning

3.7.20  managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSNCProvisioning

3.7.21  managedElementManager::ManagedElementManager_I::
getAllSrcFTPsForSNCProvisioning

3.7.22  managedElementManager::ManagedElementManager_I::
getAllDestFTPsForSNCProvisioning

3.7.23  managedElementManager::ManagedElementManager_I::
forceNEResync

3.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I

3.8.1  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllEdgePoints

3.8.2  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElements

3.8.3  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElementNames

3.8.4  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllSubnetworkConnections

3.8.5  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsWithTP

3.8.6  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNames

3.8.7  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesWithTP

3.8.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinks

3.8.9  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinkNames

3.8.10  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getMultiLayerSubnetwork

3.8.11  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getCTPsAndTopologicalLink

3.8.12  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getSNC

3.8.13  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getTopologicalLink

3.8.14  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
createAndActivateSNCFromUserLabel

3.8.15  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addDrops

3.8.16  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deactivateAndDeleteSNC

3.8.17  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC

3.8.18  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCs

3.8.19  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCNames

3.8.20  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATMemberSNCs

3.8.21  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllVCATMemberSNCNames

3.8.22  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createVCAT

3.8.23  multiLayerSubnetwork::MultiLayerSubnetwokMgr_I::deleteVCAT

3.8.24  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addMemberSNCsToVCAT

3.8.25  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteMemberSNCsFromVCAT

3.8.26  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteAllMemberSNCFromVCAT

3.8.27  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getValidSubnetworkConnectionsForMerge

3.8.28  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::upgrade

3.9  nmsSession::NmsSession_I

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::
deleteHistoryPMDataFile

3.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  session::Session_I

3.12.1  session::Session_I::endSession

3.12.2  session::Session_I::ping

3.13  mtnmVersion::Version_I

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::
modifyMLVLANAddFrontPorts

3.14.3  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANDropFrontPorts

3.14.4  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANPortState

3.14.5  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyMLVLANTPQOS

3.14.6  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANCustomerIDServiceID

3.14.7  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getMLVLAN

3.14.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteMLVLAN

3.14.9  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANs

3.14.10  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANNames

3.14.11  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAssociatedSNCs

3.14.12  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getL2Topology

3.14.13  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForSNC

3.14.14  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForMLVLAN

3.14.15  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2
Topology

3.14.16  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteL2Topology

3.14.17  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyL2Topology

3.14.18  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAvailableMLEquipmentOrTPNames

3.15   E-Series and G-Series VLAN Interfaces

3.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:

•common::Common_I

•emsMgr::EMSMgr_I

•emsSession::EmsSession_I

•emsSessionFactory::EmsSessionFactory_I

•equipment::EquipmentInventoryMgr_I

•maintenanceOps::MaintenanceManager_I

•managedElementManager::ManagedElementManager_I

•multiLayerSubnetwork::MultiLayerSubnetworkMgr_I

•nmsSession::NmsSession_I

•performance::PerformanceManagementMgr_I

•protection::ProtectionMgr_I

•session::Session_I

•mtnmVersion::Version_I

•L2 Topology and MLVLAN for ML-Series Ethernet Cards

•E-Series and G-Series VLAN Interfaces

---

Note Iterator interfaces defined by the TMF are not listed. CTM implements iterator interfaces according to the TMF definition.

---

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

Name	Type	Input/Output	Description
capabilities	CapabilityList_T	out	List of capabilities of this manager object. It is a name-value pair, where the name represents the feature or capability and the value represents the support or nonsupport of the specified feature or capability.

A Capability_T value is used to identify a functionality supported by the EMS across the NML-EML interface. It is a name-value pair, where the name represents the feature or capability and the value represents the support or nonsupport of the specified feature or capability.

The EMS capabilities for this release include individual Interface Definition Language (IDL) operation support. The feature or capability name uses the following convention to identify an IDL operation:

module_name::interface_name::operation_name

The currently defined values are:

•Supported—The specified feature or capability is fully or partially supported across the network management layer-element management layer (NML-EML) interface. An operation might be partially supported if not all values of the parameters are supported.

•Unsupported—The specified feature or capability is not supported across the NML-EML interface.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal Element Management System (EMS) failure.

Compliance

TMF-defined.

3.2  emsMgr::EMSMgr_I

The EMSMgr_I interface accesses operations that deal with the EMS itself. A handle to an instance of this interface is gained through the emsSession::EmsSession_I::getManager operation in emsSession. This interface is inherited from common::Common_I.

interface EMSMgr_I:common::Common_I

This interface implements the getCapabilities method. Operations described in the following sections are returned to the 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 allows 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 cause or severity.

The ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send clear for threshold crossing alert (TCA) events. TCAs are not reported in the eventList that is returned by this method. The ONS 15501, ONS 15530, and 15540 do send clear for threshold crossing alerts. TCAs are reported in the eventList that is returned by this method.

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.

Parameters

Name	Type	Input/Output	Description
excludeProbCauseList	notifications::ProbableCauseList_T	In	List of probable causes to exclude (for which events should not be reported)
excludeSeverityList	notifications::PerceivedSeverityList_T	In	List of severities to exclude from the output event list
how_many	unsigned long	In	Maximum number of alarms to report in the first batch
eventList	notifications::EventList_T	Out	First batch of alarms
eventIt	notifications::EventIterator_I	Out	Iterator to retrieve the remaining alarms

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 allows an NMS to request all active alarms for the EMS. Some alarms can be filtered out (excluded) by specifying their severities.

The result of this operation is independent of the filtering set up by the NMS for the notification service.

Parameters

Name	Type	Input/Output	Description
excludeSeverityList	notifications::PerceivedSeverityList_T	In	List of severities to exclude from the output event list
how_many	unsigned long	In	Maximum number of alarms to report in the first batch
eventList	notifications::EventList_T	Out	First batch of alarms
eventIt	notifications::EventIterator_I	Out	Iterator to retrieve the remaining alarms

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 operation allows an NMS to request all subnetworks that are under the control of the EMS.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of subnetworks to return in the first batch
sList	multiLayerSubnetwork::SubnetworkList_T	Out	First batch of subnetworks
sIt	multiLayerSubnetwork::SubnetworkIterator_I	Out	Iterator to retrieve the remaining subnetworks

CTM supports MultiLayerSubnetwork_T as follows:

•globaldefs::NamingAttributes_T name

–Supported. This field contains two tuples. The first tuple identifies the EMS; the second tuple is the same as nativeEMSName. The name is defined by the user in the CTM client.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported.

•string owner

–Not supported.

•Topology_T subnetworkType

–Supports TOPO_MESH.

•transmissionParameters::LayerRateList_T supportedRates

–Not supported.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 the same behavior as the "emsMgr::EMSMgr_I::getAllTopLevelSubnetworks" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of subnetworks to return in the first batch
sList	globaldefs::NamingAttributesList_T	Out	First batch of subnetwork names
sIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining subnetwork names

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 allows an NMS to request all of the top-level topological links that are under the control of the EMS. Top-level topological link is a topological link in which the end points of the topological link exists in two different multilayer subnetworks.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of top-level topological links to return in the first batch
topoList	topologicalLink::TopologicalLinkList_T	Out	First batch of top-level topological links
topoIt	topologicalLink::TopologicalLinkIterator_I	Out	Iterator to retrieve the remaining top-level topological links

CTM support for TopologicalLink_T structure is described in the following list:

•globaldefs::NamingAttributes_T name

–Supported. This field has two tuples. The first tuple is for the EMS. The second is for the topological link. The value in the second tuple is the same as the nativeEMSName field except for Y-cable links, which will have "::1" and "::2" appended to the nativeEMSName to identify the two legs of the Y-cable link.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported. For naming conventions, see the "2.2.5  Naming Conventions" section on page 2-34.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction. CTM supports:

–CD_BI for bidirectional links

–CD_BI_EW for bidirectional East to West links

–CD_BI_WE for bidirectional West to East links

–CD_UNI for unidirectional links

–CD_UNI_EW for unidirectional East to West links

–CD_UNI_WE for unidirectional West to East links

•transmissionParameters::LayerRate_T rate. Supported. Possible values are:

–LR_DSR_OC3_STM1 (for physical link)

–LR_DSR_OC12_STM4 (for physical link)

–LR_DSR_OC48_STM16 (for physical link)

–LR_DSR_OC192_STM64 (for physical link)

–LR_Physical_2_5_Gigabit_ITU (for WDM physical link)

–LR_Physical_10_Gigabit_ITU (for WDM physical link)

–LR_Line_OC3_STS3_and_MS_STM1 (for SONET/SDH link)

–LR_Line_OC12_STS12_and_MS_STM4 (for SONET/SDH link)

–LR_Line_OC48_STS48_and_MS_STM16 (for SONET/SDH link)

–LR_Line_OC192_STS192_and_MS_STM64 (for SONET/SDH link)

–LR_OCH_2_5_Gigabit_ITU (for WDM OCH link)

–LR_OCH_10_Gigabit_ITU (for WDM OCH link)

–LR_Optical_Transmission_Section (for OTS link)

–LR_Optical_Multiplex_Section (for OMS link)

–LR_Not_Applicable (for CTM layer 2 link)

•globaldefs::NamingAttributes_T aEndTP

–Supported.

•globaldefs::NamingAttributes_T zEndTP

–Supported.

•globaldefs::NVSList_T additionalInfo

–Supported parameters are listed in the following table.

Managed Element Type	Parameter Name	Supported Parameter Values
All ManagedElements that support topological links	provType	AUTODISCOVERED MANUAL UNMANAGED
All ManagedElements that support topological links	linkStatus	LINK_VALID LINK_INVALID
All ManagedElements that support topological links	linkProtectionType	PROT_ONE_PLUS_ONE PROT_BLSR_2F PROT_BLSR_4F PROT_BLSR_2F_PCA PROT_BLSR_4F_PCA PROT_PCA PROT_TUNNEL PROT_UNPROTECTED PROT_UNKNOWN PROT_NOT_APPLICABLE PROT_PARTIALLY_PROTECTED PROT_YCABLE
All ManagedElements that support topological links	linkCost	int, 0 to 1024
ONS 15530 and ONS 15540	connectionType	Inter-NE Intra-NE

Throws

globaldefs::ProcessingFailureException:

EXCPT_NOT_IMPLEMENTED

This exception is raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR 

This exception is raised in case of non specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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 the same behavior as the "emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of top-level topological links to return in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of top-level topological link names
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining top-level topological link names

Throws

globaldefs::ProcessingFailureException:

EXCPT_NOT_IMPLEMENTED 

This exception is raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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 interface allows 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

Name	Type	Input/Output	Description
topoLinkName	globaldefs::NamingAttributes_T	In	Name of the topological link
topoLink	TopologicalLink::TopologicalLink_T	Out	Top-level topological link

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when topoLinkName does not reference a top level topological link object.

EXCPT_ENTITY_NOT_FOUND

This exception is 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 interface allows an NMS to create a topological link manually between two MEs. CTM supports topological link creation between MEs belonging to the same MultiLayerSubnetwork. 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 a ObjectCreation event notification when a new topological link is created.

---

Note TLCreateData_T is a CTM-defined data structure.

---

---

Note CTM creates topological links between two PTPs even if there are no existing physical link connection in the network. To actually enable traffic through the link, the NMS has to ensure physical link connectivity and enable SDCC on the topological link.

---

This interface is supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327 SONET, ONS 15600 SONET, ONS 15600 SDH, and for unmanaged NEs.

Parameters

Name	Type	Input/Output	Description
createData	topologicalLink::TLCreateData_T	In	Data structure containing details for creating new topological links.
topologicalLink	topologicalLink::TopologicalLink_T	Out	Created topological link information.

CTM support for TLCreateData_T structure is described below:

•string userLabel

–Supported. Value of this field will be assigned to name of newly created topological link.

•boolean forceUniqueness

–CTM will guarantee uniqueness of topological link names.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction. CTM supports:

–CD_BI for bidirectional links

–CD_BI_EW for bidirectional East to West links

–CD_BI_WE for bidirectional West to East links

–CD_UNI for unidirectional links

–CD_UNI_EW for unidirectional East to West links

–CD_UNI_WE for unidirectional West to East links

•transmissionParameters::LayerRate_T rate. Supported Layer Rates are:

–LR_DSR_OC3_STM1 (for physical link)

–LR_DSR_OC12_STM4 (for physical link)

–LR_DSR_OC48_STM16 (for physical link)

–LR_DSR_OC192_STM64 (for physical link)

–LR_Physical_2_5_Gigabit_ITU (for WDM physical link)

–LR_Physical_10_Gigabit_ITU (for WDM physical link)

–LR_Line_OC3_STS3_and_ MS_STM1 (for SONET/SDH link)

–LR_Line_OC12_STS12_and_ MS_STM4 (for SONET/SDH link)

–LR_Line_OC48_STS48_and_ MS_STM16 (for SONET/SDH link)

–LR_Line_OC192_STS192_and_ MS_STM64 (for SONET/SDH link)

–LR_OCH_2_5_Gigabit_ITU (for WDM OCH link)

–LR_OCH_10_Gigabit_ITU (for WDM OCH link)

–LR_Optical_Transmission_Section (for OTS link)

–LR_Optical_Multiplex_Section (for OMS link)

•globaldefs::NamingAttributes_T aEndTP

–Supported.

•globaldefs::NamingAttributes_T zEndTP

–Supported.

•globaldefs::NVSList_T additionalCreationInfo

–Supported parameters are listed in the following table.

Managed Element Type	Parameter Name	Supported Parameter Values
All ManagedElements that support topological links	linkProtectionType	PROT_ONE_PLUS_ONE
All ManagedElements that support topological links	linkCost	int, 1 to 2147483647

•globaldefs::sSrlgGroupList_T srlgGroupListValue

–Supported. This field holds the SRLG group values. This is an optional parameter. The user can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.

Throws

globaldefs::ProcessingFailureException:

EXCPT_NOT_IMPLEMENTED 

This exception is raised if EMS cannot support this service.

EXCPT_INVALID_INPUT

This exception is raised if input createData is not valid.

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific EMS internal failure.

Compliance

CTM-defined.

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 interface allows an NMS to create a Y-Cable topological link manually between two MEs. Y-Cable links are bidirectional links from one source PTP to two destination PTPs. (TMF limits topological links to one source and one destination PTP.)

CTM reports two topological links for a Y-Cable link. Both links have the same nativeEMSName. See the "2.2.6.1  TopologicalLink" section on page 2-55.

The destination of the Y-Cable link must be on a DWDM card on either a ONS 15454 SONET, ONS 15454 SDH, or ONS155xx NE.

CTM generates two ObjectCreationEvent notifications when a new Y-Cable topological link is created. The topological link 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

Name	Type	Input/Output	Description
createData	topologicalLink:MTLCreateData_T	In	Data structure containing details for creating new Y-Cable topological link.
topologicalLink	topologicalLink::TopologicalLink_T	Out	One leg of the created Y-Cable topological link information.

CTM support for MTLCreateData_T structure is described below:

•string userLabel

–Supported. Value of this field will be assigned to nativeEMSName of the newly created topological link.

•boolean forceUniqueness

–CTM will guarantee uniqueness of topological link names.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction. CTM supports:

–CD_BI for bidirectional links

–CD_BI_EW for bidirectional East to West links

–CD_BI_WE for bidirectional West to East links

–CD_UNI for unidirectional links

–CD_UNI_EW for unidirectional East to West links

–CD_UNI_WE for unidirectional West to East links

•transmissionParameters::LayerRate_T rate. Supported Layer Rates are:

–LR_Physical_2_5_Gigabit_ITU

–LR_Physical_10_Gigabit_ITU

–LR_DSR_OC3_STM1

–LR_DSR_OC12_STM4

–LR_DSR_OC48_STM16

–LR_DSR_OC192_STM64

•globaldefs::NamingAttributesList_T aEndTPs

–Supported; should contain only one PTP.

•globaldefs::NamingAttributesList_T zEndTPs

–Supported; should contain two PTPs on the same ME.

•globaldefs::NVSList_T additionalInfo

–Supported parameters are listed in the following table.

Managed Element Type	Parameter Name	Supported Parameter Values
All ManagedElements that support topological links	linkCost	int, 1 to 2147483647

•globaldefs::sSrlgGroupList_T srlgGroupListValue

–Supported. This field holds the SRLG group values. This is an optional parameter. The user can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.

Throws

globaldefs::ProcessingFailureException:

EXCPT_NOT_IMPLEMENTED 

This exception is raised if EMS cannot support this service.

EXCPT_INVALID_INPUT

This exception is raised if createData input is not valid.

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific 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 interface allows an NMS to delete a topological link manually between two NEs. CTM throws the exception EXCPT_UNABLE_TO_COMPLY if an attempt is made to delete an autodiscovered topological link or if the topological link cannot be deleted in the current state. CTM generates a ObjectDeletion Event notification when a topological link is deleted.

---

Note CTM deletes topological links between two PTPs even if there is a physical link connection in the network. NMS has to ensure disabling of SDCC, deletion of all circuits carried through the link and removal of the physical link connectivity.

---

This interface is supported for ONS 15216, ONS 15310, ONS 15327 SONET, ONS 15454 SONET, ONS 15454 SDH, ONS 155xx, ONS 15600 SONET, ONS 15600 SDH, and unmanaged NEs.

Parameters

Name	Type	Input/Output	Description
topoLinkName	globaldefs::NamingAttributes_T	In	The name of the topological link to be deleted

Throws

globaldefs::ProcessingFailureException:

EXCPT_INVALID_INPUT

This exception is raised if input createData is not valid.

EXCPT_ENTITY_NOT_FOUND 

Raised if the specified topological link name does not exist in CTM.

EXCPT_NOT_IMPLEMENTED 

This exception is raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_UNABLE_TO_COMPLY

This exception is raised if an attempt is made to delete an autodiscovered topological link.

Compliance

CTM-defined.

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 interface allows an NMS to modify some of the parameters of the existing topological link. The following parameters can be modified using modifyTopologicalLink API:

•Description of the topological link

•Cost attribute (can be modified for SONET and SDH links only)

•Shared Risk Link Group (SRLG) values (can be modified for SONET and SDH links only)

Parameters

Name	Type	Input/Output	Description
createData	topologicalLink::TLCreateData_T	In	Data structure containing details for creating a new topological link.
topologicalLink	topologicalLink::TopologicalLink_T	Out	Information on the created topological link.

CTM support for TLCreateData_T structure is described below:

•string userLabel

–Supported. Value of this field will be assigned to the name of the newly created topological link.

•boolean forceUniqueness

–CTM will guarantee uniqueness of topological link names.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction. CTM supports:

–CD_BI for bidirectional links

–CD_UNI for unidirectional links

•transmissionParameters::LayerRate_T rate. Supported Layer Rates are:

–LR_Physical_2_5_Gigabit_ITU (for WDM physical link)

–LR_Physical_10_Gigabit_ITU (for WDM physical link)

–LR_DSR_OC3_STM1 (for physical link)

–LR_DSR_OC12_STM4 (for physical link)

–LR_DSR_OC48_STM16 (for physical link)

–LR_DSR_OC192_STM64 (for physical link)

–LR_Line_OC3_STS3_and_MS_STM1 (for SONET/SDH link)

–LR_Line_OC12_STS12_and_MS_STM4 (for SONET/SDH link)

–LR_Line_OC48_STS48_and_MS_STM16 (for SONET/SDH link)

–LR_Line_OC192_STS192_and_MS_STM64 (for SONET/SDH link)

–LR_OCH_2_5_Gigabit_ITU (for WDM OCH link)

–LR_OCH_10_Gigabit_ITU (for WDM OCH link)

–LR_Optical_Transmission_Section (for OTS link)

–LR_Optical_Multiplex_Section (for OMS link)

•globaldefs::NamingAttributesList_T aEndTPs

–Supported.

•globaldefs::NamingAttributesList_T zEndTPs

–Supported.

•globaldefs::NVSList_T additionalCreationInfo

–Supported parameters are listed in the following table.

Managed Element Type	Parameter Name	Supported Parameter Values
All ManagedElements that support topological links	linkProtectionType	PROT_ONE_PLUS_ONE
All ManagedElements that support topological links	linkCost	int, 1 to 2147483647

•globaldefs::sSrlgGroupList_T srlgGroupListValue

–Supported. This field holds the SRLG group values. This is an optional parameter. The user can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.

Throws

globaldefs::ProcessingFailureException:

EXCPT_NOT_IMPLEMENTED 

This exception is raised if EMS cannot support this service.

EXCPT_INVALID_INPUT

This exception is raised if createData input is not valid.

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific 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 interface allows an NMS to request EMS information.

Parameters

Name	Type	Input/Output	Description
emsInfo	EMS_T	Out	EMS information

CTM supports EMS_T as follows:

•globaldefs::NamingAttributes_T name

–EMS ID is returned as the same name that is displayed on the CTM client EMS property sheet.

•string userLabel

–Not supported.

•string nativeEMSName

–CTM returns the EMS ID that is displayed on the CTM client EMS property sheet.

•string owner

–Not supported.

•string emsVersion

–CTM returns "5.0."

•string type

–CTM returns "Cisco Systems/Cisco Transport Manager."

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS 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.

CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.

Parameters

Name	Type	Input/Output	Description
l2TopoType	MultiLayerSubnetwork::L2TopoType_T	In	The type of L2 topologies to be returned.
how_many	unsigned long	In	Maximum number of L2 topologies to be returned in the first batch.
l2TopoList	multiLayerSubnetwork::L2TopologyList_T	Out	List of available L2 topologies in this MultiLayerSubnetwork.
l2TopoIt	multiLayerSubnetwork::L2TopologyIterator_I	Out	The iterator used to retrieve the remaining L2 topologies.

CTM provides the following support for the L2Topology_T structure:

• globaldefs::NamingAttributes_T name

–Supported. The field contains two tuples. The first tuple contains value for EMS. The second tuple contains the L2 topology name.

• string userLabel

–Not supported.

• string nativeEMSName

–Supported. L2 topology name is reported.

•string owner

–Not supported.

•L2TopoLayerRate_T layerRate

Supported. This represents the total capacity of the L2 topology. L2TopoLayerRate_T contains the following information:

–LayerRate_T layerRate—This represents the layer rate of the SNCs. In case of VCAT, it represents the layer rate of the member SNCs.

–Unsigned long number of VCAT members—This represents the number of members in each SNC of an L2 topology consisting of all VCAT SNCs. It will contain a value less than one in all other cases and should be ignored in such cases.

–LR_STS1_and_AU3_High_Order_VC3

–LR_STS3c_and_AU4_VC4

–LR_STS6c_and_VC4_2c

–LR_STS9c_and_VC4_3c

–LR_STS12c_and_VC4_4c

–LR_STS24c_and_VC4_8c

–LR_Not_Applicable (if the L2 topology contains L1 SNCs with different layer rates or if the L2 topology contains a mix of CCAT and VCAT L1 SNCs.)

•multiLayerSubnetwork::L2TopoType l2TopoType

–The type of L2 topology. Valid values are L2TopoType.PT2PT and L2TopoType.RPR.

• multiLayerSubnetwork::L2TopoState topoState

–The state of the L2 topology. Valid values are L2TopoState.COMPLETE and L2TopoState.INCOMPLETE.

•multiLayerSubnetwork::L2TopoOperState

–The operational state of the L2 topology. Valid values are L2TopoOperState.IS, L2TopoOperState.ISPARTIAL, L2TopoOperState.OOS.

• multiLayerSubnetwork::L2TopoSyncState topoSyncState

–Indicates the current L2Topology Synchronization State. Valid values are for the L2TopoSyncState are L2TopoSyncState.NEEDED, L2TopoSyncState.INPROGRESS, L2TopoSyncState.COMPLETED, L2TopoSyncState.PARTIAL_COMPLETED, L2TopoSyncState.FAILED, and L2TopoSyncState.L2NOTREADY.

• globaldefs::NVSList_T additionalInfo

–Supports the bandwidth parameters SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth, SpMgmtCoS, CommittedCoS, AvvidVoiceVideoCoS, AvvidControlCoS, and cos value CoSCommit. All or none of these parameters should be passed. Each of the bandwidth parameters (SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth) should be between 1 and 99 and the sum of all four bandwidth parameters should be between 1 and 99. CoS commit value should be in the range of 0 to 7. If none of these parameters are passed, CTM will take the following default values: SpMgmtBandwidth (5), CommittedBandwidth (80), BestEffortBandwidth (10), AvvidControlBandwidth (4), SpMgmtCoS (6, 7), CommittedCoS (1, 2), AvvidVoiceVideoCoS (5), AvvidControlCoS (3), and CoSCommit (2).

Throws

globaldefs::ProcessingFailureException:

EXCPT_INVALID_INPUT

This exception is raised if input L2TopoType is not valid.

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS 

This exception is raised when the 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 QoS template names in the EMS. The QoS template has a scope in EMS.

CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of qosTempNames to be returned in the first batch
qosTempNameList	globaldefs::NamingAttributesList_T	Out	First batch of names
qosTempNameIt	globaldefs::NamingAttributesIterator_I	Out	The iterator used to retrieve the remaining names

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS 

This exception is raised when the maximum number of iterators that the EMS can support has been reached.

Compliance

CTM-defined.

3.2.15  emsMgr::EMSMgr_I::getAllQoSTemplates

Synopsis

void getAllQoSTemplates

			in unsigned long how_many,

			out QoSTemplateList_T qosTempList

			out QoSTemplateIterator_I qosTempIt)

			raises (globaldefs::ProcessingFailureException);

Description

This interface lists all QoS template in the EMS. The QoS template has a scope in EMS.

CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of qosTempNames to be returned in the first batch
qosTempList	QoSTemplateList_T	Out	First batch of QoSTemplates
qosTempIt	QoSTemplateIterator_I	Out	The iterator used to retrieve the remaining QoSTemplates

The structure that CTM supports for the QoSTemplate is described below:

enum TemplateType_T{ UNKNOWN, BEST_EFFORT, CIR_PIR, ADVANCED};

struct QoSTemplate_T {

//It will contain two tuples. First tuple will contain value for EMS. Second tuple will

//contain QoSTemplate_T {

			globaldefs::NamingAttributes_T templateName;

			string qos_template_description;

			TemplateType_T templateType;

			QOSPolicy_T policy;

};

typedef sequence< QoSTemplate_T> QoSTemplateList_T;

			interface QoSTemplateIterator_I

{

			boolean next_n(in unsigned long how_many,

			outQosTemplateList_T qosTempList)

			raises (globaldefs::ProcessingFailureException);

			unsigned long getLength()

			raises (globaldefs::ProcessingFailureException);

			void destroy()

			raises (globaldefs::ProcessingFailureException);

};

enum COSMarking_T{COSMARKING_UNKNOWN, COSMARKING_MARK_COS, COSMARKING_TRUST};

enum ExcessAction_T{EXCESS_ACTION_UNKNOWN, EXCESS_ACTION_DISCARD, EXCESS_ACTION_ALLOW};

enum ViolateAction_T{VIOLATE_ACTION_UNKNOWN, VIOLATE_ACTION_DISCARD, 
VIOLATE_ACTION_ALLOW};

enum MatchOption_T{MATCH_OPTION_OR, MATCH_OPTION_AND};

enum Classification{MATCH_ANY, MATCH_DSCP, MATCH_IP, MATCH_COS};

enum BestEffortType_T{BEST_EFFORT_UNKNOWN, BEST_EFFORT_RATE, BEST_EFFORT_LINE};

enum CIRType_T{CIR_UNKNOWN, CIR_RATE, CIR_LINE}

struct QoSPolicer_T {

			CIRType_T cir_type;

			long cir;

			long cir_burst;

			COSMarking_T cir_cos;

			long cir_cos_val;

			ExcessAction_T excess_act;

			long pir;

			long pir_burst;

			COSMarking_T pir_cos;

			long pir_cos_val;

			ViolateAction_T violate_act;

			long violate_cos_val;

			BestEffortType_T beff_type;

			long beff_rate;

			long beff_burst;

};

struct MatchProtocol_T (

			Classification_T matchTraffic;

			string value;

};

typedef sequence<MatchProtocol_T>MatchProtocolList_T;

struct QoSClass_T {

			MatchProtocolList_T classification;

			string class_name;

			QoSPolicer_T policer;

			MatchOption_T operator;

}

typedef sequence<QoSClass_T>QoSClassList_T

enum QoSPolicing_T{QOSP_UNKNOWN, QOSP_DEFAULT, QOSP_DEFINED, QOSP_CIRPIR, QOSP_ADVANCED} 

The existing QOSPolicy_T structure will be changed to the following:

struct QOSPolicy_T{

			string policy_name;

			QoSClassList_T qosClasses;

			QosPolicing_T policing

}

enum QoSProvisioning Type_T{PROV_QoSPolicy, PROV_QoSTemplate};

/**This union data structure will be used in MLVLANTPQOSPolicy_T and MLVLANTPData_T.OSS

user can either pass a template or the entire QoSPolicy in the provisioning request**/

union QoSPolicyData_T switch (QoSProvisioningType_T){

case PROV_QoSPolicy:

QOSPolicy_T qosPolicy;

case PROV_QoSTemplate:

globaldefs::NamingAttributes_T templateName;}

typedef sequence<QoSPolicyData_T>QoSPolicyDataList_T;

The existing MLVLANTPQOSPolicy_T structure will be changed to the following:

struct MLVLANTPQOSPolicy_T{

			globaldefs::NamingAttributes_T tpName;

//			QOSPolicy_T qosPolicy;

			QOSPolicyData_T qosPolicyData;

}

typedef sequence<MLVLANTPQOSPolicy_T>MLVLANTPQOSPolicyList_T;

The existing MLVLANTPData_T structure will be changed to the following:

struct MLVLANTPData_T{

			globaldefs::NamingAttributes_T tpName;

			L2PortType_T portType;

			L2ConnectionType_T connectionType;

			L2PortState_T portState;

//			QOSPolicy_T qosPolicy;

			QOSPolicyData_T qosPolicy;

			long portVlan;

}

typedef sequence<MLVLANTPData_T> MLVLANTPDataList_T;

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS 

This exception is raised when the 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 reports the complete QoS template information given the QoS template name. The QoS template has a scope in EMS.

CTM supports this operation only for ONS 15454 SONET and ONS 15454 SDH NEs.

Parameters

Name	Type	Input/Output	Description
qosTemplateName	globaldefs::NamingAttributes_T	In	QoSTemplate name
qosTemp	QoSTemplate_T	Out	QoSTemplate giving the complete information

For more information on the QoSTemplate_T structure, see the "emsMgr::EMSMgr_I::getAllQoSTemplateNames" section.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR 

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the QoS template name is not valid.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the QoS template name does not exist on the EMS.

Compliance

CTM-defined.

3.3  emsSession::EmsSession_I

The emsSession module allows the client to interrogate the EMS to determine which manager interfaces it supports. The NMS retrieves an instance of the manager interface objects it requires. This interface is inherited from session::Session_I.

interface EmsSession_I:session::Session_I

3.3.1  emsSession::EmsSession_I::getEventChannel

Synopsis

void getEventChannel(

out CosNotifyChannelAdmin::EventChannel eventChannel)

    raises(globaldefs::ProcessingFailureException);

Description

This operation allows an NMS to access the event channel to receive notifications. CTM publishes the name of the notification channel through the naming service. You can use the naming service to get the corresponding object reference.

Parameters

Name	Type	Input/Output	Description
eventChannel	CosNotifyChannelAdmin::EventChannel	Out	Event channel that the NMS uses

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific 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 allows an NMS to access the specified manager interface.

Parameters

Name	Type	Input/Output	Description
managerName	string	In	Class or type of manager object that the client wants.
managerInterface	common::Common_I	Out	The actual object returned implements the specified manager interface. However, it is returned as a Common_I object so the operation can be generic. The client should narrow the returned object to the correct object type.

Throws

globaldefs::ProcessingFailureException

EXCPT_NOT_IMPLEMENTED

This exception indicates that the EMS does not support the manager.

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

Compliance

TMF-defined.

3.3.3  emsSession::EmsSession_I::getSupportedManagers

Synopsis

void getSupportedManagers(out managerNames_T supportedManagerList)

    raises(globaldefs::ProcessingFailureException);

Description

This operation allows an NMS to request the manager interfaces that the EMS implements.

Parameters

Name	Type	Input/Output	Description
supportedManagerList	managerNames_T	Out	List of manager names supported in the form "managerName," where managerName is one of the following defined manager strings for CTM: •EMS •ManagedElement •MultiLayerSubnetwork •EquipmentInventory •PerformanceManagement •Maintenance •Protection

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_I

3.4.1  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey

Synopsis

void getEmsPublicKey(out string publicKey)

	raises(globaldefs::ProcessingFailureException);

Description

This operation allows the NMS to obtain the string representation of the RSA Public Key from CTM for encrypting the username and password. Encoding uses Base64 encoding scheme.

The OSS client should use Base64 decoder to decode the Public Key and get the byte array of the key from the decoded Public Key string. The byte array corresponding to the Public Key represents the key in its primary encoded format; in this case, X.509 SubjectPublicKeyInfo.

You can create the RSAPublic Key using this byte array and cryptographic libraries. Use this key to encrypt the username and password.

Before passing the encrypted password to CTM for login, the OSS client must use Base64 encoder to encode the encrypted username and password. This provides the string equivalent of the encrypted data.

Parameters

Name	Type	Input/Output	Description
publicKey	string	Out	The Public Key string returned by CTM.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

Compliance

CTM-defined.

3.4.2  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair

Synopsis

void getEmsPublicKeyPair(out string publicKeyModulus,

	out string publicKeyExponent)

	raises(globaldefs::ProcessingFailureException);

Description

This operation allows 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 should 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. The OSS client uses this key to encrypt the username and password.

Before passing the encrypted password to CTM for login, the OSS client must use Base64 encoder to encode the encrypted username and password. This provides the string equivalent of the encrypted data.

Parameters

Name	Type	Input/Output	Description
publicKeyModulus	string	Out	The Public Key Modulus string returned by CTM.
publicKeyExponent	string	Out	The Public Key Exponent string returned by CTM.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

Compliance

CTM-defined.

3.4.3  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 allows the NMS to obtain the EmsSession_I object, which contains all managers of the EMS.

CTM R5.0 allows four to 25 concurrent login sessions and as many user profiles as required.

The username and password must contain between one and 53 characters.

This operation can also accept encrypted username and password. See the "B.2  Encryption Between CTM and GateWay/CORBA" section on page B-3 for information on how to enable this feature.

Parameters

Name	Type	Input/Output	Description
user	string	In	The user or application that is trying to access the server. This user must have a profile created in CTM.
password	string	In	Password for the user application.
client	nmsSession::NmsSession_I	In	Handle to the NMS NmsSession_I object, to which the returned EmsSession_I object must be associated.
emsSessionInterface	emsSession::EmsSession_I	Out	CORBA Interoperable Object Reference (IOR) for the EmsSession_I interface.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that the client is invalid.

EXCPT_ACCESS_DENIED

This exception indicates a security violation.

Compliance

TMF-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_I

This 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 allows an NMS to request all the equipment and equipment holders contained in an ME or equipment holder.

Parameters

Name	Type	Input/Output	Description
meOrHolderName	globaldefs::NamingAttributes_T	In	Name of the ME or equipment holder for which to retrieve contained equipment and equipment holders
how_many	unsigned long	In	Maximum number of EquipmentOrHolder_Ts to return in the first batch
eqList	EquipmentOrHolderList_T	Out	First batch of EquipmentOrHolder_Ts
eqIt	EquipmentOrHolderIterator_I	Out	Iterator used to retrieve the remaining EquipmentOrHolder_Ts

The EqList parameter contains a sequence of the EquipmentOrHolder_T data type, which is defined as the union of Equipment_T and EquipmentHolder_T.

CTM supports Equipment_T as follows:

•globaldefs::NamingAttributes_T name

–Supported. This field has four tuples. The first tuple is for EMS, the second is for ManagedElement, the third is for EquipmentHolder, and the fourth contains Equipment. The value of the fourth tuple is the same as the nativeEMSName field.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported. The naming convention is described in the "2.2.5  Naming Conventions" section on page 2-34.

•string owner

–Not supported.

•boolean alarmReportingIndicator

–Supported for ONS 15454 SONET and ONS 15327 only.

•ServiceState_T serviceState

–Not supported.

•EquipmentObjectType_T expectedEquipmentObjectType

–For a list of supported values for the ONS 15200, see Table 2-26 on page 2-42.

–For a list of supported values for the ONS 15216, see Table 2-27 on page 2-42 and Table 2-28 on page 2-42.

–For a list of supported values for the ONS 15302, see Table 2-29 on page 2-43.

–For a list of supported values for the ONS 15305, see Table 2-30 on page 2-43.

–For a list of supported values for the ONS 15310 CL, see Table 2-31 on page 2-44.

–For a list of supported values for the ONS 15327, see Table 2-32 on page 2-44.

–For a list of supported values for the ONS 15454 SONET, see Table 2-33 on page 2-45.

–For a list of supported values for the ONS 15454 SDH, see Table 2-34 on page 2-46.

–For a list of supported values for the ONS 15501, ONS 15530, and ONS 15540, see Appendix D, "ONS 15501, ONS 15530, and ONS 15540 Equipment List."

–For a list of supported values for the ONS 15600 SONET, see Table 2-35 on page 2-48.

–For a list of supported values for the ONS 15600 SDH, see Table 2-36 on page 2-49.

–For a list of supported values for the ONS 15800 and ONS 15801, see Table 2-37 on page 2-49.

–For a list of supported values for the ONS 15808, see Table 2-38 on page 2-51.

•EquipmentObjectType_T installedEquipmentObjectType

–Supported. The value reported by the NE is inserted in this field.

•string installedPartNumber

–Supported when equipment is installed.

•string installedVersion

–Supported when equipment is installed.

•string installedSerialNumber

–Supported when equipment is installed.

•globaldefs::NVSList_T additionalInfo

–Supported when equipment is installed. Common Language Equipment Identification (CLEI) code is available.

CTM supports EquipmentHolder_T as follows:

•globaldefs::NamingAttributes_T name

–Supported. This field has three tuples: one for EMS, one for ManagedElement, and one for EquipmentHolder name.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported. The naming convention is defined in the "2.2.5  Naming Conventions" section on page 2-34.

•string owner

–Not supported.

• boolean alarmReportingIndicator

–Not supported.

• EquipmentHolderType_T holderType

–Supported. Valid values are additionalHolder, rack, shelf, and slot.
For ONS 15530 and ONS 15540, valid values are "rack," "shelf," "slot," "subslot," and "ppm_holder." For ONS 15501, valid values are "rack" and "shelf." For ONS 15310 and ONS 15600, valid values are "rack," "shelf," "slot," "subslot," and "port_holder." For all equipment supporting SFP modules, valid values are "rack," "shelf," "slot," "subslot," and "port_holder."

• globaldefs::NamingAttributes_T expectedOrInstalledEquipment

–Supported. If the slot is empty and not preprovisioned for any equipment, this field is empty.

• EquipmentObjectTypeList_T acceptableEquipmentTypeList

–Supported for all systems except the ONS 15501, ONS 15530, or ONS 15540. The following tables list the equipment types for all supported NEs.

ONS 15200 Slot Number	Acceptable Equipment
All slots	CLIP-0-UNP-xx1
	CLIP-7-UNP-xx

1 xx represents the specific lambda wavelength as configured on the CLIP.

ONS 15216 DCU Slot Number	Acceptable Equipment
1, 2	DCU-100 (100 ps/nm)
1, 2	DCU-350 (350 ps/nm)
1, 2	DCU-450 (450 ps/nm)
1, 2	DCU-550 (550 ps/nm)
1, 2	DCU-750 (750 ps/nm)
1, 2	DCU-950 (950 ps/nm)
1, 2	DCU-1150 (1150 ps/nm)

ONS 15216 FlexLayer Slot Number	Acceptable Equipment
1, 2, 3, 4	FLA-8-<Channel ID> Channel ID=36.6, 44.5, 52.5, 60.6
1, 2, 3, 4	FLB-2-<Channel ID> Channel ID=31.1, 32.6, 35.0, 36.6, 38.9, 40.5, 42.9, 44.5, 46.9, 48.5, 50.9, 52.5, 54.9, 56.5, 58.9, 60.6
1, 2, 3, 4	CS-2
1, 2, 3, 4	CS-3
1, 2, 3, 4	CS-4
1, 2, 3, 4	CS-SM-Y
1, 2, 3, 4	CS-MM-Y
1, 2, 3, 4	SC-4B
1, 2, 3	VOA-4

ONS 15302 Slot Number	Acceptable Equipment
1	E1-12
2	S1.1-2-SC
3	E100-4
4	WAN-4 and WAN-1

ONS 15305 Slot Number	Acceptable Equipment
1, 2, 3, 4	All equipment list in Table 2-30 on page 2-43.

ONS 15327 Slot Number	Acceptable Equipment
7, 8	MIC
5, 6	XTC
1, 2, 3, 4	ETH100, OC12, OC48

ONS 15327 Release 3.3 supports the following values in addition to those listed in the preceding tables:

ONS 15327 R3.3 Slot Number	Acceptable Equipment
1, 2, 3, 4	OC3

ONS 15327 Release 3.4 supports the following values in addition to those listed in the preceding tables:

ONS 15327 R3.4 Slot Number	Acceptable Equipment
1, 2, 3, 4	G1000_2

ONS 15454 SONET Slot Number	Acceptable Equipment
9	AIC
8, 10	XC, XCVT
7, 11	TCC
3, 15	DS1, DS1N, DS3, DS3N, DS3E, DS3NE, DS3XM, ETH100, ETH1000, OC3, OC12, EC1
1, 2, 4, 14, 16, 17	DS1, DS3, DS3E, DS3XM, ETH100, ETH1000, OC3, OC12, EC1
5, 6, 12, 13	DS1, DS3, DS3E, DS3XM, ETH100, ETH1000, OC3, OC12, EC1, OC48

ONS 15454 SONET Release 3.1 supports the following values in addition to those listed in the preceding tables:

ONS 15454 SONET R3.1 Slot Number	Acceptable Equipment
8, 10	XC10G
5, 6, 12, 13	OC192 (only when XC10G is installed in slot 8 or 10)
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	OC48 (only when XC10G is installed in slot 8 or 10)

ONS 15454 SONET Release 3.2 supports the following values in addition to those listed in the preceding tables:

ONS 15454 SONET R3.2 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16,17	G1000_4 (Only when XC10G is installed in slot 8 or 10)

ONS 15454 SONET Release 3.3 supports the following values in addition to those listed in the preceding tables:

ONS 15454 SONET R3.3 Slot Number	Acceptable Equipment
1, 2, 3, 4, 14, 15, 16,17	OC12_4 (Only when XC10G is installed in slot 8 or 10)

ONS 15454 SONET Release 3.4 supports the following values in addition to those listed in the preceding tables:

ONS 15454 SONET R3.4 Slot Number	Acceptable Equipment
9	AICI

ONS 15454 Release 4.0 supports the following values in addition to those listed above:

ONS 15454 SONET R4.0 Slot Number	Acceptable Equipment
5, 6, 12, 13	G1000_4 (when XC/XCVT is installed in slot 8 or 10)
7,11	TCC2
1, 2, 3, 4, 14, 15, 16, 17	OC3_8 (only when XC10G in installed in slot 8 or 10)
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	MXP_2.5G_10G, TXP_MR_10G
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	ML1000, ML100T (only when XC10G is installed in slot 8 or slot 10)
5, 6, 12, 13	ML1000, ML100T (only when XCVT is installed in slot 8 or slot 10)

ONS 15454 Release 4.1 supports the following values in addition to those listed above:

ONS 15454 SONET R4.1 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	TXP_MR_10G, G1000_4 (Same physical card as supported in previous releases, but with a different software image)

ONS 15454 Release 4.6 supports the following values in addition to those listed above:

ONS 15454 SONET R4.6 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, G1000_4
1, 2, 3, 4, 5, 12, 13, 14, 15, 16	MUX32_O, DMX32_O Note 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.
8, 10	OSCM
1, 2, 4, 5, 6, 12, 13, 14, 16, 17	DS3I
3, 15	DS3I, DS3IN

ONS 15454 Release 5.0 supports the following values in addition to those listed above:

ONS 15454 SONET R5.0 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, 2.5G SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, DS3XM_12, DS3EC1_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_R Note 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.
8, 10	OSCM
7, 11	TCC2P

ONS 15454 SDH Slot Number	Acceptable Equipment
9	AIC
8,10	XC10G
7, 11	TCCI
1, 2, 4, 14, 16, 17	E1, DS3I, E3, STM1, STM4, STM16, ETH100, ETH1000, G1000_4
3, 15	E1, E1N, DS3I, DS3IN, E3, STM1, STM4, STM16, ETH100, ETH1000, G1000_4
6, 12	ETH100, ETH1000, G1000_4, STM1, STM4, STM16, STM64
5, 13	E1, E3, DS3I, ETH100, ETH1000, G1000_4, STM1, STM4, STM16, STM64
23	ALM_PWR
24	CRFT_TMG
18, 19, 20, 21, 22, 25, 26, 27, 28, 29	FMEC_SMZ_E1, FMEC_SMZ_E3, FMEC_DB

ONS 15454 SDH R3.4 supports the following values in addition to those listed in the preceding tables:

ONS 15454 SDH R3.4 Slot Number	Acceptable Equipment
9	AICI
1, 2, 3, 4, 14, 15, 16, 17	STM4_4

ONS 15454 SDH Release 4.0 supports the following values in addition to those listed above:

ONS 15454 SDH R4.0 Slot Number	Acceptable Equipment
7,11	TCC2
8, 10	XCVXL_10G, XCVXL_2.5G
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	ML1000, ML100T, MXP_2.5G_10G, TXP_MR_10G, G1000_4
1, 2, 3, 4, 14, 15, 16, 17	E1_42, STM1_8, STM1E_12

ONS 15454 SDH Release 4.1 supports the following values in addition to those listed above:

ONS 15454 SDH R4.1 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	G1000_4 (Same physical card as supported in R4.0, but with different software image)

ONS 15454 SDH Release 4.6 supports the following values in addition to those listed above:

ONS 15454 SDH R4.6 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	FCMR, OSCM_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_O Note 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.
8, 10	OSCM

ONS 15454 SDH Release 5.0 supports the following values in addition to those listed above:

ONS 15454 SDH R5.0 Slot Number	Acceptable Equipment
1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17	FCMR, OSCM_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_R Note 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.
8, 10	OSCM

ONS 15600 SONET Slot Number	Acceptable Equipment
5, 10	TXC
6/7, 8/9	CXC
1, 2, 3, 4, 11, 12, 13, 14	OC48_16 (for the ONS 15600 SONET), OC192_4 (for the ONS 15600 SONET), STM16_16 (for the ONS 15600 SDH), and STM64_4 (for the ONS 15600 SDH)

ONS 15600 SONET R5.0 Slot Number	Acceptable Equipment
5, 10	TXC
6/7, 8/9	SSXC
1, 2, 3, 4, 11, 12, 13, 14	OC48_16, OC192_4
1, 2, 3, 4, 11, 12, 13, 14	ASAP_4/MeRC

ONS 15600 SDH Slot Number	Acceptable Equipment
5, 10	TXC
6/7, 8/9	CXC
1, 2, 3, 4, 11, 12, 13, 14	STM16_16, STM64_4
1, 2, 3, 4, 11, 12, 13, 14	All equipment listed in Table 2-36 on page 2-49.

ONS 15800 Slot Number	Acceptable Equipment
13-141	LSM-W
151	CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S
161	IOC-W
17	SCF-W, BAT
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12	Any other supported module. (See Table 2-37 on page 2-49.)

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 can be inserted into the slot. See Table 2-37 on page 2-49.

ONS 15801 Slot Number	Acceptable Equipment
11-121	LSM-W
131	CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S
141	IOC-W
15	SCF-W, BAT
1, 2, 3, 4, 5, 6, 7, 8, 9, 10	Any other supported module. (See Table 2-37 on page 2-49.)

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 can be inserted into the slot. See Table 2-37 on page 2-49.

ONS 15808 Slot Number	Acceptable Equipment
11-121	OSCM
131	CMP, CMP-S
141	AIU
15	SCU, PLF
1, 2, 3, 4, 5, 6, 7, 8, 9, 10	Any other supported module. (See Table 2-38 on page 2-51.)

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 can be inserted into the slot. See Table 2-38 on page 2-51.

•HolderState_T holderState

–Supported.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that managedElementOrEquipmentName does not reference an ME or an equipment holder.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that managedElementOrEquipmentName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 the same behavior as the "equipment::EquipmentInventoryMgr_I::getAllEquipment" section, but returns the object names instead of returning the entire object.

Parameters

Name	Type	Input/Output	Description
meOrHolderName	globaldefs::NamingAttributes_T	In	The name of the ME or equipment holder for which to retrieve contained equipment and equipment holders
how_many	unsigned long	In	The maximum number of EquipmentOrHolder_Ts to return in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	The first batch of names
nameIt	globaldefs::NamingAttributesIterator_I	Out	The iterator to retrieve the remaining names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when meOrHolderName does not reference an ME or an equipment holder.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when managedElementOrEquipmentName references object which does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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 allows 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 a protecting equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the supported PTPs.

When there is equipment protection, this operation reports PTPs for the primary equipment only. That is, when called on a protecting equipment (as opposed to the primary equipment), this operation returns an empty list, regardless of the current switch status.

•ONS 15200: There is no PTP support.

•ONS 15216: CTM returns all the supported PTPs for ONS 15216 if there are topological links associated with the NE.

•ONS 15302, ONS 15305: CTM returns WAN, SDH, and PDH ports.

•ONS 15310: CTM returns OC-N, DS1, DS3, and Ethernet ports.

•ONS 15327: CTM returns OC-N, DS-1, DS-3, and Ethernet ports.

•ONS 15454 SONET: CTM returns OC-N, DS-1, DS-3, EC-1, and Ethernet ports.

•ONS 15454 SDH: CTM returns STM-N (OC-N), E1, E3, DS3I, STM1E, and Ethernet ports.

•ONS 15501: CTM returns the In-Port as well as the Out-Port.

•ONS 15530: CTM returns all of the supported PTPs for ONS 15530.

•ONS 15540: CTM returns all of the client, wave, wavepatch, filter, WDM, filterband, filtergroup, oscfilter, wavepassthrough, fastEthernet, TenGigEthernetPhy, and SONET-SDH as potential PTPs.

•ONS 15600 SONET: CTM returns OC-N ports.

•ONS 15600 SDH: CTM returns STM-N ports.

•ONS 15800, ONS 15801, ONS 15808: CTM returns all the supported PTPs for a given ONS 15800, ONS 15801, or ONS 15808 equipment.

•Unmanaged NE: CTM returns PTPs only when a topological link exists and only for those PTPs that are participating in the topological link.

Parameters

Name	Type	Input/Output	Description
equipmentName	globaldefs::NamingAttributes_T	In	Name of the equipment for which to retrieve supported PTPs
how_many	unsigned long	In	Maximum number of PTPs to be reported in the first batch
tpList	terminationPoint::TerminationPointList_T	Out	First batch of PTPs
tpIt	terminationPoint::TerminationPointIterator_I	Out	Iterator used to retrieve the remaining PTPs

CTM supports TerminationPoint_T as follows:

•globaldefs::NamingAttributes_T name

–Supported. This field contains three tuples for PTP and four tuples for CTP as defined by the TMF. The third tuple contains positional information for the PTP. The naming convention is described in the "2.2.5.3  Physical Termination Point" section on page 2-35 and in the "2.2.5.4  Connection Termination Point" section on page 2-35.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported.

•string owner

–Not supported.

•globaldefs::NamingAttributes_T ingressTrafficDescriptorName

–Not supported.

•globaldefs::NamingAttributes_T egressTrafficDescriptorName

–Not supported.

•TPType_T type

–Supported. CTM supports TPT_PTP, TPT_CTP, and TPT_FTP.

•TPConnectionState_T connectionState

–Supported. For PTP it is TPCS_NA; for CTP and FTP it is TPCS_BI_CONNECTED.

•TerminationMode_T tpMappingMode

–Not supported.

•Directionality_T direction

–Supported. PTPs always report D_BIDIRECTIONAL. For the ONS 155xx, D_SOURCE and D_SINK are also supported.

•transmissionParameters::LayeredParameterList_T transmissionParams

–Supported. LayerRate is supported for both PTP, CTP, and FTP.

CTM supports the following parameters for PTP on ONS 15454 SONET:

Name	TP Type	NE Type	Valid Value	Supporting Equipment and Restriction
AlarmReporting	PTP	ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH	On, Off	All equipment, except equipment that does not have PTP, such as XC, XCVT, TCC2, CXC, and so on.
ServiceState	PTP	ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH	—	All equipment, except ML100T, ML1000, FCMR, ML-100T-8, ML2_Mapper, CE-100T-8, and equipment that does not have PTP, such as XC, XCVT, TCC2, and so on.
AdminState	PTP	ONS 15310, ONS 15327, ONS 15454 SONET	IN_SERVICE, OUT_OF_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE (NE release 3.4.1 or later), AUTO_IN_SERVICE (for NE release 3.4.1 or later)	All equipment, except ML100T, ML1000, and equipment that does not have PTP, such as XC, XCVT, TCC2 and so on. G1000_4, G1000_2, and FCMR do not support AUTO_IN_SERVICE value.
		ONS 15600 SONET	IN_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE, OUT_OF_SERVICE (NE release 5.0 or later), AUTO_IN_SERVICE (for NE release 5.0 or later)	All equipment except equipment that does not have PTP, such as CXC and so on.
		ONS 15454 SDH and ONS 15600 SDH	UNLOCKED, LOCKED, DISABLED, LOCKED, MAINTENANCE, UNLOCKED, AUTO_IN_SERVICE	All equipment, except ML100T, ML1000, and equipment that does not have PTP, such as XC, XCVT, TCC2, and so on. FCMR does not support UNLOCKED and AUTO_IN_SERVICE value. LOCKED, DISABLED, UNLOCKED, AUTO_IN_SERVICE are not supported by ONS 15600 SDH.
LineCode	PTP	ONS 15310 and ONS 15327	ami, b8zs	DS1 port on XTC card
		ONS 15454 SONET	ami, b8zs	DS1, DS1N
		ONS 15310 and ONS 15454 SONET	b3zs	DS3E, DS3NE, DS3XM, DS3I, DS31N, DS3 ports on CTX cards
		ONS 15454 SDH	hdb3	E1, E1N, E1_42
		ONS 15454 SDH	b3zs	DS3I, DS31N
FrameFormat	PTP	ONS 15310 and ONS 15327	esf, d4, unframed	DS1 port on XTC card
		ONS 15454 SONET	esf, d4, unframed	DS1, DS1N
		ONS 15454 SONET	m13 (for NE releases 4.0 and later), m23 (for NE releases 3.4.1 and earlier), cbit, unframed, auto provision fmt	DS3E, DS3NE, DS3I, DS31N
		ONS 15454 SONET	m13 (for NE releases 4.0 and later), m23 (for NE releases 3.4.1 and earlier), cbit	DS3XM
		ONS 15454 SDH	e1_mf, e1_crcmf, e1_unframed	E1, E1N, E1_42
		ONS 15454 SDH	m13 (for NE releases 4.0 and later), m23 (for NE releases 3.4.1), cbit, unframed, auto provision fmt	DS3I, DS31N
SDH_SONET_SS_BITS	PTP	ONS 15454 SONET	SDH, SONET	OCn equipment
		ONS 15454 SDH	SDH	STMn equipment
EnableSyncMsg	PTP	ONS 15310, ONS 15327, ONS 15454 SONET, and ONS 15600 SONET	On, Off	OCn equipment
		ONS 15454 SDH and ONS 15600 SDH	On, Off	STMn equipment
ALSMode	PTP	ONS 15454 SONET	DISABLED, AUTO, MANUAL, MANUAL_RESTART_FOR_TEST	OC3_8, OC48 ELR, OC192 equipment
		ONS 15454 SDH	DISABLED, AUTO, MANUAL, MANUAL_RESTART_FOR_TEST	STM1_8, STM16 ELR, STM64 equipment
PulseWidth	PTP	ONS 15454 SONET	Float value between 2.0 and 100.0	OC3_8, OC48 ELR, OC192 equipment
		ONS 15454 SDH	Float value between 2.0 and 100.0	STM1_8, STM16 ELR, STM64 equipment
RecoveryInterval	PTP	ONS 15454 SONET	Integer value between 100 and 300.	OC3_8, OC48 ELR, OC192 equipment
		ONS 15454 SDH	Integer value between 100 and 300.	STM1_8, STM16 ELR, STM64 equipment
HasLaserBeenShutdown	PTP	ONS 15454 SONET	true, false (read-only value)	OC3_8, OC48 ELR, OC192 equipment
		ONS 15454 SDH	true, false (read-only value)	STM1_8, STM16 ELR, STM64 equipment
RestartLaser	PTP	ONS 15454 SONET	true, false (write-only value)	OC3_8, OC48 ELR, OC192 equipment
		ONS 15454 SDH	true, false (write-only value)	STM1_8, STM16 ELR, STM64 equipment
IPPMMonitor	CTP	ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH	On, Off	STS CTPs on OCn card
		ONS 15454 SDH	On, Off	VC4 CTPs on STMn card
TrailTraceActualTx	CTP	ONS 15454 SONET	Free format string	DS3E, DS3NE, DS3XM, DS3I, DS31N
		ONS 15454 SDH	Free format string	E3, DS3I, DS3IN, STM1E_12
TrailTraceExpectedRx	CTP	ONS 15310 and ONS 15327 SONET	Free format string	OC3
		ONS 15454 SONET	Free format string	DS3E, DS3NE, DS3XM, DS3I, DS3IN, EC1, OC3, OC3_8, OC12_4, OC48AS, OC192
		ONS 15454 SDH	Free format string	E3, DS3I, DS3IN, STM1E_12, OC3, OC3_8, OC12_4, OC48AS, OC192
		ONS 15600 SONET and ONS 15600 SDH	Free format string	OC48_16, OC192_4
	FTP	ONS 15310 and ONS 15327	Free format string	G1000_2
		ONS 15454 SONET, ONS 15454 SDH	Free format string	G1000_4
TrailTraceMonitor	CTP	ONS 15310 and ONS 15327 SONET	On, Off	OC3
		ONS 15454 SONET	On, Off	DS3E, DS3NE, DS3XM, DS3I, DS3IN, EC1, OC3, OC3_8, OC12_4, OC48AS, OC192
		ONS 15454 SDH	On, Off	E3, DS3I, DS3IN, STM1E_12, OC3, OC3_8, OC12_4, OC48AS, OC192
		ONS 15600 SONET and ONS 15600 SDH	On, Off	OC48_16, OC192_4
	FTP	ONS 15310 and ONS 15327	On, Off	G1000_2
		ONS 15454 SONET, ONS 15454 SDH	On, Off	G1000_4
XCLoopBack	CTP	ONS 15327 SONET, ONS 15454 SONET, ONS 15600 SONET and ONS 15600 SDH	On, Off	STS CTPs on OCn card when line loopback is not set on the containing PTP
		ONS 15454 SDH	On, Off	VC4 CTPs on STMn card when line loopback is not set on the containing PTP
PortMediaType	PTP	ONS 15454 SONET and ONS 15454 SDH	Undefined, FibreChannel-1Gbps, FibreChannel-2Gbps, FICON-1Gbps, and FICON-2Gbps	FCMR (For NE release 5.0 and later)
Link Recovery	PTP	ONS 15454 SONET and ONS 15454 SDH	On, Off	FCMR (For NE release 5.0 and later)
No. of Superblocks	PTP	ONS 15454 SONET and ONS 15454 SDH	Between 4 and 32	FCMR (For NE release 5.0 and later)
Enable Distance Extension	PTP	ONS 15454 SONET and ONS 15454 SDH	On, Off	FCMR (Only in distance extension mode and for NE release 5.0 and later)
Auto Detect Credits	PTP	ONS 15454 SONET and ONS 15454 SDH	On, Off	FCMR (Only in distance extension mode and for NE release 5.0 and later)
Number Credits	PTP	ONS 15454 SONET and ONS 15454 SDH	Between 2 and 256, in multiples of 2	FCMR (Only in distance extension mode and for NE release 5.0 and later)
Autoadjust GFP Buffer Threshold	PTP	ONS 15454 SONET and ONS 15454 SDH	On, Off	FCMR (Only in distance extension mode and for NE release 5.0 and later)
GFP Buffers Available	PTP	ONS 15454 SONET and ONS 15454 SDH	Between 16 and 1200 (in multiples of 16)	FCMR (Only in distance extension mode and for NE release 5.0 and later)
Ingress Idle Filtering	PTP	ONS 15454 SONET and ONS 15454 SDH	On, Off	FCMR (Only in distance extension mode and for NE release 5.0 and later)
MaxFrameSize	PTP	ONS 15454 SONET and ONS 15454 SDH	Between 2148 and 2172	FCMR (Only in distance extension mode)
FrameFormat	CTP	ONS 15454 SONET and ONS 15454 SDH	Auto provision fmt, esf, d4, and unframed	DS3XM_12
FDLMode	CTP	ONS 15454 SONET and ONS 15454 SDH	TL403 and BFDL	DS3XM_12

---

Note If TrailTraceMonitor is off for a given CTP or FTP, CTM will not return TrailTraceActualRx in transmissionParams.

---

•TPProtectionAssociation_T tpProtectionAssociation

–Not supported.

•boolean edgePoint

–Supported.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that equipmentName does not reference an equipment object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that equipmentName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 the same behavior as the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section, but returns the object names instead of returning the entire objects.

Parameters

Name	Type	Input/Output	Description
equipmentName	globaldefs::NamingAttributes_T	In	The name of the equipment for which to retrieve supported PTPs
how_many	unsigned long	In	The maximum number of PTPs to be reported in the first batch
nameList	obaldefs::NamingAttributesList_T	Out	The first batch of PTP names
nameIt	globaldefs::NamingAttributesIterator_I	Out	The iterator to retrieve the remaining PTP names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when equipmentName does not reference an equipment object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when equipmentName references object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is 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 allows an NMS to request the equipment that contains this PTP.

Parameters

Name	Type	Input/Output	Description
ptpName	globaldefs::NamingAttributes_T	In	Name of the PTP for which to retrieve supporting equipment
eqList	EquipmentOrHolderList_T	Out	List of equipment (not equipment holders) that directly implements the PTP

EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as the union of Equipment_T and EquipmentHolder_T structures. For more information about both structures, see the "equipment::EquipmentInventoryMgr_I::getAllEquipment" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that ptpName does not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that ptpName references a PTP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.5.6  equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
Names

Synopsis

void getAllSupportingEquipmentNames(

in globaldefs::NamingAttributes_T ptpName,

out globaldefs::NamingAttributesList_T nameList)

raises(globaldefs::ProcessingFailureException);

Description

This operation performs the same function as the "equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment" section, but returns the object names instead of returning the entire objects.

Parameters

Name	Type	Input/Output	Description
ptpName	globaldefs::NamingAttributes_T	In	The name of the PTP for which to retrieve the supporting equipment
nameList	globaldefs::NamingAttributesList_T	Out	The list of equipment names (not equipment holders) directly implementing the PTP

Throws

globaldefs::ProcessingFailureException 

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when ptpName does not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when ptpName references a PTP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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 method differs from getAllEquipment in that it looks only at the next level of the containment hierarchy.

Parameters

Name	Type	Input/Output	Description
equipmentHolderName	globaldefs::NamingAttributes_T	In	Name of the equipment holder for which to retrieve the directly contained equipment and equipment holders. CTM also accepts the ME name as a value for this parameter.
equipmentOrHolderList	EquipmentOrHolderList_T	Out	Directly contained equipment and equipment holders.

EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as the union of Equipment_T and EquipmentHolder_T structures. For information about both structures, see the "equipment::EquipmentInventoryMgr_I::getAllEquipment" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that equipmentHolderName does not reference an equipment holder object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that equipmentHolderName references an equipment holder that does not exist.

EXCPT_NE_COMM_LOSS 

This exception indicates a loss of communication with the NE.

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 the given equipment or equipment holder name.

Parameters

Name	Type	Input/Output	Description
equipmentOrHolderName	globaldefs::NamingAttributes_T	In	Name of the equipment or equipment holder to retrieve
equip	EquipmentOrHolder_T	Out	The returned equipment or equipment holder

Throws

globaldefs::ProcessingFailureException 

EXCPT_INTERNAL_ERROR

Raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT 

Raised when equipmentOrHolderName does not reference an equipment or an equipment holder.

EXCPT_ENTITY_NOT_FOUND

Raised when equipmentOrHolderName references an equipment or equipment holder that does not exist.

EXCPT_NE_COMM_LOSS

Raised when communication to 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 allows the NMS to permanently provision an 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 an 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 equipmentholder (slot) is empty and not preprovisioned for another module type.

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.

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 exception EXCPT_UNABLE_TO_COMPLY.

It is not necessary to know subtypes of OC-N card at the time of provisioning. When equipment is actually installed, CTM reports subtype in the name field of the equipment.

This operation is supported only for ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH NEs.

Parameters

Name	Type	Input/Output	Description
equipmentCreateData	EQTCreateData_T	In	Data that describes the equipment to create
createdEquipment	Equipment_T	Out	The resulting created equipment

CTM provides the following support for EQTCreateData_T structure:

•string userLabel

–Not supported.

•boolean forceUniqueness

–Not supported.

•string owner

–Not supported.

•EquipmentObjectType_T expectedEquipmentObjectType

–This parameter must take one of the values for equipment.

•globaldefs::NamingAttributes_T equipmentHolderName

–Supported.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_OBJECT_IN_USE

This exception is raised when the equipment holder already has an expected equipment.

EXCPT_INVALID_INPUT

This exception is raised when equipmentHolder does not reference an equipmentHolder object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when equipmentHolder references object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the equipment cannot be created at the NE.

EXCPT_NE_COMM_LOSS

This exception is 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 an equipment. The CTM sends a warning alarm notification in case of success. This operation is supported for the ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH.

Parameters

Name	Type	Input/Output	Description
equipmentOrHolderName	Globaldefs::NamingAttributes_T	In	The equipment on which to deactivate alarm reporting

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when equipmentOrHolderName does not reference an equipment or holder.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when equipmentOrHolderName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when alarm reporting cannot be disabled for the equipment or holder.

EXCPT_NE_COMM_LOSS

This exception is 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 an 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 in case of success. This operation is only supported for the ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH.

Parameters

Name	Type	Input/Output	Description
equipmentOrHolderName	globaldefs::NamingAttributes_T	In	The equipment on which to activate alarm reporting

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when equipmentOrHolderName does not reference an equipment or holder.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when equipmentOrHolderName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when alarm reporting cannot be disabled for the equipment or holder.

EXCPT_NE_COMM_LOSS

This exception is 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 allows the NMS to permanently unprovision an equipment from the ME. The successful result of this operation is the potential deletion of the equipment object and all of its related objects, such as TPs.

ONS 15454 SONET does not allow a user to unprovision an equipment which 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 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 SONET reserves slots 7 and 11 for TCC cards. One of these slots has an IN_SERVICE Timing Communications and Control Card (TCC+ and TCC-I). If the NMS invokes unprovisionEquipment on this equipment, CTM throws the exception EXCPT_UNABLE_TO_COMPLY.

This operation is supported only for the ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH.

Parameters

Name	Type	Input/Output	Description
equipmentName	globaldefs::NamingAttributes_T	In	The name of equipment to be unprovisioned

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is 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

This exception is raised when equipmentName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the equipment cannot be unprovisioned at the NE.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.6  maintenanceOps::MaintenanceManager_I

The 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. This interface is inherited from the "common::Common_I" section.

interface MaintenanceMgr_I:common::Common_I

It 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_T 

     currentMaintenanceOpeationList,

      out CurrentMaintenanceOperationIterator_I cmoIt)

    raises(globaldefs::ProcessingFailureException);

Description

This operation allows 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 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH.

Parameters

Name	Type	Input/Output	Description
tpOrMeName	globaldefs::NamingAttributes_T	In	The name of the PTP, CTP or ME
how_many	unsigned long	In	Maximum number of maintenance operations to return in the first batch
currentMaintenanceOpeationList	CurrentMaintenanceOperationList_T	Out	First batch of maintenance operations
cmoIt	CurrentMaintenanceOperationIterator_I	Out	Iterator to access the remaining maintenance operations

CTM provides the following support for CurrentMaintenanceOperation structure:

•globaldefs::NamingAttributes_T tpName

–Supported.

•MaintenanceOperation_T maintenanceOperation

–CTM only supports FACILITY_LOOPBACK, TERMINAL_LOOPBACK, and PAYLOAD_LOOPBACK.

•transmissionParameters::LayerRate_T layerRate

–Supported for CTPs only.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_NOT_IMPLEMENTED

This exception is raised if EMS does not support this service.

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when tpOrMeName does not reference a valid object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when tpOrMeName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to the ME is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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 allows the NMS to operate and release the maintenance commands that are supported by a TP.

•ONS 15310

–Only Terminal and Facility loopback operations are supported by CTM for electrical and OC-N PTPs. No loopback operations are supported by CTM for CTPs.

•ONS 15327

–Only Terminal and Facility loopback operations are supported by CTM for the DS-N and OC-N PTPs.

–No loopback operations are supported by CTM for CTPs.

•ONS 15454 SONET

–Only Terminal and Facility loopback operations are supported by CTM for the DS-N, OC-N, EC-1 and 10G-Transponder, 10G-Muxponder, and G1000_4 (NE version 4.1 or later) PTPs.

–Only Facility loopback is supported for the DS1 CTP on DS3XM.

–Only Terminal loopback is supported on G1000_4 for NE versions earlier than R4.1.

•ONS 15454 SDH

–Only Terminal and Facility loopback operations are supported by CTM for PTPs.

–No loopback operations are supported by CTM for CTPs.

•ONS 15600 SONET and ONS 15600 SDH

–Only Facility and PayLoad loopback operations are supported by CTM for PTPs.

–No loopback operations are supported by CTM for CTPs.

---

Note For the ONS 15327, ONS 15454 SONET, and ONS 15454 SDH R3.4 or later NEs, the loopback state can be set only if the TP state is either OUT_OF_SERVICE_MAINTENANCE or AUTO_IN_SERVICE.

---

CTM ignores the MaintenanceOperation_T value in the CurrentMaintenanceOperation_T structure if MaintenanceOperationMode_T is set to MOM_RELEASE.

Parameters

Name	Type	Input/Output	Description
maintenanceOperation	CurrentMaintenanceOperation_T	In	Information on the maintenance operation to perform. This structure contains the field maintenanceOperation. Valid values for this field are: •FACILITY_LOOPBACK •TERMINAL_LOOPBACK •PAYLOAD_LOOPBACK
maintenanceOperationMode	MaintenanceOperationMode_T	In	Indicates whether the maintenance operation should be operated or released

CTM provides the following support for CurrentMaintenanceOperation_T structure:

•globaldefs::NamingAttributes_T tpName

–Supported .

•MaintenanceOperation_T maintenanceOperation

–Only FACILITY_LOOPBACK, TERMINAL_LOOPBACK, and PAYLOAD_LOOPBACK are supported.

•transmissionParameters::LayerRate_T layerRate

–Supported for CTPs only.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when tpName does not reference a TP.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when tpName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the operation is denied by the ME.

EXCPT_NE_COMM_LOSS

This exception is 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. This interface is inherited from the "common::Common_I" section.

interface ManagedElementManager_I:common::Common_I

This 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 allows 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.

The ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send a clear for TCA events. TCAs are not reported in the eventList that is returned by this method. The ONS 15501, ONS 15530, and ONS 15540 do send a clear for TCA events. TCAs are reported in the eventList.

Parameters

Name	Type	Input/Output	Description
meName	globaldefs::NamingAttributes_T	In	Name of ME for which to retrieve alarms
excludeProbCauseList	notifications::ProbableCauseList_T	In	List of probable causes to exclude (for which events should not be reported)
excludeSeverityList	notifications::PerceivedSeverityList_T	In	List of severities to exclude from the output event list
how_many	unsigned long	In	Maximum number of alarms to report in the first batch
eventList	notifications::EventList_T	out	First batch of alarms
eventIt	notifications::EventIterator_I	out	Iterator to retrieve the remaining alarms

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that meName does not reference an ME object or that excludeProbCauseList contains undefined values.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that meName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

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 allows an NMS to request all SNCs that originate on, terminate on, or transit through, a specific ME.

•ONS 15310: This method does not support STS1 SNC on CTX using DS1 ports.

•ONS 15327: This method does not support STS1 SNC on XTC using DS1 ports.

•ONS 15454 SONET: This method does not support STS1 SNC on DS1 equipment.

•ONS 15454 SDH NE: This method does not support VC4 SNC on E1 and E1_42 equipment.

This method does not report VCAT SNCs.

CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Note This operation is CTM-specific and is not defined by the TMF. In the future, if the TMF defines the same method with a different behavior, the name of this method might change.

---

Parameters

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	Name of the ME whose SNCs are required.
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	List of rates of the SNCs to be reported. If an empty list is specified, then all SNCs of all rates are reported.
how_many	unsigned long	In	Maximum number of SNCs to be reported in the first batch.
sncList	subnetworkConnection::SubnetworkConnectionList_T	Out	The first batch of SNCs.
sncIt	subnetworkConnection::SNCIterator_I	Out	Iterator to retrieve the remaining SNCs.

CTM supports SubnetworkConnection_T as follows:

•globaldefs::NamingAttributes_T name

–Supported. This field contains two tuples. The first tuple contains values for the EMS. The second tuple contains the SNC name, which is the same as nativeEMSName.

•string userLabel

–Supported.

•string nativeEMSName

–Supported. The name that the user provides at creation time is reported.

•string owner

–Not supported.

•SNCState_T sncState

–CTM supports SNCS_NONEXISTENT, SNCS_ACTIVE, SNCS_DELETING, and SNCS_PARTIAL.

---

Note When SNC is not in SNCS_ACTIVE, this structure might not have complete information about the SNC. For example, transmissionParameters for TPs reported might not be initialized. When SNC goes into SNCS_ACTIVE state, a State Change Event is generated. (See the "A.3.4  State Change Event" section on page A-6.) Then, the NMS should invoke the multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getSNC method to retrieve complete information about the SNC.

---

•globaldefs::ConnectionDirection_T direction

–Supported.

•transmissionParameters::LayerRate_T rate

–Supported.

•StaticProtectionLevel_T staticProtectionLevel

–Supported. PCA circuits have this value set to PREEMPTIBLE.

•SNCType_T sncType

–Not supported.

•TPDataList_T aEnd

–Supported.

•TPDataList_T zEnd

–Supported.

•Reroute_T rerouteAllowed

–Not supported.

•NetworkRouted_T networkRouted

–Not supported.

•globaldefs::NVSList_T additionalInfo

–Supported. Customer ID and Service ID are reported if they are available. For SNC on Ethernet Equipment, CTM reports all associated VLAN IDs. For WDM SNC, the sncSize is reported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that managedElementName does not reference an ME.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that meName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

Compliance

CTM-defined.

3.7.3  managedElementManager::ManagedElementManager_I::
getAllManagedElements

Synopsis

void getAllManagedElements(

in unsigned long how_many,

      out managedElement::ManagedElementList_T meList,

      out managedElement::ManagedElementIterator_I meIt)

    raises(globaldefs::ProcessingFailureException);

Description

This operation allows an NMS to request details about all MEs that are under the control of ManagedElementMgr_I.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of MEs to report in the first batch
meList	managedElement::ManagedElementList_T	Out	First batch of MEs
meIt	managedElement::ManagedElementIterator_I	Out	Iterator to retrieve the remaining MEs

CTM supports ManagedElement_T as follows:

•globaldefs::NamingAttributes_T name

–Supported.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported. The NE reports the name.

•string owner

–Not supported.

•string location

–Supported.

•string version

–Supported.

•string productName

–Supported.

•CommunicationState_T communicationState

–Supported.

•boolean emsInSyncState

–Supported.

•transmissionParameters::LayerRateList_T supportedRates

CTM supports the following layer rates:

–ONS 15216 supports the following layer rates:

LR_PHYSICAL_OPTICAL

–ONS 15310/ONS 15327/ONS 15454 SONET

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 on ONS 15327 Release 3.3 or later)

LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later and on ONS 15327 Release 3.3 or later)

LR_STS18c_and_VC4_6c (Supported in ONS 15454 SONET, ONS 15327 Release 5.0 or later)

LR_STS36c_and_VC4_12c (Supported in ONS 15454 SONET, ONS 15327 Release 5.0 or later)

–ONS 15454 SDH supports the following layer rates:

LR_E1_2M (supported on the ONS 15454 SDH Release 4.0 or later)

LR_E3_34M (supported on the ONS 15454 SDH Release 4.0 or later)

LR_T3_and_DS3_45M (supported on the ONS 15454 SDH Release 4.0 or later)

LR_VT2_and_TU12_VC12 (supported on the ONS 15454 SDH Release 4.0 or later)

LR_Low_Order_TU3_VC3 (supported on the 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 in ONS 15454 SDH Release 5.0 or later)

LR_STS36c_and_VC4_12c (Supported in ONS 15454 SDH Release 5.0 or later)

–ONS 15501 supports the following layer rates;

LR_Optical_Channel

LR_Optical_Multiplex_Section

LR_Optical_Transmission_Section

LR_PHYSICAL_OPTICAL

–ONS 15540 supports the following layer rates:

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

–ONS 15530 supports the following layer rates:

All layer rates supported by ONS 15540

LR_PHYSICAL_ELECTRICAL

–ONS 15600 SONET and ONS 15600 SDH support the following layer rates:

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

–Unmanaged NE:

Not supported.

•globaldefs::NVSList_T additionalInfo

–Supported. There is a Name-Value-Pair for IPAddress with the name "IPAddress." There is a Name-Value-Pair for Operational State with the name "OperationalState" with following values. The emsInSyncState value is determined by the OperationalState value. A StateChangeEvent is generated whenever the state of emsInSyncState changes.

OperationStates	EmsInSyncState
PreProvisioned	false
InServiceSyncConfiguration	false
OutOfService	false
UnderMaintenance	false
InServiceIntializing	false
InService	true

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_TOO_MANY_OPEN_ITERATORS	

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.4  managedElementManager::ManagedElementManager_I::
getAllManagedElementNames

Synopsis

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 the "managedElementManager::ManagedElementManager_I:: getAllManagedElements" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
how_many	unsigned long	In	Maximum number of MEs to report in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of MEs
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining MEs

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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 a protecting equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the PTPs.

•ONS 15200: There is no PTP support.

•ONS 15216: CTM returns all the supported PTPs for the ONS 15216.

•ONS 15302 and ONS 15305: CTM returns WAN, SDH, and PDH ports.

•ONS 15310: CTM returns OC-N, DS-1, DS3, and Ethernet ports.

•ONS 15327: CTM returns OC-N, DS1, DS3, and Ethernet ports.

•ONS 15454 SONET: CTM returns OC-N, DS1, DS3, EC-1, fiber channel, and Ethernet ports.

•ONS 15454 SDH: CTM returns STM-N (OC-N), E1, E3, DS3I, STM1E, fiber channel, and Ethernet ports.

•ONS 15501: CTM returns In-Port as well as Out-Port.

•ONS 15530: CTM returns all the supported PTPs for ONS 15530.

•ONS 15540: CTM returns all the client, wave, wavepatch, filter, wdm, filterband, filtergroup, oscfilter, wavepassthrough, fastEthernet, TenGigEthernetPhy, and sonet-sdh as potential PTPs.

•ONS 15600 SONET: CTM returns OC-N ports.

•ONS 15600 SDH: CTM returns STM-N ports.

•ONS 15800, ONS 15801, ONS 15808: CTM returns all the supported PTPs for a given ONS 158xx.

•Unmanaged NE: CTM will return PTPs only when topological link exists and only to those PTPs that are participating in the topological link.

Parameters

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	Name of the ME for which to retrieve PTPs
tpLayerRateList	transmissionParameters::LayerRateList_T	In	List of PTP layer rates for which the PTPs are retrieved. To be reported, a PTP must contain at least one of the layer rates specified. If the list is empty, all PTPs (of all rates) are returned
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	CTM does not use this parameter
how_many	unsigned long	In	Maximum number of PTPs to report in the first batch
tpList	terminationPoint::TerminationPointList_T	Out	First batch of PTPs
tpIt	terminationPoint::TerminationPointIterator_I	Out	Iterator to retrieve remaining PTPs

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

•CTM supports the following the ONS 15302 layer rates:

–LR_Section_OC3_STS3_and_RS_STM1

–LR_Line_OC3_STS3_and_MS_STM1

•CTM supports the following the ONS 15305 layer rates:

–LR_Section_OC3_STS3_and_RS_STM1

–LR_Line_OC3_STS3_and_MS_STM1

–LR_Section_OC12_STS12_and_RS_STM4

–LR_Line_OC12_STS12_and_MS_STM4

–LR_Section_OC48_STS12_and_RS_STM16

–LR_Line_OC48_STS12_and_MS_STM16

•CTM supports the following ONS 15310 and ONS 15327 layer rates:

–LR_T1_and_DS1_1_5M

–LR_T3_and_DS3_45M

–LR_Section_OC48_STS48_and_RS_STM16

–LR_Line_OC48_STS48_and_MS_STM16

–LR_Section_OC12_STS12_and_RS_STM4

–LR_Line_OC12_STS12_and_MS_STM4

–LR_Section_OC3_STS3_and_RS_STM1

–LR_Line_OC3_STS3_and_MS_STM1

–LR_Fast_Ethernet

–LR_DSR_1_5M

–LR_DSR_45M

–LR_DSR_OC3_STM4

–LR_DSR_OC12_STM4

–LR_DSR_OC48_STM16

–LR_OPTICAL_SECTION

–LR_PHYSICAL_OPTICAL

–LR_PHYSICAL_ELECTRICAL

•CTM supports the following ONS 15454 SONET layer rates:

–LR_Gigabit_Ethernet

–LR_T1_and_DS1_1_5M

–LR_T3_and_DS3_45M

–LR_Section_OC48_STS48_and_RS_STM16

–LR_Line_OC48_STS48_and_MS_STM16

–LR_Section_OC12_STS12_and_RS_STM4

–LR_Line_OC12_STS12_and_MS_STM4

–LR_Section_OC3_STS3_and_RS_STM1

–LR_Line_OC3_STS3_and_MS_STM1

–LR_Section_OC1_STS1_and_RS_STM0

–LR_Line_OC1_STS1_and_MS_STM0

–LR_Section_OC192_STS192_and_RS_STM64

–LR_Line_OC192_STS192_and_MS_STM64

–LR_Fast_Ethernet

–LR_DSR_1_5M

–LR_DSR_45M

–LR_DSR_OC1_STM0

–LR_DSR_OC3_STM1

–LR_DSR_OC12_STM4

–LR_DSR_OC48_STM16

–LR_DSR_OC192_STM64

–LR_DSR_Gigabit_Ethernet

–LR_OPTICAL_SECTION

–LR_PHYSICAL_OPTICAL

–LR_PHYSICAL_ELECTRICAL

–LR_FC-100_1063M

–LR_FC_200_2125M

–LR_FICON_1G

–LR_FICON_2G

•CTM supports the following ONS 15454 SDH layer rates:

–LR_Gigabit_Ethernet

–LR_E1_2M

–LR_E3_34M

–LR_T3_and_DS3_45M

–LR_Section_OC48_STS48_and_RS_STM16

–LR_Line_OC48_STS48_and_MS_STM16

–LR_Section_OC12_STS12_and_RS_STM4

–LR_Line_OC12_STS12_and_MS_STM4

–LR_Section_OC3_STS3_and_RS_STM1

–LR_Line_OC3_STS3_and_MS_STM1

–LR_Section_OC192_STS192_and_RS_STM64

–LR_Line_OC192_STS192_and_MS_STM64

–LR_Fast_Ethernet

–LR_DSR_2M

–LR_DSR_45M

–LR_DSR_34M

–LR_DSR_OC1_STM0

–LR_DSR_OC3_STM1

–LR_DSR_OC12_STM4

–LR_DSR_OC48_STM16

–LR_DSR_OC192_STM64

–LR_DSR_Gigabit_Ethernet

–LR_OPTICAL_SECTION

–LR_PHYSICAL_OPTICAL

–LR_PHYSICAL_ELECTRICAL

–LR_FC-100_1063M

–LR_FC_200_2125M

–LR_FICON_1G

–LR_FICON_2G

•CTM supports the following ONS 15501 layer rates:

–LR_Optical_Channel

–LR_Optical_Multiplex_Section

–LR_Optical_Transmission_Section

–LR_PHYSICAL_OPTICAL

•CTM supports the following ONS 15530 layer rates:

–All the layer rates supported by ONS 15540

–LR_Physical_Electrical

•CTM supports the following ONS 15540 layer rates:

–LR_Section_OC1_STS1_and_RS_STM0

–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_OPTICAL_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

•CTM supports the following ONS 15600 SONET and ONS 15600 SDH layer rates:

–LR_Section_OC3_STS3_and_RS_STM1

–LR_Line_OC3_STS3_and_MS_STM1

–LR_Section_OC12_STS12_and_RS_STM4

–LR_Line_OC12_STS12_and_STM4

–LR_Section_OC48_STS48_and_RS_STM16

–LR_Line_OC48_STS48_and_MS_STM16

–LR_Section_OC192_STS192_and_RS_STM64

–LR_Line_OC192_STS192_and_MS_STM64

–LR_DSR_OC48_STM16

–LR_DSR_OC192_STM64

–LR_OPTICAL_SECTION

–LR_PHYSICAL_OPTICAL

•CTM supports the following ONS 15800, ONS 15801, and ONS 15808 layer rates:

•No one layer rate has to be specified as parameter for ONS 15800, ONS 15801, or ONS 15808 equipment.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that managedElementName does not reference an ME object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that managedElementName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.6  managedElementManager::ManagedElementManager_I::
getAllPTPNames

Synopsis

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 the same behavior as the operation described in "managedElementManager::ManagedElementManager_I::getAllPTPs" section, but instead of returning the entire object structures, this operation returns their names.

CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15540, ONS 15600 SONET, ONS 15600 SDH, ONS 15800, ONS 15801, and ONS 15808 NEs.

Parameters

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	The name of the ME for which to retrieve PTPs
tpLayerRateList	transmissionParameters::LayerRateList_T	In	List of PTP layer rates for which the PTPs are to be retrieved. A PTP must contain at least one of the layer rates specified to be reported. If the list is empty then all PTPs (of all rates) are returned
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	CTM does not use this parameter
how_many	unsigned long	In	Maximum number of PTPs to report in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of PTP names
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining PTP names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when managedElementName does not reference an ME object, or tpLayerRateList or connectionLayerRateList contains undefined rates.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when managedElementName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.7  managedElementManager::ManagedElementManager_I::
getContainedInUseTPs

Synopsis

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 that is 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.

• If there are no SNCs created, CTM returns zero CTPs

• If there is one SNC created at the STS1 level, CTM returns one CTP at the STS1 layer rate

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.

• If there are no SNCs created, CTM returns zero CTPs

• If there is one SNC created at the VC4 level, CTM returns one CTP at the VC4 layer rate

---

Note CTM supports this operation only for ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	Name of the PTP
layerRateList	transmissionParameters::LayerRateList_T	In	List of rates of the contained actual CTPs to return. An empty list tells the EMS to retrieve all contained actual CTPs (of all rates)
how_many	unsigned long	In	Maximum number of CTPs to be returned in the first batch
tpList	terminationPoint::TerminationPointList_T	Out	First batch of contained in-use CTPs
tpIt	terminationPoint::TerminationPointIterator_I	Out	Iterator to retrieve the remaining contained in-use CTPs

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

CTM supports the following layer rates for the layerRateList parameter:

•ONS 15310, ONS 15327 SONET, and ONS 15454 SONET supported layerRate list

–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_STS6c_and_VC4_2c

–LR_STS9c_and_VC4_3c (Supported on ONS 15454 SONET R3.2 and later, and on ONS 15327 R3.3 and later)

–LR_STS24c_and_VC4_8c (Supported on ONS 15454 SONET R3.2 and later, and on ONS 15327 R3.3 and later)

–LR_STS192c_and_VC4_64c (Supported on ONS 15454 SONET R3.1)

–LR_STS18c_and_VC4_6c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

–LR_STS36c_and_VC4_12c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

•ONS 15454 SDH Supported LayerRate List

–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_STS192c_and_VC4_64c

–LR_STS18c_and_VC4_6c (Supported on ONS 15454 SDH Release 5.0 or later)

–LR_STS36c_and_VC4_12c (Supported on ONS 15454 SDH Release 5.0 or later)

•ONS 15600 SONET and ONS 15600 SDH Supported LayerRate List

–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

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that tpName does not reference a PTP or CTP object or that layerRateList contains undefined rates.

EXCPT_TP_INVALID_ENDPOINT

This exception indicates that tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that tpName references a PTP or CTP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.8  managedElementManager::ManagedElementManager_I::
getContainedInUseTPNames

Synopsis

void getContainedInUseTPNames(

in globaldefs::NamingAttributes_T tpName,

in transmissionParameters::LayerRateList_T layerRateList,

in unsigned long how_many,

out globaldefs::NamingAttributesList_T nameList,

out globaldefs::NamingAttributesIterator_I nameIt)

    raises(globaldefs::ProcessingFailureException);

Description

This operation has the same behavior as the "managedElementManager::ManagedElementManager_I:: getContainedInUseTPs" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	The name of the PTP
layerRateList	transmissionParameters::LayerRateList_T	In	The list of rates of the contained actual CTPS to be returned. An empty list indicates to the EMS to get all contained actual CTPs (for all rates)
how_many	unsigned long	In	The maximum number of CTPs to be returned in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of contained in use CTP names
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining contained in use CTP names

For supported layer rates, see the "managedElementManager::ManagedElementManager_I:: getContainedInUseTPs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when tpName does not reference a PTP object or layerRateList contains undefined rates.

EXCPT_TP_INVALID_ENDPOINT

This exception is raised when tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when tpName references a PTP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.9  managedElementManager::ManagedElementManager_I::
getContainedPotentialTPs

Synopsis

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 allows 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.

For example, 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 STS-3c layer rate.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	Name of the PTP or CTP for which to retrieve contained CTPs
layerRateList	transmissionParameters::LayerRateList_T	In	List of rates of the contained CTPs to report. An empty list tells the EMS to report all contained CTPs (of all rates)
how_many	unsigned long	In	Maximum number of contained CTPs to report in the first batch
tpList	terminationPoint::TerminationPointList_T	Out	First batch of contained in-use CTPs
tpIt	terminationPoint::TerminationPointIterator_I	Out	Iterator to retrieve the remaining contained in-use CTPs

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

CTM supports the following layer rates for the layerRateList parameter:

•ONS 15310, ONS 15327, and ONS 15454 SONET supported layerRate list

–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_STS6c_and_VC4_2c

–LR_STS9c_and_VC4_3c (supported on ONS 15454 SONET R3.2 and later, and on ONS 15327 R3.3 and later.)

–LR_STS24c_and_VC4_8c (supported on ONS 15454 SONET R3.2 and later, and on ONS 15327 R3.3 and later)

–LR_STS192c_and_VC4_64c (supported on ONS 15454 SONET R3.1 and later)

•ONS 15454 SDH supported LayerRate list

–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_STS192c_and_VC4_64c

•ONS 15600 SONET and ONS 15600 SDH supported layerRate list

–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

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that tpName does not reference a PTP or CTP object.

EXCPT_TP_INVALID_ENDPOINT

This exception indicates that tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that tpName references a PTP or CTP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.10  managedElementManager::ManagedElementManager_I::
getContainedPotentialTPNames

Synopsis

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);

Description

This operation has the same behavior as the "managedElementManager::ManagedElementManager_I:: getContainedPotentialTPs" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	The name of the PTP or CTP for which to get contained CTPs
layerRateList	transmissionParameters::LayerRateList_T	In	The list of the rates the contained CTPs to report. An empty list indicates to the EMS to report all contained CTPs (of all rates)
how_many	unsigned long	In	Maximum number of contained CTPs to report in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of contained in-use CTP names
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining contained in-use CTP names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when tpName does not reference a PTP or CTP object.

EXCPT_TP_INVALID_ENDPOINT

This exception is raised when tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when tpName references a PTP or CTP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.7.11  managedElementManager::ManagedElementManager_I::
getContainingSubnetworkNames

Synopsis

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

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	Name of the ME for which to retrieve the containing subnetwork names
subnetNames	globaldefs::NamingAttributesList_T	Out	Names of the subnetworks to which the NE belongs

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that managedElementName does not reference an ME object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that managedElementName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

Compliance

TMF-defined.

3.7.12  managedElementManager::ManagedElementManager_I::
getAllTopologicalLinksForME

Synopsis

void getAllTopologicalLinksForME(

in globaldefs::NamingAttributes_T meName,

      in unsigned long how_many,

      out topologicalLink::TopologicalLinkList_T topoList,

      out topologicalLink::TopologicalLinkIterator_I topoIt)

    raises(globaldefs::ProcessingFailureException);

Description

This interface returns a list of topological links originating or terminating on the specified ME.

---

Note CTM supports this operation only for ONS 15216, ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, ONS 15600 SDH, ONS 15501, ONS 15530, ONS 15540, ONS 1580x, and Unmanaged NEs.

---

Parameters

Name	Type	Input/Output	Description
meName	globaldefs::NamingAttributes_T	In	Name of the ManagedElement.
how_many	unsigned long	In	Maximum number of topological links to return in the first batch.
topoList	topologicalLink::TopologicalLinkList_T	Out	First batch of topological links.
tpIt	topologicalLink::TopologicalLinkIterator_I	Out	Iterator to retrieve the remaining topological links.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that managedElementName does not reference an ME object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that managedElementName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators has been reached to 128.

Compliance

CTM-defined.

3.7.13  managedElementManager::ManagedElementManager_I::
getManagedElement

Synopsis

void getManagedElement(

in globaldefs::NamingAttributes_T managedElementName,

      out managedElement::ManagedElement_T me)

    raises(globaldefs::ProcessingFailureException);

Description

This operation returns the ME for a specific ME name.

Parameters

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	Name of the ME to retrieve
me	managedElement::ManagedElement_T	Out	The retrieved ME

For information about the ManagedElement_T structure, see the "managedElementManager::ManagedElementManager_I:: getAllManagedElements" section.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that managedElementName does not reference an ME object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that managedElementName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

Compliance

TMF-defined.

3.7.14   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 a protecting equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of that PTP.

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	Name of the TP to retrieve
tp	terminationPoint::TerminationPoint_T	Out	Retrieved TP

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that tpName does not reference a TP object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that tpName references a TP object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

Compliance

TMF-defined.

3.7.15  managedElementManager::ManagedElementManager_I::
getAssociatedTopologicalLinks

Synopsis

void getAssociatedTopologicalLinks(

         in globaldefs::NamingAttributes_T ptpName,

         out topologicalLink::TopologicalLink_T topologicalLinks)

         raises(globaldefs::ProcessingFailureException);

Description

This operation allows the NMS to pass the TP name. CTM supports multilayer topological links and returns a list of topological links through the TP. CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15540, ONS 15600 SONET, ONS 15600 SDH, ONS 15800, ONS 15801, and ONS 15808 NEs. CTM reports all the physical optical and manual topological links.

---

Note This operation is CTM-specific and is not defined by the TMF. In the future, if the TMF defines the same method with a different behavior, the name of this method might change.

---

Parameters

Name	Type	Input/ Output	Description
tpName	globaldefs::NamingAttributes_T	In	Name of TP whose topological link is required
topologicalLinks	topologicalLink::TopologicalLink_T	Out	Topological link structure whose end is a specific TP

For information about the TopologicalLink_T structure, see the "emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks" section.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that ptpName does not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that ptpName references a PTP object that does not exist.

EXCPT_NE_COMM_LOSS 

This exception indicates a loss of communication with the NE.

Compliance

CTM-defined.

3.7.16  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. If the equipment is the protecting equipment in a 1_For_N protection group, CTM does not allow user to set parameters for TPs on that protecting equipment.

If the equipment is the protecting equipment in a 1_For_N protection group, CTM does not allow setting for "AlarmReporting" for the PTPs on the equipment. CTM supports the TrailTraceExpectedRx, TrailTraceActualTx, and TrailTraceMonitor parameters for FTPs. For valid values for each parameter, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

CTM supports the following parameters for CTPs:

•IPPMMonitor

•XCLoopback

•TrailTraceActualTx

•TrailTraceExpectedRx

•TrailTraceMonitor

---

Note For G1000 cards, the TrailTraceMonitor and TrailTaceExpectedRx parameters are supported.

---

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 the following parameters for PTPs:

•AlarmReporting

•ServiceState

•AdminState

•LineCode

•FrameFormat

•EnableSyncMsg

•SDH_SONET_SS_BITS

---

Note Valid values for PTP parameters are listed in the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

---

---

Note The SDH_SONET_SS_BITS parameter can be modified only when EnableSyncMsg is Off. In addition, EnableSyncMsg can be set to On only if SDH_SONET_SS_BITS is set to "SONET."

---

---

Note SDH_SONET_SS_BITS and EnableSyncMsg parameters must be modified by invoking two separate method calls. Neither SDH_SONET_SS_BITS nor EnableSyncMsg can be modified in the same method invocation. CTM throws a ProcessingFailureException when such an attempt is made.

---

CTM also supports the following PTP parameters related to Automatic Laser Shutdown. These parameters are not defined by TMF:

•ALSMode

•PulseWidth

•RecoveryInterval

•RestartLaser

If the equipment is the protecting equipment in a 1:N protection group, CTM sets the PTPs on the equipment to "AlarmReporting."

CTM supports the following parameters for FTPs:

•TrailTraceExpectedRx

•TrailTraceMonitor

---

Note Valid values for FTP parameters are listed in the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

---

Use the CTM client to set other parameters. CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs. Invoking this method from the NMS is a synchronous call.

Parameters

Name	Type	Input/Output	Description
tpInfo	subnetworkConnection::TPData_T	In	Details about required modifications
modifiedTP	terminationPoint::TerminationPoint_T	Out	Result of modification

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

CTM supports TPData_T as follows:

•globaldefs::NamingAttributes_T tpName

–Supported.

•terminationPoint::TerminationMode_T tpMappingMode

–Not supported.

•transmissionParameters::LayeredParameterList_T transmissionParams

–Supported.

•globaldefs::NamingAttributes_T ingressTrafficDescriptorName

–Not supported.

•globaldefs::NamingAttributes_T egressTrafficDescriptorName

–Not supported.

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the TP referred to in tpInfo does not exist.

EXCPT_INVALID_INPUT

This exception indicates that tpInfo does not reference a valid CTP object.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

Compliance

TMF-defined.

3.7.17  managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSNCProvisioning

Synopsis

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 CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	Name of the ME that is the source of the SNC to create
layerRate	transmissionParameters::LayerRate_T	In	LayerRate at which the SNC is created. All PTP names available as the source of the SNC at this layer rate are returned
direction	globaldefs::ConnectionDirection_T	In	CTM supports CD_UNI (unidirectional) or CD_BI (bidirectional)
how_many	unsigned long	In	Maximum number of PTP names to report in the first batch
tpList	globaldefs::NamingAttributesList_T	Out	First batch of PTP names
tpIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining PTP names

CTM supports layerRate for ONS 15310, ONS 15327, and ONS 15454 SONET as follows:

•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 on ONS 15327 Release 3.3 or later)

•LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later and on ONS 15327 Release 3.3 or later)

•LR_STS18c_and_VC4_6c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

CTM supports layerRate for ONS 15454 SDH as follows:

•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_STS192c_and_VC4_64c

•LR_STS18c_and_VC4_6c (Supported on ONS 15454 SDH Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15454 SDH Release 5.0 or later)

CTM supports layerRate for ONS 15600 SONET and ONS 15600 SDH as follows:

•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

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the managedElement does not exist.

EXCPT_INVALID_INPUT

This exception indicates an invalid layerRate or direction.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the managedElement.

Compliance

CTM-defined.

3.7.18  managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSNCProvisioning

Synopsis

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 SNCCreateData_T parameter of the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
ptpName	globaldefs::NamingAttributes_T	In	Name of the PTP that is the source of the SNC to create
layerRate	transmissionParameters::LayerRate_T	In	LayerRate at which the SNC is created. All CTP names available at this layer rate are returned
direction	globaldefs::ConnectionDirection_T	In	CTM supports CD_UNI (unidirectional) or CD_BI (bidirectional)
how_many	unsigned long	In	Maximum number of CTP names to report in the first batch
tpList	globaldefs::NamingAttributesList_T	Out	First batch of CTP names
tpIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining CTP names

CTM supports layerRate for the ONS 15310, ONS 15327, and ONS 15454 SONET as follows:

•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 on ONS 15327 Release 3.3 or later)

•LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later and on ONS 15327 Release 3.3 or later)

•LR_STS18c_and_VC4_6c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

CTM supports layerRate for the ONS 15454 SDH as follows:

•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_STS192c_and_VC4_64c

•LR_STS18c_and_VC4_6c (Supported on ONS 15454 SDH Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15454 SDH Release 5.0 or later)

CTM supports layerRate for ONS 15600 SONET and ONS 15600 SDH as follows:

•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

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the managedElement does not exist.

EXCPT_INVALID_INPUT

This exception indicates an invalid layerRate or direction.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the managedElement.

Compliance

CTM-defined.

3.7.19  managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSNCProvisioning

Synopsis

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 CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
managedElementName	globaldefs::NamingAttributes_T	In	Name of the ME that is the destination of the SNC to create.
srcCTPName	globaldefs::NamingAttributes_T	In	Name of the CTP selected as the source CTP name of the SNC to create.
layerRate	transmissionParameters::LayerRate_T	In	LayerRate at which the SNC is created. This value must match the layerRate of srcCTP specified in the srcCTPName field. All PTP names available as the SNC destination at this layer rate are returned.
direction	globaldefs::ConnectionDirection_T	In	CTM supports CD_UNI (unidirectional) or CD_BI (bidirectional).
how_many	unsigned long	In	Maximum number of PTP names to report in the first batch.
tpList	globaldefs::NamingAttributesList_T	Out	First batch of PTP names.
tpIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining PTP names.

CTM supports layerRate for the ONS 15310, ONS 15327, and ONS 15454 SONET as follows:

•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 on ONS 15327 Release 3.3 or later)

•LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later and on ONS 15327 Release 3.3 or later)

•LR_STS18c_and_VC4_6c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

CTM supports layerRate for the ONS 15454 SDH as follows:

•LR_E1_2M (supported on the ONS 15454 SDH Release 4.0 or later)

•LR_E3_34M (supported on the ONS 15454 SDH Release 4.0 or later)

•LR_T3_and_DS3_45M (supported on the ONS 15454 SDH Release 4.0 or later)

•LR_VT2_and_TU12_VC12 (supported on the ONS 15454 SDH Release 4.0 or later)

•LR_Low_Order_TU3_VC3 (supported on the 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_STS192c_and_VC4_64c

•LR_STS18c_and_VC4_6c (Supported on ONS 15454 SDH Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15454 SDH Release 5.0 or later)

CTM supports layerRate for ONS 15600 SONET as follows:

•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

CTM supports layerRate for ONS 15600 SDH as follows:

•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

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the PTP name does not exist.

EXCPT_INVALID_INPUT

This exception indicates an invalid layerRate or direction.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the managedElement.

Compliance

CTM-defined.

3.7.20  managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSNCProvisioning

Synopsis

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 create on a given ME. The NMS must specify the PTP name, 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 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 the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
ptpName	globaldefs::NamingAttributes_T	In	Name of the PTP.
srcCTPName	globaldefs::NamingAttributes_T	In	Name of the CTP selected as the source CTP name of the SNC to create.
layerRate	transmissionParameters::LayerRate_T	In	LayerRate at which the SNC is created. This value must match the layerRate of srcCTP specified in the srcCTPName field. All CTP names available at this layer rate are returned.
direction	globaldefs::ConnectionDirection_T	In	CTM supports CD_UNI (unidirectional) or CD_BI (bidirectional).
how_many	unsigned long	In	Maximum number of CTP names to report in the first batch.
tpList	globaldefs::NamingAttributesList_T	Out	First batch of CTP names.
tpIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining CTP names.

CTM supports layerRate for the ONS 15310, ONS 15327, and ONS 15454 SONET as follows:

•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 on ONS 15327 Release 3.3 or later)

•LR_STS24c_and_VC4_8c (Supported on ONS 15454 Release 3.2 or later and on ONS 15327 Release 3.3 or later)

•LR_STS18c_and_VC4_6c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15327 Release 5.0 or later and on ONS 15454 Release 5.0 or later)

CTM supports layerRate for the ONS 15454 SDH as follows:

•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_STS192c_and_VC4_64c

•LR_STS18c_and_VC4_6c (Supported on ONS 15454 SDH Release 5.0 or later)

•LR_STS36c_and_VC4_12c (Supported on ONS 15454 SDH Release 5.0 or later)

CTM supports layerRate for ONS 15600 SONET and ONS 15600 SDH as follows:

•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

Throws

globaldefs::ProcessingFailureException:

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the PTP name does not exist.

EXCPT_INVALID_INPUT

This exception indicates an invalid layerRate or direction.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the managedElement.

Compliance

CTM-defined.

3.7.21  managedElementManager::ManagedElementManager_I::
getAllSrcFTPsForSNCProvisioning

Synopsis

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 list of FTP names which can be used as source of an SNC to be created on a given ME. The NMS must specify the SNC layer rate to create. This method does not reserve any resources for 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 can fail. Values returned by this list can be used as aEnd in SNCCreateData_T parameter of the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section.

---

Note CTM only supports this method for the ONS 15310, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH.

---

Parameters

Name	Type	Input/Output	Description
meName	globaldefs::NamingAttributes_T	In	Name of the ME that is the source of the SNC to be created.
layerRate	transmissionParameters::LayerRate_T	In	LayerRate at which the SNC is created. All FTPs available at this layer rate are returned.
direction	globaldefs::ConnectionDirection_T	In	CTM supports CD_BI (bidirectional).
how_many	unsigned long	In	Maximum number of FTP names to report in the first batch.
tpList	globaldefs::NamingAttributesList_T	Out	First batch of FTP names.
tpIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining FTP names.

The following layerRate values are supported by CTM:

•LR_STS1_and_AU3_High_Order_VC3

•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

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR 

Raised in case of nonspecific 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::
getAllDestFTPsForSNCProvisioning

Synopsis

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);

This method returns a list of FTP names that can be used as a destination for an SNC to be created on a given ME. The NMS must specify the source TP name (which can be a CTP or FTP) and the layer rate of the SNC to create. This method does not reserve any resources for SNC creation; it only returns the FTP name list based on resource availability at that particular time. It is possible that actual SNC creation can fail. Values returned by this list can be used as zEnd in SNCCreateData_T parameter of the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section.

---

Note CTM only supports this method for the ONS 15310, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH.

---

Parameters

Name	Type	Input/Output	Description
meName	globaldefs::NamingAttributes_T	In	Name of the ME that is the source of the SNC to be created.
srcTPName	globaldefs::NamingAttributes_T	In	Name of the TP that is selected as source TP for SNC to be created.
layerRate	transmissionParameters::LayerRate_T	In	LayerRate at which the SNC is created. All FTPs available at this layer rate are returned.
direction	globaldefs::ConnectionDirection_T	In	CTM supports CD_BI (bidirectional).
how_many	unsigned long	In	Maximum number of FTP names to report in the first batch.
tpList	globaldefs::NamingAttributesList_T	Out	First batch of FTP names.
tpIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve remaining FTP names.

The following layerRate values are supported by CTM:

•LR_STS1_and_AU3_High_Order_VC3

•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

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

Raised in case of nonspecific 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.23  managedElementManager::ManagedElementManager_I::
forceNEResync

Synopsis

void forceNEResync(

in globaldefs::NamingAttributes_T meName

raises(globaldefs::ProcessingFailureException);

Description

This method forces CTM to resynchronize the inventory and alarms of the specified ME. This method returns after basic validation. The ME 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 into CTM error log if the resynchronization fails.

---

Note In the future, if the TMF defines the same method with a different behavior, the name of this method might change. CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SONET, ONS 15600 SDH, ONS 15800, ONS 15801, and ONS 15808 NEs.

---

Parameters

Name	Type	Input/Output	Description
meName	globaldefs::NamingAttributes_T	In	Name of the ManagedElement to be resynched

Throws

globaldefs::ProcessingFailureException:

EXCPT_UNABLE_TO_COMPLY

This exception indicates that an ME is in the initial poll state, or that the ME is already in the resynchronization state.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the ME does not exist.

EXCPT_INVALID_INPUT

This exception indicates an invalid ME name.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the managedElement.

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

Compliance

CTM-defined.

3.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I

This interface accesses subnetworks and their 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_I

This interface also implements the getCapabilities method. Operations described in following sections 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 allows an NMS to request a list of edge TPs for a specific 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 does not include PTPs that are part of a topological link.

---

Note CTM supports this operation only for ONS 15301, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15501, ONS 15530, ONS 15540, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
tpLayerList	transmissionParameters::LayerRateList_T	In	List of TP layer rates for which edge points are retrieved. To be reported, an edge point must contain at least one of the layer rates specified. If the list is empty, edge points of all rates are returned
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	CTM does not use this parameter
how_many	unsigned long	In	Maximum number of edge points to return in the first batch
tpList	terminationPoint::TerminationPointList_T	Out	First batch of edge points
tpIt	terminationPoint::TerminationPointIterator_I	Out	Iterator to retrieve the remaining edge points

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not reference a multiLayerSubnetwork object, or that tpLayerRateList or connectionLayerRateList contains undefined values.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.2  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElements

Synopsis

void getAllManagedElements(

		in globaldefs::NamingAttributes_T subnetName,

		in unsigned long how_many,

		out managedElement::ManagedElementList_T meList,

		out managedElement::ManagedElementIterator_I meIt)

		raises(globaldefs::ProcessingFailureException);

Description

This operation allows an NMS to request a list of MEs that are associated with a specific subnetwork.

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
how_many	unsigned long	In	Maximum number of MEs to report in the first batch
MeList	managedElement::ManagedElementList_T	Out	First batch of MEs
meIt	managedElement::ManagedElementIterator_I	Out	Iterator to retrieve the remaining MEs

For information about the ManagedElement_T structure, see the "managedElementManager::ManagedElementManager_I:: getAllManagedElements" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not reference a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.3  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 the same behavior as the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllManagedElements" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
how_many	unsigned long	In	Maximum number of MEs to report in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of ME names
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining ME names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when subnetName does not reference a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when subnetName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.4  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllSubnetworkConnections

Synopsis

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 allows an NMS to request a list of SNCs for a specific subnetwork at specific connection rates.

•ONS 15327: This method does not support STS1 SNC on XTC using DS1 ports.

•ONS 15454 SONET: This method does not report STS-1 SNC on DS-1 equipment.

•ONS 15454 SDH: This method does not report VC4 SNC on E1, E1_42 equipment. This method does not report VCAT SNCs.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	List of SNC rates to be reported. If an empty list is specified, all SNCs of all rates are reported
how_many	unsigned long	In	Maximum number of SNCs to be reported in the first batch
sncList	subnetworkConnection::SubnetworkConnectionList_T	Out	First batch of SNCs
sncIt	subnetworkConnection::SNCIterator_I	Out	Iterator to retrieve the remaining SNCs

For information about the SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not reference a multiLayerSubnetwork object or that connectionRateList contains undefined values.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.5  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsWithTP

Synopsis

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 allows an NMS to request a list of SNCs that are using a specific TP at specific connection rates. A TP might be a PTP, which requires a full list of SNCs that are using any contained CTPs. A TP might be a CTP name, which requires only SNCs that are using that CTP name or any of its contained CTPs. 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. For ONS 15454 SONET, this method does not report STS-1 SNC on DS-1 equipment. For ONS 15454 SDH, this method does not report VC4 SNC on E1, E1_42 equipment. This method does not report VCAT SNCs.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

---

Note For the ONS 15600 SONET and ONS 15600 SDH, if bridge and roll is applied, one CTP may be associated with two SNCs during a transient phase. If CTM invokes this method in this phase, it will report both the SNCs.

---

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	TP for which to report SNCs
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	List of SNC rates to be reported. If an empty list is specified, all SNCs of all rates are reported
how_many	unsigned long	In	Maximum number of SNCs to be reported in the first batch
sncList	subnetworkConnection::SubnetworkConnectionList_T	Out	First batch of SNCs
sncIt	subnetworkConnection::SNCIterator_I	Out	Iterator to retrieve the remaining SNCs

For information about the SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that tpName does not reference a TP object or that connectionRateList contains undefined values.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that tpName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.6  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNames

Synopsis

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 the same behavior as the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: getAllSubnetworkConnectionsWithTP" section, but instead of returning the entire object structures, this operation returns their names.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork.
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	List of rates of the SNCs to be reported. If an empty list is specified, then all SNCs of all rates are to be reported.
how_many	unsigned long	In	Maximum number of SNCs to be reported in the first batch.
nameList	globaldefs::NamingAttributesList	Out	First batch of SNC names.
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining SNC names.

For details of SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

Raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

Raised when subnetName does not reference an multiLayerSubnetwork object or connectionRateList contains undefined values.

EXCPT_ENTITY_NOT_FOUND

Raised when subnetName references object which does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

Raised when the maximum number of iterators has been reached to 128.

Compliance

TMF-defined.

3.8.7  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesWithTP

Synopsis

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 allows an NMS to request a list of the SNCs using the specified termination point at the specified connection rates. A TP may be a PTP in which case a full list of SNCs using any of its contained CTPs is required. A TP may be a CTP, in which case only SNCs using that CTP or any of its contained CTPs are required. 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. CTM reports all SNCs on Ethernet equipment. CTM does not report VT/VC4 tunnel SNCs.

•ONS 15454 SONET: This method does not report STS1 SNC on DS1 equipment.

•ONS 15454 SDH: This method does not report VC4 SNC on E1 equipment.

---

Note For the ONS 15600, if there is a bridge and roll applied, there exists a transient phase during which one CTP may be associated with two SNCs. In this time, if NMS invokes this method with the CTP that is involved in two SNCs, CTM reports both the SNCs.

---

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	TP for which to report SNCs.
connectionLayerRateList	transmissionParameters::LayerRateList_T	In	List of rates of the SNCs to be reported. If an empty list is specified, then all SNCs of all rates are to be reported.
how_many	unsigned long	In	Maximum number of SNCs to be reported in the first batch.
nameList	globaldefs::NamingAttributesList	Out	First batch of SNC names.
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining SNC names.

For details of SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

Raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

Raised if tpName does not reference a terminationPoint object or connectionRateList contains undefined values.

EXCPT_ENTITY_NOT_FOUND

Raised when tpName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

Raised when the maximum number of iterators has been reached to 128.

Compliance

TMF-defined.

3.8.8  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 inside the subnetwork and whose name is passed as a parameter.

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
how_many	unsigned long	In	Maximum number of topological links to return in the first batch
topoList	topologicalLink::TopologicalLinkList_T	Out	First batch of topological links
tpIt	topologicalLink::TopologicalLinkIterator_I	Out	Iterator to retrieve the remaining topological links

For information about the TopologicalLink_T structure, see the "managedElementManager::ManagedElementManager_I:: getAssociatedTopologicalLinks" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not reference a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception indicates that the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.9  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinkNames

Synopsis

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 the same behavior as the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinks" section, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
how_many	unsigned long	In	Maximum number of topological links to return in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	First batch of topological link names
NameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator to retrieve the remaining topological link names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when subnetName does not reference a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when subnetName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

TMF-defined.

3.8.10  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getMultiLayerSubnetwork

Synopsis

void getMultiLayerSubnetwork(

in globaldefs::NamingAttributes_T subnetName,

out MultiLayerSubnetwork_T subnetwork)

raises(globaldefs::ProcessingFailureException);

Description

This operation returns the subnetwork for a specific subnetwork name.

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork
subnetwork	MultiLayerSubnetwork_T	Out	Subnetwork structure returned

For information about the MultiLayerSubnetwork_T structure, see the "emsMgr::EMSMgr_I::getAllTopLevelSubnetworks" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not reference a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references a multiLayerSubnetwork object that does not exist.

Compliance

TMF-defined.

3.8.11  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getCTPsAndTopologicalLink

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, 2F-BLSR or 4F-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.

•ONS 15310: This method does not support STS1 SNC on CTX using the DS1 ports.

•ONS 15327: This method does not support STS-1 SNC on XTC using DS-1 ports.

•ONS 15454 SONET: This method does not support STS-1 SNC on DS-1 equipment.

•ONS 15454 SDH: This method does not report VC-4 SNC on E1 equipment.

The ProcessingFailureException is thrown with EXCPT_UNABLE_TO_COMPLY in all of the above listed conditions.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
sncName	globaldefs::NamingAttributes_T	In	Name of the subnetwork connection
ctpList	terminationPoint::TerminationPointList_T	Out	Unordered list of CTPs for this SNC. The list includes working and protect CTPs
topoList	topologicalLink::TopologicalLinkList_T	Out	Unordered topological links through which this SNC traverses

For information about the TerminationPoint_T structure, see the "equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs" section.

For information about the TopologicalLink_T structure, see the "managedElementManager::ManagedElementManager_I:: getAssociatedTopologicalLinks" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not reference a multiLayerSubnetwork object.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the method is invoked on SNC on Ethernet equipment or STS-1 SNC on a DS-1 card.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that sncName references an SNC object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE.

Compliance

CTM-defined.

3.8.12  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getSNC

Synopsis

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.

•ONS 15310: This method does not support STS1 SNC on CTX using DS1 ports.

•ONS 15327: This method does not support STS1 SNC on XTC using DS1 ports.

•ONS 15454 SONET: This method does not report STS-1 SNC on DS-1 equipment.

•ONS 15454 SDH: This method does not report VC4 SNC on E1, E1_42 equipment. This method does not support VCAT SNCs.

A ProcessingFailureException is thrown with EXCPT_UNABLE_TO_COMPLY.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
sncName	globaldefs::NamingAttributes_T	In	Name of the subnetwork connection
snc	subnetworkConnection::SubnetworkConnection_T	Out	SNC structure retrieved

For information about the SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that sncName does not reference a subnetworkConnection object.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the method is invoked on SNC provisioning on Ethernet equipment or STS-1 SNC on a DS-1 card.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that sncName references an SNC object that does not exist.

EXCPT_NE_COMM_LOSS 

This exception indicates a loss of communication with the NE.

Compliance

TMF-defined.

3.8.13  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getTopologicalLink

Synopsis

void getTopologicalLink(

in globaldefs::NamingAttributes_T topoLinkName,

out topologicalLink::TopologicalLink_T topoLink)

    raises(globaldefs::ProcessingFailureException);

Description

This operation returns a topological link given its name. CTM reports all autodiscovered and manual topological links.

---

Note CTM supports this operation for all NEs.

---

Parameters

Name	Type	Input/Output	Description
topoLinkName	globaldefs::NamingAttributes_T	In	Name of the subnetwork topological link to retrieve
topoLink	topologicalLink::TopologicalLink_T	Out	Subnetwork topological link returned

For information about the TopologicalLink_T structure, see the "managedElementManager::ManagedElementManager_I:: getAssociatedTopologicalLinks" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that topoLinkName does not reference a subnetwork topological link object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that topoLinkName references a subnetwork topological link object that does not exist.

Compliance

TMF-defined.

3.8.14  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
createAndActivateSNCFromUserLabel

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 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 the NMS wants to control the SNC name, it should 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 assigns it to the name of the new SNC. CTM also verifies the uniqueness of the name. The operation fails if the 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 specifying the description in the additionalCreationInfo field.

CTM cleans up resources if SNC creation fails. For example, if CTM fails to create the SNC on the destination node, CTM also cleans up resources on the source node.

If the OC-N 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 to be created. Typical use of FTP is to create SNC on Ethernet equipment, to create tunnel SNC, or to create VAP/LAP circuit. See the "2.2.7.3  Tunnel SNC Provisioning" section on page 2-59 for information about SNC provisioning.

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 PCA. PCA SNCs are unprotected. For information about PCA, refer to the NE documentation.

Users have the option to provide description for the SNC. Specify the description in the additionalCreationInfo field.

To create dual ring interconnect SNC, the staticProtectionLevel value in createData needs to be set to HIGHLY_PROTECTED. Use CTC or the CTM client to modify the Hold-off Timer attribute for this SNC.

The following types of circuit creation are not supported:

•Monitor circuits

•STS1 on DS1 cards and VC4 on E1 or E1_42 cards

•Dual-ring interconnect (DRI) circuits with routing constraints

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 to 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 to 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.

---

Note The input CTP list should represent only the end point pairs of each span, and should not include the aEnd and zEnd of the SNC to be created. DRI SNC creation is not supported when you specify the complete list of CTP pairs.

---

If you create an SNC with at least one end point on ML-series equipment, CTM identifies the SNC as the underlying 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 notifying the creation of a new L2 point-to-point topology in CTM.

CTM provides support for creation of open-ended UPSR circuits. There are two types of SNC that can be created to create an open-ended UPSR circuit.

If there is one source point and two destination end points, the NMS must specify the source point in SNCCreateData_T.aEnd. The two destination end points must be in SNCCreateData_T.zEnd.

If there are two source points and one destination point, the NMS must specify two source points in SNCCreateData_T.aEnd. The destination end point must be in SNCCreateData_T.zEnd.

CTM supports optical channel SNC creation on WDM cards through this method. For more information, see the "2.2.7.4  SNC Provisioning on WDM Equipment" section on page 2-61. The sncSize field in additionalCreationInfo is used to specify the size for the optical channel SNC.

---

Note The sncSize field is not checked to make sure that it is supported by the NE version.

---

For the ONS 15454 SONET, this operation allows 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 high-density portless transmux card (DS3XM-12) can be provided using "usePortlessTransmux," "portlessTransmuxMeName," "portlessTransmuxSlot," and "isSourceDS3MappedSTS" attributes in the "additionalCreationInfo" field.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
CreateData	subnetworkConnection::SNCCreateData_T	In	Structure describing the SNC to create and activate.
tolerableImpact	subnetworkConnection::GradesOfImpact_T	In	Maximum tolerable impact allowed.
emsFreedomLevel	EMSFreedomLevel_T	In	Maximum level of freedom that the EMS has to perform the creation and activation.
tpsToModify	subnetworkConnection::TPDataList_T	In Out	CTM ignores this parameter.
theSNC	subnetworkConnection::SubnetworkConnection_T	Out	Resulting SNC. sncState and name are set. The name is set to the user label supplied in the createData structure.
errorReason	String	Out	Specifies the creation or activation error(s), if any.

---

Note Locking is not supported.

---

For information about the SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

CTM supports SNCCreateData_T as follows:

•string userLabel

–Supported. The value of this field is assigned to the name of the new SNC.

•boolean forceUniqueness

–CTM guarantees the uniqueness only if all SNCs are created by CTM. If another tool is used for SNC creation, CTM cannot guarantee uniqueness.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction. 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)

–CD_BI_WE (bidirectional west to east)

•StaticProtectionLevel_T staticProtectionLevel

–CTM supports UNPROTECTED, FULLY_PROTECTED, and HIGHLY_PROTECTED. Other values are not supported.

•ProtectionEffort_T protectionEffort

–CTM supports all values defined by the TMF.

–If the NMS requests unprotected SNC on a BLSR ring, CTM creates an SNC. This also applies for unprotected SNCs on 1+1 protection.

–If the NMS specifies EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, CTM expects the value of the staticProtectionLevel to be UNPROTECTED. These values indicate that CTM must create PCA.

•Reroute_T rerouteAllowed

–Not supported.

•NetworkRouted_T networkRouted

–Not supported.

•SNCType_T sncType

–Not supported.

•transmissionParameters::LayerRate_T layerRate

CTM supports layerRate for the ONS 15310, ONS 15327, and ONS 15454 SONET as follows:

–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 on ONS 15327 Release 3.3 or later)

–LR_STS24c_and_VC4_8c (supported on ONS 15454 Release 3.2 or later and on ONS 15327 Release 3.3 or later)

–LR_STS18c_and_VC4_6c (supported on ONS 15454 Release 5.0 or later and on ONS 15327 Release 5.0 or later)

–LR_STS36c_and_VC4_12c (supported on ONS 15454 Release 5.0 or later and on ONS 15327 Release 5.0 or later)

–LR_Optical_Channel (for WDM SNC)

CTM supports layerRate for the ONS 15454 SDH as follows:

–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 SNC)

•CTM supports layerRate for ONS 15600 SONET and ONS 15600 SDH as follows:

–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

•CrossConnectList_T ccInclusions

–Not supported.

•ResourceList_T neTpInclusions

–Supported. CTM expects a list of ME names or any one PTP name of a topological link or the CTP name pair representing the end points of the span to be included in the SubnetworkConnection route.

•boolean fullRoute

–Not supported.

•ResourceList_T neTpSncExclusions

–Supported. CTM expects a list of ManagedElement name or any one PTP name of a topological link to be excluded in the SubnetworkConnection route.

•globaldefs::NamingAttributesList_T aEnd

–Supported. CTM expects at least one valid CTP name or FTP in this list. At most two valid CTPs can be in the list.

•globaldefs::NamingAttributesList_T zEnd

–Supported. CTM expects at least one valid CTP name or FTP in this list. At most two valid CTPs can be in the list.

•globaldefs::NVSList_T additionalCreationInfo

–Supported. Table 3-1 provides additional CTM-supported parameters for SNC creation. For more information, refer to the Cisco ONS 15454 SONET user documentation.

Table 3-1 CTM-Supported Parameters for SNC Creation 

Name	Value	Description
upsrRevertiveMode	revertive or nonrevertive	If the value is set to revertive, traffic reverts back to the working path when the conditions that diverted it to the protect path are repaired. Otherwise, traffic remains on the protect path after the switch.
upsrRevertiveTime	Valid float value between 0.5 to 12 in increments of 12	If SNC is revertive, set this parameter. The value is the amount of time that elapses before the traffic reverts to the working path. The default value is 5 minutes. Note CTM does not validate this value.
upsrSfBerLevel	3, 4, or 5	Sets the unidirectional path switched ring (USPR) path-level signal failure bit error rate thresholds (for STS SNCs only). Note CTM does not validate this value.
upsrSdBerLevel	5, 6, 7, 8, 9	Sets the UPSR path-level signal degrade bit error rate thresholds (for STS SNCs only). Note CTM does not validate this value.
upsrSwitchOnPdiP	true or false	Set this value to true if you want traffic to switch when an STS payload defect indicator is received (for STS SNCs only).
goAndReturnRouting	true or false	Set this to true if you want to provision SNCP/UPSR protection routes in Go and Return manner (ITU-T G.841). Otherwise, SNCP/UPSR protection routes are provisioned in a unidirectional manner following the GR-1400.
sncDescription	String	The description for SubnetworkConnection. This value is represented in the userLabel field of the SubnetworkConnection_T structure.
VLAN	Vlan ID	NMS must provide one or more VLAN names. The value field provides the VLAN to be used by CTM for SNC creation on Ethernet equipment. An exception is thrown if the VLAN specified does not exist in the MultiLayerSubnetwork of the source TP.
CustomerID	String	User-specified string representing the customer ID.
ServiceID	String	User-specified string representing the service ID.
sncSize	int 1=2.5Gb/s FEC 2=2.5Gb/s No FEC 3=10 Gb/s FEC 4=10 Gb/s No FEC 5=Multirate 6=Equipped not specific	User-specified size for WDM SNC. The default value is 6.
createTunnelOnTransitNode	true or false	Applicable to VT and VC circuits with transit nodes that do not have a tunnel or the existing tunnel is full. This parameter specifies whether to create a tunnel on the transit nodes. For circuits without transit nodes or with an existing tunnel on a transit node that is not full, this value is ignored. If the value specified is true, a tunnel is created and the circuit is routed through the tunnel. If the value specified is false, a new tunnel is not created. In this case, if a tunnel that is not full is available on the transit node, the circuit is routed through the tunnel. Otherwise, the circuit is not routed through a tunnel.
createVTAggregation	true or false	Applicable to VT and VC SNCs with one or more transit nodes that do not have a VAP circuit or the existing VAP circuit is exhausted. These parameters specify whether to create a new VAP circuit on the transit node(s). If the value specified is true, a VAP circuit is created and the SNC is routed using the new VAP circuit. If the value specified is false, then a new VAP circuit is created.
sourceIsSTSGrooming	true or false	Applicable in case of "true" source drop point of the VT or VC circuit that is STS-groomed for the VAP circuit creation. Note This attribute is valid only when the createVTAggregation value is set to true. Note SourceIsSTSGrooming and destinationIsSTSGrooming cannot both be set to true.
destinationIsSTSGrooming	true or false	Applicable in case of "true" destination drop point of the VT or VC circuit that is STS-groomed for the VAP circuit to be created. Note This attribute is valid only when createVTAggregation value is set to true. Note SourceIsSTSGrooming and destinationIsSTSGrooming cannot both be set to true.
vapDestination	String	User specifies the string (ME name) representing the VAP destination drop point.
usePortlessTransmux	true or false	When set to true, a portless Transmux card is used for the circuit. NMS shall provide information for portlessTransmuxMename, portlessTransmuxSlot, and isSourceDS3MappedSTS. Otherwise, an INVALID INPUT exception is thrown. When set to false, a portless transmux card is not used as the intermediate point for the end-to-end STS-1 circuit.
portlessTransmuxMeName	String	This parameter will have an ME name containing a high-density portless transmux card, which needs to be used as the circuit constraint. Note This attribute is applicable only if useportlessTransmux is true.
portlessTransmuxSlot	/rack=1/shelf=1/slot-[1..6][12..17]	NMS shall provide the physical location of the high-density portless transmux card. Note Information is required up to slot level. Note This attribute is applicable only if usePortlessTransmux is true.
isSourceDS3MappedSTS	true or false	Indicates whether source or destination is DS3-mapped. Note This attribute is applicable only if usePortlessTransmux is true.
vcatmemeberID	int, 1 to 256	Used for VCAT SNC creation, to identify every VCAT member L1 SNC uniquely. For normal CCAT circuits, this value is ignored, if specified.

---

Note CTM does not support tolerableImpact (GradesOfImpact_T) because circuits created on the ONS 15327 and ONS 15454 SONET do not impact existing traffic.

---

---

Note CTM does not support emsFreedomLevel (EMSFreedomLevel_T) because CTM always has full control of SNC creation.

---

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR 

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that a createData field is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception occurs when fields of createData reference objects that do not exist.

EXCPT_UNABLE_TO_COMPLY

This exception indicates that the SNC cannot be created or activated because the CTP name conflicts with another SNC or the NE does not support this SNC creation. This exception is also raised when CTM cannot meet the protection level or when there is no bandwidth available.

EXCPT_NE_COMM_LOSS

This exception indicates that a loss of communication with the NE prevents SNC creation.

EXCPT_USERLABEL_IN_USE

This exception indicates that 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.14.1  Creating DS-3 SNC in a Single ONS 15454 SONET Node

As shown in Figure 3-1, the ONS 15454 SONET has a DS-3 card installed in slot 4 and an OC-48 card installed in slot 13. There are twelve DS-3 ports available on the DS-3 card and one OC-48 port available on the OC-48 card.

Figure 3-1 Creating DS-3 SNC Originating and Terminating on the Same Node

To create the SNC from port 1 on the DS-3 card and drop it to the first STS on the OC-48 card, the NMS writes code that is similar to the following example:

// Assuming that reference to MultiLayerSubnetworkMgr_I is already available

// in subnetworkMgr

SNCCreateData_T createData = new SNCCreateData_T();

createData.userLabel = new String("Test DS3 Circuit");

createData.forceUniqueness = true;

// createData.owner is not supported by CTM 

// Bidirectional SNC

createData.direction = ConnectionDirection.CD_BI;

// Unprotected SNC

createData.staticProtectionLevel = 

StaticProtectionLevel_T.UNPROTECTED;

// CTM does not support any other value

createData.protectionEffort = 

ProtectionEffort_T.EFFORT_SAME_OR_BETTER;

// createData.rerouteAllowed, createData.networkRouted and 

// createData.sndType are not supported by CTM

createData.layerRate = 4; // LR_T3_and_DS3_45M

// createData.ccInclusions, createData.neTpInclusions, 

// createData.fullRoute and createData.neTpSncExclusions

// are not supported by CTM

NameAndStringValue_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 port 

NameAndStringValue_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 object

GradesOfImpact_T tolerableImpact = new GradesOfImpact_T();

EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();

// Not modifying any TPs

TPDataList_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.14.2  Creating DS-3 Protected SNC Through 2-Fiber BLSR and 1+1 Configuration

Figure 3-2 shows a configuration where Node 1, Node 2, and Node 3 form the 2-fiber BLSR ring. All nodes are ONS 15454 SONET nodes. Node 3 is connected to Node 4 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 1 to Node 4. The DS-3 is dropped at source NE Node 1 on slot 4 and port 1. The SNC destination is the OC-12 port on Node 4.

// Assuming that reference to MultiLayerSubnetworkMgr_I is already available

// in subnetworkMgr

SNCCreateData_T createData = new SNCCreateData_T();

createData.userLabel = new String("Test DS3 Circuit");

createData.forceUniqueness = true;

// createData.owner is not supported by CTM 

// Bidirectional SNC

createData.direction = ConnectionDirection.CD_BI;

// Unprotected SNC

createData.staticProtectionLevel = 

StaticProtectionLevel_T.FULLY_PROTECTED;

// CTM does not support any other value

createData.protectionEffort = 

ProtectionEffort_T.EFFORT_SAME_OR_BETTER;

// createData.rerouteAllowed, createData.networkRouted and 

// createData.sndType are not supported by CTM

createData.layerRate = 4; // LR_T3_and_DS3_45M

// createData.ccInclusions, createData.neTpInclusions, 

// createData.fullRoute and createData.neTpSncExclusions

// are not supported by CTM

NameAndStringValue_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 port 

NameAndStringValue_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 object

GradesOfImpact_T tolerableImpact = new GradesOfImpact_T();

EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();

// Not modifying any TPs

TPDataList_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.14.3  Creating Unprotected DS-3 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 
subnetworkMgr

SNCCreateData_T createData = new SNCCreateData_T();

createData.userLabel = new String("Test DS3 SNC Manual");

createData.forceUniqueness = true;

// createData.owner is not supported by CTM 

// Bidirectional SNC

createData.direction = ConnectionDirection.CD_BI;

// Unprotected SNC

createData.staticProtectionLevel = 

StaticProtectionLevel_T.FULLY_PROTECTED;

// CTM does not support any other value

createData.protectionEffort = 

ProtectionEffort_T.EFFORT_SAME_OR_BETTER;

// createData.rerouteAllowed, createData.networkRouted and 

// createData.sndType are not supported by CTM

createData.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 port 

NameAndStringValue_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 object

GradesOfImpact_T tolerableImpact = new GradesOfImpact_T();

EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();

// Not modifying any TPs

TPDataList_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.14.4  Creating Unprotected DS-3 SNC by Specifying 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 
subnetworkMgr

SNCCreateData_T createData = new SNCCreateData_T();

createData.userLabel = new String("Test DS3 SNC Manual");

createData.forceUniqueness = true;

// createData.owner is not supported by CTM 

// Bidirectional SNC

createData.direction = ConnectionDirection.CD_BI;

// Unprotected SNC

createData.staticProtectionLevel = 

StaticProtectionLevel_T.FULLY_PROTECTED;

// CTM does not support any other value

createData.protectionEffort = 

ProtectionEffort_T.EFFORT_SAME_OR_BETTER;

// createData.rerouteAllowed, createData.networkRouted and 

// createData.sndType are not supported by CTM

createData.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 port 

NameAndStringValue_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 object

GradesOfImpact_T tolerableImpact = new GradesOfImpact_T();

EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();

// Not modifying any TPs

TPDataList_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.14.5  Creating Unprotected DS-3 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 between 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 
subnetworkMgr

SNCCreateData_T createData = new SNCCreateData_T();

createData.userLabel = new String("Test DS3 SNC Manual");

createData.forceUniqueness = true;

// createData.owner is not supported by CTM 

// Bidirectional SNC

createData.direction = ConnectionDirection.CD_BI;

// Unprotected SNC

createData.staticProtectionLevel = 

StaticProtectionLevel_T.FULLY_PROTECTED;

// CTM does not support any other value

createData.protectionEffort = 

ProtectionEffort_T.EFFORT_SAME_OR_BETTER;

// createData.rerouteAllowed, createData.networkRouted and 

// createData.sndType are not supported by CTM

createData.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 #1

createData.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 #2

createData.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 #3

createData.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 #4

createData.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 port 

NameAndStringValue_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 object

GradesOfImpact_T tolerableImpact = new GradesOfImpact_T();

EMSFreedomLevel_T emsFreedomLevel = new EMSFreedomLevel_T();

// Not modifying any TPs

TPDataList_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.15  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 15310, ONS 15327, and ONS 1545 SONET. There are two steps to creating an SNC with multiple drops:

1. Invoke the operation described in "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section to create a unidirectional SNC between two nodes.

2. Add new drop points to existing an SNC.

The CTP layer rate must match the SNC layer rate. This method performs on a best-effort basis. If CTM fails to add one or more CTPs to the SNC, it throws an UNABLE_TO_COMPLY exception. The errorReason contains a list of CTPs that failed.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
sncName	globaldefs::NamingAttributes_T	In	Name of the subnetwork connection to modify and add additional CTPs
zEnd	globaldefs::NamingAttributesList_T	In	List of additional CTPs to add to the SNC

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that sncName does not refer to an SNC object or that the CTP layer rate does not match the SNC layer.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that sncName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception indicates that a CTP is in use by another SNC or that no bandwidth is available.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the ME that prevents deactivation of the SNC.

Compliance

CTM-defined.

3.8.16  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 delete a subnetwork connection with one command.

CTM removes resources allocated to the 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. The first step is validation, which is performed synchronously. If the validation is successful, this operation returns successfully. If the validation fails, the NMS receives an exception. After a successful validation, the second step is the actual deletion of resources from all NEs. This step is performed asynchronously. CTM changes the SNC state to SNCS_DELETING and sends a notification to the NMS. Upon successful completion, CTM generates an OBJECT_DELETION event. If CTM loses connectivity to one or more nodes on the SNC, it aborts the cleanup and generates an SNCS_PARTIAL state change event. The NMS must reinvoke this method when connectivity to the node is restored. If the deletion fails but the state remains SNCS_ACTIVE, CTM generates an AVC event. These SNC state change events are generated as part of the CTM operation only. If another interface is used, CTM cannot generate these events.

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 you try to delete such SNCs.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
sncName	globaldefs::NamingAttributes_T	In	Name of the subnetwork connection to deactivate and delete
tolerableImpact	subnetworkConnection::GradesOfImpact_T	In	CTM ignores this parameter
emsFreedomLevel	EMSFreedomLevel_T	In	CTM ignores this parameter
tpsToModify	subnetworkConnection::TPDataList_T	In Out	CTM ignores this parameter
theSNC	subnetworkConnection::SubnetworkConnection_T	Out	Deactivated and deleted subnetwork connection
errorReason	string	Out	Deactivation and deletion error(s), if any

For information about the SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that sncName does not refer to an SNC object, or that a tpsToModify field is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that sncName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication with the NE that prevents SNC deactivation.

Compliance

TMF-defined.

3.8.17  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:

•ML equipment (ML1000 and ML100T)

•FC_MR-4

•CE-100T-8

•ML-100T-8

---

Note CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcatName	globaldefs::NamingAttributes_T	In	Name of VCAT SNC
vcat	subnetworkConnection::VCAT_T	Out	VCAT structure

CTM supports VCAT_T as follows:

•globaldefs::namingAttributes_T vcatName

–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.

•string userLabel

–Supported.

•string nativeEMSName

–Supported. The name supplied by the user at creation time will be reported.

•string owner

–Not supported.

•VCATState_T vcatState

Supported. The state of the VCAT circuit is derived from the states of the member circuits in the same way as it is derived for CCAT SNCs. The values supported are:

–VCATState_T.VCATS_NONEXISTENT

–VCATState_T.VCATS_PENDING

–VCATState_T.VCATS_ACTIVE

–VCATState_T.VCATS_PARTIAL

–VCATState_T.VCATS_DELETING

•globaldefs::ConnectionDirection_T direction

Supported. This represents the direction of the VCAT and not the member L1 SNCs. CTM supports:

–CD_BI (bidirectional)

•boolean is Symmetrical

Supported. CTM supports symmetric VCAT SNCs. Values are:

–True if the rate or capacity is same in both directions.

–False if the rate or capacity is different in each direction.

•transmissionParameters::VCATLayerRate_T txRate

Supported. This represents the total capacity the VCAT SNC can carry in the forward direction. If the VCAT is symmetrical, then it represents the capacity in both the forward and backward directions. To represent the total capacity of a VCAT SNC, VCATLayerRate_T contains the following information:

–LayerRate_T memberRate—Represents the layer rate of the member SNCs

–Unsigned long number of members—Number of members for a given VCAT SNC.

The layer rates supported for the VCAT SNCs are:

–LR_VT1_5_and_TU11_VC11

–LR_Low_Order_TU3_VC3 (for the ONS 15454 SDH)

–LR_STS1_and_AU3_High_Order_VC3

–LR_STS3c_and_AU4_VC4

–LR_STS12c_and_VC4_4c

•transmissionParameters::VCATLayerRate_T rxRate

Supported. This represents the total capacity that the VCAT SNC can carry in the backward direction. If the VCAT is symmetrical, then the field should be ignored. The layer rates supported for the VCAT SNCs are:

–LR_VT1_5_and_TU11_VC11

–LR_Low_Order_TU3_VC3 (for the ONS 15454 SDH)

–LR_STS1_and_AU3_High_Order_VC3

–LR_STS3c_and_AU4_VC4

–LR_STS12c_and_VC4_4c

•transmissionParameters::LayerRate_T memberRate

–Supported. This represents the rate of each member circuit.

•globaldefs::NamingAttributes_T aEnd

–Supported. This is an FTP representing the port at the aEnd.

•globaldefs::NamingAttributes_T zEnd

–Supported. This is an FTP representing the port at the aEnd

•SNCType_T sncType

–Not supported.

•subnetworkConnection::LCASMode_T mode

Supported. CTM supports the following:

–LCASMode_T.LCASMODE_NONE

–LCASMode_T.LCASMODE_SWLCAS

–LCASMode_T.LCASMODE_LCAS

•subnetworkConnection::RoutingMode_T routingMode

–RoutingMode_T.ROUTE_COMMONFIBER

–RoutingMode_T.Route_INDEPENDENTFIBER

•globaldefs::NVSList_T additional Info

–Supported. Customer ID and Service ID are reported if available.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that the VCAT name does not refer to a VCAT SNC object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the VCAT name references an object that does not exist.

Compliance

CTM-defined.

3.8.18  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 VCAT SNCs only.

---

Note CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork.
connectionLayerRateList	transmissionParameters::VCATLayerRateList_T	In	List of the VCAT SNCs that is reported with specified number of members and member rate. If an empty list is reported, all VCAT SNCs of bandwidths are reported.
how_many	unsigned long	In	Maximum number of SNCs reported in the first batch.
vcatList	subnetworkConnection::VCATList_T	Out	First batch of VCAT SNCs.
vcatIt	subnetworkConnectionVCATIterator_I	Out	Iterator to retrieve the remaining VCAT SNCs.

For more information on the VCAT_T structure, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not refer to a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

CTM-defined.

3.8.19  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 all the VCAT SNCs in the specified multilayer subnetwork. This operation returns VCAT SNC names only.

---

Note CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetName	globaldefs::NamingAttributes_T	In	Name of the subnetwork.
connectionLayerRateList	transmissionParameters::VCATLayerRateList_T	In	List of the VCAT SNCs that is reported with specified number of members and member rate. If an empty list is reported, all VCAT SNCs of bandwidth are reported.
how_many	unsigned long	In	Maximum number of SNCs are reported in the first batch.
nameList	globaldefs::NamingAttributesList_T	Out	First batch of VCAT SNC names.
nameIt	globaldefs::NamingAttributesIterator_T	Out	Iterator to retrieve the remaining VCAT SNCs names.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that subnetName does not refer to a multiLayerSubnetwork object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that subnetName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

CTM-defined.

3.8.20  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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcatName	globaldefs::NamingAttributes_T	In	Name of the VCAT SNC.
isTransmit	boolean	In	IsTransmit boolean should be set to true if only the transmit-side member SNCs should be returned. If set to false, only receive-side member SNCs will be returned. If VCAT is symmetrical, then the isTransmit value is ignored and all bidirectional SNCs are returned.
how_many	unsigned long	In	Maximum number of SNCs are reported in the first batch.
sncList	subnetworkConnection::subnetworkconnectionList_T	Out	First batch of SNCs.
sncIt	subnetworkConnection::SNCIterator_I	Out	Iterator to retrieve the remaining SNCs.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that vcatName does not refer to a VCAT object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that vcatName references an object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

CTM-defined.

3.8.21  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllVCATMemberSNCNames

Synopsis

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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcatName	globaldefs::NamingAttributes_T	In	Name of the VCAT SNC.
isTransmit	boolean	In	If set to true, only transmit-side member SNCs are returned. If set to false, receive-side member SNCs are returned. If VCAT is symmetrical, then the isTransmit value is ignored and the bidirectional SNCs are returned.
how_many	unsigned long	In	Maximum number of member VCAT SNCs to be reported in the first batch.
nameList	globaldefs::NamingAttributesList_T	Out	First batch of member VCAT SNC names.
nameIt	globaldefs::NamingAttributesIterator_T	Out	Iterator to retrieve the remaining member VCAT SNC names.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception is raised when a vcatName does not reference a VCAT object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that the vcatName reference objects do not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators has reached 128.

Compliance

CTM-defined.

3.8.22  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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
createData	subnetworkConnection::VCATSNCCreateData_T	In	Structure that describes the VCAT SNC that will be created.
vcat	subnetworkConnection::VCAT_T	Out	The VCAT SNC that was created.
errorReason	string	Out	Error reason for failure.

CTM supports VCATSNCCreateData_T as follows:

•string userLabel

–Supported. Value assigned to this field is the name of the new VCAT.

•boolean forceUniqueness

–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.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction

–CTM R5.0 supports the CD_BI (bidirectional).

•boolean isSymmetrical

–Supported. In CTM R5.0, 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.

•subnetworkConnection::LCASMode_T mode

Supported. CTM supports the following:

–LCASMode_T.LCASMODE_NONE

–LCASMode_T.LCASMODE_SWLCAS

–LCASMode_T.LCASMODE_LCAS

•subnetworkConnection::RoutingMode_T routingMode

–RoutingMode_T.ROUTE_COMMONFIBER_ROUTED

–RoutingMode_T.Route_INDEPENDENTFIBER_ROUTED

•subnetworkconnection::TPData_T aEnd;

–Supported. CTM expects this field to be an FTP representing the information up to port level of the card involved in the VCAT SNC.

•subnetworkconnection::TPData_T zEnd

–Supported. CTM expects this field to be an FTP representing the information up to port level of the card involved in the VCAT SNC.

•subnetworkConnection::SNCCreateDataList sncCreateDataList

–Supported. At least one member L1 SNC should be created at the time of VCAT SNC creation. CTM expects you to specify the create data to create the L1 SNCs in this data structure. For more information on SNCCreateData_T structure, see the"multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section. For every L1 SNC, you need to specify an additionalCreationParameter "vcatMemberID" that contains a unique value from 1 to 256.

•globaldefs::NVSList_T additionalCreationInfo

–This can be used to provide additional parameters for VCAT creation. CTM supports the following values:

Name	Value	description
vcatDescription	string	Description of the VCAT.
customerID	string	User-specified string representing the customer ID.
serviceID	string	User-specified string representing the service ID.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates when CreateData field is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception indicates the fields of Createdata reference objects that do not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised if the VCAT SNC cannot be created and activated because FTP conflicts with other VCAT SNC or the NE does not support this VCAT SNC creation. This is also raised when CTM cannot meet the protection level or there are not bandwidths available.

EXCPT_NE_COMM_LOSS

This exception indicates that communications with managedElement has been lost, preventing the creation of the VCAT SNC.

EXCPT_USER:ABEL_IN_USE

This exception indicates that the userLabel uniqueness constraints have not been met.

Compliance

CTM-defined.

3.8.23  multiLayerSubnetwork::MultiLayerSubnetwokMgr_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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcatName	globaldefs::NamingAttributes_T	In	Name of the VCAT SNC.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that vcatName does not refer to a VCAT object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that vcatName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the deletion of the VCAT SNC fails.

Compliance

CTM-defined.

3.8.24  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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcat	globaldefs::NamingAttributes_T	In	Name of the VCAT SNC.
sncData	subnetworkConnection::SNCCreateDataList_T	In	Structure that describes the SNC(s) that will be created and added to the VCAT.
vcat	subnetworkConnection::VCAT_T	Out	The augmented VCAT SNC.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that vcatName does not refer to a VCAT object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that vcatName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the deletion of the VCAT SNC fails.

Compliance

CTM-defined.

3.8.25  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteMemberSNCsFromVCAT

Synopsis

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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcatName	globaldefs::NamingAttributes_T	In	Name of the VCAT SNC.
sncName	globaldefs::NamingAttributesList_T	In	Name of the SNC(s) to be deleted and removed from the VCAT.
vcat	subnetworkConnection::VCAT_T	Out	The modified VCAT SNC.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that vcatName or sncName does not refer to a VCAT/SNC object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that vcatName or sncName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the deletion of member SNC(s) to the VCAT fails.

Compliance

CTM-defined.

3.8.26  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteAllMemberSNCFromVCAT

Synopsis

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 CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
vcatName	globaldefs::NamingAttributes_T	In	Name of the VCAT SNC.
isForward	boolean	In	This boolean variable is used to ascertain the direction in which member SNCs of the VCAT are deleted.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific internal EMS failure.

EXCPT_INVALID_INPUT

This exception indicates that vcatName does not refer to a VCAT object.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that vcatName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the deletion of member SNC(s) to the VCAT fails.

Compliance

CTM-defined.

3.8.27  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getValidSubnetworkConnectionsForMerge

Synopsis

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 The valid SncUpgradeInfo value supported by CTM GateWay/CORBA is Merge. The valid SncFilterCriteria value supported by CTM GateWay/CORBA is LINED_UP. The available values that will be supported in the future are listed in the ENUM definitions below.

---

Parameters

Name	Type	Input/Output	Description
details	multiLayerSubnetwork::SncUpgradeInfo_T	In	Upgrade info for which the list of SNCs is requested. Available values are: •Merge •Reconfigure Note CTM GateWay/CORBA Release 5.0 supports only Merge.
filterCriteria	multiLayerSubnetwork::SncFilterCriteria_T	In	The filter criteria can be used to specify if the requested SNCs are LINED_UP or nonfiltered. Note CTM GateWay/CORBA Release 5.0 supports only LINED_UP.
masterSncName	globaldefs::NamingAttributes_T	In	This parameter is used to specify the name of the SNC to which the following candidate SNCs are to be merged or upgraded.
candidateSncList	globaldefs::NamingAttributesList_T	In	This parameter gives a list of SNCs that needs to be merged with the master SNC.
how_many	unsigned long	In	This parameter specifies the number of SNCs that needs to be passed and are valid for merge operation with the master SNC.
mergeableSncList	subnetworkConnection::SubnetworkConnectionList_T	Out	This parameter gives the list of SNCs that qualify for a merge.
sncIt	subnetworkConnection::SNCIterator_I	Out	This parameter is used to iterate the list of SNCs returned by the API.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

ENUM Definition

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};

Compliance

CTM-defined.

3.8.28  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

Name	Type	Input/Output	Description
details	multiLayerSubnetwork::SncUpgradeInfo_T	In	Upgrade info for which the list of SNCs are requested. Available values are: •Merge •Reconfigure
masterSncName	globaldefs::NamingAttributes_T	In	This parameter is used to specify the name of the SNC to which the following candidate SNCs are to be merged or reconfigured.
upgradableSncNameList	globaldefs::NamingAttributesList_T	In	This parameter gives the list of SNCs that needs to be merged or reconfigured with the master SNC.
resultString	string	Out	This parameter gives the result of the operation in human-readable form.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_STRICT_MERGE_FAILED

This exception is 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.9  nmsSession::NmsSession_I

This interface allows the EMS to inform the NMS of problems with notifications. When CTM fails to push an event, it notifies all connected NMSs by invoking the eventLossOccurred method on every active NmsSession_I. When the event loss period is over, CTM invokes the eventLossCleared method on NmsSession_I.

Both methods are implemented by the NMS.

NmsSession also implements all methods defined in the "session::Session_I" section.

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

Name	Type	Input/Output	Description
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 included in the errorReason parameter.

Parameters

Name	Type	Input/Output	Description
errorReason	string	Out	Error string to indicate 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 the "common::Common_I" section.

interface PerformanceManagementMgr_I:common::Common_I

This 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.

If PM collection was never started for this TP, the operation is considered successful.

Parameters

Name	Type	Input/Output	Description
pmTPSelectList	PMTPSelectList_T	In	This structure contains the relevant data for the disablePMData request. This must not be empty.
failedTPSelectList	PMTPSelectList_T	Out	List of points that were not completely disabled. An empty list indicates that the total request was successful.

CTM provide the following support for the PMTPSelect_T structure for this method:

•globaldefs::NamingAttributes_T name

–The name of the object to which this selection applies. CTM only supports ManagedElement name in this field.

•transmissionParameters::LayerRateList_T layerRateList

–Not supported.

•PMLocationList_T pMLocationList

–Not supported.

•GranularityList_T granularityList

–Supported only for enablePMData. Valid values are 15min and 24h. If the list is empty, both 15min and 24h are considered.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised if pmTPSelectList is empty.

EXCPT_NE_COMM_LOSS

This exception is raised when communication 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

Name	Type	Input/Output	Description
pmTPSelectList	PMTPSelectList_T	In	This structure contains the relevant data for the enablePMData request. This must not be empty.
failedTPSelectList	PMTPSelectList_T	Out	List of points that were not completely enabled. An empty list indicates that the total request was successful.

For details on PMTPSelect_T structure, see the "performance::PerformanceManagementMgr_I::disablePMData" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised if pmTPSelectList is empty.

EXCPT_NE_COMM_LOSS

This exception is raised when communication 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-layerRate measurement point. This operation can be applied to a PTP or CTP. The NMS specifies the TP and layerRate, 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, a 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 CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs. This method is synchronous.

---

Parameters

Name	Type	Input/Output	Description
TpName	globaldefs::NamingAttributes_T	In	Identifies the TP for which TCA parameters values are set
TcaParameters	TCAParameters_T	In Out	Lists TCA IDs and corresponding values to be applied to a specific layer rate. The settings that are actually applied are returned in this parameter

CTM supports TCAParameters_T as follows:

•transmissionParameters::LayerRate_T layerRate

•CTM supports layerRate for the ONS 15310, ONS 15327, and ONS 15454 SONET as follows:

–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 (supported only on ONS 15454 SONET)

–LR_Section_OC1_STS1_and_RS_STM0

–LR_Section_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 (supported only on ONS 15454 SONET)

–LR_Line_OC3_STS3c_and_MS_STM1

–LR_Line_OC12_STS12c_and_MS_STM4

–LR_Line_OC48_STS48c_and_MS_STM16

–LR_Section_OC192_STS192c_and_RS_STM64 (supported only on ONS 15454 SONET)

•CTM supports layerRate for the ONS 15454 SDH as follows:

–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_STS192_and_RS_STM64

–LR_Line_OC3_STS3c_and_MS_STM1

–LR_Line_OC12_STS12c_and_MS_STM4

–LR_Line_OC48_STS48c_and_MS_STM16

–LR_Line_OC192_STS192c_and_MS_STM64

•CTM supports layerRate for the ONS 15600 SONET and ONS 15600 SDH as follows:

–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

•Granularity_T granularity

–CTM supports 15 minute and 24 hour.

•PMThresholdValueList_T tcaTypeValues

–This is a sequence of PMThresholdValue_T. It contains the PMParameterName_T pmParameterName field.

CTM R5.0 supports the NE PM values listed in Table 3-2, Table 3-3, Table 3-4, and Table 3-5.

Table 3-2 ONS 15310 and ONS 15327 pmParameterName Values 

Layer Rate	PTP or CTP	pmParameterName	Location	Interval
LR_T1_and_DS1_1_5M	PTP	PMP_CV	PML_LOC_NA	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M	PTP	PMP_CV	PML_LOC_NA	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_LSS
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	CTP	PMP_CV	PML_NEAR_END_RX	15min, 24hr
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
LR_Section_OC1_STS1_and_RS_ST_M0 LR_Section_OC3_STS3c_and_RS_STM1 LR_Section_OC12_STS12c_and_RS_STM4 LR_Section_OC48_STS48c_and_RS_STM16	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24hr
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Section_OC1_STS1_and_MS_ST_M0 LR_Line_OC3_STS3c_and_ RS_STM1 LR_Line_OC12_STS12c_and_ RS_STM4 LR_Line_OC48_STS48c_and_ RS_STM16	PTP	PMP_CV	PML_NEAR_END_Rx, PML_FAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD

Table 3-3 ONS 15454 SONET TCA TP Parameter Values 

Layer Rate	PTP or CTP	pmParameterName	Location	Interval
LR_T1_and_DS1_1_5M	PTP	PMP_CV	PML_NEAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_LSS
		PMP_ES	PML_FAR_END_Rx
LR_T3_and_DS3_45M	PTP	PMP_CV	PML_LOC_NA	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M (on the DS3XM, DS3E, and DS3NE port when supported by the NE)	PTP	PMP_CV_P	PML_NEAR_END_Rx	15min, 24hr
		PMP_ES_P
		PMP_SES_P
		PMP_SAS_P
		PMP_AISS_P
		PMP_UAS_P
		PMP_CV_CP	PML_NEAR_END_Rx, PML_FAR_END_Rx
		PMP_ES_CP
		PMP_SES_CP
		PMP_SAS_CP
		PMP_AISS_CP
		PMP_UAS_CP
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	CTP	PMP_CV	PML_NEAR_END_Rx	15min, 24hr
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
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	PTP	PMP_CV	PML_NEAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Line_OC3_STS3_and_ RS_STM1 LR_Line_OC12_STS12_and_ RS_STM4 LR_Line_OC48_STS48_and_ RS_STM16 LR_Line_OC192_STS192_and_MS_STM64	PTP	PMP_CV	PML_NEAR_END_Rx, PML_FAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC
		PMP_PSD
LR_Line_OC48_STS48_and_MS_STM16 LR_Line_OC192_STS192_and_MS_STM64 (Only for R4.0 and R4.1 transponders and muxponders)	PTP	PMP_CV	PML_NEAR_END_Rx, PML_FAR_END_Rx	15 min, 24 hr
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS

Table 3-4 ONS 15454 SDH TCA TP Parameter Values 

Layer Rate	PTP or CTP	pmParameterName	Location	Interval
LR_E1_2M	PTP	PMP_CV	PML_LOC_NA	15min, 24hr
		PMP_ES
		PMP_SES
LR_T3_and_DS3_45M, LR_E3_34M	PTP	PMP_CV	PML_LOC_NA	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M	PTP	PMP_CV_P	PML_NEAR_END_Rx	15min, 24hr
		PMP_ES_P
		PMP_SES_P
		PMP_SAS_P
		PMP_AISS_P
		PMP_UAS_P
		PMP_CV_P	PML_NEAR_END_Rx PML_FAR_END_Rx
		PMP_ES_P
		PMP_SES_P
		PMP_SAS_P
		PMP_UAS_P
LR_E1_2M (Supported only if the SNC involved is of LR_E1_2M layer rate), LR_E3_34M, LR_T3_and_DS3_45M	CTP	PMP_ES	PML_NEAR_END_Rx, PML_FAR_END_Rx	15min, 24hr
		PMP_EB
		PMP_SES
		PMP_UAS
		PMP_BBE
		PMP_UAS
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	CTP	PMP_EB	PML_NEAR_END_Rx	15min, 24hr
		PMP_BBE
		PMP_SES
		PMP_ES
		PMP_UAS
LR_Section_OC3c_STS3c_and_ RS_STM1 LR_Section_OC12c_STS12c_and_ RS_STM4 LR_Section_OC48c_STS48c_and_ RS_STM16 LR_Section_OC192c_STS192c_and_RS_STM64	PTP	PMP_UAS	PML_NEAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_BBE
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	PTP	PMP_EB	PML_NEAR_END_Rx, PML_FAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_BBE
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD
LR_Line_OC48_STS48c_and_ MS_STM16 LR_Line_OC192_STS192c_and_ MS_STM64 (Only on Transponder and MuxPonder cards for NE versions 4.0 and later)	PTP	PMP_EB	PML_NEAR_END_Rx, PML_FAR_END_Rx	15min, 24hr
		PMP_ES
		PMP_SES
		PMP_BBE
		PMP_UAS

Table 3-5 ONS 15600 SONET and ONS 15600 SDH TCA TP Parameter Values 

Layer Rate	PTP or CTP	pmParameterName	Location	Interval
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	CTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
LR_Section_OC48_STS48c_and_RS_STM16 LR_Section_OC192_STS192c_and_RS_STM64	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Line_OC48_STS48_and_MS_STM16 LR_Line_OC192_and_MS_STM64	PTP	PMP-CV	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD

•PMLocation_T pmLocation

–CTM supports PML_LOC_NA, PML_NEAR_END_Rx, and PML_FAR_END_Rx.

•PMThresholdType_T thresholdType

–CTM supports only TWM_HIGH.

•boolean triggerFlag

–Not supported.

•float value

–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.

•string unit

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception indicates a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception indicates that tpName does not reference a terminationPoint object or that at least one tcaParameters field is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception indicates that tpName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception indicates a loss of communication to the ME.

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/layerRate 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 CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
tpName	globaldefs::NamingAttributes_T	In	Identification of the TP for which the values of the TCA parameters are to be retrieved
layerRate	transmissionParameters::LayerRate_T	In	LayerRate for which the values of the TCA parameters are to be retrieved
granularity	Granularity_T	In	Granularity for which the TCA parameters are to be retrieved
tcaParameter	TCAParameters_T	Out	Result of the operation

For a list of supported layer rates and parameter values, see the "performance::PerformanceManagementMgr_I::setTCATPParameter" section

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when tpName does not reference an terminationPoint object or layerRateList contains undefined rates or Granularity contains an undefined value.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when tpName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication 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 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 (nearEnd only) 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 granularity, location and time window specified is made available.

Measurement intervals and the given time frame are considered as half-open intervals to the right, i.e. startTime <= t < endTime.

Performance monitoring data on multiple TPs of multiple MEs is transferred in one data file. PM File format has been defined by TMF. CTM creates the file under CTMSHOME/pmData/username/ directory. CTM generates the unique filename. This file is kept for six hours after CTM completes writing of the requested PM data. After six hours it is deleted. When 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 begin writing to the file. Upon successful completion, it notifies the NMS session by invoking nmsSession::NmsSession_I::historyPMDataCompleted. If for some reason CTM fails to create this file or write into the file, the NMS is notified by invoking nmsSession::NmsSession_I::historyPMDataFailed.

CTM only allows one request from each NMS session at a time.

This operation is supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs. CTM raises an EXCPT_UNABLE_TO_COMPLY exception if another request comes from a session for which on 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 adverse impact on CTM.

Parameters

Name	Type	Input/Output	Description
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 completion or failure using methods defined in the "nmsSession::NmsSession_I::historyPMDataCompleted" section, and in the "nmsSession::NmsSession_I::historyPMDataFailed" section.
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 are contained in the file. An empty list means to store all supported parameters. The returned parameters are best effort, i.e., among the parameters specified, only the subset of supported parameters is 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 provides the following support for the PMTPSelect_T structure for this method:

•globaldefs::NamingAttributes_T name

–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.

•transmissionParameters::LayerRateList_T layerRateList

•CTM supports layerRate for the ONS 15310, ONS 15327, and ONS 15454 as follows:

–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 (supported 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 (supported only on ONS 15454 SONET)

–LR_Line_OC3_STS3c_and_MS_STM1

–LR_Line_OC12_STS12c_and_MS_STM4

–LR_Line_OC48_STS48c_and_MS_STM16

–LR_Line_OC192_STS192c_and_RS_STM64 (supported only on ONS 15454 SONET)

•CTM supports layerRate for the ONS 15454 SDH as follows:

–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_STS3c_and_MS_STM1

–LR_Line_OC12_STS12c_and_MS_STM4

–LR_Line_OC48_STS48c_and_MS_STM16

–LR_Line_OC192_STS192c_and_MS_STM64

•CTM supports layerRate for the ONS 15600 SONET and ONS 15600 SDH as follows:

–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_STS48c_and_ MS_STM16

–LR_Line_OC192_STS192c_and_ MS_STM64

•PMLocationList_T pMLocationList

–CTM supports PML_LOC_NA, PML_NEAR_END_Rx, and PML_FAR_END_Rx.

•GranularityList_T granularityList

–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-6, Table 3-7, Table 3-8, Table 3-9, and Table 3-10.

Table 3-6 ONS 15310 CL pmParameter Values 

LayerRate	PTP or CTP	pmParameterName	Location	Interval
LR_T1_and_DS1_1_5M	PTP	PMP_CV	PML_LOC_NA	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M	PTP	PMP_CV	PML_LOC_NA	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
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	CTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
LR_Section_OC3_STS3c_and_ RS_STM1 LR_Section_OC12_STS12c_and_ RS_STM4	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Line_OC3_STS3c_and_ MS_STM1 LR_Line_OC12_STS12c_and_ MS_STM4	PTP	PMP_CV	PML_NEAR_END_Rx, PML_FAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PSC_W
		PMP_PSD_W
		PMP_PSC_S
		PMP_PSD_S
		PMP_PSC_R
		PMP_PSD_R

.

Table 3-7 ONS 15327 pmParameter Values 

LayerRate	PTP or CTP	pmParameterName	Location	Interval
LR_T1_and_DS1_1_5M	PTP	PMP_CV	PML_LOC_NA	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M	PTP	PMP_CV	PML_LOC_NA	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
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	CTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PJ_DIFF
		PMP_PJP_SEC
		PMP_PJN_SEC
LR_Section_OC3_STS3c_and_ RS_STM1 LR_Section_OC12_STS12c_and_ RS_STM4 LR_Section_OC48_STS48c_and_ RS_STM16	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Line_OC3_STS3c_and_ MS_STM1 LR_Line_OC12_STS12c_and_ MS_STM4 LR_Line_OC48_STS48c_and_ MS_STM16	PTP	PMP_CV	PML_NEAR_END_Rx, PML_FAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PSC_W
		PMP_PSD_W
		PMP_PSC_S
		PMP_PSD_S
		PMP_PSC_R
		PMP_PSD_R

Table 3-8 ONS 15454 SONET pmParameter Values 

LayerRate	PTP or CTP	pmParameterName	Location	Interval
LR_T1_and_DS1_1_5M	PTP	PMP_CV	PML_NEAR_END_Rx, PML_FAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
		PMP_ES	PML_FAR_END_Rx
LR_T3_and_DS3_45M	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M (on DS3XM, DS3E, DS3NE port when supported by NE)	CTP	PMP_CV_P	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES_P
		PMP_SES_P
		PMP_SAS_P
		PMP_AISS_P
		PMP_UAS_P
		PMP_CV_P	PML_NEAR_END_Rx, PML_FAR_END_Rx
		PMP_ES_P
		PMP_SES_P
		PMP_SAS_P
		PMP_AISS_P
		PMP_UAS_P
LR_T3_DS3_45M LR_STS1_and_AU3_high_Order_VC3 LR_STS3c_and_AU4_VC4 LR_STS12c_andVC4_4c LR_STS6c_andVC4_2c LR_STS9c_andVC4_3c LR_STS24c_andVC4_8c LR_STS48c_andVC4_16c LR_STS192c_andVC4_64c	CTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PJ_DIFF
		PMP_PJNP_SEC
		PMP_PJN_SEC
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	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Section_OC3_STS3c_and_MS_STM1 LR_Section_OC12_STS12c_and_MS_STM4 LR_Section_OC48_STS48c_and_MS_STM16 LR_Section_OC192_STS192c_and_MS_STM64	PTP	PMP_CV	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PSC_W
		PMP_PSD_W
		PMP_PSC_S
		PMP_PSD_S
		PMP_PSC_R
		PMP_PSC_R

Table 3-9 ONS 15454 SDH pmParameter Values 

LayerRate	PTP or CTP	pmParameterName	Location	Interval
LR_E1_2M	PTP	PMP_CV	PML_LOC_NA	15 min, 24 hour
		PMP_ES
		PMP_SES
LR_T3_and_DS3_45M LR_E3_34M	PTP	PMP_CV	PML_LOC_NA	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_LSS
LR_T3_and_DS3_45M	PTP	PMP_CV_P	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES_P
		PMP_SES_P
		PMP_SAS_P
		PMP_AISS_P
		PMP_UAS_P
		PMP_CV_CP
		PMP_ES_CP
		PMP_SES_CP
		PMP_SAS_CP
		PMP_UAS_CP
LR_E1_2M LR_E3_34M LR_T3_and_DS3_45M	CTP	PMP_EB	PML_NEAR_END_Rx, PML_FAR_END_Rx	15 min, 24 hour
		PMP_BBE
		PMP_SES
		PMP_ES
		PMP_UAS
		PMP_ESR
		PMP_SESR
		PMP_BBER
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	CTP	PMP_EB	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_BBE
		PMP_SES
		PMP_ES
		PMP_UAS
		PMP_ESR
		PMP_SESR
		PMP_BBER
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PJ_DIFF
		PMP_PJP_SEC
		PMP_PJN_SEC
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	PTP	PMP_EB	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_BBE
		PMP_SES
		PMP_ES
		PMP_UAS
		PMP_ESR
		PMP_SESR
		PMP_BBER
LR_Line_OC3_STS3c_and_ MS_STM1 LR_Line_OC12_STS12c_and_ MS_STM4 LR_Line_OC48_STS48c_and_ MS_STM16 LR_Line_OC192_STS192c_and_ MS_STM64	PTP	PMP_EB	PML_NEAR_END_Rx, PML_FAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_BBE
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
		PMP_PSC_W
		PMP_PSD_W
		PMP_PSC_S
		PMP_PSD_S
		PMP_PSC_R
		PMP_PSD_R
		PMP_ESR
		PMP_SESR
		PMP_BBER

Table 3-10 ONS 15600 SONET and ONS 15600 SDH pmParameter Values 

LayerRate	PTP or CTP	pmParameterName	Location	Interval
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	CTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_FC
		PMP_SES
		PMP_ES
		PMP_UAS
		PMP_PPJ
		PMP_NPJ
		PMP_PPJC_PGEN
		PMP_NPJC_PGEN
LR_Section_OC48_STS48c_and_ MS_STM16 LR_Section_OC192_STS192c_and_ MS_STM64	PTP	PMP_CV	PML_NEAR_END_Rx	15 min, 24 hour
		PMP_ES
		PMP_SES
		PMP_SEFS
LR_Line_OC48_STS48c_and_ MS_STM16 LR_Line_OC192_STS192c_and_ MS_STM64	PTP	PMP_CV	PML_NEAR_END_Rx PML_FAR_END_Rx
		PMP_ES
		PMP_SES
		PMP_FC
		PMP_UAS
		PMP_PSC	PML_NEAR_END_Rx
		PMP_PSD

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when startTime or endTime are not valid or client is null or pmTPSelectList is empty.

EXCPT_UNABLE_TO_COMPY

This exception is raised when more than one requests is sent from same NMS client.

Compliance

CTM-defined.

3.10.6  performance::PerformanceManagementMgr_I::
deleteHistoryPMDataFile

Synopsis

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

Name	Type	Input/Output	Description
fileName	string	In	Name of the file that was created by CTM in response to the getCTMHistoryPMData call made by the NMS. This name must be the absolute path on CTM server.

Throws

globaldefs::ProcessingFailureException 

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific 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

The NMS can 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 (15min, 24hr, N/A) and location (nearEnd, farEnd, and/or bidirectional) can be specified. The operation mode is best effort. CTM only supports 24 buckets (6 hours) in 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 CTM supports this operation for ONS 15302, ONS 15305, ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

---

For a list of supported layer rates and PM parameters, with the exception of ONS 15302 and 15305, see the "performance::PerformanceManagementMgr_I::getCTMHistoryPMData" section. The list for ONS15302 and 15305 is given below in this section.

Parameters

Name	Type	Input/Output	Description
pmTPSelectList	PMTPSelectList_T	In	Specifies which history PM data to return. This list cannot be empty.
pmParameters	PMParameterNameList_T	In	Specifies which PM parameters within the scope of the pmTPSelectList are contained in the file. An empty list means to store all supported parameters. The returned parameters are best effort.
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).
how_many	unsigned long	In	Maximum number of PM data to be returned in the first batch.
pmDataList	PMDataList_T	Out	The first batch of PM data.
pmIt	PMDataIterator	Out	The iterator used to retrieve the remaining PM data.

CTM provides the following support for the PMData structure for this method:

•globaldefs::NamingAttributes_T tpname

–The name of the TP.

•transmissionParameters::LayerRate_T layerRate:

–Layer of the collected PM data. CTM supports the following layer rates for ONS 15302 and ONS 15305 (see the "performance::PerformanceManagementMgr_I::getCTMHistoryPMData" section for the list that applies to other supported NEs):

–ONS 15302: LR_Line_OC3_STS3_and_MS_STM1, LR_Section_OC3_STS3_and_RS_STM1, LR_STS3c_and_AU4_VC4, and LR_VT2_and_TU12_VC12

–ONS 15305: 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, and LR_VT2_and_TU12_VC12

•Granularity_T granularity:

–Identifies whether this is 15min or 24h data. Only 15min is supported.

CTM supports the pmParamater values listed in Table 3-11 and Table 3-12.

Table 3-11 ONS 15302 pmParameter Values 

ONS 15302 Layer Rate	pmParameterName	Location	Interval
LR_Line_OC3_STS3_and_MS_STM1	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min
LR_Section_OC3_STS3_and_RS_STM1	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx	15 min
LR_STS3c_and_AU4_VC4	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min
LR_VT2_and_TY12_VC12	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min

Table 3-12 ONS 15305 pmParameter Values 

ONS 15305 Layer Rates	pmParameterName	Location	Interval
LR_Line_OC12_STS12_and_MS_STM4	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min 1 day
LR_Line_OC3_STS3_and_MS_STM1	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min 1 day
LR_Line_OC48_STS48_and_MS_STM16	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min 1 day
LR_Low_Order_TU3_VC3	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min 1 day
LR_Section_OC12_STS12_and_RS_STM4	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx	15 min 1 day
LR_Section_OC3_STS3_and_RS_STM1	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx	15 min 1 day
LR_Section_OC48_STS48_and_RS_STM16	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx	15 min 1 day
LR_STS3c_and_AU4_VC4	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min 1 day
LR_VT2_and_TU12_VC12	PMP_BBE PMP_ES PMP_SES PMP_UAS	PML_NEAR_END_Rx PML_FAR_END_Rx	15 min 1 day

•globaldefs::Time_T retrievalTime

–ME time at which PM measurement was obtained from the ME.

•PMMeasurementList_T pmMeasurementList

–PM values.

CTM support for PMData structure is described in the following list:

•PMParameterName_T pmParameterName

–The name of the PM Measure.

•PMLocation_T pmLocation

–CTM supports PML_LOC_NA, PML_NEAR_END_Rx, and PML_FAR_END_Rx

•float value

–Value of parameter.

•string unit

–Not supported.

•string intervalStatus

–Not supported.

CTM supports the following string values:

•Valid—The PM data value is valid.

•Invalid—The PM data value is not valid or not available.

Throws

EXCPT_NOT_IMPLEMENTED

This exception is raised when NMS queries history data older than 6 hours for 15-minute buckets or 24-hour PM.

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when input parameter is not well-formed.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

Compliance

CTM-defined.

3.10.8  performance::PerformanceManagementMgr_I::getHoldingTime

Synopsis

void getHoldingTime(out HoldingTime_T holdingTime)

	raises(globaldefs::ProcessingFailureException);

Description

CTM is requested to tell the NMS how many hours the PM data records (24hr/15min) are held in CTM. This is the minimum time. If CTM does not store PM data, it is the time supported in the NE (minimum time of all managed NEs).

CTM provides users the option to configure the holdingTime. CTM supports this operation for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

Parameters

Name	Type	Input/Output	Description
holdingTime	HoldingTime_T	Out	Contains the time period in hours within which 24-hour and 15-minute PM data records can be retrieved.

CTM provides the following support for the HoldingTime_T structure for this method:

•short storeTime24hr:

–Minimum store time in hours for 24h data. CTM reports 0 if the PM data holding is forever.

•Short storeTime15min:

–Minimum store time in hours for 15min data. CTM reports 0 if the PM data holding is forever.

Throws

globaldefs::ProcessingFailureException 

EXCPT_NOT_IMPLEMENTED

This exception is raised if CTM is unable to support this service.

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

XCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

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 allows CTM 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 (15min, 24hr, NA) 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 the "performance::PerformanceManagementMgr_I::getCTMHistoryPMData" section.

CTM supports this operation for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH NEs R4.0 and above.

Parameters

Name	Type	Input/Output	Description
pmTPSelectList	PMTPSelectList_T	In	This parameter specifies which real time 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, meaning among the parameters specified, only the subset of supported parameters are stored.
how_many	unsigned long	In	Maximum number of PM data to be returned in the first batch.
pmDataList	PMDataList_T	Out	First batch of PM data.
pmIt	PMDataIterator_I	Out	Iterator used to retrieve the remaining PM data.

For information about PMData_T structure, see the "performance::PerformanceManagementMgr_I::getCTMHistoryPMData" section.

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 nonspecific 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 the 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 the "emsSession::EmsSession_I" section. This interface is inherited from the "common::Common_I" section.

interface ProtectionMgr_I:common::Common_I

It also implements the getCapabilities method. Operations described in the following subsections are returned to NMS when it invokes getCapabilities.

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 SONET, and ONS 15600 SDH NEs.

Parameters

Name	Type	Input/Output	Description
pgName	globaldefs::NamingAttributes_T	In	Name of the protection group.
how_many	unsigned long	In	Maximum number of TPs to be returned in the first batch.
nameList	globaldefs::NamingAttributesList_T	Out	The first batch of TPs that can carry protected traffic. Both protected and protecting PTPs are reported.
nameIt	globaldefs::NamingAttributesIterator_I	Out	The iterator used to retrieve the remaining PTPs that can carry protected traffic.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when pgName does not reference a protectionGroup object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when pgName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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:

•PGT_MSP_1_FOR_N: "slot n (Equipment Native Name)," n represents the slot number of the protecting equipment. For example, "slot 3 (DS3XM)."

•PGT_MSP_1_PLUS_1: "slot n (Equipment Native Name), port m," n represents the slot number and m represents the protecting port number. For example, "slot 5 (OC3), port 1."

•PGT_2_FIBER_BLSR—No defaults; name is the user-defined ring ID ranging from "1" to "9999." Ring Name is used instead of Ring ID in this release.

•PGT_4_FIBER_BLSR—No defaults; name is the user-specified ring ID ranging from "1" to `9999." Ring Name is used instead of Ring ID in this release.

If the PGP configuration is 4 fiber BLSR, there are 3 protection groups reported for this configuration, 2 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 ONA 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

Parameters

Name	Type	Input/Output	Description
meName	Globaldefs::NamingAttributes_T	In	The name of the ME for which the request is made
how_many	unsigned long	In	Maximum number of protection groups to report in the first batch
pgList	ProtectionGroupList_T	Out	First batch of protection groups
PgIt	ProtectionGroupIterator_I	Out	Iterator used to access the remaining protection groups (PGs), if any

•globaldefs::NamingAttributes_T name

–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.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported. Name is reported by the NE, it is Ring Id in case of 2_FIBER_BLSR and 4_FIBER_BLSR. It is <Ring Id>-EAST or <Ring Id>-WEST for the 2 component groups of 4 Fiber BLSR PGP. Ring Name is used instead of Ring ID in this release.

•string owner

–Not supported.

•ProtectionGroupType_T protectionGroupType

–Supported.

•ProtectionSchemeState_T protectionSchemeState

–Not supported.

•ReversionMode_T reversionMode

–Supported.

•transmissionParameters::LayerRate_T rate

–Line rate of the PTPs of the protection group.

•globaldefs::NamingAttributesList_T pgpTPList

–Supported.

•globaldefs::NVSList_T pgpParameters

–CTM only supports wtrTime. wtrTime is measured in seconds.

• globaldefs::NVSList_T additionalInfo

– CTM supports BIDIRECTIONAL for 1_PLUS_1 protection group. The values are true and false.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when meName does not reference a managedElement object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when meName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) has been reached.

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.

This operation is only supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

Parameters

Name	Type	Input/Output	Description
pgName	globaldefs::NamingAttributes_T	In	The name of the protection group that the client is interested in
protectiongroup	ProtectionGroup_T	Out	The returned protection group

CTM provides the following support for the ProtectionGroup_T structure:

•globaldefs::NamingAttributes_T name

–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.

•string userLabel

–Not supported.

•string nativeEMSName

–Supported. Name is reported by the NE, it is Ring Id in case of 2_FIBER_BLSR and 4_FIBER_BLSR. It is <Ring Id>-EAST or <Ring Id>-WEST for the 2 component groups of 4 Fiber BLSR PGP.

•string owner

–Not supported.

•ProtectionGroupType_T protectionGroupType

–Supported.

•ProtectionSchemeState_T protectionSchemeState

–Not supported.

•ReversionMode_T reversionMode

–Supported.

•transmissionParameters::LayerRate_T rate

–Line rate of the PTPs of the protection group.

•globaldefs::NamingAttributesList_T pgpTPList

–Supported.

•globaldefs::NVSList_T pgpParameters

–CTM only supports wtrTime. wtrTime is measured in seconds.

• globaldefs::NVSList_T additionalInfo

CTM supports BIDIRECTIONAL for 1_PLUS_1 protection group. The values are true and false.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when protectionGroupName does not reference a protectionGroup.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when meName references an object that does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication 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.

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.

This operation is only supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH. CTM validates whether fromTp and toTp are part of same protection group or not. If this validation fails then it throws ProcessingFailureException with EXCPT_INVALID_INPUT. CTM always performs the command on the fromTp in case of PC_LOCKOUT and PC_EXERCISE, CTM also verifies if it is possible to perform the command, otherwise, it throws EXCPT_UNABLE_TO_COMPLY. For details on how protection groups are supported, refer to the list of documentation in the preface of this manual.

Table 3-13 Protection Command Protection Groups 

Protection Group	ProtectionCommand Supported by CTM
PGT_2_FIBER_BLSR	PC_CLEAR PC_LOCKOUT PC_FORCED_SWITCH PC_MANUAL_SWITCH PC_EXERCISE
PGT_4_FIBER_BLSR	PC_CLEAR PC_LOCKOUT PC_FORCED_SWITCH PC_MANUAL_SWITCH PC_EXERCISE
PGT_MSP_1_PLUS_1	PC_CLEAR PC_LOCKOUT, PC_FORCED_SWITCH PC_MANUAL_SWITCH
PGT_MSP_1_FOR_N	PC_CLEAR PC_LOCKOUT PC_FORCED_SWITCH PC_MANUAL_SWITCH

Parameters

Name	Type	Input/Output	Description
protectionCommand	ProtectionCommand_T	In	The command to be performed
reliableSinkCtpOrGroupName	globaldefs::NamingAttributes_T	In	CTM only supports Protection group name
fromTp	globaldefs::NamingAttributes_T	In	The present source of the traffic
toTp	globaldefs::NamingAttributes_T	In	The requested source of the traffic after the command
switchData	SwitchData_T	Out	The protection switch status of the toTp provided after the execution of the command

CTM provides the following support for the ProtectionGroup_T structure:

•ProtectionType_T protectionType

–Supported. CTM always reports PT_SNCP.

•SwitchReason_T switchReason

–Supported. CTM always reports SR_MANUAL.

•transmissionParameters::LayerRate_T layerRate

–The layer that this switch is relevant to.

•globaldefs::NamingAttributes_T groupName

–Identifies the protectionGroup for which protection switch status is being reported.

•globaldefs::NamingAttributes_T protectedTP

–This is the TP that is protected.

–For a 2F BLSR, this is from the TP.

–For a 1:N MSP, this is always the working TP.

–For a 1+1 MSP, this is always the working TP.

–For a 4F BLSR, this is the working TP.

•globaldefs::NamingAttributes_T switchToTP

–toTp is reported by CTM.

•globaldefs::NVSList_T additionalInfo

–Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when reliableSinkCtpOrGroupName, fromTp, or toTp references objects that are of the correct type, but are invalid in the context of this operation.

EXCPT_ENTITY_NOT_FOUND

This exception is 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

This exception is raised if the EMS is unable to perform the operation.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to the ME 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 allows 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 a ObjectCreationEvent on successful creation of the Protection Group.

This operation is only supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs. CTM only supports the creation of 1_PLUS_1 protection groups.

Name	Type	Input/Output	Description
pgCreateData	PGPCreateData_T	In	The data that describes the protection group to create
createdPGP	ProtectionGroup_T	In	The resulting created protection group

Parameters

CTM provides the following support for the PGPCreateData_T structure:

•globaldefs::NamingAttributes_T pgpName

–Supported. The NMS is responsible for guaranteeing the uniqueness of the name.

•string userLabel

–Not supported.

•boolean forceUniqueness

–Not supported.

•string owner

–Not supported.

•ProtectionGroupType_T createdPGPType

–Supported.

•ReversionMode_T reversionMode

–Supported.

•globaldefs::NamingAttributes_T workingEquipmentOrTPName

–Supported.

•globaldefs::NamingAttributes_T protectingEquipmentOrTPName

–Supported.

•globaldefs::NVSList_T pgpParameters

–Only supports wtrTime.

•globaldefs::NVSList_T additionalInfo

–Only supports BIDIRECTIONAL for 1_PLUS_1 protection group creation.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific 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 reliableSinkCtpOrGroupName, fromTp, or toTp references objects that are of the correct type, but are invalid in the context of this operation.

EXCPT_ENTITY_NOT_FOUND

This exception is 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

This exception is raised if the EMS is unable to perform the operation.

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 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH.

Name	Type	Input/Output	Description
pgpName	globaldefs::NamingAttributes_T	In	The name of the protection group to delete

Parameters

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific 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 reliableSinkCtpOrGroupName, fromTp, or toTp references objects that are of the correct type, but are invalid in the context of this operation.

EXCPT_ENTITY_NOT_FOUND

This exception is 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

This exception is raised if the EMS is unable to perform the operation.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to the ME 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 interface is only supported for ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH NEs.

Name	Type	Input/Output	Description
ptpName	globaldefs::NamingAttributes_T	In	The name of the PTP whose association to any protection group is to be verified.
protectiongroup	ProtectionGroup_T	Out	The returned protection group.

Parameters

For information about ProtectionGroup_T, see the "protection::ProtectionMgr_I::getAllProtectionGroups" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when ptpName does not reference a PTP.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when PTP name reference object does not exist.

EXCPT_NE_COMM_LOSS

This exception is raised when communication to the ME is lost.

Compliance

CTM-defined.

3.12  session::Session_I

This interface provides capabilities to manage the client-server connection. Its main purpose is to enable the client or server to detect a loss of communication with the associated party. For a single communication session between an NMS and an EMS, there are two Session_I objects. One object is maintained on the NMS; the other is maintained on the EMS. The Session_I object maintained on the EMS is an EmsSession_I, while the Session_I object maintained on the NMS is an NmsSession_I. Both objects inherit from Session_I.

Each Session_I object pings the other Session_I object periodically to detect communication failures. CTM invokes this method on NmsSession_I once every five minutes. If the call raises an exception, CTM assumes that the session is no longer connected and deletes all allocated resources.

Attributes

readonly attribute Session_I associatedSession;

This attribute contains a reference to the Session_I on the other side (NMS or EMS) to which the object is associated. This attribute verifies whether or not the NmsSession_I/EmsSession_I association is still valid (especially in the case of communication failures).

3.12.1  session::Session_I::endSession

Synopsis

oneway void endSession();

Description

This operation provides a controlled disconnect between parties and deletes all resources allocated for the session.

Parameters

None.

Throws

None.

Compliance

TMF-defined.

3.12.2  session::Session_I::ping

Synopsis

void ping();

Description

This operation detects a loss of communication. CTM pings the NMS once 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 return string has the following format:

Release.Major[.Minor]

where Release, Major, and Minor are strings that contain only digits.

For example:

•2.1 indicates release 2, major release 1

•1.3 indicates release 1, major release 3

---

Note x.y has the same meaning as x.y.0. The minor digit is used for bug fixes to the major release. For example, 1.2.1 is a minor release of 1.2. Any changes to IDL files must be approved by the Specification Authority. For TMF 814 version 2.0, the version is 2.0.

---

Parameters

None.

Return Value

string

Throws

None.

Compliance

TMF-defined.

3.14  L2 Topology and MLVLAN for ML-Series Ethernet Cards

CTM R5.0 supports L2 topology and MLVLAN operations for the ML-series Ethernet cards in ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs. You can create MLVLAN in an L2 topology. An L2 topology has a collection of MLVLANs and underlying subnetwork connections to support the traffic at the optical layer. CTM R5.0 supports L2 service interfaces for ONS 15454 SONET and ONS 15454 SDH version 4.1 and later.

Figure 3-4 show the relationship diagram for various L2 service objects.

Figure 3-4 L2 Service Object Relationship Diagram

3.14.1  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN

Synopsis

void createMLVLAN(in globaldefs::NamingAttributes_T l2TopologyName,

in multiLayerSubnetwork::MLVLANCreateData_T mlVlanCreateData,

out multiLayerSubnetwork::MLVLAN_T mlVlan)

raises(globaldefs::ProcessingFailureException);

Description

This interface creates a new MLVLAN for a given L2 topology. An ObjectCreationEvent is generated when an MLVLAN is successfully created. CTM R5.0 supports a maximum of 4095 MLVLANs for an L2 topology.

---

Note CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/ Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	The L2 topology name in which this MLVLAN is created.
mlVlanCreateData	multiLayerSubnetwork::MLVLANCreateData_T	In	The createData for the MLVLAN to be created.
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	The MLVLAN object created by CTM.

CTM supports the following for the MLVLANCreateData_T structure:

•int mlVlanId

–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.

•string userLabel

–Not supported.

•boolean forceUniqueness

–Supported, CTM will always enforce uniqueness of MLVLAN ID.

•string owner

–Not supported.

•multilayersubnetwork::MLVLANTPDataList_T tpList

–Supported. A list of front Ethernet ports associated with the MLVLAN. Each MLVLANTPData_T structure has following members:

•globaldefs::NamingAttributes_T tpName

Specifies the front Ethernet port name.

• MultiLayerSubnetwork::L2PortType_T portType

Specifies the port type to be configured. CTM supports the following port types:

L2PortType_T.L2PT_UNI

L2PortType_T.L2PT_NNI

•MultiLayerSubnetwork::L2ConnectionType_T connectionType

Specifies the connection type to be configured for a specified port type. If the port type is L2PortType_T.UNI, then the following connection types are supported:

L2ConnectionType_T.L2CT_QINQ

L2ConnectionType_T.L2CT_DOT1Q

L2ConnectionType_T.L2CT_UNTAGGED

If the port type is L2PortType_T.L2PT_NNI, then only the L2ConnectionType_T.L2CT_DOT1Q connection type is supported.

•MultiLayerSubnetwork::L2PortState_T portState

NMS can service enable or disable a port. CTM support two port states:

L2PortState_T.L2PS_ENABLE

L2PortState_T.L2PS_DISABLE

•MultiLayerSubnetwork::QoSPolicyData_T qosPolicyData

CTM R5.0 support for the QoSPolicyData_T structure is described in the "emsMgr::EMSMgr_I::getAllQoSTemplates" section.

•int portVlan

–The user VLAN ID to be associated with this MLVLAN. If the connection type is L2ConnectionType_T.L2CT_DOT1Q, then the valid port VLAN range is 1-4096. If the connection type is L2ConnectionType_T.L2CT_UNTAGGED, then the port VLAN will be ignored.

•globaldefs::NVSList_T additionalInfo

–Supported. Customer ID and Service ID can be specified.

CTM support for MLVLAN_T structure is described as follows:

•globaldefs::NamingAttributes_T name

–Supported. This field contains three tuples. The first tuple contains a value for EMS. The second tuple contains the L2 topology name. The third tuple contains the MLVLAN ID, which is the same as nativeEMSName.

•string userLabel

–Not supported.

• string nativeEMSName

–Supported. The MLVLAN ID is reported.

•string owner

–Not supported.

•multilayersubnetwork::MLVLANTPDataList_T tpList

–Supported. Specifies the list of all front Ethernet ports and associated service type. If the port type cannot be determined, CTM represents it as L2PortType_T.L2PT_UNKNOWN. If the connection type for an MLVLAN on a port cannot be determined, CTM represents the connection type as L2ConnectionType_T.L2CT_UNKNOWN.

•mulitLayerSubnetwork::MLVLANState_T vlanState

–Supported. Valid values are MLVLANState_T.COMPLETE and MLVLANState_T.INCOMPLETE. A state change event is generated if the vlanState changes.

•globaldefs::NVSList_T additionalInfo

–Supported. Customer ID and Service ID are reported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in case of nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when:

•The L2 topology name does not reference an L2 topology object.

•MLVLAN name does not follow the naming convention.

•QoS policy is specified incorrectly.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when an L2 topology name references an L2 topology object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the MLVLAN cannot be created because only a maximum of 4095 MLVLAN IDs for an L2 topology is allowed.

Compliance

CTM-defined.

3.14.2  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANAddFrontPorts

Synopsis

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 an 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 re-query the MLVLAN information to obtain the new set of parameters associated with the MLVLAN.

---

Note CTM supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	The mlVlan name in which this MLVLAN is created.
tpList	multiLayerSubnetwork::MLVLANTPDataList_T	In	The list of front ports to be included for the specified MLVLAN
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	MLVLAN object returned after modification.

For information about MLVLAN_T, MLVLANTPData_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object or when one or more PTPs in the PTP list do not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist or when one or more PTPs in the PTP list do not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the MLVLAN cannot be modified.

Compliance

CTM-defined.

3.14.3  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANDropFrontPorts

Synopsis

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 to 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 an updated MLVLAN_T structure information. If removal of any front ports associated to 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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	The mlVlan name in which this MLVLAN is created.
tpList	globaldefs::NamingAttributesList_T	In	List of front PTP names that needs to be dropped from the specified MLVLAN.
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	MLVLAN object returned after modification.

For information about MLVLAN_T, MLVLANTPData_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object or when one or more PTPs in the PTP list do not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist or when one or more PTPs in the PTP list do not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the MLVLAN cannot be modified.

Compliance

CTM-defined.

3.14.4  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANPortState

Synopsis

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 an updated MLVLAN_T structure information. If modification of any of the MLVLAN port state 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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	The mlVlan name in which this MLVLAN is created.
tpPortStateList	multiLayerSubnetwork::MLVLANTPPortStateList_T	In	The list of front ports on which the port state needs to be modified for the specified MLVLAN.
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	MLVLAN object returned after modification.

For information about MLVLAN_T, MLVLANTPData_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

CTM supports the following for the MLVLANTPPortState_T structure:

•globaldefs::NamingAttributes_T tpName

–The front Ethernet port name that is used by this MLVLAN.

•L2PortState_T portState

–The portState is applicable only to the specified MLVLAN.

•The supported states are:

–L2PortState_T.L2PS_ENABLE

–L2PortState_T.L2PS_DISABLE.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object or when one or more PTPs in the PTP list do not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist or when one or more PTPs in the PTP list do not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the MLVLAN cannot be modified.

Compliance

CTM-defined.

3.14.5  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 an updated MLVLAN_T structure. Modification of the QOS policy is done on a best effort basis. If modification of any 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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	The mlVlan name in which this MLVLAN is created.
tpqosPolicyList	multiLayerSubnetwork::MVLANTPQOSPolicyList_T	In	The new set of QOSPolicy_T to be set on the specified MLVLAN TPs.
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	MLVLAN TP object returned after modification.

For information about MLVLAN_T and QOSPolicy_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

CTM supports the following for the MLVLANTPQOSPolicy_T structure:

•globaldefs::NamingAttributes_T tpName

–The front Ethernet port name that is used by the MLVLAN for which the QoS policy is to be modified.

•QOSPolicy_TqosPolicy

–The QOS policy; applicable only to the specified MLVLAN.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when:

•The mlVlan is not in the correct format

•The tpQosPolicyList contains the same TP more than once or is not in the correct format for the TP or QOS Policy

•The tpQosPolicyList contains TPs that do not reference valid objects.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when:

•The mlVlanName passed does not reference an MLVLAN object

•The tpQosPolicyList contains TPs that do not reference valid objects

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the QOS Policy cannot be modified.

Compliance

CTM-defined.

3.14.6  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANCustomerIDServiceID

Synopsis

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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	The mlVlan name in which this MLVLAN is created.
ids	globaldefs::NVSList_T	In	Name and Value String.The name string is "CustomerID" and/or "ServiceID," and the value string is the new CustomerID or ServiceID.
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	MLVLAN object returned after modification.

For information about MLVLAN_T, MLVLANTPData_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when an L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the MLVLAN cannot be modified.

Compliance

CTM-defined.

3.14.7  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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	The mlVlan name in which this MLVLAN is created.
mlVlan	MultiLayerSubnetwork::MLVLAN_T	Out	MLVLAN object returned after modification.

For information about MLVLAN_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when MLVLAN name is not valid.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when MLVLAN name does not exist on the L2 topology.

Compliance

CTM-defined.

3.14.8  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 a ObjectDeletionEvent when the MLVLAN is successfully deleted.

---

Note CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
mlVlanName	mlVlan:MLVLAN_T	In	The MLVLAN name to be deleted.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when an MLVLAN name does not reference an MLVLAN object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when mlVlanName references an MLVLAN object that does not exist.

EXCPT_UNABLE_TO_COMPLY

This exception is raised when the MLVLAN deletion fails.

Compliance

CTM-defined.

3.14.9  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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	L2 topology name for which all the MLVLANs are to be obtained
how_many	unsigned long	In	Maximum number of MLVLANs to be returned in the first batch
mlVlanList	MLVLANList_T	Out	List of available MLVLAN names in the L2 topology
mlVlanIt	MultiLayerSubnetwork::MLVLANIterator_I	Out	Iterator used to retrieve the remaining MLVLAN names

For information about MLVLAN_T structures, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators that the EMS can support has been reached.

Compliance

CTM-defined.

3.14.10  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

Reports list of all MLVLAN names for the L2 topology.

---

Note CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	L2 topology name for which all the MLVLANs are to be obtained
how_many	unsigned long	In	Maximum number of MLVLAN to be returned in the first batch
nameList	globaldefs::NamingAttributesList_T	Out	List of available MLVLAN names in this L2 topology
nameIt	globaldefs::NamingAttributesIterator_I	Out	Iterator used to retrieve the remaining MLVLAN names

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators that the EMS can support has been reached.

Compliance

CTM-defined.

3.14.11  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAssociatedSNCs

Synopsis

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 CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	The L2 topology name for which all the SNCs are to be obtained.
how_many	unsigned long	In	Maximum number of SNCs to be returned in the first batch.
sncList	subnetworkConnection::SubnetworkConnectionList_T	Out	The first batch of SNCs.
sncIt	subnetworkConnection::SNCIterator_I	Out	The iterator to retrieve the remaining SNCs.
vcatList	subnetworkConnection::VCATList_T	Out	First batch of VCAT SNCs.
vcatIt	subnetworkConnection::VCATIterator_I	Out	Iterator to retrieve the remaining VCAT SNCs.

For information about SubnetworkConnection_T structure, see the "managedElementManager::ManagedElementManager_I::getAllSNCs" section.

For more information about VCAT_T structure, see the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

EXCPT_TOO_MANY_OPEN_ITERATORS

This exception is raised when the maximum number of iterators (128) that the EMS can support has been reached.

Compliance

CTM-defined.

3.14.12  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

Name	Type	Input/Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	The name of the L2 topology to retrieve.
l2Topo	multiLayerSubnetwork::L2Topology_T	Out	The retrieved L2 topology.

For information about L2Topology_T structure, see the "emsMgr::EMSMgr_I::getAllL2Topologies" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

Compliance

CTM-defined.

3.14.13  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForSNC

Synopsis

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 of the L2 topologies in the EMS.

Parameters

Name	Type	Input/Output	Description
sncName	globaldefs::NamingAttributes_T	In	Name of the SNC to retrieve the associated L2 topology
l2Topo	multiLayerSubnetwork::L2Topology_T	Out	The retrieved L2 topology

For information about L2Topology_T structure, see the "emsMgr::EMSMgr_I::getAllL2Topologies" section.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the sncName does not reference a SubnetworkConnetion object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the sncName references a SubnetworkConnection object that does not exist.

Compliance

CTM-defined.

3.14.14  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForMLVLAN

Synopsis

void getAssociatedL2TopologyForMLVLAN(

		in globaldefs::NamingAttributes_T mlVlanName,

		out multiLayerSubnetwork::L2Topology_T l2Topo)

		raises(globaldefs::ProcessingFailureException);

Description

This interface 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

Name	Type	Input/Output	Description
mlVlanName	globaldefs::NamingAttributes_T	In	Name of the MLVLAN to retrieve containing the L2 topology
l2Topo	multiLayerSubnetwork::L2Topology_T	Out	The retrieved L2 topology

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the mlVlanName does not reference an MLVLAN object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the mlVlanName references an MLVLAN object that does not exist.

Compliance

CTM-defined.

3.14.15  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2
Topology

Synopsis

void createL2Topology(

in multiLayerSubnetwork::L2TopoCreateData_T createData, out 
multiLayerSubnetwork::L2Topology_T l2Topo) 

    raises(globaldefs::ProcessingFailureException);

Description

This interface provides a way to create an L2 topology, including all the optical SNCs associated with it. The user must associate MLVLANs using the interface method defined in the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createMLVLAN" section. CTM creates an L2 topology within the same MultiLayerSubnetwork. If the 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 only supports creation of 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 ML-100T-8 equipment names to be involved in the RPR topology. RPR consists of all ML-series equipment, all ML-100T-8 equipment, or a combination of ML-series and ML-100T-8 equipment. To create point-to-point topology, you must specify the end TPs of the underlying L1 SNC that needs to be created.

During L2 topology creation, if any of the underlying L1 SNC creations fail, 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 the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I:: createAndActivateSNCFromUserLabel" section to complete the L2 topology, or the NMS deletes the L2 topology and recreates the L2 topology using this interface.

For RPR topology, the NMS must specify all the equipment to be involved, in cyclical order and in pairs. There are three possible scenarios:

•All SNCs in the RPR are CCAT. In this case, only SNCCreateDataList_T is populated and VCATSNCCreateDataList_T is empty. For example, if the NMS is trying to create an RPR topology involving three ML-series cards (M1, M2, and M3), then NMS has to specify a three-element array of SNCCreateData_T. The first element's aEnd will specify the M1 equipment name and the zEnd will specify the M2 equipment name. The second element's aEnd will specify the M2 equipment name and zEnd will specify the M3 equipment name. The third element's aEnd will specify the M3 equipment name and zEnd will specify the M1 equipment name.

•All SNCs in the RPR are VCAT. In this case, only VCATSNCCreateDataList_T is populated and SNCCreateDataList_T is empty. For example, if the NMS is trying to create an RPR topology involving three ML-series cards (M1, M2, and M3), then NMS has to specify a 3-element array of VCATSNCCreateData_T. The first element's aEnd will specify the M1 equipment name and zEnd will specify the M2 equipment name. The second element's aEnd will specify the M2 equipment name and zEnd will specify the M3 equipment name. The third element's aEnd will specify the M3 equipment name and zEnd will specify the M1 equipment name.

•Mix of CCAT and VCAT SNCs in the RPR. In this case, both VCATSNCCreateDataList_T and SNCCreateDataList_T are populated and all the equipment in the two arrays is in cyclical order.

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 has to specify:

–A two-element array of SNCCreateData_T with the first element's aEnd specifying the M1 equipment name and the zEnd specifying the M2 equipment name and the second element's aEnd specifying the M3 equipment name and zEnd specifying the M1 equipment name.

–A one-element array of VCATSNCCreateData_T with the first element's aEnd specifying the M2 equipment name and zEnd specifying the M3 equipment name.

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 will throw a ProcessingFailureException if the NMS-specified list is not homogenous. CTM will throw 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 will verify 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 will use the first PTP of a pair as the aEnd of the topological link and use the second PTP of the same pair as the zEnd of the topological link. CTM will attempt to route the SNC from aEnd PTP of a PTP pair to zEnd PTP of the same pair on a topological link. CTM will throw ProcessingFailureException if SNC cannot be routed from the specified aEnd PTP to the zEnd PTP of a topological link. NMS then has to interchange the aEnd and zEnd PTPs specified, provide a different PTP pair, or delete the PTP pair from the include or exclude list. CTM will throw ProcessingFailureException if at least one PTP is not associated with a topological link. NMS has to ensure that the sequence of the object name list conforms to the sequence of the objects existing in the network. CTM will throw ProcessingFailureException if the sequence is nonconforming.

CTM R5.0 does not support L2 topology creation where the SNCs have more than one source point and destination endpoint in SNCCreateData_T.aEnd or SNCCreateData_T.zEnd.

CTM R5.0 supports creating 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 CTM R5.0 supports this operation only for the ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
L2TopoCreateData_T	multiLayerSubnetwork::L2TopoCreateData_T	In	The data structure defining the L2 topology to be created.
L2Topo	multiLayerSubnetwork::L2Topology_T	Out	The created L2 topology.

CTM support for L2TopoCreateData_T structure is described as follows:

•string nativeEMSName

–Supported. Used as the L2 topology name.

•string userLabel

–Not supported.

•boolean forceUniqueness

–CTM guarantees the uniqueness if all L2 topology are created by CTM only. If any other tool is used for L2 topology creation, CTM does not guarantee uniqueness.

•string owner

–Not supported.

•transmissionParameters::LayerRate_T

–Not supported. LayerRate is specified as part of SNCCreateData_T and VCAT SNCCreateData_T structure.

•multiLayerSubnetwork::L2TopoType l2TopoType

–The type of the L2 topology. Valid values are L2TopoType.PT2PT and L2TopoType.RPR.

•subnetworkConnection::SNCCreateDataList_T sncInfoList

–Supported.

CTM R5.0 supports the following for SNCCreateData_T structure for L2 topology creation:

•string userLabel

–Not supported.

•boolean forceUniqueness

–Not supported.

•string owner

–Not supported.

•globaldefs::ConnectionDirection_T direction

–Not supported. CTM always creates CD_BI (bidirectional) circuits.

•StaticProtectionLevel_T staticProtectionLevel

–Supported. CTM supports UNPROTECTED and FULLY_PROTECTED.

•ProtectionEffort_T protectionEffort

–CTM supports all values defined by the TMF.

–If NMS requests an unprotected SNC on a 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 statusProtectionLevel to be UNPROTECTED. These values indicate that CTM has to create a PCA.

•Reroute_T rerouteAllowed

–Not supported.

•NetworkRouted_T networkRouted

–Not supported.

•SNCType_T sncType

–Not supported.

•transmissionParameters::LayerRate_T layerRate

Supported. CTM supports the following L2 topology layer rates:

–LR_STS1_AND_AU3_High_Order_VC3 (ONS 15454 SONET)

–LR_Low_Order_TU3_VC3 (ONS 15454 SDH)

–LR_STS3c_and_AU4_VC4 (ONS 15454 SONET and ONS 15454 SDH)

–LR_STS6c_and_VC4_2c (ONS 15454 SONET and ONS 15454 SDH)

–LR_STS9c_and_VC4_3c (ONS 15454 SONET and ONS 15454 SDH)

–LR_STS12c_and_VC4_4c (ONS 15454 SONET and ONS 15454 SDH)

–LR_STS24c_and_VC4_8c (ONS 15454 SONET and ONS 15454 SDH)

•CrossConnectList_T ccInclusions

–Not supported.

•ResourceList_T neTpInclusions

–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.

•boolean fullRoute

–Not supported.

•ResourceList_T neTpSncExclusions

–Supported. CTM expects a list of ME or PTP names at the endpoints of the topological link to be excluded in the SubnetworkConnection route.

•globaldefs::NamingAttributesList_T aEnd

–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 OC-N equipment.

•globaldefs::NamingAttributesList_T zEnd

–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 OC-N equipment.

•globaldefs::NVSList_T additionalCreationInfo

–Supported. This list can be used to provide additional parameters for SNC creation. CTM supports the following parameters:

Parameters

Name	Value	Description
upsrRevertiveMode	revertive or nonrevertive	Supported only for point-to-point L2 topologies. If value is set to revertive, traffic will revert back to the working path when the conditions that diverted it to the protect path are repaired. Otherwise, it remains on the protect path after the switch.
upsrRevertiveTime	Valid float value between 0.5 and 12 in increments of 12.	Supported only for point-to-point L2 topology. If SNC is revertive then set this parameter. This is the amount of time that will elapse before the traffic reverts to the working path. The default value is 5 months. Note CTM does not validate any of the values.
upsrSfBerLevel	3, 4, or 5	Supported only for point-to-point L2 topology. Set the thresholds for signal failure bit error rate on the UPSR path-level (applicable to STS SNCs only). Note CTM does not validate any of the values.
upsrSdBerLevel	5, 6, 7, 8, 9	Supported only for point-to-point L2 topology. Set the thresholds for signal degrade bit error rate on the UPSR path-level (applicable to STS SNCs only). Note CTM does not validate any of the values.
upserSwitchOnPdiP	True or false	Supported only for point-to-point L2 topology. Set to true if you want traffic to switch when STS payload defect indicator is received (applicable to STS SNCs only). Note CTM does not validate any of the values.
goAndReturnRouting	True or false	Not supported.
sncDescription	String	Not supported.
VLAN	VLAN ID	Not supported.
CustomerID	String	Not supported.
ServiceID	String	Not supported.
sncSize	int; 1=2.5 Gbps FEC, 2=2.5 Gbps No FEC, 3=10 Gbps FEC, 4=10 Gbps No FEC, 5=Multirate, 6=Equipped not specific	Not supported.
createTunnelOnTransitNodes	True or false	Applicable for VC SNCs with one or more transit nodes that do not have a tunnel or the existing tunnel is exhausted. This parameter specifies whether to create a tunnel on the transit nodes. For SNCs without transit nodes or with an existing tunnel on a transit node that has available bandwidth, this value is ignored. If the value specified is true, a tunnel is created and the SNC is routed using this tunnel. If the value specified is false, then a new tunnel is not created. In this case, if a tunnel that is not full is available on the transit node, the circuit is routed through the tunnel; otherwise, else the circuit is not routed through the tunnel.
createVTAggregation	True or false	Applicable for VC SNCs with one or more transit nodes that do not have a VAP circuit or the existing VAP circuit is exhausted. This parameter specifies whether to create a new VAP circuit on the transit nodes. If the value specified is true, a VAP circuit is created and SNC is routed using the new VAP circuit. If the value specified is false, then the VAP circuit will not be created.
sourceIsSTSGrroming	true or false	If true, source drop point of the VC circuit will be STS-groomed for the VAP circuit to be created. Note This attribute will be valid only when createVTAggregation value is set to true. Note SourceIsSTSGrooming and destinationIsSTSGrooming cannot both be set to true.
destinationIsSTSGrooming	true or false	If true, destination drop point of the VT or VC circuit will be STS-groomed for the VAP circuit to be created. Note This attribute will be valid only when createVTAggregation value is set to true. Note SourceIsSTSGrooming and destinationIsSTSGrooming cannot both be set to true.
vapDestination	string	User specifies the string (ME name) representing VAP destination drop point.
usePortlessTransmux	true or false	If true, portless transmux card will be used for the circuit. NMS shall provide information for portlessTransmuxMeName, portlessTransmuxSlot, and isSourceDS3MappedSTS. If false, invalid input exception will be thrown. If false, portless transmux card will not be used as the intermediate point for the end-to-end STS-1 circuit.
portlessTransmuxMeName	string	Not supported
portlessTransmuxSlot	/rack=1/shelf=1/slot=[1..6][12..17]	Not supported
isSourceDS3MappedSTS	true or false	Not supported
vcatMemberId	int, 1 to 256	Used for VCAT SNC creation, to identify every VCAT member L1 SNC uniquely. For normal CCAT circuits, this value is ignored if specified.

•subnetworkConnection::VCATSNCCreateDatalist_T vcatSncInfoList

CTM supports SNCCreatedata_T structure for L2 topology creation as described below:

•string userLabel

–Not supported.

•boolean forceUniqueness

–CTM guarantees the uniqueness of all VCATs created in CTM. It is not guaranteed if other tools were used for VCAT SNC creation.

•string owner

–Not supported.

•globaldefs::ConectionDirection_T direction

–Not supported. CTM supports CD_BI (bidirectional).

•boolean isSymmetrical

–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.

•subnetworkConnection::LCASMode_T mode

Supported. CTM supports the following values:

–LCASMode_T.MODE_NONE

–LCASMode_T.MODE_SWLCAS

–LCASMode_T.MODE_LCAS

•subnetworkConnection::RoutingMode_T routingMode

Supported. CTM supports the following values:

–RoutingMode_T.COMMONFIBER_ROUTED

–RoutingMode_T.INDEPENDENTFIBER_ROUTED

•globaldefs::NamingAttributes_T aEnd

–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.

•globaldefs::NamingAttributes_T zEnd

–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.

•subnetworkConnection::SNCCreateDataList_T sncCreateDataList

–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.

•globaldefs::NVList_TadditionalCreationInfo

–Not supported.

•subnetworkConnection::StatisProtectionLevel_T staticProtectionLevel

–Not supported. StaticProtectionLevel is specified as part of the SNCCreateData_T and VCATSNCCreateData_T structures.

•globaldefs::NVSList_T additionalInfo

–Supports the bandwidth parameters SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth, SpMgmtCoS, CommittedCoS, AvvidVoiceVideoCoS, AvvidControlCoS, and cos value CosCommit. Either all or none of these parameters should be passed. Each of the bandwidth parameters SpMgmtbandwidth, CommittedBandwidth, BestEffortBandwidth, and AvvidControlBandwidth must be from 1 to 96, and the sum of all four parameters must also be from 1 to 99. CoScommit value should be in the range from 0 to 7. If none of these parameters pass, CTM will take the following default values: 5 (SpMgmtBandwidth), 80 (CommittedBandwidth), 10 (BestEffortBandwidth), 4 (AvvidControlBandwidth), 6, 7 (SpMgmtCoS), 1, 2 (CommittedCoS), 5 (AvvidVoiceVideoCoS), 3 (AvvidControlCoS), and 2 (cos value CosCommit).

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when one or more input tplist is invalid or when the specified layer rate is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when one or more input tpList is does not exist.

EXCPT_UNABLE_TO_COMPLY 

This exception is raised when a layer rate is not supported for L2 topology creation or when CTM cannot create the L2 topology for the specified layer rate. This is also raised if the VCAT SNC cannot be created and activated because CTP conflicts with other VCAT SNCs or the NE does not support the VCAT SNC creation.

EXCPT_OBJECT_IN_USE

This exception is raised when the specified L2 topology already exists.

EXCPT_NE_COMM_LOSS 

This exception is raised when one of the MEs specified as part of L2 topology creation is not reachable.

Compliance

CTM-defined.

3.14.16  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteL2Topology

Synopsis

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 there are no MLVLANs associated with the L2 topology to ensure that the L2 topology is successfully deleted.

---

Note CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	The name of the L2 topology to be deleted.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

EXCPT_UNABLE_TO_COMPLY 

This exception is raised when L2 topology name specified has MLVLAN associated with it.

EXCPT_NE_COMM_LOSS 

This exception is raised when one of the MEs specified as part of an L2 topology creation is not reachable.

Compliance

CTM-defined.

3.14.17  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyL2Topology

Synopsis

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 the "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2 Topology" section. Also, this operation is used when the L2 topology is discovered but it can't be used when the L2 topology synchronization state is L2TopoSyncState.L2NOTREADY.

---

Note CTM supports this operation only for the ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
l2TopologyName	globaldefs::NamingAttributes_T	In	The name of the L2 topology that will be modified.
l2Modifydata	globaldefs::NVList_T	In	The bandwidth allocation parameters of the L2 topology that will be modified. Note The l2Modifydata parameter should be the same format as the bandwidth parameters listed in globaldefs::NVSList_T additionalInfo of "multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2 Topology" section.
l2Topo	multiLayerSubnetwork::L2Topology_T	Out	The modified L2 topology.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when the L2 topology name does not reference an L2 topology object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when the L2 topology name references an L2 topology object that does not exist.

EXCPT_UNABLE_TO_COMPLY 

This exception is raised when one or more of the MEs associated with the specified L2 topology is not accessible.

Compliance

CTM-defined.

3.14.18  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAvailableMLEquipmentOrTPNames

Synopsis

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 any L2 topology at this time.

---

Note CTM R5.0 supports this operation only for ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
managedElementList	globaldefs::NamingAttributesList_T	In	The name list of ManagedElements from which available ML-series cards needs to be determined.
topoType	multiLayerSubnetwork::L2TopoType_T	In	The topology type that would be created using the list. CTM supports L2TopoType_T.L2TT_RPR or L2TopoType_T.L2TT_PT2PT.
how_many	unsigned long	In	The maximum number of Equipment or TP names to return in the first batch.
eqorTPNamesList	NamingAttributesList_T	Out	The first batch of Equipment or TP names.
eqorTPNamesIt	NamingAttributesIterator_I	Out	The iterator used to retrieve the remaining Equipment or TP names.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

EXCPT_INVALID_INPUT

This exception is raised when any of the ManagedElement names does not refer to a ManagedElement object.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when any of the MEs does not exist in CTM.

Compliance

CTM-defined.

3.15   E-Series and G-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 MultiLayerSubnetwork. VLAN names and IDs are unique within the MultiLayerSubnetwork.

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

This method creates a new VLAN with an ID and name associated to the MultiLayerSubnetwork.

---

Note CTM supports this operation only for ONS 15327, ONS 15310, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetname	globaldefs::NamingAttributes_T	In	MultiLayerSubnetwork name to which this VLAN is to be associated.
vlanId	VlanId	In	ID of the VLAN to be created.
name	String	In	Name of the VLAN to be created.
vlan	Vlan_T	Out	VLAN object created by CTM.

Throws

globaldefs::ProcessingFailureException

EXCPT_INVALID_INPUT

This exception is raised when a VLAN ID or subnetname is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when a subnetname does not exist in the EMS.

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

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 to the MultiLayerSubnetwork.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetname	globaldefs::NamingAttributes_T	In	MultiLayerSubnetwork name to which this VLAN is associated.
vlanId	VlanId	In	ID of the VLAN to be deleted.

Throws

globaldefs::ProcessingFailureException

EXCPT_INVALID_INPUT

This exception is raised when a VLAN ID or subnetname is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when a subnetname does not exist in the EMS.

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.

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 MultiLayerSubnetwork.

---

Note CTM supports this operation only for ONS 15310, ONS 15327, ONS 15454 SONET, and ONS 15454 SDH NEs.

---

Parameters

Name	Type	Input/Output	Description
subnetname	globaldefs::NamingAttributes_T	In	MultiLayerSubnetwork name for which all the VLANs are to be obtained.
vlanList	VlanList_T	Out	List of available VLANs for this EMS.

Throws

globaldefs::ProcessingFailureException

EXCPT_INVALID_INPUT

This exception is raised when a subnetname is invalid.

EXCPT_ENTITY_NOT_FOUND

This exception is raised when a subnetname does not exist in the EMS.

EXCPT_INTERNAL_ERROR

This exception is raised in the case of a nonspecific EMS internal failure.