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.