Northbound CORBA Interface Developer
Guide (Configuration)
Issue 03
Date 2010-08-16
consent of Huawei Technologies Co., Ltd.
Trademarks and Permissions
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute the warranty of any kind, express or implied.
Huawei Technologies Co., Ltd.
Address: Huawei Industrial Base
Bantian, Longgang Shenzhen 518129
People's Republic of China
Website: http://www.huawei.com
About This Document
Related Versions
The following table lists the product versions related to this document.
Product Name Version
iManager U2000 V100R002C01
Intended Audience
Focusing on the configuration management of the CORBA NBI, this document describes the enhanced development of the NBI from the aspects as follows: basic information, interface function, information model, and interface model.
This document provides the reference information about the configuration management of the CORBA NBI.
This document is intended for:
l Application Developer l Data Configuration Engineer
Symbol Conventions
The symbols that may be found in this document are defined as follows.
Symbol Description
DANGER
Indicates a hazard with a high level of risk, which if not avoided, will result in death or serious injury.
WARNING
Indicates a hazard with a medium or low level of risk, which if not avoided, could result in minor or moderate injury.
CAUTION
Indicates a potentially hazardous situation, which if not avoided, could result in equipment damage, data loss, performance degradation, or unexpected results.
TIP Indicates a tip that may help you solve a problem or save
time.
NOTE Provides additional information to emphasize or supplement
important points of the main text.
Command Conventions
The command conventions that may be found in this document are defined as follows.
Convention Description
Boldface The keywords of a command line are in boldface.
Italic Command arguments are in italics.
[ ] Items (keywords or arguments) in brackets [ ] are optional.
{ x | y | ... } Optional items are grouped in braces and separated by
vertical bars. One item is selected.
[ x | y | ... ] Optional items are grouped in brackets and separated by
vertical bars. One item is selected or no item is selected.
{ x | y | ... }* Optional items are grouped in braces and separated by
vertical bars. A minimum of one item or a maximum of all items can be selected.
[ x | y | ... ]* Optional items are grouped in brackets and separated by
vertical bars. Several items or no item can be selected.
GUI Conventions
The GUI conventions that may be found in this document are defined as follows.
Convention Description
Boldface Buttons, menus, parameters, tabs, window, and dialog titles are in boldface. For example, click OK.
> Multi-level menus are in boldface and separated by the ">"
Change History
Updates between document issues are cumulative. Therefore, the latest document issue contains all updates made in previous issues.
Changes in Issue 03 (2010-08-16) Based on Product Version V100R002C01
Errors are corrected.
Changes in Issue 02 (2010-07-16) Based on Product Version V100R002C01
Errors are corrected.
Changes in Issue 01 (2010-05-18) Based on Product Version V100R002C01
Contents
About This Document...iii
1 Overview...1-1
1.1 Introduction...1-2 1.2 Configuration Management...1-2
2 Format of Notification Events...2-1
2.1 Format of the NT_OBJECT_CREATION Event...2-2 2.1.1 Header Format of the NT_OBJECT_CREATION Event...2-2 2.1.2 Format of the NT_OBJECT_CREATION Event (filterable_data)...2-2 2.1.3 Format of the NT_OBJECT_CREATION Event (remainder_of_body)...2-3 2.2 Format of the NT_OBJECT_DELETION Event...2-3 2.2.1 Header Format of the NT_OBJECT_DELETION Event...2-4 2.2.2 Format of the NT_OBJECT_DELETION Event (filterable_data)...2-4 2.2.3 Format of the NT_OBJECT_DELETION Event (remainder_of_body)...2-5 2.3 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event...2-5 2.3.1 Header Format of the NT_ATTRIBUTE_VALUE_CHANGE Event...2-5 2.3.2 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event (filterable_data)...2-6 2.3.3 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event (remainder_of_body)...2-7 2.4 Format of the NT_STATE_CHANGE Event...2-7 2.4.1 Header Format of the NT_STATE_CHANGE Event...2-7 2.4.2 Format of the NT_STATE_CHANGE Event (filterable_data)...2-8 2.4.3 Format of the NT_STATE_CHANGE Event (remainder_of_body)...2-9 2.5 Format of the NT_PROTECTION_SWITCH Event...2-9 2.5.1 Header Format of the NT_PROTECTION_SWITCH Event...2-9 2.5.2 Format of the NT_PROTECTION_SWITCH Event (filterable_data)...2-10 2.5.3 Format of the NT_PROTECTION_SWITCH Event (remainder_of_body)...2-12 2.6 Format of the NT_ATMPROTECTION_SWITCH Event...2-12 2.6.1 Header Format of the NT_ATMPROTECTION_SWITCH Event...2-13 2.6.2 Format of the NT_ATMPROTECTION_SWITCH Event (filterable_data)...2-13 2.6.3 Format of the NT_ATMPROTECTION_SWITCH Event (remainder_of_body)...2-14 2.7 Format of the NT_WDMPROTECTION_SWITCH Event...2-14 2.7.1 Header Format of the NT_WDMPROTECTION_SWITCH Event...2-14 2.7.2 Format of the NT_WDMPROTECTION_SWITCH Event (filterable_data)...2-15
2.8.1 Header Format of the NT_RPRPROTECTION_SWITCH Event...2-17 2.8.2 Format of the NT_RPRPROTECTION_SWITCH Event (filterable_data)...2-17 2.8.3 Format of the NT_RPRPROTECTION_SWITCH Event (remainder_of_body)...2-18 2.9 Format of the NT_EPROTECTION_SWITCH Event...2-18 2.9.1 Header Format of the NT_EPROTECTION_SWITCH Event...2-19 2.9.2 Format of the NT_EPROTECTION_SWITCH Event (filterable_data)...2-19 2.9.3 Format of the NT_EPROTECTION_SWITCH Event (remainder_of_body)...2-20 2.10 Format of the NT_IPPROTECTION_SWITCH Event...2-21 2.10.1 Header Format of the NT_IPPROTECTION_SWITCH Event...2-21 2.10.2 Format of the NT_IPPROTECTION_SWITCH Event (filterable_data)...2-21 2.10.3 Format of the NT_IPPROTECTION_SWITCH Event (remainder_of_body)...2-22 2.11 Format of the NT_ROUTE_CHANGE Event...2-22 2.11.1 Header Format of the NT_ROUTE_CHANGE Event...2-23 2.11.2 Format of the NT_ROUTE_CHANGE Event (filterable_data)...2-23 2.11.3 Format of the NT_ROUTE_CHANGE Event (remainder_of_body)...2-24 2.12 Format of the NT_ASON_RESOURCE_CHANGE Event...2-24 2.12.1 Header Format of the NT_ASON_RESOURCE_CHANGE Event...2-24 2.12.2 Format of the NT_ASON_RESOURCE_CHANGE Event (filterable_data)...2-25 2.12.3 Format of the NT_ASON_RESOURCE_CHANGE Event (remainder_of_body)...2-26 2.13 Format of the NT_FILE_TRANSFER_STATUS Event...2-26 2.13.1 Header Format of the NT_FILE_TRANSFER_STATUS Event...2-26 2.13.2 Format of the NT_FILE_TRANSFER_STATUS Event (filterable_data)...2-27 2.13.3 Format of the NT_FILE_TRANSFER_STATUS Event (remainder_of_body)...2-28 2.14 Format of the NT_PRBSTEST_STATUS Event...2-28 2.14.1 Header Format of the NT_PRBSTEST_STATUS Event...2-28 2.14.2 Format of the NT_PRBSTEST_STATUS Event (filterable_data)...2-29 2.15 Format of the NT_HEARTBEAT Event...2-29 2.15.1 Header Format of the NT_HEARTBEAT Event...2-30 2.15.2 Format of the NT_HEARTBEAT Event (filterable_data)...2-30
3 Information Model...3-1
3.1 emsMgr...3-2 3.1.1 EMS_T...3-2 3.2 equipment...3-4 3.2.1 EQTCreateData_T...3-4 3.2.2 Equipment_T...3-5 3.2.3 EquipmentHolder_T...3-6 3.3 managedElement...3-7 3.3.1 ManagedElement_T...3-7 3.4 subnetworkConnection...3-8 3.4.1 CrossConnect_T...3-83.4.2 TPData_T...3-9 3.4.3 SubnetworkConnection_T...3-9 3.4.4 SNCCreateData_T...3-11 3.4.5 SNCModifyData_T...3-15 3.5 multiLayerSubnetwork...3-18 3.5.1 MultiLayerSubnetwork_T...3-18 3.6 topologicalLink...3-19 3.6.1 TopologicalLink_T...3-19 3.7 terminationPoint...3-19 3.7.1 TerminationPoint_T...3-20 3.8 protection...3-21 3.8.1 ProtectionGroup_T...3-22 3.8.2 SwitchData_T...3-28 3.8.3 WDMProtectionGroup_T...3-29 3.8.4 WDMSwitchData_T...3-30 3.8.5 EProtectionGroup_T...3-31 3.8.6 ESwitchData_T...3-34 3.8.7 IPSwitchData_T...3-34 3.9 HW_mstpInventory...3-35 3.9.1 HW_MSTPEndPoint_T...3-36 3.9.2 HW_VirtualBridge_T...3-36 3.9.3 HW_VirtualLAN_T...3-37 3.9.4 HW_ForwardEndPoint_T...3-37 3.9.5 HW_MSTPBindingPath_T...3-38 3.9.6 HW_QosRule_T...3-38 3.9.7 HW_Flow_T...3-39 3.9.8 HW_LinkAggregationGroup_T...3-40 3.9.9 HW_LAGBranchPort _T...3-41 3.9.10 HW_SpanningTree_T...3-41 3.9.11 HW_STCurrentPort_T...3-41 3.9.12 ShapingQueue...3-42 3.10 HW_mstpProtection...3-42 3.10.1 HW_RPRNode_T...3-42 3.10.2 HW_RPRTopoInfo_T...3-43 3.10.3 HW_RPRSwitchData_T...3-44 3.10.4 HW_AtmProtectGroup_T...3-45 3.10.5 HW_AtmServiceProtectPair_T...3-46 3.10.6 HW_AtmPGSwitchData_T...3-46 3.10.7 HW_AtmPGSingleEndSwitchPara_T...3-47 3.11 HW_mstpService...3-47 3.11.1 HW_EthServiceTP_T...3-47 3.11.2 HW_EthService_T...3-47
3.11.5 HW_AtmServiceCreateData_T...3-50 3.11.6 HW_AtmServiceTP_T...3-50 3.12 trafficDescriptor...3-50 3.12.1 TrafficDescriptor_T...3-51 3.12.2 TDCreateData_T...3-51 3.13 encapsulationLayerLink...3-52 3.13.1 EncapsulationLayerLink_T...3-52 3.13.2 ELLinkCreateData_T...3-53 3.14 flowDomain...3-54 3.14.1 FlowDomain_T...3-54 3.14.2 FlowDomainFragment_T...3-55 3.14.3 FDFrCreateData_T...3-56 3.14.4 EthernetOAMPoint_T...3-57 3.14.5 EthernetOAMOperation_T...3-57 3.14.6 EthernetOAMParamer_T...3-58 3.14.7 EthernetLTTestResult_T...3-58 3.15 HW_controlPlane...3-58 3.15.1 HW_SnppLink_T...3-58 3.15.2 HW_Capacity_T...3-60 3.16 maintenanceOps...3-60 3.16.1 CurrentMaintenanceOperation_T...3-60 3.16.2 PRBSTestResult_T...3-61 3.16.3 PRBSTestParameter_T...3-61 3.16.4 SampleResult_T...3-61 3.16.5 TestDuration_T...3-62 3.17 TopoManagementManager...3-62 3.17.1 Node_T...3-62 3.17.2 Position_T...3-62 3.18 HW_vpnManager...3-62 3.18.1 MatrixFlowDomainFragment_T...3-63 3.18.2 MultipointServiceAttr_T...3-64 3.18.3 StaticMacAddress_T...3-66 3.18.4 SplitHorizonGroup_T...3-66 3.18.5 IPCrossConnection_T...3-66 3.18.6 TrafficTrunk_T...3-67 3.18.7 RouteConstraint_T...3-68 3.18.8 MFDFrModifyData_T...3-69 3.18.9 TrafficTrunkCreateData_T...3-70 3.18.10 TrafficTrunkModifyData_T...3-71 3.19 trafficConditioningProfile...3-72
3.19.1 HW_TCProfile_T...3-73 3.19.2 HW_TCProfileCreateData_T...3-74 3.19.3 TrafficConditioningProfileAssign_T...3-75 3.19.4 TrafficConditioningProfileDeassign_T...3-75
4 Interface Model...4-1
4.1 Common_I...4-2 4.1.1 setUserLabel...4-2 4.1.2 setnativeEMSName...4-3 4.1.3 setOwner...4-4 4.1.4 Notification...4-5 4.2 EquipmentInventoryMgr_I...4-5 4.2.1 provisionEquipment...4-6 4.2.2 unprovisionEquipment...4-7 4.2.3 Notifications...4-7 4.3 ManagedElementMgr_I... 4-8 4.3.1 setTPData...4-8 4.3.2 createCrossConnections...4-9 4.3.3 This interface is in the best-effort mode.deleteCrossConnections...4-11 4.3.4 activateCrossConnections...4-12 4.3.5 deactivateCrossConnections...4-13 4.3.6 createFTP...4-15 4.3.7 deleteFTP...4-16 4.3.8 modifyFTPMembers...4-17 4.3.9 Notifications...4-18 4.4 MultiLayerSubnetworkMgr_I...4-19 4.4.1 createSNC...4-20 4.4.2 modifySNC...4-22 4.4.3 activateSNC...4-24 4.4.4 createAndActivateSNC...4-26 4.4.5 deactivateSNC...4-28 4.4.6 deleteSNC...4-29 4.4.7 deactivateAndDeleteSNC...4-30 4.4.8 checkValidSNC...4-32 4.4.9 setConjunctionSNC...4-33 4.4.10 swapSNC...4-34 4.4.11 Notifications...4-36 4.5 ProtectionMgr_I...4-36 4.5.1 performProtectionCommand...4-36 4.5.2 performWDMProtectionCommand...4-38 4.5.3 Notifications...4-39 4.6 HW_MSTPInventoryMgr_I...4-39 4.6.1 setMstpEndPoint...4-404.6.4 createVLAN...4-43 4.6.5 deleteVLAN...4-44 4.6.6 addVLANForwardPort...4-45 4.6.7 delVLANForwardPort...4-46 4.6.8 setVLANData...4-47 4.6.9 addBindingPath...4-48 4.6.10 delBindingPath...4-49 4.6.11 setLCASState...4-50 4.6.12 createQosRule...4-51 4.6.13 setQosRule...4-52 4.6.14 createFlow...4-53 4.6.15 deleteQosRule...4-54 4.6.16 setFlow...4-55 4.6.17 deleteFlow...4-56 4.6.18 createLinkAggregationGroup...4-57 4.6.19 modifyLinkAggregationGroup...4-58 4.6.20 deleteLinkAggregationGroup...4-59 4.6.21 setMstpEndPointShapingQueue...4-60 4.6.22 setSTProtocolParam...4-61 4.6.23 setSTBridgeParam...4-62 4.6.24 setSTPortParam...4-63 4.6.25 Notifications...4-64 4.7 HW_MSTPProtectionMgr_I...4-64 4.7.1 performRPRProtectionCommand...4-64 4.7.2 performAtmPGProtectionCommand...4-65 4.7.3 Notifications...4-66 4.8 HW_MSTPServiceMgr_I...4-67 4.8.1 createEthService...4-67 4.8.2 deleteEthService...4-68 4.8.3 createAtmService...4-69 4.8.4 deleteAtmService...4-70 4.8.5 activateAtmService...4-71 4.8.6 deactivateAtmService...4-72 4.8.7 Notifications...4-73 4.9 TrafficDescriptorMgr_I...4-73 4.9.1 activateTrafficDescriptor...4-73 4.9.2 deactivateTrafficDescriptor...4-74 4.9.3 HW_createTrafficDescriptor...4-75 4.9.4 deleteTrafficDescriptor...4-76 4.9.5 Notifications...4-77
4.10 HW_controlPlaneMgr_I...4-77 4.10.1 setSRLG...4-78 4.10.2 Notifications...4-79 4.11 EncapsulationLayerLinkMgr_I...4-79 4.11.1 createELLink...4-79 4.11.2 activateELLink...4-80 4.11.3 deactivateELLink...4-81 4.11.4 deleteELLink...4-82 4.11.5 increaseBandwidthOfELLink...4-83 4.11.6 decreaseBandwidthOfELLink...4-84 4.11.7 setELLinkLCASState...4-86 4.11.8 Notifications...4-86 4.12 FlowDomainMgr_I...4-87 4.12.1 createFDFr...4-87 4.12.2 activateFDFr...4-89 4.12.3 deactivateFDFr...4-90 4.12.4 deleteFDFr...4-91 4.12.5 performEthernetOAMCommand...4-92 4.12.6 Notifications...4-92 4.13 MaintenanceMgr_I...4-93 4.13.1 performMaintenanceOperation...4-93 4.13.2 enablePRBSTest...4-94 4.13.3 disablePRBSTest...4-95 4.14 TCProfileMgr_I...4-96 4.14.1 HW_createTCProfile...4-96 4.14.2 HW_modifyTCProfile...4-97 4.14.3 deleteTCProfile...4-99 4.14.4 assignTrafficConditioningProfile...4-100 4.14.5 deassignTrafficConditioningProfile...4-101 4.15 Session_I...4-102 4.15.1 ping...4-102 4.15.2 endSession...4-102 4.16 HW_securityMgr_I...4-103 4.16.1 modifyPassword...4-103 4.17 HW_VPNMgr_I...4-103 4.17.1 createMFDFr...4-104 4.17.2 deleteMFDFr...4-105 4.17.3 activateMFDFr...4-106 4.17.4 deactivateMFDFr...4-107 4.17.5 modifyMFDFr...4-108 4.17.6 createTrafficTrunk...4-110 4.17.7 deleteTrafficTrunk...4-110
4.17.10 modifyTrafficTrunk...4-113 4.17.11 createIPCrossConnections...4-114 4.17.12 deleteIPCrossConnections...4-115 4.17.13 activateIPCrossConnections...4-116 4.17.14 deactivateIPCrossConnections...4-117 4.17.15 modifyIPCrossConnection...4-118
A Object Naming Rules...A-1
A.1 EMS...A-3 A.2 Subnetwork...A-3 A.3 TopoSubnetwork...A-4 A.4 ProtectionSubnetwork...A-4 A.5 SubnetworkConnection...A-4 A.6 ManagedElement...A-5 A.7 TopologicalLink...A-5 A.8 EPGP...A-6 A.9 PTP...A-6 A.10 FTP...A-8 A.11 CTP...A-9 A.12 TrafficDescriptor...A-14 A.13 EquipmentHolder...A-14 A.14 Equipment...A-15 A.15 ProtectionGroup...A-15 A.16 WDM ProtectionGroup...A-16 A.17 VirtualBridge...A-16 A.18 VLAN...A-17 A.19 Ethernet Service...A-17 A.20 ATM Service...A-18 A.21 ATM ProtectGroup...A-18 A.22 QoS Rule...A-19 A.23 Flow...A-19 A.24 Flow Domain...A-20 A.25 FlowDomainFragment...A-20 A.26 EncapsulationLayerLink...A-21 A.27 LinkAggregationGroup...A-21 A.28 RPRNode...A-21 A.29 Routing Area...A-22 A.30 SNPPLink...A-22 A.31 MatrixFlowDomainFragment...A-23 A.32 TrafficTrunk...A-23 A.33 IPCrossConnection...A-24
A.34 tcProfileName...A-24
B AdditionalInfo Description...B-1
B.1 ManagedElement_T...B-2 B.2 TerminationPoint_T...B-3 B.3 Equipment_T...B-4 B.4 SubnetworkConnection_T...B-4 B.5 SNCCreateData_T...B-5 B.6 SNCModifyData_T...B-6 B.7 CrossConnect_T...B-7 B.8 HW_EthService_T...B-10 B.9 TrafficDescriptor_T...B-11 B.10 EthernetOAMOperation_T...B-11 B.11 ELLinkCreateData_T...B-12 B.12 FDFrCreateData_T...B-12C Lists...C-1
C.1 Notification Event Samples...C-2 C.1.1 NT_OBJECT_CREATION Event Sample...C-2 C.1.2 NT_OBJECT_DELETION Event Sample...C-4 C.1.3 NT_ATTRIBUTE_VALUE_CHANGE Event Sample...C-5 C.1.4 NT_STATE_CHANGE Event Sample...C-6 C.1.5 NT_PROTECTION_SWITCH Event Sample...C-6 C.1.6 NT_ATMPROTECTION_SWITCH Event Sample...C-8 C.1.7 NT_WDMPROTECTION_SWITCH Event Sample...C-9 C.1.8 NT_RPRPROTECTION_SWITCH Event Sample...C-10 C.1.9 NT_EPROTECTION_SWITCH Event Sample...C-11 C.1.10 NT_ASON_RESOURCE_CHANGE Event Sample...C-13 C.1.11 NT_PRBSTEST_STATUS Event Sample...C-13 C.1.12 NT_HEARTBEAT Event Sample...C-14 C.1.13 NT_ROUTE_CHANGE Event Sample...C-15 C.1.14 NT_IPPROTECTION_SWITCH Event Sample...C-18 C.2 IDL Description...C-19
D Glossary...D-1
E Acronyms and Abbreviations...E-1
Tables
Table 1-1 Configuration management...1-2 Table 2-1 Header format of the NT_OBJECT_CREATION event...2-2 Table 2-2 Format of the fiterrable_data in the structure of the NT_OBJECT_CREATION event...2-2 Table 2-3 Header format of the NT_OBJECT_DELETION event...2-4 Table 2-4 Format of filterable_data in structure of the NT_OBJECT_DELETION event...2-4 Table 2-5 Header format of the NT_ATTRIBUTE_VALUE_CHANGE event...2-5 Table 2-6 Format of filterable_data in structure of the NT_ATTRIBUTE_VALUE_CHANGE event...2-6 Table 2-7 Header format of the NT_STATE_CHANGE event...2-7 Table 2-8 Format of filterable_data in structure of the NT_STATE_CHANGE event...2-8 Table 2-9 Header format of the NT_PROTECTION_SWITCH event...2-9 Table 2-10 Format of filterable_data in structure of the NT_PROTECTION_SWITCH event...2-10 Table 2-11 Header format of the NT_ATMPROTECTION_SWITCH event...2-13 Table 2-12 Format of filterable_data in structure of the NT_ATMPROTECTION_SWITCH event...2-13 Table 2-13 Header format of the NT_WDMPROTECTION_SWITCH event...2-14 Table 2-14 Format of filterable_data in structure of the NT_WDMPROTECTION_SWITCH event...2-15 Table 2-15 Header format of the NT_RPRPROTECTION_SWITCH event...2-17 Table 2-16 Format of filterable_data in structure of the NT_RPRPROTECTION_SWITCH event...2-17 Table 2-17 Header format of the NT_EPROTECTION_SWITCH event...2-19 Table 2-18 Format of filterable_data in structure of the NT_EPROTECTION_SWITCH event...2-19 Table 2-19 Header format of the NT_IPPROTECTION_SWITCH event...2-21 Table 2-20 Format of filterable_data in structure of the NT_IPPROTECTION_SWITCH event...2-21 Table 2-21 Header format of the NT_ROUTE_CHANGE event...2-23 Table 2-22 Format of filterable_data in structure of the NT_ROUTE_CHANGE event...2-23 Table 2-23 Header format of the NT_ASON_RESOURCE_CHANGE event...2-24 Table 2-24 Format of filterable_data in structure of the NT_ASON_RESOURCE_CHANGE event...2-25 Table 2-25 Header format of the NT_FILE_TRANSFER_STATUS event...2-26 Table 2-26 Format of filterable_data in structure of the NT_FILE_TRANSFER_STATUS event...2-27 Table 2-27 Header format of the NT_PRBSTEST_STATUS event...2-28 Table 2-28 Format of filterable_data in structure of the NT_PRBSTEST_STATUS event...2-29 Table 2-29 Header format of the NT_HEARTBEAT event...2-30 Table 2-30 Format of filterable_data in structure of the NT_HEARTBEAT event...2-30 Table A-1 EMS...A-3 Table A-2 Subnetwork...A-3
Table A-5 SubnetworkConnection...A-4 Table A-6 ManagedElement...A-5 Table A-7 TopologicalLink...A-5 Table A-8 EPGP...A-6 Table A-9 PTP...A-6 Table A-10 FTP...A-8 Table A-11 CTP...A-9 Table A-12 TrafficDescriptor...A-14 Table A-13 EquipmentHolder...A-14 Table A-14 Equipment...A-15 Table A-15 ProtectionGroup...A-15 Table A-16 WDM ProtectionGroup...A-16 Table A-17 VirtualBridge...A-16 Table A-18 VLAN...A-17 Table A-19 Ethernet Service...A-17 Table A-20 ATM Service...A-18 Table A-21 ATM ProtectGroup...A-18 Table A-22 QoS Rule...A-19 Table A-23 Flow...A-19 Table A-24 Flow Domain...A-20 Table A-25 FlowDomainFragment...A-20 Table A-26 EncapsulationLayerLink...A-21 Table A-27 LinkAggregationGroup...A-21 Table A-28 RPRNode...A-21 Table A-29 Routing Area...A-22 Table A-30 SNPPLink...A-22 Table B-1 ManagedElement_T...B-2 Table B-2 TerminationPoint_T...B-3 Table B-3 Equipment_T...B-4 Table B-4 SubnetworkConnection_T...B-4 Table B-5 SNCCreateData_T...B-5 Table B-6 SNCModifyData_T...B-6 Table B-7 CrossConnect_T...B-7 Table B-8 HW_EthService_T...B-10 Table B-9 TrafficDescriptor_T...B-11 Table B-10 EthernetOAMOperation_T...B-11 Table B-11 ELLinkCreateData_T...B-12 Table B-12 FDFrCreateData_T...B-12 Table C-1 NT_OBJECT_CREATION event sample...C-2 Table C-2 NT_OBJECT_DELETION event sample...C-4
Table C-3 NT_ATTRIBUTE_VALUE_CHANGE event sample...C-5 Table C-4 NT_STATE_CHANGE event sample...C-6 Table C-5 NT_PROTECTION_SWITCH event sample...C-6 Table C-6 NT_ATMPROTECTION_SWITCH event sample...C-8 Table C-7 NT_WDMPROTECTION_SWITCH event sample...C-9 Table C-8 NT_RPRPROTECTION_SWITCH event sample...C-10 Table C-9 NT_EPROTECTION_SWITCH event sample...C-11 Table C-10 NT_ASON_RESOURCE_CHANGE event sample...C-13 Table C-11 NT_PRBSTEST_STATUS event sample...C-13 Table C-12 NT_HEARTBEAT event sample...C-14 Table C-13 NT_ROUTE_CHANGE event sample...C-15 Table C-14 NT_EPROTECTION_SWITCH event sample...C-18
1
Overview
About This Chapter
1.1 Introduction
1.1 Introduction
Huawei CORBA interface provides extensive functions of network resource configuration for the operation support system (OSS). With these interfaces, a user can maintain a network, configure equipment resources, deliver end-to-end services, and deliver the services of individual NEs. In this way, the network resources are managed flexibly.
1.2 Configuration Management
The U2000 CORBA NBI provides the configuration management functions listed in Table 1-1.
NOTE
Unless otherwise specified, the NA equipment does not support the following functions.
Table 1-1 Configuration management
Function Description
Network maintenance The user can set loopback
(LB) and alarm insertion and perform pseudo-random binary sequence (PRBS) tests.
Test and diagnosis The user can perform
operations, administration and maintenance (OAM) of Ethernet services.
Equipment configuration The user can install and delete boards.
Port configuration The user can set port
parameters, binding paths for Ethernet ports, and attributes of the IF ports of the RTN. Protection configuration The user can perform
multiplex section protection (MSP) switching and wavelength division multiplexing (WDM) protection switching. The user can also create link aggregation protection groups.
Service diagnosis The user can perform LB test,
LT test, and continuity check (CC) of Ethernet services.
Function Description Delivery of end-to-end SDH
services
The user can perform the following operations:
l Create, delete, activate,
deactivate, and modify SDH trails.
l Perform switching of
pre-configured SDH trails.
SDH: synchronous digital hierarchy
Delivery of end-to-end WDM services
The user can create, delete, activate, and deactivate WDM trails. The user can also modify the source and sink of WDM trails.
WDM: Wave-length Division Multiplexing
Delivery of end-to-end SDH ASON services
The user can perform the following operations:
l Create, delete, activate,
and deactivate SDH ASON trails. l Modify routing constraints of SDH ASON trails. l Set association of SDH ASON trails.
l Set shared risk link groups
of SDH ASON.
ASON: automatically switched optical network
Delivery of end-to-end Ethernet services
The user can perform the following operations:
l Create, delete, activate
and deactivate a FDFr.
l Create, delete, activate,
and deactivate an ELL.
l Adjust the bandwidth
bound to an ELL.
l FDFr: flow domain
fragment
l ELL: encapsulation layer
link
Delivery of end-to-end RTN services
The user can create and delete SDH or PDH radio links.
Delivery of SDH services of individual NEs
The user can create, delete, activate, and deactivate SDH cross-connections.
Delivery of MSTP services of individual NEs
The user can perform the following operations:
l Create and delete the
Ethernet services of individual NEs.
l Create an Ethernet virtual
bridge.
l Create an L2 forwarding
table for Ethernet.
l Create, activate,
deactivate, and delete the ATM services of
individual NEs.
l Create, delete, activate,
and deactivate an ATM traffic descriptor. l MSTP: multi-service transmission platform l ATM: asynchronous transfer mode Delivery of PTN services of individual NEs
The user can perform the following operations: l Create, activate, deactivate, delete MPLS static tunnel. l Create, activate, deactivate, delete MPLS dynamic tunnel. l Create, activate, deactivate, delete IP tunnel. l Create, activate, deactivate, delete PW switch. l Create, activate,
deactivate, delete AES service.
l Create, activate,
deactivate, delete CES service.
l Create, activate,
deactivate, delete EPL service.
l Create, activate,
deactivate, delete EPLn service.
Function Description Delivery of OTN services of
individual NEs
The user can perform the following operations:
l Create, delete, activate,
deactivate WDM cross-connections.
l Create, modify, delete
OTN trails.
l Create, modify, delete,
perform OTN protection group.
2
Format of Notification Events
About This Chapter
In the additionalInfoUsage.pdf and AVC_SC_Notifications.pdf among the supporting
documentation of the TMF 814 recommendation, the structure of each notification event of the CORBA interface is described. This chapter presents the detailed definitions of the structure of the notification events.
2.1 Format of the NT_OBJECT_CREATION Event 2.2 Format of the NT_OBJECT_DELETION Event
2.3 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event 2.4 Format of the NT_STATE_CHANGE Event
2.5 Format of the NT_PROTECTION_SWITCH Event 2.6 Format of the NT_ATMPROTECTION_SWITCH Event 2.7 Format of the NT_WDMPROTECTION_SWITCH Event 2.8 Format of the NT_RPRPROTECTION_SWITCH Event 2.9 Format of the NT_EPROTECTION_SWITCH Event 2.10 Format of the NT_IPPROTECTION_SWITCH Event 2.11 Format of the NT_ROUTE_CHANGE Event
2.12 Format of the NT_ASON_RESOURCE_CHANGE Event 2.13 Format of the NT_FILE_TRANSFER_STATUS Event 2.14 Format of the NT_PRBSTEST_STATUS Event 2.15 Format of the NT_HEARTBEAT Event
2.1 Format of the NT_OBJECT_CREATION Event
2.1.1 Header Format of the NT_OBJECT_CREATION Event
2.1.2 Format of the NT_OBJECT_CREATION Event (filterable_data) 2.1.3 Format of the NT_OBJECT_CREATION Event (remainder_of_body)
2.1.1 Header Format of the NT_OBJECT_CREATION Event
Table 2-1 Header format of the NT_OBJECT_CREATION eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_OBJECT_ CREATION.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.1.2 Format of the NT_OBJECT_CREATION Event
(filterable_data)
Table 2-2 Format of the fiterrable_data in the structure of the NT_OBJECT_CREATION event
Name Type Description
notificationId String Unique ID of the notification
Name Type Description
objectName globaldefs::NamingAttribute
s_T
Name of the object created.
objectType notifications::ObjectType_T Type of the object created.
objectTypeQualifier String Type of the reported event.
This field is applicable to only the object types added in TMF V3.0.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
edgePointRelated boolean If the event relates to a PTP
that is an edge point or to a protection group containing a PTP that is an edge point, the value is true. Otherwise, the value is false.
2.1.3 Format of the NT_OBJECT_CREATION Event
(remainder_of_body)
remainder_of_body of the NT_OBJECT_CREATION event is the information model for creating an object. For details, see 3 Information Model.
2.2 Format of the NT_OBJECT_DELETION Event
2.2.1 Header Format of the NT_OBJECT_DELETION Event
2.2.2 Format of the NT_OBJECT_DELETION Event (filterable_data) 2.2.3 Format of the NT_OBJECT_DELETION Event (remainder_of_body)
Table 2-3 Header format of the NT_OBJECT_DELETION event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_OBJECT_ DELETION.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.2.2 Format of the NT_OBJECT_DELETION Event
(filterable_data)
Table 2-4 Format of filterable_data in structure of the NT_OBJECT_DELETION event
Name Type Description
notificationId string Unique ID of the notification
event.
objectName globaldefs::NamingAttribute
s_T
Name of the deleted object.
objectType notifications::ObjectType_T Type of the deleted object.
This field is used for only the object types defined in TMF V2.1 and the earlier versions.
objectTypeQualifier string Type of the reported event.
This field is applicable to only the object types added in TMF V3.0.
Name Type Description
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
edgePointRelated boolean If the event relates to a PTP
that is an edge point or to a protection group containing a PTP that is an edge point, the value is true. Otherwise, the value is false.
2.2.3 Format of the NT_OBJECT_DELETION Event
(remainder_of_body)
remainder_of_body of the NT_OBJECT_DELETION event is always null. When you delete a cross-connection object, you need to fill in the details of the cross-connection.
2.3 Format of the NT_ATTRIBUTE_VALUE_CHANGE
Event
2.3.1 Header Format of the NT_ATTRIBUTE_VALUE_CHANGE Event
2.3.2 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event (filterable_data) 2.3.3 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event (remainder_of_body)
2.3.1 Header Format of the NT_ATTRIBUTE_VALUE_CHANGE
Event
Table 2-5 Header format of the NT_ATTRIBUTE_VALUE_CHANGE event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
Type
Level-1 Name Level-2 Name
type_name string Type of a
notification event. The value is fixed as NT_ATTRIBU TE_VALUE_ CHANGE.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.3.2 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event
(filterable_data)
Table 2-6 Format of filterable_data in structure of the NT_ATTRIBUTE_VALUE_CHANGE event
Name Type Description
notificationId string Unique ID of the notification
event.
objectName globaldefs::NamingAttribute
s_T
Name of the object of which attributes change.
objectType notifications::ObjectType_T Type of the object of which
attributes change. This parameter is used for only the object types defined in TMF V2.1 and the earlier versions.
objectTypeQualifier string Type of the reported event.
This field is applicable to only the object types added in TMF V3.0.
emsTime globaldefs::Time_T Time (UTC) when the EMS
Name Type Description
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
edgePointRelated boolean If the event relates to a PTP
that is an edge point or to a protection group containing a PTP that is an edge point, the value is true. Otherwise, the value is false.
attributeList notifications::NVList_T List of changed attributes.
2.3.3 Format of the NT_ATTRIBUTE_VALUE_CHANGE Event
(remainder_of_body)
remainder_of_body of the NT_ATTRIBUTE_VALUE_CHANGE event is always null.
2.4 Format of the NT_STATE_CHANGE Event
2.4.1 Header Format of the NT_STATE_CHANGE Event
2.4.2 Format of the NT_STATE_CHANGE Event (filterable_data) 2.4.3 Format of the NT_STATE_CHANGE Event (remainder_of_body)
2.4.1 Header Format of the NT_STATE_CHANGE Event
Table 2-7 Header format of the NT_STATE_CHANGE eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_STATE_C HANGE.
Type
Level-1 Name Level-2 Name
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.4.2 Format of the NT_STATE_CHANGE Event (filterable_data)
Table 2-8 Format of filterable_data in structure of the NT_STATE_CHANGE eventName Type Description
notificationId string Unique ID of the notification
event.
objectName globaldefs::NamingAttribute
s_T
Name of the object of which the state changes.
objectType notifications::ObjectType_T Type of the object of which
the state changes. This parameter is used for only the object types defined in TMF V2.1 and the earlier versions.
objectTypeQualifier string Type of the reported event.
This field is applicable to only the object types added in TMF V3.0.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
edgePointRelated boolean If the event relates to a PTP
that is an edge point or to a protection group containing a PTP that is an edge point, the value is true. Otherwise, the value is false.
attributeList notifications::NVList_T List of the values of changed
2.4.3 Format of the NT_STATE_CHANGE Event
(remainder_of_body)
remainder_of_body of the NT_STATE_CHANGE event is always null. When you delete a cross-connection object, you need to fill in the details of the cross-connection. For details of the cross-connection, see 3.4.1 CrossConnect_T.
2.5 Format of the NT_PROTECTION_SWITCH Event
2.5.1 Header Format of the NT_PROTECTION_SWITCH Event
2.5.2 Format of the NT_PROTECTION_SWITCH Event (filterable_data) 2.5.3 Format of the NT_PROTECTION_SWITCH Event (remainder_of_body)
2.5.1 Header Format of the NT_PROTECTION_SWITCH Event
Table 2-9 Header format of the NT_PROTECTION_SWITCH eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_PROTEC TION_SWITC H.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
(filterable_data)
Table 2-10 Format of filterable_data in structure of the NT_PROTECTION_SWITCH event
Name Type Description
notificationId string Unique ID of the notification
event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
ProtectionType protection::ProtectionType_
T
Protection type.
switchReason protection::switchReason_T Reason why the switching
occurs.
layerRate transmissionParameters::La
yerRate_T
Layer rate that the switching is associated to.
groupName globaldefs::NamingAttribute
s_T
Name of the protection group where the switching occurs. If the protection type is SNCP, this field is an empty name can be reported.
Name Type Description
protectedTP globaldefs::NamingAttribute
s_T
Protected TP when the switching occurs. For SNCP, the value is always the reliable TP. For a notification of two-fiber BLSR
switching, the value is the TP that is inactive during the switching. For a notification of four-fiber MSP ring switching, the value is the working TP that is inactive during the switching. For a notification of 1:N MSP switching, the value is the working TP for which the protection switching occurs. For a notification of revertive 1+1 MSP switching, the value is the working TP. For a notification of non-revertive 1+1 MSP
switching, the value is the TP that was active before the switching (After the switching, the protected TP changes).
switchAwayFromTP globaldefs::NamingAttribute
s_T
Source TP that is switched away from. For two-fiber MSP switching, the value is the TP that is switched. For four-fiber MSP ring
switching, the value is one of the TPs in the MSP 1:N protection groups (working or protection). For four-fiber ring switching, the value is the working TP of the span that is switched. For example, if the east span switches to the west span, the value is the east working TP.
switchToTP globaldefs::NamingAttribute
s_T
Destination TP that is switched to. This TP is the source TP that is activated after the switching or the current active TP if no protection switching occurs
nativeEMSName string Name of the protection group where the protection
switching occurs.
additionalInfo notifications::NVList_T Additional information about
the protection switching event, currently including the type of the equipment where the switching occurs
(indicated by
ProductName) and the information about the protected board (indicated by protectedEquipment-Name), source board (indicated by
switchAwayFromEquip-mentName), and sink board (indicated by
switchToEquipment-Name).
NOTE
BLSR: bidirectional line switched ring additionalInfo in the NT_PROTECTION_SWITCH event structure of the U2000 CORBA interface is an extended field. This field stores the type of the equipment where the protection switching occurs.
2.5.3 Format of the NT_PROTECTION_SWITCH Event
(remainder_of_body)
remainder_of_body of the NT_PROTECTION_SWITCH event is always null.
2.6 Format of the NT_ATMPROTECTION_SWITCH Event
2.6.1 Header Format of the NT_ATMPROTECTION_SWITCH Event
2.6.2 Format of the NT_ATMPROTECTION_SWITCH Event (filterable_data) 2.6.3 Format of the NT_ATMPROTECTION_SWITCH Event (remainder_of_body)
2.6.1 Header Format of the NT_ATMPROTECTION_SWITCH
Event
Table 2-11 Header format of the NT_ATMPROTECTION_SWITCH event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_ATMPRO TECTION_S WITCH.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.6.2 Format of the NT_ATMPROTECTION_SWITCH Event
(filterable_data)
Table 2-12 Format of filterable_data in structure of the NT_ATMPROTECTION_SWITCH event
Name Type Description
notificationId string Unique ID of the notification
event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
pgName globaldefs::NamingAttribute s_T
Name of the ATM protection group where the switching occurs.
switchMode SwitchMode_T Switching mode.
protectType HW_mstpProtection::HW_ AtmProtectType_T Protection type. srcEndSwitchPara HW_mstpProtection::HW_ AtmPGSingleEndSwitchPar a_T
Parameters of the source-end switching. This field
describes the reason, the state and other information about the source-end switching.
snkEndSwitchPara HW_mstpProtection::HW_
AtmPGSingleEndSwitchPar a_T
Parameters of the sink-end switching. This field
describes the reason, the state and other information about the sink-end switching.
2.6.3 Format of the NT_ATMPROTECTION_SWITCH Event
(remainder_of_body)
remainder_of_body of the NT_ATMPROTECTION_SWITCH event is always null.
2.7 Format of the NT_WDMPROTECTION_SWITCH Event
2.7.1 Header Format of the NT_WDMPROTECTION_SWITCH Event
2.7.2 Format of the NT_WDMPROTECTION_SWITCH Event (filterable_data) 2.7.3 Format of the NT_WDMPROTECTION_SWITCH Event (remainder_of_body)
2.7.1 Header Format of the NT_WDMPROTECTION_SWITCH
Event
Table 2-13 Header format of the NT_WDMPROTECTION_SWITCH event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
Event Header
Type Name Type Description
Level-1 Name Level-2 Name
type_name string Type of a
notification event. The value is fixed as NT_WDMPR OTECTION_S WITCH.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.7.2 Format of the NT_WDMPROTECTION_SWITCH Event
(filterable_data)
Table 2-14 Format of filterable_data in structure of the NT_WDMPROTECTION_SWITCH event
Name Type Description
notificationId string Unique ID of the notification
event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
protectionGroupType protection::WDMProtection
Group_T
Type of the protection group.
switchReason protection::switchReason_T Reason why the switching
occurs.
groupName globaldefs::NamingAttribute
s_T
Name of the protection group where the switching occurs.
protectedTP globaldefs::NamingAttribute
s_T
Name of the protected TP during the switching.
switchAwayFromTP globaldefs::NamingAttribute s_T
Name of the source TP that is switched away from.
switchToTP globaldefs::NamingAttribute
s_T
Name of the destination TP that is switched to.
nativeEMSName string Information about the WDM
protection group where the switching occurs.
additionalInfo notifications::NVList_T Additional information about
the protection switching event, currently including the type of the equipment where the switching occurs
(indicated by
ProductName) and the information about the protected board (indicated by protectedEquipment-Name), source board (indicated by
switchAwayFromEquip-mentName), and sink board (indicated by
switchToEquipment-Name).
NOTE
additionalInfo in the NT_WDMPROTECTION_SWITCH event structure of the U2000 CORBA interface
is an extended field. This field stores the type of the equipment where the WDM protection switching occurs.
2.7.3 Format of the NT_WDMPROTECTION_SWITCH Event
(remainder_of_body)
remainder_of_body of the NT_WDMPROTECTION_SWITCH event is always null.
2.8 Format of the NT_RPRPROTECTION_SWITCH Event
2.8.1 Header Format of the NT_RPRPROTECTION_SWITCH Event
2.8.2 Format of the NT_RPRPROTECTION_SWITCH Event (filterable_data) 2.8.3 Format of the NT_RPRPROTECTION_SWITCH Event (remainder_of_body)
2.8.1 Header Format of the NT_RPRPROTECTION_SWITCH
Event
Table 2-15 Header format of the NT_RPRPROTECTION_SWITCH event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_RPRPRO TECTION_S WITCH.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.8.2 Format of the NT_RPRPROTECTION_SWITCH Event
(filterable_data)
Table 2-16 Format of filterable_data in structure of the NT_RPRPROTECTION_SWITCH event
Name Type Description
notificationId string Unique ID of the notification
event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
nodeName globaldefs::NamingAttribute s_T
Name of the node.
switchState HW_SwitchState_T Switching state.
switchReason protection::SwitchReason_T Switching cause.
switchPosition HW_SwitchPosition_T Switching position.
switchParameters globaldefs::NVSList_T switchParameters supports
the following parameters: switchPosition switchState protectType SwitchCountTimes ProtectCountTime LastSwitchCommand The parameters for switchParameters in a HW_RPRSwitchData_T structure contain east and west switching parameters.
2.8.3 Format of the NT_RPRPROTECTION_SWITCH Event
(remainder_of_body)
remainder_of_body of the NT_RPRPROTECTION_SWITCH event is always null.
2.9 Format of the NT_EPROTECTION_SWITCH Event
2.9.1 Header Format of the NT_EPROTECTION_SWITCH Event
2.9.2 Format of the NT_EPROTECTION_SWITCH Event (filterable_data) 2.9.3 Format of the NT_EPROTECTION_SWITCH Event (remainder_of_body)
2.9.1 Header Format of the NT_EPROTECTION_SWITCH Event
Table 2-17 Header format of the NT_EPROTECTION_SWITCH eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_EPROTE CTION_SWIT CH.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.9.2 Format of the NT_EPROTECTION_SWITCH Event
(filterable_data)
Table 2-18 Format of filterable_data in structure of the NT_EPROTECTION_SWITCH event
Name Type Description
notificationId string Unique ID of the notification
event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
eProtectionGroupType protection::EProtectionGrou
pType_T
Type of the reported equipment protection group.
eSwitchReason protection::ESwitchReason_ T
Reason why the switching occurs.
groupName globaldefs::NamingAttribute
s_T
Name of the equipment group where the switching occurs.
protectedE globaldefs::NamingAttribute
s_T
Protected equipment during the switching. For an m:n protection group, the protected equipment is the working equipment during the switching.
switchAwayFromE globaldefs::NamingAttribute
s_T
Source equipment that is switched away from.
switchToE globaldefs::NamingAttribute
s_T
Destination equipment that is switched to.
nativeEMSName string Detailed information about
the equipment protection group where the switching occurs.
additionalInfo globaldefs::NVSList_T Additional information,
currently including the type of the equipment where the equipment protection switching occurs (indicated by ProductName) and the information about the protected board (indicated by protectedEquipment-Name), source board (indicated by
switchAwayFromEquip-mentName), and sink board (indicated by
switchToEquipment-Name).
NOTE
additionalInfo in the NT_EPROTECTION_SWITCH event structure of the U2000 CORBA interface is
an extended field. This field stores the information about the type of equipment where the protection switching occurs.
2.9.3 Format of the NT_EPROTECTION_SWITCH Event
(remainder_of_body)
2.10 Format of the NT_IPPROTECTION_SWITCH Event
2.10.1 Header Format of the NT_IPPROTECTION_SWITCH Event
2.10.2 Format of the NT_IPPROTECTION_SWITCH Event (filterable_data) 2.10.3 Format of the NT_IPPROTECTION_SWITCH Event (remainder_of_body)
2.10.1 Header Format of the NT_IPPROTECTION_SWITCH Event
Table 2-19 Header format of the NT_IPPROTECTION_SWITCH eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_IPPROTE CTION_SWIT CH.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.10.2 Format of the NT_IPPROTECTION_SWITCH Event
(filterable_data)
Table 2-20 Format of filterable_data in structure of the NT_IPPROTECTION_SWITCH event
Name Type Description
notificationId string Unique ID of the notification
emsTime globaldefs::Time_T Time (UTC) when the EMS reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
protectionType string Type of a tunnel APS
protection group.
switchReason SwitchReason_T Cause of the switching.
groupName globaldefs::NamingAttribute
s_T
Name of a tunnel APS protection group where the switching occurs.
protectedList globaldefs::NamingAttribute
sList_T
List of tunnels under protection where the switching occurs.
switchAwayFromList globaldefs::NamingAttribute
sList_T
List of source tunnels where the switching occurs.
switchToList globaldefs::NamingAttribute
sList_T
List of destination tunnels where the switching occurs.
nativeEMSName string Details about a tunnel APS
protection group where the switching occurs.
additionalInfo globaldefs::NVSList_T Additional information.
Currently, this field is null.
2.10.3 Format of the NT_IPPROTECTION_SWITCH Event
(remainder_of_body)
remainder_of_body of the NT_IPPROTECTION_SWITCH event is always null.
2.11 Format of the NT_ROUTE_CHANGE Event
2.11.1 Header Format of the NT_ROUTE_CHANGE Event
2.11.2 Format of the NT_ROUTE_CHANGE Event (filterable_data) 2.11.3 Format of the NT_ROUTE_CHANGE Event (remainder_of_body)
2.11.1 Header Format of the NT_ROUTE_CHANGE Event
Table 2-21 Header format of the NT_ROUTE_CHANGE eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_ROUTE_ CHANGE.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.11.2 Format of the NT_ROUTE_CHANGE Event (filterable_data)
Table 2-22 Format of filterable_data in structure of the NT_ROUTE_CHANGE eventName Type Description
notificationId string Unique ID of the notification
event.
objectName globaldefs::NamingAttribute
s_T
Name of the object that reports the event.
objectType notifications::ObjectType_T Type of the object that
reports the event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
routeChangeEvent subnetworkConnection::Rer outeChangeEvent_T
Status information during the route change. The value is RerouteStarted, RerouteCompleted or RerouteFailed. route subnetworkConnection::Rou te_T
Detailed information about the new route.
2.11.3 Format of the NT_ROUTE_CHANGE Event
(remainder_of_body)
remainder_of_body of the NT_ROUTE_CHANGE event is always null.
2.12 Format of the NT_ASON_RESOURCE_CHANGE
Event
2.12.1 Header Format of the NT_ASON_RESOURCE_CHANGE Event
2.12.2 Format of the NT_ASON_RESOURCE_CHANGE Event (filterable_data) 2.12.3 Format of the NT_ASON_RESOURCE_CHANGE Event (remainder_of_body)
2.12.1 Header Format of the NT_ASON_RESOURCE_CHANGE
Event
Table 2-23 Header format of the NT_ASON_RESOURCE_CHANGE event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_ASON_R ESOURCE_C HANGE.
Event Header
Type Name Type Description
Level-1 Name Level-2 Name
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.12.2 Format of the NT_ASON_RESOURCE_CHANGE Event
(filterable_data)
Table 2-24 Format of filterable_data in structure of the NT_ASON_RESOURCE_CHANGE event
Name Type Description
notificationId string Unique ID of the notification
event.
objectName globaldefs::NamingAttribute
s_T
Name of the object that reports the event.
objectTypeQualifier string Object (ASON domain or
ASON node) of the reported event.
The value is
ROUTING_AREA or ROUTING_NODE.
notifyType string Type (creation or deletion) of
the reported event. The value is OBJECT_CREATE or OBJECT_DELETE.
emsTime globaldefs::Time_T Time (UTC) when the EMS
reports the event.
neTime globaldefs::Time_T Time (UTC) of the event
reported by the NE. If the NE does not report the time, the value is null.
edgePointRelated boolean If the event relates to a PTP that is an edge point or to a protection group containing a PTP that is an edge point, the value is true. Otherwise, the value is false.
2.12.3 Format of the NT_ASON_RESOURCE_CHANGE Event
(remainder_of_body)
remainder_of_body of the NT_ASON_RESOURCE_CHANGE event is always null.
2.13 Format of the NT_FILE_TRANSFER_STATUS Event
2.13.1 Header Format of the NT_FILE_TRANSFER_STATUS Event
2.13.2 Format of the NT_FILE_TRANSFER_STATUS Event (filterable_data) 2.13.3 Format of the NT_FILE_TRANSFER_STATUS Event (remainder_of_body)
2.13.1 Header Format of the NT_FILE_TRANSFER_STATUS Event
Table 2-25 Header format of the NT_FILE_TRANSFER_STATUS eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_FILE_TR ANSFER_STA TUS.
event_name string Name of a
notification event. The value is always null.
Event Header
Type Name Type Description
Level-1 Name Level-2 Name
variable_header Timeout string Timeout period
of a notification event.
2.13.2 Format of the NT_FILE_TRANSFER_STATUS Event
(filterable_data)
Table 2-26 Format of filterable_data in structure of the NT_FILE_TRANSFER_STATUS event
Name Type Description
notificationId string Unique ID of the notification
event.
filename string File directory and file name
that are entered. For example, /tmp/alarm4.txt.
transferStatu string Transfer status.
When transfer fails, the value is FT_FAILED.
When transfer is completed, the value is
FT_COMPLETED. When transfer is in process, the value is
FT_IN_PROGRESS.
percentComplete string Progress of the transfer
expressed in percentage. The value ranges from 0 to 100. For example, 100 percent.
failureReason string Cause of the file transfer failure.
When the transfer succeeds, the value is null.
When the transfer fails, details of the failure are described. For example, when the IP address is incorrect, the message "connection to 10.71.227.26 failed" is displayed. When the user name or password is incorrect, the message "530 Login incorrect" is displayed.
2.13.3 Format of the NT_FILE_TRANSFER_STATUS Event
(remainder_of_body)
remainder_of_body of the NT_FILE_TRANSFER_STATUS event is always null.
2.14 Format of the NT_PRBSTEST_STATUS Event
2.14.1 Header Format of the NT_PRBSTEST_STATUS Event
2.14.2 Format of the NT_PRBSTEST_STATUS Event (filterable_data)
2.14.1 Header Format of the NT_PRBSTEST_STATUS Event
Table 2-27 Header format of the NT_PRBSTEST_STATUS eventEvent Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_PRBSTES T_STATUS.
Event Header
Type Name Type Description
Level-1 Name Level-2 Name
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.14.2 Format of the NT_PRBSTEST_STATUS Event
(filterable_data)
Table 2-28 Format of filterable_data in structure of the NT_PRBSTEST_STATUS event
Name Type Description
notificationId string Unique ID of the notification
event.
TPName globaldefs::NamingAttribute
s_T
Name of the TP for which a 2 Mbit/s PRBS test is
performed.
TestStatus notifications::FileTransferSt
atus_T
Status of the 2 Mbit/s PRBS test.
The value is
FT_COMPLETED or FT_IN_PROGRESS.
percentComplete short Progress of the test. The
value ranges from 0 to 100.
2.15 Format of the NT_HEARTBEAT Event
2.15.1 Header Format of the NT_HEARTBEAT Event
Table 2-29 Header format of the NT_HEARTBEAT event Event Header
Type Name Type Description
Level-1 Name Level-2 Name
fixed_header event_type domain_name string Domain of a
notification event. The value is fixed as tmf_mtnm.
type_name string Type of a
notification event. The value is fixed as NT_HEARTB EAT.
event_name string Name of a
notification event. The value is always null.
variable_header Timeout string Timeout period
of a notification event.
2.15.2 Format of the NT_HEARTBEAT Event (filterable_data)
Table 2-30 Format of filterable_data in structure of the NT_HEARTBEAT eventName Type Description
notificationId string Unique ID of the notification
event.
objectName globaldefs::NamingAttribute
s_T
Name of the object that reports the event.
objectType notifications:: ObjectType_T Type of the object that
reports the event.
emsTime globaldefs::Time_T Time (UTC) when the EMS
3
Information Model
About This Chapter
3.1 emsMgr 3.2 equipment 3.3 managedElement 3.4 subnetworkConnection 3.5 multiLayerSubnetwork 3.6 topologicalLink 3.7 terminationPoint 3.8 protection 3.9 HW_mstpInventory 3.10 HW_mstpProtection 3.11 HW_mstpService 3.12 trafficDescriptor 3.13 encapsulationLayerLink 3.14 flowDomain 3.15 HW_controlPlane 3.16 maintenanceOps 3.17 TopoManagementManager 3.18 HW_vpnManager 3.19 trafficConditioningProfile
3.1 emsMgr
3.1.1 EMS_T
3.1.1 EMS_T
Name Type Description
name globaldefs::NamingAttribute
s_T
Name of an EMS.
userLabel string Null by default. This field can
be set through the setUserLabel interface.
nativeEMSName string The value of this field is
consistent with the name of the EMS in the name field mentioned above. The default value is Huawei/ U2000. This field can be set through the configuration file.
owner string Null by default. This field can
be set through the setOwner interface.
emsVersion string Version (in the form of
VxxRxxxCxx) of the EMS, for example, U2000 V100R002C01.
Type string For the U2000, the default
value is U2K. This field cannot be set.
Name Type Description
addtionalIfo globaldefs::NVSList_T Additional information,
which currently includes the AlarmSeverity, Location, CommuAddress, EmsTime InterfaceVersion, and EmsState parameters. AlarmSeverity: indicates the highest severity level of active alarms in the network management system. This field has five values:
l PS_CRITICAL: indicates a critical alarm. l PS_MAJOR: indicates a major alarm. l PS_MINOR: indicates a minor alarm. l PS_WARNING: indicates a warning alarm.
l Null: indicates that no
alarm is active. Location: indicates the physical location of the network management system. The default value is local. The value of this field can be set through the configuration file.
CommuAddress: indicates the IP address and port number of the host where the northbound interface communicating with the upper-level network
management system resides. The value is in the format of host:port, for example, 10.70.71.82:12003 and localhost:12003. EmsTime: current time (UTC) of the network management system, for example,
20071102110027.0Z, which indicates UTC 2007-11-02 11:00:27.
InterfaceVersion: indicates the interface version. EmsState: indicates the current status of the U2000.
3.2 equipment
3.2.1 EQTCreateData_T 3.2.2 Equipment_T 3.2.3 EquipmentHolder_T
3.2.1 EQTCreateData_T
Name Type Description
userLabel string User label of the board to be
installed. The value is a character string in a free format. This field can be null. The value is in the format that complies with the
requirement of the U2000 GUI for naming objects.
forceUniqueness boolean Flag that specifies whether
the user label must be unique. Currently, this field is not supported and can be set to false only.
owner string Owner of the board to be
installed. The value is a character string in a free format. This field can be null. The value is in the format that complies with the
requirement of the U2000 GUI for naming objects.
expectedEquipmentObject-Type
EquipmentObjectType_T Type of the board to be
installed. The value is in the format of board name(board type), for example, LWX (109).
equipmentHolderName globaldefs::NamingAttribute
s_T
Name Type Description
additionalInfo globaldefs::NVSList_T Additional field, which is not
used or processed currently.
3.2.2 Equipment_T
Name Type Description
name globaldefs::NamingAttribute
s_T
Name of a board.
userLabel string User label of the board.
nativeEMSName string Name of the board displayed
on the GUI of the network management system.
Owner string Onwer of the board. The
value is null by default and can be set through the setOwner interface.
alarmReportingIndicator boolean Whether the reporting of
alarms of boards is enabled. This value is always set to true.
serviceState ServiceState_T Working state of the board.
expectedEquipmentObject-Type
EquipmentObjectType_T Type of the board configured
on the network management system.
installedEquipmentObject-Type
EquipmentObjectType_T Type of the board installed on the NE.
installedPartNumber string Part number of the board,
which is a part of the bar code of the board.
installedVersion string Version number of the board.
installedSerialNumber string Serial number of the board,
which is a part of the bar code of the board.