Cisco Transport Manager GateWay/CORBA User's Guide and Programmer Manual, 7.2
Chapter 3: Using CTM GateWay/CORBA Interfaces

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.2.17  emsMgr::EMSMgr_I::getAllEMSandMEClearedAlarms

3.2.18  emsMgr::EMSMgr_I::getAllEMSSystemClearedAlarms

3.2.19  emsMgr::EMSMgr_I::createServerTrailLink

3.2.20  emsMgr::EMSMgr_I::deleteServerTrailLink

3.2.21  emsMgr::EMSMgr_I::addManagedElement

3.2.22  emsMgr::EMSMgr_I::addNetworkPartition

3.2.23  emsMgr::EMSMgr_I::addMultiLayerSubnetwork

3.2.24  emsMgr::EMSMgr_I::deleteAndPurgeManagedElement

3.2.25  emsMgr::EMSMgr_I::deleteNetworkPartition

3.2.26  emsMgr::EMSMgr_I::deleteMultiLayerSubnetwork

3.2.27  emsMgr::EMSMgr_I::addSWVersion

3.2.28  emsMgr::EMSMgr_I::getAllSupportedMESoftwareVersions

3.3  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::getEmsSession

3.4.2  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey

3.4.3  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair

3.5  equipment::EquipmentInventoryMgr_I

3.5.1  equipment::EquipmentInventoryMgr_I::getAllEquipment

3.5.2  equipment::EquipmentInventoryMgr_I::getAllEquipmentNames

3.5.3  equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs

3.5.4  equipment::EquipmentInventoryMgr_I::getAllSupportedPTPNames

3.5.5  equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment

3.5.6  equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
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.5.13  equipment::EquipmentInventoryMgr_I::configureMLParameters

3.6  maintenanceOps::MaintenanceManager_I

3.6.1  maintenanceOps::MaintenanceMgr_I::getActiveMaintenanceOperations

3.6.2  maintenanceOps::MaintenanceMgr_I::performMaintenanceOperation

3.7  managedElementManager::ManagedElementManager_I

3.7.1  managedElementManager::ManagedElementManager_I::getAllActiveAlarms

3.7.2  managedElementManager::ManagedElementManager_I::getAllSNCs

3.7.3  managedElementManager::ManagedElementManager_I::
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::
getManagedElement

3.7.13  managedElementManager::ManagedElementManager_I::getTP

3.7.14  managedElementManager::ManagedElementManager_I::
getAssociatedTopologicalLinks

3.7.15  managedElementManager::ManagedElementManager_I::setTPData

3.7.16  managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSNCProvisioning

3.7.17  managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSNCProvisioning

3.7.18  managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSNCProvisioning

3.7.19  managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSNCProvisioning

3.7.20  managedElementManager::ManagedElementManager_I::
getAllSrcFTPsForSNCProvisioning

3.7.21  managedElementManager::ManagedElementManager_I::
getAllDestFTPsForSNCProvisioning

3.7.22  managedElementManager::ManagedElementManager_I::
forceNEResync

3.7.23  managedElementManager::ManagedElementManager_I::
getAllTopologicalLinksForME

3.7.24  managedElementManager::ManagedElementManager_I::
getAllRolls

3.7.25  managedElementManager::ManagedElementManager_I::
getAllRollNames

3.7.26  managedElementManager::ManagedElementManager_I::
getRoll

3.7.27  managedElementManager::ManagedElementManager_I::
getRollToPTPs

3.7.28  managedElementManager::ManagedElementManager_I::
getRollToCTPs

3.7.29  managedElementManager::ManagedElementManager_I::
getRollFromCTPs

3.7.30  managedElementManager::ManagedElementManager_I::setPortName

3.7.31  managedElementManager::ManagedElementManager_I::getPortName

3.7.32  managedElementManager::ManagedElementManager_I::
getAllClearedAlarms

3.7.33  managedElementManager::ManagedElementManager_I::
getAllSrcPTPsForSTProvisioning

3.7.34  managedElementManager::ManagedElementManager_I::
getAllSrcCTPsForSTProvisioning

3.7.35  managedElementManager::ManagedElementManager_I::
getAllDestPTPsForSTProvisioning

3.7.36  managedElementManager::ManagedElementManager_I::
getAllDestCTPsForSTProvisioning

3.7.37  managedElementManager::ManagedElementManager_I::
getAllCrossConnections

3.7.38  managedElementManager::DownloadMESoftware

3.7.39  managedElementManager::getAllSoftwareDownloadJobs

3.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I

3.8.1  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllEdgePoints

3.8.2  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllEdgePointNames

3.8.3  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllManagedElement

3.8.4  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllManagedElementNames

3.8.5  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnections

3.8.6  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionsWithTP

3.8.7  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNames

3.8.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllSubnetworkConnectionNamesWithTP

3.8.9  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllTopologicalLinks

3.8.10  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllTopologicalLinkNames

3.8.11  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getMultiLayerSubnetwork

3.8.12  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getCTPsAndTopologicalLinks

3.8.13  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNC

3.8.14  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getSNCsByUserLabel

3.8.15  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getTopologicalLink

3.8.16  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
createAndActivateSNCFromUserLabel

3.8.17  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createAndActivateSNC

3.8.18  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addDrops

3.8.19  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deactivateAndDeleteSNC

3.8.20  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getVCATSNC

3.8.21  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCs

3.8.22  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATSNCNames

3.8.23  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllVCATMemberSNCs

3.8.24  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllVCATMemberSNCNames

3.8.25  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createVCAT

3.8.26  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteVCAT

3.8.27  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::addMemberSNCsToVCAT

3.8.28  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteMemberSNCsFromVCAT

3.8.29  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteAllMemberSNCFromVCAT

3.8.30  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getValidSubnetworkConnectionsForMerge

3.8.31  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::upgrade

3.8.32  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createRoll

3.8.33  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteRoll

3.8.34  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::cancelRoll

3.8.35  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::forceValidSignal

3.8.36  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::completeRoll

3.8.37  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::finishRoll

3.8.38  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllRolls

3.8.39  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllRollNames

3.8.40  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedRollNamesForSNC

3.8.41  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedSNCNamesForRoll

3.8.42  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createAndActivateSNCOnDRI

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

3.14.6  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::modifyMLVLANTPQOS

3.14.7  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyMLVLANCustomerIDServiceID

3.14.8  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getMLVLAN

3.14.9  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::deleteMLVLAN

3.14.10  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANs

3.14.11  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getAllMLVLANNames

3.14.12  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAssociatedSNCs

3.14.13  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getL2Topology

3.14.14  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForSNC

3.14.15  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAssociatedL2TopologyForMLVLAN

3.14.16  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::createL2
Topology

3.14.17  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
deleteL2Topology

3.14.18  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
modifyL2Topology

3.14.19  multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::
getAllAvailableMLEquipmentOrTPNames

3.15  E-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 VLAN Interfaces


Note The iterator interfaces defined by TMF are not listed here. CTM implementation of these interfaces does not deviate from 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, in which the name represents the feature/capability name and the value represents the support or nonsupport of the specified feature/capability.

The EMS capabilities for this release include individual IDL operation support. The feature/capability name part is used to identify an IDL operation using the following convention:

module_name::interface_name::operation_name

The currently defined values are as follows:

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

Unsupported—The specified feature/capability is not supported at all across the NML-EML interface.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

TMF-defined.

3.2  emsMgr::EMSMgr_I

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

interface EMSMgr_I:common::Common_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 enables an NMS to request active alarms that are under the control of the EMS (alarms raised by the NEs and alarms raised by the EMS itself). Some alarms might be filtered out (excluded) by specifying their probable causes or severities.

Due to performance concerns, only one OSS client is allowed to invoke this operation at a time. Otherwise, CTM throws an EXCPT_UNABLE_TO_COMPLY exception.

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

ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH

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

ONS 15540, ONS15530, and ONS 15501

TCAs are also reported in the eventList returned by this method as ONS 15540 sends a "clear" for the threshold crossing alarms.

ONS 15800, ONS 15801, and ONS 15808

ONS 15800, ONS 15801, and ONS 15808 alarms that are retrieved using the CTM GateWay/CORBA have OT_EQUIPMENT as the object_type field.

Parameters

Name
Type
Input/Output
Description

excludeProbCauseList

notifications::ProbableCauseList_T

In

The 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 - Raised in case of non-specific EMS internal failure.

EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS Client.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.2.2  emsMgr::EMSMgr_I::getAllEMSSystemActiveAlarms

Synopsis

void getAllEMSSystemActiveAlarms(
        in notifications::PerceivedSeverityList_T excludeSeverityList,
        in unsigned long how_many,
        out notifications::EventList_T eventList,
        out notifications::EventIterator_I eventIt) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request all active alarms for the EMS. Some alarms can be filtered out (excluded) by specifying their severities.

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

Parameters

Name
Type
Input/Output
Description

excludeSeverityList

notifications::PerceivedSeverityList_T

In

List of severities to exclude from the output event list.

how_many

unsigned long

In

Maximum number of alarms to report in the first batch.

eventList

notifications::EventList_T

Out

First batch of alarms.

eventIt

notifications::EventIterator_I

Out

Iterator to retrieve the remaining alarms.


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.2.3  emsMgr::EMSMgr_I::getAllTopLevelSubnetworks

Synopsis

void getAllTopLevelSubnetworks(
        in unsigned long how_many,
        out multiLayerSubnetwork::SubnetworkList_T sList,
        out multiLayerSubnetwork::SubnetworkIterator_I sIt) 
     raises(globaldefs::ProcessingFailureException);

Description

This enables an NMS to request all subnetworks that are under the control of the EMS.

Parameters

Name
Type
Input/Output
Description

how_many

unsigned long

In

Maximum number of subnetworks to return in the first batch.

sList

multiLayerSubnetwork::SubnetworkList_T

Out

First batch of subnetworks.

sIt

multiLayerSubnetwork::SubnetworkIterator_I

Out

Iterator to retrieve the remaining subnetworks.


CTM support for MultiLayerSubnetwork_T is as follows:

globaldefs::NamingAttributes_T name

Supported. It will contain two tuples. The first tuple identifies the EMS and the second tuple will be the same as nativeEMSName. The naming convention is described in 2.2.4.1  Multilayer Subnetwork, page 2-38.

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 - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.2.4  emsMgr::EMSMgr_I::getAllTopLevelSubnetworkNames

Synopsis

