Alcatel-Lucent 1359 CorbaNBI | Release 1.6 Interface Specification 2 d. E A 8DG 34000 AAAA TQZZA Z Z T P 1 January 2010 4 1 7 0 Issue 4 9 0 0 0 E B 8 1359CORBA NBI 1.5- Interface Specification 8DG 34000 AAAA Ed. 4 Status: RL Author: Chen Min Page 2 / 268 TQZZA *** PRINTED and DISTRIBUTED COPIES ARE UNCONTROLLED *** Electronic originals available in Optics PDM All rights reserved. Passing on and copying of this document, use and communication of its content not permitted without written authorisation from Alcatel-Lucent CORBANBI 1.6 INTERFACE SPECIFICATION Author: CORBA NBI System team 8DG 34000 AAAA TQZZA Revision History ED Date Comments Author Appraisal authority 1.1 2009-10-27 Creation Liu Liu Tang Tie 1.2 2009-10-30 Modification Wu liang Tang Tie 1.3 2009-11-1 Modification Cui Kai Tang Tie 1.4 2010-01-18 Modification Wu liang Tang Tie Table of Contents CorbaNBI 1.6 Interface Specification ................................................................................................................ 3 HISTORY ......................................................................................................................................................... 15 OPEN ISSUES ................................................................................................................................................ 16 Purpose and scope .......................................................................................................................................... 16 Referenced Documents ................................................................................................................................... 17 1. GLOSSARY AND DEFINITIONS ......................................................................................................... 18 1.1. Definitions.......................................................................................................................................... 18 1.2. Abbreviations .................................................................................................................................... 18 2. INTRODUCTION .................................................................................................................................. 19 2.1. Document scope ............................................................................................................................... 19 3. ARCHITECTURAL DESCRIPTION ...................................................................................................... 20 4. INTERFACE DESCRIPTION ................................................................................................................ 21 5. DESIGN CHOICES ............................................................................................................................... 22 6. Data Type Description .......................................................................................................................... 23 6.1.1. AssignedSeverity_T ................................................................................................................... 23 6.1.2. AlarmSeverityAssignment_T ..................................................................................................... 23 6.1.3. AlarmSeverityAssignmentList_T ................................................................................................ 24 6.1.4. ASAP_T ..................................................................................................................................... 24 6.1.5. ASAPList_T ................................................................................................................................ 26 6.1.6. ASAPCreateModifyData_T ........................................................................................................ 26 6.1.7. Capability_T ............................................................................................................................... 27 6.1.8. CapabilityList_T ......................................................................................................................... 27 6.1.9. EMS_T ....................................................................................................................................... 27 6.1.10. managerNames_T .................................................................................................................. 28 6.1.11. EquipmentObjectType_T ....................................................................................................... 28 6.1.12. EquipmentObjectTypeList_T .................................................................................................. 29 6.1.13. ServiceState_T ....................................................................................................................... 29 6.1.14. EquipmentHolderType_T ....................................................................................................... 29 6.1.15. HolderState_T ........................................................................................................................ 29 6.1.16. Equipment_T .......................................................................................................................... 30 6.1.17. EQTCreateData_T ................................................................................................................. 32 6.1.18. EquipmentHolder_T ............................................................................................................... 32 6.1.19. EquipmentTypeQualifier_T .................................................................................................... 33 6.1.20. EquipmentOrHolder_T ........................................................................................................... 34 6.1.21. EquipmentOrHolderList_T; ..................................................................................................... 34 6.1.22. NameAndStringValue_T ........................................................................................................ 34 6.1.23. NVSList_T .............................................................................................................................. 34 6.1.24. NamingAttributes_T ................................................................................................................ 34 6.1.25. NamingAttributesList_T .......................................................................................................... 35 6.1.26. Time_T ................................................................................................................................... 35 6.1.27. ConnectionDirection_T ........................................................................................................... 35 6.1.28. ExceptionType_T ................................................................................................................... 35 6.1.29. ProcessingFailureException ................................................................................................... 37 6.1.30. ServerLaunchCapability_T ..................................................................................................... 37 6.1.31. GuiCutThroughData_T ........................................................................................................... 38 6.1.32. GuiCutThroughDataList_T ..................................................................................................... 38 6.1.33. GCTProfileInfo_T ................................................................................................................... 39 6.1.34. MaintenanceOperation_T ....................................................................................................... 39 6.1.35. MaintenanceOperationMode_T .............................................................................................. 39 6.1.36. CurrentMaintenanceOperation_T ........................................................................................... 40 6.1.37. CurrentMaintenanceOperationList_T ..................................................................................... 40 6.1.38. CommunicationState_T .......................................................................................................... 40 6.1.39. ManagedElement_T ............................................................................................................... 40 6.1.40. ManagedElementList_T ......................................................................................................... 42 6.1.41. Topology_T ............................................................................................................................ 42 6.1.42. EMSFreedomLevel_T ............................................................................................................ 43 6.1.43. MultiLayerSubnetwork_T ....................................................................................................... 43 6.1.44. SubnetworkList_T ................................................................................................................... 44 6.1.45. TPPoolCreateData_T ............................................................................................................. 44 6.1.46. ProtectionSchemeState_T ..................................................................................................... 45 6.1.47. ProtectionType_T ................................................................................................................... 45 6.1.48. SwitchReason_T .................................................................................................................... 46 6.1.49. ESwitchReason_T .................................................................................................................. 46 6.1.50. ProtectionCommand_T .......................................................................................................... 46 6.1.51. ProtectionGroupType_T ......................................................................................................... 46 6.1.52. EProtectionGroupType_T ...................................................................................................... 47 6.1.53. ReversionMode_T .................................................................................................................. 47 6.1.54. ProtectionGroup_T ................................................................................................................. 47 6.1.55. ProtectionGroupList_T; .......................................................................................................... 48 6.1.56. EProtectionGroup_T............................................................................................................... 48 6.1.57. EProtectionGroupList_T ......................................................................................................... 49 6.1.58. SwitchData_T ......................................................................................................................... 49 6.1.59. SwitchDataList_T ................................................................................................................... 50 6.1.60. ESwitchData_T ....................................................................................................................... 50 6.1.61. ESwitchDataList_T ................................................................................................................. 51 6.1.62. BackupId_T ............................................................................................................................ 51 6.1.63. BackupIdList_T ....................................................................................................................... 51 6.1.64. Current_OperationStatus_T ................................................................................................... 52 6.1.65. BackupStatus_T ..................................................................................................................... 52 6.1.66. StaticProtectionLevel_T ......................................................................................................... 52 6.1.67. ProtectionEffort_T .................................................................................................................. 53 6.1.68. SNCState_T ........................................................................................................................... 53 6.1.69. GradesOfImpact_T ................................................................................................................. 53 6.1.70. TPData_T ............................................................................................................................... 54 6.1.71. TPDataList_T ......................................................................................................................... 55 6.1.72. SNCType_T ............................................................................................................................ 55 6.1.73. Reroute_T .............................................................................................................................. 55 6.1.74. NetworkRouted_T .................................................................................................................. 56 6.1.75. RerouteChangeEvent_T ........................................................................................................ 56 6.1.76. SubnetworkConnection_T ...................................................................................................... 56 6.1.77. SubnetworkConnectionList_T ................................................................................................ 58 6.1.78. CrossConnect_T .................................................................................................................... 58 6.1.79. Route_T .................................................................................................................................. 59 6.1.80. CrossConnectList_T ............................................................................................................... 59 6.1.81. Resource_T ............................................................................................................................ 59 6.1.82. ResourceList_T ...................................................................................................................... 59 6.1.83. RouteDescriptor_T ................................................................................................................. 59 6.1.84. RouteList_T ............................................................................................................................ 61 6.1.85. RouteCreateData_T ............................................................................................................... 61 6.1.86. RouteNameAndAdminState_T ............................................................................................... 62 6.1.87. RouteNameAndAdminStateList_T ......................................................................................... 62 6.1.88. SNCCreateData_T ................................................................................................................. 62 6.1.89. SNCModifyData_T ................................................................................................................. 64 6.1.90. Directionality_T ....................................................................................................................... 66 6.1.91. TPConnectionState_T ............................................................................................................ 66 6.1.92. TPType_T ............................................................................................................................... 67 6.1.93. TerminationMode_T ............................................................................................................... 67 6.1.94. TPProtectionAssociation_T .................................................................................................... 69 6.1.95. TerminationPoint_T ................................................................................................................ 69 6.1.96. TerminationPointList_T .......................................................................................................... 75 6.1.97. GTP_T .................................................................................................................................... 75 6.1.98. GTPlist_T ............................................................................................................................... 76 6.1.99. GTPEffort_T ........................................................................................................................... 76 6.1.100. TopologicalLink_T .................................................................................................................. 76 6.1.101. TopologicalLinkList_T............................................................................................................. 77 6.1.102. TLCreateData_T ..................................................................................................................... 78 6.1.103. ServiceCategory_T ................................................................................................................. 78 6.1.104. TrafficParameterList_T ........................................................................................................... 79 6.1.105. TrafficDescriptor_T ................................................................................................................. 79 6.1.106. TDCreateData_T .................................................................................................................... 80 6.1.107. TrafficDescriptorList_T ........................................................................................................... 81 6.1.108. ServiceCategory_T ................................................................................................................. 81 6.1.109. TrafficParameterList_T ........................................................................................................... 81 6.1.110. TransmissionDescriptor_T ..................................................................................................... 81 6.1.111. TMDCreateData_T ................................................................................................................. 82 6.1.112. TransmissionDescriptorList_T ................................................................................................ 83 6.1.113. LayerRate_T ........................................................................................................................... 83 6.1.114. LayerRateList_T ..................................................................................................................... 84 6.1.115. LayeredParameters_T............................................................................................................ 84 6.1.116. LayeredParameterList_T ........................................................................................................ 84 6.1.117. Destination_T ......................................................................................................................... 84 6.1.118. Granularity_T .......................................................................................................................... 84 6.1.119. GranularityList_T .................................................................................................................... 85 6.1.120. PMLocation_T ........................................................................................................................ 85 6.1.121. PMLocationList_T ................................................................................................................... 85 6.1.122. PMParameterName_T ........................................................................................................... 85 6.1.123. PMParameterNameList_T ...................................................................................................... 85 6.1.124. PMParameter_T ..................................................................................................................... 85 6.1.125. PMParameterList_T ............................................................................................................... 86 6.1.126. PMThresholdType_T .............................................................................................................. 86 6.1.127. PMThresholdValue_T............................................................................................................. 86 6.1.128. PMThresholdValueList_T ....................................................................................................... 87 6.1.129. TCAParameter_T ................................................................................................................... 87 6.1.130. TCAParameterList_T.............................................................................................................. 87 6.1.131. TCAParameterProfile_T ......................................................................................................... 87 6.1.132. TCAParameterProfileList_T ................................................................................................... 88 6.1.133. PMMeasurement_T ................................................................................................................ 88 6.1.134. PMMeasurementList_T .......................................................................................................... 89 6.1.135. PMData_T .............................................................................................................................. 89 6.1.136. PMDataList_T ......................................................................................................................... 90 6.1.137. PMTPSelect_T ....................................................................................................................... 90 6.1.138. PMTPSelectList_T .................................................................................................................. 90 6.1.139. HoldingTime_T ....................................................................................................................... 90 6.1.140. TCAParameters_T ................................................................................................................. 91 6.1.141. AdministrativeState_T ............................................................................................................ 91 6.1.142. PMThreshold_T ...................................................................................................................... 91 6.1.143. PMThresholdList_T ................................................................................................................ 91 6.1.144. PMParameterWithThresholds_T ............................................................................................ 92 6.1.145. PMParameterWithThresholdsList_T ...................................................................................... 92 6.1.146. PMP_T ................................................................................................................................... 92 6.1.147. PMPList_T .............................................................................................................................. 93 6.1.148. PMMonitorOrReportStatus_T ................................................................................................. 93 6.1.149. PMCollectionPlan_T ............................................................................................................... 93 6.1.150. PMCollectionPlanList_T ......................................................................................................... 94 6.1.151. StpProtocolType_T ................................................................................................................. 94 6.1.152. BridgeType_T ......................................................................................................................... 95 6.1.153. BridgeLogicPort_T .................................................................................................................. 95 6.1.154. BridgeLogicPortList_T ............................................................................................................ 95 6.1.155. VirtualBridgeParameter_T ...................................................................................................... 95 6.1.156. VirtualBridge_T ....................................................................................................................... 97 6.1.157. VirtualBridgeList_T ................................................................................................................. 98 6.1.158. Vlan_T .................................................................................................................................... 98 6.1.159. VlanList_T .............................................................................................................................. 99 6.1.160. StpMode_T ............................................................................................................................. 99 6.1.161. VStpPortEnable_T .................................................................................................................. 99 6.1.162. VStpPortManualMode_T ........................................................................................................ 99 6.1.163. VStpPortRole_T ..................................................................................................................... 99 6.1.164. VStpPortAdminConnectionType_T ........................................................................................ 99 6.1.165. VStpPortOperConnectionType_T ........................................................................................ 100 6.1.166. VstpPortRcvdInternal_T ....................................................................................................... 100 6.1.167. VStpPortState_T .................................................................................................................. 100 6.1.168. StpPortParam_T ................................................................................................................... 100 6.1.169. ForwardingRecordState_T ................................................................................................... 101 6.1.170. ForwardingRecord_T............................................................................................................ 101 6.1.171. ForwardingRecordList_T ...................................................................................................... 102 6.1.172. ObjectType_T ....................................................................................................................... 102 6.1.173. ObjectTypeQualifier_T ......................................................................................................... 103 6.1.174. PerceivedSeverity_T ............................................................................................................ 103 6.1.175. AcknowledgeIndication_T .................................................................................................... 103 6.1.176. AlarmTypeQualifier_T .......................................................................................................... 103 6.1.177. PerceivedSeverityList_T ...................................................................................................... 103 6.1.178. ServiceAffecting_T ............................................................................................................... 103 6.1.179. ProbableCauseList_T ........................................................................................................... 104 6.1.180. NameAndAnyValue_T .......................................................................................................... 104 6.1.181. NVList_T ............................................................................................................................... 104 6.1.182. FileTransferStatus_T ............................................................................................................ 104 6.1.183. EventList_T .......................................................................................................................... 104 6.1.184. SpecificProblem_T ............................................................................................................... 104 6.1.185. SpecificProblemList_T.......................................................................................................... 104 6.1.186. NotifIDList_T ......................................................................................................................... 105 6.1.187. CorrelatedNotifications_T ..................................................................................................... 105 6.1.188. CorrelatedNotificationList_T ................................................................................................. 105 6.1.189. ProposedRepairAction_T ..................................................................................................... 105 6.1.190. ProposedRepairActionList_T ............................................................................................... 105 6.1.191. AlarmId_T ............................................................................................................................. 105 6.1.192. TCAId_T ............................................................................................................................... 106 6.1.193. AlarmOrTCAIdentifier_T ....................................................................................................... 106 6.1.194. AlarmAndTCAIDList_T ......................................................................................................... 106 6.1.195. Destination_T ....................................................................................................................... 107 6.1.196. Granularity_T ........................................................................................................................ 107 6.1.197. GranularityList_T .................................................................................................................. 107 6.1.198. PMLocation_T ...................................................................................................................... 107 6.1.199. PMLocationList_T ................................................................................................................. 107 6.1.200. PMParameterName_T ......................................................................................................... 107 6.1.201. PMParameterNameList_T .................................................................................................... 107 6.1.202. PMParameter_T ................................................................................................................... 108 6.1.203. PMParameterList_T ............................................................................................................. 108 6.1.204. PMThresholdType_T ............................................................................................................ 108 6.1.205. PMThresholdValue_T........................................................................................................... 108 6.1.206. PMThresholdValueList_T ..................................................................................................... 109 6.1.207. TCAParameter_T ................................................................................................................. 109 6.1.208. TCAParameterList_T............................................................................................................ 109 6.1.209. TCAParameterProfile_T ....................................................................................................... 109 6.1.210. TCAParameterProfileList_T ................................................................................................. 110 6.1.211. PMMeasurement_T .............................................................................................................. 110 6.1.212. PMMeasurementList_T ........................................................................................................ 111 6.1.213. PMData_T ............................................................................................................................ 111 6.1.214. PMDataList_T ....................................................................................................................... 111 6.1.215. PMTPSelect_T ..................................................................................................................... 112 6.1.216. PMTPSelectList_T ................................................................................................................ 112 6.1.217. HoldingTime_T ..................................................................................................................... 112 6.1.218. TCAParameters_T ............................................................................................................... 112 6.1.219. AdministrativeState_T .......................................................................................................... 113 6.1.220. PMThreshold_T .................................................................................................................... 113 6.1.221. PMThresholdList_T .............................................................................................................. 113 6.1.222. PMParameterWithThresholds_T .......................................................................................... 113 6.1.223. PMParameterWithThresholdsList_T .................................................................................... 114 6.1.224. PMP_T ................................................................................................................................. 114 6.1.225. PMPList_T ............................................................................................................................ 115 7. INTERFACE SET DESCRIPTION ...................................................................................................... 116 7.1. Notifications ..................................................................................................................................... 116 7.1.1. Structure of the notification ...................................................................................................... 116 7.1.2. Supported notifications ............................................................................................................ 116 7.2. Common_I interface ........................................................................................................................ 116 7.2.1. Operations ............................................................................................................................... 116 7.2.1.1. setUserLabel ..................................................................................................................... 116 7.2.1.2. setOwner .......................................................................................................................... 117 7.2.1.3. setAdditionalInfo ............................................................................................................... 118 7.3. EMSMgr_I interface ........................................................................................................................ 119 7.3.1. Operations ............................................................................................................................... 119 7.3.1.1. getEMSTime ..................................................................................................................... 119 7.3.1.2. setEMSTime ..................................................................................................................... 119 7.3.1.3. setEMSLocation................................................................................................................ 120 7.3.1.4. getEMS ............................................................................................................................. 120 7.3.1.5. getAllTopLevelSubnetworks ............................................................................................. 120 7.3.1.6. getAllTopLevelSubnetworksNames.................................................................................. 121 7.3.1.7. getAllTopLevelTopologicalLinks ....................................................................................... 122 7.3.1.8. getAllTopLevelTopologicalLinkNames ............................................................................. 122 7.3.1.9. getTopLevelTopologicalLink ............................................................................................. 123 7.3.1.10. filteredGetActiveAlarms .................................................................................................... 124 7.3.1.11. getAllEMSAndMEActiveAlarms ........................................................................................ 124 7.3.1.12. getAllEMSSystemActiveAlarms ....................................................................................... 125 7.3.1.13. createTopologicalLink ...................................................................................................... 125 7.3.1.14. deleteTopologicalLink ....................................................................................................... 126 7.3.1.15. getAllEMSAndMEUnacknowledgedActiveAlarms ............................................................ 127 7.3.1.16. getAllEMSSystemUnacknowledgedActiveAlarms ............................................................ 127 7.3.1.17. createASAPUnderMe ....................................................................................................... 128 7.3.1.18. getAllASAPsUnderMe ...................................................................................................... 129 7.3.1.19. getAllASAPNamesUnderMe............................................................................................. 129 7.3.1.20. deleteASAP ...................................................................................................................... 130 7.3.1.21. assignASAP ..................................................................................................................... 130 7.3.1.22. deassignASAP ................................................................................................................. 131 7.3.1.23. modifyASAP ..................................................................................................................... 132 7.3.1.24. getASAP ........................................................................................................................... 132 7.3.1.25. getASAPbyResource ........................................................................................................ 133 7.3.1.26. getASAPAssociatedResourceNames .............................................................................. 134 7.4. EmsSession_I Interface .................................................................................................................. 134 7.4.1. Operations ............................................................................................................................... 134 7.4.1.1. getSupportedManagers .................................................................................................... 134 7.4.1.2. getManager ....................................................................................................................... 135 7.4.1.3. getEventChannel .............................................................................................................. 136 7.4.1.4. modifyPassword ............................................................................................................... 136 7.5. EmsSessionFactory_I Interface ...................................................................................................... 137 7.5.1. Operations ............................................................................................................................... 137 7.5.1.1. getEmsSession ................................................................................................................. 137 7.6. MaintenanceMgr_I Interface ........................................................................................................... 137 7.6.1. Operations ............................................................................................................................... 137 7.6.1.1. performMaintenanceOperation ......................................................................................... 137 7.6.1.2. getActiveMaintenanceOperations ..................................................................................... 138 7.7. ManagedElementMgr_I Interface .................................................................................................... 139 7.7.1. Operations ............................................................................................................................... 139 7.7.1.1. getAllManagedElements ................................................................................................... 139 7.7.1.2. getHighestLayerRateOfME ............................................................................................... 140 7.7.1.3. getHighestAlarmSeverityOfME ......................................................................................... 140 7.7.1.4. getAllGatewayManagedElements .................................................................................... 140 7.7.1.5. getAllManagedElementNames ......................................................................................... 141 7.7.1.6. getAllGatewayManagedElementNames ........................................................................... 142 7.7.1.7. getAllPTPs ........................................................................................................................ 142 7.7.1.8. getAllPTPsWithoutFTPs ................................................................................................... 143 7.7.1.9. getAllFTPs ........................................................................................................................ 144 7.7.1.10. getAllPTPNames .............................................................................................................. 145 7.7.1.11. getAllPTPNamesWithoutFTPs ......................................................................................... 145 7.7.1.12. getAllFTPNames .............................................................................................................. 146 7.7.1.13. getGTP ............................................................................................................................. 147 7.7.1.14. getAllGTPs ....................................................................................................................... 147 7.7.1.15. getAllGTPNames .............................................................................................................. 148 7.7.1.16. getContainingGTP ............................................................................................................ 148 7.7.1.17. getTP ................................................................................................................................ 149 7.7.1.18. getTTIInformation ............................................................................................................. 150 7.7.1.19. getManagedElement ........................................................................................................ 150 7.7.1.20. getContainedPotentialTPs................................................................................................ 151 7.7.1.21. getContainedPotentialTPNames ...................................................................................... 152 7.7.1.22. getContainedInUseTPs .................................................................................................... 152 7.7.1.23. getContainedInUseTPNames .......................................................................................... 153 7.7.1.24. getContainedCurrentTPs.................................................................................................. 154 7.7.1.25. getContainedCurrentTPNames ........................................................................................ 155 7.7.1.26. getContainingTPs ............................................................................................................. 155 7.7.1.27. getContainingTPNames ................................................................................................... 156 7.7.1.28. getAllUnacknowledgedActiveAlarms ................................................................................ 156 7.7.1.29. getAllActiveAlarms ........................................................................................................... 157 7.7.1.30. setTPData ........................................................................................................................ 158 7.7.1.31. getAllCrossConnections ................................................................................................... 160 7.7.1.32. getCrossConnectionById.................................................................................................. 161 7.7.1.33. getCrossConnection ......................................................................................................... 161 7.7.1.34. getCrossConnectionsByName ......................................................................................... 162 7.7.1.35. getAllCrossConnectionsName ......................................................................................... 162 7.7.1.36. createCrossConnection .................................................................................................... 163 7.7.1.37. deleteCrossConnection .................................................................................................... 163 7.7.1.38. getPotentialFixedCCs ....................................................................................................... 164 7.7.1.39. getAllFixedCrossConnections .......................................................................................... 165 7.7.1.40. getLcasStatus ................................................................................................................... 165 7.7.1.41. setLcasStatus ................................................................................................................... 166 7.7.1.42. getEncapsulateProtocol ................................................................................................... 166 7.7.1.43. setEncapsulateProtocol.................................................................................................... 167 7.7.1.44. getContainingSubnetworkNames ..................................................................................... 167 7.8. MultiLayerSubnetworkMgr_I Interface ............................................................................................ 168 7.8.1. Operations ............................................................................................................................... 168 7.8.1.1. getAllManagedElements ................................................................................................... 168 7.8.1.2. getAllManagedElementNames ......................................................................................... 169 7.8.1.3. getMultiLayerSubnetwork ................................................................................................. 169 7.8.1.4. getNextLevelMultiLayerSubnetworks ............................................................................... 170 7.8.1.5. getNextLevelMultiLayerSubnetworkNames ..................................................................... 171 7.8.1.6. getAllTopologicalLinks ...................................................................................................... 171 7.8.1.7. getAllTopologicalLinkNames ............................................................................................ 172 7.8.1.8. getTopologicalLink ............................................................................................................ 173 7.8.1.9. getAssociatedTP............................................................................................................... 173 7.8.1.10. getSNCsByUserLabel ...................................................................................................... 174 7.8.1.11. getAllSubnetworkConnections ......................................................................................... 175
Description: