-
Cisco Prime Optical GateWay/CORBA User Guide and Programmer Manual, 9.3
-
Preface
-
Chapter 1: Overview of Cisco Prime Optical GateWay/CORBA
-
Chapter 2: NE- and Cisco Prime Optical-Specific Details
-
Chapter 3: Using Cisco Prime Optical GateWay/CORBA Interfaces
-
Chapter 4: Using Connectionless Interfaces
-
Appendix A: Notifications, Fault Management, and Probable Cause Mapping
-
Appendix B: Server Administration and Configuration
-
Appendix C: OSS Use Cases and Client Development
-
Appendix D: Equipment List for NEs
-
Feedback
Table Of Contents
Using GateWay/CORBA Interfaces
3.1 Overview of APIs Supported by NE Type
3.2.1 common::Common_I:: getCapabilities
3.3.1 getAllEMSAndMEActiveAlarms
3.3.2 getAllEMSSystemActiveAlarms
3.3.3 getAllTopLevelSubnetworks
3.3.4 getAllTopLevelSubnetworkNames
3.3.5 getAllTopLevelTopologicalLinks
3.3.6 getAllTopLevelTopologicalLinkNames
3.3.7 getTopLevelTopologicalLink
3.3.9 createTopologicalLinkWithYCableProtection
3.3.17 getAllEMSandMEClearedAlarms
3.3.18 getAllEMSSystemClearedAlarms
3.3.19 Passive Unit EMS Alarms
3.3.23 addMultiLayerSubnetwork
3.3.25 deleteMultiLayerSubnetwork
3.3.26 getAllSupportedMEModels
3.5 emsSessionFactory::EmsSessionFactory_I
3.6 equipment::EquipmentInventoryMgr_I
3.6.5 getAllSupportingEquipment
3.6.6 getAllSupportingEquipmentNames
3.7 maintenanceOps::MaintenanceMgr_I
3.7.1 getActiveMaintenanceOperations
3.7.2 performMaintenanceOperation
3.8 managedElementManager::ManagedElementManager_I
3.8.4 getAllManagedElementNames
3.8.8 getContainedInUseTPNames
3.8.9 getContainedPotentialTPs
3.8.10 getContainedPotentialTPNames
3.8.11 getContainingSubnetworkNames
3.8.13 getAllCtmMEInternalPatchcord
3.8.16 getAssociatedTopologicalLinks
3.8.18 getAllSrcPTPsForSNCProvisioning
3.8.19 getAllSrcCTPsForSNCProvisioning
3.8.20 getAllSrcCTPsForVCATMemberSNCProvisioning
3.8.21 getAllDestPTPsForSNCProvisioning
3.8.22 getAllDestCTPsForSNCProvisioning
3.8.23 getAllDestCTPsForVCATMemberSNCProvisioning
3.8.24 getAllSrcFTPsForSNCProvisioning
3.8.25 getAllDestFTPsForSNCProvisioning
3.8.27 getAllTopologicalLinksForME
3.8.38 getAllSoftwareDownloadJobs
3.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
3.9.4 getAllManagedElementNames
3.9.5 getAllSubnetworkConnections
3.9.6 getAllSubnetworkConnectionsWithTP
3.9.7 getAllSubnetworkConnectionNames
3.9.8 getAllSubnetworkConnectionNamesWithTP
3.9.10 getAllTopologicalLinkNames
3.9.11 getMultiLayerSubnetwork
3.9.12 getCTPsAndTopologicalLinks
3.9.16 createAndActivateSNCFromUserLabel
3.9.18 (Deprecated) createAndActivateProtectedOchccFromUserLabel
3.9.25 getAllVCATMemberSNCNames
3.9.29 deleteMemberSNCsFromVCAT
3.9.30 deleteAllMemberSNCFromVCAT
3.9.31 getValidSubnetworkConnectionsForMerge
3.9.41 getAssociatedRollNamesForSNC
3.9.42 getAssociatedSNCNamesForRoll
3.9.43 createAndActivateSNCOnDRI
3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards
3.10.2 modifyMLVLANAddFrontPorts
3.10.3 modifyMLVLANDropFrontPorts
3.10.7 modifyMLVLANCustomerIDServiceID
3.10.14 getAssociatedL2TopologyForSNC
3.10.15 getAssociatedL2TopologyForMLVLAN
3.10.19 getAllAvailableMLEquipmentOrTPNames
3.13 performance::PerformanceManagementMgr_I
3.13.6 getCTMValidHistoryPMData
3.13.7 deleteHistoryPMDataFile
3.14 protection::ProtectionMgr_I
3.14.4 performProtectionCommand
3.14.7 getAssociatedProtectionGroup
3.17 Transmission Descriptor Interfaces
3.17.1 getAllTransmissionDescriptors
3.17.2 getAllTransmissionDescriptorsNames
3.17.3 getTransmissionDescriptor
3.17.5 createTransmissionDescriptor
3.17.6 deleteTransmissionDescriptor
3.18 Software and Data Manager Interface
3.18.10 getAllSupportedMESoftwareVersions
3.18.12 addSupportedMESoftwareVersion
Using GateWay/CORBA Interfaces
This chapter describes each interface that Cisco Prime Optical supports, including TeleManagement Forum (TMF)-specific and Cisco-proprietary interfaces. This chapter includes the following information:
•
Overview of APIs Supported by NE Type
•
•
•
•
•
•
•
•
•
Note
3.1 Overview of APIs Supported by NE Type
The following table lists each API and the NEs that support it.
3.2 common::Common_I
The Common_I interface is a set of services and utilities that each manager interface inherits. Prime Optical supports only one method from this interface.
3.2.1 common::Common_I:: getCapabilities
Synopsis
void getCapabilities(out CapabilityList_T capabilities)raises(globaldefs::ProcessingFailureException);Description
This interface retrieves the capabilities of the manager. All nonspecified capabilities are assumed to be unsupported.
Parameters
A Capability_T value is used to identify a functionality supported by the EMS across the network management layer-element management layer (NML-EML) interface. It is a name/value pair, in which the name represents the feature/capability name and the value represents the support or nonsupport of the specified feature/capability.
The EMS capabilities for this release include individual IDL operation support. The feature/capability name part is used to identify an IDL operation using the following convention:
module_name::interface_name::operation_name
The currently defined values are:
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
TMF-defined.
3.3 emsMgr::EMSMgr_I
The EMSMgr_I interface accesses operations that deal with the EMS itself. A handle to an instance of this interface is gained through the emsSession::EmsSession_I::getManager operation in emsSession. This interface is inherited from common::Common_I.
interface EMSMgr_I:common::Common_IThis interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.3.1 getAllEMSAndMEActiveAlarms
Synopsis
void getAllEMSAndMEActiveAlarms(in notifications::ProbableCauseList_T excludeProbCauseList,in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_many,out notifications::EventList_T eventList,out notifications::EventIterator_I eventIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request active alarms that are under the control of the EMS (alarms raised by the NEs and alarms raised by the EMS itself). Some alarms might be filtered out (excluded) by specifying their probable causes or severities.
Due to performance concerns, only one OSS client is allowed to invoke this operation at a time. Otherwise, Prime Optical throws the EXCPT_UNABLE_TO_COMPLY exception.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH
ONS 15310, ONS 15327, ONS 15454 SDH, ONS 15454 SONET, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for TCA events. TCAs are not reported in the eventList returned by this method.
ONS 15540 and ONS 15530
TCAs are reported in the eventList returned by this method. The ONS 15540 sends a "clear" for TCAs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS client.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.3.2 getAllEMSSystemActiveAlarms
Synopsis
void getAllEMSSystemActiveAlarms(in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_many,out notifications::EventList_T eventList,out notifications::EventIterator_I eventIt) raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all active alarms for the EMS. Some alarms can be filtered out (excluded) by specifying their severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.3.3 getAllTopLevelSubnetworks
Synopsis
void getAllTopLevelSubnetworks(in unsigned long how_many,out multiLayerSubnetwork::SubnetworkList_T sList,out multiLayerSubnetwork::SubnetworkIterator_I sIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all subnetworks that are under the control of the EMS.
Parameters
Prime Optical support for MultiLayerSubnetwork_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
For the Prime Optical client subnetwork types, the following mapping applies:
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.3.4 getAllTopLevelSubnetworkNames
Synopsis
void getAllTopLevelSubnetworkNames(in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the interface described in getAllTopLevelSubnetworks, but instead of returning entire object structures, this interface returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.3.5 getAllTopLevelTopologicalLinks
Synopsis
void getAllTopLevelTopologicalLinks(in unsigned long how_many,out topologicalLink::TopologicalLinkList_T topoList,out topologicalLink::TopologicalLinkIterator_I topoIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all of the top-level topological links that are under the control of the EMS. A top-level topological link is a link in which the link endpoints exist in two different multilayer subnetworks.
If a topological link that is under the control of the EMS is removed from the NE, the provType parameter is reported as INVALID.
Parameters
Prime Optical support for TopologicalLink_T structure is as follows:
•
–
•
–
•
–
•
–
•
•
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.3.6 getAllTopLevelTopologicalLinkNames
Synopsis
void getAllTopLevelTopologicalLinkNames(in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the interface described in getAllTopLevelTopologicalLinks, but instead of returning entire object structures, this interface returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.3.7 getTopLevelTopologicalLink
Synopsis
void getTopLevelTopologicalLink(in globaldefs::NamingAttributes_T topoLinkName,out topologicalLink::TopologicalLink_T topoLink)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request the top-level topological link if its name is under the control of the EMS.
If a link that is under the control of the EMS is removed from the NE, the ProvType parameter is reported as INVALID.
Parameters
topoLinkName
globaldefs::NamingAttributes_T
In
Name of the topological link.
topoLink
TopologicalLink::TopologicalLink_T
Out
Top-level topological link.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a top level topological link object.EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a top level topological link object that does not exist in the EMS.Compliance
TMF-defined.
3.3.8 createTopologicalLink
Synopsis
void createTopologicalLink(in topologicalLink::TLCreateData_T createData,out topologicalLink::TopologicalLink_T topologicalLink)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to create a topological link manually between two MEs. Prime Optical supports topological link creation between MEs belonging to the same multilayer subnetwork. If Prime Optical autodiscovers a topological link between two endpoints on which a manually created link exists, Prime Optical overwrites the manually created topological link information with the autodiscovered topological link information. Prime Optical generates an attribute value change event when a manually created link is overwritten with autodiscovered topological link information. Prime Optical supports topological link creation between two unmanaged NEs, and also between a managed NE and an unmanaged NE. Prime Optical ignores the topological link layer rate if the topological link creation is between two unmanaged NEs.
Prime Optical generates an object creation event notification when a new topological link is created.
Note
Parameters
Prime Optical support for TLCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
–
•
•
–
•
–
•
–
•
–
To create unidirectional OTS links without side between 80WXC cards on the ONS15454 NEs, specify the parameter zEndSecSrc as secondary source and the parameter aEndSecDst as destination TP in the additionalCreationInfo list.
A End PTP[0] name = EMS value = Cisco Systems/CTM[1] name = ManagedElement value = 15454-ANSI-68-9[2] name = PTP value =/rack=1/shelf=1/slot=15/port=12Z End PTP[0] name = EMS value = Cisco Systems/CTM[1] name = ManagedElement value = 15454-ANSI-68-8[2] name = PTP value = /rack=1/shelf=1/slot=13/port=13Additional CreationInfo[0] name = linkProtectionType value = PROT_UNPROTECTED[1] name = linkCost value = 1024[2] name = provType value = PATCHCORD[3] name = zEndSecSrc value = name='EMS';value='Cisco Systems/CTM';name='ManagedElement';value='15454-ANSI-68-8';name='PTP';value='/rack=1/shelf =1/slot=13/port=10'[4] name = aEndSecDst value = name='EMS';value='Cisco Systems/CTM';name='ManagedElement';value='15454-ANSI-68-9';name='PTP';value='/rack=1/shelf =1/slot=15/port=1'In both of these examples, if the operator supplies any wrong parameters for secondary source/drop ports, the Cisco Prime Optical GateWay/CORBA interface returns an exception that reports the list of actual available ports retrieved from the ME, such as the following:
java.lang.String errorReason=The secondary PTP /rack=1/shelf=1/slot=15/port=10 does not belong to the list of available PTPs: /rack=1/shelf=1/slot=15/port=1, /rack=1/shelf=1/slot=15/port=2, /rack=1/shelf=1/slot=15/port=3, /rack=1/shelf=1/slot=15/port=4, /rack=1/shelf=1/slot=15/port=5, /rack=1/shelf=1/slot=15/port=6, /rack=1/shelf=1/slot=15/port=7, /rack=1/shelf=1/slot=15/port=8If you do not provide a secondary source PTP, the primary link between the AendTP and the ZendTP is successfully created. However, while creating the reverse link, the GateWay/CORBA interface tries using the secondary source as the first element from the list of available PTPs returned by the ME/NCP layer (for example, /rack=1/shelf=1/slot=15/port=1). If such a PTP port is still available, the reverse link is created properly; otherwise, Prime Optical throws an exception.
It is recommended that you specify a secondary source PTP. If you do not specify the secondary source PTP, GateWay/CORBA, by default, uses the first item from the list of available PTPs. However, the element may also be invalid.
You have to specify the desired PTP in the additional creation info list in case of the availability of multiple choices.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.EXCPT_INVALID_INPUT - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
TMF-defined.
3.3.9 createTopologicalLinkWithYCableProtection
Synopsis
void createTopologicalLinkWithYCableProtection(in topologicalLink::MTLCreateData_T createData,out topologicalLink::TopologicalLink_T topologicalLink)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to create a Y-cable topological link manually between two managed elements. A Y-cable link is a bidirectional link with one PTP source and two PTP destinations. Because of the limitation in TMF for topological links that have one PTP source and one PTP destination, Prime Optical reports two topological links for a Y-cable link. These two topological links have the same nativeEMSName. See Topological Links for the naming convention for the Y-cable topological link object name. The destination of the Y-cable link must be on a DWDM card on an ONS 15454 SONET/SDH or on an ONS 155xx NE.
Prime Optical generates two object creation event notifications when a new Y-cable topological link is created.
The topological link returned by this method is one leg of the Y-cable.
Parameters
Prime Optical support for MTLCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if input createData is not valid.EXCPT_INVALID_INPUT - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.3.10 deleteTopologicalLink
Synopsis
void deleteTopologicalLink(in globaldefs::NamingAttributes_T topoLinkName)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to delete a topological link manually between two managed elements. Prime Optical throws the EXCPT_UNABLE_TO_COMPLY exception if an attempt is made to delete an autodiscovered topological link or if the topological link cannot be deleted in the current state. Prime Optical generates an object deletion event notification when a topological link is deleted.
Note
•
Parameters
topoLinkName
globaldefs::NamingAttributes_T
In
Name of the topological link to delete.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised if input topological link name is invalid.EXCPT_ENTITY_NOT_FOUND - Raised if the specified topological link name does not exist in Prime Optical.EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_UNABLE_TO_COMPLY - Raised if an attempt is made to delete an auto-discovered topological link.Compliance
Prime Optical-defined. This interface is already proposed in TMF and will be included TMF Release 3.0.
3.3.11 modifyTopologicalLink
Synopsis
void modifyTopologicalLink(in topologicalLink::TLCreateData_T newTLCreateData,out topologicalLink::TopologicalLink_T newTopologicalLink )raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to modify the following parameters of existing topological links:
•
•
Note
Parameters
Prime Optical support for TLCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
•
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised if input createData is not valid.EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.3.12 getEMS
Synopsis
void getEMS(out EMS_T emsInfo)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request EMS information.
Parameters
Prime Optical supports EMS_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
TMF-defined.
3.3.13 getAllL2Topologies
Synopsis
void getAllL2Topologies(in multiLayerSubnetwork::L2TopoType_T l2TopoType,in unsigned long how_many,out multiLayerSubnetwork::L2TopologyList_T l2TopoList,out multiLayerSubnetwork::L2TopologyIterator_I l2TopoIt)raises(globaldefs::ProcessingFailureException);Description
This interface lists all L2 topologies of a particular topology type in the EMS. The L2 topology has a scope in the EMS. Prime Optical supports only Resilient Packet Ring (RPR) and point-to-point L2 topology types.
Parameters
Prime Optical support for L2Topology_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
•
•
LR_STS1_and_AU3_High_Order_VC3
LR_STS3c_and_AU4_VC4
LR_STS6c_and_VC4_2c
LR_STS9c_and_VC4_3c
LR_STS12c_and_VC4_4c
LR_STS24c_and_VC4_8c
LR_Not_Applicable (if the L2 topology contains L1 SNCs with different layer rates or if the L2 topology contains a mix of CCAT and VCAT L1 SNCs)
•
–
•
–
Note
•
–
•
–
•
•
•
•
•
•
•
–
–
•
•
•
•
•
•
•
•
•
•
•
•
•
–
•
•
•
•
•
•
•
•
•
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when an l2TopoType is invalid.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the EMS reaches the maximum number of iterators that it can support.Compliance
Prime Optical-defined.
3.3.14 getAllQoSTemplateNames
Synopsis
void getAllQoSTemplateNames( in unsigned long how_many,out globaldefs::NamingAttributesList_T qosTempNameList,out globaldefs::NamingAttributesIterator_I qosTempNameIt)raises(globaldefs::ProcessingFailureException);Description
This interface lists all QoS template names in the EMS. The QoSTemplate has a scope in the EMS.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the EMS reaches the maximum number of iterators that it can support.Compliance
Prime Optical-defined.
3.3.15 getAllQoSTemplates
Synopsis
void getAllQoSTemplatesin unsigned long how_many,out QoSTemplateList_T qosTempListout QoSTemplateIterator_I qosTempIt)raises(globaldefs::ProcessingFailureException);Description
This interface lists all QoS templates in the EMS. The QoSTemplate has a scope in the EMS.
Parameters
Prime Optical support for QoSTemplate structure is as follows:
•
•
•
–
–
–
•
•
–
–
Each QoSClass_T has the following members:
•
•
Classification_T.MATCH_ANY
Classification_T.MATCH_DSCP
Classification_T.MATCH_IP
Classification_T.MATCH_COS
string value—This field is a string value. Multiple values are separated by spaces.
•
•
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
•
–
–
–
–
–
–
•
•
–
–
•
–
–
Note
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the EMS reaches the maximum number of iterators that it can support.Compliance
Prime Optical-defined.
3.3.16 getQoSTemplate
Synopsis
void getAllQoSTemplates(in globaldefs::NamingAttribute_T QoSTemplateName,out QoSTemplate_T qosTemp )raises(globaldefs::ProcessingFailureException);Description
This interface lists the complete QoSTemplate information for each QoSTemplate name. The QoSTemplate has a scope in the EMS.
Parameters
qosTemplateName
globaldefs::NamingAttributes_T
In
QoS template name.
qosTemp
QoSTemplate_T
Out
QoS template with the complete information.
For details about the QoSTemplate_T structure, see getAllQoSTemplateNames.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when the QoSTemplate name is not valid.EXCPT_ENTITY_NOT_FOUND - Raised when the QoSTemplate name does not exist on the EMS.Compliance
Prime Optical-defined.
3.3.17 getAllEMSandMEClearedAlarms
Synopsis
void getAllEMSandMEClearedAlarms(in notifications::ProbableCauseList_T excludeProbCauseList,in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_manyout notifications::EventList_T eventList,out notifications::EventIterator_I eventIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all of the cleared and acknowledged alarms that are under the control of the EMS (both alarms raised by the NEs and alarms raised by the EMS itself). Some alarms may be filtered out (excluded) by specifying their probable causes or severities.
Due to performance concerns, this operation is restricted to enable only one OSS client to access it at one time. Otherwise, Prime Optical throws the EXCPT_UNABLE_TO_COMPLY exception.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH
The ONS 15310, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for TCA events. TCAs are not reported in the eventList that is returned by this method.
ONS 15540 and ONS 15530
TCAs are reported in the eventList that is returned by this method. The ONS 15540 sends a "clear" for TCAs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_UNABLE_TO_COMPLY - Raised when this method is being used by another OSS Client.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.3.18 getAllEMSSystemClearedAlarms
Synopsis
void getAllEMSSystemClearedAlarms(in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_manyout notifications::EventList_T eventList,out notifications::EventIterator_I eventIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all of the cleared and acknowledged alarms that are for the EMS itself. Some alarms may be filtered out (excluded) by specifying their severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.3.19 Passive Unit EMS Alarms
In Prime Optical 9.3, passive units are supported. See Passive Unit Inventory for the list of passive units that are supported. For passive units, no alarms are supported.
3.3.20 createServerTrailLink
Synopsis
void createServerTrailLink(in serverTrailLink::STLCreateData_T createDataraises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to create a server trail link manually between two MEs. Prime Optical supports the server trail link creation between MEs belonging to the same multilayer subnetwork. Prime Optical generates an object creation event notification when a new server trail link is created.
Note
•
Parameters
createData
serverTrailLink::STLCreateData_T
In
Data structure containing details for creating a new server trail link.
Prime Optical support for STLCreateData_T structure is as follows:
•
Not supported. The value of this field is assigned to the name of the newly created server trail link.
•
Not supported.
•
Not supported.
•
Prime Optical supports only CD_BI for bidirectional links.
•
Supported layer rates are:
–
–
–
–
–
–
•
Supported.
•
Supported.
•
Supported. The supported parameters are listed in the following table.
•
Supported. This field holds the SRLG group values. This is an optional parameter that you can include in the SRLG group during the link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH server trail links.
Prime Optical support for ServerTrailLink_T structure is as follows:
•
Supported. This field has two tuples. The first tuple is for EMS. The second one is for ServerTrailLink. The value in the second tuple is the same as the nativeEMSName field.
•
Not supported.
•
Not supported
•
Not supported.
•
Prime Optical supports only CD_BI for bidirectional links.
•
Supported layer rates are:
–
–
–
–
–
–
•
Supported. The CTP for the serverTrailLink aEnd.
•
Supported. The CTP for the serverTrailLink zEnd.
•
Supported. The supported parameters are listed in the following table.
•
Supported. This field holds the SRLG group values. This is an optional parameter that you can include in the SRLG group during the link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH server trail links.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised if input createData is not valid.EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.3.21 deleteServerTrailLink
Synopsis
void deleteServerTrailLink(in globaldefs::NamingAttributes_T serverTrailLinkName)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to delete a server trail link manually between two MEs. Prime Optical throws the EXCPT_UNABLE_TO_COMPLY exception if the server trail link cannot be deleted in the current state. Prime Optical generates an object deletion event notification when a server trail link is deleted.
Parameters
serverTrailLinkName
globaldefs::NamingAttributes_T
In
Name of the server trail link to delete.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised if input the server trail link name is invalid.EXCPT_ENTITY_NOT_FOUND - Raised if the specified server trail link name does not exist in Prime Optical.EXCPT_NOT_IMPLEMENTED - Raised if the EMS cannot support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_UNABLE_TO_COMPLY - Raised if attempt is made to delete a server trail which cannot be deleted.Compliance
Prime Optical-defined.
3.3.22 addNetworkPartition
Synopsis
void addNetworkPartition(in string name, in string description) raises(globaldefs::ProcessingFailureException);Description
This interface enables the OSS to add a new network partition.
Parameters
name
string
In
Network partition name.
description
string
In
Description of the new partition.
Throws
globaldefs::ProcessingFailureExceptionCompliance
Prime Optical-defined.
3.3.23 addMultiLayerSubnetwork
Synopsis
void addMultiLayerSubnetwork(in MultiLayerSubnetworkCreateData _T subnetCreateData) raises(globaldefs::ProcessingFailureException);Description
This interface allows the NMS to add a new multilayer subnetwork. Upon successful addition, the EMS generates an object creation event for the multilayer subnetwork object.
Parameters
subnetCreateData
MultiLayerSubnetworkCreateData _T
In
MultiLayerSubnetwork input data.
The structure for MultiLayerSubnetworkCreateData _T is as follows:
struct MultiLayerSubnetworkCreateData_T{globaldefs::NamingAttributes_T subnetworkName;string userLabel;string nativeEMSName;string owner;multiLayerSubnetwork::Topology_T subnetworkType;globaldefs::NVSList_T additionalInfo ;};The description of each parameter is as follows:
enum Topology_T { TOPO_SINGLETON, TOPO_CHAIN, TOPO_PSR,TOPO_OPEN_PSR, TOPO_SPRING, TOPO_OPEN_SPRING, TOPO_MESH };The structure of Additional Info is as follows:
The parameter name "Type" in additionalInfo can have the following values:
•
•
•
•
Throws
globaldefs::ProcessingFailureExceptionCompliance
Prime Optical-defined.
3.3.24 deleteNetworkPartition
Synopsis
void deleteNetworkPartition(in string name) raises(globaldefs::ProcessingFailureException);Description
This interface enables the OSS to delete an existing network partition.
Parameters
Throws
globaldefs::ProcessingFailureExceptionCompliance
Prime Optical-defined.
3.3.25 deleteMultiLayerSubnetwork
Synopsis
void deleteMultiLayerSubnetwork(in globaldefs::NamingAttributes_T subnetworkName) raises(globaldefs::ProcessingFailureException);Description
This interface allows the NMS to delete an existing subnetwork. Successful operation requires the EMS to generate an object deletion event.
Parameters
subnetworkName
globaldefs::NamingAttributes_T
In
Subnet name to delete.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_ENTITY_NOT_FOUND- Raised if the multilayer subnetwork is not found.EXCPT_UNABLE_TO_COMPLY- Raised if the EMS cannot comply.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service.Compliance
Prime Optical-defined.
3.3.26 getAllSupportedMEModels
Synopsis
void getAllSupportedMEModels(out globaldefs::NVSList_T supportedMEs)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of all of the models that the EMS supports. A model's structure has the following form:
•
•
Parameters
supportedMEs
NVSList_THolder
Out
List of all of the supported model names.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.4 EmsSession::EmsSession_I
The emsSession module enables the client to query the EMS to determine the manager interfaces that the EMS supports. The NMS retrieves an instance of the required manager interface objects. This interface is inherited from session::Session_I.
interface EmsSession_I:session::Session_I3.4.1 getEventChannel
Synopsis
void getEventChannel(out CosNotifyChannelAdmin::EventChannel eventChannel)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to access the event channel to receive notifications. Prime Optical publishes the name of the notification channel through the naming service. You can use the naming service to get the corresponding object reference.
Parameters
eventChannel
CosNotifyChannelAdmin::EventChannel
Out
Event channel that the NMS uses.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
TMF-defined.
3.4.2 getManager
Synopsis
void getManager(in string managerName,out common::Common_I managerInterface)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to access the specified manager interface.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - This exception indicates that the EMS does not support the manager.EXCPT_INTERNAL_ERROR - This exception indicates a nonspecific internal EMS failure.Compliance
TMF-defined.
3.4.3 getSupportedManagers
Synopsis
void getSupportedManagers(out managerNames_T supportedManagerList)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request the manager interfaces that the EMS implements.
Parameters
Throws
None.
Compliance
TMF-defined.
3.5 emsSessionFactory::EmsSessionFactory_I
A single instance of the EmsSessionFactory_I is the entry point to the EMS. The NMS uses this object reference to connect to Prime Optical. This interface implements the version interface and returns the server IDL version. It is inherited from mtnmVersion::Version_I.
interface EmsSessionFactory_I:mtnmVersion::Version_I3.5.1 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 interface enables the NMS to obtain the EmsSession_I object, which contains all managers of the EMS.
Prime Optical allows 4 to 25 concurrent login sessions and as many user profiles as required for configuring the number of concurrent login sessions. See Location of the Naming Service IOR File to configure the number of concurrent login sessions. The username and password must contain from 1 to 53 characters.
This interface can also accept the encrypted username and password. To enable encryption on the username and password, check the Enable encryption for username and password check box in the Prime Optical client Control Panel for the GateWay/CORBA service. Prime Optical 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 Prime Optical. To obtain the Prime Optical public key, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKey API. To obtain the Prime Optical public key pair, use the emsSessionFactory::EmsSessionFactory_I::getEmsPublicKeyPair API.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of a nonspecific internal EMS failure.EXCPT_INVALID_INPUT - Raised when the client is invalid or when the length of the username or password passed is not within the permissible limits (1-53).EXCPT_ACCESS_DENIED - Raised in the following cases:When all the eight login sessions are used up.When the user name specified does not exist.Or in case of any other security violation.Compliance
TMF-defined.
3.5.2 getEmsPublicKey
Synopsis
void getEmsPublicKey(out string publicKey)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to obtain the string representation of the RSA public key encoded in the Base64 encoding scheme. The operation encrypts the username and password from the string representation of the RSA public key.
The OSS client must use the Base64 decoders to decode the public key and get the byte[] of the public key from the decoded public key string. The byte[] corresponding to the public key represents the key in its primary encoded format; in this case, X.509 SubjectPublicKeyInfo.
You can create the RSA public key using this byte array and cryptographic libraries. Use this key to encrypt the username and password. Bouncy Castle Provider is an example of a security provider that you can use to create the RSA public key.
The public key is then used to encrypt the username and password. Before passing the encrypted password to Prime Optical 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
publicKey
string
Out
Public key string returned by Prime Optical.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.5.3 getEmsPublicKeyPair
Synopsis
void getEmsPublicKeyPair(out string publicKeyModulus,out string publicKeyExponent)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to obtain the string representation of the RSA public key pair (in the modulus and exponent forms) from Prime Optical 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 Prime Optical for login, the OSS client must use the Base64 encoder to encode the encrypted username and password. This provides the string equivalent of the encrypted data.
Parameters
publicKeyModulus
string
Out
Public key modulus string returned by Prime Optical.
publicKeyExponent
string
Out
Public key exponent string returned by Prime Optical.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.6 equipment::EquipmentInventoryMgr_I
This interface accesses operations that deal with equipment. A handle to an instance of this interface is gained through the getManager operation in emsSession. This interface is inherited from common::Common_I.
interface EquipmentInventoryMgr_I:common::Common_IThis interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.6.1 getAllEquipment
Synopsis
void getAllEquipment(in globaldefs::NamingAttributes_T meOrHolderName,in unsigned long how_many,out EquipmentOrHolderList_T eqList,out EquipmentOrHolderIterator_I eqIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all of the equipment and equipment holders contained in a managed element or equipment holder.
Parameters
The EqList parameter contains a sequence of the EquipmentOrHolder_T data type, which is defined as the union of Equipment_T and EquipmentHolder_T.
Prime Optical support for Equipment_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
–
–
–
–
–
–
•
–
•
–
•
–
•
–
•
–
Prime Optical support for EquipmentHolder_T is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
–
–
–
–
–
•
–
•
–
–
1, 2, 3, 4
All equipment listed in Equipment List for ONS 15305
1
CTX-2500, CTX-FILLER
2
CE-100T-8, ML-100T-8, CE-MR-6
3, 4
CTX-2500, CTX-FILLER
1, 2, 5, 6
E1-21/E3-DS3-3, E1-63/E3-DS3-3
1, 2, 5, 6
CE-100T-8, ML-100T-8, CE-MR-6, EXP-FILLER
3, 4
CTX-2500, CTX-FILLER
1, 2, 5, 6
DS1-84/DS3-EC1-3, DS1-28/DS3-EC1-3, DS3-EC-6
1, 2, 5, 6
CE-100T-8, ML-100T-8, CE-MR-6, EXP-FILLER
7, 8
MIC
5, 6
XTC
1, 2, 3, 4
ETH100, OC12, OC48
5,10
TXC
6/7, 8/9
SSXC
1, 2, 3, 4, 11, 12, 13, 14
OC48_16, OC192_4, OC48_32
1, 2, 3, 4, 11, 12, 13, 14
ASAP, STM64_4_DWDM
5, 10
TXC
6/7, 8/9
SSXC
1, 2, 3, 4, 11, 12, 13, 14
OC48_16, OC192_4, OC48_32
1, 2, 3, 4, 11, 12, 13, 14
ASAP, OC192_4_DWDM
Compliance
TMF-defined.
3.6.2 getAllEquipmentNames
Synopsis
void getAllEquipmentNames(in globaldefs::NamingAttributes_T meOrHolderName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the interface described in getAllEquipment, but returns the object name instead of returning the entire object.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when meOrHolderName does not reference a managed element or an equipment holder.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementOrEquipmentName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.6.3 getAllSupportedPTPs
Synopsis
void getAllSupportedPTPs(in globaldefs::NamingAttributes_T equipmentName,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request the PTPs that are directly supported by specific equipment. The PTPs that are returned are those that share their physical layer with the primary equipment (that is, they represent a port on the equipment or are connected by a fiber, wire, and so on).
If the equipment is protection equipment in a 1_FOR_N protection group, Prime Optical reports only the AlarmReporting for the LayeredParameters of the supported PTPs.
•
•
•
•
•
•
•
•
•
•
Parameters
Prime Optical support for TerminationPoint_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
Prime Optical supports the following parameters for PTP.
Note
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.6.4 getAllSupportedPTPNames
Synopsis
void getAllSupportedPTPNames(in globaldefs::NamingAttributes_T equipmentName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the interface described in getAllSupportedPTPs, but returns the object names instead of returning the entire object.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.6.5 getAllSupportingEquipment
Synopsis
void getAllSupportingEquipment(in globaldefs::NamingAttributes_T ptpName,out EquipmentOrHolderList_T eqList)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request the equipment that contains a given PTP.
Parameters
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For details about both structures, see getAllEquipment.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.6.6 getAllSupportingEquipmentNames
Synopsis
void getAllSupportingEquipmentNames(in globaldefs::NamingAttributes_T ptpName,out globaldefs::NamingAttributesList_T nameList)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the operation described in getAllSupportingEquipment, but returns the object name instead of returning the entire object.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.6.7 getContainedEquipment
Synopsis
void getContainedEquipment(in globaldefs::NamingAttributes_T equipmentHolderName,out EquipmentOrHolderList_T equipmentOrHolderList)raises(globaldefs::ProcessingFailureException);Description
This interface returns the equipment and equipment holders that a specific equipment holder contains. This interface differs from getAllEquipment in that it looks only at the next level of the containment hierarchy.
Parameters
EquipmentOrHolderList_T is a list of EquipmentOrHolder_T, which is defined as a union of Equipment_T and EquipmentHolder_T structures. For details about both structures, see getAllEquipment.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentHolderName does not reference an equipment holder object.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolderName references an equipment holder that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.6.8 getEquipment
Synopsis
void getEquipment(in globaldefs::NamingAttributes_T equipmentOrHolderName,out EquipmentOrHolder_T equip)raises(globaldefs::ProcessingFailureException);Description
This interface returns the equipment or equipment holder for specific equipment or equipment holder names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or an equipment holder.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an equipment or equipment holder that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.6.9 provisionEquipment
Synopsis
void provisionEquipment(in EQTCreateData_T equipmentCreateData,out Equipment_T createdEquipment)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to permanently provision a piece of equipment in an equipment holder in an ME. The result of this operation is the creation of the equipment object and all of its related objects, such as TPs. The resulting object is returned.
The equipment holder that contains the equipment must exist. The equipment object can already exist, but the equipment holder must not have expected equipment already provisioned.
If the equipment is provisioned successfully, Prime Optical generates a state change event on the holder state change and an object creation event for the equipment, and pushes them to the event channel.
It is important to note that the ONS 15454 SONET detects new equipment and provisions it automatically, provided that the equipment holder (slot) is empty and is not preprovisioned for another module type.
The equipment must be from the acceptableEquipmentTypeList of the slots. If these slots are selected to provision any other type of card, Prime Optical 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, Prime Optical reports the subtype in the name field of the equipment.
For the ONS 15600 SONET and ONS 15600 SDH, each CXC or SSXC card occupies two slots (slots 6 and 7 or slots 8 and 9), and the NMS can specify any one of the slots to provision a CXC or SSXC card.
Parameters
equipmentCreateData
EQTCreateData_T
In
Data that describes the equipment to create.
createdEquipment
Equipment_T
Out
Resulting created equipment.
Prime Optical support for EQTCreateData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
Note
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_OBJECT_IN_USE - Raised when the equipment holder already has an expected equipment.EXCPT_INVALID_INPUT - Raised when equipmentHolder does not reference an equipmentHolder object.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentHolder references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be created at the NE.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.6.10 setAlarmReportingOff
Synopsis
void setAlarmReportingOff(in globaldefs::NamingAttributes_T equipmentOrHolderName)raises(globaldefs::ProcessingFailureException);Description
This interface disables alarm reporting on a piece of equipment. If successful, Prime Optical sends a warning alarm notification. For optical NEs, the interface supports the node names as equipment only when the NE alarms are configured with "off."
Parameters
equipmentOrHolderName
Globaldefs::NamingAttributes_T
In
Equipment on which to deactivate alarm reporting.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or holder.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when alarm reporting cannot be disabled for the equipment or holder.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.6.11 setAlarmReportingOn
Synopsis
void setAlarmReportingOn(in globaldefs::NamingAttributes_T equipmentOrHolderName)raises(globaldefs::ProcessingFailureException);Description
This interface enables alarm reporting on a piece of equipment.
The default setting for alarmReporting is "on." If the alarmReporting status is off, it indicates that a warning alarm has been raised for it. Prime Optical generates a cleared warning alarm if successful. For optical NEs, the interface supports the node names as equipment only when the NE alarms are configured with "off."
Parameters
equipmentOrHolderName
globaldefs::NamingAttributes_T
In
Equipment on which to activate alarm reporting.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or holder.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when alarm reporting cannot be disabled for the equipment or holder.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.6.12 unprovisionEquipment
Synopsis
void unprovisionEquipment(in globaldefs::NamingAttributes_T equipmentName)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to permanently unprovision equipment from the managed element. The successful result of this operation is the potential deletion of the equipment object and all of its related objects, such as termination points.
The ONS 15454 SONET does not allow a user to unprovision a piece of equipment that is in use (SNC is created on this equipment). However, if the equipment is present in the slot and is not in use, it can be unprovisioned. If the equipment is not physically removed from the slot and new equipment is not provisioned in the same slot, the NE redetects the equipment in approximately 1 minute. If the equipment is not physically removed from the slot and new equipment of a different type is provisioned in the same slot, the NE generates an equipment mismatch alarm.
If the equipment is unprovisioned successfully, Prime Optical generates a state change event on the holder state change and an object deletion event for the equipment, and pushes them to the event channel.
The ONS 15454 reserves slots 7 and 11 for TCC. One of these slots has an in-service TCC card. If the NMS invokes unprovisionEquipment on this equipment, Prime Optical throws the EXCPT_UNABLE_TO_COMPLY exception.
Parameters
equipmentName
globaldefs::NamingAttributes_T
In
Name of the equipment to unprovision.
Note
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when equipmentName does not reference an equipment object.EXCPT_OBJECT_IN_USE - Deletion is rejected because equipment resources are in use.EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when the equipment cannot be unprovisioned at the NE.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.7 maintenanceOps::MaintenanceMgr_I
MaintenanceMgr_I is used as a handle to gain access to the maintenance operation. A handle to an instance of this interface is gained through the getManager operation in emsSession.
interface MaintenanceMgr_I:common::Common_IThis interface also implements the getCapabilities method. Operations described in the following subsections are returned to the NMS when it invokes getCapabilities.
3.7.1 getActiveMaintenanceOperations
Synopsis
void getActiveMaintenanceOperations(in globaldefs::NamingAttributes_T tpOrMeName,in unsigned long how_many,out CurrentMaintenanceOperationList_TcurrentMaintenanceOpeationList,out CurrentMaintenanceOperationIterator_I cmoIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to query the EMS to determine if any persistent maintenance commands have been invoked. This query is supported for PTP, CTP, and ME objects.
Parameters
Prime Optical support for CurrentMaintenanceOperation structure is as follows:
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific 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 the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.7.2 performMaintenanceOperation
Synopsis
void performMaintenanceOperation(in CurrentMaintenanceOperation_T maintenanceOperation,in MaintenanceOperationMode_T maintenanceOperationMode)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to operate and release the maintenance commands that are supported by a TP.
ONS 15310 CL and ONS 15310 MA
Prime Optical supports only terminal and facility loopback operations for electrical and OC-n PTPs.
Prime Optical does not support loopback operations for CTPs.
ONS 15327
Prime Optical supports only terminal and facility loopback operations for DS-n and OC-n PTPs.
Prime Optical does not support loopback operations for CTPs.
For the ONS 15327 R3.4 or later, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.
ONS 15454 SDH
Prime Optical supports only terminal and facility loopback operations for PTPs.
Prime Optical does not support loopback operations for CTPs.
For the ONS 15454 SDH R3.4 or later, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.
ONS 15454 SONET
Prime Optical supports only terminal and facility loopback operations for DS-n, OC-n, EC1, 10G-transponder, 10G-muxponder, and G1000_4 PTPs.
Only facility loopback is supported for DS1 CTPs on DS3XM cards.
For the ONS 15454 SONET R3.4 or later, the loopback state can be set only if the TP state is either Out of Service-Maintenance or Auto in Service.
ONS 15600 SDH
Prime Optical supports only terminal and facility loopback operations for PTPs.
Prime Optical does not support loopback operations for CTPs.
Loopback is supported only in the Out of Service-Maintenance state of the PTP.
Prime Optical ignores the MaintenanceOperation_T value in CurrentMaintenanceOperation_T structure, if MaintenanceOperationMode_T is set to MOM_RELEASE.
ONS 15600 SONET
Prime Optical supports only facility and payload loopback operations for PTPs.
Prime Optical does not support loopback operations for CTPs.
Loopback is supported only in the Out of Service-Maintenance state of the PTP.
Prime Optical ignores the MaintenanceOperation_T value in CurrentMaintenanceOperation_T structure, if MaintenanceOperationMode_T is set to MOM_RELEASE.
Parameters
Prime Optical support for CurrentMaintenanceOperation_T structure is as follows:
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific 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 the managed element is lost.Compliance
TMF-defined.
3.8 managedElementManager::ManagedElementManager_I
This interface accesses operations that deal with MEs and TPs. A handle to an instance of this interface is gained through the getManager operation in emsSession.
interface ManagedElementManager_I:common::Common_IThis interface also implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.8.1 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 interface enables an NMS to request all active alarms for the specified ME, excluding alarms that the ME does not report to Prime Optical. 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 15310 CL, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH
The ONS 15310 CL, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for TCA events. TCAs are not reported in the eventList that is returned by this method.
ONS 15530 and ONS 15540
TCAs are reported in the eventList returned by this method. The ONS 15530 and ONS 15540 send a "clear" for TCAs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific 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 communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.2 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 interface enables an NMS to request all SNCs that originate on, terminate on, or transit through a given ME.
•
•
•
•
•
•
This interface does not report VCAT SNCs.
Parameters
Prime Optical support for SubnetworkConnection_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
Note
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific 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 communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.3 getAllManagedElements
Synopsis
void getAllManagedElements(in unsigned long how_many,out managedElement::ManagedElementList_T meList,out managedElement::ManagedElementIterator_I meIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request details about all MEs that are under the control of ManagedElementMgr_I.
Parameters
Prime Optical support for ManagedElement_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
–
•
For a list of all supported layer rates, see Layer Rate.
•
Supported. Two parameters are sent in this field:
–
–
PreProvisioned
False
InServiceSyncConfiguration
False
OutOfService
False
UnderMaintenance
False
InServiceIntializing
False
InService
True
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.4 getAllManagedElementNames
Synopsis
void getAllManagedElementNames(in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as getAllManagedElements, but instead of returning entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.5 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 interface 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, Prime Optical reports only the AlarmReporting for the LayeredParameters of the PTPs.
This interface also returns a list of front Ethernet ports on an ML-series card on the specified managed element.
•
•
•
•
•
•
•
•
•
•
•
Parameters
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For a list of all supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.6 getAllPTPNames
Synopsis
void getAllPTPNames(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRateList_T tpLayerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the interface described in getAllPTPs, but returns the object names instead of the object structures.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.7 getContainedInUseTPs
Synopsis
void getContainedInUseTPs(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface retrieves the in-use CTPs contained in a specific PTP, at specific layer rates. An in-use CTP is a CTP used by an SNC in any state (including pending) or a CTP that is terminated and mapped.
Example for SONET: The NMS invokes this method on an OC3 PTP (and assumes that the NE does not have an XCVT card, so VT-level cross-connects are not possible) with an empty layerRateList.
•
•
Example for SDH: The NMS invokes this method on an STM-1 PTP (and assumes that the NE does not have an XC10G card, so VC12-level cross-connects are not possible) with an empty layerRateList.
•
•
Parameters
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For a list of all supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.8 getContainedInUseTPNames
Synopsis
void getContainedInUseTPNames(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the operation described in getContainedInUseTPs, but instead of returning entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.9 getContainedPotentialTPs
Synopsis
void getContainedPotentialTPs(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all of the CTPs it can support in all possible mapping configurations, at specified rates and TPs. This interface returns all potential contained CTPs for a specific TP. The TP might be a PTP or a CTP. If the layerRateList is empty, contained CTPs at all flexible and static LayerRates are returned.
For example, on an ONS 15454 SONET NE, the NMS invokes this method on an OC-3 PTP (assuming that the NE does not have an XCVT card, so VT-level cross-connects are not possible) with an empty layerRateList. Regardless of the number of SNCs, Prime Optical returns four CTPs: three at the STS-1 layer rate and one at the STS3c layer rate.
Parameters
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For a list of all supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object.EXCPT_TP_INVALID_ENDPOINT - Raised when tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.10 getContainedPotentialTPNames
Synopsis
void getContainedPotentialTPNames(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T layerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP or CTP object.EXCPT_TP_INVALID_ENDPOINT - Raised when tpName refers to a PTP (and all contained potential CTPs) that is part of a topological link.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP or CTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.8.11 getContainingSubnetworkNames
Synopsis
void getContainingSubnetworkNames(in globaldefs::NamingAttributes_T managedElementName,out globaldefs::NamingAttributesList_T subnetNames)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of subnetwork names to which the ME (supplied as an input parameter) belongs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.8.12 getManagedElement
Synopsis
void getManagedElement(in globaldefs::NamingAttributes_T managedElementName,out managedElement::ManagedElement_T me)raises(globaldefs::ProcessingFailureException);Description
This interface returns the managed element for a specific managed element name.
Parameters
managedElementName
globaldefs::NamingAttributes_T
In
Name of the ME to retrieve.
me
managedElement::ManagedElement_T
Out
Retrieved ME.
For details about the ManagedElement_T structure, see getAllManagedElements.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.8.13 getAllCtmMEInternalPatchcord
Synopsis
void getAllCtmMEInternalPatchcord(in globaldefs::NamingAttributes_T managedElementName,out globaldefs::NVSList_T patches)raises (globaldefs::ProcessingFailureException);Description
This interface returns a list of internal Prime Optical patchcords for a specific managed element name.
Parameters
managedElementName
globaldefs::NamingAttributes_T
In
Name of the ME to retrieve.
patches
globaldefs::NVSList_T
Out
The retrieved patchcords.
For details about the ManagedElement_T structure, see getAllManagedElements.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when managedElementName does not reference a managed element object.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an ME object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.14 setAdditionalInfo
Synopsis
void setAdditionalInfo(in globaldefs::NamingAttributes_T tpName,inout globaldefs::NVSList_T additionalInfo)raises(globaldefs::ProcessingFailureException);Description
This interface sets attributes using the additionalInfo structure. This interface is supported only for:
•
•
G1000_4
X
X
CE-1000-4
X
X
CE-100T-8
X
X
X
X
X
CE-MR-10
X
X
CE-MR-6
X
X
This interface is also supported for the attribute LinkIntegrityTimer for the cards and the NE types listed in the following table.
CE-100T-8
X
X
X
X
X
CE-MR-10
X
X
CE-MR-6
X
X
This interface is also supported for the attribute LinkIntegrityTimer for the cards and the NE types listed in the following table.
For CE-100T-8, CE-MR-6, and CE-MR-10 cards, the LinkIntegrityTimer attribute value cannot be set to 0.
For G1000_4 and CE-1000-4 cards, the LinkIntegrityTimer attribute value cannot be set to 0 if the LinkIntegrityDisable attribute is set to false.
For G1000_4 and CE-1000-4 cards, the LinkIntegrityTimer attribute value must be set to 0 if the LinkIntegrityDisable attribute is set to true.
For G1000_4 and CE-1000-4 cards, the LinkIntegrityDisable attribute can be set only to true or false.
This operation returns a list of modified attributes with the new related values applied.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service, or if the service is not supported for the selected NE type or card.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a termination point object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a TP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.8.15 getTP
Synopsis
void getTP(in globaldefs::NamingAttributes_T tpName,out terminationPoint::TerminationPoint_T tp)raises(globaldefs::ProcessingFailureException);Description
This interface returns the TP structure for a specific TP name.
For the PTP on protection equipment in a 1_FOR_N protection group, Prime Optical reports only the AlarmReporting for the LayeredParameters of that PTP.
For PTPs, the additionalInfo attribute list contains the LinkIntegrityTimer attribute value if the selected card is one of the following (see also setAdditionalInfo):
•
•
•
For PTPs, the additionalInfo attribute list contains the LinkIntegrityTimer and LinkIntegrityDisable attribute values if the selected card is one of following:
•
Parameters
tpName
globaldefs::NamingAttributes_T
In
Name of the TP to retrieve.
tp
terminationPoint::TerminationPoint_T
Out
Retrieved TP.
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when tpName does not reference a termination point object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a TP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.8.16 getAssociatedTopologicalLinks
Synopsis
void getAssociatedTopologicalLinks(in globaldefs::NamingAttributes_T ptpName,out topologicalLink::TopologicalLink_T topologicalLinks)raises(globaldefs::ProcessingFailureException);Description
This interface enables the NMS to pass the TP name. Prime Optical supports multilayer topological links and returns a list of topological links through the TP.
Prime Optical reports all the physical optical and manual topological links.
Parameters
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when ptpName does not reference a physical termination point object.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.17 setTPData
Synopsis
void setTPData(in subnetworkConnection::TPData_T tpInfo,out terminationPoint::TerminationPoint_T modifiedTP)raises(globaldefs::ProcessingFailureException);Description
This interface allows the NMS to set parameters on a specific TP. The results tell the NMS which modifications succeeded.
Prime Optical supports the following parameters for CTPs:
•
•
•
•
•
To completely remove the path trace, the NMS must set TrailTraceMonitor to Off and TrailTraceExpectedRx to an empty string in one call.
If the NMS sends only TrailTraceExpectedRx, Prime Optical sets TrailTraceMonitor to On and sets the value of the expected string. If TrailTraceExpectedRx contains an empty string as the only parameter in the call, Prime Optical changes TrailTraceMonitor to On and sets the expected string to an empty string. To completely remove the path trace, the NMS must set TrailTraceMonitor to Off and set TrailTraceExpectedRx to an empty string in one call.
Prime Optical supports the following parameters for PTPs:
•
•
•
•
•
•
The SDH_SONET_SS_BITS parameter can be modified only when EnableSyncMsg is Off. EnableSyncMsg can be set to On only if SDH_SONET_SS_BITS is set to SONET.
The SDH_SONET_SS_BITS and EnableSyncMsg parameters must be modified by invoking two separate method calls. If you try to use the same method to modify SDH_SONET_SS_BITS and EnableSyncMsg, Prime Optical generates a processing failure exception.
The setTPData interface does not apply to the following ML-series card parameters that are configurable through Cisco IOS:
•
•
Prime Optical supports the following automatic laser shutdown parameters on PTPs. These parameters are not defined by the TMF.
•
•
•
•
If the equipment is the protecting equipment in a 1_For_N protection group, Prime Optical sets the PTPs on the equipment to AlarmReporting.
Prime Optical supports only the following parameters for FTPs:
•
•
For valid values for each parameter, see Table 3-4 in getAllSupportedPTPs.
You must use the Prime Optical client to set other TP parameters.
Invoking this method from the NMS is a synchronous call.
Parameters
tpInfo
subnetworkConnection::TPData_T
In
Details about required modifications.
modifiedTP
terminationPoint::TerminationPoint_T
Out
Result of modification.
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
Prime Optical support for TPData_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the TP referred to in tpInfo does not exist.EXCPT_INVALID_INPUT - Raised when tpInfo does not reference a valid CTP object.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.8.18 getAllSrcPTPsForSNCProvisioning
Synopsis
void getAllSrcPTPsForSNCProvisioning(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of PTP names that can be used as the source of an SNC to create on a given ME. The NMS must specify the layer rate and the direction of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns a PTP name list based on current resource availability. The actual SNC creation might still fail.
Parameters
For a list of supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.19 getAllSrcCTPsForSNCProvisioning
Synopsis
void getAllSrcCTPsForSNCProvisioning(in globaldefs::NamingAttributes_T ptpName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of CTP names that can be used as the source of an SNC to create on a given ME. The NMS must specify the layer rate and the direction of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns a CTP name list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as aEnd in the SNCCreateData_T parameter of the createAndActivateSNCFromUserLabel method described in createAndActivateSNCFromUserLabel.
Parameters
For a list of supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.20 getAllSrcCTPsForVCATMemberSNCProvisioning
Synopsis
void getAllSrcCTPsForVCATMemberSNCProvisioning(in globaldefs::NamingAttributes_T ptpName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs:: NamingAttributesList_T tpList,out globaldefs:: NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of CTP names that can be used as the source of a VCAT member SNC to create on a given PTP. The NMS must specify the layer rate and the direction of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns a CTP name list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as the aEnd in each SNCCreateData_T listed from the sncCreateDataList field of the type VCAT SNCCreateData_T, which is required as a parameter of the createVCATl method described in createVCAT.
This interface must be used according to SNC Provisioning for ONS 15454 CE-MR-10 Cards.
Restrict the use of this API to VCAT circuits involving CE-MR-10 cards in Manual mode.
Parameters
See the Parameters section of getAllSrcCTPsForSNCProvisioning.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.21 getAllDestPTPsForSNCProvisioning
Synopsis
void getAllDestPTPsForSNCProvisioning(in globaldefs::NamingAttributes_T managedElementName,in globaldefs::NamingAttributes_T srcCTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs:: NamingAttributesList_T tpList,out globaldefs:: NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of PTP names that can be used as the destination of an SNC to create on a given ME. The NMS must specify the source CTP name, layer rate, and the direction of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns a PTP name list based on current resource availability. The actual SNC creation might still fail.
Parameters
For a list of supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the PTP does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.22 getAllDestCTPsForSNCProvisioning
Synopsis
void getAllDestCTP namesForSNCProvisioning(in globaldefs::NamingAttributes_T ptpName,in globaldefs::NamingAttributes_T srcCTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs::NamingAttributesList_T ctpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of CTP names that can be used as the destination of an SNC to create on a given PTP. The NMS must specify the source CTP name (or source FTP name, in the case of VC3 port grouping circuits that have the source on E3, DS3I, or DS3IN cards), layer rate, and the direction of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns a CTP list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as the zEnd in the SNCCreateData_T parameter of createAndActivateSNCFromUserLabel.
Parameters
For a list of supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the PTP does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.23 getAllDestCTPsForVCATMemberSNCProvisioning
Synopsis
void getAllDestCTPsForVCATMemberSNCProvisioning(in globaldefs::NamingAttributes_T ptpName,in globaldefs::NamingAttributes_T srcTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,out globaldefs:: NamingAttributesList_T tpList,out globaldefs:: NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of CTP names that can be used as the destination of a VCAT member SNC to create on a given PTP. The NMS must specify the source CTP name (or source FTP name for VC3 port grouping circuits whose source is on E3, DS3I, or DS3IN cards), layer rate, and direction of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns a CTP name list based on current resource availability. The actual SNC creation might still fail.
Values returned by this list can be used as the zEnd in each SNCCreateData_T listed from the sncCreateDataList field of the type VCAT SNCCreateData_T, which is required as a parameter of the createVCATl method described in createVCAT.
This interface must be used according to SNC Provisioning for ONS 15454 CE-MR-10 Cards.
Restrict the use of this API to VCAT circuits involving CE-MR-10 cards in Manual mode.
Parameters
See the Parameters section of getAllDestCTPsForSNCProvisioning.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the PTP does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.24 getAllSrcFTPsForSNCProvisioning
Synopsis
void getAllSrcFTPsForSNCProvisioning(in globaldefs::NamingAttributes_T meName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,in unsigned long members,out globaldefs:: NamingAttributesList_T tpList,out globaldefs:: NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of FTP names that can be used as the source of an SNC to create on a given managed element. The NMS must specify the layer rate of the SNC that is created. This interface does not reserve resources for SNC creation; rather, this method returns the FTP name list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as the aEnd in the SNCCreateData_T parameter of the createAndActivateSNCFromUserLabel method described in createAndActivateSNCFromUserLabel.
Parameters
For a list of supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.25 getAllDestFTPsForSNCProvisioning
Synopsis
void getAllDestFTPsForSNCProvisioning(in globaldefs::NamingAttributes_T meName,in globaldefs::NamingAttributes_T srcTPName,in transmissionParameters::LayerRate_T layerRate,in globaldefs::ConnectionDirection_T direction,in unsigned long how_many,in unsigned long no_of_member_circuits,out globaldefs:: NamingAttributesList_T tpList,out globaldefs:: NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of FTP names that can be used as the destination of an SNC to create on a specific managed element. The NMS must specify the source TP (CTP or FTP) name and layer rate of the SNC to create. This interface does not reserve resources for SNC creation; rather, this method returns the FTP name list based on current resource availability. The actual SNC creation might still fail. Values returned by this list can be used as the zEnd in the SNCCreateData_T parameter of the createAndActivateSNCFromUserLabel method described in createAndActivateSNCFromUserLabel.
Parameters
For a list of supported layer rates, see Layer Rate.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised when layerRate or direction are invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.8.26 forceNEResync
Synopsis
void forceNEResync(in globaldefs::NamingAttributes_T meNameraises(globaldefs::ProcessingFailureException);Description
This interface forces Prime Optical to resynchronize the inventory and alarms of the specified managed element. This interface is an asynchronous call and returns after basic validation. The managed element is then queued for resynchronization. Prime Optical generates a state change event indicating that the emsInSyncState has changed to False. Upon successful completion of resynchronization, Prime Optical generates a state change event indicating that the emsInSyncState attribute has changed to True. An entry is made in the Prime Optical error log if the resynchronization fails.
Parameters
meName
globaldefs::NamingAttributes_T
In
Name of the managed element to resynchronize.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or if the managed element is already in the resynchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.8.27 getAllTopologicalLinksForME
Synopsis
void getAllTopologicalLinksForME(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out topologicalLink::TopologicalLinkList_T topoList,out topologicalLink::TopologicalLinkIterator_I topoIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of topological links that originate or terminate on the specified managed element.
Parameters
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.8.28 getAllRolls
Synopsis
void getAllRolls(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out multiLayerSubnetwork::RollList_T rollList,out multiLayerSubnetwork::RollIterator_I rollIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of rolls within the managed element whose name is passed as a parameter.
Parameters
Prime Optical supports Roll_T as follows:
•
Supported. It contains three tuples: the first tuple contains the EMS name, the second tuple contains theManagedElement name, and the third tuple contains the nativeEMSName of this roll.
•
Not supported.
•
Supported. Each roll has a unique name assigned by the Cisco MSM.
•
Not supported.
•
Supported. Possible values are AUTO or MANUAL.
•
Supported. The name of the rollFrom SNC.
•
Supported. The name of the rollTo SNC.
•
Supported. The name of the CTP that is rolled over.
•
Supported. The CTP to which the rollFromCTPName CTP is rolled over.
•
Supported. The following values are supported:
–
–
–
–
•
Supported. Values are TRUE or FALSE.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.8.29 getAllRollNames
Synopsis
void getAllRollNames(in globaldefs::NamingAttributes_T meName,in unsigned long how_many,out globaldefs::NamingAttributesList nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of roll names within the managed element whose name is passed as a parameter.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.8.30 getRoll
Synopsis
void getRoll(in globaldefs::NamingAttributes_T rollName,out multiLayerSubnetwork::Roll_T roll,raises(globaldefs::ProcessingFailureException);Description
This interface returns the Roll_T structure for a specific roll name.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll.
Roll
multiLayerSubnetwork::Roll_T
Out
Roll object.
Prime Optical support for Roll_T is described in getAllRolls.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the roll does not exist.EXCPT_INVALID_INPUT - Raised if the roll name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.8.31 getRollToPTPs
Synopsis
void getRollToPTPs (in globaldefs::NamingAttributes_T meName,in globaldefs::NamingAttributesList_T sncNames,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of PTPs on a managed element that can be used for provisioning a roll on a specific SNC. The returned PTPs can be used to contain the rollToCTP. The SNC must be associated with the managed element on which the interface is invoked.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.8.32 getRollToCTPs
Synopsis
void getRollToCTPs(in globaldefs::NamingAttributes_T ptpName,in globaldefs::NamingAttributesList_T sncNames,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of CTPs contained in the PTP. This list can be used for roll provisioning as the rollToCTP for a given SNC. The list of PTPs can be obtained by using the operation defined in getRollToPTPs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or in config synchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.8.33 getRollFromCTPs
Synopsis
void getRollFromCTPs(in globaldefs::NamingAttributes_T meName,in globaldefs::NamingAttributesList_T sncNames,in globaldefs::NamingAttributes_T fixCTPName,in unsigned long how_many,out globaldefs::NamingAttributesList_T tpList,out globaldefs::NamingAttributesIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of rollFromCTPNames after selecting the fixed point of the roll. This is needed for path-protection SNCs and SNCs that have a secondary source, because multiple rollFromCTP values are possible.
This interface also returns a list of CTPs that can be used to populate the rollFromCTP data structure in the RollCreateData_T data structure.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the cancellation of the rolling operation.EXCPT_UNABLE_TO_COMPLY - Raised when the roll cannot be created.Compliance
Prime Optical-defined.
3.8.34 setPortName
Synopsis
void setPortName(in globaldef::NamningAttributes_T ptpName,in string portName,out string newPortName)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to set a name for the selected port. The PTP specified as input identifies the port. The port name is set to the value passed in through the portName parameter.
Parameters
ptpName
globaldefs::NamingAttributesList_T
In
Name of the PTP whose name will be set.
portName
String
In
Port name value to set for the specified PTP.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when the ptpName does not refer to a valid PTP name or when it contains undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references an object that does not exist.Compliance
Prime Optical-defined.
3.8.35 getPortName
Synopsis
void getPortName (in globaldefs:: NamingAttributes_T ptpName,out string portName )raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to get a name for the selected port. The PTP specified as input identifies the port. The resulting port name is used as the argument parameter.
Parameters
ptpName
globaldefs::NamingAttributesList_T
In
Name of the PTP whose name will be set.
portName
String
Out
Port name specified for the input PTP.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when the ptpName does not refer to a valid PTP name or when it contains undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references an object that does not exist.Compliance
Prime Optical-defined.
3.8.36 getAllClearedAlarms
Synopsis
void getAllClearedAlarms(in globaldefs::NamingAttributes_T meName,in notifications::ProbablyCauseList_T excludeProbCauseList,in notifications::PerceivedSeverityList_T excludeSeverityList,in unsigned long how_many,out notifications::EventList_T eventList,out notifications::EventIterator_I eventIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request all of the cleared and acknowledged alarms for the specified ME. Alarms that are not reported by the ME to the EMS are not reported by this operation. Some alarms may be filtered out by specifying the probable cause of the severities.
The result of this operation is independent of the filtering set up by the NMS for the notification service.
ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH
The ONS 15310 CL, ONS 15310 MA SDH, ONS 15310 MA SONET, ONS 15327, ONS 15454 SONET, ONS 15454 SDH, ONS 15600 SONET, and ONS 15600 SDH do not send a "clear" for TCA events. TCAs are not reported in the eventList returned by this method.
ONS 15530 and ONS 15540
TCAs are reported in the eventList returned by this method. The ONS 15530 and ONS 15540 send a "clear" for TCAs.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific 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 communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.8.37 getAllCrossConnections
Synopsis
void getAllCrossConnections(in globaldefs::NamingAttributes_T managedElementName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::CrossConnectList_T ccList,out subnetworkConnection::CCIterator_I ccIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of cross-connections on the managed element.
Parameters
A cross-connect represents a connection within a single managed element. This structure is used primarily in the specification of routes.
Prime Optical support for the CrossConnection_T structure is as follows:
•
–
•
–
•
–
•
–
•
–
•
–
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_ENTITY_NOT_FOUND - Raised when managedElementName references an MEobject that does not exist.EXCPT_INVALID_INPUT - Raised if managedElementName does not reference amanaged element.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the EMS reaches the maximum number of iterators that it can support.Compliance
TMF-defined.
3.8.38 getAllSoftwareDownloadJobs
Synopsis
void getAllSoftwareDownloadJobs(in unsigned long how_many,out JobMonitorList_T jobList)raises(globaldefs::ProcessingFailureException);Description
This interface retrieves the status of all scheduled and completed software download jobs.
Parameters
how_many
unsigned long
In
Number of download jobs to retrieve.
jobList
JobMonitorList_T
Out
List of jobs scheduled (see the definition that follows this table).
typedef sequence<JobMonitorData_T> JobMonitorList_T;struct JobMonitorData_T{unsigned long jobId;unsigned long taskId;string taskType;string taskOwner;string neId;string taskStatus;string creationTime;string scheduledTime;string startTime;string endTime;string displayInformation;string userComments;string additionalComments;};The following table lists descriptions of each individual parameter.
Throws
globaldefs::ProcessingFailureExceptionCompliance
Prime Optical-defined.
3.8.39 setMEAdminState
Synopsis
void setMEAdminState (in globaldefs::NamingAttributes_T meName,in AdminState_T adminState)raises (globaldefs::ProcessingFailureException)Description
This interface is used to force the EMS to change the administrative state of the managed element to the specified state.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_UNABLE_TO_COMPLY - Raised if the managed element is in the initial poll state or if the managed element is already in the resynchronization state.EXCPT_ENTITY_NOT_FOUND - Raised if the managed element does not exist.EXCPT_INVALID_INPUT - Raised if the managed element name is invalid.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_NOT_IMPLEMENTED - Raised if the EMS does not support this service.The following enum is used to define the various NE admin states:
enum AdminState_T {IN_SERVICE,OUT_OF_SERVICEOUT_OF_SERVICE_BY_MAINTENANCE}Compliance
Prime Optical-defined.
3.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
The multiLayerSubnetworkMgr_I operation is used to gain access to subnetworks and their respective operations. A handle to an instance of this interface is gained through the getManager operation in emsSession. This interface is inherited from common::Common_I.
interface ManagedElementManager_I:common::Common_ImultiLayerSubnetworkMgr_I also implements the getCapabilities method. Operations described in following subsections are returned to the NMS when it invokes getCapabilities.
3.9.1 getAllEdgePoints
Synopsis
void getAllEdgePoints(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T tpLayerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out terminationPoint::TerminationPointList_T tpList,out terminationPoint::TerminationPointIterator_I tpIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request a list of edge termination points for the specified subnetwork at one or more of the NMS-specified layers that are capable of containing CTPs that can be connected at one or more of the NMS-specified connection layer rates.
Prime Optical reports the PTPs that are not part of the topological link.
Parameters
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object, or tpLayerRateList or connectionLayerRateList contain undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.2 getAllEdgePointNames
Synopsis
getAllEdgePointNamesvoid getAllEdgePointNames(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T layerRateList,in transmissionParameters::LayerRateList_T connectionLayerRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request a list of edge termination points for the specified subnetwork at one or more of the NMS-specified layers that are capable of containing CTPs that can be connected at one or more of the NMS-specified connection layer rates.
Prime Optical reports the PTPs that are not part of the topological link.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object or tpLayerRateList or connectionLayerRateList contain undefined values.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.3 getAllManagedElement
Synopsis
void getAllManagedElementNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request a list of managed elements that are associated with the specified subnetwork.
Parameters
For details about the ManagedElement_T structure, see getAllManagedElements.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.4 getAllManagedElementNames
Synopsis
void getAllManagedElementNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the operation described in getAllManagedElement, but instead of returning entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.5 getAllSubnetworkConnections
Synopsis
void getAllSubnetworkConnections(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SNCIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request a list of SNCs for the specified subnetwork at the specified connection rates.
•
•
•
•
•
This interface does not report SNCs with duplicate names or VCAT SNCs.
If the Prime Optical subnetwork contains multiple circuits with the same name, the getAllSubnetworkConnections call returns the circuit name and details for only one of the circuits. It is not possible to predict which one of the multiple circuits will have its name and details returned.
Parameters
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.6 getAllSubnetworkConnectionsWithTP
Synopsis
void getAllSubnetworkConnectionsWithTP(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SNCIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This interface enables an NMS to request a list of the SNCs using the specified TP at the specified connection rates. A TP might be a PTP that requires a full list of SNCs using any of its contained CTPs. A TP might be a CTP or FTP that only requires the SNCs using that CTP or FTP. Both end CTPs and intermediate CTPs at the same layer are considered. In all cases, only SNCs that also match the specified connection rate filter are returned.
•
•
•
•
This interface does not report SNCs with duplicate names.
Note
Parameters
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised if tpName does not reference a termination point object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.7 getAllSubnetworkConnectionNames
Synopsis
void getAllSubnetworkConnectionNames(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the operation described in getAllSubnetworkConnections, but instead of returning entire object structures, this operation returns their names.
Parameters
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.8 getAllSubnetworkConnectionNamesWithTP
Synopsis
void getAllSubnetworkConnectionNamesWithTP(in globaldefs::NamingAttributes_T tpName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the operation described in getAllSubnetworkConnectionsWithTP, but instead of returning entire object structures, this operation returns their names.
Parameters
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised if tpName does not reference a terminationPoint object.EXCPT_ENTITY_NOT_FOUND - Raised when tpName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.9 getAllTopologicalLinks
Synopsis
void getAllTopologicalLinks(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out topologicalLink::TopologicalLinkList_T topoList,out topologicalLink::TopologicalLinkIterator_I topoIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of topological links that exist within the subnetwork whose name is passed as a parameter.
Parameters
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.10 getAllTopologicalLinkNames
Synopsis
void getAllTopologicalLinkNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface has the same behavior as the operation described in getAllTopologicalLinks, but instead of returning entire object structures, this operation returns their names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
TMF-defined.
3.9.11 getMultiLayerSubnetwork
Synopsis
void getMultiLayerSubnetwork(in globaldefs::NamingAttributes_T subnetName,out MultiLayerSubnetwork_T subnetwork)raises(globaldefs::ProcessingFailureException);Description
This interface returns a subnetwork given a subnetwork name.
Parameters
subnetName
globaldefs::NamingAttributes_T
In
Name of the subnetwork.
subnetwork
MultiLayerSubnetwork_T
Out
Subnetwork structure returned.
For details about the MultiLayerSubnetwork_T structure, see getAllTopLevelSubnetworks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references a multiLayerSubnetwork object that does not exist.Compliance
TMF-defined.
3.9.12 getCTPsAndTopologicalLinks
Synopsis
void getCTPsAndTopologicalLinks(in globaldefs::NamingAttributes_T sncName,out terminationPoint::TerminationPointList_T ctpList,out topologicalLink::TopologicalLinkList_T topologicalLinkList)raises(globaldefs::ProcessingFailureException);Description
The NMS provides the SNC name, and Prime Optical returns ordered lists: one list for all CTPs/FTPs and another for all topological links. Prime Optical reports topological links and CTPs/FTPs of the working path for a 1+1, 2-fiber BLSR, or 4-fiber BLSR protected SNC. Prime Optical reports topological links and CTPs/FTPs of both the working and protect paths for a path-protection SNC. An SNC with the source or destination on Ethernet equipment is also supported.
•
•
•
•
This interface does not report VCAT SNCs.
The lists are unordered for circuits for which:
•
•
A processing failure exception is returned with an EXCPT_UNABLE_TO_COMPLY exception in all of the preceding conditions.
Parameters
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_UNABLE_TO_COMPLY - Raised when invoked on SNC on Ethernet equipment or STS-1 SNC on DS1 equipment.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.9.13 getSNC
Synopsis
void getSNC(in globaldefs::NamingAttributes_T sncName,out subnetworkConnection::SubnetworkConnection_T snc)raises(globaldefs::ProcessingFailureException);Description
This interface returns the SNC structure for the SNC whose name is supplied as a parameter.
•
•
•
•
•
•
This interface does not report VCAT SNCs.
A processing failure exception is returned with an EXCPT_UNABLE_TO_COMPLY exception in all of the preceding conditions.
Parameters
sncName
globaldefs::NamingAttributes_T
In
Name of the subnetwork connection.
snc
subnetworkConnection::SubnetworkConnection_T
Out
SNC structure retrieved.
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not reference an SNC object or when sncName is not unique.EXCPT_UNABLE_TO_COMPLY - Raised when invoked on SNC on Ethernet equipment or STS-1 SNC on DS1 equipment.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.9.14 getSNCsByUserLabel
Synopsis
void getSNC(in string userLabel,out subnetworkConnection::SubnetworkConnection_T snc)raises(globaldefs::ProcessingFailureException);Description
This interface returns the SNC structure for the SNC whose name is supplied as a parameter.
•
•
•
•
•
•
This interface does not report VCAT SNCs.
A processing failure exception is returned with an EXCPT_UNABLE_TO_COMPLY exception in all of the preceding conditions.
Parameters
userLabel
String
In
Name of the subnetwork connection.
snc
subnetworkConnection::SubnetworkConnection_T
Out
SNC structure retrieved.
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not reference an SNC object or when sncName is not unique.EXCPT_UNABLE_TO_COMPLY - Raised when invoked on SNC on Ethernet equipment or STS-1 SNC on DS1 equipment.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
TMF-defined.
3.9.15 getTopologicalLink
Synopsis
void getTopologicalLink(in globaldefs::NamingAttributes_T topoLinkName,out topologicalLink::TopologicalLink_T topoLink)raises(globaldefs::ProcessingFailureException);Description
This interface returns a topological link. Prime Optical reports all autodiscovered and manual topological links.
Parameters
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a subnetwork topological link object.EXCPT_ENTITY_NOT_FOUND - Raised when topoLinkName references a subnetwork topological link object that does not exist.Compliance
TMF-defined.
3.9.16 createAndActivateSNCFromUserLabel
Synopsis
void createAndActivateSNCFromUserLabel(in subnetworkConnection::SNCCreateData_T createData,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This interface provides a way to create and activate a subnetwork connection in one command. It is Prime Optical-specific and not TMF-defined. According to the TMF, the SNC name is assigned by the EMS when it creates the SNC. However, if the NMS is to control the SNC name, it must use this method. The NMS provides the name of the SNC in the userLabel field of the SNCCreateData input parameter. Prime Optical uses the userLabel value and assign it to the name of the new SNC. Prime Optical also verifies the uniqueness of the name. The operation fails if an SNC with the same name as the userLabel exists. This is an asynchronous operation. Successful completion of this operation only guarantees delivery of the creation request to Prime Optical. Operation on CTPs of this SNC might still fail.
Optionally, you can also provide a description for the SNC by entering it in the additionalCreationInfo field.
Prime Optical cleans up resources if SNC creation fails. For example, if Prime Optical fails to create the SNC on the destination node, Prime Optical also cleans up resources on the source node.
If the OC-n port is configured for SDH, Prime Optical can create the SNC. Prime Optical supports only those layer rates supported by the NE. However, IPPM and J1 path tracing are not supported for CTPs of this SNC.
FTPs can be used as A ends and Z ends of the SNCs. A typical use of FTP is to create an SNC on Ethernet equipment, create a tunnel SNC, or create a VAP/LAP circuit. See Provisioning Subnetwork Connections for more information.
Creating SNCs between ONS 15327 nodes or ONS 15310, and between ONS 15600 nodes is identical to creating SNCs between ONS 15454 nodes. It is also possible to create SNCs among ONS 15327, ONS 15454, and ONS 15600 nodes.
Prime Optical supports protection channel access (PCA). PCA SNCs are unprotected. For details about PCA, see the NE documentation.
You can provide a description for the SNC. Enter the description in the additionalCreationInfo field.
To create a dual-ring interconnect SNC, set the staticProtectionLevel value in createData to HIGHLY_PROTECTED. Use the CTC or Prime Optical client to modify the Hold-off Timer attribute for this SNC.
The following types of circuit creation are not supported:
•
•
•
In addition to specifying SNC creation parameters using the SNCCreateData_T structure, the NMS can provide a partial or complete list of MEs or both end PTPs of a topological link to include or exclude in the SNC route during SNC creation. The NMS can specify only one type of object name list during the SNC creation. Prime Optical returns a processing failure exception if the NMS-specified list is not homogeneous. Prime Optical returns a processing failure exception with EXCPT_ENTITY_NOT_FOUND as the error reason if any one of the specified MEs or PTPs does not exist. If the NMS specifies a PTP list, Prime Optical verifies whether PTPs are specified in pairs and each PTP of a PTP pair is associated with each end PTP of the same topological link. Prime Optical uses the first PTP of a PTP pair as the aEnd of the topological link, and uses the second PTP of the same PTP pair as the zEnd of the topological link. Prime Optical attempts to route the SNC from the aEnd PTP of a PTP pair to the zEnd PTP of the same pair on a topological link. Prime Optical returns a processing failure exception if the SNC cannot be routed from the specified aEnd PTP to the zEnd PTP of a topological link. The NMS then must interchange the aEnd PTP and zEnd PTP specified, or provide a different PTP pair, or delete the PTP pair from the include or exclude list. Prime Optical returns a processing failure exception if at least one PTP is not associated with a topological link. The NMS must ensure that the sequence of the object name list conforms to the sequence of the objects that exist in the network. Prime Optical returns a processing failure exception if the sequence is nonconforming.
In addition to specifying SNC creation parameters using the SNCCreateData_T structure, the NMS can provide a complete list of CTP pairs representing the complete route of the SNC. Each CTP pair represents the two endpoints of one span in the SNC route. A span represents a partial route of an SNC with the endpoints specified on the endpoints of a topological link. Prime Optical processes the input list in CTP pairs. Prime Optical assumes each pair represents the two endpoints of a span, and the CTP native names are the same for the two endpoints (the STS numbers are the same for each CTP pair). The NMS must ensure that the sequence of spans represented by the CTP pairs conforms to the sequence existing in the network. Prime Optical returns a processing failure exception if the sequence is nonconforming.
If you create an SNC with at least one endpoint on ML-series equipment, Prime Optical identifies the SNC for a new Layer 2 point-to-point topology. Prime Optical creates a new Layer 2 point-to-point topology and an object creation event is generated to notify for the creation of a new L2 point-to-point topology in Prime Optical.
Prime Optical provides support for the creation of open-ended path-protection circuits. There are two types of SNCs that can be created for open-ended path-protection circuits.
For one source point and two destination endpoints, the NMS must specify the source point in SNCCreateData_T.aEnd, and the two destination endpoints in SNCCreateData_T.zEnd.
For two source points and one destination endpoint, the NMS must specify two source points in SNCCreateData_T.aEnd and one destination endpoint in SNCCreateData_T.zEnd.
Prime Optical supports optical channel SNC creation on WDM cards through this method. See SNC Provisioning on WDM Equipment for detailed information. The sncSize field in additionalCreationInfo is used to specify the size of the optical channel SNC.
Prime Optical supports OCH trail SNC creation on DWDM transponder/muxponder cards or ITU-T line cards through a DWDM network. See SNC Provisioning on WDM Equipment.
For the ONS 15454 SONET, this operation enables you to create an end-to-end STS-1 circuit using the portless transmux interfaces of the transmux card as an intermediate connection point. Information about the high-density portless transmux card (DS3XM-12) can be provided using the usePortlessTransmux, portlessTransmuxMeName, portlessTransmuxSlot, and isSourceDS3MappedSTS attributes in the additionalCreationInfo field.
Parameters
Prime Optical does not support locking.
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Prime Optical support for the SNCCreateData_T structure is as follows:
•
Supported. The value in this field is assigned to the name of the newly created SNC.
•
Prime Optical guarantees the uniqueness of SNCs if they are all created by Prime Optical. Prime Optical cannot guarantee the uniqueness if any other tool has been used instead.
•
Not supported.
•
Prime Optical supports CD_UNI (unidirectional), CD_BI (bidirectional), CD_UNI_EW (unidirectional east-to-west), CD_UNI_WE (unidirectional west-to-east), CD_BI_EW (bidirectional east-to-west), and CD_BI_WE (bidirectional west-to-east).
•
Prime Optical supports UNPROTECTED, FULLY_PROTECTED, and HIGHLY_PROTECTED. Prime Optical does not support any other value.
•
Prime Optical supports all values defined by the TMF.
If the NMS requests an unprotected SNC on a BLSR ring, Prime Optical creates the SNC. The same is true for an unprotected SNC with 1+1 protection.
If the NMS specifies EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, Prime Optical expects the value of staticProtectionLevel to be UNPROTECTED. These values indicate that Prime Optical must create the PCA.
•
Not supported.
•
Not supported.
•
Not supported.
•
Prime Optical supports the following layer rates:
•
Not supported.
•
Supported. You must provide a list of managed element names or the PTP names at the endpoints of the topological link. For complete manual routing, you must provide the list of all CTPs of the links (OCH trail links, if any) to which the circuit must be routed.
For protected OCHNC and OCHCC circuits, this parameter defines only the inclusion routing constraints for the working path of the circuit. To define the constraints for the protected path, Prime Optical provides the additional info parameters "includedProtectedME" and "excludedProtectedME."
•
Not supported.
•
Supported. Prime Optical expects a list of managed element names or the PTP names at the endpoints of the TopologicalLink to exclude from the SNC route.
For protected OCHNC and OCHCC circuits, this parameter defines only the exclusion routing constraints for the working path of the circuit. To define the constraints for the protected path, Prime Optical provides the additional info parameters "includedProtectedME" and "excludedProtectedME."
•
Supported. Prime Optical expects at least one valid CTP or FTP in this list. At most, two valid CTPs can be in the list.
•
Supported. Prime Optical expects at least one valid CTP or FTP in this list. At most, two valid CTPs can be in the list.
•
This list can be used to provide additional parameters for SNC creation. The following table provides additional Prime Optical-supported parameters for SNC creation. For more information, refer to the ONS 15454 SONET user documentation.
Prime Optical does not support tolerableImpact (GradesOfImpact_T). Circuits created on the ONS 15327 and ONS 15454 do not impact existing traffic.
Prime Optical does not support emsFreedomLevel (EMSFreedomLevel_T). Prime Optical has full control of SNC creation.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when a field of createData is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when fields of createData reference objects that do not exist.EXCPT_UNABLE_TO_COMPLY - Raised if the SNC cannot be created and activated because CTP conflicts with other SNC or NE does not support this SNC creation. This exception is also raised when Prime Optical cannot meet protection levels or there is no bandwidth available.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents creation of the SNC.EXCPT_USERLABEL_IN_USE - Raised when the user label uniqueness constraint is not met.Compliance
Prime Optical-defined.
3.9.17 CreateAndActivateSNC
Synopsis
void createAndActivateSNCFromUserLabel(in subnetworkConnection::SNCCreateData_T createData,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This interface is identical to createAndActivateSNCFromUserLabel, except that Prime Optical assigns the name of the created subnetwork connection. The userLabel field in SNCCreateData_T can remain blank. Even if the user label is specified, Prime Optical ignores it and assigns a user label to the SNC.
Compliance
TMF-defined.
3.9.18 (Deprecated) createAndActivateProtectedOchccFromUserLabel
Synopsis
void createAndActivateProtectedOchccFromUserLabel(in subnetworkConnection::SNCCreateData_T createData,in OCHCCProtectedConstraints_T ochccProtectedConstraints,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);where:
struct OCHCCProtectedConstraints_T {subnetworkConnection::ResourceList_T neTpProtectedInclusions;subnetworkConnection::ResourceList_T neTpSncProtectedExclusions;};Description
This interface has the same behavior as createAndActivateSNCFromUserLabel, but is used only to create protected OCHCC circuits when it is necessary to specify route constraints for the protected path.
Note
Parameters
Prime Optical supports the following layer rates:
•
•
Compliance
Prime Optical-defined.
3.9.19 addDrops
Synopsis
void addDrops(in globaldefs::NamingAttributes_T sncName,in globaldefs::NamingAttributesList_T zEnd)raises(globaldefs::ProcessingFailureException);Description
This proprietary interface supports SNCs with multiple drops for the ONS 15310, ONS 15327, and ONS 15454. There are two steps to create an SNC with multiple drops:
Step 1
Step 2
Note
•
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or layer rate of any CTP does not match the SNC layer.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised if the CTP is in use by other SNC. This exception is also raised when there is no bandwidth available.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost, which prevents the deactivation of the SNC.Compliance
Prime Optical-defined.
3.9.20 deactivateAndDeleteSNC
Synopsis
void deactivateAndDeleteSNC(in globaldefs::NamingAttributes_T sncName,in subnetworkConnection::GradesOfImpact_T tolerableImpact,in EMSFreedomLevel_T emsFreedomLevel,inout subnetworkConnection::TPDataList_T tpsToModify,out subnetworkConnection::SubnetworkConnection_T theSNC,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This interface provides a way to deactivate and then delete a subnetwork connection in one operation.
Prime Optical removes resources allocated to this SNC from each node. Successful completion of this asynchronous operation guarantees only delivery of the deletion request to Prime Optical. The NMS waits for an OBJECT_DELETION event for the SNC.
Prime Optical performs this operation in two steps:
1.
2.
Parameters
For details about the SubnetworkConnection_T structure, see getAllSNCs.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field in tpsToModify is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deactivation of the SNC.Compliance
TMF-defined.
3.9.21 getVCATSNC
Synopsis
void MultiLayerSubnetworkMgr_I::getVCATSNC(in globaldefs::NamingAttributes_T vcatName,out subnetworkConnection::VCAT_T vcat) raises(globaldefs::ProcessingFailureException);Description
This interface returns the VCAT structure for the VCAT SNC whose name is supplied as an argument. The VCAT SNCs are supported on the following equipment types:
•
•
•
Parameters
vcatName
globaldefs::NamingAttributes_T
In
Name of the VCAT SNC.
vcat
subnetworkConnection::VCAT_T
Out
VCAT structure.
Prime Optical support for VCAT_T is as follows:
•
Supported. This field will contain two tuples. The first tuple contains the value for the EMS. The second tuple contains the VCAT name, which is the same as the nativeEMSName. The value of the name field in the last tuple is VCATSubnetworkConnection.
•
Supported.
•
Supported. Name supplied by the user at creation time will be reported.
•
Not supported.
•
Supported. The state of the VCAT circuit is derived from the states of the member circuits in the same way as it is derived for CCAT SNCs. The values supported are:
–
–
–
–
–
•
Supported. This field represents the direction of the VCAT and not the member L1 SNCs.
Prime Optical supports CD_UNI (unidirectional) and CD_BI (bidirectional). Current release supports only CD_BI.
•
Supported. Current release supports only symmetric VCAT SNCs.
–
–
•
Supported. This field represents the total capacity the VCAT SNC can carry in the forward direction. If the VCAT is symmetrical, it represents the capacity both in the forward and backward directions. To represent the total capacity of a VCAT SNC, VCATLayerRate_T contains the following information:
–
–
For a list of supported layer rates, see Layer Rate.
•
Supported. This field represents the total capacity the VCAT SNC can carry in the backward direction. If the VCAT is symmetrical, this field is ignored. For a list of supported layer rates, see Layer Rate.
•
Supported. This field represents the rate of each member circuit.
•
Supported. This is an FTP representing the port at the aEnd.
•
Supported. This is an FTP representing the port at the zEnd. This field is empty for open-ended VCAT.
•
Not supported.
•
Supported. Prime Optical supports the following values:
–
–
–
•
Supported. Prime Optical supports the following values:
–
–
•
Supported. CustomerID and ServiceID are reported if they are available. The openVcat field reports values of true or false to show whether the SNC is an open-ended VCAT.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not refer to a VCAT SNC object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.Compliance
Prime Optical-defined.
3.9.22 getAllVCATSNCs
Synopsis
void MultiLayerSubnetworkMgr_I::getAllVCATSNCs(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out subnetworkConnection::VCATList_T vcatList,out subnetworkConnection::VCATIterator_I vcatIt) raises(globaldefs::ProcessingFailureException);Description
This interface returns all the VCAT SNCs in the specified multilayer subnetwork. This interface returns only the VCAT SNCs.
Parameters
For details about the VCAT_T structure, see getVCATSNC.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.9.23 getAllVCATSNCNames
Synopsis
void MultiLayerSubnetworkMgr_I::getAllVCATSNCNames(in globaldefs::NamingAttributes_T subnetName,in transmissionParameters::LayerRateList_T connectionRateList,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns the names of all the VCAT SNCs in the specified multilayer subnetwork. This interface returns only the VCAT SNC names.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetName does not reference a multiLayerSubnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.9.24 getAllVCATMemberSNCs
Synopsis
void MultiLayerSubnetworkMgr_I::getAllMemberVCATSNCs(in globaldefs::NamingAttributes_T vcatName,in boolean isTransmit,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T sncList,out subnetworkConnection::SubnetworkConnectionIterator_I sncIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns all of the member SNCs for the VCAT SNC.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference a VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.9.25 getAllVCATMemberSNCNames
Synopsis
void MultiLayerSubnetworkMgr_I::getAllVCATMemberSNCNames(in globaldefs::NamingAttributes_T vcatName,boolean isTransmit,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns the names of all member SNCs for a given VCAT SNC.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference a VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.EXCPT_TOO_MANY_OPEN_ITERATORS - Raised when the maximum number of iterators reaches 128.Compliance
Prime Optical-defined.
3.9.26 createVCAT
Synopsis
void MultiLayerSubnetworkMgr_I::createVCAT(in subnetworkConnection::VCATSNCCreateData_T createData,out subnetworkConnection::VCAT_T vcat,out string errorReason)raises(globaldefs::ProcessingFailureException);Description
This interface attempts to create a VCAT SNC.
Prime Optical generates an object creation event for the VCAT SNC that was created and for the individual Layer 1 SNCs.
Parameters
Prime Optical support for VCATSNCCreateData_T structure is as follows:
•
Supported. Value assigned to this field is the name of the new VCAT.
•
Prime Optical guarantees the uniqueness of all VCATs created by Prime Optical. Prime Optical does not guarantee uniqueness if any other tool is used for VCAT SNC creation.
•
Not supported.
•
Prime Optical supports only CD_BI (bidirectional).
•
Supported. In the current release, only symmetric VCAT SNCs are supported. If set to true, all members are bidirectional L1 SNCs, and the VCAT layer rate is the same for both directions. If set to false, all members are unidirectional L1 SNCs, and the supported VCAT layer rate on either direction can be different.
•
Supported. Prime Optical supports the following values:
–
–
–
•
Supported. Prime Optical supports the following values:
–
–
•
Supported. Prime Optical expects this field to be an FTP representing the information up to port level of the card involved in VCAT SNC.
•
Supported. Prime Optical expects this field to be an FTP representing the information up to the port level of the card involved in the VCAT SNC. This field is empty for open-ended VCAT.
•
Supported. At least one member L1 SNC must be created at the time of VCAT SNC creation. Prime Optical expects user to specify the create data information required to create the L1 SNC(s) in this data structure. For complete information on SNCCreateData_T structure, see createAndActivateSNCFromUserLabel. For every L1 SNC, you must specify an additionalCreationParamemter vcatMemberId, which must contain a unique value from 1 to 256.
•
This list can be used to provide additional parameters for VCAT creation. Prime Optical supports the following values:
•
Supported. You must provide a list of managed element names or the PTP names at the endpoints of the topological link. For complete manual routing, you must provide the list of all CTPs of the links (OCH trail links, if any) to which the circuit must be routed.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when a field of createData is invalid.EXCPT_ENTITY_NOT_FOUND - Raised when fields of createData reference objects that do not exist.EXCPT_UNABLE_TO_COMPLY - Raised if the VCAT SNC cannot be created and activated because FTP conflicts with another VCAT SNC or NE does not support this VCAT SNC creation. This exception is also raised when Prime Optical cannot meet protection levels or there is no bandwidth available.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents creation of the VCAT SNC.EXCPT_USERLABEL_IN_USE - Raised when the user label uniqueness constraint is not met.Compliance
Prime Optical-defined.
3.9.27 deleteVCAT
Synopsis
void deleteVCAT(in globaldefs::NamingAttributes_T vcatName) raises(globaldefs::ProcessingFailureException);Description
This interface deletes the VCAT specified in the input. Prime Optical generates an object deletion event for the VCAT SNC that was deleted and for the individual Layer 1 SNCs that were deleted.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference a VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when deletion of the VCAT SNC fails.Compliance
Prime Optical-defined.
3.9.28 addMemberSNCsToVCAT
Synopsis
void addMemberSNCsToVCAT(in globaldefs::NamingAttributes_T vcatName,in subnetworkConnection::SNCCreateDataList_T sncData,out subnetworkConnection::VCAT_T vcat)raises(globaldefs::ProcessingFailureException);Description
This interface adds a member SNC to the VCAT that is specified in the input. Prime Optical generates an attribute value change event for the VCAT SNC that was modified due to the addition of the new SNC(s), and an object creation event for the member L1 SNCs that were created.
For each new member, you must specify an additional creation parameter called "vcatMemberId," which is a unique number from 1 to 256. The value that you choose cannot be in use by any other members that belong to the VCAT SNC.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference a VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when addition of a member SNC to the VCAT fails.Compliance
Prime Optical-defined.
3.9.29 deleteMemberSNCsFromVCAT
Synopsis
void deleteMemberSNCsFromVCAT(in globaldefs::NamingAttributes_T vcatName,in globaldefs::NamingAttributesList_T sncName,out subnetworkConnection::VCAT_T vcat)raises(globaldefs::ProcessingFailureException);Description
This interface deletes a member SNC from the VCAT specified in the input. Prime Optical generates an attribute value change event for the VCAT SNC that was modified due to the deletion of the member SNC, and an object deletion event for the member L1 SNC that was deleted.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName or sncName does not reference a VCAT/SNC object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName or sncName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when deletion of member SNC(s) from the VCAT fails.Compliance
Prime Optical-defined.
3.9.30 deleteAllMemberSNCFromVCAT
Synopsis
void deleteAllMemberSNCFromVCAT(in globaldefs::NamingAttributes_T vcatName,in boolean isForward)raises( globaldefs::ProcessingFailureException );Description
This interface deletes all member SNCs in the VCAT group that is specified during input. If boolean value is set to true, all member SNCs in the transmit direction are deleted. If boolean value is set to false, all member SNCs in the receive direction are deleted. For symmetrical VCAT, this value is ignored; all member circuits in both transmit and receive directions are deleted. Prime Optical generates an attribute value change for the VCAT SNC modified due to the deletion of member SNC(s), and an object deletion event for the member L1 SNCs deleted.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when vcatName does not reference a VCAT object.EXCPT_ENTITY_NOT_FOUND - Raised when vcatName references an object that does not exist.EXCPT_UNABLE_TO_COMPLY - Raised when deletion of member SNC(s) from the VCAT fails.Compliance
Prime Optical-defined.
3.9.31 getValidSubnetworkConnectionsForMerge
Synopsis
void getValidSubnetworkConnectionsForUpgrade(in multiLayerSubnetwork::SncUpgradeInfo_T details,in multiLayerSubnetwork::SncFilterCriteria_T filterCriteria,in globaldefs::NamingAttributes_T masterSncName,in globaldefs::NamingAttributesList_T candidateSncList,in unsigned long how_many,out subnetworkConnection::SubnetworkConnectionList_T mergeableSncList,out subnetworkConnection::SNCIterator_I sncIt )raises(globaldefs::ProcessingFailureException);Description
This interface is used to get the list of SNCs for the Merge operation. The SncFilterCriteria specifies the SNCs that are requested. These SNCs are lined up. The master SNC name specifies the name of the SNC with which the candidates will merge. The how_many parameter provides the list of SNCs that will be returned.
Note
Parameters
enum SncUpgradeType_T {MERGE,RECONFIGURE};enum SncOperationType_T {STRICT_MERGE,LOOSE_MERGE,NONE};enum SncFilterCriteria_T {LINED_UP,NO_FILTER};struct SncUpgradeInfo_T {SncUpgradeType_T upgradeType;SncOperationType_T operationType;};Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
3.9.32 upgrade
Synopsis
void upgrade(in multiLayerSubnetwork::SncUpgradeInfo_T details,in globaldefs::NamingAttributes_T masterSncName,in globaldefs::NamingAttributesList_T upgradableSncNameList,out string resultString )raises(globaldefs::ProcessingFailureException);Description
This interface is used to merge or configure a list of SNCs to the SNC reported in the masterSncName. This interface supports STRICT MERGE and LOOSE MERGE as operation types from the OSS. The LOOSE MERGE option in SncUpgradeInfo_T is available only if a strict operation failed and the OSS receives a processing failure exception with EXCPT_STRICT_MERGE_FAILED.
There is no restriction in GateWay/CORBA to prevent a LOOSE MERGE operation from the OSS during a normal call.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_STRICT_MERGE_FAILED - Raised when a strict merge operation from the OSS fails. The OSS uses this exception to issue a loose merge call.Compliance
Prime Optical-defined.
3.9.33 createRoll
Synopsis
void createRoll(in multiLayerSubnetwork::RollCreateData_T rollCreateData)raises(globaldefs::ProcessingFailureException);Description
Prime Optical supports roll creation on optical CTPs. Electrical CTPs and FTPs are not supported for bridge and roll creation.
Prime Optical generates an Object Creation event for the roll created and subnetwork connections created as part of the roll creation. The subnetwork connections that are created as part of the roll creation will be named as nativeEMSName of the SNC appended with _ROLL** where ** is a number.
The creation of bridge and roll is an asynchronous process. If the operation fails, Prime Optical cleans up all resources. For example, if Prime Optical fails to create a bridge and roll on one node, it also cleans up resources on other nodes.
Parameters
rollCreateData
multiLayerSubnetwork::RollCreateData_T
In
Structure describing the roll to create.
For details about the Roll_T structure, see getAllRolls.
Prime Optical support for RollCreateData_T is as follows:
•
Supported.
•
Supported.
•
Supported. This refers to the name of the SNC to roll partially or fully. If two SNCs are specified, the first SNC will be the RollFromSNC and the second SNC will be the RollToSNC.
•
Supported. This refers to the fully qualified name of the CTP of the SNC. This CTP is the fixed point of the roll. In cases where the rollType is DUAL, there will be two fixed points in the roll. The first fixCTP indicates the first fixed point in the roll object and the second fixCTP indicates the second fixed point of the roll.
•
Supported. This refers to the fully qualified name of the CTP of the SNC. This CTP is either the source or destination or any other associated CTP of the SNC. In cases where the rollType is DUAL, the first element in the array indicates the first rollFromCTP point and the second element in the array indicates the second rollFromCTP point.
Note
•
Supported. This refers to the fully qualified name of the CTP where the roll occurs. In cases where the rollType is DUAL, the first element in the array indicates the first rollToCTP point and the second element in the array indicates the second rollToCTP point.
•
Supported. Prime Optical expects a list of managed element names or PTP names of the endpoint of a topological link or CTP name pair representing the endpoints of the span to include in the subnetwork connection route. For complete manual routing, Prime Optical expects the list of all CTPs of the links (OCH Trail circuit links, if any) to which the circuit must be routed. If the OSS specifies a CTP pair in the neTpInclusions, the entire path for the subnetwork connection must be specified.
•
Supported. Prime Optical expects a list of managed element names or PTP names of the endpoint of a topological link representing the endpoints of the span to exclude in the subnetwork connection route.
•
Prime Optical supports the following for the subnetwork connection that is created as part of the roll creation:
–
–
–
Note
•
If the NMS requests unprotected SNC on a BLSR ring, Prime Optical creates the SNC. The same is true for unprotected SNC on 1+1 protection.
If the NMS requests EFFORT_SAME_OR_WORSE or EFFORT_WHATEVER, Prime Optical expects a value of staticProtectionLevel of UNPROTECTED. These values indicate that Prime Optical must create the PCA.
Prime Optical support for Roll_T is described in getAllRolls.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field in rollCreateData is invalid, or the data does not conform to roll creation rules.EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deactivation of the SNC.EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.Compliance
Prime Optical-defined.
Scenarios: Roll Creation
Figure 3-1 Example 1: Roll Source or Destination of an SNC—Part 1
Figure 3-2 Example 2: Roll Source or Destination of an SNC—Part 2
Figure 3-3 Example 3: Roll Intermediate Managed Elements or Topological Links
3.9.34 deleteRoll
Synopsis
void deleteRoll(in globaldefs::NamingAttributes_T rollname)raises(globaldefs::ProcessingFailureException);Description
Prime Optical generates an object deletion event for the deleted roll object. Prime Optical also generates object deletion events for the SNCs that are deleted.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll to delete.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deletion of the roll.Compliance
Prime Optical-defined.
3.9.35 cancelRoll
Synopsis
void cancelRoll(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
This interface cancels a roll task when the rollValidSignal is not received. For more information on canceling a roll task, see the network element documentation.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll to cancel.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the cancellation of the roll operation.EXCPT_UNABLE_TO_COMPLY - Raised when the roll cannot be created.Compliance
Prime Optical-defined.
3.9.36 forceValidSignal
Synopsis
void forceValidSignal(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
This interface runs on both automatic and manual rolls.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll on which to force a valid signal.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost.Compliance
Prime Optical-defined.
3.9.37 completeRoll
Synopsis
void completeRoll(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
This interface must run on manual rolls (RollMode_T.MANUAL).
Prime Optical generates a state change event upon completion of the roll.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll to complete.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deactivation of the SNC.Compliance
Prime Optical-defined.
3.9.38 finishRoll
Synopsis
void completeRoll(in globaldefs::NamingAttributes_T rollName)raises(globaldefs::ProcessingFailureException);Description
This interface is invoked to finish rolls. When the roll is finished, it is cleared from the rolls list and the new rolled SNC becomes active.
Parameters
rollName
globaldefs::NamingAttributes_T
In
Name of the roll to finish.
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when rollName does not refer to a roll object.EXCPT_ENTITY_NOT_FOUND - Raised when rollName references an object that does not exist.EXCPT_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deactivation of the SNC.Compliance
Prime Optical-defined.
3.9.39 getAllRolls
Synopsis
void getAllRolls(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out multiLayerSubnetwork::RollList_T rollList,out multiLayerSubnetwork::RollIterator_I rollIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of rolls within the subnetwork whose name is passed as a parameter.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetwork name does not refer to a subnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetwork references an object that does not exist.Compliance
Prime Optical-defined.
3.9.40 getAllRollNames
Synopsis
void getAllRollNames(in globaldefs::NamingAttributes_T subnetName,in unsigned long how_many,out globaldefs::NamingAttributesList_T nameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns a list of roll names within the subnetwork whose name is passed as a parameter.
Parameters
Throws
globaldefs::ProcessingFailureExceptionEXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.EXCPT_INVALID_INPUT - Raised when subnetwork name does not refer to a subnetwork object.EXCPT_ENTITY_NOT_FOUND - Raised when subnetwork references an object that does not exist.Compliance
Prime Optical-defined.
3.9.41 getAssociatedRollNamesForSNC
Synopsis
void getAssociatedRollNamesForSNC(in globaldefs::NamingAttributes_T sncName,in unsigned long how_many,out globaldefs::NamingAttributesList rollNameList,out globaldefs::NamingAttributesIterator_I nameIt)raises(globaldefs::ProcessingFailureException);Description
This interface returns all the rolls associated with the SNC.
Parameters
Throws
globaldefs::ProcessingFailureException<EXCPT_INTERNAL_ERROR - Raised in case of nonspecific EMS internal failure.
