- 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
Cisco Prime Optical GateWay/CORBA User Guide and Programmer Manual, 9.3
- Updated:
- February 1, 2018
Chapter: Chapter 3: Using Cisco Prime Optical GateWay/CORBA Interfaces
- 3.1 Overview of APIs Supported by NE Type
- 3.2 common::Common_I
- 3.3 emsMgr::EMSMgr_I
- 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.8 createTopologicalLink
- 3.3.9 createTopologicalLinkWithYCableProtection
- 3.3.10 deleteTopologicalLink
- 3.3.11 modifyTopologicalLink
- 3.3.12 getEMS
- 3.3.13 getAllL2Topologies
- 3.3.14 getAllQoSTemplateNames
- 3.3.15 getAllQoSTemplates
- 3.3.16 getQoSTemplate
- 3.3.17 getAllEMSandMEClearedAlarms
- 3.3.18 getAllEMSSystemClearedAlarms
- 3.3.19 Passive Unit EMS Alarms
- 3.3.20 create ServerTrailLink
- 3.3.21 delete ServerTrailLink
- 3.3.22 addNetworkPartition
- 3.3.23 addMultiLayerSubnetwork
- 3.3.24 deleteNetworkPartition
- 3.3.25 deleteMultiLayerSubnetwork
- 3.3.26 getAllSupportedMEModels
- 3.4 EmsSession::EmsSession_I
- 3.5 emsSessionFactory::EmsSessionFactory_I
- 3.6 equipment::EquipmentInventoryMgr_I
- 3.6.1 getAllEquipment
- 3.6.2 getAllEquipmentNames
- 3.6.3 getAllSupportedPTPs
- 3.6.4 getAllSupportedPTPNames
- 3.6.5 getAllSupportingEquipment
- 3.6.6 getAllSupportingEquipmentNames
- 3.6.7 getContainedEquipment
- 3.6.8 getEquipment
- 3.6.9 provisionEquipment
- 3.6.10 setAlarmReportingOff
- 3.6.11 setAlarmReportingOn
- 3.6.12 unprovisionEquipment
- 3.7 maintenanceOps::MaintenanceMgr_I
- 3.8 managedElementManager::ManagedElementManager_I
- 3.8.1 getAllActiveAlarms
- 3.8.2 getAllSNCs
- 3.8.3 getAllManagedElements
- 3.8.4 getAllManagedElementNames
- 3.8.5 getAllPTPs
- 3.8.6 getAllPTPNames
- 3.8.7 getContainedInUseTPs
- 3.8.8 getContainedInUseTPNames
- 3.8.9 getContainedPotentialTPs
- 3.8.10 getContainedPotentialTPNames
- 3.8.11 getContainingSubnetworkNames
- 3.8.12 getManagedElement
- 3.8.13 getAllCtmMEInternalPatchcord
- 3.8.14 setAdditionalInfo
- 3.8.15 getTP
- 3.8.16 getAssociatedTopologicalLinks
- 3.8.17 setTPData
- 3.8.18 getAllSrcPTPsForSNC Provisioning
- 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.26 forceNEResync
- 3.8.27 getAllTopologicalLinksForME
- 3.8.28 getAllRolls
- 3.8.29 getAllRollNames
- 3.8.30 getRoll
- 3.8.31 getRollToPTPs
- 3.8.32 getRollToCTPs
- 3.8.33 getRollFromCTPs
- 3.8.34 setPortName
- 3.8.35 getPortName
- 3.8.36 getAllClearedAlarms
- 3.8.37 getAllCrossConnections
- 3.8.38 getAllSoftwareDownloadJobs
- 3.8.39 setMEAdminState
- 3.9 multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
- 3.9.1 getAllEdgePoints
- 3.9.2 getAllEdgePointNames
- 3.9.3 getAllManagedElement
- 3.9.4 getAllManagedElementNames
- 3.9.5 getAllSubnetworkConnections
- 3.9.6 getAllSubnetworkConnectionsWithTP
- 3.9.7 getAllSubnetworkConnectionNames
- 3.9.8 getAllSubnetworkConnectionNamesWithTP
- 3.9.9 getAllTopologicalLinks
- 3.9.10 getAllTopologicalLinkNames
- 3.9.11 getMultiLayerSubnetwork
- 3.9.12 getCTPsAndTopologicalLinks
- 3.9.13 getSNC
- 3.9.14 getSNCsByUserLabel
- 3.9.15 getTopologicalLink
- 3.9.16 createAndActivateSNCFromUserLabel
- 3.9.17 CreateAndActivateSNC
- 3.9.18 (Deprecated) createAndActivateProtectedOchccFromUserLabel
- 3.9.19 addDrops
- 3.9.20 deactivateAndDeleteSNC
- 3.9.21 getVCATSNC
- 3.9.22 getAllVCATSNCs
- 3.9.23 getAllVCATSNCNames
- 3.9.24 getAllVCATMemberSNCs
- 3.9.25 getAllVCATMemberSNCNames
- 3.9.26 createVCAT
- 3.9.27 deleteVCAT
- 3.9.28 addMemberSNCsToVCAT
- 3.9.29 deleteMemberSNCsFromVCAT
- 3.9.30 deleteAllMemberSNCFromVCAT
- 3.9.31 getValidSubnetworkConnectionsForMerge
- 3.9.32 upgrade
- 3.9.33 createRoll
- 3.9.34 deleteRoll
- 3.9.35 cancelRoll
- 3.9.36 forceValidSignal
- 3.9.37 completeRoll
- 3.9.38 finishRoll
- 3.9.39 getAllRolls
- 3.9.40 getAllRollNames
- 3.9.41 getAssociatedRollNamesForSNC
- 3.9.42 getAssociatedSNCNamesForRoll
- 3.9.43 createAndActivateSNCOnDRI
- 3.9.44 addManagedElement
- 3.9.45 deleteManagedElement
- 3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards
- 3.10.1 createMLVLAN
- 3.10.2 modifyMLVLANAddFrontPorts
- 3.10.3 modifyMLVLANDropFrontPorts
- 3.10.4 modifyMLVLANPortState
- 3.10.5 modifyMLVLANRSTPState
- 3.10.6 modifyMLVLANTPQOS
- 3.10.7 modifyMLVLANCustomerIDServiceID
- 3.10.8 getMLVLAN
- 3.10.9 deleteMLVLAN
- 3.10.10 getAllMLVLANs
- 3.10.11 getAllMLVLANNames
- 3.10.12 getAllAssociatedSNCs
- 3.10.13 getL2Topology
- 3.10.14 getAssociatedL2TopologyForSNC
- 3.10.15 getAssociatedL2TopologyForMLVLAN
- 3.10.16 createL2Topology
- 3.10.17 deleteL2Topology
- 3.10.18 modifyL2Topology
- 3.10.19 getAllAvailableMLEquipmentOrTPNames
- 3.11 E-Series VLAN Interfaces
- 3.12 nmsSession::NmsSession_I
- 3.13 performance::PerformanceManagementMgr_I
- 3.13.1 disablePMData
- 3.13.2 enablePMData
- 3.13.3 setTCATPParameter
- 3.13.4 getTCATPParameter
- 3.13.5 getCTMHistoryPMData
- 3.13.6 getCTMValidHistoryPMData
- 3.13.7 deleteHistoryPMDataFile
- 3.13.8 getTPHistoryPMData
- 3.13.9 getHoldingTime
- 3.13.10 getAllCurrentPMData
- 3.13.11 getMEPMcapabilities
- 3.13.12 Passive Unit EMS PM
- 3.14 protection::ProtectionMgr_I
- 3.15 session::Session_I
- 3.16 mtnmVersion::Version_I
- 3.17 Transmission Descriptor Interfaces
- 3.18 Software and Data Manager Interface
- 3.18.1 backupME
- 3.18.2 getMEBackupStatus
- 3.18.3 abortMEBackup
- 3.18.4 getBackupList
- 3.18.5 activateSoftwareOnME
- 3.18.6 revertSoftwareOnME
- 3.18.7 restoreME
- 3.18.8 getMERestoreStatus
- 3.18.9 abortMERestore
- 3.18.10 getAllSupportedMESoftwareVersions
- 3.18.11 downloadMESoftware
- 3.18.12 addSupportedMESoftwareVersion
- 3.18.13 getSWDownloadStatus
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
- common::Common_I
- emsMgr::EMSMgr_I
- EmsSession::EmsSession_I
- emsSessionFactory::EmsSessionFactory_I
- equipment::EquipmentInventoryMgr_I
- maintenanceOps::MaintenanceMgr_I
- managedElementManager::ManagedElementManager_I
- multiLayerSubnetwork::MultiLayerSubnetworkMgr_I
- L2 Topology and ML VLAN for ML-Series Ethernet Cards
- E-Series VLAN Interfaces
- nmsSession::NmsSession_I
- performance::PerformanceManagementMgr_I
- protection::ProtectionMgr_I
- session::Session_I
- mtnmVersion::Version_I
- Transmission Descriptor Interfaces
- Software and Data Manager Interface
Note The iterator interfaces defined by the TMF are not listed here. Prime Optical implementation of these interfaces does not deviate from the TMF definition.
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
This interface retrieves the capabilities of the manager. All nonspecified capabilities are assumed to be unsupported.
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
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.
This interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.3.1 getAllEMSAndMEActiveAlarms
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.
TCAs are reported in the eventList returned by this method. The ONS 15540 sends a “clear” for TCAs.
3.3.2 getAllEMSSystemActiveAlarms
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.
3.3.3 getAllTopLevelSubnetworks
This interface enables an NMS to request all subnetworks that are under the control of the EMS.
Prime Optical support for MultiLayerSubnetwork_T is as follows:
– Supported. This field contains two tuples. The first tuple identifies the EMS. The second tuple is the same as nativeEMSName. The naming convention is described in Multilayer Subnetwork.
– Supports TOPO_SINGLETON, TOPO_CHAIN, TOPO_PSR, TOPO_OPEN_PSR, TOPO_SPRING, TOPO_OPEN_SPRING, and TOPO_MESH.
For the Prime Optical client subnetwork types, the following mapping applies:
3.3.4 getAllTopLevelSubnetworkNames
This interface has the same behavior as the interface described in getAllTopLevelSubnetworks , but instead of returning entire object structures, this interface returns their names.
3.3.5 getAllTopLevelTopologicalLinks
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.
Maximum number of top-level topological links to return in the first batch. |
|||
Iterator to retrieve the remaining top-level topological links. |
Prime Optical support for TopologicalLink_T structure is as follows:
– Supported. This field has two tuples. The first tuple is for the EMS. The second is for the topological link. The value in the second tuple is the same as the nativeEMSName field except for the Y-cable links, which have “::1” and “::2” appended to the nativeEMSName to identify the two legs of the Y-cable link.
– Supported. For more information, see Naming Conventions.
- globaldefs::ConnectionDirection_T direction. Prime Optical supports CD_BI for bidirectional links and CD_UNI for unidirectional links.
- transmissionParameters::LayerRate_T rate. Supported. For a list of possible values, see Layer Rate.
- globaldefs::NamingAttributes_T aEndTP
– Supported parameters are listed in the following table.
3.3.6 getAllTopLevelTopologicalLinkNames
This interface has the same behavior as the interface described in getAllTopLevelTopologicalLinks, but instead of returning entire object structures, this interface returns their names.
3.3.7 getTopLevelTopologicalLink
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.
EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a top level topological link object.
3.3.8 createTopologicalLink
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 Prime Optical creates topological links between two PTPs even if there are no existing physical link connections in the network. To enable SDCC on the topological link, the NMS must ensure the presence of physical link connectivity.
Prime Optical support for TLCreateData_T structure is as follows:
– Supported. The value of this field is assigned to the name of the newly created topological link. For patchcord links, Prime Optical assigns the link name. The user label that is passed as input is ignored for patchcord links.
– Prime Optical guarantees the uniqueness of topological link names.
– Prime Optical supports CD_BI for bidirectional links.
– Prime Optical supports CD_UNI for unidirectional links.
- transmissionParameters::LayerRate_T rate. For a list of supported layer rates, see Layer Rate.
- globaldefs::NamingAttributes_T aEndTP
– Supported. The supported parameters are listed in the following table.
– Supported. This field holds the shared risk link group (SRLG) group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.
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.
[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=8
If 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.
3.3.9 createTopologicalLinkWithYCableProtection
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.
Data structure containing details for creating a new Y-cable topological link. |
|||
One leg of the created Y-cable topological link information. |
Prime Optical support for MTLCreateData_T structure is as follows:
– Supported. The value of this field is assigned to the nativeEMSName of the newly created topological link.
– Prime Optical guarantees the uniqueness of topological link names.
– Supports only CD_BI for bidirectional links.
– Supported. It contains only one PTP.
– Supported. It contains two PTPs on the same ME.
– Supported. The supported parameters are listed in the following table.
– Supported. This field holds the SRLG group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are only supported for SONET/SDH topological links.
3.3.10 deleteTopologicalLink
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 • Prime Optical deletes topological links between two PTPs even if there is a physical link connection in the network. The NMS must ensure the disabling of the SDCC, the deletion of all circuits carried through the link, and the removal of the physical link connectivity.
- Patchcord links are deleted twice. The first delete operation forces the link to become invalid, but the link information is still present in the Prime Optical database. The second delete operation removes the link information from the Prime Optical database.
EXCPT_ENTITY_NOT_FOUND - Raised if the specified topological link name does not exist in Prime Optical.
EXCPT_UNABLE_TO_COMPLY - Raised if an attempt is made to delete an auto-discovered topological link.
Prime Optical-defined. This interface is already proposed in TMF and will be included TMF Release 3.0.
3.3.11 modifyTopologicalLink
This interface enables an NMS to modify the following parameters of existing topological links:
- Cost attribute (modifiable only for SONET and SDH links)
- SRLG values (modifiable only for SONET and SDH links)
Note The modifyTopologicalLink API is not supported for links with patchcord provisioning. Also, you cannot use the modifyTopologicalLink API to modify the link description on any supported NEs.
Prime Optical support for TLCreateData_T structure is as follows:
– Supported. The value of this field is assigned to the name of the newly created topological link.
– Prime Optical guarantees the uniqueness of topological link names.
– Prime Optical supports CD_BI for bidirectional links and CD_UNI for unidirectional links.
- transmissionParameters::LayerRate_T rate. For a list of supported layer rates, see the layer rates supported in createTopologicalLink.
- globaldefs::NamingAttributes_T aEndTP
– Supported. The supported parameters are listed in the following table.
– Supported. This field holds the SRLG group values. This is an optional parameter. You can include the SRLG group during link creation. A maximum of five SRLG groups are supported for a given link. SRLG groups are supported only for SONET/SDH topological links.
3.3.12 getEMS
This interface enables an NMS to request EMS information.
Prime Optical supports EMS_T is as follows:
– EMS ID is returned as the same name that is displayed on the Prime Optical client EMS property sheet.
– Prime Optical returns the EMS ID that is displayed on the Prime Optical client EMS property sheet.
– Prime Optical returns “9.3.”
3.3.13 getAllL2Topologies
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.
Maximum number of L2 topologies to return in the first batch. |
|||
List of available L2 topologies in this multilayer subnetwork. |
|||
Prime Optical support for L2Topology_T structure is as follows:
– Supported. The field contains two tuples. The first tuple contains a value for EMS. The second tuple contains the L2 topology name.
– Supported. The L2 topology name is reported.
– Supported. This represents the total capacity of the L2 topology. L2TopoLayerRate_T contains the following information:
- LayerRate_T layerRate—Represents the layer rate of the SNCs. For VCAT, represents the layer rate of the member SNCs.
- Unsigned long numberOfVcatMembers—Represents the number of members in each SNC of an L2 topology consisting of all VCAT SNCs. In all other cases, it contains a value less than one and should be ignored.
- Supported layer rates are:
LR_STS1_and_AU3_High_Order_VC3
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)
– The L2 topology type. Valid values are L2TopoType.PT2PT, L2TopoType.RPR, and L2TopoType.DOT17_RPR.
– GateWay/CORBA handles the L2 topology states L2TopoState.COMPLETE and L2TopoState.INCOMPLETE.
Note The L2TopoState API does not take into consideration the L2 protection information (WRAPPING or STEERING). Consequently, the COMPLETE_WRAPPING and COMPLETE_STEERING states are remapped into COMPLETE. Likewise, the INCOMPLETE_WRAPPING and INCOMPLETE_STEERING states are remapped into INCOMPLETE.
– The operational state of the L2 topology. Valid values are L2TopoOperState.IS, L2TopoOperState.ISPARTIAL, and L2TopoOperState.OOS.
– The current L2 topology synchronization state. Valid values for L2TopoSyncState are:
- L2TopoSyncState. NEEDED
- L2TopoSyncState. INPROGRESS
- L2TopoSyncState. COMPLETE
- L2TopoSyncState. PARTIALLY_COMPLETE
- L2TopoSyncState. FAILED
- L2TopoSyncState. L2SERVICENOTREADY
- globaldefs::NVSList_T additionalInfo
– If the topology type is DOT17_RPR, the bandwidth parameter values return the absolute bandwidth reserved for the class of traffic. The return value is similar to 250 (Class A). The number 250 indicates 250 Mbps bandwidth reserved for Class A-type traffic. Multicast bandwidth parameters are not supported for this type of topology. If no values are defined for class types, the following default values are returned:
- ClassSpMgmt: C
- ClassCommitted: C
- ClassBestEffort: C
- ClassAvvidControl: B
- ClassAvvidVoiceVideo: A
- ClassAReservedBandwidth: 0
- ClassA1Bandwidth: 10
- ClassBCommittedBandwidth: 10
- SpMgmtCoS: 6, 7
- CommittedCoS: 1, 2
- AvvidVoiceVideoCoS: 5
- AvvidControlCoS: 3
- CosCommit: 2
– The bandwidth parameters SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, AvvidControlBandwidth, SpMgmtCoS, CommittedCoS, AvvidVoiceVideoCoS, AvvidControlCoS, and the CoS value CosCommit are supported. Either all or none of these parameters are passed. Each of the bandwidth parameters (SpMgmtBandwidth, CommittedBandwidth, BestEffortBandwidth, and AvvidControlBandwidth) is from 1 to 96; the sum of all four bandwidth parameters is from 1 to 99. The CoS commit value is from 0 to 7. If none of these parameters is passed, Prime Optical takes the following default values:
3.3.14 getAllQoSTemplateNames
This interface lists all QoS template names in the EMS. The QoSTemplate has a scope in the EMS.
3.3.15 getAllQoSTemplates
This interface lists all QoS templates in the EMS. The QoSTemplate has a scope in the EMS.
Prime Optical support for QoSTemplate structure is as follows:
- globaldefs::NamingAttributes_T templateName—Supported. This field specifies the template name.
- string qos_template_description—Supported. This field specifies the description of the template.
- emsMgr::TemplateType_T—TemplateType specifies the type of template. Prime Optical supports the following types:
- QOSPolicy_T policy—Supported. This field specifies the QoS policy for the template.
- QOSPolicy_T is defined as follows:
– string policy_name—Supported. This field specifies the policy name for the QoS.
– QoSClassList_T qosClass—Supported. This field provides a list of QoS classes for the policy.
Each QoSClass_T has the following members:
- multiLayerSubnetwork::MatchProtocolList_T classification—Supported. Each MatchProtocol_T is defined as:
- Classification_T matchTraffic—Specifies the traffic classification. Prime Optical supports the following classifications:
string value—This field is a string value. Multiple values are separated by spaces.
- string class_name—Supported. This field specifies the name of the QoS class.
- QoSPolicer_T policer—Supported. This field specifies the policer to use.
- QoSPolicer_T structure has the following members:
– multiLayerSubnetwork::CIRType_T cir_type—Supported. This field specifies the type of CIR (line rate or rate limited). Prime Optical defines the following values:
– long cir—Supported. This field specifies the CIR value in the range of 96 to 800,000 kilobits per second.
– long cir_burst—Supported. This field specifies the CIR burst value in the range of 8000 to 64000 bytes.
– multiLayerSubnetwork::COSMarking_T cir_cos—Supported. Specifies the type of CoS marking for the CIR. Prime Optical supports the following values:
– COSMarking_T.COSMARKING_MARK_COS
– COSMarking_T.COSMARKING_TRUST
– long cir_cos_val—Supported. This field specifies the CIR CoS value.
– multiLayerSubnetwork::ExcessAction_T excess_act—Supported. Prime Optical supports the following values:
– ExcessAction_T.EXCESS_ACTION_DISCARD
– ExcessAction_T.EXCESS_ACTION_ALLOW
– long pir—Supported. This field specifies the PIR value in the range of 96 to 800,000 kilobits per second. The PIR value is equal to or greater than the CIR value.
– long pir_burst—Supported. This field specifies the PIR burst value in the range of 8000 to 64000 bytes. The PIR burst value is equal to or greater than the CIR burst value.
– multiLayerSubnetwork::COSMarking_T pir_cos—Supported. This field specifies the type of CoS marking for PIR. Prime Optical supports the following values:
– long pir_cos_value—Supported. This field specifies the PIR COS value.
– multiLayerSubnetwork::ViolateAction_T violate_act—Supported. Prime Optical supports the following values:
– ViolateAction_T.VIOLATE_ACTION_DISCARD
– ViolateAction_T.VIOLATE_ACTION_ALLOW
– long violate_cos_val—Supported. This field specifies the violated COS value.
– multiLayerSubnetwork::BesteffortType_T beff_type—Supported. Prime Optical supports the following values for best effort type:
– long beff_rate—Supported. This field specifies the maximum rate of best effort in the range of 96 to 800,000 kilobits per second.
– long beff_rate_burst—Supported. This field is in the range of 8000 to 64000 bytes.
- multiLayerSubnetwork::MatchOption_T operator—Supported. Prime Optical supports the following Match option:
– MatchOption_T.MATCH_OPTION_OR
– MatchOption_T.MATCH_OPTION_AND
Note Prime Optical always uses MatchOption_T.MATCH_OPTION_AND.
3.3.16 getQoSTemplate
This interface lists the complete QoSTemplate information for each QoSTemplate name. The QoSTemplate has a scope in the EMS.
For details about the QoSTemplate_T structure, see getAllQoSTemplateNames.
3.3.17 getAllEMSandMEClearedAlarms
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.
TCAs are reported in the eventList that is returned by this method. The ONS 15540 sends a “clear” for TCAs.
3.3.18 getAllEMSSystemClearedAlarms
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.
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
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 • STLCreateData_T is a Prime Optical-defined data structure. The TMF proposed this structure and included it in the TMF 3.0 specification.
- Prime Optical creates the server trail link between two CTPs even if there are no existing physical link connections in the network.
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.
Prime Optical supports only CD_BI for bidirectional links.
– LR_STS1_and_AU3_High_Order_VC3
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.
Prime Optical supports only CD_BI for bidirectional links.
– LR_STS1_and_AU3_High_Order_VC3
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.
3.3.21 deleteServerTrailLink
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.
EXCPT_ENTITY_NOT_FOUND - Raised if the specified server trail link name does not exist in Prime Optical.
3.3.23 addMultiLayerSubnetwork
void addMultiLayerSubnetwork(in MultiLayerSubnetworkCreateData _T subnetCreateData) raises(globaldefs::ProcessingFailureException);
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.
The structure for MultiLayerSubnetworkCreateData _T is as follows:
The description of each parameter is as follows:
The NMS uses the additionalInfo attribute to communicate to the EMS any other information required to create the multiLayerSubnetwork. |
The structure of Additional Info is as follows:
The parameter name “Type” in additionalInfo can have the following values:
3.3.24 deleteNetworkPartition
This interface enables the OSS to delete an existing network partition.
3.3.25 deleteMultiLayerSubnetwork
void deleteMultiLayerSubnetwork(in globaldefs::NamingAttributes_T subnetworkName) raises(globaldefs::ProcessingFailureException);
This interface allows the NMS to delete an existing subnetwork. Successful operation requires the EMS to generate an object deletion event.
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.
3.4.1 getEventChannel
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.
3.4.2 getManager
This interface enables an NMS to access the specified manager interface.
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.
3.5.1 getEmsSession
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.
3.5.2 getEmsPublicKey
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.
3.5.3 getEmsPublicKeyPair
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.
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.
This interface implements the getCapabilities method. Operations described in the following sections are returned to the NMS when it invokes getCapabilities.
3.6.1 getAllEquipment
This interface enables an NMS to request all of the equipment and equipment holders contained in a managed element or equipment holder.
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:
– Supported. This field has four tuples. The first tuple is for EMS, the second is for ManagedElement, the third is for EquipmentHolder, and the fourth contains equipment. The value of the fourth tuple is the same as the value in the nativeEMSName field.
– Supported. The naming convention is described in Equipment Holder.
– Supported for ONS 15327 and ONS 15454 only.
– ONS 15216—All values listed in Table D-1 are supported.
– ONS 15305 and ONS 15305 CTC—All values listed in Table D-2 and Table D-3 are supported.
– ONS 15310 CL—All values listed in Table D-4 are supported.
– ONS 15310 MA SDH—All values listed in Table D-5 are supported.
– ONS 15310 MA SONET—All values listed in Table D-6 are supported.
– ONS 15327—All values listed in Table D-7 are supported.
– ONS 15454 SDH—All values listed in Table D-8 are supported.
– ONS 15454 SONET—All values listed in Table D-9 are supported.
– ONS 15530—All values listed in Table D-10 are supported.
– ONS 15540—All values listed in Table D-11 and Table D-12 are supported.
– ONS 15600 SDH—All values listed in Table D-13 are supported.
– ONS 15600 SONET—All values listed in Table D-14 are supported.
– Supported. The value reported by the NE is inserted in this field.
– Supported when equipment is installed.
– Supported when equipment is installed.
– Supported when equipment is installed.
– Supported when equipment is installed. Common Language Equipment Identification (CLEI) code is available.
Prime Optical support for EquipmentHolder_T is as follows:
– Supported. This field has three tuples: one for EMS, one for ManagedElement, and one for EquipmentHolder name.
– Supported. The naming convention is defined in Equipment Holder.
– Supported values are additionalHolder, rack, shelf, and slot.
– For the ONS 15600 SONET and ONS 15600 SDH, valid values are rack, shelf, slot, sub_slot, and ppm_holder.
– For the ONS 15310 CL, ONS 15310 MA SONET, and ONS 15310 MA SDH, valid values are rack, shelf, slot, and ppm_holder.
– For the ONS 15540 and ONS 15530, valid values are rack, shelf, slot, sub_slot, and ppm_holder.
– For the ONS 15454 SONET and ONS 15454 SDH, valid values are rack, shelf, slot, ppm_holder, and port.
– For all equipment supporting SFP modules, valid values are rack, shelf, slot, sub_slot, and port_holder.
– Supported. If the slot is empty and not preprovisioned for equipment, this field is empty.
– Not supported for ONS 15530 and ONS 15540.
|
Channel ID = 31.1, 32.6, 35.0, 36.6, 38.9, 40.5, 42.9, 44.5, 46.9, 48.5, 50.9, 52.5, 54.9, 56.5, 58.9, 60.6 |
|
All equipment listed in Equipment List for ONS 15305 |
3.6.2 getAllEquipmentNames
This interface has the same behavior as the interface described in getAllEquipment, but returns the object name instead of returning the entire object.
Name of the ME or equipment holder for which to retrieve contained equipment and equipment holders. |
|||
Maximum number of EquipmentOrHolder_Ts to return in the first batch. |
|||
EXCPT_INVALID_INPUT - Raised when meOrHolderName does not reference a managed element or an equipment holder.
3.6.3 getAllSupportedPTPs
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.
- ONS 15454 SONET: Prime Optical returns OC -n , DS1, DS3, EC-1, fibre channel, and front Ethernet ports.
- ONS 15454 SDH: Prime Optical returns STM -n (OC -n ), E1, E3, DS3I, STM1E, fibre channel, and front Ethernet ports.
- ONS 15327: Prime Optical returns OC -n , DS1, DS3, and Ethernet ports.
- ONS 15540: Prime Optical returns client, wave, wavepatch, filter, wdm, filterband, filtergroup, oscfilter, wavepassthrough, fastEthernet, TenGigEthernetPhy, and sonet-sdh as potential PTPs.
- ONS 15530: Prime Optical returns all the supported PTPs for ONS 15530.
- ONS 15216: Prime Optical returns all the supported PTPs for ONS 15216, if there is a topological link associated with the NE.
- ONS 15600 SONET: Prime Optical returns OC -n ports.
- ONS 15600 SDH: Prime Optical returns STM -n ports.
- ONS 15305 and ONS 15305 CTC: Prime Optical returns WAN, SDH, and PDH ports.
- ONS 15310 CL and ONS 15310 MA: Prime Optical returns OC -n , DS1, DS3, and Ethernet ports.
Prime Optical support for TerminationPoint_T structure is as follows:
– Supported. This field contains three tuples for PTP and four tuples for CTP as defined by the TMF. The third tuple contains positional information for the PTP. The naming convention is described in Physical Termination Point, Connection Termination Point, and Floating Termination Point.
– Supported. Prime Optical supports TPT_PTP, TPT_CTP, and TPT_FTP.
– Supported. For PTP, it is TPCS_NA; for CTP and floating termination point (FTP), it is TPCS_BI_CONNECTED.
– Supported. PTPs always report D_BIDIRECTIONAL. For the ONS 155xx, D_SOURCE and D_SINK are also supported.
– Supported. Layer rate is supported for PTP, CTP, and FTP.
Prime Optical supports the following parameters for PTP.
Note If TrailTraceMonitor is off for a given CTP or FTP, Prime Optical does not return TrailTraceActualRx in transmissionParams.
3.6.4 getAllSupportedPTPNames
This interface has the same behavior as the interface described in getAllSupportedPTPs, but returns the object names instead of returning the entire object.
3.6.5 getAllSupportingEquipment
This interface enables an NMS to request the equipment that contains a given PTP.
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.
3.6.6 getAllSupportingEquipmentNames
This interface has the same behavior as the operation described in getAllSupportingEquipment, but returns the object name instead of returning the entire object.
3.6.7 getContainedEquipment
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.
Name of the equipment holder for which to retrieve the directly contained equipment and equipment holders. Prime Optical also accepts the ME name as a value for this parameter. |
|||
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.
EXCPT_INVALID_INPUT - Raised when equipmentHolderName does not reference an equipment holder object.
3.6.8 getEquipment
This interface returns the equipment or equipment holder for specific equipment or equipment holder names.
EXCPT_INVALID_INPUT - Raised when equipmentOrHolderName does not reference an equipment or an equipment holder.
3.6.9 provisionEquipment
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.
Prime Optical support for EQTCreateData_T structure is as follows:
– This parameter must take one of the values for equipment described in getAllEquipment.
Note This interface is not applicable for configuring payloads for client ports in TXP_MR_10G.
3.6.10 setAlarmReportingOff
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."
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does not exist.
3.6.11 setAlarmReportingOn
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."
EXCPT_ENTITY_NOT_FOUND - Raised when equipmentOrHolderName references an object that does not exist.
3.6.12 unprovisionEquipment
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.
Note This interface is not applicable for configuring payloads for client ports in TXP_MR_10G.
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.
This 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
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.
Prime Optical support for CurrentMaintenanceOperation structure is as follows:
– Prime Optical supports FACILITY_LOOPBACK, TERMINAL_LOOPBACK, and PAYLOAD_LOOPBACK.
3.7.2 performMaintenanceOperation
This interface enables the NMS to operate and release the maintenance commands that are supported by a TP.
Prime Optical supports only terminal and facility loopback operations for electrical and OC-n PTPs.
Prime Optical does not support loopback operations for CTPs.
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.
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.
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.
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.
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.
Information on the maintenance operation to perform. This structure contains the field maintenance operation. Valid values for this field are: |
|||
Prime Optical support for CurrentMaintenanceOperation_T structure is as follows:
– Only FACILITY_LOOPBACK, TERMINAL_LOOPBACK, and PAYLOAD_LOOPBACK are supported.
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.
This 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
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.
TCAs are reported in the eventList returned by this method. The ONS 15530 and ONS 15540 send a “clear” for TCAs.
3.8.2 getAllSNCs
This interface enables an NMS to request all SNCs that originate on, terminate on, or transit through a given ME.
- For the ONS 15310 CL, this method does not report STS-1 SNC on CTX using DS1 ports.
- For the ONS 15310 MA SONET, this method does not report STS-1 SNC on DS1 ports of DS1_xx cards.
- For the ONS 15310 MA SDH, this method does not report VC4 SNC on E1 ports of E1_63_E3_3 cards.
- For the ONS 15327, this method does not report STS-1 SNC on XTC using DS1 ports.
- For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment.
- For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment.
This interface does not report VCAT SNCs.
List of rates of the SNCs to report. If an empty list is specified, all SNCs of all rates are reported. |
|||
Prime Optical support for SubnetworkConnection_T structure is as follows:
– Supported. This field contains two tuples. The first tuple contains values for the EMS. The second tuple contains the SNC name, which is the same as nativeEMSName.
– Supported. The name supplied by the user at creation time is reported.
– Prime Optical supports SNCS_NONEXISTENT, SNCS_ACTIVE, SNCS_DELETING, and SNCS_PARTIAL.
Note When the SNC is not in SNCS_ACTIVE state, this structure might not have complete information about the SNC. For example, transmissionParameters for TPs reported might not be initialized. When the SNC goes into SNCS_ACTIVE state, a state change event is generated (see State Change Event). Then, the NMS invokes the multiLayerSubnetwork::MultiLayerSubnetworkMgr_I::getSNC method to retrieve complete information about the SNC.
– Supported. For PCA circuits, the value is set to PREEMPTIBLE.
– Supported. Customer ID and service ID are reported if they are available. For an SNC on Ethernet equipment, Prime Optical reports all associated VLAN IDs. For a WDM SNC, the sncSize is reported.
3.8.3 getAllManagedElements
This interface enables an NMS to request details about all MEs that are under the control of ManagedElementMgr_I.
Prime Optical support for ManagedElement_T structure is as follows:
– Supported. The name is reported by the NE.
For a list of all supported layer rates, see Layer Rate.
Supported. Two parameters are sent in this field:
– A name/value pair for the IP address with the name “IPAddress.”
– A name/value pair for the operational state with the name “OperationalState,” containing the following values. The emsInSyncState value is determined by the OperationalState value. A state change event is generated whenever the state of emsInSyncState changes.
3.8.4 getAllManagedElementNames
This interface has the same behavior as getAllManagedElements, but instead of returning entire object structures, this operation returns their names.
3.8.5 getAllPTPs
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.
- ONS 15216: Prime Optical returns all the supported PTPs for ONS 15216.
- ONS 15305 and ONS 15305 CTC: Prime Optical returns WAN, SDH, and PDH ports.
- ONS 15310 CL, ONS 15310 MA SDH, and ONS 15310 MA SONET: Prime Optical returns OC -n , DS1, DS3, and Ethernet ports.
- ONS 15327: Prime Optical returns OC -n , DS1, DS3, and Ethernet ports.
- ONS 15454 SONET: Prime Optical returns OC -n , DS1, DS3, EC-1, fibre channel, and Ethernet ports.
- ONS 15454 SDH: Prime Optical returns STM -n (OC -n ), E1, E3, DS3I, STM1E, fibre channel, and Ethernet ports.
- ONS 15530: Prime Optical returns all supported PTPs.
- ONS 15540: Prime Optical returns client, wave, wavepatch, filter, wdm, filterband, filtergroup, oscfilter, wavepassthrough, fastEthernet, TenGigEthernetPhy, and sonet-sdh as potential PTPs.
- ONS 15600 SONET: Prime Optical returns OC -n ports.
- ONS 15600 SDH: Prime Optical returns STM -n ports.
- Unmanaged NE: Prime Optical returns PTPs only when a topological link exists, and returns only those PTPs that participate in the topological link.
List of PTP layer rates for which the PTPs are retrieved. To be reported, a PTP must contain at least one of the layer rates specified. If the list is empty, all PTPs (of all rates) are returned. |
|||
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For a list of all supported layer rates, see Layer Rate.
3.8.6 getAllPTPNames
This interface has the same behavior as the interface described in getAllPTPs, but returns the object names instead of the object structures.
List of PTP layer rates for which PTPs are retrieved. To be reported, a PTP must contain at least one of the specified layer rates. If the list is empty, all PTPs (of all rates) are returned. |
|||
3.8.7 getContainedInUseTPs
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.
- If there are no SNCs created, Prime Optical returns zero CTPs.
- If there is one SNC created at the STS-1 level, Prime Optical returns one CTP at the STS-1 layer rate.
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.
- If there are no SNCs created, Prime Optical returns zero CTPs.
- If there is one SNC created at the VC4 level, Prime Optical returns one CTP at the VC4 layer rate.
List of rates of the contained actual CTPs to return. An empty list tells the EMS to retrieve all contained actual CTPs (of all rates). |
|||
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For a list of all supported layer rates, see Layer Rate.
3.8.8 getContainedInUseTPNames
This interface has the same behavior as the operation described in getContainedInUseTPs, but instead of returning entire object structures, this operation returns their names.
3.8.9 getContainedPotentialTPs
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.
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For a list of all supported layer rates, see Layer Rate.
3.8.10 getContainedPotentialTPNames
3.8.11 getContainingSubnetworkNames
This interface returns a list of subnetwork names to which the ME (supplied as an input parameter) belongs.
3.8.12 getManagedElement
This interface returns the managed element for a specific managed element name.
For details about the ManagedElement_T structure, see getAllManagedElements.
3.8.13 getAllCtmMEInternalPatchcord
This interface returns a list of internal Prime Optical patchcords for a specific managed element name.
For details about the ManagedElement_T structure, see getAllManagedElements.
3.8.14 setAdditionalInfo
This interface sets attributes using the additionalInfo structure. This interface is supported only for:
This interface is also supported for the attribute LinkIntegrityTimer for the cards and the NE types listed in the following table.
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.
Name of the TP to which to apply the list of modified attribute values. |
|||
List of attributes that must be modified, as well as the new related values to apply. |
3.8.15 getTP
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):
- CE-100T-8 or CE-MR-6 on ONS 15310 MA SONET or ONS 15310 MA SDH
- CE-100T-8 on ONS 15310 CL
- CE-100T-8 or CE-MR-10 on ONS 15454 SONET or ONS 15454 SDH
For PTPs, the additionalInfo attribute list contains the LinkIntegrityTimer and LinkIntegrityDisable attribute values if the selected card is one of following:
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
3.8.16 getAssociatedTopologicalLinks
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.
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
3.8.17 setTPData
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:
- Admin state, MTU size, and COS accounting for POS and Ethernet interfaces.
- Speed, duplex, and flow control for Ethernet interfaces.
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.
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
3.8.18 getAllSrcPTPsForSNCProvisioning
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.
Layer rate at which the SNC is created. All PTP names available as the source of the SNC at this layer rate are returned. |
|||
Prime Optical supports CD_UNI (unidirectional) or CD_BI (bidirectional). |
|||
For a list of supported layer rates, see Layer Rate.
3.8.19 getAllSrcCTPsForSNCProvisioning
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.
Layer rate at which the SNC is created. All CTP names available at this layer rate are returned. |
|||
Prime Optical supports CD_UNI (unidirectional) or CD_BI (bidirectional). |
|||
For a list of supported layer rates, see Layer Rate.
3.8.20 getAllSrcCTPsForVCATMemberSNCProvisioning
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.
See the Parameters section of getAllSrcCTPsForSNCProvisioning.
3.8.21 getAllDestPTPsForSNCProvisioning
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.
For a list of supported layer rates, see Layer Rate.
3.8.22 getAllDestCTPsForSNCProvisioning
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.
For a list of supported layer rates, see Layer Rate.
3.8.23 getAllDestCTPsForVCATMemberSNCProvisioning
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.
See the Parameters section of getAllDestCTPsForSNCProvisioning.
3.8.24 getAllSrcFTPsForSNCProvisioning
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.
For a list of supported layer rates, see Layer Rate.
3.8.25 getAllDestFTPsForSNCProvisioning
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.
Name of the TP that is selected as the source TP for the SNC to create. |
|||
Layer rate at which the SNC is created. All FTPs available at this layer rate are returned. |
|||
For a list of supported layer rates, see Layer Rate.
3.8.26 forceNEResync
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.
3.8.27 getAllTopologicalLinksForME
This interface returns a list of topological links that originate or terminate on the specified managed element.
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
3.8.28 getAllRolls
This interface returns a list of rolls within the managed element whose name is passed as a parameter.
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.
Supported. Each roll has a unique name assigned by the Cisco MSM.
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:
3.8.29 getAllRollNames
This interface returns a list of roll names within the managed element whose name is passed as a parameter.
3.8.30 getRoll
This interface returns the Roll_T structure for a specific roll name.
Prime Optical support for Roll_T is described in getAllRolls.
3.8.31 getRollToPTPs
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.
Name of the SNC to roll over. If more than one SNC is specified, the first SNC becomes the RollFrom SNC and the second SNC becomes the RollToSNC. |
|||
3.8.32 getRollToCTPs
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.
3.8.33 getRollFromCTPs
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.
Name of the SNC to roll over. If more than one SNC is specified, the first SNC becomes the RollFrom SNC and the second SNC becomes the RollToSNC. |
|||
3.8.34 setPortName
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.
3.8.35 getPortName
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.
3.8.36 getAllClearedAlarms
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.
TCAs are reported in the eventList returned by this method. The ONS 15530 and ONS 15540 send a “clear” for TCAs.
3.8.37 getAllCrossConnections
This interface returns a list of cross-connections on the managed element.
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:
– Always true. Prime Optical only returns cross-connections for SNCs that are in SNCState_T.SNCS_ACTIVE or SNCState_T.SNCS_PARTIAL. This attribute indicates whether the cross-connect is active in the ME.
– Direction of the cross-connection. Prime Optical returns CD_UNI or CD_BI.
– Prime Optical always returns ST_SIMPLE.
– Names of TPs at the aEnd of the cross-connection.
– Names of TPs at the zEnd of the cross-connection.
– This attribute allows the EMS to communicate to the NMS additional information that is not explicitly modeled. This attribute is read-only. Prime Optical does not return any additional information.
3.8.38 getAllSoftwareDownloadJobs
This interface retrieves the status of all scheduled and completed software download jobs.
The following table lists descriptions of each individual parameter.
3.8.39 setMEAdminState
This interface is used to force the EMS to change the administrative state of the managed element to the specified state.
Name of the managed element to resynchronize. It must contain a name/value pair, where the name is ManagedElement and the value is ME Name . |
|||
EXCPT_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.
The following enum is used to define the various NE admin states:
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.
multiLayerSubnetworkMgr_I also implements the getCapabilities method. Operations described in following subsections are returned to the NMS when it invokes getCapabilities.
3.9.1 getAllEdgePoints
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.
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
3.9.2 getAllEdgePointNames
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.
3.9.3 getAllManagedElement
This interface enables an NMS to request a list of managed elements that are associated with the specified subnetwork.
For details about the ManagedElement_T structure, see getAllManagedElements.
3.9.4 getAllManagedElementNames
This interface has the same behavior as the operation described in getAllManagedElement, but instead of returning entire object structures, this operation returns their names.
3.9.5 getAllSubnetworkConnections
This interface enables an NMS to request a list of SNCs for the specified subnetwork at the specified connection rates.
- For the ONS 15310 MA SONET, this method does not report STS-1 SNC on DS1 ports of DS1_xx cards.
- For the ONS 15310 MA SDH, this method does not report VC4 SNC on E1 ports of E1_63_E3_3 cards.
- For the ONS 15327, this method does not report STS-1 SNC on XTC using DS1 ports.
- For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment.
- For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment.
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.
List of rates of the SNCs to report. If an empty list is specified, all SNCs of all rates are reported. |
|||
For details about the SubnetworkConnection_T structure, see getAllSNCs.
3.9.6 getAllSubnetworkConnectionsWithTP
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.
- For the ONS 15310 MA SONET, this method does not report STS-1 SNC on DS1 ports of DS1_xx cards.
- For the ONS 15310 MA SDH, this method does not report VC4 SNC on E1 ports of E1_63_E3_3 cards.
- For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment.
- For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment.
This interface does not report SNCs with duplicate names.
Note For ONS 15600 SONET and ONS 15600 SDH NEs, if bridge-and-roll is applied, one CTP may be associated with two SNCs during a transient phase. If Prime Optical invokes this method during this phase, it reports both SNCs.
List of rates of the SNCs to report. If an empty list is specified, all SNCs of all rates are reported. |
|||
For details about the SubnetworkConnection_T structure, see getAllSNCs.
3.9.7 getAllSubnetworkConnectionNames
This interface has the same behavior as the operation described in getAllSubnetworkConnections, but instead of returning entire object structures, this operation returns their names.
List of rates of the SNCs to report. If an empty list is specified, all SNCs of all rates are reported. |
|||
For details about the SubnetworkConnection_T structure, see getAllSNCs.
3.9.8 getAllSubnetworkConnectionNamesWithTP
This interface has the same behavior as the operation described in getAllSubnetworkConnectionsWithTP, but instead of returning entire object structures, this operation returns their names.
List of rates of the SNCs to report. If an empty list is specified, all SNCs of all rates are reported. |
|||
For details about the SubnetworkConnection_T structure, see getAllSNCs.
3.9.9 getAllTopologicalLinks
This interface returns a list of topological links that exist within the subnetwork whose name is passed as a parameter.
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
3.9.10 getAllTopologicalLinkNames
This interface has the same behavior as the operation described in getAllTopologicalLinks, but instead of returning entire object structures, this operation returns their names.
3.9.11 getMultiLayerSubnetwork
This interface returns a subnetwork given a subnetwork name.
For details about the MultiLayerSubnetwork_T structure, see getAllTopLevelSubnetworks.
3.9.12 getCTPsAndTopologicalLinks
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.
- For the ONS 15310, this method does not report STS-1 SNC on CTX using DS1 ports.
- For the ONS 15327, this method does not report STS-1 SNC on XTC using DS1 ports.
- For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment.
- For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment.
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.
For details about the TerminationPoint_T structure, see getAllSupportedPTPs.
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
3.9.13 getSNC
This interface returns the SNC structure for the SNC whose name is supplied as a parameter.
- For the ONS 15310 CL, this method does not report STS-1 SNC on CTX using DS1 ports.
- For the ONS 15310 MA SONET, this method does not report STS-1 SNC on DS1 ports of DS1_xx cards.
- For the ONS 15310 MA SDH, this method does not report VC4 SNC on E1 ports of E1_63_E3_3 cards.
- For the ONS 15327, this method does not report STS-1 SNC on XTC using DS1 ports.
- For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment.
- For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment.
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.
For details about the SubnetworkConnection_T structure, see getAllSNCs.
EXCPT_INVALID_INPUT - Raised when sncName does not reference an SNC object or when sncName is not unique.
3.9.14 getSNCsByUserLabel
This interface returns the SNC structure for the SNC whose name is supplied as a parameter.
- For the ONS 15310 CL, this method does not report STS-1 SNC on CTX using DS1 ports.
- For the ONS 15310 MA SONET, this method does not report STS-1 SNC on DS1 ports of DS1_xx cards.
- For the ONS 15310 MA SDH, this method does not report VC4 SNC on E1 ports of E1_63_E3_3 cards.
- For the ONS 15327, this method does not report STS-1 SNC on XTC using DS1 ports.
- For the ONS 15454 SONET, this method does not report STS-1 SNC on DS1 equipment.
- For the ONS 15454 SDH, this method does not report VC-4 SNC on E1 or E1_42 equipment.
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.
For details about the SubnetworkConnection_T structure, see getAllSNCs.
EXCPT_INVALID_INPUT - Raised when sncName does not reference an SNC object or when sncName is not unique.
3.9.15 getTopologicalLink
This interface returns a topological link. Prime Optical reports all autodiscovered and manual topological links.
For details about the TopologicalLink_T structure, see getAllTopLevelTopologicalLinks.
EXCPT_INVALID_INPUT - Raised when topoLinkName does not reference a subnetwork topological link object.
3.9.16 createAndActivateSNCFromUserLabel
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:
- Monitor circuits
- STS-1 on DS1 cards and VC-4 on E1 and E1_42 cards
- DRI circuits with constraint routing
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.
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.
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.
Prime Optical supports the following layer rates:
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.”
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.
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.
3.9.17 CreateAndActivateSNC
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.
3.9.18 (Deprecated) createAndActivateProtectedOchccFromUserLabel
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 This API has been deprecated from CTM R9.0.
3.9.19 addDrops
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 Invoke the operation described in createAndActivateSNCFromUserLabel to create a unidirectional SNC between two nodes.
Step 2 Invoke this operation to add new drop points to an existing SNC.
Note • The layer rate must match the SNC layer rate. This interface performs on a best-effort basis. If Prime Optical fails to add one or more TPs to the SNC, it generates an UNABLE_TO_COMPLY exception. The errorReason contains a list of CTPs that failed.
- Depending on the card type, the terminology is CTP or FTP . For example, termination points on CE-MR-6 cards are CTPs when the cards are configured for manual mode. For CE-MR-6 cards configured for automatic mode, the termination points are FTPs.
Name of the subnetwork connection to which to add termination points (either CTPs or FTPs). |
|||
List of additional termination points (either CTPs or FTPs) to add to the SNC. |
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_UNABLE_TO_COMPLY – Raised if the CTP is in use by other SNC. This exception is also raised when there is no bandwidth available.
3.9.20 deactivateAndDeleteSNC
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. The first step is validation. This is performed synchronously. If successful, this operation returns successfully. If validation fails, the NMS receives an exception.
2. After a successful validation, the second step is the actual deletion of resources from all NEs. This step is performed asynchronously. Prime Optical changes the SNC state to SNCS_DELETING and sends a notification to the NMS. Upon successful completion, Prime Optical generates an OBJECT_DELETION event. If Prime Optical loses connectivity to one or more nodes on the SNC, it aborts the cleanup and generates an SNCS_PARTIAL state change event. The NMS must reinvoke this method when connectivity to the node is restored. If the deletion fails but the state remains SNCS_ACTIVE, Prime Optical generates an AVC event. These SNC state change events are generated as part of the Prime Optical operation only. If another interface is used, Prime Optical cannot generate these events.
For details about the SubnetworkConnection_T structure, see getAllSNCs.
EXCPT_INVALID_INPUT - Raised when sncName does not refer to an SNC object, or any field in tpsToModify is invalid.
3.9.21 getVCATSNC
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:
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. Name supplied by the user at creation time will be reported.
Supported. The state of the VCAT circuit is derived from the states of the member circuits in the same way as it is derived for CCAT SNCs. The values supported are:
– VCATState_T.VCATS_NONEXISTENT
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.
– True if the rate/capacity is same in both directions.
– False if the rate/capacity is different in each direction.
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:
– LayerRate_T memberRate: Layer rate of the member SNCs.
– Unsigned long numberOfMembers: Number of members for the given VCAT SNC.
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.
Supported. Prime Optical supports the following values:
– LCASMode_T. LCASMODE _SWLCAS
Supported. Prime Optical supports the following values:
– RoutingMode_T. ROUTE_COMMONFIBER
– RoutingMode_T. ROUTE_INDEPENDENTFIBER
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.
3.9.22 getAllVCATSNCs
This interface returns all the VCAT SNCs in the specified multilayer subnetwork. This interface returns only the VCAT SNCs.
List of the VCAT SNCs to report with specified number of members and memberRate. If an empty list is specified, all VCAT SNCs of bandwidth are reported. |
|||
For details about the VCAT_T structure, see getVCATSNC.
3.9.23 getAllVCATSNCNames
This interface returns the names of all the VCAT SNCs in the specified multilayer subnetwork. This interface returns only the VCAT SNC names.
3.9.24 getAllVCATMemberSNCs
This interface returns all of the member SNCs for the VCAT SNC.
3.9.25 getAllVCATMemberSNCNames
This interface returns the names of all member SNCs for a given VCAT SNC.
3.9.26 createVCAT
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.
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.
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:
– RoutingMode_T.COMMONFIBER_ROUTED
– RoutingMode_T.INDEPENDENTFIBER_ROUTED
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.
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.
3.9.27 deleteVCAT
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.
3.9.28 addMemberSNCsToVCAT
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.
3.9.29 deleteMemberSNCsFromVCAT
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.
3.9.30 deleteAllMemberSNCFromVCAT
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.
3.9.31 getValidSubnetworkConnectionsForMerge
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 The valid SncUpgradeInfo value supported by GateWay/CORBA is Merge. The valid SncFilterCriteria value supported by GateWay/CORBA is LINED_UP. The available values that will be supported in the future are listed in the ENUM definitions in the following table.
3.9.32 upgrade
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.
3.9.33 createRoll
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.
For details about the Roll_T structure, see getAllRolls.
Prime Optical support for RollCreateData_T is as follows:
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 If the rollFromCTP can be determined from the fixed CTP, the value is ignored.
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 Prime Optical does not support other values.
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.
EXCPT_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_NE_COMM_LOSS - Raised when communication to the managed element is lost and this prevents the deactivation of the SNC.
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
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.
3.9.35 cancelRoll
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.
3.9.37 completeRoll
This interface must run on manual rolls (RollMode_T.MANUAL).
Prime Optical generates a state change event upon completion of the roll.
3.9.38 finishRoll
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.
3.9.39 getAllRolls
This interface returns a list of rolls within the subnetwork whose name is passed as a parameter.
3.9.40 getAllRollNames
This interface returns a list of roll names within the subnetwork whose name is passed as a parameter.
3.9.42 getAssociatedSNCNamesForRoll
This interface returns the rollFrom SNC name and rollTo SNC name for a roll whose name is passed as a parameter. For circuit bridge-and-roll operations, the Prime Optical client Rolls table contains roll-from circuit and roll-to circuit attributes. The getAssociatedSNCNamesForRoll method returns these attributes for a given circuit roll.
3.9.43 createAndActivateSNCOnDRI
This structure was introduced to provide BLSR-DRI protection support. This structure is not defined by TMF. This structure is similar to createAndActivateSNCOnUserLabel (see getSNCsByUserLabel for more details) except that a new field, driNode, has been added.
The structure of DRISNCCreateData_T is as follows:
The structure of DRINodes_T is as follows:
Prime Optical support for DriNode_T structure is as follows:
This field defines integer values that categorize the BLSR-DRI as traditional or nontraditional BLSR-DRI. In Prime Optical type = 0 means it is a dummy node, 1 = traditional. and 2 = nontraditional.
This field indicates whether or not the RIP option is supported.
This structure holds the primary and secondary nodes. The sDriNodePair structure is as follows:
– globaldefs::NamingAttributes_T PrimaryME—Defines the primary DRI node.
– globaldefs::NamingAttributes_T SecondaryME —Defines the secondary DRI node.
– globaldefs::NamingAttributesList requiredRings—Holds the ring information. The first name value tuple represents EMS instance and the second one holds the BLSR ring ID.
3.9.44 addManagedElement
This interface allows the NMS to add a new managed element to the specified subnetwork.
- If the operation fails, an exception is returned, and the managed element is not added to the subnetwork.
- If the operation succeeds, a managed element is added to the specified subnetwork. The EMS populates the ME communication state, its supported layer rates, and emsInSyncState when connectivity to the ME is established.
Prime Optical generates an NT_OBJECT_CREATION event upon successful addition of a managed element.
The structure of MEAdditionalData_T is as follows:
The description of each field is as follows:
- string userLabel—User-specified label of the managed element.
- string nativeEMSName—nativeEMSName of the managed element to add.
- string owner—Owner of the managed element.
- string location—Location of the managed element.
- string version—The NMS can specify the ME version; however, this value is overwritten when the ME is put in service and the EMS retrieves the actual version information.
- string productName—Product name of the managed element.
- globaldefs::NVSList_T additionalInfo—Parameters that must be specified to the EMS to add the ME; for example, IP address, ME username, password, and any other vendor-specific proprietary data.
Prime Optical support for addManagedElement is as follows:
- globaldefs::NamingAttributes_T managedElementName: Not supported
- globaldefs::NamingAttributes_T containingSubnetworkName: Supported
- string userLabel: Not supported
- string nativeEMSName: Not supported
- string owner: Not supported
- string location (location of the managed element): Supported
- string version: Not supported
- string productName: Not supported
- globaldefs::NVSList_T additionalInfo: Supported
The structure of Additional Info is as follows:
The parameter name “Community String” in additionalInfo can have the following values:
- For NE types ONS 15216 EDFA2 and ONS 15216 EDFA3, the Community String value is private .
- For OADM NE types, the Community String parameter is not required.
- For the remaining NE types, the Community String value is public .
The parameter name “NEModel” in additionalInfo can have the following values:
- "CISCO_ONS_15327_UPSR_ADM"
- "CISCO_ONS_15327_TSA_TERMINAL"
- "CISCO_ONS_15327_BLSR_ADM"
- "CISCO_ONS_15327_HYBRID"
- "CISCO_ONS_15327_Other"
- "CISCO_ONS_15327_Unknown"
- "CISCO_ONS_15454_UPSR_ADM"
- "CISCO_ONS_15454_BLSR_ADM"
- "CISCO_ONS_15454_TSA_TERMINAL"
- "CISCO_ONS_15454_OPTICAL_ADM"
- "CISCO_ONS_15454_HUB"
- "CISCO_ONS_15454_DWDM_HYBRID"
- "CISCO_ONS_15454_TERMINAL_HUB_EAST"
- "CISCO_ONS_15454_TERMINAL_HUB_WEST"
- "CISCO_ONS_15454_DWDM_TERMINAL"
- "CISCO_ONS_15454_PASSIVE_LINE_SITE"
- "CISCO_ONS_15454_ACTIVE_LINE_SITE"
- "CISCO_ONS_15454_ROADM"
- "CISCO_ONS_15454_TERMINAL_OADM_EAST"
- "CISCO_ONS_15454_TERMINAL_OADM_WEST"
- "CISCO_ONS_15454_DWDM_HUB_NODE"
- "CISCO_ONS_15454_OSC_REGENERATION_SITE"
- "CISCO_ONS_15454_L_LINE_SITE"
- "CISCO_ONS_15454_L_ROADM"
- "CISCO_ONS_15454_L_TERMINAL"
- "CISCO_ONS_15454_L_HUB"
- "CISCO_ONS_15454_Other"
- "CISCO_ONS_15454_Unknown"
- "CISCO_ONS_15540_ESP"
- "CISCO_ONS_15540_ESPx"
- "CISCO_ONS_15530"
- "CISCO_ONS_15454_SDH_MSSPRING"
- "CISCO_ONS_15454_SDH_SNC_ADM"
- "CISCO_ONS_15454_SDH_TSA_TERMINAL"
- "CISCO_ONS_15454_SDH_TSA_TERMINAL_EAST"
- "CISCO_ONS_15454_SDH_TSA_TERMINAL_WEST"
- "CISCO_ONS_15454_SDH_OPTICAL_ADM"
- "CISCO_ONS_15454_SDH_HUB"
- "CISCO_ONS_15454_SDH_HYBRID"
- "CISCO_ONS_15454_SDH_DWDM_HUB_NODE"
- "CISCO_ONS_15454_SDH_PASSIVE_LINE_SITE"
- "CISCO_ONS_15454_SDH_ACTIVE_LINE_SITE"
- "CISCO_ONS_15454_SDH_LINE_AMPLIFIER"
- "CISCO_ONS_15454_SDH_DWDM_TERMINAL"
- "CISCO_ONS_15454_SDH_ROADM"
- "CISCO_ONS_15454_SDH_L_LINE_SITE"
- "CISCO_ONS_15454_SDH_L_ROADM"
- "CISCO_ONS_15454_SDH_L_TERMINAL"
- "CISCO_ONS_15454_SDH_L_HUB"
- "CISCO_ONS_15454_SDH_Other"
- "CISCO_ONS_15454_SDH_Unknown"
- "CISCO_ONS_15600_UPSR_ADM"
- "CISCO_ONS_15600_TSA_TERMINAL"
- "CISCO_ONS_15600_BLSR_ADM"
- "CISCO_ONS_15600_LINEAR_ADM"
- "CISCO_ONS_15600_DCS"
- "CISCO_ONS_15600_HYBRID"
- "CISCO_ONS_15600_Other"
- "CISCO_ONS_15600_Unknown"
- "CISCO_ONS_15600_SDH_MSSPRING"
- "CISCO_ONS_15600_SDH_TSA_TERMINAL"
- "CISCO_ONS_15600_SDH_LINEAR_ADM"
- "CISCO_ONS_15600_SDH_DCS"
- "CISCO_ONS_15600_SDH_HYBRID"
- "CISCO_ONS_15600_SDH_Other"
- "CISCO_ONS_15600_SDH_Unknown"
- "CISCO_ONS_15305"
- "CISCO_ONS_15305_CTC_SNCP"
- "CISCO_ONS_15305_CTC_Unknown"
- "CISCO_ONS_15305_CTC_Other"
- "Not_Managed_Other_Vendor"
- "CISCO_ONS_15216_EDFA1"
- "CISCO_ONS_15216_EDFA2"
- "CISCO_ONS_15216_EDFA3_POST_AMPLIFIER"
- "CISCO_ONS_15216_EDFA3_LINE_AMPLIFIER"
- "CISCO_ONS_15216_EDFA3_PRE_AMPLIFIER"
- "CISCO_ONS_15216_EDFA3_Other"
- "CISCO_ONS_15216_EDFA3_Unknown"
- "CISCO_ONS_15216_OSC_1510"
- "CISCO_ONS_15216_DCU"
- "CISCO_ONS_15216_FlexLayer"
- "CISCO_ONS_15216_200_GHZ_OADM1"
- "CISCO_ONS_15216_200_GHZ_OADM2"
- "CISCO_ONS_15216_100_GHZ_OADM4"
- "CISCO_ONS_15216_100_GHZ_OADM2"
- "CISCO_ONS_15216_100_GHZ_OADM1"
- "CISCO_ONS_15216_DWDM_Filter_RED_200_GHZ_DWDM_FILTER"
- "CISCO_ONS_15216_DWDM_Filter_BLUE_200_GHZ_DWDM_FILTER"
- "CISCO_ONS_15216_DWDM_Filter_RED_100_GHZ_DWDM_FILTER"
- "CISCO_ONS_15216_DWDM_Filter_BLUE_100_GHZ_DWDM_FILTER"
- "CISCO_ONS_15310_CL_UPSR_ADM"
- "CISCO_ONS_15310_CL_TSA_TERMINAL"
- "CISCO_ONS_15310_CL_BLSR_ADM"
- "CISCO_ONS_15310_CL_HYBRID"
- "CISCO_ONS_15310_CL_Other"
- "CISCO_ONS_15310_CL_Unknown"
- "CISCO_ONS_15310_MA_UPSR_ADM"
- "CISCO_ONS_15310_MA_TSA_TERMINAL"
- "CISCO_ONS_15310_MA_BLSR_ADM"
- "CISCO_ONS_15310_MA_HYBRID"
- "CISCO_ONS_15310_MA_Other"
- "CISCO_ONS_15310_MA_Unknown"
- "CISCO_ONS_15310_MA_SDH_UPSR_ADM"
- "CISCO_ONS_15310_MA_SDH_TSA_TERMINAL"
- "CISCO_ONS_15310_MA_SDH_BLSR_ADM"
- "CISCO_ONS_15310_MA_SDH_HYBRID"
- "CISCO_ONS_15310_MA_SDH_Other"
- "CISCO_ONS_15310_MA_SDH_Unknown"
3.10 L2 Topology and ML VLAN for ML-Series Ethernet Cards
Prime Optical supports L2 topology and ML VLAN operations for the ML-series Ethernet cards in ONS 15454 SONET and ONS 15454 SDH NEs. You can create an ML VLAN in an L2 topology. An L2 topology has a collection of ML VLANs and underlying subnetwork connections to support the traffic at the optical layer.
The following figure shows the relationship diagram for various L2 service objects.
Figure 3-4 L2 Service Object Relationship Diagram
Prime Optical supports L2 service interfaces for the ONS 15454 SONET and ONS 15454 SDH R4.1 and later.
3.10.1 createMLVLAN
This interface creates a new ML VLAN for a given L2 topology. An object creation event is generated when an ML VLAN is created successfully. Prime Optical supports a maximum of 4095 ML VLANs for an L2 topology.
Prime Optical support for MLVLANCreateData_T structure is as follows:
Supported. The ML VLAN ID used to create the ML VLAN. If it is –1, Prime Optical assigns the ID for the ML VLAN created. Prime Optical supports ML VLAN IDs from 1 to 4095.
Supported. Prime Optical always enforces the uniqueness of the ML VLAN ID.
Supported. A list of front Ethernet ports associated with the ML VLAN.
Each MLVLANTPData_T structure has the following members:
Specifies the front Ethernet port name.
Specifies the port type to configure. Prime Optical supports the following port types:
Specifies the connection type to configure for the specified port type. If the port type is L2PortType_T.UNI, the following connection types are supported:
– L2ConnectionType_T.L2CT_QINQ
– L2ConnectionType_T.L2CT_DOT1Q
– L2ConnectionType_T.L2CT_UNTAGGED
If the port type is L2PortType_T.L2PT_NNI, the following connection type is supported:
– L2ConnectionType_T.L2CT_DOT1Q
If the connection type is not L2ConnectionType_T.L2CT_QINQ, you can specify the following RSTP values.
The NMS can enable or disable the RSTP state for a non-QinQ drop. Prime Optical supports two port states:
– L2RSTPState_T.L2RSTP_DISABLE
For a QinQ drop, this value (if specified) is ignored.
NMS can enable a service or disable a port. Prime Optical support two port states:
Specifies the interface type to be configured. Prime Optical supports the following interface types:
– L2InterfaceType_T. L2IT_FASTETHER
– L2InterfaceType _T. L2IT_GIGAETHER
– L2InterfaceType _T. L2IT_PORTCHANNEL
Prime Optical support for QOSPolicyData_T structure is described in QOSPolicyData_T.
The user VLAN ID to associate with this ML VLAN. If the connection type is L2ConnectionType_T.L2CT_DOT1Q, the valid port VLAN range is from 2 to 4096. If the connection type is L2ConnectionType_T.L2CT_UNTAGGED, the port VLAN is ignored.
Supported. You can specify the customerID and service ID.
Prime Optical support for MLVLAN_T structure is as follows:
Supported. This field contains three tuples. The first tuple has the EMS value. The second tuple has the L2 topology name. The third tuple has the ML VLAN ID that is the same as nativeEMSName.
Supported. The ML VLAN ID is reported.
Supported. Specifies the list of all front Ethernet ports and associated service type.
If the port type on a port cannot be determined, Prime Optical represents the port type as L2PortType_T.L2PT_UNKNOWN.
If the connection type for an ML VLAN on a port cannot be determined, Prime Optical represents the connection type as L2ConnectionType_T.L2CT_UNKNOWN.
Supported. Valid values are MLVLANState_T.COMPLETE and MLVLANState_T.INCOMPLETE. A state change event is generated if the VLAN state changes.
Supported. The customer ID and service ID are reported.
EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist.
3.10.2 modifyMLVLANAddFrontPorts
This interface adds additional front ports to the existing MVLAN. An attribute change event is reported when the front ports are successfully added. Prime Optical does not specify which attribute of the ML VLAN has changed. The NMS must obtain updated MLVLAN_T structure information. If the addition of any of the front ports to the ML VLAN fails, Prime Optical generates a processing failure exception. The NMS user must requery the ML VLAN information to obtain the new set of parameters associated with the ML VLAN.
For details about the MLVLAN_T, MLVLANTPData_T structure, see createMLVLAN.
EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object or when one or more PTPs in the PTP list does not reference a PTP object.
3.10.3 modifyMLVLANDropFrontPorts
This interface drops front ports associated with an existing ML VLAN. An attribute change event is reported when the front ports are dropped from the ML VLAN. Prime Optical does not specify which attribute of the ML VLAN has changed. The NMS must obtain updated MLVLAN_T structure information. If removal of any front ports associated with the ML VLAN fails, Prime Optical generates a processing failure exception. The NMS user must requery the ML VLAN information to obtain the new set of parameters associated with the ML VLAN.
For details about the MLVLAN_T structure, see createMLVLAN.
EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object or when one or more PTPs in the PTP list does not reference a PTP object.
3.10.4 modifyMLVLANPortState
This interface enables or disables specified ML VLAN traffic on the specified list of front ports. An attribute change event is reported when one of the ML VLAN parameters is modified. Prime Optical does not specify which attribute of the ML VLAN has changed. The NMS must obtain updated MLVLAN_T structure information. If modification of any of the ML VLAN port states fails, Prime Optical generates a processing failure exception. The NMS user must requery the ML VLAN information to obtain the new set of parameters associated with the ML VLAN.
For details about the MLVLAN_T structure, see createMLVLAN.
Prime Optical support for MLVLANTPPortState_T structure is as follows:
The front Ethernet port name used by this ML VLAN.
The portState is applicable only to the specified ML VLAN. The supported states are:
EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object or when one or more PTPs in the PTP list does not reference a PTP object.
3.10.5 modifyMLVLANRSTPState
This interface enables or disables specific ML VLAN traffic on the specified list of drop ports. An attribute change event is reported when an ML VLAN parameter is modified. Prime Optical does not specify which attribute of the ML VLAN has changed. The NMS must obtain updated MLVLAN_T structure information. If the modification of an ML VLAN RSTP state fails, Prime Optical generates a processing failure exception. You must issue another query for the ML VLAN information to obtain the new set of parameters associated with the ML VLAN.
For details about the MLVLAN_T structure, see createMLVLAN.
Prime Optical support for MLVLANRSTPState_T structure is as follows:
The front Ethernet port name used by this ML VLAN.
The rstpState is applicable only to the specified non-QinQ drops of the ML VLAN. The supported states are:
– L2RSTPState_T.L2RSTP_DISABLE
EXCPT_INVALID_INPUT - Raised when l2TopologyName does not reference an L2 topology object or when one or more PTPs in the PTP list does not reference a PTP object.
EXCPT_ENTITY_NOT_FOUND - Raised when l2TopologyName references an L2 topology object that does not exist or when one or more PTPs in the PTP list does not exist.
3.10.6 modifyMLVLANTPQOS
This interface modifies the QoS policies of a list of termination points in the specified ML VLAN. An attribute change event is reported for each call to this API, even if more than one TP QoS policy has been modified. Prime Optical does not specify which attribute of the ML VLAN has changed. The NMS must obtain updated MLVLAN_T structure. Modification of any QoS policy is done on a best effort basis. If modification of any part of the QOSPolicy fails, Prime Optical generates a processing failure exception. The NMS user must requery the ML VLAN information to get the new set of parameters associated with the ML VLAN.