void getAllTopLevelSubnetworkNames(
        in unsigned long how_many,
        out globaldefs::NamingAttributesList_T nameList,
        out globaldefs::NamingAttributesIterator_I nameIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation has exactly the same behavior as the operation described in emsMgr::EMSMgr_I::getAllTopLevelSubnetworks, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name
Type
Input/Output
Description

how_many

unsigned long

In

Maximum number of subnetworks to return in the first batch.

sList

globaldefs::NamingAttributesList_T

Out

First batch of subnetwork names.

sIt

globaldefs::NamingAttributesIterator_I

Out

Iterator to retrieve the remaining subnetwork names.


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.2.5  emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks

Synopsis

void getAllTopLevelTopologicalLinks(
        in unsigned long how_many,
        out topologicalLink::TopologicalLinkList_T topoList,
        out topologicalLink::TopologicalLinkIterator_I topoIt) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request all of the top-level topological links that are under the control of the EMS. A top-level topological link is a topological link in which the end-points of the topological link exist in two different multilayer subnetworks.

If the link is under the control of the EMS and then removed from the NE, the ProvType parameter is reported as INVALID.

Parameters

Name
Type
Input/Output
Description

how_many

unsigned long

In

Maximum number of top-level topological links to return in the first batch

topoList

topologicalLink::TopologicalLinkList_T

Out

First batch of top-level topological links

topoIt

topologicalLink::TopologicalLinkIterator_I

Out

Iterator to retrieve the remaining top-level topological links


CTM support for TopologicalLink_T structure is as follows:

globaldefs::NamingAttributes_T name

Supported. This field has two tuples. The first tuple is for the EMS. The second is for the topological link. The value in the second tuple is the same as the nativeEMSName field except for the Y-cable links, which 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 more information, see 2.2.5  Naming Conventions, page 2-43.

string owner

Not supported.

globaldefs::ConnectionDirection_T direction. CTM will support CD_BI for the bidirectional links and CD_UNI for the unidirectional 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 table below.

Managed Element Type
Parameter Name
Supported Parameter Values

All ManagedElements that support topological links

provType

AUTODISCOVERED

MANUAL

UNMANAGED

PATCHCORD

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

All ManagedElements that support topological links

linkAliasName

User-specified alias name for the link name. Can support Unicode characters.

All ManagedElements which support Topological Link

linkAliasName

User-specified alias name for the link name. Can support Unicode characters.


Throws

globaldefs::ProcessingFailureException

EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.2.6  emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinkNames

Synopsis

void getAllTopLevelTopologicalLinkNames(
        in unsigned long how_many,
        out globaldefs::NamingAttributesList_T nameList,
        out globaldefs::NamingAttributesIterator_I nameIt) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation has exactly the same behavior as the operation described in emsMgr::EMSMgr_I::getAllTopLevelTopologicalLinks, but instead of returning the entire object structures, this operation returns their names.

Parameters

Name
Type
Input/Output
Description

how_many

unsigned long

In

Maximum number of top-level topological links to return in the first batch

nameList

globaldefs::NamingAttributesList_T

Out

First batch of top-level topological link names

nameIt

globaldefs::NamingAttributesIterator_I

Out

Iterator to retrieve the remaining top-level topological link names


Throws

globaldefs::ProcessingFailureException

EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.2.7  emsMgr::EMSMgr_I::getTopLevelTopologicalLink

Synopsis

void getTopLevelTopologicalLink(
        in globaldefs::NamingAttributes_T topoLinkName,
        out topologicalLink::TopologicalLink_T topoLink) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request the top-level topological link given that its name is under the control of the EMS.

If the link is under the control of the EMS and then removed from the NE, the ProvType parameter is reported as INVALID.

Parameters

Name
Type
Input/Output
Description

topoLinkName

globaldefs::NamingAttributes_T

In

Name of the topological link

topoLink

TopologicalLink::TopologicalLink_T

Out

Top-level topological link


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a top level topological 
link object.

EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a top level topological link 
object that does not exist in the EMS.

Compliance

TMF-defined.

3.2.8  emsMgr::EMSMgr_I::createTopologicalLink

Synopsis

void createTopologicalLink(
        in topologicalLink::TLCreateData_T createData,
        out topologicalLink::TopologicalLink_T topologicalLink) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to create a topological link manually between two ManagedElements. CTM supports topological link creation between MEs belonging to the same multiLayer subnetwork. If CTM auto discovers a topological link between two end-points on which a manually created link exists, then CTM overwrites the manually created topological link information with the autodiscovered topological link information. CTM generates an AttributeValueChange event when a manually created link is overwritten with auto discovered topological link information. CTM supports topological link creation between two unmanaged NEs, and also between a managed NE and an unmanaged NE. CTM ignores the topological link layer rate if the topological link creation is between two unmanaged NEs.

CTM generates an ObjectCreation event notification when a new topological link is created.


Note For topological links that involve a CRS-1 NE on one end, the other end supports CRS-1, ONS 15454 SONET, and ONS 15454 SDH NEs. Manual links that involve CRS-1 NEs supports the LR_Physical_10_Gigabit_ITU and LR_Physical_40_Gigabit_ITU layer rates.



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 connections 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 operation is supported for CRS-1, ONS 15216, ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, ONS 15600 SDH, ONS155xx, and unmanaged NEs.

Parameters

Name
Type
Input/Output
Description

createData

topologicalLink::TLCreateData_T

In

Data structure containing details for creating new topological links.

topologicalLink

topologicalLink::TopologicalLink_T

Out

Created topological link information.


CTM support for TLCreateData_T structure is as follows:

string userLabel

Supported. The value of this field will be assigned to the name of the newly created topological link.

boolean forceUniqueness

CTM guarantees the uniqueness of topological link names.

string owner

Not supported.

globaldefs::ConnectionDirection_T direction

CTM will support CD_BI for bidirectional links.

CTM will support CD_UNI for unidirectional 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. The supported parameters are listed in the table below:

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 - 2147483647

All ManagedElements that support Topological links

provType

MANUAL and PATCHCORD.

Default MANUAL.


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 - Raised if input createData is not valid.

EXCPT_INVALID_INPUT - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

CTM-defined. This interface is already proposed in TMF and will be included in TMF Release 3.0.

3.2.9  emsMgr::EMSMgr_I::createTopologicalLinkWithYCableProtection

Synopsis

void createTopologicalLinkWithYCableProtection(
        in topologicalLink::MTLCreateData_T createData,
        out topologicalLink::TopologicalLink_T topologicalLink) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to create a Y-Cable topological link manually between two ManagedElements. A Y-Cable link is a bidirectional link with one PTP source and two PTP destinations. Because of the limitation in TMF for TopologicalLinks having one PTP source and one PTP destination, CTM will report two TopologicalLinks for a Y-Cable link. These two topological links will have the same nativeEMSName. See 2.2.5.8  TopologicalLink, page 2-70 for the naming convention for the Y-Cable TopologicalLink object name. The destination of the Y-Cable link must be on a DWDM card on an ONS15454SONET/SDH or on an ONS155xx NE.

CTM generates two ObjectCreationEvent notifications when a new Y-Cable topological link is created.

The TopologicalLink returned from this method is one leg of the Y-Cable.

This interface is supported for ONS 15454 SONET, ONS 15454 SDH, and ONS155xx NEs.

Parameters

Name
Type
Input/Output
Description

createData

topologicalLink:MTLCreateData_T

In

Data structure containing details for creating a new Y-Cable topological link.

topologicalLink

topologicalLink::TopologicalLink_T

Out

One leg of the created Y-Cable topological link information.


CTM support for MTLCreateData_T structure is as follows:

string userLabel

Supported. The value of this field will be assigned to the nativeEMSName of the newly created topological link.

boolean forceUniqueness

CTM guarantees uniqueness of topological link names.

string owner

Not supported.

globaldefs::ConnectionDirection_T direction

Supports only CD_BI for bidirectional links.

transmissionParameters::LayerRate_T rate. Supported layer rates are:

LR_Physical_2_5_Gigabit_ITU

LR_Physical_10_Gigabit_ITU

LR_DSR_OC3_STM1

LR_DSR_OC12_STM4

LR_DSR_OC48_STM16

LR_DSR_OC192_STM64

globaldefs::NamingAttributesList_T aEndTPs

Supported. It should contain only one PTP.

globaldefs::NamingAttributesList_T zEndTPs

Supported. It should contain two PTPs on the same ME.

globaldefs::NVSList_T additionalInfo

Supported. The supported parameters are listed in the table below.

Managed Element Type
Parameter Name
Supported Parameter Values

All ManagedElements that support topological links

linkCost

Int, 1 to 2147483647

All ManagedElements that support Topological links

provType

MANUAL (default value) and PATCHCORD.


globaldefs::sSrlgGroupList_T srlgGroupListValue

Supported. This field holds the SRLG group values. This is an optional parameter. 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 - Raised if input createData is not valid.

EXCPT_INVALID_INPUT - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

CTM-defined.

3.2.10  emsMgr::EMSMgr_I::deleteTopologicalLink

Synopsis

void deleteTopologicalLink(
        in globaldefs::NamingAttributes_T topoLinkName) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to delete a topological link manually between two ManagedElements. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if an attempt was made to delete an autodiscovered topological link or if the topological link could not be deleted in the current state. CTM generates an ObjectDeletion event notification when a topological link is deleted.


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


This operation is supported for CRS-1, ONS 15216, ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS155xx, ONS 15600 SONET, ONS 15600 SDH, and unmanaged NEs.

Parameters

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 - Raised if input topological link name is invalid.

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

EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete an auto-discovered 
topological link

Compliance

CTM-defined. This interface is already proposed in TMF and will be included TMF Release 3.0.

3.2.11  emsMgr::EMSMgr_I::modifyTopologicalLink

Synopsis

void modifyTopologicalLink(
        in topologicalLink::TLCreateData_T newTLCreateData,
        out topologicalLink::TopologicalLink_T newTopologicalLink)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to modify some of the parameters of the existing topological links. The following parameters can be modified using modifyTopologicalLink API.

Description of the topological link

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

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

Parameters

Name
Type
Input/Output
Description

createData

topologicalLink::TLCreateData_T

In

Data structure containing details for creating a new topological link.

topologicalLink

topologicalLink::TopologicalLink_T

Out

Created topological link information.


CTM support for TLCreateData_T structure is as follows:

string userLabel

Supported. The value of this field will be assigned to the name of the newly created topological link.

boolean forceUniqueness

CTM guarantees uniqueness of topological link names.

string owner

Not supported.

globaldefs::ConnectionDirection_T direction

CTM will support CD_BI for bidirectional links and CD_UNI for unidirectional links.

transmissionParameters::LayerRate_T rate. Supported layer rates are:

LR_DSR_OC3_STM1 (for physical link)

LR_DSR_OC12_STM4 (for physical link)

LR_DSR_OC48_STM16 (for physical link)

LR_DSR_OC192_STM64 (for physical link)

LR_Physical_10_Gigabit_ITU

LR_Physical_40_Gigabit_ITU

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 table below.

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 - 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 the link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for the SONET/SDH topological links. SRLG is not supported for CRS-1 links.

Throws

globaldefs::ProcessingFailureException

EXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.

EXCPT_INVALID_INPUT - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

CTM-defined.

3.2.12  emsMgr::EMSMgr_I::getEMS

Synopsis

void getEMS(out EMS_T emsInfo) 
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request the EMS information.

Parameters

Name
Type
Input/Output
Description

emsInfo

EMS_T

Out

EMS information


CTM supports EMS_T is as follows:

globaldefs::NamingAttributes_T name

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

string userLabel

Not supported.

string nativeEMSName

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

string owner

Not supported.

string emsVersion

CTM returns "7.2."

string type

CTM returns "Cisco Systems/Cisco Transport Manager."

globaldefs::NVSList_T additionalInfo

Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

TMF-defined.

3.2.13  emsMgr::EMSMgr_I::getAllL2Topologies

Synopsis

void getAllL2Topologies(in multiLayerSubnetwork::L2TopoType_T l2TopoType,
        in unsigned long how_many,
        out multiLayerSubnetwork::L2TopologyList_T l2TopoList,
        out multiLayerSubnetwork::L2TopologyIterator_I l2TopoIt)
     raises(globaldefs::ProcessingFailureException);

Description

This interface lists all L2 topologies of a particular topology type in the EMS. The L2 topology has a scope in EMS. CTM supports only Resilient Packet Ring (RPR) and point-to-point L2 topology types.


Note 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 multiLayer subnetwork.

l2TopoIt

multiLayerSubnetwork::L2TopologyIterator_I

Out

The iterator used to retrieve the remaining L2 topologies.


CTM support for L2Topology_T structure is as follows:

globaldefs::NamingAttributes_T name

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

string userLabel

Not supported.

string nativeEMSName

Supported. L2 topology name will be 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—It represents the layer rate of the SNCs. In case of VCAT, it represents the layer rate of the member SNCs.

Unsigned long numberOfVcatMembers—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.

Supported Layer rates are:

LR_STS1_and_AU3_High_Order_VC3

LR_STS3c_and_AU4_VC4

LR_STS6c_and_VC4_2c

LR_STS9c_and_VC4_3c

LR_STS12c_and_VC4_4c

LR_STS24c_and_VC4_8c

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

multiLayerSubnetwork::L2TopoType l2TopoType

The type of the 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, and L2TopoOperState.OOS.

multiLayerSubnetwork::L2TopoSyncState topoSyncState

Indicates the current L2 topology synchronization state. The valid values for L2TopoSyncState are:

L2TopoSyncState. NEEDED

L2TopoSyncState. INPROGRESS

L2TopoSyncState. COMPLETED

L2TopoSyncState. PARTIAL_COMPLETED

L2TopoSyncState. FAILED

L2TopoSyncState. L2NOTREADY

globaldefs::NVSList_T additionalInfo

Supported.

The Bandwidth parameters SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth, SpMgmtCoS, CommittedCoS, AvvidVoiceVideoCoS, AvvidControlCoS, and CoS value CosCommit are supported. Either all or none of these parameters should be passed. Each of the bandwidth parameters (SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, and AvvidControlBandwidth) should be between 1 and 96 and the sum of all the four bandwidth parameters should be from 1 to 99. CoS commit value should be in the range 0 to 7. If none of these parameters is passed, CTM takes the following default values:

SpMgmtBandwidth: 5

CommittedBandwidth: 80

BestEffortBandwidth: 10

AvvidControlBandwidth: 4

SpMgmtCoS: 6, 7

CommittedCoS: 1, 2

AvvidVoiceVideoCoS: 5

AvvidControlCoS: 3

CosCommit: 2.

Throws

globaldefs::ProcessingFailureException

EXCPT_INVALID_INPUT - Raised when a l2TopoType is invalid.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can 
support has been reached.

Compliance

CTM-defined.

3.2.14  emsMgr::EMSMgr_I::getAllQoSTemplateNames

Synopsis

void getAllQoSTemplateNames( in unsigned long how_many,
        out globaldefs::NamingAttributesList_T qosTempNameList,
        out globaldefs::NamingAttributesIterator_I qosTempNameIt)
     raises(globaldefs::ProcessingFailureException);

Description

This interface lists all QoSTemplate names in the EMS. The QoSTemplate has a scope in EMS.

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

Parameters

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

The first batch of names

qosTempNameIt

globaldefs::NamingAttributesIterator_I

Out

The iterator used to retrieve the remaining names


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can 
support has been reached.

Compliance

CTM-defined.

3.2.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 QoSTemplate in the EMS. The QoSTemplate has a scope in EMS.

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

Parameters

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

The first batch of QoSTemplates

qosTempIt

QoSTemplateIterator_I

Out

The iterator used to retrieve the remaining QoSTemplates


CTM support for QoSTemplate structure is as follows:

globaldefs::NamingAttributes_T templateName—Supported. This field specifies the template name.

string qos_template_description—Supported. This field specifies the description of the template.

emsMgr::TemplateType_T—TemplateType specifies the type of template. CTM supports the following types:

TemplateType_T.BEST_EFFORT

TemplateType_T.CIR_PIR

TemplateType_T.ADVANCED

QOSPolicy_T policy—Supported. This field specifies the QoS policy for the template.

QOSPolicy_T is defined as follows:

string policy_name—Supported. This field specifies the policy name for the QoS.

QoSClassList_T qosClass—Supported. This provides a list of QoS classes for the policy.

Each QoSClass_T has the following members:

multiLayerSubnetwork::MatchProtocolList_T classification—Supported. Each MatchProtocol_T is defined as:

Classification_T matchTraffic—Specifies the traffic classification. CTM supports the following classifications:

Classification_T.MATCH_ANY

Classification_T.MATCH_DSCP

Classification_T.MATCH_IP

Classification_T.MATCH_COS

string value—This field is a string value. Multiple values should be separated by spaces.

string class_name—Supported. This field specifies the name of the QoS class.

QoSPolicer_T policer—Supported. This field specifies the policer to be used.

QoSPolicer_T structure has the following members:

multiLayerSubnetwork::CIRType_T cir_type—Supported. This specifies the type of CIR, which can either be line rate or rate limited. CTM defines the following values:

CIRType_T.CIR_RATE

CIRType_T.CIR_LINE

long cir—Supported. This field specifies the value of the "cir" and should be in the range of 96 to 800,000 kilobits per second.

long cir_burst—Supported. This field specifies the value of the "cir burst" and should be in the 8000 to 64000 bytes range.

multiLayerSubnetwork::COSMarking_T cir_cos—Supported. Specifies the type of CoS marking for the CIR. CTM supports the following values:

COSMarking_T.COSMARKING_MARK_COS

COSMarking_T.COSMARKING_TRUST

long cir_cos_val—Supported. This field specifies the value of CIR CoS value.

multiLayerSubnetwork::ExcessAction_T excess_act—Supported. CTM supports the following values:

ExcessAction_T.EXCESS_ACTION_DISCARD

ExcessAction_T.EXCESS_ACTION_ALLOW

long pir—Supported. This field specifies the value of the "pir" and should be in the range 96 to 800,000 kilobits per second. It should also be equal to or greater than the cir.

long pir_burst—Supported. This field specifies the value of the "pir burst" and should be in the 8000 to 64000 bytes range. It should also be equal to or greater than the cir burst.

multiLayerSubnetwork::COSMarking_T pir_cos—Supported. This field specifies the type of CoS marking for PIR. CTM supports the following values:

COSMarking_T.COSMARKING_MARK_COS

COSMarking_T.COSMARKING_TRUST

long pir_cos_value—Supported. This field specifies the value of the "pir cos."

multiLayerSubnetwork::ViolateAction_T violate_act—Supported. CTM supports the following values:

ViolateAction_T.VIOLATE_ACTION_DISCARD

ViolateAction_T.VIOLATE_ACTION_ALLOW

long violate_cos_val—Supported. This field specifies the value for "violated cos."

multiLayerSubnetwork::BesteffortType_T beff_type—Supported. CTM supports the following values for best effort type:

BestEffortType_T.BEST_EFFORT_RATE

BestEffortType_T.BEST_EFFORT_LINE

long beff_rate—Supported. This field specifies the maximum rate of best effort and should be in the range of 96 to 800,000 kilobits per second.

long beff_rate_burst—Supported. This field should be in the 8000 to 64000 bytes range.

multiLayerSubnetwork::MatchOption_T operator—Supported. CTM supports the following Match option:

MatchOption_T.MATCH_OPTION_OR

MatchOption_T.MATCH_OPTION_AND


Note CTM always uses MatchOption_T.MATCH_OPTION_AND.


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators that the EMS can 
support has been reached.

Compliance

CTM-defined.

3.2.16  emsMgr::EMSMgr_I::getQoSTemplate

Synopsis

void getAllQoSTemplates(
        in globaldefs::NamingAttribute_T QoSTemplateName,
        out QoSTemplate_T qosTemp )
     raises(globaldefs::ProcessingFailureException);

Description

This interface lists the complete QoSTemplate information given the QoSTemplate name. The QoSTemplate has a scope in EMS.

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

Parameters

Name
Type
Input/Output
Description

qosTemplateName

globaldefs::NamingAttributes_T

In

QoS template name

qosTemp

QoSTemplate_T

Out

QoS template giving the complete information


For details on QoSTemplate_T structure, see emsMgr::EMSMgr_I::getAllQoSTemplateNames.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when QoSTemplate name is not valid.

EXCPT_ENTITY_NOT_FOUND - Raised when QoSTemplate name does not exist on the EMS.

Compliance

CTM-defined.

3.2.17  emsMgr::EMSMgr_I::getAllEMSandMEClearedAlarms

Synopsis

void getAllEMSandMEClearedAlarms(
        in notifications::ProbableCauseList_T excludeProbCauseList,
        in notifications::PerceivedSeverityList_T excludeSeverityList,
        in unsigned long how_many
        out notifications::EventList_T eventList,
        out notifications::EventIterator_I eventIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request all of the cleared and acknowledged alarms that are under the control of this EMS (both those raised by the NEs and those raised by the EMS itself). Some alarms may be filtered out (excluded) by specifying their probable causes or severities.

Due to performance concerns, this operation is restricted to enable only one OSS client to access it at one time. Otherwise, CTM throws EXCPT_UNABLE_TO_COMPLY exception.

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

ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310

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

ONS 15540, ONS15530, and ONS 15501

TCAs are also reported in the eventList that is returned by this method as ONS 15540 sends a "clear" for threshold crossing alarms.

Parameters

Name
Type
Input/Output
Description

excludeProbCauseList

notifications::ProbableCauseList_T

In

The list of probable alarm causes to exclude from the output event list

excludeSeverityList

notifications::PerceivedSeverityList_T

In

List of alarm severities to exclude from the output event list

how_many

unsigned long

In

Maximum number of alarms to report in the first batch

EventList

notifications::EventList

Out

First batch of alarms

EventIt

notifications::EventIterator_I

Out

Iterator to retrieve the remaining alarms


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS Client.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

CTM-defined.

3.2.18  emsMgr::EMSMgr_I::getAllEMSSystemClearedAlarms

Synopsis

void getAllEMSSystemClearedAlarms(
        in notifications::PerceivedSeverityList_T excludeSeverityList,
        in unsigned long how_many
        out notifications::EventList_T eventList,
        out notifications::EventIterator_I eventIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request all of the cleared and acknowledged alarms that are for the EMS itself. Some alarms may be filtered out (excluded) by specifying their severities.

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

Parameters

Name
Type
Input/Output
Description

excludeSeverityList

notifications::PerceivedSeverityList_T

In

List of alarm severities to exclude from the output event list

how_many

unsigned long

In

Maximum number of alarms to report in the first batch

EventList

notifications::EventList

Out

First batch of alarms

EventIt

notifications::EventIterator_I

Out

Iterator to retrieve the remaining alarms


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

CTM-defined.

3.2.19  emsMgr::EMSMgr_I::createServerTrailLink

Synopsis

void createServerTrailLink(
        in serverTrailLink::STLCreateData_T createData
        out serverTrailLink::ServerTrailLink_T serverTrailLink)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to create a ServerTrail link manually between two ManagedElements. CTM supports the ServerTrail link creation between ManagedElements belonging to the same multiLayer subnetwork. CTM generates an ObjectCreation Event notification when a new ServerTrail link is created.


Note STLCreateData_T is a CTM-defined data structure. TMF has proposed this structure and is included in the TMF 3.0 specifications.



Note CTM creates the serverTrail link between two CTPs even if there are no existing physical link connections in the network. This operation is supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600 SONET, ONS 15600 SDH, and ONS 15310.


Parameters

Name
Type
Input/Output
Description

createData

serverTrailLink::STLCreateData_T

In

Data structure containing details for creating a new serverTrail Link

serverTrailLink

serverTrailLink::ServerTrailLink_T

Out

Created serverTrailLink information


CTM support for STLCreateData_T structure is as follows:

string userLabel

Not supported. The value of this field is assigned to the name of the newly created ServerTrailLink.

boolean forceUniqueness

Not supported.

string owner

Not supported.

globaldefs::ConnectionDirection_T direction

CTM will support only CD_BI for bidirectional links.

transmissionParameters::LayerRate_T rate

Supported layer rates are:

LR_STS1_and_AU3_High_Order_VC3

LR_STS3c_and_AU4_VC4

LR_STS12c_and_VC4_4c

LR_STS24c_and_VC4_8c

LR_STS48c_and_VC4_16c

LR_STS192c_and_VC4_64c

globaldefs::NamingAttributes_T aEndCTP

Supported.

globaldefs::NamingAttributes_T zEndCTP

Supported.

globaldefs::NVSList_T additionalCreationInfo

Supported. The supported parameters are listed in the table below.

ManagedElement Type
Parameter Name
Supported Parameter Values

All ManagedElements which support ServerTrailLink

serverTrailLinkProtectionType

PREEMPTIBLE, UNPROTECTED, FULLY_PROTECTED

All ManagedElements which support ServerTrailLink

linkCost

Int, 1 - 2147483647

All ManagedElements which support ServerTrailLink

linkCount

Int, 1 - 1024


globaldefs::sSrlgGroupList_T srlgGroupListValue

Supported. This field holds the SRLG group values. This is an optional parameter you can include in the SRLG group during the Link creation. A maximum of five SRLG groups are supported for a given Link. SRLG groups are only supported for SONET/SDH serverTrailLinks.

CTM support for ServerTrailLink_T structure is as follows:

globaldefs::NamingAttributes_T name

Supported. This field will have two tuples. The first tuple is for EMS. The second one is for ServerTrailLink. The value in the second tuple is the same as the nativeEMSName field.

string userLabel

Not supported.

boolean forceUniqueness

Not supported

string owner

Not supported.

globaldefs::ConnectionDirection_T direction

CTM will support only CD_BI for bidirectional links.

transmissionParameters::LayerRate_T rate

Supported layer rates are:

LR_STS1_and_AU3_High_Order_VC3

LR_STS3c_and_AU4_VC4

LR_STS12c_and_VC4_4c

LR_STS24c_and_VC4_8c

LR_STS48c_and_VC4_16c

LR_STS192c_and_VC4_64c

globaldefs::NamingAttributes_T aEndTP

Supported. The CTP for the serverTrailLink aEnd.

globaldefs::NamingAttributes_T zEndTP

Supported. The CTP for the serverTrailLink zEnd.

globaldefs::NVSList_T additionalCreationInfo

Supported. The supported parameters are listed in the table below.

ManagedElement Type
Parameter Name
Supported Parameter Values

All ManagedElements which support ServerTrailLink

serverTrailLinkProtectionType

PREEMPTIBLE, UNPROTECTED, FULLY_PROTECTED

All ManagedElements which support ServerTrailLink

linkCost

int, 1 - 2147483647

All ManagedElements which support ServerTrailLink

linkCount

int, 1 - 1024


globaldefs::sSrlgGroupList_T srlgGroupListValue

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

Throws

globaldefs::ProcessingFailureException

EXCPT_INVALID_INPUT - Raised if input createData is not valid.

EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

CTM-defined.

3.2.20  emsMgr::EMSMgr_I::deleteServerTrailLink

Synopsis

void deleteServerTrailLink(
        in globaldefs::NamingAttributes_T serverTrailLinkName)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to delete a serverTrail Link manually between two ManagedElements. CTM throws the EXCPT_UNABLE_TO_COMPLY exception if the server trail link cannot be deleted in the current state. CTM generates an ObjectDeletion Event notification when a serverTrail link is deleted.

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

Parameters

Name
Type
Input/Output
Description

serverTrailLinkName

globaldefs::NamingAttributes_T

In

The name of the serverTrail link to be deleted


Throws

globaldefs::ProcessingFailureException

EXCPT_INVALID_INPUT - Raised if input serverTrail link name is invalid.

EXCPT_ENTITY_NOT_FOUND - Raised if the specified serverTrail link name does not exist in 
CTM.

EXCPT_NOT_IMPLEMENTED - Raised if EMS cannot support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete a serverTrail which cannot be 
deleted.

Compliance

CTM-defined.

3.2.21  emsMgr::EMSMgr_I::addManagedElement

Synopsis

void addManagedElement(
       in MEAdditionData_T neData) 
    raises(globaldefs::ProcessingFailureException);

Description

This operation enables the OSS to add a network element. All types of elements are supported except MGX and IOX.

Parameters

Name
Type
Input/Output
Description

neData

MEAdditionData_T

in

Input data needed for the addition of the Network Element


The structure of MEAdditionalData_T is as follows:

struct MEAdditionData_T
{
  MEModel model;
  string ipadd;
  string nwPartitionName;
  string multiLayerSubnetworkName;
  string neUsername;
  string nePasswd;
  string neLocationName;
  string neDescription;
  string snmpCommunityString;
  string neVendorName;
  boolean isGNE;
};

The description of each field is as follows:

Name
Type
Description

model

NEModel

NE model name

ipadd

string

The IP Address of the Network Element

nwPartitionName

string

The network partition name under which the NE is to be added

multiLayerSubnetworkName

string

The subnetwork name under which the NE is to be added

neUsername

string

Username

nePasswd

string

Password

neLocationName

string

Location

neDescription

string

Description

snmpCommunityString

string

SNMP community string

neVendorName

string

NE version name

isGNE

boolean

True if the NE is a GNE, false otherwise


enum MEModel{
   CISCO_ONS_15327, CISCO_ONS_15454, CISCO_ONS_15540_ESP, CISCO_ONS_15540_ESPx,
   CISCO_ONS_15530, CISCO_ONS_15501, CISCO_ONS_15800, CISCO_ONS_15801, CISCO_ONS_15808,
   CISCO_ONS_15454_SDH, CISCO_ONS_15216_EDFA2, CISCO_ONS_15216_OADM,
   CISCO_ONS_15216_DWDM_Filter, CISCO_ONS_15600, CISCO_ONS_15600_SDH, CISCO_ONS_15216_OSC,
   CISCO_ONS_15216_DCU, CISCO_ONS_15302, CISCO_ONS_15305, CISCO_ONS_15305_CTC, 
   CISCO_ONS_15216_FlexLayer, Not_Managed_Other_Vendor, CISCO_ONS_15216_EDFA3,
   CISCO_ONS_15310_CL, CISCO_CRS_1, CISCO_XR_12000, CISCO_CAT_6509, CISCO_ONS_15216_EDFA1,
   CISCO_MDS_9000, CISCO_MGX_8880_8850, CISCO_ONS_15310MA,
   CISCO_7600
};

Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.22  emsMgr::EMSMgr_I::addNetworkPartition

Synopsis

void addNetworkPartition(
        in string name, in string description) 
     raises(globaldefs::ProcessingFailureException);

Description

This API enables the OSS to add a new network partition.

Parameters

Name
Type
Input/Output
Description

name

string

In

Network partition name

description

string

In

Description for the new partition


Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.23  emsMgr::EMSMgr_I::addMultiLayerSubnetwork

Synopsis

void addMultiLayerSubnetwork(
        in MultiLayerSubnetworkData_T npData) 
     raises(globaldefs::ProcessingFailureException);

This API enables the OSS to add a new subnet partition.

Parameters

Name
Type
Input/Output
Description

npData

MultiLayerSubnetworkData_T

in

Subnet partition data


The structure for SubNetworkPartitionData_T is as follows:

struct MultiLayerSubnetworkData_T
  {
     string name;
     string title;
     string userLabel;
     SubNetType_T type; 
     SubnetToplogy_T topology;
     string npId;
};

The description of each parameter is as follows:

Name
Type
Description

name

string

New subnet partition name

title

string

Title

userLabel

string

User label

type

SubNetType_T

Subnet type (see the definition below)

topology

SubnetToplogy_T

Subnet topology (see the definition below)

npId

string

The network partition name under which the subnet is to be added


enum SubNetType_T{ SONET, SDH, OTHER, UNKNOWNSUBNETTYPE};
enum SubnetToplogy_T{OTHER_SUBNET_TYPE, POINT_TO_POINT, LINEAR, UPSR, SNC, BLSR, MSSP, 
OPEN_UPSR, OPEN_SNC, HYBRID, MESH, SINGLETON, UNKNOWN_SUBNET_TYPE};

Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.24  emsMgr::EMSMgr_I::deleteAndPurgeManagedElement

Synopsis

boolean deleteAndPurgeManagedElement(in string neName) 
     raises(globaldefs::ProcessingFailureException);

Description

This API enables the OSS to delete a NE.

Parameters

Name
Type
Input/Output
Description

neName

string

In

NE name that needs deletion


Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.25  emsMgr::EMSMgr_I::deleteNetworkPartition

Synopsis

void deleteNetworkPartition(in string name) 
     raises(globaldefs::ProcessingFailureException);

This API enables the OSS to delete an existing network partition.

Parameters

Name
Type
Input/Output
Description

name

string

In

Network partition name that needs to be deleted


Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.26  emsMgr::EMSMgr_I::deleteMultiLayerSubnetwork

Synopsis

void deleteMultiLayerSubnetwork(in string subnetworkName) 
     raises(globaldefs::ProcessingFailureException);

Description

This API enables the OSS to delete an existing network partition.

Parameters

Name
Type
Input/Output
Description

name

string

In

Subnet name that needs to be deleted


Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.27  emsMgr::EMSMgr_I::addSWVersion

Synopsis

void addSWVersion (in SoftwareVersionTable_T versionData) 
     raises(globaldefs::ProcessingFailureException);

Description

This API enables the OSS to add a new software version to the supported NE version table.

Parameters

Name
Type
Input/Output
Description

versionData

SoftwareVersionTable_T

In

The input details for the addition of a new software version


struct SoftwareVersionTable_T
  {
   NEModel model;
   string olderSWVersion;
   string newSWVersion;
   string versionName;
  };

Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.2.28  emsMgr::EMSMgr_I::getAllSupportedMESoftwareVersions

Synopsis

void getAllSupportedMESoftwareVersions(
        in unsigned long how_many, 
        out SupportedMESoftwareVersionList_T versionList,
        out SupportedMESoftwareVersionIterator_I versionIt) 
     raises(globaldefs::ProcessingFailureException);

Description

This API enables the OSS to add a new software version to the supported NE version table.

Parameters

Name
Type
Input/Output
Description

how_many

unsigned long

In

Maximum number of software versions to be reported in the first batch.

versionList

SupportedMESoftwareVersionList_T

Out

First batch of supported software versions. See the definition below.

versionIt

SupportedMESoftwareVersionIterator_I

Out

Iterator to retrieve the remaining software versions. See the definition below.


struct SupportedMESoftwareVersion_T
  {
    string model;
    string swversion;
    string versionName;
    };

typedef sequence<SupportedMESoftwareVersion_T> SupportedMESoftwareVersionList_T;
interface SupportedMESoftwareVersionIterator_I 
   {
      boolean next_n(in  unsigned long    how_many,
                     out SupportedMESoftwareVersionList_T neVersionList)
        raises (globaldefs::ProcessingFailureException);

      unsigned long getLength()
        raises(globaldefs::ProcessingFailureException);

      void destroy()
        raises(globaldefs::ProcessingFailureException);
   };

Throws

globaldefs::ProcessingFailureException

Compliance

CTM-defined.

3.3  emsSession::EmsSession_I

The emsSession module enables the client to query the EMS to determine the manager interfaces the EMS is supporting. The NMS retrieves an instance of the needed manager interface objects. This interface is inherited from session::Session_I.

interface EmsSession_I:session::Session_I

3.3.1  emsSession::EmsSession_I::getEventChannel

Synopsis

void getEventChannel(
        out CosNotifyChannelAdmin::EventChannel eventChannel)
     raises(globaldefs::ProcessingFailureException);

Description

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

Parameters

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 non-specific internal EMS failure.

Compliance

TMF-defined.

3.3.2  emsSession::EmsSession_I::getManager

Synopsis

void getManager(
        in string managerName,
        out common::Common_I managerInterface)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to access the specified manager interface.

Parameters

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 non-specific internal EMS failure.

Compliance

TMF-defined.

3.3.3  emsSession::EmsSession_I::getSupportedManagers

Synopsis

void getSupportedManagers(out managerNames_T supportedManagerList)
     raises(globaldefs::ProcessingFailureException);

Description

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

Parameters

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

Synopsis

void getEmsSession(in string user,
        in string password,
        in nmsSession::NmsSession_I client,
        out emsSession::EmsSession_I emsSessionInterface)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to obtain the EmsSession_I object, which contains all managers of the EMS.

CTM allows 4 to 25 concurrent login sessions and as many user profiles as required for configuring the number of concurrent login sessions. See B.8  Location of Naming Service IOR File, page B-6 for configuring the number of concurrent login sessions. The username and password must contain between 1 and 53 characters.

This operation can also accept the encrypted username and password. To enable encryption on the username and password, check the Enable encryption for username and password check box in the CTM client Control Panel for the CTM Gateway/CORBA service. CTM then decrypts the username and password accordingly.

To encrypt the username and password, you must use the RSA algorithm with the public key or the public key pair provided by CTM. To obtain the CTM public key, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey API. To obtain the CTM public key pair, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair API.

Parameters

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 - Raised in case of a non-specific internal EMS failure.

EXCPT_INVALID_INPUT - Raised when client is invalid or when the length of User name or 
Password passed is not within the permissible limits (1-53).

EXCPT_ACCESS_DENIED - Raised in the following cases:

When all the eight login sessions are used up.
When the user name specified does not exist.
Or in case of any other security violation.

Compliance

TMF-defined.

3.4.2  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey

Synopsis

void getEmsPublicKey(out string publicKey)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to obtain the string representation of the RSA public key encoded in the Base64 encoding scheme. The operation encrypts the username and password from the string representation of the RSA public key.

The OSS client must use the Base64 decoders to decode the public key and get the byte[] of the public key from the decoded public key string. The byte[] corresponding to the public key represents the key in its primary encoded format; in this case, X.509 SubjectPublicKeyInfo.

You can create the RSA public key using this byte array and cryptographic libraries. Use this key to encrypt the username and password. Bouncy Castle Provider is an example of a security provider that you can use to create the RSApublic key.

The public key is then used to encrypt the username and password. Before passing the encrypted password to CTM for login, the OSS client must encode the encrypted username and password using the Base64 encoder to get the string equivalent of the encrypted data.

Parameters

Name
Type
Input/Output
Description

publicKey

string

Out

The public key string returned by CTM.


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

Compliance

CTM-defined.

3.4.3  emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair

Synopsis

void getEmsPublicKeyPair(out string publicKeyModulus,
        out string publicKeyExponent)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to obtain the string representation of the RSA public key pair (in the modulus and exponent forms) from CTM for encrypting the username and password.

The OSS client must convert the string representation of the public key modulus and public key exponent into a nonnegative integer and create an RSA public key using cryptographic libraries. Crypto++ is one of the security providers available.

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

Parameters

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 - Raised in case of non-specific EMS internal failure.

Compliance

CTM-defined.

3.5  equipment::EquipmentInventoryMgr_I

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

interface EquipmentInventoryMgr_I:common::Common_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 enables an NMS to request all of the equipment and equipment holders contained in a managed element or equipment holder.

Parameters

Name
Type
Input/Output
Description

meOrHolderName

globaldefs::NamingAttributes_T

In

The 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

The first batch of EquipmentOrHolder_Ts

eqIt

EquipmentOrHolderIterator_I

Out

The iterator used to retrieve the remaining EquipmentOrHolder_Ts


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

CTM support forEquipment_T is as follows:

globaldefs::NamingAttributes_T name

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

string userLabel

Not supported.

string nativeEMSName

Supported. The naming convention is described in 2.2.5.6  Equipment, page 2-50.

string owner

Not supported.

boolean alarmReportingIndicator

Supported for ONS 15454 and ONS 15327 only.

ServiceState_T serviceState

Not supported.

EquipmentObjectType_T expectedEquipmentObjectType

ONS 15454 SONET—All values listed in Table 2-40 on page 2-60 are supported.

ONS 15454 SDH—All values listed in Table 2-39 on page 2-56 are supported.

ONS 15327—All values listed in Table 2-38 on page 2-56 are supported.

ONS 15600 SONET—All values listed in Table 2-41 on page 2-62 are supported.

ONS 15600 SDH—All values listed in Table 2-42 on page 2-63 are supported.

ONS 15310 CL—All values listed in Table 2-36 on page 2-55 are supported.

ONS 15800, ONS15801—All values listed in Table 2-43 on page 2-63 are supported.

ONS 15808—All values listed in Table 2-44 on page 2-65 are supported.

ONS 15302—All values listed in Table 2-33 on page 2-54 are supported.

ONS 15305 and ONS 15305 CTC—All values listed in Table 2-34 on page 2-54 are supported.

ONS 15540—All values listed in D.3  Equipment List for ONS 15540 ESP, page D-14 and D.4  Equipment List for ONS 15540 ESPx, page D-20 are supported.

ONS 15530—All values listed in D.2  Equipment List for ONS 15530, page D-1 are supported.

ONS 15501—All values listed in D.1  Equipment List for ONS 15501, page D-1 are supported.

ONS 15216—All values listed in 2.2.5.6.4  ONS 15216, page 2-53 are supported.

CRS-1 and XR 12000—All values listed in 2.2.5.6.1  CRS-1, page 2-50 and 2.2.5.6.20  XR 12000, page 2-68 are supported.

MGX 8880/8850/8830—All values listed in 2.2.5.6.3  MGX 8880/8850/8830, page 2-51 are supported.

EquipmentObjectType_T installedEquipmentObjectType

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

string installedPartNumber

Supported when equipment is installed.

string installedVersion

Supported when equipment is installed.

string installedSerialNumber

Supported when equipment is installed.

globaldefs::NVSList_T additionalInfo

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

CTM support for EquipmentHolder_T is as follows:

globaldefs::NamingAttributes_T name

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

string userLabel

Not supported.

string nativeEMSName

Supported. The naming convention is defined in 2.2.5.7  EquipmentHolder, page 2-69.

string owner

Not supported.

boolean alarmReportingIndicator

Not supported.

EquipmentHolderType_T holderType

Supported valid values are additionalHolder, "rack", "shelf", and "slot"

For ONS 15600, ONS 15310 CL, and ONS 15310 MA, valid values are "rack", "shelf", "slot", "subslot", and "ppm_holder"

For ONS 15540 and ONS 15530, valid values are "rack", "shelf", "slot", "subslot", and "ppm_holder"

For ONS 15454 SONET and ONS 15454 SDH, valid values are "rack", "shelf", "slot", "ppm_holder", and "port"

For ONS 15501 valid values are "rack" and "shelf"

For all Equipment supporting SFP modules, the valid values are "rack", "shelf", "slot", "sub_slot", and "port_holder"

For MGX 8880/8850/8830, valid values are "rack", "shelf", "slot", "subslot", and "peripheral_holder"

globaldefs::NamingAttributes_T expectedOrInstalledEquipment

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

EquipmentObjectTypeList_T acceptableEquipmentTypeList

Supported.

Not supported for ONS 15540, ONS 15530 and ONS 15501.

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 Release 3.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 Release 3.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 Release 3.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 Release 3.4 Slot Number
Acceptable Equipment

9

AICI


ONS 15454 Release 4.0 Slot Number
Acceptable Equipment

5, 6, 12, 13

G1000_4

(When XC10G 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 10)

5, 6, 12, 13

ML1000, ML100T

(Only when XCVT is installed in slot 8 or 10)


ONS 15454 Release 4.1 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

TXP_G1000_41

1 The same physical card as was supported in the previous release, but with a different software image.


ONS 15454 Release 4.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

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O1

8, 10

OSCM

1, 2, 4, 5, 6, 12, 13, 14, 16, 17

DS3I

3, 15

DS3I, DS3IN

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15454 Release 5.0 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, 2.5G SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, DS3XM_12, DS3_EC1_48, ML2_EXIGE, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O, WSS_32, DMX32_R1

8, 10

OSCM

7, 11

TCC2P

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15454 Release 5.0.1 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, 2.5G SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, DS3XM_12, DS3_EC1_48, ML2_EXIGE, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP, 2.5-10G_Muxponder, 10G_MR_Transponder, OPT_BST_E

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O, WSS_32, DMX32_R1

8, 10

OSCM

7, 11

TCC2P

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15454 Release 6.0 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, 2.5G SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, DS3XM_12, DS3_EC1_48, ML2_EXIGE, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP, DS1_E1_56, MRC_12,OPT_BST_E, 2.5-10G_Muxponder, 10G_MR_Transponder

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O, WSS_32, DMX32_R1

8, 10

OSCM, XCVXC, XCVXC25G

7, 11

TCC2P

5, 6, 12, 13

OC192_XFP

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Among the two subsequent slots, the first slot should be mentioned for provisioning these cards.


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 Release 3.4 Slot Number
Acceptable Equipment

9

AICI

1, 2, 3, 4, 14, 15, 16, 17

STM4_4


ONS 15454 SDH Release 4.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 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

G1000_41

1 Same physical card as supported in previous release but with different software image


ONS 15454 SDH Release 4.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

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O1

8, 10

OSCM

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15454 SDH Release 5.0 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O, WSS_32, DMX32_R1

8, 10

OSCM

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15454 SDH Release 5.0.1 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP, 2.5-10G_Muxponder, 10G_MR_Transponder, OPT_BST_E

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O, WSS_32, DMX32_R1

8, 10

OSCM

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15454 SDH Release 6.0 Slot Number
Acceptable Equipment

1, 2, 3, 4, 5, 6, 12, 13, 14, 15, 16, 17

FCMR, OSC_CSM, OPT_BST, OPT_PRE, MUX_DMX4, AD_1B, AD_1C, AD_2C, AD_4B, AD_4C, TXPP_MR_2.5G, TXP_MR_2.5G, SP-Datamux xx.xx, 2.5G UP-Datamux xx.xx, TXP_MR_10E, MXP_2.5G_10E, 2.5G_DM, 2.5G_DMP, MRC_12, OPT_BST_E, 2.5-10G_Muxponder, 10G_MR_Transponder

1, 2, 3, 4, 5, 12, 13, 14, 15, 16

MUX32_O, DMX32_O, WSS_32, DMX32_R1

8, 10

OSCM, XCVXC, XCVXC25G

5, 6, 12, 13

STM64_XFP

1, 2, 3, 4, 5, 13, 14, 15, 16, 17

DS1I

18, 19, 20, 21, 22, 30, 31, 32, 33, 34

FMEC_SMZ_DS1I

1 These cards occupy two slots, hence they can be provisioned only when the two subsequent slots are empty. Amount the two subsequent slots, the first slot should be mentioned for provisioning these cards.


ONS 15327 supports the following value for all releases:

ONS 15327 Slot Number
Acceptable Equipment

7, 8

MIC

5, 6

XTC

1, 2, 3, 4

ETH100, OC12, OC48


ONS 15327 Release 3.3 Slot Number
Acceptable Equipment

1, 2, 3, 4

OC3


ONS 15327 Release 3.4 Slot Number
Acceptable Equipment

1, 2, 3, 4

G1000_2


ONS 15800 Slot Number
Acceptable Equipment

151

CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S

13-142

LSM-W

163

IOC-W

17

SCF-W and BAT

1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12

For any other supported module, see 2.2.5.6.17  ONS 15800 and ONS 15801, page 2-63

1 This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see 2.2.5.6.17  ONS 15800 and ONS 15801, page 2-63) can be inserted into the slot.

2 Same as (1).

3 Same as (1).


ONS 15801 supports the following values

ONS 15801 Slot Number
Acceptable Equipment

131

CMP-W, CMP-W-S, CMP-W-2E, CMP-W-2E-S

11-12 (see (1) below)

LSM-W

14 (see (1) below)

IOC-W

15

SCF-W and BAT

1, 2, 3, 4, 5, 6, 7, 8, 9, 10

For any other supported module, see 2.2.5.6.17  ONS 15800 and ONS 15801, page 2-63

1 This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see 2.2.5.6.17  ONS 15800 and ONS 15801, page 2-63) can be inserted into the slot


ONS 15808 supports the following values

ONS 15808 Slot Number
Acceptable Equipment

131

CMP, CMP-S

11-121

OSCM

141

AIU

15

SCU and PL

1, 2, 3, 4, 5, 6, 7, 8, 9, 10

Any other supported module (see 2.2.5.6.18  ONS 15808, page 2-65)

1 This constraint applies if the shelf contains a module of the specified kind. If the shelf does not contain such a module, any other supported module (see 2.2.5.6.18  ONS 15808, page 2-65) can be inserted into the slot.


ONS 15302 supports the following values

ONS 15302 Slot Number
Acceptable Equipment

1

E1-12

2

S1.1-2-SC

3

E100-4

4

WAN-4 and WAN-1


ONS 15305 and ONS 15305 CTC support the following values:

ONS 15305 Slot Number
Acceptable Equipment

1, 2, 3, 4

All equipment listed in 2.2.5.6.6  ONS 15305 and ONS 15305 CTC, page 2-54


ONS 15216 supports the following values

ONS 15216 DCU Release 2.0 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 (ps/nm)

1, 2

DCU-1150 (1150 ps/nm)

1, 2

DCU-E-200 (200 ps/nm)

1, 2

DCU-E-350 (350 ps/nm)

1, 2

DCU-L-300 (300 ps/nm)

1, 2

DCU-L-600 (600 ps/nm)

1, 2

DCU-L-700 (700 ps/nm)

1, 2

DCU-L-800 (800 ps/nm)

1, 2

DCU-L-1000 (1000 ps/nm)

1, 2

DCU-L-1100 (1100 ps/nm)

1, 2

DCU-DS-L-100 (100 ps/nm)

1, 2

DCU-DS-L-200 (200 ps/nm)

1, 2

DCU-DS-L-300 (300 ps/nm)


ONS 15216 FlexLayer Slot Number
Acceptable Equipment

1, 2, 3, 4

FLA-8-<Channel ID>

Channel ID = 36.6, 44.5, 52.5, 60.6

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 15600 support the following values:

ONS 15600 V1.1 and ONS 15600 V1.3 Slot Number
Acceptable Equipment

5, 10

TXC

6/7, 8/9

CXC

1, 2, 3, 4, 11, 12, 13, 14

OC48_16, OC192_4


ONS 15600 V5.0 Slot Number
Acceptable Equipment

5, 10

TXC

6/7, 8/9

SSXC [new cross-connect card]

1, 2, 3, 4, 11, 12, 13, 14

OC48_16, OC192_4, OC48_32

1, 2, 3, 4, 11, 12, 13, 14

ASAP


ONS 15600 SDH V1.4 Slot Number
Acceptable Equipment

5, 10

TXC

6/7, 8/9

CXC

1, 2, 3, 4, 11, 12, 13, 14

STM16_16, STM64_4


ONS 15310 MA Release 7.2 Slot Number
Acceptable Equipment

3, 4

CTX-2500 and CTX-FILLER

1, 2, 5, 6

DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3, and DS3-EC-6

1, 2, 5, 6

CE-100T-8, ML2-100T-8, and EXP-FILLER


Compliance

TMF-defined.

3.5.2  equipment::EquipmentInventoryMgr_I::getAllEquipmentNames

Synopsis

void getAllEquipmentNames(in globaldefs::NamingAttributes_T meOrHolderName,
        in unsigned long how_many,
        out globaldefs::NamingAttributesList_T nameList,
        out globaldefs::NamingAttributesIterator_I nameIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation has exactly the same behavior as the operation described in equipment::EquipmentInventoryMgr_I::getAllEquipment, but returns the object names instead of returning the entire object.

Parameters

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 - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when meOrHolderName does not reference a managed element or 
an equipment holder.

EXCPT_ENTITY_NOT_FOUND - Raised when managedElementOrEquipmentName references object which 
does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.5.3  equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs

Synopsis

void getAllSupportedPTPs(
        in globaldefs::NamingAttributes_T equipmentName,
        in unsigned long how_many,
        out terminationPoint::TerminationPointList_T tpList,
        out terminationPoint::TerminationPointIterator_I tpIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request the PTPs that are directly supported by specific equipment. The PTPs that are returned are those that share their physical layer with the primary equipment (that is, they represent a port on the equipment or are connected by a fiber, wire, and so on).

If the equipment is protection equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the supported PTPs.

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

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

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

ONS 15800, ONS 15801, and ONS 15808: CTM returns all the supported PTPs for specific ONS 158xx equipment.

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

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

ONS 15501: CTM returns In-Port and Out-Port.

ONS 15216: CTM returns all the supported PTPs for ONS 15216, if there is a topological link associated with the NE.

ONS 15600 SONET: CTM returns OC-N ports.

ONS 15600 SDH: CTM returns STM-N ports.

ONS 15302, ONS15305, and ONS15305 CTC: CTM returns WAN, SDH, and PDH ports.

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

CRS-1 and XR 12000: CTM returns the line cards ports (POS, POS/SDH, and GE).

MGX 8880/8850/8830: CTM returns the physical service module cards ports (DS1, DS3, and SONET/SDH).

Parameters

Name
Type
Input/Output
Description

equipmentName

globaldefs::NamingAttributes_T

In

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

tpList

terminationPoint::TerminationPointList_T

Out

The first batch of PTPs

tpIt

terminationPoint::TerminationPointIterator_I

Out

The iterator used to retrieve the remaining PTPs


CTM support for TerminationPoint_T structure is as follows:

globaldefs::NamingAttributes_T name

Supported. This field contains three tuples for PTP and four tuples for CTP as defined by the TMF. The third tuple contains positional information for the PTP. The naming convention is described in 2.2.5.3  Physical Termination Point, page 2-44, 2.2.5.4  Connection Termination Point, page 2-45, and 2.2.5.5  Floating Termination Point, page 2-50.

string userLabel

Not supported.

string nativeEMSName

Supported.

string owner

Not supported.

globaldefs::NamingAttributes_T ingressTrafficDescriptorName

Not supported.

globaldefs::NamingAttributes_T egressTrafficDescriptorName

Not supported.

TPType_T type

Supported. CTM supports TPT_PTP, TPT_CTP, and TPT_FTP.

TPConnectionState_T connectionState

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

TerminationMode_T tpMappingMode

Not supported.

Directionality_T direction

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

transmissionParameters::LayeredParameterList_T transmissionParams

Supported. Layer rate is supported for PTP, CTP, and FTP.

CTM supports the following parameters for PTP

Parameter
TP Type
NE Type
Valid Value
Supporting Equipment and Restriction

AlarmReporting

PTP

ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600, ONS 15600 SDH, ONS 15310 CL, ONS 15310 MA

On, Off

All equipment, except equipment that does not have PTP, such as XC, XCVT, TCC2, CXC, and so on.

ServiceState

PTP

ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600, ONS 15600 SDH, ONS 15310 CL, ONS 15310 MA

All equipment (except ML100T, ML1000, FCMR, ML2_L2L3, ML2_MAPPER, CE-100T-8 and equipment that does not have PTP, such as XC, XCVT, TCC2, an so on).

AdminState

PTP

ONS 15327, ONS 15454 SONET, ONS 15310 CL, ONS 15310 MA

IN_SERVICE, OUT_OF_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE (for NE Release 3.4.1 or later), AUTO_IN_SERVICE (for NE Release 3.4.1 or later)

Down, Up

All equipment (except ML100T, ML1000, and equipment that does not have PTP, such as XC, XCVT, TCC2, an so on). G1000_4, G1000_2, and FCMR do not support the AUTO_IN_SERVICE value.

Down and Up are valid values shown for ML-series cards (ML100T, ML1000, and ML-FX).

For CE-series and E-series Ethernet cards, valid values are In Service, Auto In Service, Out of Service, and Out of Service by Maintenance.

SERV_NA is not a valid value for any card.

ONS 15600

IN_SERVICE, OUT_OF_SERVICE_BY_MAINTENANCE, OUT_OF_SERVICE (for NE 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, ONS 15600 SDH

UNLOCKED, LOCKED, DISABLED, LOCKED, MAINTENANCE and UNLOCKED, AUTO_IN_SERVICE

All equipment (except ML100T, ML1000, and equipment that does not have PTP, such as XC, XCVT, TCC2, CXC an so on) FCMR does not support UNLOCKED, AUTO_IN_SERVICE value.

LOCKED, DISABLED and UNLOCKED, AUTO IN SERVICE are not supported by the ONS 15600 SDH.

LineCode

PTP

ONS 15327, ONS 15310 CL, ONS 15310 MA

ami, b8zs

DS1 port on XTC card and CTX card.

ONS 15454 SONET

ami, b8zs

DS1, DS1N.

ONS 15454 SONET, ONS15310CL, ONS 15310 MA

b3zs

DS3E, DS3NE, DS3XM, DS3I, DS3IN, DS3, DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3.

ONS 15454 SDH

hdb3

E1, E1N, E1_42.

ONS 15454 SDH

b3zs

DS3I, DS31N.

FrameFormat

PTP

ONS 15327, ONS 15310 CL, ONS 15310 MA

esf, d4, unframed, auto provision fmt (Only on 310)

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, DS3.

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 15310 CL, ONS 15310 MA

m13, cbit, unframed

DS3 port on CTX card.

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 15327, ONS 15454 SONET, ONS 15600, ONS 15310 CL, ONS 15310 MA

On, Off

OCn Equipment.

ONS 15600 SDH, ONS 15454 SDH

On, Off

STMn Equipment.

ALSMode

PTP

ONS 15454 SONET

DISABLED, AUTO, MANUAL, MANUAL_RESTART_FOR_TEST

OC3_8, OC48 ELR, OC192 Equipment only.

ONS 15454 SDH

DISABLED, AUTO, MANUAL, MANUAL_RESTART_FOR_TEST

STM1_8, STM16 ELR, STM64 Equipment only.

PulseWidth

PTP

ONS 15454 SONET

Float value between 2.0 and 100.0

OC3_8, OC48 ELR, OC192 Equipment only.

ONS 15454 SDH

Float value between 2.0 and 100.0

STM1_8, STM16 ELR, STM64 Equipment only.

RecoveryInterval

PTP

ONS 15454 SONET

Integer value between 100 and 300

OC3_8, OC48 ELR, OC192 Equipment only.

ONS 15454 SDH

Integer value between 100 and 300

STM1_8, STM16 ELR, STM64 Equipment only.

HasLaserBeenShutdown

PTP

ONS 15454 SONET

True, False (read-only value)

OC3_8, OC48 ELR, OC192 Equipment only.

ONS 15454 SDH

True, False (read-only value)

STM1_8, STM16 ELR, STM64 Equipment only.

RestartLaser

PTP

ONS 15454 SONET

True, False (read-only value)

OC3_8, OC48 ELR, OC192 Equipment only.

ONS 15454 SDH

True, False (read-only value)

STM1_8, STM16 ELR, STM64 Equipment only.

IPPMMonitor

CTP

ONS 15327, ONS 15454 SONET, ONS 15600, ONS 15600 SDH, ONS 15310 CL, ONS 15310 MA

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 15327, ONS 15310 CL, ONS 15310 MA

Free-format string

OC3.

ONS 15454 SONET

Free-format string

DS3E, DS3NE, DS3I, DS3IN, DS3XM, EC1, OC3, OC3_8, OC12_4, OC48AS, OC192.

ONS 15454 SDH

Free-format string

E3, DS3I, DS3IN, STM1E_12, OC3, OC3_8, OC12_4, OC48AS, OC192

ONS 15600, ONS 15600 SDH

Free-format string

OC48_16, OC192_4.

FTP

ONS 15327

Free-format string

G1000_2.

ONS 15310 CL, ONS 15310 MA

Free-format string

ML2_MAPPER and ML2_L2L3.

ONS 15454 SONET, ONS 15454 SDH

Free-format string

G1000_4, ML100T, ML1000, and CE-100T-8.

TrailTraceMonitor

CTP

ONS 15327, ONS 15310 CL, ONS 15310 MA

On, Off

OC3.

ONS 15454 SONET

On, Off

DS3E, DS3NE, DS3I, DS3IN, DS3XM, EC1, OC3, OC3_8, OC12_4, OC48AS, OC192.

ONS 15454 SDH

On, Off

E3, DS3I, DS3IN, STM1E_12, OC3, OC3_8, OC12_4, OC48AS, OC192.

ONS 15600, ONS 15600 SDH

On, Off

OC48_16, OC192_4.

FTP

ONS 15327

On, Off

G1000_2.

ONS 15310 CL, ONS 15310 MA

On, Off

ML2_L2L3 and ML2_MAPPER.

ONS 15454 SONET, ONS 15454 SDH

On, Off

G1000_4, ML100T, ML1000, and CE-100T-8.

XCLoopBack

CTP

ONS 15327 SONET, ONS 15454 SONET, ONS 15600 SONET, 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, ONS 15454 SDH

UNDEFINED, FibreChannel-1Gbps, FibreChannel-2Gbps, FICON-1Gbps, and FICON-2Gbps

FCMR (For NE Release 5.0 and later software).

Link Recovery

PTP

ONS 15454 SONET, ONS 15454 SDH

On, Off

FCMR (For NE Release 5.0 and later software).

No. of Superblocks

PTP

ONS 15454 SONET, ONS 15454 SDH

Between 4 and 32

FCMR (For NE Release 5.0 and later software).

Enable Distance Extension

PTP

ONS 15454 SONET, ONS 15454 SDH

On, Off

FCMR (Only in distance extension mode and for NE Release 5.0 and later software).

Auto Detect Credits

PTP

ONS 15454 SONET, ONS 15454 SDH

On, Off

FCMR (Only in distance extension mode and for NE Release 5.0 and later software).

Number Credits

PTP

ONS 15454 SONET, 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 software).

Autoadjust GFP Buffer Threshold

PTP

ONS 15454 SONET, ONS 15454 SDH

On, Off

FCMR (Only in distance extension mode and for NE Release 5.0 and later software).

GFP Buffers Available

PTP

ONS 15454 SONET, 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 software).

Ingress Idle Filtering

PTP

ONS 15454 SONET, ONS 15454 SDH

On, Off

FCMR (Only in distance extension mode and for NE Release 5.0 and later software).

MaxFrameSize

PTP

ONS 15454

Between 2148 and 2172

FCMR (Only in distance extension mode).

FrameFormat

CTP

ONS 15454

Auto provision fmt, esf, d4, and unframed

DS3XM_12.

FDLMode

CTP

ONS 15454

TL403 and BFDL

DS3XM_12.

DetectedLineType

PTP

ONS 15454

Read-only value

DS3E.



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. For CTP and FTP, the value must be False.

globaldefs::NVSList_T additionalInfo

Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.5.4  equipment::EquipmentInventoryMgr_I::getAllSupportedPTPNames

Synopsis

void getAllSupportedPTPNames(
        in globaldefs::NamingAttributes_T equipmentName,
        in unsigned long how_many,
        out globaldefs::NamingAttributesList_T nameList,
        out globaldefs::NamingAttributesIterator_I nameIt)
    raises(globaldefs::ProcessingFailureException);

Description

This operation has exactly the same behavior as the operation described in equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs, but returns the object names instead of returning the entire objects.

Parameters

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 - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators (128) has been 
reached.

Compliance

TMF-defined.

3.5.5  equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment

Synopsis

void getAllSupportingEquipment(
        in globaldefs::NamingAttributes_T ptpName,
        out EquipmentOrHolderList_T eqList)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request the equipment that contains this PTP.

Parameters

Name
Type
Input/Output
Description

ptpName

globaldefs::NamingAttributes_T

In

The name of the PTP for which to retrieve supporting equipment

eqList

EquipmentOrHolderList_T

Out

The list of equipment (not equipment holders) that directly implements the PTP


EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For further details on both structures, see equipment::EquipmentInventoryMgr_I::getAllEquipment.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.5.6  equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment
Names

Synopsis

void getAllSupportingEquipmentNames(
        in globaldefs::NamingAttributes_T ptpName,
        out globaldefs::NamingAttributesList_T nameList)
     raises(globaldefs::ProcessingFailureException);

Description

This operation has exactly the same behavior as the operation described in equipment::EquipmentInventoryMgr_I::getAllSupportingEquipment, but returns the object names instead of returning the entire objects.

Parameters

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 - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object.

EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.5.7  equipment::EquipmentInventoryMgr_I::getContainedEquipment

Synopsis

void getContainedEquipment(
        in globaldefs::NamingAttributes_T equipmentHolderName,
        out EquipmentOrHolderList_T equipmentOrHolderList)
     raises(globaldefs::ProcessingFailureException);

Description

This operation returns the equipment and equipment holders that a specific equipment holder contains. This operation differs from getAllEquipment in that it looks only at the next level of the containment hierarchy.

Parameters

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

The directly contained equipment and equipment holders.


EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For further details on both structures, see equipment::EquipmentInventoryMgr_I::getAllEquipment.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when equipmentHolderName does not reference an equipment 
holder object.

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolderName references an equipment holder 
that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

Compliance

TMF-defined.

3.5.8  equipment::EquipmentInventoryMgr_I::getEquipment

Synopsis

void getEquipment(in globaldefs::NamingAttributes_T equipmentOrHolderName,
        out EquipmentOrHolder_T equip)
     raises(globaldefs::ProcessingFailureException);

Description

This service returns the equipment or equipment holder for specific equipment or equipment holder name.

Parameters

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 non-specific EMS internal failure.

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

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

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.5.9  equipment::EquipmentInventoryMgr_I::provisionEquipment

Synopsis

void provisionEquipment(
        in EQTCreateData_T equipmentCreateData,
        out Equipment_T createdEquipment)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to permanently provision a piece of equipment in an equipment holder in an ME. The result of this operation is the creation of the equipment object and all its related objects, such as TPs. The resulting object is returned.

The equipment holder that contains the equipment must exist. The equipment object can already exist, but the equipment holder must not have expected equipment already provisioned.

If the equipment is provisioned successfully, CTM generates a StateChangeEvent on the holder state change and an ObjectCreationEvent for the equipment, and pushes them to the event channel.

It is important to note that Cisco ONS 15454 SONET detects new equipment and provisions it automatically, provided that the equipment holder (slot) is empty and not preprovisioned for another module type.

The equipment must be from the acceptableEquipmentTypeList of the slots. If these slots are selected to provision any other type of card, CTM returns the EXCPT_UNABLE_TO_COMPLY exception.

PPMs and PIMs can also be provisioned using this interface.

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

In ONS 15600 SONET and ONS 15600 SDH, each CXC or SSXC card occupies two slots (slots 6 and 7 or slots 8 and 9), and the NMS can specify any one of the slots to provision a CXC or SSXC card.

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

Parameters

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 support for EQTCreateData_T structure is as follows:

string userLabel

Not supported.

boolean forceUniqueness

Not supported.

string owner

Not supported.

EquipmentObjectType_T expectedEquipmentObjectType

This parameter must take one of the values for equipment described in equipment::EquipmentInventoryMgr_I::getAllEquipment.

globaldefs::NamingAttributes_T equipmentHolderName

Supported.

globaldefs::NVSList_T additionalInfo

Not supported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_OBJECT_IN_USE - Raised when the equipment holder already has an expected equipment.

EXCPT_INVALID_INPUT - Raised when equipmentHolder does not reference an equipmentHolder 
object.
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolder references an object that does not 
exist.

EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be created at the NE.

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.5.10  equipment::EquipmentInventoryMgr_I::setAlarmReportingOff

Synopsis

void setAlarmReportingOff(
        in globaldefs::NamingAttributes_T equipmentOrHolderName)
     raises(globaldefs::ProcessingFailureException);

Description

This operation disables alarm reporting on a piece of equipment. The CTM sends a warning alarm notification if successful.

This operation is supported for ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, ONS 15310 MA, and ONS 15310 CL.

Parameters

Name
Type
Input/Output
Description

equipmentOrHolderName

Globaldefs::NamingAttributes_T

In

The equipment on which to deactivate alarm reporting


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

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

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does 
not exist.

EXCPT_UNABLE_TO_COMPLY - Raised when alarm reporting cannot be disabled for the equipment 
or holder.

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.5.11  equipment::EquipmentInventoryMgr_I::setAlarmReportingOn

Synopsis

void setAlarmReportingOn(
        in globaldefs::NamingAttributes_T equipmentOrHolderName)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables alarm reporting on a piece of equipment.

The default setting for alarmReporting is "on." If the alarmReporting status is off, it indicates that a warning alarm has been raised for it. CTM generates a cleared warning alarm if successful.

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

Parameters

Name
Type
Input/Output
Description

equipmentOrHolderName

globaldefs::NamingAttributes_T

In

The equipment on which to activate alarm reporting


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Rraised when equipmentOrHolderName does not reference an equipment 
or holder.

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does 
not exist.

EXCPT_UNABLE_TO_COMPLY - Raised when alarm reporting cannot be disabled for the equipment 
or holder.

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.5.12  equipment::EquipmentInventoryMgr_I::unprovisionEquipment

Synopsis

void unprovisionEquipment(
        in globaldefs::NamingAttributes_T equipmentName)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to permanently unprovision equipment from the managed element. The successful result of this operation is the potential deletion of the equipment object and all its related objects, such as termination points.

ONS 15454 SONET does not allow a user to unprovision a piece of equipment that is in use (SNC is created on this equipment). However, if the equipment is present in the slot and not in use, it can be unprovisioned. If the equipment is not physically removed from the slot and new equipment is not provisioned in the same slot, the NE redetects the equipment in approximately one minute. If the equipment is not physically removed from the slot and new equipment of a different type is provisioned in the same slot, the NE generates an equipment mismatch alarm.

If the equipment is unprovisioned successfully, CTM generates a StateChangeEvent on the holder state change and an ObjectDeletionEvent for the equipment, and pushes them to the event channel.

ONS 15454 reserves Slot 7 and 11 for TCC. One of these slots will have an IN SERVICE TCC card. If the NMS invokes unprovisionEquipment on this equipment, CTM throws the EXCPT_UNABLE_TO_COMPLY exception.

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

Parameters

Name
Type
Input/Output
Description

equipmentName

globaldefs::NamingAttributes_T

In

The name of the equipment to be unprovisioned


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.

EXCPT_OBJECT_IN_USE - Deletion is rejected because equipment resources are in use.

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not 
exist.

EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be unprovisioned at the NE.

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.5.13  equipment::EquipmentInventoryMgr_I::configureMLParameters

Synopsis

void configureMLParameters(
        in globaldefs::NamingAttributes_T equipmentOrHolderName,
        in globaldefs::NVSList_T paramList
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables provisioning of fast Ethernet and POS configuration parameters on the ML cards. The operation is performed on a best-effort basis and CTM will not validate the parameter names and the values being passed to the API.

If the operation is unsuccessful, CTM throws a ProcessingFailureException.

This operation enables the user to configure the following POS parameters:

Interface state: This feature denotes the administration state of the POS interface. The valid values are "shut" and "no shut."

MTU size: This attribute configures the maximum transport unit of the Ethernet packets. The valid range for MTU size is from 64 to 9000. The default MTU is 1500.

Framing type: This feature indicates the Layer 2 encapsulation format. It can be either the high-level data link control (HDLC) or Point-to-Point Protocol (PPP).


Note Framing type can only be configured on 15310 Elise cards.


CoS Accounting: When enabled, this feature allows the L2 CoS to initiate the counting packets on an interface. This CoS accounting feature can be enabled or disabled.

All POS parameters can be configured for all POS ports.

CTM GateWay/CORBA enables users to provision the following parameters on the Fast Ethernet ports:

Interface state: This feature denotes the administration state of the fast ethernet ports. The valid values are "shut" and "no shut."

MTU size: This attribute configures the maximum transport units of the Ethernet packets. The valid range for MTU size is from 64 to 9000. The default MTU is 1500.

Speed: This feature configures the speed operation. The only permissible value is "auto." Setting this value to "auto" will enable the automatic speed configuration.

Duplex: This feature must be set to "auto" for ML1000T cards. ML100T cards support the following options:

auto: Enable autoduplex configuration

full: Force full-duplex operation

half: Force half-duplex operation

Flow control: The flow control must be performed on the send packets. The valid values are:

desired: Allow, but do not require flow-control packets on port

off: Disable flow-control packets on port

on: Enable flow-control packets on port (works only with policing)


Note Bandwidth and delay cannot be configured from CTM GateWay/CORBA.


This operation is supported only on ML cards.

Parameters

Name
Type
Input/Output
Description

equipmentOrHolderName

globaldefs::NamingAttributes_T

in

The name of the equipment holder for the ML card

paramList

globaldefs::NVSList_T

in

Parameter list in name/value pair. For example, to set MTU size to 64: name=MTU size and valud=64.


Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure

EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference a valid object

EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does 
not exist

EXCPT_NE_COMM_LOSS - Raised when communications to the managed element is lost

EXCPT_UNABLE_TO_COMPLY - Raised when CTM fails to configure the ML card parameters as 
requested.

Compliance

CTM-defined.

3.6  maintenanceOps::MaintenanceManager_I

MaintenanceMgr_I is used as a handle to gain access to the maintenance operation. A handle to an instance of this interface is gained through the getManager operation in emsSession.

interface MaintenanceMgr_I:common::Common_I

This interface also implements the getCapabilities method. Operations described in the following subsections are returned to the NMS when it invokes getCapabilities.

3.6.1  maintenanceOps::MaintenanceMgr_I::getActiveMaintenanceOperations

Synopsis

void getActiveMaintenanceOperations(
        in globaldefs::NamingAttributes_T tpOrMeName,
        in unsigned long how_many,
        out CurrentMaintenanceOperationList_T 
            currentMaintenanceOpeationList,
        out CurrentMaintenanceOperationIterator_I cmoIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to query the EMS to determine if any persistent maintenance commands have been invoked. This query is supported for the PTP, CTP, or ME object.

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

Parameters

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 support for CurrentMaintenanceOperation structure is as follows:

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 - Raised if EMS does not support this service.

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when tpOrMeName does not reference a valid object.

EXCPT_ENTITY_NOT_FOUND - Raised when tpOrMeName references an object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communication to the ME is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.6.2  maintenanceOps::MaintenanceMgr_I::performMaintenanceOperation

Synopsis

void performMaintenanceOperation(
        in CurrentMaintenanceOperation_T maintenanceOperation,
        in MaintenanceOperationMode_T maintenanceOperationMode)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables the NMS to operate and release the maintenance commands that are supported by a TP.

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

ONS 15310 CL and ONS 15310 MA

CTM supports only terminal and facility loopback operations for electrical and OCn PTPs.

CTM does not support loopback operations for CTPs.

ONS 15327 SONET

CTM supports only terminal and facility loopback operations for DSn and OCn PTPs.

CTM does not support loopback operations for CTPs.

For NE Release 3.4 or later of the ONS 15327 SONET, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.

ONS 15454 SDH

CTM supports only terminal and facility loopback operations for PTPs.

CTM does not support loopback operations for CTPs.

For NE Release 3.4 or later of the ONS 15454, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.

ONS 15454 SONET

CTM supports only terminal and facility loopback operations for DSn, OCn, EC1, 10G-transponder, 10G-muxponder, and G1000_4 (NE release 4.1 and later) PTPs.

Only facility loopback is supported for DS1 CTPs on DX3XM cards.

Only terminal loopback is supported on G1000_4 for NE releases earlier than R4.1.

For NE Release 3.4 or later of the ONS 15454 SONET, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.

ONS 15600 SDH

CTM supports only terminal and facility loopback operations for PTPs.

CTM does not support loopback operations for CTPs.

Loopback is supported only in the Out of Service-Maintenance state of the PTP.

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

ONS 15600 SONET

CTM supports only facility and payload loopback operations for PTPs.

CTM does not support loopback operations for CTPs.

Loopback is supported only in the Out of Service-Maintenance state of the PTP.

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

Parameters

Name
Type
Input/Output
Description

maintenanceOperation

CurrentMaintenanceOperation_T

In

Information on the maintenance operation to perform. This structure contains the field maintenance operation. 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 support for CurrentMaintenanceOperation_T structure is as follows:

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 - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when tpName does not reference a TP.

EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist.

EXCPT_UNABLE_TO_COMPLY - Raised when the operation is denied by the ME.

EXCPT_NE_COMM_LOSS - Raised when communication to managedElement is lost.

Compliance

TMF-defined.

3.7  managedElementManager::ManagedElementManager_I

This interface accesses operations that deal with MEs and TPs. A handle to an instance of this interface is gained through the getManager operation in emsSession.

interface ManagedElementManager_I:common::Common_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 enables an NMS to request all active alarms for the specified ME, excluding alarms that the ME does not report to CTM. Some alarms can be filtered out (excluded) by specifying their probable causes or severities.

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

ONS 15454 SONET, ONS 15454 SDH, ONS 15327, ONS 15600, ONS 15600 SDH, and ONS 15310 CL

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

ONS 15540, ONS 15530, and ONS 15501

TCAs are also reported in the eventList returned by this method as ONS 15540, ONS 15530, and ONS 15501 send "clear" for the threshold crossing alarms.

ONS 15800, ONS 15801, and ONS 15808

ONS 15800, ONS 15801, and ONS 15808 alarms that are retrieved using CTM GateWay/CORBA have OT_EQUIPMENT as the object_type field.

Parameters

Name
Type
Input/Output
Description

meName

globaldefs::NamingAttributes_T

In

Name of the ME for which to retrieve alarms

excludeProbCauseList

notifications::ProbableCauseList_T

In

List of probable causes to exclude (for which events 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 - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when meName does not reference a managed element object or 
excludeProbCauseList contains undefined values.

EXCPT_ENTITY_NOT_FOUND - Raised when meName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.7.2  managedElementManager::ManagedElementManager_I::getAllSNCs

Synopsis

void getAllSNCs(
        in globaldefs::NamingAttributes_T managedElementName,
        in transmissionParameters::LayerRateList_T connectionRateList,
         in unsigned long how_many,
         out subnetworkConnection::SubnetworkConnectionList_T sncList,
         out subnetworkConnection::SNCIterator_I sncIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation enables an NMS to request all SNCs that originate on, terminate on, or transit through a given ME.

For the ONS 15454 SONET NE, this method will not report STS1 SNC on DS1 equipment.

For the ONS 15454 SDH NE, this method will not report VC4 SNC on E1, E1_42 equipment.

For the ONS 15327 SONET NE, this method will not report STS1 SNC on XTC using DS1 ports.

For the ONS 15310 CL SONET NE, this method will not report STS1 SNC on CTX using DS1 ports.

This method will not report VCAT SNCs.

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

Parameters

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

First batch of SNCs.

sncIt

subnetworkConnection::SNCIterator_I

Out

Iterator to retrieve the remaining SNCs.


CTM support for SubnetworkConnection_T structure is 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. Name supplied by the user at creation time is reported.

string owner

Not supported.

SNCState_T sncState

CTM will support 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 the SNC goes into SNCS_ACTIVE state, a State Change Event is generated (see A.4.4  State Change Event, page A-7). 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 will 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 an SNC on Ethernet Equipment, CTM reports all associated VLAN IDs. For a WDM SNC, the sncSize is reported.

Throws

globaldefs::ProcessingFailureException

EXCPT_INTERNAL_ERROR - Raised in case of non-specific EMS internal failure.

EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element.

EXCPT_ENTITY_NOT_FOUND - Raised when meName references an ME object that does not exist.

EXCPT_NE_COMM_LOSS - Raised when communications to managedElement is lost.

Compliance

CTM-defined.

3.7.3  managedElementManager::ManagedElementManager_I::
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 enables 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 support for ManagedElement_T structure is as follows:

globaldefs::NamingAttributes_T name

Supported.

string userLabel

Not supported.

string nativeEMSName

Supported. The name is reported by the NE.

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 will support the following layer rates:

ONS 15454 SONET, ONS 15327, and ONS 15310 CL

LR_T1_and_DS1_1_5M

LR_T3_and_DS3_45M

LR_VT1_5_and_TU11_VC11

LR_STS1_and_AU3_High_Order_VC3

LR_STS3c_and_AU4_VC4

LR_STS6c_and_VC4_2c

LR_STS12c_and_VC4_4c

LR_STS48c_and_VC4_16c

LR_STS192c_and_VC4_64c (Supported on ONS 15454 Release 3.1 or later)

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

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

ONS 15454 SDH

LR_E1_2M (Supported on ONS 15454 SDH Release 4.0 or later)

LR_E3_34M (Supported on ONS 15454 SDH Release 4.0 or later)

LR_T3_and_DS3_45M (Supported on ONS 15454 SDH Release 4.0 or later)

LR_VT2_and_TU12_VC12 (Supported on ONS 15454 SDH Release 4.0 or later)

LR_Low_Order_TU3_VC3 (Supported on ONS 15454 SDH Release 4.0 or later)

LR_STS3c_and_AU4_VC4

LR_STS12c_and_VC4_4c

LR_STS48c_and_VC4_16c

LR_STS192c_and_VC4_64c

LR_STS6c_and_VC4_2c

LR_STS9c_and_VC4_3c

LR_STS24c_and_VC4_8c

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

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

ONS15540

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

ONS15530

All layer rates supported by the ONS15540

LR_PHYSICAL_ELECTRICAL

ONS15501

LR_Optical_Channel

LR_Optical_Multiplex_Section

LR_Optical_Transmission_Section

LR_PHYSICAL_OPTICAL

ONS15216

LR_PHYSICAL_OPTICAL

ONS 15600 SONET and ONS 15600 SDH

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.

Storage (MDS 9000) NE

Not supported.

globaldefs::NVSList_T additionalInfo

Supported. Two parameters is sent in this field:

A name/value pair for IP address with the name "IPAddress."

A name/value pair for operational state with the name "OperationalState," containing the 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 - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.7.4  managedElementManager::ManagedElementManager_I::
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 managedElementManager::ManagedElementManager_I:: getAllManagedElements, 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 - Raised in case of non-specific EMS internal failure.

EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when maximum number of iterators has reached 128.

Compliance

TMF-defined.

3.7.5  managedElementManager::ManagedElementManager_I::getAllPTPs

Synopsis

void getAllPTPs(
        in globaldefs::NamingAttributes_T managedElementName,
        in transmissionParameters::LayerRateList_T tpLayerRateList,
        in transmissionParameters::LayerRateList_T connectionLayerRateList,
        in unsigned long how_many,
        out terminationPoint::TerminationPointList_T tpList,
        out terminationPoint::TerminationPointIterator_I tpIt)
     raises(globaldefs::ProcessingFailureException);

Description

This operation allows an NMS to request all PTPs on a specific ME that contain one or more NMS-specified PTP layer rates, and that are capable of supporting one or more NMS-specified connection layer rates. If no PTPs match the layer constraints, an empty list is returned. A PTP is returned regardless of connectivity to other MEs or position in the subnetwork. (Both PTPs at the subnetwork edge and PTPs that are internal to the subnetwork are reported.)

For PTPs on protection equipment in a 1_FOR_N protection group, CTM reports only the AlarmReporting for the LayeredParameters of the PTPs.

This method also returns a list of front Ethernet ports on an ML-series card on the specified ManagedElement.

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

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

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

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

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

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

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

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

ONS 15600 SONET: CTM returns OC-N ports.

ONS 15600 SDH: CTM returns STM-N ports.

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

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

CRS-1, XR 12000: CTM returns ports (POS, POS/SDH, GE, and FE) of Line Cards.

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

Storage (MDS 9000) NE: CTM returns PTPs only when a topological link exists, and returns only those PTPs that are participating in the topological link.

MGX 8880/8850/8830: CTM returns the physical ports (DS1, DS3, and SONET/SDH) of service module cards.

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 details on TerminationPoint_T structure, see equipment::EquipmentInventoryMgr_I::getAllSupportedPTPs.

CTM supports the following layer rates:

ONS 15454 SONET

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