iManager U2000 Unified Network Management System V200R017C60SPC200
Northbound TL1 Interface User Guide Issue
01
Date
2018-03-05
HUAWEI TECHNOLOGIES CO., LTD.
Copyright © Huawei Technologies Co., Ltd. 2018. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written 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 a 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
Email:
[email protected]
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
i
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
About This Document
About This Document Related Version The following table lists the product version related to this document. Product Name
Version
iManager U2000
V200R017C60SPC200
Intended Audience This document provides the commands and examples related to the TL1 NBI based on inventory management and services of the iManager U2000. In addition, this document provides typical examples for service provisioning, troubleshooting, and FAQ. This document describes how to install and run the TL1 NBI and provides the commands and examples for session control and operations performed to devices, notification of resource changes, inventory management, and service provisioning and maintenance. In addition, this document describes the examples for provisioning services related to the GPON FTTH, GPON FTTB, DSLAM/MSAN and provides troubleshooting and FAQ. This document is intended for: l
Application developers
l
Data configuration engineers
Symbol Conventions The symbols that may be found in this document are defined as follows. Symbol
Description Indicates an imminently hazardous situation which, if not avoided, will result in death or serious injury.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
ii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
About This Document
Symbol
Description Indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury. Indicates a potentially hazardous situation which, if not avoided, may result in minor or moderate injury. Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results. NOTICE is used to address practices not related to personal injury. Calls attention to important information, best practices and tips. NOTE is used to address information not related to personal injury, equipment damage, and environment deterioration.
Command Conventions The command conventions that may be found in this document are defined as follows.
Issue 01 (2018-03-05)
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.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
iii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
About This Document
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 ">" signs. For example, choose File > Create > Folder.
Change History For details about the change history, see 1 Change History.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
iv
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
Contents About This Document.....................................................................................................................ii 1 Change History.............................................................................................................................. 1 2 Usage Note...................................................................................................................................... 9 3 TL1 NBI Overview...................................................................................................................... 11 3.1 Introduction to the TL1 NBI.........................................................................................................................................11 3.2 Position in the Network................................................................................................................................................ 12 3.3 Communication Protocols............................................................................................................................................ 12 3.4 Functions and Features................................................................................................................................................. 13 3.5 Security Mechanism..................................................................................................................................................... 14 3.6 Performance Specifications.......................................................................................................................................... 16 3.7 Standard Compliance....................................................................................................................................................17 3.8 References.................................................................................................................................................................... 17
4 Relationships Between the License and TL1 NBI................................................................. 18 5 Installing and Enabling the NBI for Provisioning the TL1 Service.................................. 23 5.1 Configuration Requirements.........................................................................................................................................23 5.2 Installing a TL1 NBI Component................................................................................................................................. 24 5.3 Checking the Status of the TL1 NBI............................................................................................................................ 24
6 Maintaining the TL1 NBI...........................................................................................................26 6.1 Requirements for Maintenance Staff............................................................................................................................ 27 6.2 Routine Maintenance.................................................................................................................................................... 27 6.3 Logging in to the System Monitor Client..................................................................................................................... 28 6.4 Starting the TL1 Process...............................................................................................................................................30 6.5 Stopping the TL1 Process.............................................................................................................................................31 6.6 Checking the License Status of the U2000...................................................................................................................31 6.7 Creating a U2000 User for the Access of an OSS and Assign Rights to the User....................................................... 32
7 SSL Principle and Configuration............................................................................................. 35 7.1 SSL Principle................................................................................................................................................................ 35 7.2 Applying for an SSL Certificate................................................................................................................................... 36 7.3 Configuring an SSL Certificate.................................................................................................................................... 37
8 Setting Configuration Items......................................................................................................42 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
v
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
9 Distributed System..................................................................................................................... 68 9.1 Overview...................................................................................................................................................................... 68 9.2 List of Unsupported Commands...................................................................................................................................70 9.3 Maintaining the TL1 NBI Gateway Service.................................................................................................................71 9.4 Setting Configuration Items..........................................................................................................................................72
10 Command Format...................................................................................................................... 76 10.1 Format Description..................................................................................................................................................... 76 10.2 Command Format Description................................................................................................................................... 78 10.3 Response Format Description.....................................................................................................................................80 10.4 Format Description of the Resource Change Notification......................................................................................... 82
11 Supported Devices of the Same Series..................................................................................84 12 Controlling a Session and Performing Operations on a Device...................................... 85 12.1 Controlling the Session...............................................................................................................................................85 12.1.1 Logging in to the U2000 (LOGIN)..........................................................................................................................85 12.1.2 Logging In to the U2000 (ACT-USER)...................................................................................................................87 12.1.3 Exiting the U2000 (LOGOUT)................................................................................................................................89 12.1.4 Exiting the U2000 (CANC-USER)......................................................................................................................... 90 12.1.5 Querying the U2000 Version (LST-BMSVERSION)..............................................................................................91 12.1.6 Querying the NMS Information (LST-EMFSYSINFO)..........................................................................................92 12.1.7 Handshaking (SHAKEHAND)................................................................................................................................95 12.1.8 Handshaking (REPT-STAT).....................................................................................................................................96 12.2 Performing Operations on a Device........................................................................................................................... 98 12.2.1 Creating a Subnet (ADD-SUBNET)....................................................................................................................... 98 12.2.2 Modifying a Subnet (MOD-SUBNET)................................................................................................................... 99 12.2.3 Deleting a Subnet (DEL-SUBNET)...................................................................................................................... 101 12.2.4 Adding an NE Link (ADD-NELINK)................................................................................................................... 102 12.2.5 Modifying an NE Link (MOD-NELINK)............................................................................................................. 104 12.2.6 Deleting an NE Link (DEL-NELINK).................................................................................................................. 106 12.2.7 Synchronizing the Time (SYNC-DEVTIME)....................................................................................................... 107 12.2.8 Synchronizing NE Data (SYNC-DEV)................................................................................................................. 109 12.2.9 Deleting a Device (DEL-DEV)..............................................................................................................................111 12.2.10 Resetting a Device (RESET-DEV)...................................................................................................................... 115 12.2.11 Resetting a Board (RESET-BOARD).................................................................................................................. 117 12.2.12 Changing the Device Name and Alias (MOD-DEV).......................................................................................... 119 12.2.13 Modifying the Shelf Name and Alias (MOD-FRAME)...................................................................................... 121 12.2.14 Modifying the Slot Alias (MOD-SLOT)............................................................................................................. 124 12.2.15 Exporting a Resource File (DMP-INVENTORY)...............................................................................................126 12.2.16 Exporting Service Port Statistics to Files (DMP-E2EPERF).............................................................................. 134 12.2.17 Exporting Ethernet Port Statistics to Files (DMP-ETHPERF)............................................................................137 12.2.18 Exporting PON Port Statistics to Files (DMP-PONPERF)................................................................................. 139 12.2.19 Adding a Device (ADD-DEV)............................................................................................................................ 142 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
vi
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
12.2.20 Adding a Board (ADD-BOARD)........................................................................................................................ 146 12.2.21 Deleting a Board (DEL-BOARD)....................................................................................................................... 149 12.2.22 Disabling a Board (DISABLE-BOARD)............................................................................................................ 151 12.2.23 Enabling a Board (ENABLE-BOARD).............................................................................................................. 153 12.2.24 Confirming a Board (CONFIRM-BOARD)........................................................................................................155 12.2.25 Switching Over the Active and Standby Control Boards (SYSTEM-SWITCH)................................................ 157 12.2.26 Activating a CATV Port (ACT-CATVPORT)..................................................................................................... 159 12.2.27 Deactivating a CATV Port (DACT-CATVPORT)............................................................................................... 161 12.2.28 Changing a Device IP Address (MOD-DEVIP)..................................................................................................163 12.2.29 Adding an Alarm to the U2000 (ADD-ALARM)............................................................................................... 166 12.2.30 Saving the Device Configuration (SAVE-DEV)................................................................................................. 169 12.2.31 Issuing the Command Configuration Script to a Device (CFG-DEVEX)...........................................................171 12.2.32 Issuing the Command Configuration Script to an MDE Device (CFG-MDUEX)..............................................181 12.2.33 Configuring the ANCP (CFG-PORTANCPINTERFACE)................................................................................. 186 12.2.34 Modifying System Attributes for NEs (CFG-DEVSYSPARA).......................................................................... 189
13 Notification of Resource Changes........................................................................................192 13.1 Notifying Resource Changes.................................................................................................................................... 192 13.1.1 Registering the Notification of Resource Changes (REG-RESCHGNOTIFY).................................................... 192 13.1.2 Canceling the Notification of Resource Changes (UREG-RESCHGNOTIFY)....................................................193 13.1.3 Querying the Notification of Resource Changes (LST-BMSRESCHANOTIFY)................................................ 194 13.2 Notifying Device Resource Changes........................................................................................................................197 13.2.1 Notifying Device Confirmation.............................................................................................................................198 13.2.2 Notifying Device Deletion.....................................................................................................................................199 13.2.3 Notifying Device Synchronization........................................................................................................................ 201 13.2.4 Notifying Shelf Confirmation................................................................................................................................202 13.2.5 Notifying the Shelf Deletion..................................................................................................................................203 13.2.6 Notifying Slot Confirmation..................................................................................................................................205 13.2.7 Notifying the Slot Deletion....................................................................................................................................206 13.2.8 Reporting Notifications of OLT Attribute Changes.............................................................................................. 207 13.2.9 Reporting Notifications of MDU Attribute Changes............................................................................................ 209 13.2.10 Reporting Notifications of ONU Addition.......................................................................................................... 211 13.2.11 Reporting Notifications of ONU Deletion...........................................................................................................213 13.2.12 Reporting Notifications of Board Attribute Changes.......................................................................................... 215 13.2.13 Notifying Plug and Play Deployment Completion..............................................................................................217 13.3 Notifying GPON Resource Changes........................................................................................................................ 220 13.3.1 Reporting Notifications on Initial Power-on of GPON ONUs.............................................................................. 220 13.3.2 Notifying the Event That an FTTH GPON ONU Port Is Online.......................................................................... 222 13.3.3 Notifying the Automatic Discovery of a GPON ONU..........................................................................................225 13.3.4 Notifying GPON ONU Replacement.................................................................................................................... 228 13.4 Notifying EPON Resource Changes.........................................................................................................................230 13.4.1 Reporting Notifications on Initial Power-on of EPON ONUs.............................................................................. 231 13.4.2 Notifying the Event That an FTTH ONU Port Is Online...................................................................................... 233 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
vii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
13.4.3 Notifying the Automatic Discovery of an EPON ONU........................................................................................ 235 13.4.4 Notifying EPON ONU Replacement.....................................................................................................................238
14 Inventory Management.......................................................................................................... 241 14.1 Querying Device Resources..................................................................................................................................... 243 14.1.1 Querying a Subnet (LST-SUBNET)...................................................................................................................... 243 14.1.2 Querying an NE Link (LST-NELINK)..................................................................................................................246 14.1.3 Querying the Information About a Device (LST-DEV)........................................................................................ 249 14.1.4 Querying Device Global Configurations (LST-DEVCFG)................................................................................... 259 14.1.5 Querying CPU and Memory Information about an NE (LST-DEVINFO)........................................................... 263 14.1.6 Querying Subrack Information (LST-FRAME).................................................................................................... 268 14.1.7 Querying the Information About a Board (LST-BOARD)....................................................................................273 14.1.8 Querying Real-Time Performance Data of Boards (LST-BOARDPERF)............................................................ 280 14.1.9 Querying the Information About a Daughter Board (LST-SUBBOARD)............................................................ 282 14.1.10 Querying the Information About a Port (LST-PORT)......................................................................................... 286 14.1.11 Querying Protection Group Information (LST-PSG) ......................................................................................... 294 14.1.12 Querying the Alarms on the U2000 (LST-ALARM)...........................................................................................298 14.1.13 Querying the MAC Addresses Learnt by Devices (LST-OLTLEARNINGMAC)..............................................301 14.2 Querying ADSL Resources...................................................................................................................................... 305 14.2.1 Querying the Basic Information About an ADSL Port (LST-ADSLPORTCFG)................................................. 305 14.2.2 Querying Specified Information About ADSL Ports (LST-DSLPORTSPECIFYINFO)......................................307 14.2.3 Querying the Details of an ADSL Port (LST-DSLPORTDETAILINFO)............................................................. 312 14.2.4 Querying the List of ADSL Line Profiles (LST-ADSLLINEPROFILE).............................................................. 335 14.2.5 Querying the Details of an ADSL Line Profile (LST-ADSLLINEPROFILEDETAIL)........................................343 14.2.6 Querying the List of ADSL Alarm Profiles (LST-ADSLALARMPROFILE)......................................................352 14.2.7 Querying the List of ADSL Extended Profiles (LST-ADSLEXTENDPROFILE)............................................... 356 14.2.8 Querying the Details of an ADSL Extended Profile (LST-ADSLEXTENDPROFILEDETAIL).........................359 14.2.9 Querying the Alarm Information About an ADSL Port (LST-ADSLPORTALARM)..........................................366 14.2.10 Querying the Alarm Status of an xDSL Port (LST-XDSLPORTALARMSTATE)............................................. 369 14.2.11 Querying the Performance Statistics of an ADSL Port (LST-ADSLPORTPERF)..............................................374 14.2.12 Querying the Current Performance Statistics of an ADSL Port (LST-ADSLNTPORTPERF)...........................377 14.2.13 Querying Performance of ADSL Port in Current 15 Minutes and Last 15 Minutes (LSTADSLPORTQTRPERF)................................................................................................................................................... 381 14.2.14 Querying the Historical 15-minute Performance Statistics of an ADSL Port (LST-ADSLPORTHISQTRPERF) .......................................................................................................................................................................................... 390 14.2.15 Querying Bit Allocation Information About an ADSL Port (LST-ADSLBITALLOCINFO)............................ 395 14.2.16 Querying the U-MAC/V-MAC of an xDSL Port (LST-XDSLPORTMACMAPING)....................................... 398 14.3 Querying G.SHDSL Resources................................................................................................................................ 401 14.3.1 Querying the Chipset Mode of a Board (LST-SHDSLBOARDCHIPSETMODE).............................................. 401 14.3.2 Querying the Details of an SHDSL Port (LST-SHDSLPORTDETAILINFO)......................................................403 14.3.3 Querying the List of SHDSL Line Profiles (LST-SHDSLSPANPROFILE)......................................................... 411 14.3.4 Querying the Details of an SHDSL Line Profile (LST-SHDSLSPANPROFILEDETAIL).................................. 413 14.3.5 Querying the Devices That Reference an SHDSL Line Profile (LST-DEVBYSP).............................................. 419 14.3.6 Querying the Ports That Reference an SHDSL Line Profile (LST-PORTBYSP)................................................. 421 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
viii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
14.3.7 Querying the List of SHDSL Alarm Profiles (LST-SHDSLALARMPROFILE)................................................. 423 14.3.8 Querying the Details of an SHDSL Alarm Profile (LST-SHDSLALARMPROFILEDETAIL)...........................425 14.3.9 Querying the Devices That Reference an SHDSL Alarm Profile (LST-DEVBYAL)...........................................428 14.3.10 Querying the Ports That Reference an SHDSL Alarm Profile (LST-PORTBYAL)............................................430 14.3.11 Querying the Alarm Information About an SHDSL Port (LST-SHDSLPORTALARM)................................... 433 14.3.12 Querying the Performance Statistics of a G.SHDSL Port (LST-SHDSLPORTPERF)....................................... 436 14.3.13 Querying the FE1 Attribute of a TDM SHDSL Port (LST-SHDSLPORTFE1)..................................................443 14.4 Querying VDSL2 Resources.................................................................................................................................... 445 14.4.1 Querying the Details of a VDSL2 Port (LST-VDSL2PORTDETAILINFO)........................................................ 445 14.4.2 Querying Specified Information About VDSL2 Ports (LST-VDSL2PORTSPECIFYINFO)...............................476 14.4.3 Querying VDSL2 Port Information about Specified NEs (LST-NEVDSL2PORTDETAILINFO)...................... 492 14.4.4 Querying the Alarm Information About a VDSL2 Port (LST-VDSLPORTALARM)..........................................500 14.4.5 Querying the Performance Statistics on a VDSL2 Port (LST-VDSLPORTPERF)...............................................503 14.4.6 Querying a VDSL2 Line Profile (LST-VDSLLINEPROFILE)............................................................................ 518 14.4.7 Query the Details of a VDSL2 Line Profile (LST-VDSLLINEPROFILEDETAIL).............................................520 14.4.8 Querying a VDSL2 Alarm Profile (LST-VDSLALARMPROFILE).................................................................... 532 14.4.9 Query the Details of a VDSL2 Alarm Profile (LST-VDSLALARMPROFILEDETAIL).................................... 535 14.4.10 Querying the Alarm Status of an xDSL Port (LST-XDSLPORTALARMSTATE)............................................. 541 14.4.11 Querying Bit Allocation Information About a VDSL2 Port (LST-VDSL2BITALLOCINFO)...........................545 14.4.12 Querying the U-MAC/V-MAC of an xDSL Port (LST-XDSLPORTMACMAPING)....................................... 548 14.4.13 Querying Global VDSL2 Profile Names (LST-PROFNAME)........................................................................... 551 14.4.14 Querying NE-side VDSL2 Profile Names (TI Mode).........................................................................................553 14.4.14.1 Querying VDSL2 Service Profile Names (LST-VDSLSERVICEPROFILE).................................................. 554 14.4.14.2 Querying VDSL2 UPBO Profile Names (LST-VDSLUPBOPROFILE)......................................................... 556 14.4.14.3 Querying VDSL2 DPBO Profile Names (LST-VDSLDPBOPROFILE)......................................................... 558 14.4.14.4 Querying VDSL2 Spectrum Profile Names (LST-VDSLSPECPROFILE)..................................................... 560 14.4.14.5 Querying VDSL2 Alarm Profile Names (LST-VDSLTIALARMPROFILE).................................................. 562 14.4.14.6 Querying VDSL2 SNR Margin Profile Names (LST-VDSLNMPROFILE)................................................... 564 14.4.14.7 Querying VDSL2 Delay INP Profiles (LST-VDSLINPPROFILE)................................................................. 567 14.4.15 Querying the Performance Statistics on a GPON ONT VDSL2 Port (LST-ONTVDSLPORTPERF)............... 569 14.4.16 Querying the Details of a GPON ONT VDSL2 Port (LST-ONTVDSL2PORTDETAILINFO).........................579 14.4.17 Querying Specified Information About GPON ONT VDSL2 Ports (LST-ONTVDSL2PORTSPECIFYINFO) .......................................................................................................................................................................................... 594 14.5 Querying G.fast Resources....................................................................................................................................... 605 14.5.1 Querying the Details of a G.fast Port (LST-GFASTPORTDETAILINFO)........................................................... 605 14.5.2 Querying G.fast Port Information About Specified NEs (LST-NEGFASTPORTDETAILINFO)........................628 14.5.3 Querying the Alarm Information About a G.fast Port (LST-GFASTPORTALARM)...........................................634 14.5.4 Querying the Performance Statistics on a G.fast Port (LST-GFASTPORTPERF)................................................637 14.5.5 Querying the Alarm Status of an xDSL Port (LST-XDSLPORTALARMSTATE)............................................... 649 14.5.6 Querying the Bit Allocation Information About a G.fast Port (LST-GFASTBITALLOCINFO)......................... 654 14.5.7 Querying the U-MAC/V-MAC of an xDSL Port (LST-XDSLPORTMACMAPING)......................................... 656 14.6 Querying a Bonding Group...................................................................................................................................... 659 14.6.1 Querying a Bonding Group (RTRV-BONDGRP)..................................................................................................659 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
ix
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
14.6.2 Querying the Details of a Bonding Group (RTRV-BONDGRPDETAIL).............................................................662 14.6.3 Querying Performance Statistics of a VDSL2 Bonding Group (LST-VDSL2BONDINGGROUPPERF)........... 666 14.6.4 Querying the Details of a VDSL2 Bonding Group (LST-VDSL2BONDINGDETAILINFO)............................. 671 14.7 Querying Video Resources....................................................................................................................................... 674 14.7.1 Querying the List of Virtual Upstream Ports in an IGMP VLAN (LST-IGMPUPLINKPORT).......................... 674 14.7.2 Querying the Information About Multicast Programs (LST-NTVPROGRAM)................................................... 677 14.7.3 Querying the Detail Information of a Multicast User (LST-NTVUSRDETAIL)..................................................684 14.7.4 Querying the List of Multicast Users (LST-NTVPORTBASIC)...........................................................................692 14.7.5 Querying the Rights Profile of a Multicast User (LST-NTVPORTRP)................................................................ 702 14.7.6 Querying Rights Profiles (LST-NTVRP).............................................................................................................. 712 14.7.7 Querying the Programs Specified in a Rights Profile (LST-RPPROGRAM)....................................................... 715 14.7.8 Querying the Multicast VLAN Information of a Device (RTRV-IGMPVLAN)...................................................719 14.7.9 Querying the Multicast VLAN of a Multicast User (LST-NTVUSRIGMPVLAN)............................................. 721 14.7.10 Querying the Details of a Multicast VLAN (RTRV-IGMPVLANDETAIL).......................................................730 14.7.11 Querying the Details on a Multicast VLAN (LST-IGMPVLANDETAIL)......................................................... 734 14.7.12 Querying the Multicast Subtend Port (LST-NTVCASCADE)............................................................................739 14.8 Querying GPON Resources......................................................................................................................................743 14.8.1 Querying the List of GPON Ports (LST-GPONPORT)......................................................................................... 743 14.8.2 Querying the Details of a GPON Port (LST-GPONPORTDETAIL).....................................................................747 14.8.3 Querying the Information About an Upstream GPON Port (LST-GPONNNIPORT)...........................................754 14.8.4 Querying the List of ONUs (LST-ONT)................................................................................................................758 14.8.5 Querying the Details of an ONT (LST-ONTDETAIL)..........................................................................................770 14.8.6 Querying the IP Address of a GPON ONT (LST-ONTIPINFO)...........................................................................779 14.8.7 Querying the Information About Auto-Discovered GPON ONUs (LST-GPONONTAUTOFIND).....................783 14.8.8 Querying the Running Status of an ONT (LST-ONTRUNINFO).........................................................................788 14.8.9 Querying the List of ONT Ports (LST-ONTPORT).............................................................................................. 794 14.8.10 Querying the Details of an ONT Port (LST-ONTPORTDETAIL)......................................................................799 14.8.11 Querying the Ethernet Port Details of a GPON ONT (LST-GPONONTETHPORTDETAIL)........................... 805 14.8.12 Querying the Status of an ONU POTS User (LST-ONTPOTSSTATE).............................................................. 808 14.8.13 Querying the MAC Addresses Learned by the User Port of an FTTH ONU (LST-GPONONTPORTMAC)....814 14.8.14 Querying the Details of GPON Optical Modules (LST-GPONSFP)...................................................................819 14.8.15 Querying the Parameters of the Optical Module of an ONT (LST-ONTDDMDETAIL)................................... 825 14.8.16 Querying the Optical Module Information of an MDU NNI Port (LST-ONUNNIDDMDETAIL)....................834 14.8.17 Querying the Ethernet Transmission Feature of an Upstream Port of an ONT (LST-ONTETHPORTPERF)... 838 14.8.18 Querying the List of DBA Profiles Bound to an ONT (LST-ONTDBAPROF)..................................................844 14.8.19 Querying the List of GEM Ports (LST-GEMPORT)........................................................................................... 850 14.8.20 Querying the List of GEM Connections (LST-GEMCONNECTION)............................................................... 855 14.8.21 Querying the Real-Time Performance Data of Ethernet Traffic on a GPON UNI Port (LST-GPONPORTPERF) .......................................................................................................................................................................................... 860 14.8.22 Querying the Real-Time Performance Data of a GPON ONT Ethernet Port (LST-GPONONTETHPORTPERF) .......................................................................................................................................................................................... 864 14.8.23 Querying the ONT WAN Port Information (LST-ONTWAN)............................................................................ 868 14.8.24 Querying ONT SIP User Accounts (LST-ONTSIPINFO).................................................................................. 873 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
x
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
14.8.25 Querying GPON Line Profile Names (LST-GPONLINEPROFILE).................................................................. 878 14.8.26 Querying GPON Service Profile Names (LST-GPONSRVPROFILE)............................................................... 881 14.8.27 Query the DHCP IP Configuration of an ONT (LST-ONTIPCONFIG)............................................................. 883 14.8.28 Querying the VoIP Address of an ONT (LST-ONTVAGVOIP)......................................................................... 887 14.8.29 Querying the ONT PSTN User Information (LST-ONTVOIPPSTNUSER)...................................................... 892 14.8.30 Querying the VLAN Switching Pair for an Ethernet Port on a GPON ONT (LSTONTETHVLANSWTICHPAIR)......................................................................................................................................901 14.8.31 Querying the Traffic Shaping Information of an ONT Queue (LST-ONTQUEUESHAPING)..........................905 14.8.32 Querying the GPON Optical Module Information (LST-GPONDDMINFO).....................................................909 14.8.33 Querying the Transmission Feature of a GPON NNI Port (LST-GPONNNIPERF)...........................................913 14.8.34 Querying the First Idle GEM Port ID of GPON Ports (LST-FRSTIDLGEM)....................................................916 14.8.35 Exporting POTS Service Provisioning Statistical Files (DMP-POTSPERF)..................................................... 919 14.8.36 Exporting GPON ONT Online Status Statistical Files (DMP-ONTPERF)........................................................ 921 14.8.37 Querying GPON MDU Replacement Tasks (LST-ONTRM)..............................................................................923 14.8.38 Querying Call Record of a ONT Pots (LST-ONTPOTSCALLRECORD)......................................................... 930 14.8.39 Querying Details About a Global GPON Line Profile(LST-GLOBALGPONLINEPROFILEDETAIL)...........935 14.8.40 Querying a Global GPON Line Profile Name List(LST-GLOBALGPONLINEPROFILENAME)...................938 14.8.41 Querying Details About a Global GPON Service Profile (LST-GLOBALGPONSRVPROFILEDETAIL).......940 14.8.42 Querying a Global GPON Service Profile Name List (LST-GLOBALGPONSRVPROFILENAME)...............943 14.8.43 Querying Details About a Global GPON DBA Profile (LST-GLOBALDBAPROFILEDETAIL).................... 945 14.8.44 Querying a Global GPON DBA Profile Name List (LST-GLOBALDBAPROFILENAME)............................ 949 14.8.45 Querying the ONT WLAN Information (LST-ONTUSERWLAN).................................................................... 951 14.8.46 Querying WiFi Statistics (LST-ONTAPWIFISTATISTICS)...............................................................................958 14.8.47 Querying the WiFi Device Information (LST-ONTWIFIDEVICE)................................................................... 962 14.8.48 Querying the Online External AP Information (LST-ONTEXTERNALAP)..................................................... 967 14.8.49 Querying the AP Neighbor Information (LST-ONTAPNEIGHBOR).................................................................971 14.8.50 Querying the number of connected ont users(LST-ONTUSER)......................................................................... 976 14.9 Querying EPON Resources...................................................................................................................................... 980 14.9.1 Querying Information About an Upstream EPON ONU Port (LST-EPONNNIPORT)........................................980 14.9.2 Querying the List of EPON ONTs (LST-EPONONT).......................................................................................... 983 14.9.3 Querying Information About Auto-discovered EPON ONUs (LST-EPONONTAUTOFIND)............................ 992 14.9.4 Querying the Running Status of an ONT (LST-EPONONTRUNINFO).............................................................. 995 14.9.5 Querying the Ethernet Port Details of an EPON ONT (LST-EPONONTETHPORTDETAIL)..........................1002 14.9.6 Querying the MAC Addresses Learned by the User Port of an FTTH ONU (LST-EPONONTPORTMAC).... 1005 14.9.7 Querying the EPON Information of an MDU Device (LST-EPONBYONUDEV)............................................ 1010 14.9.8 Querying Optical Module Information About an EPON ONT (LST-EPONONTDDMDETAIL)......................1015 14.9.9 Querying the Optical Module Information of an MDU NNI Port (LST-ONUNNIDDMDETAIL) ...................1022 14.9.10 Querying Details on EPON Optical Modules (LST-EPONSFP).......................................................................1025 14.9.11 Querying Optical Module Information About an EPON Port (LST-EPONPORTDDMDETAIL)................... 1031 14.9.12 Querying the EPON Port Details (LST-EPONPORTDETAIL).........................................................................1035 14.9.13 Querying Real-Time Performance Data of an EPON Port (LST-EPONPONPORTPERF).............................. 1039 14.9.14 Querying Real-Time Performance Data of Ethernet Traffic on an EPON UNI Port (LST-EPONPORTPERF) ........................................................................................................................................................................................ 1042 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xi
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
14.9.15 Querying Real-Time Performance Data on an EPON ONT Ethernet Port (LST-EPONONTETHPORTPERF) ........................................................................................................................................................................................ 1046 14.9.16 Querying ONT SIP User Accounts (LST-ONTSIPINFO)................................................................................ 1050 14.9.17 Querying the VoIP Address of an ONT (LST-ONTVAGVOIP)....................................................................... 1055 14.9.18 Querying the ONT PSTN User Information (LST-ONTVOIPPSTNUSER).................................................... 1060 14.9.19 Querying Call Record of a ONT Pots (LST-ONTPOTSCALLRECORD)....................................................... 1069 14.9.20 Querying the ONT WLAN Information (LST-ONTUSERWLAN).................................................................. 1074 14.9.21 Querying WiFi Statistics (LST-ONTAPWIFISTATISTICS).............................................................................1082 14.9.22 Querying the WiFi Device Information (LST-ONTWIFIDEVICE)................................................................. 1086 14.9.23 Querying the Online External AP Information (LST-ONTEXTERNALAP)................................................... 1091 14.9.24 Querying the AP Neighbor Information (LST-ONTAPNEIGHBOR)...............................................................1095 14.9.25 Querying the number of connected ont users(LST-ONTUSER)....................................................................... 1100 14.10 CNU Resource Query........................................................................................................................................... 1104 14.10.1 Querying the List of CNUs (LST-CNU)............................................................................................................1104 14.10.2 Querying the Details of a CNU (LST-CNUDETAIL)....................................................................................... 1108 14.11 Querying CM Resources....................................................................................................................................... 1112 14.11.1 Querying the Info of CM (LST-CMINFO)........................................................................................................ 1112 14.11.2 Querying the CPE List of a CM (LST-CMCPELIST)....................................................................................... 1116 14.11.3 Collecting Statistics on a CM (LST-CMNUMSTATIC).................................................................................... 1119 14.11.4 Querying the List of CMs (LST-CMLIST)........................................................................................................1123 14.11.5 Querying the Quality of CM Upstream Channels (LST-CMUPCHANNELINFO).......................................... 1132 14.11.6 Querying the Quality of CM Downstream Channels (LST-CMDOWNCHANNELINFO)..............................1136 14.11.7 Querying the Downstream Channel Info List of RF Ports (LST-DOWNCHANNELINFO)............................1140 14.11.8 Querying the Upstream Channel Info List of RF Ports (LST-UPCHANNELINFO)........................................ 1144 14.11.9 Querying the Details of a CM (LST-CMDETAIL)............................................................................................1149 14.11.10 Querying the PNM Pre-equalization Coefficients of a CM (LST-CMPNM-EQD).........................................1158 14.11.11 Querying the PNM Auxiliary Parameters of a CM (LST-CMPNM-SUB)......................................................1165 14.11.12 Querying the Layer 2 VPN VLAN of a CM (LST-L2VPNVLAN)................................................................ 1172 14.11.13 Querying Amplifier Details (LST-AMPDETAIL)...........................................................................................1175 14.12 Querying VLAN Resources..................................................................................................................................1179 14.12.1 Querying the VLAN Information of a Device (LST-VLAN)............................................................................ 1179 14.12.2 Querying the Details of a VLAN (LST-VLANDETAIL)..................................................................................1185 14.12.3 Querying the VLAN ID of an xDSL Port (LST-DSLPORTVLAN)................................................................. 1191 14.12.4 Querying the List of Ports in a VLAN (LST-PORTOFVLAN).........................................................................1195 14.12.5 Querying the VLAN ID of a Port (LST-VLANOFPORT)................................................................................ 1199 14.12.6 Querying the Transmission Feature of a VLAN (LST-VLANPERF)............................................................... 1202 14.12.7 Querying an L3 Interface (LST-VLANL3IF)....................................................................................................1207 14.13 Querying Ethernet Resources............................................................................................................................... 1211 14.13.1 Querying the Details of an Ethernet Port (LST-ETHPORTDETAILINFO)......................................................1211 14.13.2 Querying an Ethernet Aggregation Group (LST-LAG).....................................................................................1219 14.13.3 Querying the List of Vlan in Aggregation Group (LST-VLANOFLAG)......................................................... 1224 14.13.4 Querying the Details of an SFP (LST-SFPDETAILINFO)............................................................................... 1227 14.13.5 Querying the SFP Information of a Device (LST-SFP).....................................................................................1233 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
14.13.6 Querying the Upstream Traffic Information of an Ethernet Port (LST-ETHPORTSTATINFO)...................... 1239 14.13.7 Querying the DDM Details of an Optical Module (LST-DDMDETAILINFO)................................................1243 14.13.8 Querying the Ethernet Transmission Statistics (LST-ETHPORTPERF)...........................................................1247 14.13.9 Querying the List of Ethernet Ports (LST-ETHPORT)..................................................................................... 1253 14.13.10 Querying the MAC Addresses Learned by the Service Port of an FTTB ONU (LST-ETHPORTMAC).......1258 14.13.11 Querying the Up Link Ethernet Transmission Statistics (LST-DEVUPLINK)............................................... 1262 14.14 Querying Service Virtual Port Resources............................................................................................................. 1266 14.14.1 Querying Service Virtual Ports (LST-SERVICEPORT)....................................................................................1266 14.14.2 Querying the Service Port Information about NEs (LST-NESERVICEPORTDETAIL).................................. 1292 14.14.3 Querying the Details of a Service Virtual Port (LST-SERVICEPORTDETAIL)..............................................1297 14.14.4 Querying the Static IP Addresses of a Service Port (LST-IP2SERVICEPORT)...............................................1319 14.14.5 Querying the Performance Statistics of Service Ports (LST-SERVICEPORTPERF)....................................... 1330 14.14.6 Querying CAR Groups (LST-CARGROUP).....................................................................................................1345 14.14.7 Querying Bundles of Service Virtual Ports (LST-SERVICEPORTBUNDLE)................................................. 1348 14.14.8 Querying the MAC Addresses Learned By a User Port and Its Service Port (LST-PORTMACADDRESS).. 1351 14.14.9 Querying the 802.1x of a Service Port (LST-DOT1X2SERVICEPORT)......................................................... 1363 14.14.10 Querying the List of ONUs (LST-ONTSERVICEPORT)............................................................................... 1374 14.15 Querying PVC Resources..................................................................................................................................... 1379 14.15.1 Querying the Information About a PVC (LST-PVC)........................................................................................ 1379 14.15.2 Querying the Information About a VPI (LST-VPI)...........................................................................................1385 14.15.3 Querying the Information About a PVP (LST-PVP)......................................................................................... 1388 14.15.4 Querying Anti-DoS Attack Information of Service Flows (LST-ANTIDOS).................................................. 1393 14.16 Querying TDM E1 Resources.............................................................................................................................. 1396 14.16.1 Querying Local TDM E1 Connections (LST-NATIVETDMCONN)............................................................... 1397 14.16.2 Querying the Attribute of a PRI E1 Port (LST-PRIE1)..................................................................................... 1403 14.17 Querying Traffic Profile Resources...................................................................................................................... 1407 14.17.1 Querying a global ATM Traffic Profile (LST-ATMTP).................................................................................... 1407 14.17.2 Querying an IP Traffic Profile (LST-IPTP)....................................................................................................... 1410 14.17.3 Querying a global MEF IP Traffic Profile (LST-MEFIPTP).............................................................................1413 14.18 Querying PSTN Resources................................................................................................................................... 1419 14.18.1 Querying a V5 PSTN User (LST-V5PSTNUSER)............................................................................................1419 14.19 Querying the ISDN Resources............................................................................................................................. 1423 14.19.1 Querying a V5 ISDN BRA User (LST-V5BRAUSER).................................................................................... 1424 14.19.2 Querying a V5 ISDN PRA User (LST-V5PRAUSER)..................................................................................... 1427 14.20 Querying VoIP Resources.....................................................................................................................................1431 14.20.1 Querying a VoIP PSTN User (LST-VOIPPSTNUSER).................................................................................... 1431 14.20.2 Querying the List of Configured VoIP PSTN Users (LST-VOIPPOTSBASIC)............................................... 1455 14.20.3 Querying the Performance Data of a VoIP PSTN Port (LST-VOIPPSTNPERF)............................................. 1463 14.20.4 Querying the Extended Telephone Numbers of a VoIP PSTN Port (LST-VOIPPSTNEXTTELNO)...............1466 14.20.5 Querying the User Name and Password of a VoIP PSTN Port (LST-VOIPPSTNACCOUNT)....................... 1469 14.20.6 Querying Members of an CLI Account Group (LST-CGMEMBER)............................................................... 1472 14.20.7 Querying CLI Account Groups (LST-CLIGROUP)..........................................................................................1474 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xiii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
14.20.8 Querying Service Rights and Service Data of VoIP PSTN Users (LST-VOIPPSTNSRV)............................... 1476 14.20.9 Querying a VoIP ISDN BRA User (LST-VOIPBRAUSER).............................................................................1488 14.20.10 Querying the List of Configured VoIP ISDN BRA Users (LST-VOIPBRABASIC)......................................1502 14.20.11 Querying Authentication Information About a VoIP ISDN BRA Port (LST-VOIPBRAACCOUNT)...........1507 14.20.12 Querying Service Rights of a VoIP ISDN BRA Port (LST-VOIPBRASRV)..................................................1510 14.20.13 Querying the Extended Phone Number of a VoIP ISDN BRA Port (LST-VOIPBRAEXTTELNO)..............1517 14.20.14 Querying a VoIP ISDN PRA User (LST-VOIPPRAUSER)............................................................................1519 14.20.15 Querying the List of Configured VoIP ISDN PRA Users (LST-VOIPPRABASIC).......................................1532 14.20.16 Querying Authentication Information About a VoIP ISDN PRA Port (LST-VOIPPRAACCOUNT)............1537 14.20.17 Querying Service Rights of VoIP ISDN PRA Ports (LST-VOIPPRASRV)....................................................1540 14.20.18 Querying the Extended Phone Number of a VoIP ISDN PRA Port (LST-VOIPPRAEXTTELNO).............. 1544 14.20.19 Querying the VBD Parameter of Voice Ports (LST-VOIPVBD).................................................................... 1547 14.20.20 Querying SIP User Groups (LST-USERGROUP)...........................................................................................1550 14.20.21 Querying an MGC Global Profile (LST-MGCD)............................................................................................1554 14.20.22 Querying a VAG (LST-VAG).......................................................................................................................... 1556 14.20.23 Querying the MGCD Associated with a VAG (LST-MGCDOFVAG)............................................................1561 14.20.24 Querying a VSG (LST-VSG)...........................................................................................................................1563 14.20.25 Querying an Association (LST-ASSOCIATION)............................................................................................1566 14.20.26 Querying the Hunting Group List (LST-HUNTINGGROU).......................................................................... 1569 14.20.27 Querying the Hunting Group Member List (LST-HGMEMBER).................................................................. 1572 14.20.28 Querying the Group Account List (LST-GROUPNUMBER).........................................................................1575 14.20.29 Querying Service Rights and Service Data for Group Accounts (LST-GROUPNUMBERSRV)...................1578 14.20.30 Querying Authentication Information for Group Accounts (LST-GROUPNUMBERAUTH).......................1582 14.20.31 Querying Call Release Cause Codes in a Hunting Group (LST-HUNTINGSTOPCAUSECODE)............... 1585 14.20.32 Querying a Global Number Change Profile (LST-NUMCHGPROFILE).......................................................1587 14.20.33 Querying the VBD Parameter of Voice Ports (LST-VOIPVBD).................................................................... 1590 14.20.34 Querying Physical Information Corresponding to Telephone Numbers (LST-TELNUMLOCATIONINFO)1593 14.21 Querying SPC Resources......................................................................................................................................1596 14.21.1 Querying the List of SPCs (LST-SPC).............................................................................................................. 1596 14.21.2 Querying the Details of an SPC (DTL-SPC).....................................................................................................1602 14.22 Querying SPCM Resources.................................................................................................................................. 1610 14.22.1 Querying an SPCM User (LST-SPCMUSER)...................................................................................................1611 14.23 Querying ACL and QoS Resources......................................................................................................................1615 14.23.1 Querying ACL Groups (LST-ACLGRP)...........................................................................................................1615 14.23.2 Querying the Subitems of an Extended ACL Group (LST-ACLEXTSUBITEM)............................................1618 14.23.3 Querying the Subitems of a Standard ACL Group (LST-ACLBASESUBITEM)............................................ 1624 14.23.4 Querying the Subitems of a Layer 2 ACL Group (LST-ACLLINKSUBITEM)...............................................1627 14.23.5 Querying Port Rate Limit (LST-QOSRATELIMIT)......................................................................................... 1630 14.23.6 Querying a Traffic Limit on a Port (LST-QOSTRAFFICLIMIT).....................................................................1635 14.24 Querying HQoS Resources...................................................................................................................................1639 14.24.1 Querying the Information About a Port VLAN CAR(LST-HQOS)..................................................................1639
15 Service Provisioning............................................................................................................. 1643 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xiv
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.1 ADSL Service Provisioning................................................................................................................................... 1645 15.1.1 Creating an ADSL Line Profile (CRT-ADSLLINEPROFILE)........................................................................... 1645 15.1.2 Deleting an ADSL Line Profile (DEL-ADSLLINEPROFILE).......................................................................... 1656 15.1.3 Deleting an ADSL Line Profile from a Device (DEL-ADSLLPOFDEV).......................................................... 1658 15.1.4 Creating an ADSL Alarm Profile (CRT-ADSLALARMPROFILE)...................................................................1660 15.1.5 Deleting an ADSL Alarm Profile (DEL-ADSLALARMPROFILE).................................................................. 1662 15.1.6 Deleting an ADSL Alarm Profile from a Device (DEL-ADSLAPOFDEV).......................................................1664 15.1.7 Creating an ADSL Extended Profile (CRT-ADSLEXTENDPROFILE)............................................................ 1666 15.1.8 Deleting an ADSL Extended Profile (DEL-ADSLEXTENDPROFILE)............................................................1672 15.1.9 Deleting an ADSL Extended Profile from a Device (DEL-ADSLEPOFDEV).................................................. 1674 15.1.10 Activating an ADSL Port (ACT-ADSLPORT)................................................................................................. 1676 15.1.11 Deactivating an ADSL Port (DACT-ADSLPORT)........................................................................................... 1678 15.1.12 Modifying the Attributes of an ADSL Port (MOD-ADSLPORT).................................................................... 1680 15.1.13 Modifying the Attributes of an ADSL Port Through the Enhanced Command (MOD-ADSLPORTEX)........1688 15.1.14 Modifying the Working Mode of an ADSL Port (MOD-ADSLWORKMODE).............................................. 1704 15.1.15 Blocking an ADSL Port (BLK-ADSLPORT)................................................................................................... 1705 15.1.16 Unblocking an ADSL Port (UBLK-ADSLPORT)............................................................................................ 1707 15.1.17 Modifying the VLAN ID of an ADSL Port (MOD-DSLPORTVLAN)............................................................1709 15.1.18 Modifying the Alias of an ADSL Port (MOD-PORTNAME)...........................................................................1712 15.1.19 Initializing an ADSL Port (INIT-ADSLPORT).................................................................................................1714 15.2 G.SHDSL Service Provisioning............................................................................................................................. 1716 15.2.1 Creating an SHDSL Line Profile (CRT-SHDSLSPANPROFILE)......................................................................1716 15.2.2 Deleting an SHDSL Line Profile (DEL-SHDSLSPANPROFILE)..................................................................... 1724 15.2.3 Deleting an SHDSL Line Profile from a Device (DEL-SHDSLSPONDEV)..................................................... 1726 15.2.4 Creating an SHDSL Alarm Profile (CRT-SHDSLALARMPROFILE).............................................................. 1728 15.2.5 Deleting an SHDSL Alarm Profile (DEL-SHDSLALARMPROFILE)..............................................................1730 15.2.6 Deleting an SHDSL Alarm Profile from a Device (DEL-SHDSLALONDEV)................................................. 1732 15.2.7 Activating an SHDSL Port (ACT-SHDSLPORT)............................................................................................... 1734 15.2.8 Deactivating an SHDSL Port (DACT-SHDSLPORT).........................................................................................1736 15.2.9 Binding SHDSL Ports (BND-SHDSLPORT)..................................................................................................... 1738 15.2.10 Unbinding SHDSL Ports (UBND-SHDSLPORT)............................................................................................ 1740 15.2.11 Modifying the Attributes of an SHDSL Port (MOD-SHDSLPORT)................................................................ 1742 15.2.12 Performing a Loopback on an SHDSL Port (LOOPBACK-SHDSLPORT)..................................................... 1747 15.2.13 Canceling a Loopback Test on an SHDSL Port (ULOOPBACK-SHDSLPORT)............................................ 1750 15.2.14 Configuring the Chipset Mode of a Board (CFG-SHDSLBOARDCHIPSETMODE)..................................... 1752 15.2.15 Modifying the FE1 Attribute of a TDM SHDSL Port (MOD-SHDSLPORTFE1)........................................... 1754 15.3 VDSL2 Service Provisioning................................................................................................................................. 1756 15.3.1 Activating a VDSL2 Port (ACT-VDSL2PORT)................................................................................................. 1756 15.3.2 Deactivating a VDSL2 Port (DACT-VDSL2PORT)........................................................................................... 1759 15.3.3 Modifying the Attributes of a VDSL2 Port (MOD-VDSL2PORT).................................................................... 1762 15.3.4 Modifying the Attributes of a VDSL2 Port Through the Enhanced Command (MOD-VDSL2PORTEX)........1767 15.3.5 Activating a GPON ONT VDSL2 Port (ACT-ONTVDSL2PORT).................................................................... 1784 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xv
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.3.6 Deactivating a GPON ONT VDSL2 Port (DACT-ONTVDSL2PORT)..............................................................1788 15.3.7 Modifying the Attributes of a GPON ONT VDSL2 Port (MOD-ONTVDSL2PORT)....................................... 1792 15.3.8 Modifying the Attributes of a GPON ONT VDSL2 Port Through the Enhanced Command(MODONTVDSL2PORTEX)................................................................................................................................................... 1796 15.4 G.fast Service Provisioning.................................................................................................................................... 1803 15.4.1 Activating a G.fast Port (ACT-GFASTPORT).................................................................................................... 1803 15.4.2 Deactivating a G.fast Port (DACT-GFASTPORT)..............................................................................................1805 15.4.3 Modifying the Attributes of a G.fast Port (MOD-GFASTPORT)....................................................................... 1807 15.4.4 Binding a G.fast TDD Profile (MOD-GFASTPROFILE)...................................................................................1812 15.5 Bonding Group Management................................................................................................................................. 1813 15.5.1 Adding a Bonding Group (ENT-BONDGRP)..................................................................................................... 1813 15.5.2 Modifying the Attributes of a Bonding Group (ED-BONDGRP).......................................................................1817 15.5.3 Deleting a Bonding Group (DLT-BONDGRP)....................................................................................................1821 15.5.4 Activating a Bonding Group (ACT-BONDGRP)................................................................................................1823 15.5.5 Deactivating a Bonding Group (DACT-BONDGRP)......................................................................................... 1825 15.5.6 Associating Ports with a Bonding Group (ASS-BONDGRP).............................................................................1828 15.5.7 Disassociating Ports from a Bonding Group (DASS-BONDGRP).....................................................................1830 15.6 Video Service Provisioning.................................................................................................................................... 1833 15.6.1 Provisioning the Multicast Service (JOIN-NTVUSR/JOIN-NTV).....................................................................1833 15.6.2 Modifying the Attributes of a Multicast User (MOD-NTVUSR/MOD-NTVPORT)......................................... 1853 15.6.3 Stopping the Multicast Service (QUIT-NTV)..................................................................................................... 1868 15.6.4 Suspending the Multicast Service (BLK-NTVPORT)........................................................................................ 1879 15.6.5 Re-provisioning the Multicast Service (UBLK-NTVPORT).............................................................................. 1888 15.6.6 Adding Rights Profiles for a Multicast User (BND-NTVUSRRP/BND-NTVRP)............................................. 1896 15.6.7 Deleting Rights Profiles of a Multicast User (UBND-NTVUSRRP/UBND-NTVRP).......................................1905 15.6.8 Adding a Program Profile to a Device (ADD-NTVPROGRAM)....................................................................... 1914 15.6.9 Deleting a Program Profile from a Device (DEL-NTVPROGRAM)................................................................. 1920 15.6.10 Binding or Unbinding Rights Profiles on Schedule (BND-NTVUSRRP-SCHEDULE)..................................1923 15.6.11 Binding Rights Profiles with an NE (BND-NTVALLUSRRP).........................................................................1932 15.6.12 Unbinding Rights Profiles from an NE (UBND-NTVALLUSRRP).................................................................1935 15.6.13 Adding a Multicast VLAN (ADD-IGMPVLAN)............................................................................................. 1938 15.6.14 Deleting a Multicast VLAN (DEL-IGMPVLAN).............................................................................................1943 15.6.15 Adding a Multicast Subtend Port (ADD-NTVCASCADE).............................................................................. 1946 15.6.16 Deleting a Multicast Subtend Port (DEL-NTVCASCADE)............................................................................. 1951 15.6.17 Adding a Virtual Upstream Port of a Multicast VLAN (ADD-IGMPUPLINKPORT).....................................1954 15.6.18 Deleting a Virtual Upstream Port of a Multicast VLAN (DEL-IGMPUPLINKPORT)....................................1957 15.7 GPON Service Provisioning................................................................................................................................... 1960 15.7.1 Adding an ONU (ADD-ONT)............................................................................................................................. 1960 15.7.2 Modifying an ONU (MOD-ONT)....................................................................................................................... 1978 15.7.3 Deleting an ONT (DEL-ONT)............................................................................................................................ 1994 15.7.4 Activating an ONT (ACT-ONT)..........................................................................................................................1999 15.7.5 Deactivating an ONT (DACT-ONT)................................................................................................................... 2003 15.7.6 Resetting an ONT (RESET-ONT)....................................................................................................................... 2006 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xvi
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.7.7 Binding a DBA Profile to an ONT (BIND-ONTDBAPROF).............................................................................2011 15.7.8 Modifying the DBA Profile Bound to an ONT (MOD-ONTDBAPROF).......................................................... 2015 15.7.9 Unbinding a DBA Profile from an ONT (DBIND-ONTDBAPROF)................................................................. 2019 15.7.10 Adding a User VLAN for an ONT (ADD-ONTPORTVLAN)......................................................................... 2023 15.7.11 Deleting a User VLAN from an ONT (DEL-ONTPORTVLAN)..................................................................... 2027 15.7.12 Binding an ONT Port to a User VLAN (BIND-ONTPORTVLAN)................................................................. 2032 15.7.13 Unbinding an ONT Port from a User VLAN (DBIND-ONTPORTVLAN)..................................................... 2036 15.7.14 Adding a Binding Group for Ethernet Ports on a GPON ONT (ADD-ONTPORTBUNDLE)......................... 2040 15.7.15 Deleting a Binding Group of Ethernet Ports on a GPON ONT (DEL-ONTPORTBUNDLE)......................... 2044 15.7.16 Adding a VLAN Switching Pair for an Ethernet Port on a GPON ONT (ADD-ONTETHVLANSWTICHPAIR) ........................................................................................................................................................................................ 2047 15.7.17 Deleting a VLAN Switching Pair from an Ethernet Port on a GPON ONT (DELONTETHVLANSWTICHPAIR)....................................................................................................................................2053 15.7.18 Resetting the Function for Enabling the Discovery of the ONT SN (RESET-ONTSNSWITCH)....................2058 15.7.19 Adding a GEM Port (ADD-GEMPORT).......................................................................................................... 2061 15.7.20 Modifying a GEM Port (MOD-GEMPORT).....................................................................................................2065 15.7.21 Deleting a GEM Port (DEL-GEMPORT)..........................................................................................................2069 15.7.22 Binding a GEM Port to an ONT (BIND-ONTGEMPORT).............................................................................. 2071 15.7.23 Unbinding a GEM Port from an ONT (DBIND-ONTGEMPORT).................................................................. 2074 15.7.24 Adding a GEM Connection (ADD-GEMCONNECTION)...............................................................................2077 15.7.25 Modifying a GEM Connection (MOD-GEMCONNECTION).........................................................................2083 15.7.26 Deleting a GEM Connection (DEL-GEMCONNECTION)..............................................................................2088 15.7.27 Modifying the User Port of an ONT (MOD-ONTPORT)................................................................................. 2092 15.7.28 Configuring a Customized VAS of a GPON Terminal (CFG-ONTVAINDIV)................................................ 2100 15.7.29 Configuring the GPON FTTH Service (CFG-ONTSVC)................................................................................. 2118 15.7.30 Configuring the GPON FTTB Service (CFG-PORTSVC)................................................................................2127 15.7.31 Adding the CoS for a GEM Port (ADD-GEMPORTCOS)............................................................................... 2134 15.7.32 Deleting the CoS of a GEM Port (DEL-GEMPORTCOS)................................................................................2138 15.7.33 Adding the IP Configuration to an ONT (ADD-ONTIPCONFIG)................................................................... 2142 15.7.34 Configuring ONT Voice Users (CFG-ONT-POTS)...........................................................................................2146 15.7.35 Deleting ONT Voice Services (DLT-ONT-POTS).............................................................................................2155 15.7.36 Replacing a GPON ONU (REPLACE-ONT)....................................................................................................2158 15.7.37 Deleting a GPON MDU Replacement Task (DEL-ONTRM)...........................................................................2163 15.7.38 Canceling an MDU Replacement Task (CANCEL-ONTRM).......................................................................... 2169 15.7.39 Configuring the WAN Port VLAN of an ONT (CFG-ONTVLAN)................................................................. 2174 15.7.40 Configuring the TR-069 Management Channel for a GPON ONT (CFG-ACSSERVERINFO)......................2177 15.7.41 Changing the Password for Logging In to the Local ONT Web Page (SET-ONTUSERINFO)....................... 2182 15.7.42 Creating a Global GPON Line Profile(ADD-GLOBALGPONLINEPROFILE)..............................................2187 15.7.43 Deleting a Global GPON Line Profile(DEL-GLOBALGPONLINEPROFILE).............................................. 2189 15.7.44 Creating a Global GPON Service Profile (ADD-GLOBALGPONSRVPROFILE)..........................................2191 15.7.45 Deleting a Global GPON Service Profile (DEL-GLOBALGPONSRVPROFILE).......................................... 2194 15.7.46 Creating a Global GPON DBA Profile (ADD-GLOBALDBAPROFILE)....................................................... 2196 15.7.47 Deleting a Global GPON DBA Profile (DEL-GLOBALDBAPROFILE)........................................................ 2199 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xvii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.7.48 Add the ONT WLAN (ADD-ONTUSERWLAN)............................................................................................ 2200 15.7.49 Configuring the ONT WLAN (CFG-ONTUSERWLAN).................................................................................2205 15.7.50 Delete the ONT WLAN Information (DEL-ONTUSERWLAN)......................................................................2211 15.8 EPON Service Provisioning................................................................................................................................... 2214 15.8.1 Adding an EPON ONT (ADD-EPONONT)....................................................................................................... 2214 15.8.2 Modifying an EPON ONT (MOD-EPONONT)..................................................................................................2230 15.8.3 Modifying an EPON ONT Port (MOD-EPONONTPORT)................................................................................ 2241 15.8.4 Deleting an EPON ONT (DEL-EPONONT).......................................................................................................2246 15.8.5 Activating an EPON ONT (ACT-EPONONT)....................................................................................................2250 15.8.6 Deactivating an EPON ONT (DACT-EPONONT)............................................................................................. 2254 15.8.7 Resetting an EPON ONT (RESET-EPONONT)................................................................................................. 2258 15.8.8 Configuring a Customized VAS of an EPON Terminal (CFG-ONTVAINDIV).................................................2261 15.8.9 Configuring the EPON FTTB Service (CFG-PORTSVC).................................................................................. 2278 15.8.10 Adding CoS for Rate Limitation of an EPON ONT (ADD-ONTCOS)............................................................ 2284 15.8.11 Deleting CoS for Rate Limitation of an EPON ONT (DEL-ONTCOS)........................................................... 2288 15.8.12 Configuration for Querying User-Defined ONT Parameters (SYN-ONTXML).............................................. 2291 15.8.13 Configuring the WAN Port VLAN of an ONT (CFG-ONTVLAN)................................................................. 2293 15.8.14 Configuring the TR-069 Management Channel for an EPON ONT (CFG-EPONACSSERVERINFO)..........2296 15.8.15 Changing the Password for Logging In to the Local ONT Web Page (SET-ONTUSERINFO)....................... 2301 15.8.16 Add the ONT WLAN (ADD-ONTUSERWLAN)............................................................................................ 2305 15.8.17 Configuring the ONT WLAN (CFG-ONTUSERWLAN).................................................................................2310 15.8.18 Delete the ONT WLAN Information (DEL-ONTUSERWLAN)......................................................................2316 15.9 CNU Service Provisioning..................................................................................................................................... 2319 15.9.1 Adding a CNU (ADD-CNU)............................................................................................................................... 2319 15.9.2 Modifying a CNU (MOD-CNU)......................................................................................................................... 2323 15.9.3 Activating a CNU (ACT-CNU)........................................................................................................................... 2326 15.9.4 Deactivating a CNU (DACT-CNU).....................................................................................................................2329 15.9.5 Resetting a CNU (RESET-CNU).........................................................................................................................2332 15.9.6 Deleting a CNU (DEL-CNU).............................................................................................................................. 2334 15.9.7 Modifying a UNI Port on a CNU (MOD-CNUPORT)........................................................................................2337 15.9.8 Configuring a CBAT UNI Port (CFG-CBATUNI)..............................................................................................2340 15.10 CM Service Provisioning......................................................................................................................................2343 15.10.1 Resetting or Deleting a CM (REBOOT-CM).................................................................................................... 2343 15.10.2 Starting a CMC Upstream Frequency Scan (START-CMC-FFT).....................................................................2345 15.10.3 Stopping a CMC Upstream Frequency Scan (STOP-CMC-FFT)..................................................................... 2348 15.10.4 Querying CMC Upstream Frequency Scan Data (LST-CMC-FFT)..................................................................2350 15.10.5 Creating a PNM Performance Monitoring Task (CRE-PNM-TSK)..................................................................2354 15.10.6 Deleting a PNM Performance Monitoring Task (DEL-PNM-TSK)..................................................................2360 15.10.7 Modifying a PNM Performance Monitoring Task (MOD-PNM-TSK).............................................................2362 15.11 VLAN Service Management................................................................................................................................ 2366 15.11.1 Adding a VLAN (ADD-VLAN)........................................................................................................................2367 15.11.2 Deleting a VLAN (DEL-VLAN).......................................................................................................................2374 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xviii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.11.3 Modifying a VLAN (MOD-VLAN).................................................................................................................. 2379 15.11.4 Associating an Ethernet Port with a VLAN (ASS-ETHPORTANDVLAN)..................................................... 2386 15.11.5 Disassociating an Ethernet Port from a VLAN (DASS-ETHPORTANDVLAN)............................................. 2391 15.11.6 Setting the VLAN That Is Allowed to Pass Through a Trunk Port (CFG-VLANTRUNKPORT)................... 2395 15.11.7 Adding an IP Interface (ADD-IPINTERFACE)................................................................................................ 2397 15.11.8 Deleting an IP Interface (DEL-IPINTERFACE)............................................................................................... 2401 15.11.9 Adding an L3 Interface (ADD-VLANL3IF)..................................................................................................... 2403 15.11.10 Deleting an L3 Interface (DEL-VLANL3IF).................................................................................................. 2408 15.11.11 Activating an L3 Interface (ACT-VLANL3IF)................................................................................................2412 15.11.12 Deactivating an L3 Interface (DACT-VLANL3IF)......................................................................................... 2415 15.12 Ethernet Service Provisioning.............................................................................................................................. 2418 15.12.1 Configuring an Ethernet Port (MOD-ETHPORT).............................................................................................2418 15.12.2 Configuring the LACP Priority of an Ethernet Port (MOD-PORTLACP)........................................................2426 15.12.3 Activating an Ethernet Port (ACT-ETHPORT)................................................................................................. 2429 15.12.4 Deactivating an Ethernet Port (DACT-ETHPORT)...........................................................................................2434 15.12.5 Adding an Ethernet Aggregation Group (ADD-LAG)......................................................................................2438 15.12.6 Modifying an Ethernet Aggregation Group (MOD-LAG)................................................................................ 2445 15.12.7 Deleting an Ethernet Aggregation Group (DEL-LAG)..................................................................................... 2452 15.12.8 Associating Ports with an Ethernet Aggregation Group (ASS-LAG)............................................................... 2455 15.12.9 Disassociating Ports from an Ethernet Aggregation Group (DASS-LAG)....................................................... 2461 15.13 Service Virtual Port Provisioning......................................................................................................................... 2465 15.13.1 Modifying a Service Virtual Port (MOD-SERVICEPORT).............................................................................. 2465 15.13.2 Adding a Service Virtual Port (CRT-SERVICEPORT)..................................................................................... 2485 15.13.3 Deleting a Service Virtual Port (DEL-SERVICEPORT)...................................................................................2510 15.13.4 Binding an xDSL Channel to a Service Virtual Port (BIND-CHANNEL)....................................................... 2524 15.13.5 Activating a Service Virtual Port (ACT-SERVICEPORT)................................................................................2529 15.13.6 Deactivating a Service Virtual Port (DACT-SERVICEPORT)......................................................................... 2542 15.13.7 Adding a Static IP Address to a Service Virtual Port (ADD-IP2SERVICEPORT)...........................................2556 15.13.8 Deleting the Static IP Address of a Service Virtual Port (DEL-IP2SERVICEPORT)...................................... 2567 15.13.9 Adding a CAR Group for Service Virtual Ports (ADD-CARGROUP).............................................................2579 15.13.10 Modifying a CAR Group for Service Virtual Ports (MOD-CARGROUP).....................................................2582 15.13.11 Adding a Member to a CAR Group (ADD-CARGROUPMEMBER)............................................................ 2584 15.13.12 Deleting a Member from a CAR Group (DEL-CARGROUPMEMBER)...................................................... 2594 15.13.13 Deleting a CAR Group for Service Virtual Ports (DEL-CARGROUP)..........................................................2604 15.13.14 Adding a Bundle for Service Virtual Ports (ADD-SERVICEPORTBUNDLE)..............................................2606 15.13.15 Deleting a Bundle of Service Virtual Ports (DEL-SERVICEPORTBUNDLE).............................................. 2609 15.13.16 Adding a MAC Address to a Service Virtual Port (ADD-MAC2SERVICEPORT)........................................2611 15.13.17 Deleting the MAC Address of a Service Virtual Port (DEL-MAC2SERVICEPORT)................................... 2622 15.13.18 Config a 802.1x to a Service Virtual Port (CFG-DOT1X2SERVICEPORT)..................................................2633 15.14 PVC Service Provisioning.................................................................................................................................... 2644 15.14.1 Creating an ADSL-ATM PVC (CRT-ADSLATMPVC)....................................................................................2644 15.14.2 Creating an ADSL-LAN PVC (CRT-ADSLLANPVC).................................................................................... 2649 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xix
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.14.3 Creating an ADSL-CES PVC (CRT-ADSLCESPVC)...................................................................................... 2658 15.14.4 Creating an ATM-ATM PVC (CRT-ATMATMPVC)........................................................................................2663 15.14.5 Deleting a PVC (DEL-PVC)............................................................................................................................. 2667 15.14.6 Creating a PVC (CRT-PVC).............................................................................................................................. 2672 15.14.7 Modifying a PVC (MOD-PVC)........................................................................................................................ 2677 15.14.8 Setting the Anti-DoS Attack Parameters (MOD-ANTIDOS)........................................................................... 2683 15.14.9 Activating a PVC (ACT-PVC).......................................................................................................................... 2686 15.14.10 Deactivating a PVC (DACT-PVC).................................................................................................................. 2689 15.14.11 Switching the Multi-PVC Service Mode of an ADSL Port (CHG-PVCMD)................................................. 2693 15.15 TDM E1 Service Provisioning............................................................................................................................. 2694 15.15.1 Creating a Local TDM E1 Connection (CRT-NATIVETDMCONN)............................................................... 2695 15.15.2 Deleting a Local TDM E1 Connection (DEL-NATIVETDMCONN).............................................................. 2700 15.15.3 Modifying the Attribute of a PRI E1 Port (MOD-PRIE1)................................................................................ 2704 15.16 Traffic Profile Management..................................................................................................................................2708 15.16.1 Creating an ATM Traffic Profile (CRT-TRAFFICPROFILE)...........................................................................2709 15.16.2 Deleting an ATM Traffic Profile (DEL-TRAFFICPROFILE).......................................................................... 2713 15.16.3 Creating an IP Traffic Profile (CRT-IPTRAFFICPROFILE)............................................................................ 2715 15.16.4 Deleting an IP Traffic Profile (DEL-IPTRAFFICPROFILE)........................................................................... 2718 15.16.5 Creating an MEF IP Traffic Profile (CRT-MEFIPTRAFFICPROFILE)...........................................................2719 15.16.6 Deleting an MEF IP Traffic Profile (DEL-MEFIPTRAFFICPROFILE).......................................................... 2723 15.17 PSTN Service Provisioning.................................................................................................................................. 2725 15.17.1 Adding a V5 PSTN User (ADD-V5PSTNUSER).............................................................................................2726 15.17.2 Modifying a V5 PSTN User (MOD-V5PSTNUSER)....................................................................................... 2730 15.17.3 Deleting a V5 PSTN User (DEL-V5PSTNUSER)............................................................................................2734 15.17.4 Blocking a V5 PSTN Port (BLK-V5PSTNPORT)............................................................................................2736 15.17.5 Unblocking a V5 PSTN Port (UBK-V5PSTNPORT)....................................................................................... 2739 15.17.6 Resetting a V5 PSTN Port (RST-V5PSTNPORT)............................................................................................ 2741 15.17.7 Looping Back a V5 PSTN Port (LBK-V5PSTNPORT)....................................................................................2743 15.17.8 Canceling the Loopback on a V5 PSTN Port (CLB-V5PSTNPORT)...............................................................2745 15.18 ISDN Service Provisioning.................................................................................................................................. 2748 15.18.1 Adding a V5 ISDN BRA User (ADD-V5BRAUSER)..................................................................................... 2748 15.18.2 Modifying a V5 ISDN BRA User (MOD-V5BRAUSER)................................................................................2750 15.18.3 Deleting a V5 ISDN BRA User (DEL-V5BRAUSER).....................................................................................2753 15.18.4 Blocking a V5 ISDN BRA Port (BLK-V5BRAPORT).....................................................................................2755 15.18.5 Unblocking a V5 ISDN BRA Port (UBK-V5BRAPORT)................................................................................ 2758 15.18.6 Resetting a V5 ISDN BRA Port (RST-V5BRAPORT)..................................................................................... 2760 15.18.7 Looping Back a V5 ISDN BRA Port (LBK-V5BRAPORT)............................................................................ 2762 15.18.8 Canceling the Loopback on a V5 ISDN BRA Port (CLB-V5BRAPORT)....................................................... 2766 15.18.9 Adding a V5 ISDN PRA User (ADD-V5PRAUSER)...................................................................................... 2769 15.18.10 Modifying a V5 ISDN PRA User (MOD-V5PRAUSER)...............................................................................2771 15.18.11 Deleting a V5 ISDN PRA User (DEL-V5PRAUSER)....................................................................................2773 15.18.12 Blocking a V5 ISDN PRA Port (BLK-V5PRAPORT)................................................................................... 2775 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xx
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.18.13 Unblocking a V5 ISDN PRA Port (UBK-V5PRAPORT)...............................................................................2778 15.19 VoIP Service Provisioning....................................................................................................................................2780 15.19.1 Adding a VoIP PSTN User (ADD-VOIPPSTNUSER)..................................................................................... 2780 15.19.2 Modifying a VoIP PSTN User (MOD-VOIPPSTNUSER)............................................................................... 2804 15.19.3 Deleting a VoIP PSTN User (DEL-VOIPPSTNUSER).................................................................................... 2821 15.19.4 Enabling the VoIP PSTN Service (ACT-VOIPPSTNSERV).............................................................................2825 15.19.5 Configuring VoIP PSTN Service Rights and Service Data (CFG-VOIPPSTNSRV)........................................2829 15.19.6 Disabling a VoIP PSTN Service (DACT-VOIPPSTNSERV)............................................................................2839 15.19.7 Modifying a VoIP PSTN Port (MOD-VOIPPSTNPORT).................................................................................2844 15.19.8 Resetting a VoIP PSTN Port (RST-VOIPPSTNPORT)..................................................................................... 2846 15.19.9 Looping Back a VoIP PSTN Port (LBK-VOIPPSTNPORT)............................................................................ 2849 15.19.10 Canceling the Loopback on a VoIP PSTN Port (CLB-VOIPPSTNPORT)..................................................... 2852 15.19.11 Enabling the Automatic Gain of a VoIP PSTN Port (BAG-VOIPPSTNPORT)............................................. 2855 15.19.12 Configuring the Extended Telephone Number of a VoIP PSTN Port (CFG-VOIPPSTNEXTTELNO).........2858 15.19.13 Configuring the User Name and Password of a VoIP PSTN Port (CFG-VOIPPSTNACCOUNT)................2860 15.19.14 Adding a VoIP ISDN BRA User (ADD-VOIPBRAUSER)............................................................................ 2863 15.19.15 Modifying a VoIP ISDN BRA User (MOD-VOIPBRAUSER)...................................................................... 2875 15.19.16 Deleting a VoIP ISDN BRA User (DEL-VOIPBRAUSER)........................................................................... 2885 15.19.17 Enabling the VoIP ISDN BRA Service (ACT-VOIPBRASERV)................................................................... 2888 15.19.18 Configuring Service Rights for a VoIP ISDN BRA Port (CFG-VOIPBRASRV)...........................................2891 15.19.19 Configuring Authentication Information for VoIP ISDN BRA Ports (CFG-VOIPBRAACCOUNT)............2897 15.19.20 Disabling a VoIP ISDN BRA Service (DACT-VOIPBRASERV).................................................................. 2899 15.19.21 Resetting a VoIP ISDN BRA Port (RST-VOIPBRAPORT)............................................................................2903 15.19.22 Looping Back a VoIP ISDN BRA Port (LBK-VOIPBRAPORT)................................................................... 2905 15.19.23 Canceling the Loopback on a VoIP ISDN BRA Port (CLB-VOIPBRAPORT).............................................. 2909 15.19.24 Activating a VoIP ISDN BRA Port (ACT-VOIPBRAPORT)......................................................................... 2912 15.19.25 Deactivating a VoIP ISDN BRA Port (DACT-VOIPBRAPORT)...................................................................2915 15.19.26 Configuring the Extended Phone Number of a VoIP ISDN BRA Port (CFG-VOIPBRAEXTTELNO)........ 2917 15.19.27 Adding a VoIP ISDN PRA User (ADD-VOIPPRAUSER).............................................................................2919 15.19.28 Modifying a VoIP ISDN PRA User (MOD-VOIPPRAUSER)....................................................................... 2929 15.19.29 Deleting a VoIP ISDN PRA User (DEL-VOIPPRAUSER)............................................................................ 2940 15.19.30 Enabling the VoIP ISDN PRA Service (ACT-VOIPPRASERV).................................................................... 2942 15.19.31 Configuring Service Rights for a VoIP ISDN PRA Port (CFG-VOIPPRASRV)............................................2944 15.19.32 Configuring Authentication Information for VoIP ISDN PRA Accounts (CFG-VOIPPRAACCOUNT)......2947 15.19.33 Disabling the VoIP ISDN PRA Service (DACT-VOIPPRASERV)................................................................ 2950 15.19.34 Configuring the Extended Phone Number of a VoIP ISDN PRA Port (CFG-VOIPPRAEXTTELNO)......... 2953 15.19.35 Adding a SIP User Group (ADD-USERGROUP).......................................................................................... 2955 15.19.36 Modifying a SIP User Group (MOD-USERGROUP).....................................................................................2959 15.19.37 Deleting a SIP User Group (DEL-USERGROUP)..........................................................................................2962 15.19.38 Adding an MGC Global Profile (ADD-MGCD)............................................................................................. 2964 15.19.39 Deleting an MGC Global Profile (DEL-MGCD)............................................................................................ 2967 15.19.40 Adding a VAG (ADD-VAG)............................................................................................................................2968 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxi
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.19.41 Modifying a VAG (MOD-VAG)......................................................................................................................2983 15.19.42 Deleting a VAG (DEL-VAG)...........................................................................................................................2988 15.19.43 Activating a VAG (ACT-VAG)........................................................................................................................2991 15.19.44 Deactivating a VAG (DACT-VAG)................................................................................................................. 2994 15.19.45 Associating an MGCD with a VAG (ASS-MGCDANDVAG)....................................................................... 2997 15.19.46 Disassociating an MGCD from a VAG (DASS-MGCDANDVAG)............................................................... 3000 15.19.47 Binding a VAG to a TID Profile (MOD-VAGTIDPROFILE).........................................................................3002 15.19.48 Modifying the H.248 Profile Bound to the VAG (MOD-VAGH248PROFILE)............................................. 3005 15.19.49 Adding a VSG (ADD-VSG)............................................................................................................................3006 15.19.50 Deleting a VSG (DEL-VSG)........................................................................................................................... 3009 15.19.51 Creating an Association (ADD-ASSOCIATION)........................................................................................... 3010 15.19.52 Deleting an Association (DEL-ASSOCIATION)............................................................................................3012 15.19.53 Adding a Hunting Group (ADD-HUNTINGGROUP)....................................................................................3014 15.19.54 Modifying a Hunting Group (MOD-HUNTINGGROUP).............................................................................. 3017 15.19.55 Deleting a Hunting Group (DEL-HUNTINGGROUP)...................................................................................3020 15.19.56 Adding a Hunting Group Member (ADD-HGMEMBER)..............................................................................3022 15.19.57 Modifying a Hunting Group Member (MOD-HGMEMBER)........................................................................ 3025 15.19.58 Deleting a Hunting Group Member (DEL-HGMEMBER)............................................................................. 3028 15.19.59 Adding a Group Account (ADD-GROUPNUMBER).................................................................................... 3030 15.19.60 Modifying a Group Account (MOD-GROUPNUMBER)...............................................................................3033 15.19.61 Activating a Group Account (ACT-GROUPNUMBER).................................................................................3035 15.19.62 Deactivating a Group Account (DACT-GROUPNUMBER).......................................................................... 3036 15.19.63 Deleting a Group Account (DEL-GROUPNUMBER)................................................................................... 3038 15.19.64 Configuring Service Rights and Service Data for Group Accounts (CFG-GROUPNUMBERSRV)............. 3040 15.19.65 Configuring Authentication Information for Group Accounts (CFG-GROUPNUMBERAUTH)................. 3044 15.19.66 Adding an CLI Account Group (ADD-CLIGROUP)......................................................................................3046 15.19.67 Deleting an CLI Account Group (DEL-CLIGROUP).....................................................................................3048 15.19.68 Adding a Member to an CLI Account Group (ADD-CGMEMBER)............................................................. 3050 15.19.69 Deleting a Member from an CLI Account Group (DEL-CGMEMBER)........................................................3052 15.19.70 Adding a Call Release Cause Code to a Hunting Group(ADD-HUNTINGSTOPCAUSECODE)................ 3054 15.19.71 Deleting a Call Release Cause Code from a Hunting Group (DEL-HUNTINGSTOPCAUSECODE)..........3055 15.19.72 Creating a Global Number Change Profile (CRT-NUMCHGPROFILE)....................................................... 3057 15.19.73 Deleting a Global Number Change Profile (DEL-NUMCHGPROFILE).......................................................3060 15.19.74 Setting VBD Parameters of Voice Ports (CFG-VOIPVBD)............................................................................3061 15.20 SPC Service Provisioning.....................................................................................................................................3064 15.20.1 Adding an SPC (ADD-SPC)..............................................................................................................................3064 15.20.2 Modifying an SPC (MOD-SPC)........................................................................................................................3070 15.20.3 Deleting an SPC (DEL-SPC).............................................................................................................................3072 15.20.4 Setting Up an SPC (CON-SPC).........................................................................................................................3075 15.20.5 Releasing an SPC (DISCON-SPC)....................................................................................................................3078 15.21 SPCM Service Provisioning................................................................................................................................. 3081 15.21.1 Adding an SPCM User (ADD-SPCMUSER)....................................................................................................3081 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
15.21.2 Modifying an SPCM User (MOD-SPCMUSER).............................................................................................. 3084 15.21.3 Deleting an SPCM User (DEL-SPCMUSER)...................................................................................................3088 15.22 ACL and QoS Management................................................................................................................................. 3089 15.22.1 Adding an ACL Group (ADD-ACLGRP).........................................................................................................3090 15.22.2 Deleting an ACL Group (DEL-ACLGRP)........................................................................................................ 3093 15.22.3 Adding a Subitem to an Extended ACL Group (ADD-ACLEXTSUBITEM).................................................. 3096 15.22.4 Deleting a Subitem from an Extended ACL Group (DEL-ACLEXTSUBITEM)............................................ 3102 15.22.5 Activating the Subitem of an Extended ACL Group (ACT-ACLEXTSUBITEM)...........................................3104 15.22.6 Deactivating the Subitem of an Extended ACL Group (DACT-ACLEXTSUBITEM).................................... 3106 15.22.7 Adding the QoS Priority (ADD-QOSPRIORITY)............................................................................................ 3108 15.22.8 Deleting the QoS Priority (DEL-QOSPRIORITY)........................................................................................... 3113 15.22.9 Adding a Subitem to a Standard ACL Group (ADD-ACLBASESUBITEM)...................................................3116 15.22.10 Deleting the Subitem from a Standard ACL Group (DEL-ACLBASESUBITEM)........................................3119 15.22.11 Adding a Subitem to a Layer 2 ACL Group (ADD-ACLLINKSUBITEM)................................................... 3122 15.22.12 Deleting a Subitem from a Layer 2 ACL Group (DEL-ACLLINKSUBITEM)............................................. 3126 15.22.13 Setting a Traffic Limit on a Port (ADD-QOSTRAFFICLIMIT).....................................................................3128 15.22.14 Removing a Traffic Limit from a Port (DEL-QOSTRAFFICLIMIT)............................................................ 3132 15.22.15 Setting a Rate Limit on a Port (ADD-QOSRATELIMIT)...............................................................................3136 15.22.16 Removing a Rate Limit from a Port (DEL-QOSRATELIMIT)...................................................................... 3140 15.23 HQoS Management.............................................................................................................................................. 3143 15.23.1 Adding a Port VLAN CAR(CRT-HQOS)......................................................................................................... 3144 15.23.2 Modifying the Information About a Port VLAN CAR(MOD-HQOS)............................................................. 3146 15.23.3 Deleting a Port VLAN CAR(DEL-HQOS)....................................................................................................... 3148 15.23.4 Add One HQoS User(ADD-HQOSUSER)....................................................................................................... 3150 15.23.5 Modifying One HQoS User(MOD-HQOSUSER)............................................................................................ 3155 15.23.6 Querying the Information About a HQoS User(LST-HQOSUSER)................................................................. 3159 15.23.7 Deleting One HQoS User(DEL-HQOSUSER)................................................................................................. 3164 15.23.8 Add One Member to the HQoS User(ADD-HQOSUSERMEMBER)............................................................. 3168 15.23.9 Deleting Members from an HQoS User(DEL-HQOSUSERMEMBER).......................................................... 3177 15.23.10 Querying a Member of the HQoS User(LST-HQOSUSERMEMBER)..........................................................3186
16 Performing the Diagnostic Test.......................................................................................... 3197 16.1 OAM Loopback Test (START-ATMOAMBYPVC).............................................................................................. 3198 16.2 Searching Tone Test (TST-SEARCHINGTONE).................................................................................................. 3202 16.3 Capturing the Test Bus (TST-CONNECT)............................................................................................................. 3205 16.4 Releasing the Test Bus (TST-DISCEXT)............................................................................................................... 3206 16.5 Callee Emulation Test (TST-CALLEDAUTORESP).............................................................................................3208 16.6 Call Emulation Test (TST-CALLERAUTODIAL)................................................................................................ 3213 16.7 Loop Line Test (TST-OUTSIDE)........................................................................................................................... 3219 16.8 MELT Test (TST-XDSLMELT)............................................................................................................................. 3235 16.9 Circuit Line Test (TST-POTSCIRCUIT)................................................................................................................3242 16.10 Setting Up a Line Test Session (CONN-LPACC-MET)...................................................................................... 3247 16.11 Capturing Circuits or Loop Lines (CHG-SPLIT-LILO).......................................................................................3251 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxiii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
16.12 Releasing the Test Bus (DISC-TACC)................................................................................................................. 3253 16.13 Capturing the Test Bus (CHG-SPLIT)................................................................................................................. 3255 16.14 Monitoring the Test bus (CONN-MON).............................................................................................................. 3257 16.15 Monitoring the Test bus (CONN-TACC-MET)....................................................................................................3259 16.16 PPPoE Emulation Test (TST-ONTPPPOE)..........................................................................................................3261 16.17 ETH OAM............................................................................................................................................................ 3267 16.17.1 Adding an MD (ENT-ETHOAM-MD)..............................................................................................................3267 16.17.2 Deleting an MD (DLT-ETHOAM-MD)............................................................................................................ 3271 16.17.3 Querying an MD (RTRV-ETHOAM-MD)........................................................................................................ 3273 16.17.4 Adding an MA (ENT-ETHOAM-MA)..............................................................................................................3276 16.17.5 Modifying an MA (ED-ETHOAM-MA)...........................................................................................................3281 16.17.6 Deleting an MA (DLT-ETHOAM-MA)............................................................................................................ 3284 16.17.7 Querying an MA (RTRV-ETHOAM-MA)........................................................................................................ 3287 16.17.8 Adding an MEP (ENT-ETHOAM-MEP).......................................................................................................... 3291 16.17.9 Modifying an MEP (ED-ETHOAM-MEP)....................................................................................................... 3296 16.17.10 Deleting an MEP (DLT-ETHOAM-MEP).......................................................................................................3300 16.17.11 Querying an MEP (RTRV-ETHOAM-MEP)...................................................................................................3302 16.17.12 Enabling the Transmit of CC (Continuity Check) Packets (STA-ETHOAM-CCSEND)............................... 3308 16.17.13 Disabling the Transmit of CC Packets (STP-ETHOAM-CCSEND)...............................................................3310 16.17.14 Enabling the Receive of CC Packets (STA-ETHOAM-CCRECV)................................................................ 3313 16.17.15 Disabling the Receive of CC Packets (STP-ETHOAM-CCRECV)................................................................3315 16.17.16 Performing the Loopback Test (STA-ETHOAM-LB).....................................................................................3318 16.17.17 Querying the Bridge MAC Address of a Device (RTRV-ETHOAM-BRIDGEMAC)....................................3321
17 GPON FTTH Service Provision Example......................................................................... 3324 17.1 Overview of GPON FTTH Services.......................................................................................................................3324 17.2 GPON FTTH Service Provisioning........................................................................................................................ 3327 17.3 GPON FTTH Service Planning.............................................................................................................................. 3328 17.4 GPON FTTH Service Deployment.........................................................................................................................3334 17.5 GPON FTTH Service Provisioning Guide............................................................................................................. 3337 17.5.1 Preparing for GPON FTTH Service Provisioning...............................................................................................3337 17.5.2 Logging In to the U2000..................................................................................................................................... 3338 17.5.3 Internet Access Service....................................................................................................................................... 3338 17.5.3.1 Process of Managing an Internet Access Service............................................................................................. 3339 17.5.3.2 Internet Access Service Data Planning.............................................................................................................3344 17.5.3.3 Preconfiguring an Internet Access Service.......................................................................................................3347 17.5.3.4 Provisioning an Internet Access Service.......................................................................................................... 3349 17.5.3.5 Modifying Internet Access Service Parameters................................................................................................3352 17.5.3.6 Suspending an Internet Access Service............................................................................................................ 3352 17.5.3.7 Restoring an Internet Access Service............................................................................................................... 3353 17.5.3.8 Deleting an Internet Access Service................................................................................................................. 3353 17.5.3.9 Deregister an Internet Access User...................................................................................................................3354 17.5.3.10 Migrating an Internet Access Service.............................................................................................................3354 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxiv
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
17.5.4 IPTV Service....................................................................................................................................................... 3355 17.5.4.1 Process of Managing an IPTV Service.............................................................................................................3355 17.5.4.2 IPTV Service Data Planning.............................................................................................................................3361 17.5.4.3 Preconfiguring an IPTV Service.......................................................................................................................3364 17.5.4.4 Provisioning an IPTV Service.......................................................................................................................... 3367 17.5.4.5 Modifying IPTV Service Parameters............................................................................................................... 3370 17.5.4.6 Suspending an IPTV Service............................................................................................................................ 3371 17.5.4.7 Restoring an IPTV Service............................................................................................................................... 3371 17.5.4.8 Deleting an IPTV Service.................................................................................................................................3372 17.5.4.9 Deregistering an IPTV User............................................................................................................................. 3373 17.5.4.10 Migrating an IPTV Service.............................................................................................................................3373 17.5.5 VoIP Service........................................................................................................................................................ 3374 17.5.5.1 Process of Managing a VoIP Service................................................................................................................3374 17.5.5.2 VoIP Service Data Planning..............................................................................................................................3381 17.5.5.3 Preconfiguring a VoIP Service..........................................................................................................................3389 17.5.5.4 Provisioning a VoIP Service............................................................................................................................. 3395 17.5.5.5 Modifying VoIP Service Parameters................................................................................................................ 3399 17.5.5.6 Suspending a VoIP Service...............................................................................................................................3400 17.5.5.7 Restoring a VoIP Service.................................................................................................................................. 3401 17.5.5.8 Deleting a VoIP Service....................................................................................................................................3401 17.5.5.9 Deregistering a VoIP User................................................................................................................................ 3402 17.5.5.10 Migrating a VoIP Service................................................................................................................................3402 17.5.6 Logging Out of the U2000...................................................................................................................................3402
18 GPON FTTB/C Service Provision Example......................................................................3404 18.1 Overview of GPON FTTB/FTTC Services............................................................................................................ 3404 18.2 Overview of GPON FTTB/FTTC Service Provisioning........................................................................................ 3407 18.3 GPON FTTB/FTTC Service Planning................................................................................................................... 3408 18.4 GPON FTTB/FTTC Service Deployment.............................................................................................................. 3413 18.5 GPON FTTB/FTTC Service Provisioning............................................................................................................. 3414 18.5.1 Preparing for Service Provisioning......................................................................................................................3415 18.5.2 Logging In to the U2000..................................................................................................................................... 3415 18.5.3 Internet Access Service....................................................................................................................................... 3416 18.5.3.1 Process of Managing an Internet Access Service............................................................................................. 3416 18.5.3.2 Internet Access Service Data Planning.............................................................................................................3421 18.5.3.3 Preconfiguring an Internet Access Service.......................................................................................................3425 18.5.3.4 Provisioning an Internet Access Service.......................................................................................................... 3428 18.5.3.5 Modifying Internet Access Service Parameters................................................................................................3433 18.5.3.6 Suspending an Internet Access Service............................................................................................................ 3433 18.5.3.7 Restoring an Internet Access Service............................................................................................................... 3434 18.5.3.8 Deleting an Internet Access Service................................................................................................................. 3434 18.5.3.9 Deregistering an Internet Access Service User................................................................................................ 3435 18.5.3.10 Migrating an Internet Access Service.............................................................................................................3435 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxv
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
18.5.4 IPTV Service....................................................................................................................................................... 3436 18.5.4.1 Process of Managing an IPTV Service.............................................................................................................3436 18.5.4.2 IPTV Service Data Planning.............................................................................................................................3442 18.5.4.3 Preconfiguring an IPTV Service.......................................................................................................................3446 18.5.4.4 Provisioning an IPTV Service.......................................................................................................................... 3450 18.5.4.5 Modifying IPTV Service Parameters............................................................................................................... 3457 18.5.4.6 Suspending an IPTV Service............................................................................................................................ 3458 18.5.4.7 Restoring an IPTV Service............................................................................................................................... 3458 18.5.4.8 Deleting an IPTV Service.................................................................................................................................3459 18.5.4.9 Deregistering an IPTV User............................................................................................................................. 3460 18.5.4.10 Migrating an IPTV Service.............................................................................................................................3460 18.5.5 VoIP Service........................................................................................................................................................ 3460 18.5.5.1 Process of Managing a VoIP Service................................................................................................................3461 18.5.5.2 VoIP Service Data Planning..............................................................................................................................3465 18.5.5.3 Preconfiguring a VoIP Service..........................................................................................................................3469 18.5.5.4 Provisioning a VoIP Service............................................................................................................................. 3473 18.5.5.5 Modifying VoIP Service Parameters................................................................................................................ 3476 18.5.5.6 Suspending a VoIP Service...............................................................................................................................3477 18.5.5.7 Restoring a VoIP Service.................................................................................................................................. 3477 18.5.5.8 Deleting VoIP Services..................................................................................................................................... 3478 18.5.5.9 Migrating a VoIP Service..................................................................................................................................3478 18.5.6 Logging Out of the U2000...................................................................................................................................3479
19 DSLAM/MSAN Service Provision Example.................................................................... 3480 19.1 Overview of DSLAM/MSAN Services.................................................................................................................. 3481 19.2 DSLAM/MSAN Service Provisioning................................................................................................................... 3483 19.3 DSLAM/MSAN Service Plan................................................................................................................................ 3484 19.4 DSLAM/MSAN Service Deployment....................................................................................................................3488 19.5 DSLAM/MSAN Service Provisioning Guide........................................................................................................ 3489 19.5.1 Preparing for DSLAM/MSAN Services Provisioning........................................................................................ 3489 19.5.2 Logging In to the U2000..................................................................................................................................... 3490 19.5.3 Internet Access Service....................................................................................................................................... 3490 19.5.3.1 Process of Managing Internet Access Services................................................................................................ 3491 19.5.3.2 Data Plan for Internet Access Services.............................................................................................................3498 19.5.3.3 Preconfiguring an Internet Access Service.......................................................................................................3503 19.5.3.4 Provisioning an xDSL PPPoE Internet Access Service....................................................................................3506 19.5.3.5 Provisioning an xDSL PPPoA Internet Access Service................................................................................... 3509 19.5.3.6 Modifying Parameters for Internet Access Services........................................................................................ 3515 19.5.3.7 Suspending an Internet Access Service............................................................................................................ 3516 19.5.3.8 Restoring an Internet Access Service............................................................................................................... 3516 19.5.3.9 Deleting an Internet Access Service................................................................................................................. 3517 19.5.3.10 Deregistering an Internet Access Service User.............................................................................................. 3517 19.5.3.11 Migrating an Internet Access Service.............................................................................................................3518 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxvi
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
19.5.4 IPTV Services......................................................................................................................................................3518 19.5.4.1 Process of Managing an IPTV Service.............................................................................................................3518 19.5.4.2 Data Plan for IPTV Services............................................................................................................................ 3524 19.5.4.3 Preconfiguring an IPTV Service.......................................................................................................................3529 19.5.4.4 Provisioning an IPTV Service.......................................................................................................................... 3532 19.5.4.5 Modifying IPTV Service Parameters............................................................................................................... 3538 19.5.4.6 Suspending an IPTV Service............................................................................................................................ 3539 19.5.4.7 Restoring an IPTV Service............................................................................................................................... 3539 19.5.4.8 Deleting an IPTV Service.................................................................................................................................3540 19.5.4.9 Deregistering an IPTV Service User................................................................................................................ 3540 19.5.4.10 Migrating an IPTV Service.............................................................................................................................3541 19.5.5 VoIP Services.......................................................................................................................................................3541 19.5.5.1 Process of Managing VoIP Services................................................................................................................. 3542 19.5.5.2 Data Plan for VoIP Services............................................................................................................................. 3547 19.5.5.3 Preconfiguring a VoIP Service..........................................................................................................................3553 19.5.5.4 Provisioning a VoIP Service............................................................................................................................. 3557 19.5.5.5 Modifying VoIP Service Parameters................................................................................................................ 3558 19.5.5.6 Suspending a VoIP Service...............................................................................................................................3559 19.5.5.7 Restoring a VoIP Service.................................................................................................................................. 3559 19.5.5.8 Deregistering a VoIP User................................................................................................................................ 3560 19.5.5.9 Migrating a VoIP Service..................................................................................................................................3560 19.5.6 Triple Play Services............................................................................................................................................. 3561 19.5.6.1 Data Plan for Triple Play Services....................................................................................................................3562 19.5.6.2 Preconfiguring a Triple Play Service................................................................................................................3568 19.5.6.3 Provisioning a Triple Play Service................................................................................................................... 3572 19.5.7 Logging Out of the U2000...................................................................................................................................3576
20 List of Customized TL1 Commands.................................................................................. 3577 21 Troubleshooting Common Faults...................................................................................... 3599 21.1 Diagnosing a Failure to Issue TL1 Commands...................................................................................................... 3599 21.2 Failure for the OSS to Connect To the U2000........................................................................................................3603 21.3 No XML File Generated After TL1 Commands Are Run......................................................................................3605 21.4 Common Error Codes............................................................................................................................................. 3605 21.4.1 2686058516/2686058596.................................................................................................................................... 3606 21.4.2 2686058497/2686058499.................................................................................................................................... 3606 21.4.3 2686058508......................................................................................................................................................... 3606 21.4.4 2686058500......................................................................................................................................................... 3607 21.4.5 102690820/2689014791...................................................................................................................................... 3607 21.4.6 1615069195......................................................................................................................................................... 3607 21.4.7 1615462437......................................................................................................................................................... 3609 21.4.8 1610614842/1616445483/1616445484/1616445485.......................................................................................... 3610 21.4.9 2686058552......................................................................................................................................................... 3610 21.4.10 76546022........................................................................................................................................................... 3611 Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxvii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
21.4.11 76546023........................................................................................................................................................... 3613 21.4.12 1610612765....................................................................................................................................................... 3614 21.4.13 15658136501/2686058531................................................................................................................................ 3615 21.4.14 2689008176....................................................................................................................................................... 3616 21.4.15 1615069206....................................................................................................................................................... 3617 21.4.16 2686058603....................................................................................................................................................... 3617 21.4.17 2689023090....................................................................................................................................................... 3618 21.4.18 2689020327....................................................................................................................................................... 3618 21.4.19 2688880284....................................................................................................................................................... 3618 21.5 Collecting Fault Information.................................................................................................................................. 3619
22 FAQ.......................................................................................................................................... 3622 22.1 Session Connection.................................................................................................................................................3622 22.2 Interaction Between the OSS, U2000, and NE.......................................................................................................3623 22.3 User Control........................................................................................................................................................... 3624 22.4 Database Upgrade...................................................................................................................................................3624 22.5 TL1 Command Performance.................................................................................................................................. 3625 22.6 Identifying a Device by Using the Device Name Instead of the Device ID...........................................................3625 22.7 How to Locate a Device According to the IP Address...........................................................................................3625 22.8 Certain Port Status Defined Inconsistently in the TL1 Specifications and the Client............................................3626 22.9 Virtual Subslot........................................................................................................................................................ 3627 22.10 Global TL1 Character Encoding...........................................................................................................................3627 22.11 Recording TL1 User Logs.................................................................................................................................... 3628 22.12 How to Modify the Format of the Returned SN................................................................................................... 3629 22.13 How to Set the IP Address Listening Range........................................................................................................ 3631 22.14 Which Characters Are Supported by String-Type Parameters?........................................................................... 3631
23 Command Parameter Reference......................................................................................... 3633 23.1 Parameters Related to the Device Type.................................................................................................................. 3634 23.2 Parameters Related To the Board Type...................................................................................................................3636 23.3 Parameters Related To the Port Type......................................................................................................................3636 23.4 Parameters Related To the Port Status....................................................................................................................3645 23.5 Parameters Related To the ADSL Working Mode..................................................................................................3647 23.6 Mapping Between FTTH ONU Types and ASCII Codes...................................................................................... 3647 23.7 Mapping Between FTTO&FTTD ONU Types and ASCII Codes......................................................................... 3672 23.8 Mapping Between FTTH ONU Types and Function of Configuring the VAS...................................................... 3675 23.9 Mapping Between FTTO&FTTD ONU Types and Function of Configuring the VAS......................................... 3699 23.10 Parameters Related To the Range of VLAN IDs for Different Devices...............................................................3702 23.11 Parameters Related To the PVC Connection Type............................................................................................... 3703 23.12 Parameters Related To the Traffic Profile............................................................................................................ 3706 23.13 Parameters Related To the Voice Gain..................................................................................................................3711 23.14 Parameters Related To the Valid Values of Level.................................................................................................3712 23.15 TST-OUTSIDE Results........................................................................................................................................ 3712
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxviii
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Contents
24 Acronyms and Abbreviations............................................................................................. 3717
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
xxix
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
1 Change History
1
Change History
This topic lists the change history of the document. Updates between document issues are cumulative. Therefore, the latest document issue contains all updates made in previous issues.
Changes in Issue 01 (2018-03-05) Based on Product Version V200R017C60SPC200 The second commercial release has the following updates:
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
1
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
1 Change History
Topic
Section
Description
Cause and Impact
13.2.13 Notifying Plug and Play Deployment Completion
Output Parameters
The NOTE of Return HWTC for HUAWEI ONU is added for parameter VENDORID.
A clear description of the output of VENDORID is required.
13.3.1 Reporting Notifications on Initial Power-on of GPON ONUs 13.3.3 Notifying the Automatic Discovery of a GPON ONU 13.4.1 Reporting Notifications on Initial Power-on of EPON ONUs 14.8.4 Querying the List of ONUs (LSTONT) 14.8.5 Querying the Details of an ONT (LSTONTDETAIL) 14.9.2 Querying the List of EPON ONTs (LSTEPONONT)
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
2
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
1 Change History
Topic
Section
Description
Cause and Impact
14.8.7 Querying the Information About Auto-Discovered GPON ONUs (LSTGPONONTAUTO FIND)
Output Parameters
The NOTE of Return 2011 for HUAWEI ONU is added for parameter VENDORID.
A clear description of the output of VENDORID is required.
Input Parameters
Add 2011 in input parameter range of VENDORID.
A clear description of the input of VENDORID is required.
Add the usage note about the GPON_VENDORI D_AUTOFIND_S
The configuration item determines the format of VENDORID
14.8.23 Querying the ONT WAN Port Information (LST-ONTWAN) 14.8.24 Querying ONT SIP User Accounts (LSTONTSIPINFO) 14.9.3 Querying Information About Auto-discovered EPON ONUs (LSTEPONONTAUTOF IND) 14.9.7 Querying the EPON Information of an MDU Device (LSTEPONBYONUDE V) 14.8.24 Querying ONT SIP User Accounts (LSTONTSIPINFO) 15.7.1 Adding an ONU (ADD-ONT) 15.7.2 Modifying an ONU (MODONT) 15.8.1 Adding an EPON ONT (ADDEPONONT) 15.8.2 Modifying an EPON ONT (MOD-EPONONT) 8 Setting Configuration Items
Issue 01 (2018-03-05)
Table 8-1
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
3
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Topic
Section
14.8.7 Querying the Information About Auto-Discovered GPON ONUs (LSTGPONONTAUTO FIND) 15.19.5 Configuring VoIP PSTN Service Rights and Service Data (CFGVOIPPSTNSRV)
14.20.8 Querying Service Rights and Service Data of VoIP PSTN Users (LSTVOIPPSTNSRV)
1 Change History
Description
Cause and Impact
WITH configuration item. Usage Note
Command Format Input Parameters
Command Format Input Parameters
The parameters CUTOFFDIS, AUTOREPOL, DISPNAMEMOD E, FASTDISCNNT, HOTLINE, PERMAHOLD, and SCCCLASS are added.
You can set the permissions for automatic call setup, automatic polarity reverse, user alias display, fast call clearing, hotline services, permanent hold-over, and SCC.
The parameters CUTOFFDIS, AUTOREPOL, DISPNAMEMOD E, FASTDISCNNT, HOTLINE, PERMAHOLD, and SCCCLASS are added.
You can set the permissions for automatic call setup, automatic polarity reverse, user alias display, fast call clearing, hotline services, permanent hold-over, and SCC.
Changes in Issue 01 (2017-10-25) Based on Product Version V200R017C60 The first commercial release has following updates:
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
4
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
1 Change History
Topic
Sectio n
Description
Cause and Impact
14.9.8 Querying Optical Module Information About an EPON ONT (LSTEPONONTDDM DETAIL)
Comma nd Format
The parameter SHOWOPTI ON is added.
You can use the SHOWOPTION parameter to control the returned optical module type, optical module subtype, upper alarm threshold of the transmit optical power, lower alarm threshold of the transmit optical power, upper alarm threshold of the receive optical power, lower alarm threshold of the receive optical power, upper alarm threshold of the bias current, lower alarm threshold of the bias current, upper alarm threshold of the supply voltage, lower alarm threshold of the supply voltage, upper alarm threshold of the temperature, lower alarm threshold of the temperature.
The parameter SHOWOPTI ON is added.
You can use the SHOWOPTION parameter to control the returned the ONT port output power, the subtype of the ONT port.
The parameters ONTID, ONTSN, PWD, LOID and ONUPORT are added.
You can use the parameters to control the scene of ONT.
The parameters STATE, Conclusion, FailReason are added.
You can use the parameters to control the scene of ONT.
14.8.15 Querying the Parameters of the Optical Module of an ONT (LSTONTDDMDETAI L)
14.8.9 Querying the List of ONT Ports (LSTONTPORT)
Input Paramet er Respon se Format Respon se Format
Comma nd Format Input Paramet er Respon se Format Respon se Format
16.7 Loop Line Test (TSTOUTSIDE)
Comma nd Format Input Paramet er
16.5 Callee Emulation Test (TSTCALLEDAUTO RESP)
Issue 01 (2018-03-05)
Respon se Format Output Paramet er
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
5
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
1 Change History
Topic
Sectio n
Description
Cause and Impact
16.6 Call Emulation Test (TSTCALLERAUTO DIAL)
Input Paramet er
The value ONU is added for DIALSTYLE parameter.
You can use the parameters to control the scene of ONT.
16.16 PPPoE Emulation Test (TSTONTPPPOE)
ALL
This topic is added.
You can perform the PPPoE emulation test on ONUs.
8 Setting Configuration Items
Virtuali zation configu ration items
The ItemsBUFFE R_CHECK_I NTERVAL,B UFFER_EXC EED_ALAR M_THRESH OLD and BUFFER_EX CEED_CLEA R_THRESH OLD are added.
You can use the parameters to configure TL1 threshold alarm.
15.23.6 Querying the Information About a HQoS User(LSTHQOSUSER)
All
This topic is added.
You can query a HQoS User.
15.23.5 Modifying One HQoS User(MODHQOSUSER)
All
This topic is added.
You can modify a HQoS User.
15.23.4 Add One HQoS User(ADDHQOSUSER)
Comma nd Format
Command Format is changed.
HQoS extends to Ethernet port.
15.23.8 Add One Member to the HQoS User(ADDHQOSUSERME MBER)
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
6
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Topic
Sectio n
Description
Cause and Impact
8 Setting Configuration Items
Virtuali zation configu ration items
The ItemsXPON_ ONU_NAME _REPEAT_S WITCH are added.
ONU names can be repeated OLT-wide.
14.8.14 Querying the Details of GPON Optical Modules (LSTGPONSFP)
Output Paramet er
The value are added for the TYPE parameter.
You can use the parameters to control the scene of optical module.
23.6 Mapping Between FTTH ONU Types and ASCII Codes
Mappin g Betwee n FTTH ONU Types and ASCII Codes
The new ONU type HG8042, HG8043, HG8247U is added.
To support HG8042, HG8043, HG8247U as an ONU type.
The new ONU type HG8122 is added.
To support HG8122 as an ONU type.
23.8 Mapping Between FTTH ONU Types and Function of Configuring the VAS
Issue 01 (2018-03-05)
1 Change History
Mappin g Betwee n FTTH ONU Types and Functio n of Configu ring the VAS
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
7
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
1 Change History
Topic
Sectio n
Description
Cause and Impact
23.7 Mapping Between FTTO&FTTD ONU Types and ASCII Codes
Mappin g Betwee n FTTO ONU Types and ASCII Codes
The new ONU type EG8080P, EG8280P is added.
To support EG8080P and EG8280P as an ONU type.
The parameter SHOWOPTI ON is added.
The parameter SHOWOPTION is added.
The configuration items BMS_LSTON TPORT_SHO W_NNI is added.
The configuration items BMS_LSTONTPORT_SHOW_NNI is added to return the NNI port.
The ItemsDEV_E RROR_TOL ERANCE are added.
Tolerance switch for error of device.
23.9 Mapping Between FTTO&FTTD ONU Types and Function of Configuring the VAS
14.1.3 Querying the Information About a Device (LST-DEV)
Mappin g Betwee n FTTO ONU Types and Functio n of Configu ring the VAS Input Paramet er Output Paramet er Respon se Format
Issue 01 (2018-03-05)
8 Setting Configuration Items
Table 8-1
14.8.9 Querying the List of ONT Ports (LSTONTPORT)
Usage Note
8 Setting Configuration Items
Virtuali zation configu ration items
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
8
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
2 Usage Note
2
Usage Note
This topic describes the usage note of TL1 commands. To use the TL1 NBI properly, ensure that: l
You have logged in to the U2000 using LOGIN command.
l
The ENDESC parameter (that is, the returned error description) in the response information may be optimized in later versions. Therefore, you are not advised to set the ENDESC parameter as the keyword for OSS matching.
l
You have selected the Access domain check box in the Domain area when installing the U2000.
l
You have purchased the desired license. For details, see 4 Relationships Between the License and TL1 NBI.
l
You have logged in to the U2000 through TL1 NBI 9819. The SSL authentication mode is used by default. If you want to modify the authentication mode, see 3.5 Security Mechanism.
l
The system monitor client process TL1NBiDm and related service processes are running properly.
l
TL1 users exist on the U2000 and have been assigned with the required rights. You can create TL1 users in the NMS user management window or use the existing users on the U2000 client. NOTE
The default user name is admin(in the case of centralized deployment) or ssoadmin (in the case of distributed deployment). Both users' initial passwords are Changeme_123 . The password must be changed during the first login to ensure system security. Keep the password confidential and change it regularly.
l
You have set configuration items by running the specific TL1 commands.
l
You have synchronized data on the U2000 before issuing TL1 commands to keep data consistency between the U2000 and NEs. If the data is inconsistent, the commands may fail to be issued.
l
You have learned about 3.6 Performance Specifications and 10 Command Format of the TL1 NBI.
l
You have commissioned TL1 commands before interconnecting the U2000 with the OSS. Run the telnet U2000 server IP address 9819 command in the CLI, or log in to a more secure SSL client tool and enter the U2000 server IP address and port 9819 to connect to the U2000 TL1 NBI. Then run TL1 commands to test command correctness.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
9
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
2 Usage Note
l
The U2000 V200R015C50 supports the same TL1 commands for the MD5500, MA5651G, MA5300, MA5100V1, MA5100V2, MA5105, MA5605, MA5615, UA5000 and UA5000(PVU) as the U2000 V200R014C60 does. For details, see iManager U2000 V200R014C60 Northbound TL1 Interface User Guide.
l
You must properly run TL1 commands that are used only for internal commissioning or customized scenarios. Otherwise, commands may fail to be issued or services become abnormal. The commands used for internal commissioning or customized scenarios will not be provided in this document. If you need them, apply for them from Huawei.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
10
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
3
TL1 NBI Overview
About This Chapter This topic provides an introduction to the transaction language 1 (TL1) northbound interface (NBI), including its position in the network, communication protocols, functions, security mechanisms, performance specifications, and standard compliance of TL1 NBI. 3.1 Introduction to the TL1 NBI This topic briefly describes the TL1 NBI. 3.2 Position in the Network This topic describes the position of the TL1 NBI in the network. 3.3 Communication Protocols This topic describes the communication protocols that the TL1 NBI uses. 3.4 Functions and Features This topic describes the functions and features that the TL1 NBI supports. 3.5 Security Mechanism This topic describes the security mechanism that the TL1 NBI uses. 3.6 Performance Specifications This topic describes the performance specifications that the TL1 NBI supports. 3.7 Standard Compliance This topic describes the standard that the TL1 NBI complies with. 3.8 References This topic provides the references for this user guide.
3.1 Introduction to the TL1 NBI This topic briefly describes the TL1 NBI. The TL1 NBI is used to interconnect the element management system (EMS) with the operation support system (OSS) or with the network management system (NMS) The TL1 NBI supports the functions of resource query, provisioning, and diagnostic tests of the ADSL, video, and VoIP services through the OSS or NMS. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
11
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
3.2 Position in the Network This topic describes the position of the TL1 NBI in the network. Figure 3-1 shows the position of the TL1 NBI in the network. Figure 3-1 Position of the TL1 NBI in the network
The functions of the entities are as follows: l
OSS/NMS refers to the operation support system or network management system of carriers. The OSS or NMS issues TL1 commands to the U2000 for automatic service provisioning.
l
TL1 NBI for Service Provisioning provides an interface between the OSS/NMS and the U2000. In this way, the OSS/NMS can perform multi-service provisioning and resource querying operations.
l
U2000 is unified network management system (NMS) developed by Huawei. It supports all functions of the element and network management layers and providing NBIs.
l
Network element (NE) refers to the element device in the network. It is managed by the U2000.
3.3 Communication Protocols This topic describes the communication protocols that the TL1 NBI uses. The access network adapter interacts with the EMS through the TL1 commands based on the SSL/TCP/IP-based socket. The EMS, as a server, provides an available SSL/TCP SOCKET interface, and accepts the request from the OSS to set up a session through the default port number 9819. After the session is set up, you can access the system after the login authentication. Figure 3-2shows the protocol stack for the TL1 NBI. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
12
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
Figure 3-2 Protocol stack for the TL1 NBI
l
OSS: operation support system
l
NMS: network management system
l
SSL: Secure Sockets Layer
l
TCP/IP: Transmission Control Protocol/Internet Protocol
3.4 Functions and Features This topic describes the functions and features that the TL1 NBI supports.
Functions The TL1 NBI supports the following functions: l
Resource change notification: The TL1 NBI supports the function of notifying changes of devices, EPON resources, and Ethernet resources.
l
Inventory query: The TL1 NBI supports the function of querying various resources, such as devices, xDSL resources (including ADSL, G.SHDSL, and VDSL2 resources), video resources, xPON resources (including GPON and EPON resources), and VoIP resources.
l
Service provisioning and management: The TL1 NBI supports the function of provisioning and maintaining various types of services, such as the xDSL services (including ADSL, G.SHDSL, and VDSL2 services), video service, xPON service (including GPON and EPON services), and VoIP service.
l
Diagnostic test: The TL1 NBI supports the function of performing the diagnostic test, such as the OAM loopback test and ETH OAM function.
Features Successful issue of TL1 commands can change NMS configurations. No negative impact is introduced after a rollback upon failure to run the TL1 commands. Combining different parameters, TL1 commands can implement various complex functions. The OSS system can Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
13
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
use functions of the TL1 NBI by calling interfaces that are developed based on the TL1 standards. A session (through port 9819) needs to be set up between the U2000 and the OSS before the OSS can issue any TL1 command. Then, by using the login command, the OSS can log in to the U2000 successfully after passing the authentication. During the interaction, the OSS and the U2000 set handles for each command. Generally, the OSS system issues the next command only after receiving the response to the previous command from the U2000. The command response, right or wrong, wraps up the processing of a command. If the OSS logs out but does not terminate the session, the U2000 terminates the session after ten-minuteperiod of no commands. The TL1 NBI supports concurrent client operations. Multiple clients can communicate with the server to issue commands through the TL1 NBI at the same time.
3.5 Security Mechanism This topic describes the security mechanism that the TL1 NBI uses. By default, the TL1 NBI uses the security mechanism of the EMS. To activate this mechanism, you need to add NBI users and configure the access control list (ACL) on the EMS server. To enable the OSS to log in to the U2000 without being restricted by the ACL, perform the following operations: 1.
Modify the configuration item in the oss\server\etc\oss_cfg\access\TL1NBiDm.conf file. Specifically, change the configuration item dynamic NICMWriterTask Service_Object * bmsniconnectionmanage:_make_CNICMWriterTask() "-port 9819 -poolsize 16 -idletime 600 -returnerr 1" in the oss\server\etc\oss_cfg\access\TL1NBiDm.conf file to dynamic NICMWriterTask Service_Object * bmsniconnectionmanage:_make_CNICMWriterTask() "-port 9819 -poolsize 16 idletime 600 -returnerr 1 -enableACL 1".
2.
On the System Monitor client, restart the TL1NBiDm process for the configuration to take effect. a.
Log in to the System Monitor client.
b.
In the system monitor client window, click the Service Monistor tab.
c.
Right-click the TL1NBiDm process and choose Stop the Service from the shortcut menu.
d.
After the TL1NBiDm process stops, right-click it and choose Start the Service from the shortcut menu.
The EMS system supports up to 30 concurrent connections. The security mechanism of the TL1 NBI is as follows: l
Issue 01 (2018-03-05)
Login authentication: After connecting to the TL1 NBI, the OSS sends the LOGIN command for login authentication. The TL1 NBI accepts the command on the connection only after the authentication succeeds. The user name and password for login are the same as those of the U2000 client. User rights depend on the U2000 user rights and TL1 license. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
14
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
NOTE
The default user name is admin(in the case of centralized deployment) or ssoadmin (in the case of distributed deployment). Both users' initial passwords are Changeme_123 . The password must be changed during the first login to ensure system security. Keep the password confidential and change it regularly.
NOTICE You are advised to create an independent TL1 NBI user with both query and configure operation rights. This prevents errors caused by insufficient permissions during the process of service provisioning. You can also assign either query or configure operation rights to a user according to actual situations. l
Operation and domain authentication: The U2000 provides operation rights and domain rights for access users. Only users that have related operation rights can invoke the TL1 NBI. For details, see 6.7 Creating a U2000 User for the Access of an OSS and Assign Rights to the User.
l
Automatic release of the connection: If no message is transmitted through a connection within 10 minutes, the connection will be released automatically.
l
IP address listening range: By default, messages sent from all IP addresses are listened. To ensure security, you can configure settings to only listen to messages sent from specified IP addresses. For details, see 22.13 How to Set the IP Address Listening Range.
l
Communication protocol: The U2000 TL1 NBI provides SSL and TCP connections. The U2000 uses the SSL authentication mode by default to connect to the OSS to ensure their communication security. NOTE
l SSL is more secure and widely used and has better performance than TCP. Therefore, SSL is recommended during protocol configuration. For details about SSL, see 7 SSL Principle and Configuration. l Only the TLSv1.1 and later protocol is supported when you connect with SSL.
Perform the following operations to query and change the connection mode: a.
b.
c.
Issue 01 (2018-03-05)
Run the select CfgValue from BMSDB..bms_cfg_tab where strLocateName='AN.NBFRAME' and CfgName = 'PROTOCOL' script to query the current connection mode. n
If CfgValue is displayed as 2 (default value), the SSL protocol is used.
n
If CfgValue is displayed as 0, the TCP protocol is used.
Run a database script to change the value of CfgValue to the desired protocol. n
SSL: update BMSDB..bms_cfg_tab set CfgValue='2' where strLocateName='AN.NBFRAME' and CfgName='PROTOCOL'
n
TCP: update BMSDB..bms_cfg_tab set CfgValue='0' where strLocateName='AN.NBFRAME' and CfgName='PROTOCOL'
On the System Monitor client, restart the TL1NBiDm process for the configuration to take effect. i.
Log in to the System Monitor client.
ii.
In the system monitor client window, click the Service Monistor tab. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
15
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
iii. Right-click the TL1NBiDm process and choose Stop the Service from the shortcut menu. iv.
After the TL1NBiDm process stops, right-click it and choose Start the Service from the shortcut menu.
l
Limited number of IP connections: The TL1 NBI limits the number of TCP connections established with a single IP address. Connections will be denied after the limit is reached. The restriction can be controlled by setting the configuration item TL1_MAX_IP_CONNECTION.
l
IP address blacklist: If the number of failed login attempts of an IP address exceeds the limit in a specified duration, the U2000 will prohibit the IP address from establishing connections in a set duration. The restriction can be controlled by setting configuration items: NBIFRAME_LOGIN_FAIL_COUNT_INTERVAL, NBIFRAME_MAX_ALLOWED_LOGIN_FAILS, and NBIFRAME_MAX_BLOCK_TIME.
3.6 Performance Specifications This topic describes the performance specifications that the TL1 NBI supports. Table 3-1 lists the performance specifications of the TL1 NBI. Table 3-1 Performance specifications of the TL1 NBI Item
Specification
Maximum number of OSS connections that can be received at one time
l Common- and medium-scale networks: 20 It is recommended that the number of OSS connections of each function interface be allocated as follows: – Service provisioning: 15 – Inventory query: 2 – Diagnosis and test: 3 l Large- and ultra-large-scale networks: 30 It is recommended that the number of OSS connections of each function interface be allocated as follows: – Service provisioning: 20 – Inventory query: 2 – Diagnosis and test: 8 NOTE For details about the mapping between the network scale and server configurations, see iManager U2000 Product Description.
Issue 01 (2018-03-05)
Processing capability for requesting commands of TL1
10 per second (only for configuration commands)
Response time for requesting commands of TL1
Within two minutes (excluding test commands)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
16
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
3 TL1 NBI Overview
3.7 Standard Compliance This topic describes the standard that the TL1 NBI complies with. The TL1 NBI complies with the Generic Requirements (GR) 831 standard.
3.8 References This topic provides the references for this user guide. User Requirement Specification of Interface Between C & W HKT CFMS and NMSI of AN Vendor Operations Application Messages - Language for Operations Application Messages(GR831)
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
17
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
4
4 Relationships Between the License and TL1 NBI
Relationships Between the License and TL1 NBI This topic describes the relationships between the license and the TL1 NBI. The U2000 license controls the TL1 NBI software in the interface function dimensions. l
Inventory.
l
Service delivery.
Use the text viewer to view the contents of the license file (.dat file) in the oss\server\etc\conf \license\ directory. On Solaris and Linux, view the license as user root. On Windows, view the license as user administrator. To use the service provisioning and inventory querying functions of the TL1 NBI, apply for related licenses. Refer to Table 4-1 for the details of license control items. The parameters Feature means the feature group. Table 4-1 License control items
Issue 01 (2018-03-05)
License Control Item
Function Description
Abbreviati on
Value
Service Provisioning
This item defines the number of ONUs that support PON service provisioning. Each PON terminal consumes the license item by 1.
LNSDPENE S13
0-8000000
Per PON Terminal Resource License for NBI Service ProvisioningAccess Network
The TL1 command to provision services on PON terminals can be run only when the license count of this item is greater than 1.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
18
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
License Control Item Per Broadband Port License for NBI Service ProvisioningAccess Network
4 Relationships Between the License and TL1 NBI
Function Description
Abbreviati on
Value
This item defines the total number of ADSL ports, VDSL ports, Ethernet ports, and G.FAST resources that support broadband service provisioning. Each broadband port consumes the license item by 1.
LNSDPENE S12
0-8000000
LNSDPENE S11
0-8000000
The TL1 command to provision broadband services can be run only when the license count of this item or the item Compatible license for TL1 service provisioning NBI — access is greater than 1. Per Narrowband Port License for NBI Service ProvisioningAccess Network
Issue 01 (2018-03-05)
This item defines the number of POTS ports that support narrowband service provisioning. Each narrowband port consumes the license item by 1. The TL1 command to provision narrowband services can be run only when the license count of this item or the item Compatible License for TL1 Service Provisioning NBI-Access Network is greater than 1
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
19
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
License Control Item Compatible License for TL1 Service Provisioning NBI-Access Network
4 Relationships Between the License and TL1 NBI
Function Description
Abbreviati on
Value
This item defines the total number of ADSL ports, VDSL ports, Ethernet ports, G.FAST, and POTS ports that support service provisioning. Each broadband or narrowband port consumes the license item by 1.
LNSDNELC R77
0-8000000
LNSDPENE V05
0-8000000
The TL1 command to provision broadband services can be run only when the license count of this item or the item Compatible license for TL1 service provisioning NBI — access is greater than 1. The TL1 command to provision narrowband services can be run only when the license count of this item or the item Compatible License for TL1 Service Provisioning NBI-Access Network is greater than 1 Inventory Querying
Issue 01 (2018-03-05)
Per PON Terminal Resource License for NBI InventoryAccess Network
This item defines the number of ONUs that support PON inventory query. Each PON terminal consumes the license item by 1. The TL1 command to query PON terminals can be run only when the license count of this item is greater than 1.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
20
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
License Control Item Per Broadband Port License for NBI InventoryAccess Network
4 Relationships Between the License and TL1 NBI
Function Description
Abbreviati on
Value
This item defines the total number of ADSL ports, VDSL ports, SHDSL ports, Ethernet ports, G.FAST, andP2P access resources that support query of broadband inventory. Each broadband port consumes the license item by 1.
LNSDPENE V04
0-8000000
LNSDPENE V03
0-8000000
The TL1 command to query broadband resources can be run only when the license count of this item or the item Compatible license for TL1 inventory NBI — access is greater than 1. Per Narrowband Port License for NBI InventoryAccess Network
This item defines the total number of POTS ports, PRA ports, BRA ports, and E1 ports that support query of narrowband inventory. Each narrowband port consumes the license item by 1. The TL1 command to query narrowband resources can be run only when the license count of this item or the item Compatible License for TL1 Inventory NBIAccess Network is greater than 1.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
21
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
License Control Item Compatible License for TL1 Inventory NBI-Access Network
4 Relationships Between the License and TL1 NBI
Function Description
Abbreviati on
Value
This item defines the total number of ADSL ports, VDSL ports, SHDSL ports, Ethernet ports, G.FAST, P2P access ports, POTS ports, PRA ports, BRA ports, and E1 ports that support inventory query. Each broadband or narrowband port consumes the license item by 1.
LNSDNELC R78
0-8000000
LNSDPENE V06
0-8000000
The TL1 command to query broadband resources can be run only when the license count of this item or the item Compatible license for TL1 inventory NBI — access is greater than 1. The TL1 command to query narrowband resources can be run only when the license count of this item or the item Compatible License for TL1 Inventory NBIAccess Network is greater than 1. Per CMC License for NBI InventoryAccess Network
This item defines the number of MA5633s that support CMC inventory query. Each MA5633 extended subrack or MA5633 NE consumes the license item by 1.
NOTE
l ONTs consume license items for PON terminals only and do not consume license items for their broadband and narrowband ports. l MDUs consume license items for their broadband and narrowband ports only and do not consume license items for PON terminals. l The license expires when it is exhausted. In that event, related TL1 commands cannot be executed.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
22
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
5
5 Installing and Enabling the NBI for Provisioning the TL1 Service
Installing and Enabling the NBI for Provisioning the TL1 Service
About This Chapter This topic describes how to install and enable the NBI for provisioning the TL1 service on Windows OS and Solaris/Linux OS. 5.1 Configuration Requirements Because the U2000 TL1 NBI and the U2000 server run on the same PC or Sun workstation, no additional configuration is required. However, to enable the TL1 NBI, you must purchase the license for the corresponding functions. 5.2 Installing a TL1 NBI Component This topic describes how to install a TL1 NBI component. 5.3 Checking the Status of the TL1 NBI This topic describes how to check the status of the TL1 process and the license for the TL1 NBI after a TL1 NBI component is installed.
5.1 Configuration Requirements Because the U2000 TL1 NBI and the U2000 server run on the same PC or Sun workstation, no additional configuration is required. However, to enable the TL1 NBI, you must purchase the license for the corresponding functions. NOTE
For different U2000 system , the configuration requirements of U2000 are different, refer to the corresponding iManager U2000 Software Installation and Commissioning Guide for more information.
Hardware Configuration In practice, the U2000 TL1 interface and the U2000 server run on the same PC or SUN workstation. The hardware is configured to ensure the proper installation and running of the U2000 server. Any additional hardware configuration is not required the U2000 TL1 interface. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
23
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
5 Installing and Enabling the NBI for Provisioning the TL1 Service
For details of hardware requirements of U2000 Server, refer to section "Configuration Requirements" in the iManager U2000 Software Installation and Commissioning Guide.
Software Configuration Since the TL1 interface is integrated into the U2000 installation software, no additional software configuration is required for the installation of the U2000 TL1 interface. For details of software requirements U2000 Server, refer to section "Configuration Requirements" in the iManager U2000 Software Installation and Commissioning Guide.
License The U2000 controls the functions and available resources of the TL1 NBI through a license. If you want to enable the TL1 interface, you need to purchase the U2000 license. Ensure the license support TL1 interface function before deploying the TL1 NBI. For details, see 4 Relationships Between the License and TL1 NBI. If the license does not support the functions or resources needed, contact Huawei engineers to apply for the license. For the license introduction and information on how to apply for a license, see section Applying for and Updating the U2000 License in the iManager U2000 Administrator Guide.
5.2 Installing a TL1 NBI Component This topic describes how to install a TL1 NBI component.
Procedure Step 1 Run the installation program of the U2000 and select to install Access domain . For details on the installation steps, see the iManager U2000 Software Installation and Commissioning Guide. ----End
5.3 Checking the Status of the TL1 NBI This topic describes how to check the status of the TL1 process and the license for the TL1 NBI after a TL1 NBI component is installed.
Prerequisites After the U2000 is installed, the OS is restarted and the U2000 service is started. NOTE
If the U2000 service is not started, start the U2000 service manually. l Run the oss\server\platform\bin\startnms.bat file on Windows OS. l Run the following command on Solaris\Linux OS: $ cd /opt/oss/server/platform/bin $ ./startnms.sh
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
24
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
5 Installing and Enabling the NBI for Provisioning the TL1 Service
Context In a U2000 HA system, check the status of the TL1 process at the primary site. Check whether the license is effective at the primary and secondary sites.
Procedure Step 1 Check the status of the TL1 process. 1.
Log in to the system monitor client.
2.
On the Service Monistor tab page, check whether the TL1NBiDm process is running. NOTE
If the process is not started, right-click TL1NBiDm and choose Start the Service from the shortcut menu.
Step 2 Check whether the license for the TL1 NBI is effective. 1.
Log in to the client.
2.
Choose Help > License Management > License Information (traditional style) from the main menu or select System Management in Application Center and choose License Management > Licenes Information (application style) from the main menu.
3.
In the License Information dialog box, click Resource Control Item. In the Resource column, check whether the applied license items are included and the Capacity counts are consistent with the number that you apply for.
----End
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
25
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6
6 Maintaining the TL1 NBI
Maintaining the TL1 NBI
About This Chapter This chapter provides instructional suggestions for the maintenance conditions and routine operations for the TL1 interface. This chapter also describes the basic operation for maintaining the TL1 interface. In addition, this chapter describes how to solve problems that may occur during maintenance, which can help maintenance personnel to solve problems quickly. 6.1 Requirements for Maintenance Staff This section describes the requirements for maintenance staff. 6.2 Routine Maintenance By routine maintenance, faults such as malfunction in the system operation can be detected in time if countermeasures are properly adopted to handle the problem. In this way, hidden troubles are cleared to prevent accidents from happening. It is recommended that you perform routine maintenance once a week. 6.3 Logging in to the System Monitor Client This topic describes how to log in to the System Monitor client that runs on Windows, Solaris, or Linux OS. 6.4 Starting the TL1 Process This topic describes how to start the TL1 process in the Stopped state using the System Monitor client. 6.5 Stopping the TL1 Process This topic describes how to stop the TL1 process using the System Monitor client. 6.6 Checking the License Status of the U2000 This topic describes how to check the license status of the U2000. By learning the license usage, you can apply for a new license from Huawei in time when the NMS requires an expansion or the license is about to expire. 6.7 Creating a U2000 User for the Access of an OSS and Assign Rights to the User If the U2000 TL1 interface runs in the normal state and the network communication is normal, you need to create a network management user on the U2000 for the access of an OSS before the OSS accesses the U2000 through the TL1 interface.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
26
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
6.1 Requirements for Maintenance Staff This section describes the requirements for maintenance staff. To guarantee the smooth maintenance and rapid problem solving, the maintenance staffis required to have the following experiences: l
Be familiar with the basic operations of the PC, Sun workstation, Windows, Solaris and Linux operating systems.
l
Have a good understanding of the TL1 technology.
l
Understand concepts of the telecommunication management network (TMN) and know the basic networking architecture of the U2000 well.
l
Be familiar with the configuration and the operations of enabling and disabling the U2000 TL1 interface. NOTE
For maintenance of the workstation, refer to the maintenance manual provided by its supplier.
6.2 Routine Maintenance By routine maintenance, faults such as malfunction in the system operation can be detected in time if countermeasures are properly adopted to handle the problem. In this way, hidden troubles are cleared to prevent accidents from happening. It is recommended that you perform routine maintenance once a week.
Checking the TL1 Service l
When the U2000 single server is running, log in to the System Monitor client which monitors the U2000 process. Check whether the TL1NBiDm processes is running properly.
l
In a U2000 HA system, log in to the System Monitor client at the primary site and check the running status of the TL1NBiDm process. NOTE
Primary site: Used for the high availability system, the primary site refers to the physical primary site. Whether a site is a primary site or a secondary site is specified when it is installed, the role does not change when the system switching occurs. In most of the time, a primary site is in the active state, whereas a secondary site is in the standby state for protecting the primary site.
Backing up the logs of the U2000 TL1 NBI By default, the logging function of the TL1 NBI is disabled. The TL1 user operations are not recorded in logs. To enable the logging function of the TL1, refer to 22.11 Recording TL1 User Logs. The log information of the U2000 TL1 NBI is as follows: l
server/var/logs/Develop/TL1NBiDm/TL1NBiDm_%y%m%d_%H%M%S.*
l
server/var/logs/Develop/TL1NBiDm/BootLog_%y%m%d_%H%M%S.*
l
server/var/logs/mrblog/iMAPBase_p47_%y%m%d_%H%M%S.*
l
server/var/logs/mrblog/iMAPMrb_p2_%y%m%d_%H%M%S.*
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
27
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
Back up the log files regularly in case they occupy too much of the system disk space. The log files record the running information of the U2000 TL1 NBI and the operation performed by the NMS/OSS through the U2000 TL1 NBI. If an error occurs when the U2000 TL1 NBI is running, you can refer to the log files to do the troubleshooting. If you want to back up the log information of the U2000 TL1 NBI, manually copy the log information to a specified directory. Alternatively, choose Administration > Log Management > Query Operation Logs (traditional style) from the main menu or select Security Management in Application Center and choose Log Management > Query Operation Logs (application style) from the main menu. In the Query Operation Logs window, select the required log to view the operation result and details.
Dumping operation logs of the U2000 TL1 NBI Dump the log files regularly in case they occupy too much of the system disk space. l
l
Manually dump in the U2000 client. a.
Choose Administration > Task Schedule > Task Management (traditional style) from the main menu or select System Management in Application Center and choose Task Schedule > Task Management (application style) from the main menu.
b.
In the Task Management window, choose Manual Dump > Operation Log Manual Dump from the navigation tree.
c.
In the right pane, right-click the manual dump task and choose Run from the shortcut menu.
d.
In the Run dialog box, set the parameters.
e.
Click Dump to dump logs.
Setting the log overflow dump in the U2000 client. a.
Choose Administration > Task Schedule > Task Management (traditional style) from the main menu or select System Management in Application Center and choose Task Schedule > Task Management (application style) from the main menu.
b.
In the Task Management window, choose Overflow Dump > Operation Log Overflow Dump from the navigation tree.
c.
Double-click the task in the right pane.
d.
In the Attributes dialog box, set the parameters on the Common Parameters and Extended Parameters tabs.
e.
Click OK.
6.3 Logging in to the System Monitor Client This topic describes how to log in to the System Monitor client that runs on Windows, Solaris, or Linux OS.
Prerequisites l
The U2000 server runs in the normal state.
l
The system, which monitoring process, runs in the normal state.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
28
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
l
The System Monitor communicates well with the U2000 server.
l
You have a valid user account and password of the U2000.
l
The default port number of the server is 31080. Do not change it in normal conditions. Otherwise, you cannot log in to the U2000 server.
l
The login modes include the SSL mode and the common mode. In SSL mode, data is encrypted when being transmitted between the client and the server. In common mode, data is not encrypted during transmission. To ensure the security of data transmission, you are recommended to use the Security (SSL) mode.
l
The port used for login in common mode is different from that in SSL mode. The port number is 31030 in common mode, and 31080 in SSL mode.
l
By default, if you do not log in to the U2000 system monitor client for more than 60 days, your account automatically turns to the suspend state except that you are an admin user(in the case of centralized deployment) or ssoadmin users (in the case of distributed deployment).
l
If you never use an account for login after creating it, the U2000 does not suspend or delete the account.
Context
Procedure Step 1 Start the system monitor client. l
On Windows OS, to start the system monitor client, double-click the related shortcut icon on the desktop.
l
On Solaris or Linux OS, log in to the operating system of the server as the ossuser user. Run the following command to start the system monitor client. $ cd /opt/oss/client $ ./startup_sysmonitor_global.sh
Step 2 In the Login dialog box, select a server from the Server drop-down list. If the list does not contain a server, perform the following steps: on the right of the Server drop-down list.
1.
Click
2.
In the Server List dialog box, click Add.
3.
In the Add Server Information dialog box, specify Name and Server Name(or IP Address), and then select a login mode. Click OK.
4.
In the Server List dialog box, click OK.
Step 3 In the Login dialog box, enter the user name and password. The user name and password are the same as those for the U2000 client. NOTE
The default user name is admin(in the case of centralized deployment) or ssoadmin (in the case of distributed deployment). Both users' initial passwords are Changeme_123 . The password must be changed during the first login to ensure system security. Keep the password confidential and change it regularly.
Step 4 Click Login. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
29
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
l
6 Maintaining the TL1 NBI
If you attempt to connect to the server in a non-SSL mode, the client displays a dialog box indicating security risks. –
If you want to continue the connection, click Yes. If you do not want the client to display the dialog box again upon subsequent logins, select Do not remind me next time. NOTE
The IP address of the server being connected is saved to the SysComServer.dat file in Client installation directory\client\plugins\loginui\style\conf\loginui. Therefore, the Do not remind me next time settings apply only to the connected server. If you want the client to display the dialog box that indicates the security risks upon subsequent logins, delete the SysComServer.dat file.
– l
If you want to terminate the connection, click No. The Login dialog box is displayed. You can select the matched communication mode.
If the client does not trust the server, you need to determine whether the server is trustworthy using the server certificate. –
If you confirm that the server is trustworthy, click Yes and log in to the client. If you do not want the system to display the dialog box again, contact the system administrator to configure a trust certificate.
–
If you confirm that the server is untrustworthy, click No to return to the Login dialog box and contact the system administrator to process the issue.
----End
6.4 Starting the TL1 Process This topic describes how to start the TL1 process in the Stopped state using the System Monitor client.
Prerequisites l
The U2000 server runs in the normal state.
l
The system, which monitoring process, runs in the normal state.
l
The System Monitor communicates well with the U2000 server.
l
You have a valid user account and password of the U2000.
l
The TL1NBiDm process is in the Stopped state.
Context In a U2000 HA system, start the TL1 process at the primary site.
Procedure Step 1 Log in to the system monitor client. Step 2 In the system monitor client window, click the Service Monistor tab. Step 3 Right-click the TL1NBiDm process and choose Start the Service from the shortcut menu. ----End Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
30
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
6.5 Stopping the TL1 Process This topic describes how to stop the TL1 process using the System Monitor client.
Prerequisites l
The U2000 server runs in the normal state.
l
The system, which monitoring process, runs in the normal state.
l
The System Monitor communicates well with the U2000 server.
l
You have a valid user account and password of the U2000.
l
The TL1NBiDm process is in the Running state.
l
For a U2000 HA system, stop the TL1 process at the primary site.
l
If Startup Mode is set to Automatic, the TL1 process is started with the startup of the U2000.
l
If Startup Mode is set to Manual, the TL1 process is not started with the startup of the U2000.
Context
NOTICE Stopping a service affects the functions of the TL1 NBI. Therefore, perform this operation with caution.
Procedure Step 1 Log in to the system monitor client. Step 2 In the system monitor client window, click the Service Monistor tab. Step 3 Select TL1NBiDm process, right-click, and then choose Stop the Service from the shortcut menu. ----End
6.6 Checking the License Status of the U2000 This topic describes how to check the license status of the U2000. By learning the license usage, you can apply for a new license from Huawei in time when the NMS requires an expansion or the license is about to expire.
Context For details on the license item for the TL1 connection, see 4 Relationships Between the License and TL1 NBI. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
31
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
Procedure Step 1 Log in to the U2000 client. Step 2 Choose Help > License Management > License Information (traditional style) from the main menu or select System Management in Application Center and choose License Management > Licenes Information (application style) from the main menu. Step 3 In the License Information dialog box, click Resource Control Item to view the license usage. NOTE
When the number of resources exceeds the licensed capacity, the corresponding license item is displayed in red. This affects the license renewal. Specifically, the newly applied license count must be greater than the number consumed. Otherwise, the license renewal fails. For details on how to apply for a license, see the section "Applying for and Updating the U2000 License" of the iManager U2000 Administrator Guide.
Step 4 (Optional) Click Export License to save the license information to files in *.xls, *.csv, *.txt, *.html, *.pdf, or *.xlsx format. ----End
6.7 Creating a U2000 User for the Access of an OSS and Assign Rights to the User If the U2000 TL1 interface runs in the normal state and the network communication is normal, you need to create a network management user on the U2000 for the access of an OSS before the OSS accesses the U2000 through the TL1 interface.
Context
NOTICE To ensure system security, when the OSS accesses the U2000 through the NBI, the U2000 will authenticate user logins. The U2000 provides operation rights and domain rights for access users. Only users that have related operation rights can invoke the TL1 NBI. For more details about the NMS user management, see the online help of U2000.
Procedure Step 1 Login the client of U2000. Step 2 Choose Administration > NMS Security > NMS User Management (traditional style) from the main menu or select Security Management in Application Center and choose OSS Security > OSS User Management (application style) from the main menu. Step 3 In the NMS User Management navigation tree, right-click the User node and choose New User from the shortcut menu. Step 4 In the New User dialog box, set the properties of the new user. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
32
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
The user name and password must be set. For the other properties, you can use default values or set them after you create the user account successfully. If the OSS access U2000 by TL1 NBI, some user attributes are valid, as the following table shown. Attribute
Description
Operations
Normal properties
The OSS use the user name or password access U2000 by TL1 NBI.
On the New User dialog box, set user properties, such as user name, description content, and password.
Domain
For the user that access U2000 by TL1 NBI can manage the equipment in the domain only.
1. ClickMore Setting, on the Setting dialog box, choose Domain tab page, click Select. 2. In the Select Domain dialog box, set the management domain of the user.
Operation Rights
l TL1 Query Operation Set: TL1 NBI query rights (including performing diagnostic test and notifying resource change) l TL1 Configure Operation Set: TL1 NBI configuration rights
Access control list (ACL)
Issue 01 (2018-03-05)
You cannot access U2000 if the IP is not in the access control list.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
1. ClickMore Setting, on the Setting dialog box, choose Operation Rights tab page, click Select. 2. In the Select Operation Rights dialog box, set the Authorization Objects to Network Management Application, select the operation rights of the user in the Operations panel. ClickMore Setting, on the Setting dialog box, choose ACL tab page, set the ACL for the user.
33
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
6 Maintaining the TL1 NBI
NOTICE To ensure system security, password must be complex enough. Remember to change passwords regularly. The password must meet the following requirements to safeguard your user account. 1. It is a character string consisting of 8 to 16 characters. 2. It contains at least four types of the following characters: –
Lowercase letter: a-z
–
Uppercase letter: A-Z
–
Digit: 0-9
–
Special character: ` ~ ! @ # $ % ^ & * ( ) - _ = + \ | [ { } ] ; : ' " , < . > / ? or space.
Step 5 In the New User dialog box, click OK. The user account is created. ----End
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
34
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
7
7 SSL Principle and Configuration
SSL Principle and Configuration
About This Chapter The SSL encryption mechanism is used to ensure the security of the messages transmitted between the U2000 and the OSS. 7.1 SSL Principle This section describes the principle of SSL. 7.2 Applying for an SSL Certificate The U2000 provides a default SSL certificate for encryption and authentication. It is recommended that customers replace the default certificate with their own security certificate. Customers can apply for another SSL certificate from a third party that authorizes and issues SSL certificates. After the TL1 northbound interface (NBI) is configured to work in SSL mode, the OSS must communicate with the U2000 TL1 NBI in SSL mode, that is, the certificate, digital signature, encryption algorithm, or other manners must be used to ensure the communication security. 7.3 Configuring an SSL Certificate The U2000 provides a default SSL certificate for encryption and authentication. It is recommended that customers replace the default certificate with their own security certificate. Specifically, the customer can apply for a security certificate from a trusted CA and then use the certificate to replace the original U2000 SSL certificate.
7.1 SSL Principle This section describes the principle of SSL. The Security Socket Layer (SSL) is a type of security communication protocol developed by Netscape. By using the digital certificate, the SSL enables an encrypted security channel to be set up between the client and the server. This ensures that the transmitted information is not intercepted by others. After adopting the SSL encryption mechanism, the client needs to set up the communication connection to the server first. The server sends the digital certificate and the public key to the client, and exchanges the password with the client. Usually, the RSA password algorithm is used. The Diffie-Hellman or Fortezza-KEA password algorithm can also be used. After the Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
35
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
7 SSL Principle and Configuration
identity is verified, the public key is used to encrypt the session key of the client and the session key is sent to the server. After the server receives the session key, the server decrypts the session key. Then, an encrypted communication channel is set up between the client and the server. The three crucial elements of SSL are certificate, digital signature, and encryption. For details about the concepts and principles of SSL, refer to the related documents.
7.2 Applying for an SSL Certificate The U2000 provides a default SSL certificate for encryption and authentication. It is recommended that customers replace the default certificate with their own security certificate. Customers can apply for another SSL certificate from a third party that authorizes and issues SSL certificates. After the TL1 northbound interface (NBI) is configured to work in SSL mode, the OSS must communicate with the U2000 TL1 NBI in SSL mode, that is, the certificate, digital signature, encryption algorithm, or other manners must be used to ensure the communication security.
Default SSL Certificate Provided By the U2000 Table 7-1 shows the TL1 NBI certificates and paths. Table 7-1 SSL certificate and path
Issue 01 (2018-03-05)
Certificate
Description
Path
server.p12
Server identity certificate. The file is in the encoding format of PKCS12 and includes the private key and identity certificate.
server/etc/ssl/access/keyStore/PFX
client.p12
Client identity certificate. The file is in the encoding format of PKCS12 and includes the private key and identity certificate.
server/etc/ssl/access/keyStore/PFX
trust.cer
Trust certificate
server/etc/ssl/access/trust/PEM
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
36
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
7 SSL Principle and Configuration
Applying for an SSL Certificate When you apply for an SSL certificate from a third party that authorizes and issues SSL certificates, the desired SSL certificate of the U2000 must meet the requirements listed in Table 7-2 because the U2000 TL1 NBI uses the PEM encoding format. An SSL certificate has multiple encoding formats. You are advised to apply for an SSL certificate in proper encoding format based on the OSS type, so that you do not need to convert the certificate format.
NOTICE Use the default SSL certificate provided by the U2000 if security requirement is not high. Otherwise, apply for an SSL certificate from a third-party security institute. Table 7-2 Requirements for SSL certificates of the U2000 TL1 NBI Certificate Type
Requirement
Server identity certificate
l The file encoding format is PFX. l The RSA asymmetric encryption algorithm is used. l The private key contains a minimum of 1024 bits. l The file encoding format is PFX.
Client identity certificate
l The RSA asymmetric encryption algorithm is used. l The private key contains a minimum of 1024 bits.
Trust certificate
The file encoding format is PEM.
NOTICE l The U2000 uses its own SSL certificate by default. It does not generate, sign a signature for, or convert a special SSL certificate for a specified site. For a special SSL certificate, you are advised to prepare it by yourself or purchase it from a third party that authorizes and issues the SSL certificate. Replace the default SSL certificate on the U2000 with a special certificate after converting it to a format supported by the U2000. l If the default certificate on the U2000 is used, the OSS needs to convert it to a format supported by the OSS. If you need technical support and have purchased associated integration support service, contact the local Huawei customer service center.
7.3 Configuring an SSL Certificate The U2000 provides a default SSL certificate for encryption and authentication. It is recommended that customers replace the default certificate with their own security certificate. Specifically, the customer can apply for a security certificate from a trusted CA and then use the certificate to replace the original U2000 SSL certificate. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
37
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
7 SSL Principle and Configuration
Prerequisites l
The Centralized Maintenance Management Tool server has been started.
l
Port 31945 on the Centralized Maintenance Management Tool server has been enabled.
l
The PC used to log in to the Centralized Maintenance Management Tool in web mode can properly communicate with the Centralized Maintenance Management Tool server.
l
The primary IS node has been configured to communicate with the primary and secondary Float IP and NBI GW nodes and the PM, Backup, NM, and EM nodes.
You have obtained one or more of the following files based on actual needs: l
Identity certificate (*.p12)
l
Trust certificate (*.cer)
l
CRL (*.crl)
Context The TL1 NBI supports P12 identity certificates and PEM trust certificates only. The default certificate and its directory are as follows. Table 7-3 SSL certificate and path Certificate
Description
Path
server.p12
Server identity certificate. The file is in the encoding format of PKCS12 and includes the private key and device certificate.
server/etc/ssl/access/keyStore/PFX
trust.cer
Trust certificate used to identify trusted access objects.
server/etc/ssl/access/trust/PEM
NOTE
The new identity certificate is automatically changed to server.p12 and stored in the preceding directory to replace the original certificate.
Procedure l
Centralized deployment a.
Issue 01 (2018-03-05)
Upload the certificates in binary mode to the following directories of the U2000 server: n
Windows: %IMAP_ROOT%\certs
n
Solaris or Linux: Upload the certificate to $IMAP_ROOT/certs as the ossuser user.
b.
Use the MSuite to log in to the U2000 server.
c.
On the MSuite, choose Certificate File Management > TL1 Certificate to open the Certificate Configuration dialog box. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
38
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide n
7 SSL Principle and Configuration
Replacing an identity certificate 1)
Click the PrivateIdentityPanel tab, select the certificate file to be replaced from the File Name drop-down list, and click Replace.
2)
In the dialog box that is displayed, enter the passwords for the old and new certificates and click OK. NOTE
To ensure system security, the password for the new certificate must meet the following complexity requirements. To keep the password and system secure, the password must meet the following requirements: 1. Contain 8 to 18 characters. 2. Contain at least three of the following combinations:
n
l
Digit
l
Special characters =~@#^*-_+[{}]:./?
Click the Trust Certificate tab, select the certificate file to be added from the File Name drop-down list, and click Add.
Click the Trust Certificate tab, right-click the trust certificate to be deleted in the certificate list, and choose Delete from the shortcut menu.
Click the CRL tab, select the CRL to be used from the File Name dropdown list, and click Update.
Restart the TL1 service for the configurations to take effect. n
l
Uppercase letter
Configuring a CRL 1)
d.
l
Deleting a trust certificate 1)
n
Lowercase letter
Adding a trust certificate 1)
n
l
End the TL1 NBI service and then start the TL1 NBI service.
Distributed deployment a.
Upload the certificates to the $IMAP_ROOT/certs directory of the IS server. NOTE
The owner of these certificates must be ossuser:ossgroup. The certificate permission must be set to 600.
b.
Log in to the MSuite client. n
Start the web browser, enter https://Primary IS node's IP address:31945, and click Enter. NOTE
Internet Explorer 9/10/11, Google Chrome 29, and Firefox 12.0 or higher are recommended. The recommended resolution is 1280 x 768 or higher. If a message about a security certificate issue is displayed during the HTTPS access, ignore the message and continue the browsing. n
Issue 01 (2018-03-05)
On the login page, set User Name and Password of the user and click Log In.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
39
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
7 SSL Principle and Configuration
NOTE
The default user name is admin. The initial password of the admin user is Changeme_123. If the U2000 is preinstalled before being delivered, the password has been changed to Admin_123. To ensure system security, change the password promptly, update it periodically, and save it properly. If you log in for the first time, the system requires you to change the password and displays a message indicating that product information has not been configured.
c.
Choose System > Certificate Management > TL1 Certificate to open the certificate configuration page. n
Replacing an identity certificate 1)
Click the Identity Certificate tab, and select the certificate file to be replaced from the File Name drop-down list.
2)
Enter the passwords of the old and new certificates in the Old Certificate Password and New Certificate Password text boxes, and click OK. NOTE
To ensure system security, the password for the new certificate must meet complexity requirements. To keep the password and system secure, the password must meet the following requirements: 1. Contain 8 to 18 characters. 2. Contain at least three of the following combinations:
n
Uppercase letter
l
Digit
l
Special characters =~@#^*-_+[{}]:./?
Click the Trust Certificate tab, select the certificate file to be added from the File Name drop-down list, and click OK. Click the Trust Certificate tab, and click Delete in the fifth column of the certificate list.
Configuring a CRL 1)
d.
l
Deleting a trust certificate 1)
n
Lowercase letter
Adding a trust certificate 1)
n
l
Click the CRL tab, select the CRL file to be used from the File Name drop-down list, and click OK.
Restart the TL1 service for the configurations to take effect. n
End the TL1 gateway service and start the TL1 gateway service by following 9.3 Maintaining the TL1 NBI Gateway Service.
----End
Result After certificate replacement, the original certificate is stored in %IMAP_ROOT%/var/ backup/deployssl/ssl/access/YYYY_MM_DD_HH_MM_SS. YYYY_MM_DD_HH_MM_SS indicates the timestamp. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
40
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
l
YYYY: year
l
MM: month
l
DD: day
l
HH: hour
l
MM: minute
l
SS: second
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
7 SSL Principle and Configuration
41
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
8
8 Setting Configuration Items
Setting Configuration Items
This topic describes how to set configuration items before running TL1 commands. The configuration items described in this topic are applicable to both the centralized and distributed systems. For particular configuration items applicable to the distributed system, see 9.4 Setting Configuration Items. l
Virtualization configuration items Before running TL1 commands, set configuration items listed in Table 8-1 based on actual needs. a.
Log in to the MSuite client. For details, see Starting the Process of the MSuite Server and Logging In to the MSuite Client in section MSuite of iManager U2000 V200R017C60SPC200 Administrator Guide.
b.
Choose Tools > Config Manager from the main menu.
c.
Modify the configuration item values in an appropriate manner based on actual needs. n
n
Setting configuration items one by one. 1)
Click Filter in the upper right corner. In the dialog box that is displayed, set Config Name by following Table 8-1 and click OK.
2)
Double-click the configuration item to be modified in the list. In the dialog box that is displayed, set Config Value and click OK.
Setting configuration items in batches by importing a configuration item table. 1)
Obtain a configuration item table from the U2000 installation directory. Because only the Windows OS supports Excel, obtain the table from the specified Windows-based U2000 installation directory (X:\oss\client \client\Config_Item_Import\en\Config_Item_Import.xls, where X indicates the U2000 installation directory).
2)
Double-click the blank configuration item table, set values for the desired configuration items by following Table 8-1, and save the table. NOTE
Only tables in .xls format are supported. The configuration item data must be stored in the Config item data sheet of the table. Do not add or delete sheets. The first line of the table is a title line where stored data cannot be read. The configuration data must be stored consecutively.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
42
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
d.
8 Setting Configuration Items
3)
Verify that the entered information in the table is correct and click Import in the upper right corner. In the dialog box that is displayed, select the desired configuration item table and click Open.
4)
In the Configuration Item Batch Import dialog box, verify that all configuration items in the table are correct.
5)
Click OK. In the prompt dialog box that is displayed, click OK.
Log in to the System Monitor client and restart the related processes by following Table 8-1.
Table 8-1 Configuration item description Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
DEVMEA N
0
Indicates that in the TL commands except for the notification of resource changes, the DEV parameter is used to locate a device according to the device name.
0
1
TL1N BiDm
For details, see 22.7 How to Locate a Device According to the IP Address.
1
Indicates that in the TL commands except for the notification of resource changes, the DEV parameter is used to locate a device according to the IP address.
0
Indicates that in the notification of resource changes, the DEV parameter is used to locate a device according to the device name.
0
1
BmsAc cess_* process (multip le instanc es involvi ng multipl
NOTE This configurat ion item is supported only by the centralize d system. For the DevMean configurat ion item in the distribute d system, see 9.4 Setting Configur ation Items.
BMSNB_ MSGNOT IFY_DEV MEAN
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
43
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
TL1_ONT _SN_LEN GTH
Issue 01 (2018-03-05)
Config uratio n Item Value
Description
1
Indicates that in the notification of resource changes, the DEV parameter is used to locate a device according to the IP address.
12
Indicates that the returned SN is in the format of 12byte character string.
16
Indicates that the returned SN is in the format of 16byte character string.
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
e process es)
16
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
12
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es) TL1N BiDm inTL1 NBiD m
Command involved by the configuration item: LST-ONT
44
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Issue 01 (2018-03-05)
8 Setting Configuration Items
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
TL1_SN_ LEN_SPE CIAL_ON UTYPE
ONU type. The value depend s on the EQUIP MENT ID returne d by the LSTONT comma nd. Use comma s (,) to separat e multipl e ONU types, for exampl e, HG824 0A,HG 8245A.
Specifies the format of the SN returned by some GPON ONU types in the exported resource file. To set the SN format returned by some ONU types to be different from that returned by all other ONU types and defined in the TL1_ONT_SN_L ENGTH parameter, set this parameter. For example, if TL1_ONT_SN_L ENGTH is set to 16, it indicates that the returned SN is in the format of 16-byte character string. However, the HG8240A needs to support an SN in the format of 12-byte character string. In this case, set TL1_SN_LEN_S PECIAL_ONUT YPE to HG8240A. In contrast, if TL1_ONT_SN_L ENGTH is set to 12, it indicates that the returned SN is in the format of 12-byte character
-
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
Restar ting Proces ses
Remarks
45
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
0
0
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
Command involved by the configuration item: Notifying Device Synchronization
0
0
TL1N BiDm
Command involved by the configuration item: LST-PORT When you query ports in fuzzy match mode, it takes a long time to run the command. If the entered alias matches many ports, the command may time out. You are advised to query ports in exact
string. However, the HG8240A needs to support an SN in the format of 16-byte character string. In this case, set TL1_SN_LEN_S PECIAL_ONUT YPE to HG8240A. SYNC_C OMPLET ED_NOTI FY_OSS
TL1_USE _HAZY_ QRY_AT_ LST_POR T
Issue 01 (2018-03-05)
0
Indicates that the NE synchronization results are not reported to the OSS.
1
Indicates that the NE synchronization results are reported to the OSS.
0
Indicates that the ALIAS parameter in LST-PORT uses the exact match mode to filter ports when the DID and DEV parameters are not set.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
46
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
TL1_SHO W_MA56 83T_SWI TCH
NBI_INV ENTORY_ DUMP_V ERSION
Issue 01 (2018-03-05)
Config uratio n Item Value
Description
1
Indicates that the ALIAS parameter in LST-PORT uses the fuzzy match mode to filter ports when the DID and DEV parameters are not set.
0
Indicates that in the exported resource files or response, the device type of the MA5683T is displayed as MA5680T.
1
Indicates that in the exported resource files or response, the device type of the MA5683T is displayed as MA5683T.
2
Indicates that you can export the list of inventory resources including devices, subracks, boards, ports and Ethernet aggregation groups of a specified type to a file.
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
match mode or enter filter criteria as precise as possible when querying ports in fuzzy match mode. Set the configuration item based on actual needs. 0
1
TL1N BiDm inTL1 NBiD m
2
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
2
TL1N BiDm
Commands involved by the configuration item: DMPINVENTORY, LST-DEV, and LST-DEVINFO
Command involved by the configuration item: DMPINVENTORY The directory and format of exported XML resource file vary with the value of the configuration item NBI_INVENTO RY_DUMP_VE
47
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Issue 01 (2018-03-05)
Configur ation Item
Config uratio n Item Value
Description
NOTE This configurat ion item is supported only by the centralize d system. For the DumpVer sion configurat ion item in the distribute d system, see 9.4 Setting Configur ation Items.
3
Indicates that you can export the resource information about a specified device type, device, or resource type (device, subrack, board, daughter board, port, Ethernet aggregation group, BRA port, POTS port, ADSL port, VDSL port, ONT, service virtual port, VLANOFLAG, and Ethernet port) to a file. If the RES parameter is not set to specify the resource type, you can export data of the default resource types only, including ME, SHELF, CARD, DAUGTHERCA RD, and PORT. To export data of other resource types, set the RES parameter in the command. For example, run the DMPINVENTORY::: CTAG::RES=ME SHELF CARD DAUGHTERCA
8 Setting Configuration Items
De fa ult Va lu e
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
RSION. For details, see Description of the directory
48
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
and format of exported files.
RD PORT POTS BRA LAG ADSL VDSL ONT SERVICEPORT VLANOFLAG ETH command.
LoadOfflin e
Issue 01 (2018-03-05)
4
Indicates that you can export the resource information (device information, subrack, board, daughter board, port, ONT, splitter, link, or protection group) about a device or devices on the entire network to a file. Exporting resources of a specified type is not supported.
0
Disables the TL1 offline predeployment function. An error message is displayed indicating that devices are offline when you run the CFG-MDUEX command.
Remarks
0
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
0
Tl1NBi Dm
Command involved by the configuration item: CFGMDUEX
49
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
XPON_C HECK_PA SSWORD _REPEAT _SWITCH
Config uratio n Item Value
Description
1
Enables the TL1 offline predeployment function. A scheduling task is generated in the scheduling center when you run the CFG-MDUEX command, and TL1 commands are added to this task as subitems. After MDUs are powered on, TL1 commands are issued in sequence.
0
Indicates that the U2000 does not provide the function of detecting ONT authentication password (corresponding to PWD) conflicts.
1
Issue 01 (2018-03-05)
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
0
1
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
The values of the PWD parameter may be duplicate, which may affect current services.
Indicates that the U2000 provides the function of detecting ONT authentication password (corresponding to PWD) conflicts.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
Commands involved by the configuration item: ADD-ONT and MOD-ONT
50
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
XPON_C HECK_IA DIP_REP EAT_SWI TCH
0
Indicates that the U2000 does not provide the function of detecting voice IP address or Layer 3 interface IP address conflicts.
0
1
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
Ensure that the parameter is set to a unique value to avoid affecting provisioned services.
XPON_C HECK_O NTDOMA IN_REPE AT_SWIT CH
XPON_C HECK_P HONENU M_REPE AT_SWIT CH
Issue 01 (2018-03-05)
8 Setting Configuration Items
1
Indicates that the U2000 provides the function of detecting voice IP address or Layer 3 interface IP address conflicts.
0
Indicates that the U2000 does not provide the function of detecting domain name conflicts.
1
Indicates that the U2000 provides the function of detecting domain name conflicts.
0
Indicates that the U2000 does not provide the function of detecting telephone number (corresponding to SIPUSERNAME _N if SIP is used and corresponding to H248DN_N if H.248 is used) conflicts.
0
1
Commands involved by the configuration item: CFGONTVAINDIV and ADDVLANL3IF
Ensure that parameters are set to a unique value to avoid affecting provisioned services. Command involved by the configuration item: CFGONTVAINDIV
0
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
1
51
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
XPON_C HECK_M AC_REPE AT_SWIT CH
CMTS_C M_SNMP QUERYS WITCH
Issue 01 (2018-03-05)
Config uratio n Item Value
Description
1
Indicates that the U2000 provides the function of detecting telephone number (corresponding to SIPUSERNAME _N if SIP is used and corresponding to H248DN_N if H.248 is used) conflicts.
0
Indicates that the U2000 does not provide the function of detecting ONU MAC addresses conflicts.
1
Indicates that the U2000 provides the function of detecting ONU MAC addresses conflicts.
0
Indicates that some parameters are obtained from the cable modem termination system (CMTS) side, and is returned during periodic polling.
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
0
1
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
Commands involved by the configuration item: ADDEPONONT and MODEPONONT
0
0
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
Commands involved by the configuration item: LSTCMPNM-EQD and LSTCMPNM-SUB
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
52
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
TL1_USE ROPERL OG_SWIT CH
BMS_TL1 _NBI_IP NOTE Before using the configurat ion item, modify the ListenAll Ip configura tion item first.
Issue 01 (2018-03-05)
Config uratio n Item Value
Description
1
Indicates that some parameters are obtained from the CM side, and is returned in real time. The prerequisite is that the U2000 and CM are reachable to each other and the CM is online.
0
Indicates that user operation logs will not be recorded.
1
Indicates that user operation logs will be recorded.
default
If this configuration item is set to default, the listening IP address does not need to be set. At this moment, the listening IP address is the floating IP address, that is, the value of the floatServerName configruation item in oss\server\etc \conf \sysconfigure.xml .
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
1
1
Tl1NBi Dm
For details, see 22.11 Recording TL1 User Logs.
def aul t
def aul t
Tl1NBi Dm
For details, see 22.13 How to Set the IP Address Listening Range.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
53
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
IP address
l If this configuration item is set to a valid IP address, the TL1 NBI only listens to the messages sent from the IP address.
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
0
0
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
Command involved by the configuration item: CFGONTVAINDIV
l If this configuration item is set to an invalid IP address, the listening IP address is the floating IP address, that is, the value of the floatServerNa me configuration item in oss \server\etc \conf \sysconfigure. xml. XPON_S UPPORT_ LAN_IP_ CONFIG
Issue 01 (2018-03-05)
0
Indicates that the IP address segment of ONT LAN ports cannot be set.
1
Indicates that the IP address segment of ONT LAN ports can be set.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
54
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
NBI_CHE CK_RID_I NPUT_S WITCH
0
Indicates that the value of the RID parameter can be set to quotation marks except for two single quotation marks (''), such as one single quotation mark (') or three single quotation marks (''').
0
0
TL1N BiDm
Command involved by the configuration item: MODSERVICEPORT and CRTSERVICEPORT
OPERATI ON_MOD E
CMMORE INFO
Issue 01 (2018-03-05)
8 Setting Configuration Items
1
Indicates that the value of the RID parameter cannot be set to quotation marks except for two single quotation marks (''), such as one single quotation mark (') or three single quotation marks (''').
0
Indicates that the U2000 does not verify the NE SSH fingerprint.
1
Indicates that the U2000 verifies the NE SSH fingerprint.
0
Indicates that no other information is exported when the CM resources are exported through the NBI.
inTL1 NBiD m
0
0
-
Command involved by the configuration item: CFGDEVEX
0
0
TL1N BiDm
Command involved by the configuration item:DMPINVENTORY
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
55
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
1
Indicates that the DOC version is exported when the CM resources are exported through the NBI.
0
Default Output Parameter is: DID DEV FN FRAMENAME FRAMESTAT
1
Default Output Parameter is: DID DEV FN FRAMENAME FRAMESTAT FRAMELOCALN AME SHELF FRAMESUPPLIE R
XPONCO MMON_T HIRDON T_EQUIP MENT_F ORMAT
0
Returns CIGG as the terminal types of CIGG vendors' ONUs.
1
Returns the actual ONU types as the terminal types of CIGG vendors' ONUs.
TL1_MA X_SESSI ONCOUN T
15
Maximum number of concurrent logins allowed by the TL1 NBI.
TL1_IS_A DD_BASI CPROPER TY
Issue 01 (2018-03-05)
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
0
0
TL1N BiDm inTL1 NBiD m
Command involved by the configuration item: LSTFRAME
0
0
BmsAc cess TL1N BiDm inTL1 NBiD m
Command involved by the configuration item: LSTGPONONTAUT OFIND and LSTEPONONTAUT OFIND
15
15
TL1N BiDm
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
56
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Issue 01 (2018-03-05)
8 Setting Configuration Items
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
TL1_CHA RSET
AutoSe lect
Chinese environment uses the GBK encoding format. English environment uses the ISO-8859–1 encoding format. Other environments use the UTF-8 encoding format.
G B K
GB K
TL1N BiDm
-
UTF-8
Uses the UTF-8 encoding format.
ISO– 8859– 1
Uses the ISO-8859–1 encoding format.
GBK
Uses the GBK encoding format.
TL1_MA X_IP_CO NNECTIO N
15
Maximum number of connection established with a single IP address (value range: 1-1024).
15
15
TL1N BiDm
-
NBIFRA ME_LOGI N_FAIL_ COUNT_I NTERVAL
60
Login failure count interval (value range: 1-86400, unit: s).
60
60
TL1N BiDm
-
NBIFRA ME_MAX _ALLOW ED_LOGI N_FAILS
3
Maximum number of failed login attempts (value range: 1-10).
3
3
TL1N BiDm
-
NBIFRA ME_MAX _BLOCK_ TIME
180
Duration in the blacklist (value range: 1-86400, unit: s).
18 0
18 0
TL1N BiDm
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
57
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
XPON_S UPPORT_ TR069_O VER_GE NERIC
0
TR069 operation switch is disabled.
0
0
BmsAc cess
1
TR069 operation switch is enabled.
Command involved by the configuration item: GETONTTR069NOD EVALUE and SETONTTR069NOD EVALUE.
BMS_LST _DEV_CR TDATE_S HOW_G MT
0
Indicates GMT is not displayed in the CRTDATE parameter when querying the time that an NE is created.
0
0
TL1N BiDm
Command involved by the configuration item:LST-DEV
GPON_P WD_FOR MAT_IN_ DB
Issue 01 (2018-03-05)
8 Setting Configuration Items
1
Indicates GMT is displayed in the CRTDATE parameter when querying the time that an NE is created.
0
Indicates the storage format of the authentication password is HEX when the GPON ONT data is imported into the database.
1
Indicates the storage format of the authentication password is common when the GPON ONT data is imported into the database.
inTL1 NBiD m
0
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
0
BmsAc cess
Command involved by the configuration item:LSTFRAME and so on.
58
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Issue 01 (2018-03-05)
8 Setting Configuration Items
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
TL1_LIST ENPORT
9819
Indicates the port of the TL1NBiDm northbound service(default: 9819).
98 19
98 19
TL1N BiDm
-
TL1_IDL ETIME
600
Indicates the idle time of the TL1NBiDm northbound service(default: 600).
60 0
60 0
TL1N BiDm
-
BMS_DE V_QUER Y_SERVI CEPORT
0
Disables query data from NEs.
0
0
1
Enables query data from NEs.
BmsAc cess_* process (multip le instanc es involvi ng multipl e process es)
Command involved by the configuration item: DELSERVICEPORT
BUFFER_ CHECK_I NTERVAL
10
Indicates the Interval of TL1 buffer check time(unit:s).
10
10
TL1N BiDm
-
BUFFER_ EXCEED_ ALARM_ THRESH OLD
80
Indicates the value of TL1 buffer exceeds the alarm threshold(value range:0-100;unit: %).
80
inTL1 NBiD m
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
80
TL1N BiDm
-
inTL1 NBiD m
59
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
Config uratio n Item Value
Description
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
Remarks
BUFFER_ EXCEED_ CLEAR_T HRESHO LD
75
Indicates the value of TL1 buffer threshold exceeding alarm is cleared(value range:0-100;unit: %).
75
75
TL1N BiDm
-
NBI_INV ENTORY_ DUMP_A DSL_VDS L_POTS
0
Export ADSL/ VDSL/POTS Ports of common format.
0
0
TL1N BiDm
1
Export ADSL/ VDSL/POTS Ports of special format.
Command involved by the configuration item:DMPINVENTORY
BMS_LST ONTPOR T_SHOW _NNI
0
The output of the LST-ONTPORT command does not contain information about the NNI ports.
0
0
TL1N BiDm
Command involved by the configuration item:LSTONTPORT
XPON_O NU_NAM E_REPEA T_SWITC H
Issue 01 (2018-03-05)
8 Setting Configuration Items
1
The output of the LST-ONTPORT command contains information about the NNI ports.
0
Indicates the name of ONU can't be repeated.
inTL1 NBiD m
inTL1 NBiD m
0
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
0
BmsAc cess BmsCo mmon BmsTe st inTL1 NBiD m TL1N BiDm BmsPo nEmsT L1
Command involved by the configuration item:ADD-ONT ADDEPONONT MOD-ONT MODEPONONT
60
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configur ation Item
DEV_ER ROR_TOL ERANCE
Config uratio n Item Value
Description
1
Indicates the name of ONU can be repeated.
0
Tolerance switch for error of device is disabled.
1
8 Setting Configuration Items
De fa ult Va lu e
Re co m me nd ed Va lu e
Restar ting Proces ses
BmsPo nAlarm TL1 0
0
BmsAc cess BmsCo mmon
Tolerance switch for error of device is enabled.
inbxml soap_a gent TL1N BiDm inTL1 NBiD m
GPON_V ENDORI D_AUTO FIND_SW ITH
l
0
Returns 2011 as the VENDORID.
1
Returns HWTC as the VENDORID.
Remarks
0
0
TL1N BiDm,i nTL1N BiDm
Command involved by the configuration item:DELSERVICEPORT and so on. Configuration item TL1_TOLERAN CCE_ERRORwi ll not be available when DEV_ERROR_ TOLERANCEis enabled. Command involved by the configuration item: LSTGPONONTAUT OFIND
Configuration items of the BMSDB..bms_cfg_tab database TL1_LSTSERVICEPORT_PT is used as an example to describe how to set configuration items in the BMSDB..bms_cfg_tab database. a.
Run the following SQL statement to query the configuration item status: select CfgValue from BMSDB..bms_cfg_tab where CfgName = 'TL1_LSTSERVICEPORT_PT'
b.
If the value of TL1_LSTSERVICEPORT_PT is not 1, run the following SQL statement: update BMSDB..bms_cfg_tab set CfgValue = '1' where CfgName = 'TL1_LSTSERVICEPORT_PT'
c.
Run the following SQL statement to check whether the modification succeeds: select CfgValue from BMSDB..bms_cfg_tab where CfgName = 'TL1_LSTSERVICEPORT_PT'
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
61
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
8 Setting Configuration Items
d.
Log in to the System Monitor client and restart the TL1NBiDm process.
e.
Issue the command again and check whether the value of PT returned meets requirements.
Table 8-2 Configuration item description Configurat ion Item
Co nfi gur ati on Ite m Val ue
Description
Def ault Val ue
Rec om me nde d Val ue
Resta rting Proce sses
Remarks
PROTOCO L
0
Indicates that the U2000 and OSS use the TCP protocol to communicate with each other.
2
2
TL1N BiDm
For details, see 3.5 Security Mechanism.
2
Indicates that the U2000 and OSS use the SSL protocol to communicate with each other.
0
Indicates that an error message is displayed when a user runs the DELSERVICEPORT command to delete nonexistent service ports for the MA5600T, MA5680T, MA5603T V800R006C02 and later versions, MA5608T, MA5800 series,EA5800 series, and all MDUs.
1
1
-
For details, see 15.13.3 Deleting a Service Virtual Port (DELSERVICEPO RT). Configuration item TL1_TOLER ANCCE_ERR ORwill not be available when DEV_ERROR _TOLERANC Eis enabled.
NOTE This configuratio n item is supported only by the centralized system. For the Protocol configuratio n item in the distributed system, see 9.4 Setting Configurat ion Items.
TL1_TOLE RANCCE_ ERROR
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
62
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configurat ion Item
Issue 01 (2018-03-05)
Co nfi gur ati on Ite m Val ue
Description
1
Indicates that a success message is displayed when a user runs the DELSERVICEPORT command to delete nonexistent service ports for the MA5600T, MA5680T, MA5603T V800R006C02 and later versions, MA5608T, MA5800 series, EA5800 series, and all MDUs.
DUMP_MA X_FILE_SI ZE
20
DUMP_MA X_FILE_S AVE_NUM
UseRightPa raNameFor PotsState
8 Setting Configuration Items
Def ault Val ue
Rec om me nde d Val ue
Resta rting Proce sses
Remarks
Indicates the size of each exported file. The value indicates that the maximum size of each exported file is 20 MB.
20
20
20
Indicates the maximum number of files that can be saved. The value indicates that a maximum of 20 files can be exported.
20
20
BmsA ccess _* proce ss (multi ple instan ces involv ing multi ple proce sses)
Commands involved by the configuration item: DMPE2EPERF, DMPETHPERF, DMPONTPERF, and DMPPOTSPERF
0
Indicates that the original spelling format FAILEDREGISTRATTION is retained.
0
1
TL1N BiDm
1
Indicates that the correct spelling format FAILEDREGISTRATION is used.
Command involved by the configuration item: LSTONTPOTSST ATE
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
63
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Issue 01 (2018-03-05)
8 Setting Configuration Items
Configurat ion Item
Co nfi gur ati on Ite m Val ue
Description
Def ault Val ue
Rec om me nde d Val ue
Resta rting Proce sses
Remarks
IsSupportX MLSyn
0
Disables query of userdefined ONT parameters.
0
0
1
Enables query of userdefined ONT parameters.
BmsA ccess _* proce ss (multi ple instan ces involv ing multi ple proce sses)
Command involved by the configuration item:SYNONTXML
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
64
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
8 Setting Configuration Items
Configurat ion Item
Co nfi gur ati on Ite m Val ue
Description
Def ault Val ue
Rec om me nde d Val ue
Resta rting Proce sses
Remarks
TL1_LSTS ERVICEPO RT_PT
0
Indicates that the values of the output parameter PT of the LST-SERVICEPORT command are as follows:
0
0
TL1N BiDm
Command involved by the configuration item: LSTSERVICEPO RT
l LAN-ADSL l LAN-SHDSL l LAN-ATM l LAN-LAN l LAN-ETH l LAN-VDSL2 l LAN-GFAST l LAN-GPON l LAN-EPON l SPU-GPON l SPU-SPU l SPU-LAN l LAN-SPU l LAN-EPONONT LAN l LAN-GPONONT LAN l LAN-ONT IPHOST l LAN-ONT l LAN-GPONONT VDSL2 l UPLINKPORTETHER l UPLINKPORTLAN l UPLINKPORTGPON
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
65
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configurat ion Item
Co nfi gur ati on Ite m Val ue
Description
1
Indicates that the values of the output parameter PT of the LST-SERVICEPORT command are as follows:
8 Setting Configuration Items
Def ault Val ue
Rec om me nde d Val ue
Resta rting Proce sses
Remarks
1
0
reimpor t the memo ry table
For details, see 15.1.12 Modifying the Attributes of an ADSL Port (MODADSLPORT), 15.1.13 Modifying the Attributes of an ADSL Port Through the Enhanced Command (MODADSLPORTE X),15.2.11 Modifying the Attributes of an SHDSL
l ADSL l SHDSL l ATM l LAN l ETH l VDSL2 l GFAST l GPON l EPON l SPU l CNULAN l XPON NEED_REF RESH_WIN
Issue 01 (2018-03-05)
0
Indicates that the U2000 does not refresh aliases on the client after the aliases are modified through an NBI. You can query the aliases again to refresh them.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
66
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configurat ion Item
Issue 01 (2018-03-05)
Co nfi gur ati on Ite m Val ue
Description
1
Indicates that the U2000 refreshes aliases on the client after the aliases are modified through an NBI.
8 Setting Configuration Items
Def ault Val ue
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
Rec om me nde d Val ue
Resta rting Proce sses
Remarks
Port (MODSHDSLPORT) ,15.3.3 Modifying the Attributes of a VDSL2 Port (MODVDSL2PORT) or15.3.4 Modifying the Attributes of a VDSL2 Port Through the Enhanced Command (MODVDSL2PORT EX).
67
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
9 Distributed System
9
Distributed System
About This Chapter In a distributed U2000 system, the deployment modes, functions and features of NBIs differ from those in a centralized system. This topic mainly describes the TL1 NBI overview, list of unsupported commands, TL1 NBI gateway maintenance, and configuration item setting in a distributed system. 9.1 Overview This topic describes the position and installation mode, user creation, TL1 security certificate, and TL1 service maintenance of the NBI gateway in a distributed system. 9.2 List of Unsupported Commands This topic describes the list of commands that are not supported by the TL1 NBI in a distributed system. 9.3 Maintaining the TL1 NBI Gateway Service Among the northbound interface (NBI) gateways in a distributed system, the TL1 NBI gateway service cannot be maintained on the System Monitor client. Instead, it needs to be started or ended manually. 9.4 Setting Configuration Items
9.1 Overview This topic describes the position and installation mode, user creation, TL1 security certificate, and TL1 service maintenance of the NBI gateway in a distributed system.
Position of the NBI Gateway The OSS accesses the U2000 to manage networks through the NBI gateway. The NBI gateway needs to be independently installed on the U2000 server and is protected by using active and standby nodes. After one node is faulty, the other node is automatically connected.Figure 9-1 shows the position of the NBI gateway in a distributed U2000 system.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
68
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
9 Distributed System
Figure 9-1 Position of the NBI gateway
NBI Gateway Installation The installation of the NBI gateway is closely related to the installation of the U2000 in a distributed system. This guide by default considers that the NBI gateway has been installed and describes only the configuration procedure and parameters. For details about the software and hardware configurations and installation procedure of the NBI gateway, see the U2000 Distributed System User Guide.
NBI Gateway User The OSS can access the U2000 service only after passing the authentication of the NBI gateway. Therefore, you need to create a user for the NBI gateway, including the user name, password, and IP address. For details, see theU2000 Distributed System User Guide.
TL1 Security Certificate of the NBI Gateway The security certificate of the NBI gateway is used for secure communication with the OSS, EM, or NM. You can select the default security certificate or apply for and replace it with a new one.
Connection Limitation of the NBI Gateway The maximum number of NBI gateway connections is 200. Each EM has no connection limitation, and a maximum of 300 tasks are supported in a queue.
TL1 Service In a distributed system, the TL1 service is running on the NBI gateway, EM, and NM. The NBI gateway process is not running by default. You need to log in to the NBI gateway server Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
69
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
9 Distributed System
and start the gateway service manually. For details about how to check, start, and stop the NBI gateway service, see 9.3 Maintaining the TL1 NBI Gateway Service.
9.2 List of Unsupported Commands This topic describes the list of commands that are not supported by the TL1 NBI in a distributed system. Table 9-1 shows the list of commands that are not supported by the TL1 NBI in a distributed system. Table 9-1 List of unsupported commands Category
Command
Login/logout
Logging In to the U2000 (ACT-USER) Exiting the U2000 (CANC-USER)
Test bus
Capturing the Test Bus (TST-CONNECT) Releasing the Test Bus (TST-DISCEXT)
NE link
Querying an NE Link (LST-NELINK) Adding an NE Link (ADD-NELINK) Modifying an NE Link (MOD-NELINK) Deleting an NE Link (DEL-NELINK)
Global profile
Creating an ADSL Alarm Profile (CRTADSLALARMPROFILE) Creating an ADSL Extended Profile (CRTADSLEXTENDPROFILE) Creating an ADSL Line Profile (CRT-ADSLLINEPROFILE) Creating an IP Traffic Profile (CRT-IPTRAFFICPROFILE) Creating an MEF IP Traffic Profile (CRT-MEFIPTRAFFICPROFILE) Creating an SHDSL Alarm Profile (CRTSHDSLALARMPROFILE) Creating an SHDSL Line Profile (CRT-SHDSLSPANPROFILE) Creating an ATM Traffic Profile (CRT-TRAFFICPROFILE) Deleting an ADSL Alarm Profile (DELADSLALARMPROFILE) Deleting an ADSL Extended Profile (DELADSLEXTENDPROFILE) Deleting an ADSL Line Profile (DEL-ADSLLINEPROFILE)
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
70
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Category
9 Distributed System
Command Deleting an IP Traffic Profile (DEL-IPTRAFFICPROFILE) Deleting an MEF IP Traffic Profile (DEL-MEFIPTRAFFICPROFILE) Deleting an MGC Global Profile (DEL-MGCD) Deleting an SHDSL Alarm Profile (DELSHDSLALARMPROFILE) Deleting an SHDSL Line Profile (DEL-SHDSLSPANPROFILE) Deleting an ATM Traffic Profile (DEL-TRAFFICPROFILE)
Exporting files
Exporting Service Port Statistics to Files (DMP-E2EPREF) Exporting Ethernet Port Statistics to Files (DMP-ETHPREF) Exporting GPON ONT Online Status Statistical Files (DMPONTPERF) Exporting PON Port Statistics to Files (DMP-PONPERF) Exporting POTS Service Provisioning Statistical Files (DMPPOTSPERF)
NMS configuration management
Querying the U2000 Version (LST-BMSVERSION) Querying the NMS Information (LST-EMFSYSINFO)
9.3 Maintaining the TL1 NBI Gateway Service Among the northbound interface (NBI) gateways in a distributed system, the TL1 NBI gateway service cannot be maintained on the System Monitor client. Instead, it needs to be started or ended manually.
Prerequisites The TL1 NBI gateway has been installed. For details about the software and hardware configurations and installation procedure of the NBI gateway, see the U2000 Distributed System User Guide.
Context This operation applies only to starting or ending the TL1 NBI gateway among the NBI gateways in a distributed system. For details about how to start or end the TL1 service on the EM and NM in a centralized or distributed system, see 6.4 Starting the TL1 Process and 6.5 Stopping the TL1 Process.
Procedure l Issue 01 (2018-03-05)
End the TL1 NBI gateway service manually. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
71
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
a.
Log in to the OS as the ossuser user.
b.
Stop the TL1 NBI gateway service.
9 Distributed System
$ cd /opt/oss/server/bin $ svc_adm -cmd stopsvc TL1GW
c.
Wait for several seconds. If information similar to the following is displayed, the TL1 service is stopped: TL1GW...............................stopped ------------cost: 1(sec)-----------svc_adm : info : STOP finished.
l
Start the TL1 NBI gateway service manually. a.
Log in to the OS as the ossuser user.
b.
Start the TL1 NBI gateway service. $ cd /opt/oss/server/bin $ svc_adm -cmd startsvc TL1GW
c.
Wait for several seconds. If information similar to the following is displayed, the TL1 NBI gateway service is successfully started: TL1GW...............................running ------------cost: 2(sec)-----------svc_adm : info : START finished. NOTE
If the error message "Failed to connect to the monitorAgent" is displayed, run the following commands to start the NBI GW NMS service: $ cd /opt/oss/server/bin/ $ ./startnms.sh
If the following information is displayed, the NBI GW NMS service is successfully started: Start GW NMS Successfully!
----End
9.4 Setting Configuration Items In a distributed system, use the NBI command configuration tool to set the NBI gateway configuration items. For other configuration items, refer to the specific TL1 commands and set them on the U2000 NMS Maintenance Suite of the EM. The specific procedure for setting the NBI gateway configuration items is as follows: 1.
Log in to the OS as the root user.
2.
Start the NBI command configuration tool on the gateway node. # cd /opt/oss/server/combine_service/nbigw # . /opt/oss/server/svc_profile.sh # ./startup_nbiconfigtool.sh
3.
When the supported NBI types are displayed, enter 1 to select the common TL1 NBI and press Enter. **********Welcome*********** Please input which NBI config you need display or modify: [1]:CommonTL1 [2]:TelTL1 [3]:SoapXml [q]:Quit Enter your value: 1
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
72
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
9 Distributed System
NOTE
The meanings of the NBI types are as follows: l [1]: CommonTL1: Indicates the common TL1 NBI that uses port 9819. [1]:CommonTL1 must be selected. l [2]: TelTL1: Indicates the TL1 NBI that uses ports 13027 and 13028. l [3]: SoapXml: Indicates the XML NBI that complies with the customized MTOSI 1.1 standards.
4.
When all configuration items and their values are displayed, enter Y and press Enter if you need to modify them. **************Current Value**************** DumpVersion(2/3/4) :.2 DevMean(DevName/DevIP) :.DevName Protocol(TCP/SSL) :.TCP CharSet(UTF-8/ISO-8859-1/GBK) :.GBK ACL :Not Config ***************************************** Do you want to modify config?(Y/N) Y
Table 9-2 Configuration item description Configuration Item
Value
Description
Default Value
DevMean
DevName
This configuration item resides in TL1 commands and locates objects by device name.
DevName
DevIP
This configuration item resides in TL1 commands and locates objects by device IP.
TCP
The OSS communicates with the NBI gateway over TCP.
SSL
The OSS communicates with the NBI gateway over SSL.
GBK
The TL1 character encoding format is GBK.
UTF-8
The TL1 character encoding format is UTF-8.
ISO-8859-1
The TL1 character encoding format is ISO-8859-1.
2
If the DumpVersion configuration item is set to 2 (default value), you can export the list of inventory resources including devices, subracks, boards, ports and Ethernet aggregation groups of a specified type to a file.
Protocol
CharSet
DumpVersion
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
SSL
GBK
2
73
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Configuration Item
ACL
9 Distributed System
Value
Description
3
If the DumpVersion configuration item is set to 3, you can export the resource information about a specified device type, device, or resource type (device, subrack, board, daughter board, port, Ethernet aggregation group, BRA port, POTS port, ADSL port, VDSL port, ONT, service virtual port, VLANOFLAG, or Ethernet port) to a file.
4
If the DumpVersion configuration item is set to 4, you can export the resource information (device information, subrack, board, daughter board, port, ONT, splitter, link, or protection group) about a device or devices on the entire network to a file.
A single IP address or a certain IP address segment. The value is in the following format:
This configuration item indicates the access control list (ACL) of the TL1 NBI.
Default Value
NA
l A single IP address: 192.168 .10.1 l A certain IP address segment : 192.168 .10.1/24 or 0.0.0.0255.255 . 255.255
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
74
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
5.
9 Distributed System
Select the configuration items to be modified, for example, enter 2 and TCP and press Enter. Then the OSS connects to the NBI gateway over TCP. After the modification succeeds, the "Success!" message is displayed. Which item you need modify? [0] DumpVersion(2/3/4) [1] DevMean(DevName/DevIP) [2] Protocol(TCP/SSL) [3] CharSet(UTF-8/ISO-8859-1/GBK) [4] ACL Please enter which item you need modify:(example 1) 2 Enter your item value: TCP Success!
6.
Issue 01 (2018-03-05)
Restart the TL1 NBI gateway service.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
75
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
10
10 Command Format
Command Format
About This Chapter This topic describes the formats of the commands, responses, and resource change notifications. 10.1 Format Description This topic describes the functions of the TL1 NBI commands. 10.2 Command Format Description This topic describes the formats and parameters of the TL1 NBI commands. 10.3 Response Format Description This topic describes the parameters of the responses to the TL1 NBI commands. 10.4 Format Description of the Resource Change Notification This topic describes the format and parameters of the command for resource change notification of the TL1 NBI
10.1 Format Description This topic describes the functions of the TL1 NBI commands.
Command Format Command format refers to the format user enters for command request. The corresponding matching requirements on running certain commands are as following: l
Commands for operation: All the character strings match with each other precisely.
l
Commands for query: Perform a fuzzy query for the optional parameter of character string type. Perform a precise matching operation for the mandatory parameter with character strings of data type. If the filter criteria user entered identifies several records but cannot identify one record at one time, the NBI returns the records to the user in the form of a list.
l
Commands for the parameters of fixed value: The input and output can be in the form of either enumerated value or character string. The parameters can also be set through the
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
76
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
10 Command Format
configuration file. In this case, the methods for inputting and outputting must be the same.
Response Format Response format refers to the format of the response to the command. This format must be related to the corresponding compulsory command.
Format of the Resource Change Notification The Autonomous Message of TL1 is the notification message of the NBI. Autonomous Message is sent from the EMS to the upper-layer management system and need not be related to the corresponding compulsory commands. The Functions of the Autonomous Messages are as follows: l
Reports the alarming or non-alarming emergencies
l
Reports the scheduled test and diagnosis to NEs
l
Reports inspection data on performance specifications
l
Reports the change of the data in the NE database
l
Reports the preceding information regularly according to the selection criteria of the NE
Command Symbol Table 10-1 provides the description of command symbols enclosed in different formats. Table 10-1 Command symbol description Symbol
Description
<>
Encloses an identifier, for example,
indicates an integer type.
[]
Encloses an optional character or message.
()
Encloses a group of mandatory symbol and messages. NOTE If a field in a command format is not enclosed with any symbol, it indicates that the field is mandatory. For example, in the command format LOGIN:::CTAG::UN=user-name,PWD=password;, the UN=user-name and PWD=password fields are not enclosed with any symbol, it indicates that the UN and PWD parameters are mandatory.
Issue 01 (2018-03-05)
^
Refers to the Space character.
cr
Refers to the Enter character.
lf
Indicates to wrap to a new line.
|
Separates multiple options. Only one option can be selected, for example, the value a|b|c indicates that you can only select a, b, or c.
::=
Takes the left and right part of one grammar rule apart, for example, the value ::= (0|1|~|9) indicates that the value is any figure ranges from 0 to 9. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
77
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
10 Command Format
10.2 Command Format Description This topic describes the formats and parameters of the TL1 NBI commands.
Command Format :<staging_parameter_blocks>:<message_payload_block>; ::=[-<modifier>[-<modifiers>]] Staging Parameter Block::=[]:::
NOTICE If an optional parameter does not exist, do not omit the spacing character between this parameter and the one next to it. For example, if the does not exist, the ":" follows it must remain.
Parameter Description Table 10-2 describes the parameters of the TL1 command. Table 10-2 Parameters of the TL1 command Parameter
Description
command_code
Refers to the command code, and indicates what needs to be executed. l verb: a mandatory parameter and specifies the operations that the command executes. In U2000, it is defined as the name of the notice message l modifier: optional value in the verb parameter. There are two such values in the parameter and are separated by a hyphen (-) symbol.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
78
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Parameter
Description
staging_parameter_blo cks
Command parameter.
10 Command Format
l target identifier: not applicable in this case l access identifier: Is used for location l ctag (correlation tag): the symbol connecting the entered message and the response message; "ctag" can be any character other than a colon (:), semicolon (;) and comma (,) and must be consistent between the input message and the response message. NOTE The following characters are supported: l English letters: A-Z and a-z. l Numbers: 0-9. l Symbols: ( ) _ - + . / \ and space. Some commands allow single quotation marks '' in the Alias field or certain fields, indicating that they are left blank.
message_payload_blo ck
Refers to the main content of the message and is named pay-load; It can be either a null value or multiple data block in the format of: "((,)*)*". "Px" indicates a data item. Use a comma (,) to separate several data items. The format of the data item is shown as "=".
Example The LST-FRAME command is used as an example to describe the command format.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
79
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
10 Command Format
10.3 Response Format Description This topic describes the parameters of the responses to the TL1 NBI commands.
Format Description The formats of the responses are of the following two types: l
l
Format of the response to the operation command: –
–
header::=^^^<sid>^-<month>^:<minute>:<second>
–
response identification::=M^^^
–
text block::=(^^^<EN=error-code>^^^<ENDESC=error-description>) terminator::=(;|>)
Format of the response to the query command: –
–
header::=^^^<sid>^-<month>^:<minute>:<second>
–
response identification::=M^^^
–
text block::=(^^^<EN=error-code>^^^<ENDESC=error-description>) [( ^^^)]
–
quoted line::=^^^^^^< blktotal=total-count>
–
result::=(<->*)((()*))(<>*)
–
attribs::=(()*)
–
values::=(()*)
–
terminator::=(;|>)
Parameter Description Table 10-3 describes the parameters of the responses to the TL1 NBI commands. Table 10-3 Parameters of the responses to the TL1 NBI commands
Issue 01 (2018-03-05)
Parameter
Description
header
Indicates the header of the message, and is the common part of the responding message and automatic reported message. A header includes the device ID (sid), the date, and the time.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
80
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Parameter
Description
response identification
Indicates the response identifier.
10 Command Format
l ctag (correlation tag): the symbol connecting the entered message and the response message; "ctag" can be any character other than a colon (:), semicolon (;) and comma (,) and must be consistent between the input message and the response message. l completion code: functions as an ending identifier. text block
Indicates the body text of the responding message. l EN: error code. l ENDESC: error description. NOTE The ENDESC parameter (that is, the returned error description) in the response information may be optimized in later versions. Therefore, you are not advised to set the ENDESC parameter as the keyword for OSS matching.
l quoted line: return parameter. When the quantity of the querying information is too large, the NBI delivers the data to the client end in packets. "blktag" indicates the sequencing number of the current packet; "blkcount" indicates the amount of the data enclosed in the current packet; "blktotal" indicates the total amount of the data. l title: character string type, indicates the title of the response. l attrib: character string type, indicates the attribute name. l value: character string type, indicates the attribute value. -indicates that the current NE does not support this attribute or the attribute value is invalid. terminator
Refers to the ending identifier of the response, including ">"and ";".
Example The response information to the LST-FRAME command is used as an example to describe the response format.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
81
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
10 Command Format
10.4 Format Description of the Resource Change Notification This topic describes the format and parameters of the command for resource change notification of the TL1 NBI
Format of Resources Change Notification [] header::=^^^<sid>^-<month>-^:<minute>:<second> auto id::=^^^[^<modifier>[^<modifier>]] text block::=(^^^)|(^^^)| (^^^) terminator::=(;|>)
Parameter Description Table 10-4 describes the parameters required for the resource change notification. Table 10-4 Parameters required for the resource change notification
Issue 01 (2018-03-05)
Parameter
Description
header
Indicates the header of the message, and is the common part of the responding message and automatic reported message. A header includes the device ID (sid), date and time.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
82
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
10 Command Format
Parameter
Description
auto id
Indicates the level and state of automatic reported message. l almcde: indicates the severity different alarms, such as *C (Critical), ** (Major), * (Minor) and A (Warning). l atag: a correlation tag of the automatic reported message that must be consecutive and allocated by the NE. The atag parameter must be contained by each automatic reported message. The "atag" helps the upper-layer EMS to locate the cause of the automatic reported message and is used to indicate whether any error occurs while the upper-layer EMS receives the messages. l verb: a mandatory parameter and specifies the operations that the command executes. In U2000, "verb" defines the name of the message and includes two optional modifier values that are separated by a blank space. NOTE With regard to the message of resources change notification, the almcde parameter is A.
text block
Indicates the body text of the responding messages. l unquoted line: error code. In the notification, it is always "0". l quoted line: content of the message packets. It is used to deposit the notification. l comment: located between "/*" and "*/", and is used to explain a message.
terminator
Issue 01 (2018-03-05)
The ending identifier of the responding messages, including">"and";".
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
83
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
11
11 Supported Devices of the Same Series
Supported Devices of the Same Series
This topic describes devices that TL1 commands support. Because devices of the same series have the same features, the Device Type column in the following table lists only one type of device. Table 11-1 Device type parameters
Issue 01 (2018-03-05)
Device Type No.
Device Type
Device Types of the Same Series
Remarks
96
MA5620
MA5620A, MA5620B, and MA5620H
TL1 commands that apply to the MA5620 also apply to the MA5620A, MA5620B, and MA5620H.
97
MA5626
MA5626A, MA5626B, and MA5626H
TL1 commands that apply to the MA5626 also apply to the MA5626A, MA5626B, and MA5626H.
100
MA5616
MA5616A
TL1 commands that apply to the MA5616 also apply to the MA5616A.
104
MA5612
MA5612B
TL1 commands that apply to the MA5612 also apply to the MA5612B.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
84
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12
12 Controlling a Session and Performing Operations on a Device
Controlling a Session and Performing Operations on a Device
About This Chapter This topic provides the commands and examples for controlling a session and performing operations on a device. Session control is used to manage the socket connection between the access adaptation module and the U2000, thus providing protection against the unauthorized attackers on the network. It is recommended that you change the user ID and password regularly during the operation and maintenance of the system. 12.1 Controlling the Session This topic provides the commands and examples for controlling the session. 12.2 Performing Operations on a Device This topic provides the commands and examples for performing operations on a device. The operations include synchronizing the time, adding, deleting, and resetting a device or board, and adding a device alarm.
12.1 Controlling the Session This topic provides the commands and examples for controlling the session. Session control is used to manage the socket connection between the access adaptation module and the U2000, thus providing protection against the unauthorized attackers on the network. It is recommended that you change the user ID and password regularly during the operation and maintenance of the system.
12.1.1 Logging in to the U2000 (LOGIN) Usage Note When using the TL1 NBI function, make sure the OSS communicates with the U2000 using port 9819. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
85
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
This command is used to log in to the U2000 after a connection is successfully set up. If you log in to the TL1 NBI successfully, you can issue NBI commands to perform operations on the devices.
Command Format LOGIN:::CTAG::UN=user-name,PWD=password;
Input Parameter Parameter
Type
Range
Description
Default
UN
OCTET STRING
SIZE (20)
Indicates the user name.
-
PWD
OCTET STRING
SIZE (16)
Indicates the password.
-
NOTE
The default user name is admin(in the case of centralized deployment) or ssoadmin (in the case of distributed deployment). Both users' initial passwords are Changeme_123 . The password must be changed during the first login to ensure system security. Keep the password confidential and change it regularly.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code
Issue 01 (2018-03-05)
ID
Description
Solution
76546031
Invalid user name or password.
Enter the correct user name and password.
76545967
Invalid license.
Apply for a new license and update it.
2686058556
User relogin error.
Do not log in to the U2000 again because you have logged in.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
86
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
ID
Description
Solution
1618280737
The number of sessions exceeds the maximum limit. Contact the administrator.
Check the TL1 client that you have logged in to. If the upper limit is reached, modify the configuration item TL1_MAX_SESSIONCO UNT.
Example To log in to the U2000 by entering the user name tester and the password Changeme_321 after a connection is successfully set up between the server and the client, run the following command: LOGIN:::1::UN=tester,PWD=Changeme_321; The result is as follows:
M
0 2005-06-08 16:39:39 1 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.1.2 Logging In to the U2000 (ACT-USER) Usage Note This command is used to log in to the EMS. After you log in to the EMS successfully, the NMS can manage all the NEs in the EMS. If no operation is performed within 10 minutes, you will be logged out automatically. To prevent such a problem, you can run the SHAKEHAND:::CTAG::; command for handshaking to retain the connection. You can log in to the U2000 from the NMS with a user account that is created on the U2000 EMS client.
Command Format ACT-USER:[<TID>]::::;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
87
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Input Parameter Parameter
Type
Range
Description
Default
<TID>
OCTET STRING
SIZE (20)
Indicates the target identifier. The value of this parameter is null. TID is represented by two successive colons.
N/A
OCTET STRING
SIZE (16)
Indicates the existing user names in the EMS.
N/A
OCTET STRING
SIZE (16)
Indicates the user password.
N/A
NOTE
The default user name is admin(in the case of centralized deployment) or ssoadmin (in the case of distributed deployment). Both users' initial passwords are Changeme_123 . The password must be changed during the first login to ensure system security. Keep the password confidential and change it regularly.
Response Format l
Normal ^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf M^^ˆCOMPLD cr lf ;
l
Error ^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf M^^ˆDENY cr lf ^^^<errcode> ^^^/*<error description>*/ ;
Output Parameter None.
Error Code ID
Description
Solution
2686058556
User relogin error
Do not log in to the U2000 again because you have logged in.
Example To log in to the U2000 by entering the user name admin and the password Changeme_321, run the following command: Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
88
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
ACT-USER::admin:100::Changeme_321; The result is as follows: l
Normal M ;
l
N2000BMS 09-01-01 02:15:27 100 COMPLD
Error N2000BMS 09-01-01 02:49:08 M 100 DENY IDMS /*Invalid user name or password.*/ ;
Related Command There is no related command.
12.1.3 Exiting the U2000 (LOGOUT) Usage Note None.
Command Format LOGOUT:::CTAG::;
Input Parameter None.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To exit the U2000, run the following command: LOGOUT:::8::; The result is as follows: 0 2005-06-08 16:39:39
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
89
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide M
8 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.1.4 Exiting the U2000 (CANC-USER) Usage Note This command is used to log out of the EMS. A user cannot force another user to log out of the EMS.
Command Format CANC-USER:[<TID>]:[]:;
Input Parameter Parameter
Type
Range
Description
Default
<TID>
OCTET STRING
SIZE (20)
Indicates the target identifier. The value of this parameter is blank here. TID is represented by two successive colons.
N/A
OCTET STRING
SIZE (16)
Indicates the existing user names in the EMS.
N/A
NOTE
The default user name is admin(in the case of centralized deployment) or ssoadmin (in the case of distributed deployment). Both users' initial passwords are Changeme_123 . The password must be changed during the first login to ensure system security. Keep the password confidential and change it regularly.
Response Format l
Normal ^^^ M^^^^COMPLD ;
; l
Error ^^^ M^^^DENY ^^^<errcode>
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
90
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
^^^/*<error description>*/ ;
Output Parameter None.
Error Code ID
Description
Solution
989855937
User does not log in
Ensure that the entered user name is the same as the name of the current user that has logged in to the system.
Example To exit the U2000 by entering the user name admin, run the following command: CANC-USER::admin:100; The result is as follows: l
Normal M ;
l
N2000BMS 04-01-01 15:23:20 100 COMPLD
Error M
N2000BMS 04-01-01 14:30:00 100 DENY IDMS /*User does not log in*/
;
Related Command There is no related command.
12.1.5 Querying the U2000 Version (LST-BMSVERSION) Usage Note None.
Command Format LST-BMSVERSION:::CTAG::;
Input Parameter None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
91
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format It complies with the response format of the query command provided in 10.3 Response Format Description. title = "V" + Version + "R" + release version + "C" + customer version + "SP" + spVersion name of attributes: VERSION
Output Parameter Parameter
Type
Range
Description
VERSION
OCTET STRING
SIZE (252)
Indicates the U2000 version.
Error Code None.
Example To query the U2000 version, run the following command: LST-BMSVERSION:::1::; The result is as follows:
M
0 2005-12-11 17:14:14 1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
V200R017C60SPC200 -----------Version V200R017C60SPC200 -----------;
Related Command None.
12.1.6 Querying the NMS Information (LST-EMFSYSINFO) Usage Note None.
Command Format LST-EMFSYSINFO:::CTAG::;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
92
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Supporting Device None.
Response Format It complies with the response format of the query command provided in 10.3 Response Format Description. title=Information of EMS system name of attributes:ID NAME TYPE MANUFATCTURE IP INTERFACE MANUADDRESS OPERATESTATE SYSWARNSTATE MAXNECOUNT NECOUNT CREATOR CREATEDATE HARDWAREINFO SOFTWAREINFO CREATORADDRESS CREATORTEL REMARK VERSION
Output Parameter Param eter
Type
Range
Description
ID
INTEGER
1
Indicates the NMS ID from a vendor.
NAME
OCTET STRING
HUAWEIEMS
Indicates the NMS name from a vendor.
TYPE
OCTET STRING
EMS
Indicates the NMS type from a vendor.
MAN UFAT CTUR E
OCTET STRING
HUAWEI
Indicates the vendor name.
IP
OCTET STRING
SIZE (255)
Indicates the IP address and port number used for the communication between the NMS and the OSS. The format is "IP address:port number". For example, 10.71.210.219:9819.
INTER FACE
OCTET STRING
SIZE (255)
Indicates the NMS version from a vendor.
MAN UADD RESS
OCTET STRING
SIZE (255)
Indicates the location of the NMS server.
OPER ATEST ATE
OCTET STRING
normal
Indicates the running status of the NMS from a vendor.
SYSW ARNS TATE
OCTET STRING
Critical
Indicates the alarm status of the NMS from a vendor. The highest severity of alarm is returned.
Major Minor Warn none
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
93
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
MAX NECO UNT
OCTET STRING
SIZE (255)
Indicates the maximum NEs that the NMS from a vendor can manage.
NECO UNT
OCTET STRING
SIZE (255)
Indicates the number of NEs that the NMS from a vendor is managing.
CREA TOR
OCTET STRING
SIZE (255)
Indicates the ID of the installation engineer of the NMS.
CREA TEDA TE
OCTET STRING
SIZE (255)
Indicates the NMS installation date.
HARD WARE INFO
OCTET STRING
PC
Indicates the hardware information about the NMS server.
SOFT WARE INFO
OCTET STRING
WINDOWS
CREA TORA DDRE SS
OCTET STRING
SIZE (255)
Indicates the address of the NMS installation engineer.
CREA TORT EL
OCTET STRING
SIZE (255)
Indicates the telephone number of the NMS installation engineer.
REMA RK
OCTET STRING
SIZE (255)
Indicates the NMS remarks.
VERSI ON
OCTET STRING
SIZE (255)
Indicates the software version of the NMS from a vendor.
SUN
SOLARIS
Indicates the software information about the NMS server.
NOTE
You may use personal information of users when querying the NMS information. Therefore, you are obligated to take considerable measures, in compliance with the laws of the countries concerned and the user privacy policies of your company, to ensure that the personal data of users is fully protected.
Error Code None.
Example To query the information about the NMS from a vendor, run the following command: LST-EMFSYSINFO:::1::; Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
94
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
The result is as follows: 0 2010-12-13 12:11:24 M 1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1 Information of EMS system ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ID NAME TYPE MANUFATCTURE IP INTERFACE MANUADDRESS OPERATESTATE SYSWARNSTATE MAXNECOUNT NECOUNT CREATOR CREATEDATE HARDWAREINFO SOFTWAREINFO CREATORADDRESS CREATORTEL REMARK VERSION 1 HUAWEIEMS EMS HUAWEI 10.71.210.81:9819 V200R017C60SPC200 shenzhen normal none 15000 0.390625 huawei -- SUN SOLARIS shenzhen 400-830-2118 Remark V200R017C60SPC200 ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------;
Related Command None.
12.1.7 Handshaking (SHAKEHAND) Usage Note If the connection is idle within 10 minutes, the system automatically cancels the connection. To prevent such a problem, you can issue the command for handshaking to retain the connection without performing other operations.
Command Format SHAKEHAND:::CTAG::;
Input Parameter None.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
95
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Example To issue the command for handshaking to the system, run the following command: SHAKEHAND:::8::; The result is as follows: 0 2005-06-08 16:39:39 8 COMPLD EN=0 ENDESC=Succeeded.
M
;
Related Command None.
12.1.8 Handshaking (REPT-STAT) Usage Note If the test access session has been idle for 600 seconds, DISC-TACC will be automatically executed to release the test access port (TAP) and cancel the test session. Run this handshake command to retain the test session before the time (600 seconds) is out.
Command Format REPT-STAT:<TID>::;
Supporting Device Device Type No.
Device Type
94
MA5603U MA5603U V800R202C01 and later versions
Input Parameter
Issue 01 (2018-03-05)
Parame ter
Type
Range
Description
Default
TID
OCTET STRING
SIZE (128)
Indicates the default device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
96
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format l
Normal ^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf M^^ˆCOMPLD cr lf ;
l
Error ^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf M^^ˆDENY cr lf ^^^<errcode> ^^^/*<error description>*/ ;
Output Parameter None.
Error Code ID
Description
Solution
1611604226
The TAP does not exist.
The entered TAP number is different from the TAP number specified by the device. In this case, enter the specified TAP number and re-issue the CONNLPACC-MET command.
Example To issue the command for handshaking to the system, run the following command: REPT-STAT:10.71.59.79::CTAG; The result is as follows: l
Normal 7340116 11-01-30 11:08:37 M CTAG COMPLD ;
l
Error 7340116 11-01-30 11:06:55 M CTAG DENY IDMS /*The TAP does not exist*/ ;
Related Command l
CONN-LPACC-MET
l
DISC-TACC
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
97
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
12.2 Performing Operations on a Device This topic provides the commands and examples for performing operations on a device. The operations include synchronizing the time, adding, deleting, and resetting a device or board, and adding a device alarm. NOTE
If there is no description for the time format, the time of related commands is in UTC format by default.
12.2.1 Creating a Subnet (ADD-SUBNET) Usage Note This command is used to create a subnet on the U2000.
Command Format ADD-SUBNET::NAMESEQUENCE=sequence of subnet name:CTAG::[COMMENT=subnet-comment];
Supporting Device This command is used to perform operations on the U2000. Device type is not specified.
Input Parameter Parame ter
Type
Range
Description
Default
NAMES EQUEN CE
OCTET STRING
SIZE (1024)
Indicates the sequence of subnet names. Names of subnets in different layers are separated by backslash (\), for example, \HW\F4. In a distributed system, the parameter value is in the format of \EM subnet name on the NM \Subnet name sequence on the EM, for example, \EmSubmapem_184\H W\F4.
N/A
COMM ENT
OCTET STRING
SIZE (255)
Indicates the remarks for the subnet.
N/A
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
98
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Output Parameter None.
Error Code None.
Example To add a subnet named \HW\F4 with remarks abc, run the following command: ADD-SUBNET::NAMESEQUENCE=\HW\F4:2::COMMENT=abc; The result is as follows: M
0 2011-05-01 16:39:39 2 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.2.2 Modifying a Subnet (MOD-SUBNET) Usage Note This command is used to modify the name and remarks of a subnet on the U2000.
Command Format MOD-SUBNET::NAMESEQUENCE=sequence of subnet name:CTAG::[NAME=subnet name] [,COMMENT=subnet-comment];
Supporting Device This command is used to perform operations on the U2000. Device type is not specified.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
99
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Input Parameter Param eter
Type
Range
Description
Default
NAME SEQU ENCE
OCTET STRING
SIZE (1024)
Indicates the sequence of subnet names. Names of subnets in different layers are separated by backslash (\), for example, \HW\F4. In a distributed system, the parameter value is in the format of \EM subnet name on the NM\Subnet name sequence on the EM, for example, \EmSubmapem_184\H W\F4.
N/A
NAME
OCTET STRING
SIZE (128)
Indicates the name of the lowest level subnet. For example, F4 in \HW\F4 is the name of the lowest level subnet. Do not enter backslash (\) for this parameter.
N/A
COMM ENT
OCTET STRING
SIZE (255)
Indicates the remarks for the subnet.
N/A
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To modify the name of subnet \HW\F4 to \HW\F3, run the following command: MOD-SUBNET::NAMESEQUENCE=\HW\F4:2::NAME=F3,COMMENT=1234; The result is as follows: M
Issue 01 (2018-03-05)
0 2011-05-01 16:39:39 2 COMPLD
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
100
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide EN=0
12 Controlling a Session and Performing Operations on a Device
ENDESC=Succeeded.
;
Related Command None.
12.2.3 Deleting a Subnet (DEL-SUBNET) Usage Note This command is used to delete an empty subnet, which does not contain lower-level subnets or devices.
Command Format DEL-SUBNET::NAMESEQUENCE=sequence of subnet name:CTAG::;
Supporting Device This command is used to perform operations on the U2000. Device type is not specified.
Input Parameter Param eter
Type
Range
Description
Default
NAME SEQU ENCE
OCTET STRING
SIZE (1024)
Indicates the sequence of subnet names. Names of subnets in different layers are separated by backslash (\), for example, \HW\F4. In a distributed system, the parameter value is in the format of \EM subnet name on the NM\Subnet name sequence on the EM, for example, \EmSubmapem_184\H W\F4.
N/A
You can only delete the lowest level subnet. For example, if you enter \HW\F4 or F4, only subnet F4 is deleted.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
101
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Output Parameter None.
Error Code None.
Example To delete a subnet named F4, run the following command: DEL-SUBNET::NAMESEQUENCE=\HW\F4:2::; The result is as follows: 0 2011-05-01 16:39:39 2 COMPLD EN=0 ENDESC=Succeeded.
M ;
Related Command None.
12.2.4 Adding an NE Link (ADD-NELINK) Usage Note This command is used to add an NE link on the U2000. A source and a sink end must exist on the U2000.
Command Format ADD-NELINK::NAME=link-name,TYPE=link-type,SOURCEDEV=source device name[,SOURCEFN=source frame no.,SOURCESN=source slot no.,SOURCEPN=source port no.],SINKDEV=sink device name[,SINKFN=sink frame no.,SINKSN=sink slot no.,SINKPN=sink port no.]:CTAG::[NETTYPE=link network type][,COMMENT=link-comment] [,ALIAS=link-userlabel][,OWNER=link-owner];
Supporting Device This command is used to perform operations on the U2000. Device type is not specified.
Input Parameter
Issue 01 (2018-03-05)
Param eter
Type
Range
Description
Default
NAME
OCTET STRING
SIZE (128)
Indicates the name of the link.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
102
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Default
TYPE
OCTET STRING
IPLINK
Indicates the type of the link.
-
L2LINK
l IP link
VIRTUALL INK
l Layer 2 link l Virtual link NOTE The SOURCEFN, SOURCESN, SOURCEPN, SINKFN, SINKSN, and SINKPN parameters are mandatory if you set this parameter to IPLINK or L2LINK.
SOURC EDEV
OCTET STRING
SIZE (128)
Indicates the name of the source end.
-
SOURC EFN
Integer
0-255
Indicates the subrack ID of the source end.
-
SOURC ESN
Integer
0-35
Indicates the slot ID of the source end.
-
SOURC EPN
Integer
0-63
Indicates the port ID of the source end.
-
SINKD EV
OCTET STRING
SIZE (128)
Indicates the name of the sink end.
-
SINKF N
Integer
0-255
Indicates the subrack ID of the sink end.
-
SINKS N
Integer
0-35
Indicates the slot ID of the sink end.
-
SINKP N
Integer
0-63
Indicates the port ID of the sink end.
-
NETTY PE
OCTET STRING
IPV4
Indicates the network protocol type.
-
IPV6 DUALSTA CK
Issue 01 (2018-03-05)
COMM ENT
OCTET STRING
SIZE (64)
Indicates the remarks.
-
ALIAS
OCTET STRING
SIZE (64)
Indicates the alias of the link.
-
OWNE R
OCTET STRING
SIZE (64)
Indicates the owner of the link.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
103
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To add an NE link named link_name, run the following command: ADDNELINK::NAME=link_name,TYPE=L2LINK,SOURCEDEV=10.78.217.110,SOURCEF N=0,SOURCESN=5,SOURCEPN=1,SINKDEV=10.78.217.114,SINKFN=0,SINKSN=1,SI NKPN=1:CTAG::NETTYPE=IPV4,COMMENT=link_comment,ALIAS=link_alias,OW NER=link_owner; The result is as follows: M
0 2011-08-01 16:39:39 CTAG COMPLD EN=0 ENDESC=Succeeded.
Related Command None.
12.2.5 Modifying an NE Link (MOD-NELINK) Usage Note This command is used to modify information about an NE link on the U2000.
Command Format MOD-NELINK::[LINKID=link-id][,NAME=link-name]:CTAG::[MNAME=modified-link-name] [,NETTYPE=net-type][,COMMENT=link-comment][,ALIAS=link-userlabel][,OWNER=linkowner];
Supporting Device This command is used to perform operations on the U2000. Device type is not specified.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
104
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Input Parameter Param eter
Type
Range
Description
Default
LINKI D
OCTET STRING
SIZE(32)
Indicates the ID of the link.
-
NAME
OCTET STRING
SIZE(128)
Indicates the name of the link.
-
MNA ME
OCTET STRING
SIZE(128)
Indicates the name of a new link.
-
NETT YPE
OCTET STRING
IPV4
Indicates the network protocol type after modification.
-
IPV6 DUALSTAC K
COMM ENT
OCTET STRING
SIZE (64)
Indicates the new remarks.
-
ALIAS
OCTET STRING
SIZE (64)
Indicates the new alias of the link.
-
OWNE R
OCTET STRING
SIZE (64)
Indicates the new owner of the link.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To change the link name from link-name to link-new-name, run the following command: MOD-NELINK::NAME=link-name:2::MNAME=link-newname,NETTYPE=IPV6,COMMENT=new-comment,ALIAS=new-alias,OWNER=newowner; The result is as follows: M
Issue 01 (2018-03-05)
0 2011-05-01 16:39:39 2 COMPLD EN=0 ENDESC = Succeeded.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
105
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Related Command None.
12.2.6 Deleting an NE Link (DEL-NELINK) Usage Note This command is used to delete an NE link on the U2000.
Command Format DEL-NELINK::[LINKID=link-id][,NAME=link-name]:CTAG::;
Supporting Device This command is used to perform operations on the U2000. Device type is not specified.
Input Parameter Param eter
Type
Range
Description
Default
LINKI D
OCTET STRING
SIZE(32)
Indicates the ID of the link.
-
NAME
OCTET STRING
SIZE(128)
Indicates the name of the link.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To delete a subnet named F4, run the following command: DEL-NELINK::NAME=link-name:CTAG::; The result is as follows: M
Issue 01 (2018-03-05)
0 2011-08-01 16:39:39 CTAG COMPLD EN=0 ENDESC=Succeeded.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
106
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Related Command None.
12.2.7 Synchronizing the Time (SYNC-DEVTIME) Usage Note This command is used to synchronize the time of the specified device so that the system time of the device is the same as the system time of the U2000 server. The time returned by the command is in UTC mode.
Command Format SYNC-DEVTIME::(DID=Device-ID|DEV=Device-name|DT=Device-type):CTAG::;
Supporting Device Device Type No.
Device Type
34
MA5680T
44
MA5600V3
57
MA5606T
94
MA5603U
95
MA5603T
219
UA5000 (PVMV1)
253
UA5000 (IPMB)
249
MA5600T
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
107
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Parameter
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
DT
INTEGER
See Supporting Device.
Device Type.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description. title=" synchronize the time of the device "+device-name+" with the server" name of attributes:TIME
Output Parameter None.
Error Code ID
Description
Solution
2686058531
The device does not exist.
Check and ensure that the entered ID, name, and IP address of the device are correct.
Example To synchronize the time of the device 10.78.217.111 so that the system time of the device is the same as the system time of the U2000 server, run the following command: SYNC-DEVTIME::DEV=10.78.217.111:1::; The result is as follows: 0 2010-11-20 11:07:08
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
108
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
M
1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1 synchronize the time of the device 10.78.217.111 with the server --------TIME 2010-11-20 3:7:8:0 --------;
Related Command None.
12.2.8 Synchronizing NE Data (SYNC-DEV) Usage Note This command is used to synchronize the data of a specified NE to maintain the data consistency between the U2000 and the NE. The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be used as the location information. Before using these two parameters as the location information, make sure that the DEV parameter indicates the IP address of the device. For details, see 22.7 How to Locate a Device According to the IP Address.
Command Format SYNC-DEV::(DID=device-ID|DEV=device-name|(DEV=device-oltipaddress,ONULOCATEINFO=onu-locate-information))[,SRV=sync-service-name]:CTAG::;
Supporting Device For information about the supporting devices, see 23.1 Parameters Related to the Device Type.
Input Parameter
Issue 01 (2018-03-05)
Paramete r
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
109
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
If you set both the DEV and ONULOCATEINFO parameters for an ONU, that is, enter DEV=device-oltipaddress,ONULOCATEINF O=onu-locate-infomation, the DEV parameter indicates the IP address of the OLT. ONULOC ATEINFO
OCTET STRING
SIZE (128)
Indicates the ONU location information. This parameter is used with the DEV parameter (IP address of the OLT).
N/A
The format is subrack number/ slot ID/port ID/ONU ID. For example, 0/2/0/0 indicates the ONU 0 that is connected to port 0/2/0. SRV
OCTET STRING
l PHYRES l ADSL l VDSL
Indicates the types of services to be synchronized. Data of the entire NE is synchronized if this parameter is blank.
-
l ETH l SERVICE PORT l IGMP l PROTOC OL l VOIP l GPON l EPON
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
110
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Output Parameter None.
Error Code ID
Description
Solution
1610612773
Synchronizing. Please wait...
Wait until the synchronization is complete.
Example To synchronize the data of the NE 10.78.217.114, run the following command: SYNC-DEV::DEV=10.78.217.114:CTAG::; The result is as follows: M
7340071 2010-12-20 21:07:34 CTAG COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.2.9 Deleting a Device (DEL-DEV) Usage Note This command is used to delete only the device and empty submap. When deleting an empty submap, ensure that the submap name is unique.
Command Format DEL-DEV::(DID=Device-ID|SUBMAP=submapname|(DEV=Device-name[,DEVIP=deviceIP])):CTAG::;
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
219
UA5000 (PVM)
37
MA5662
44
MA5600V3
253
UA5000 (IPMB)
34
MA5680T
57
MA5606T Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
111
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Device Type No.
Device Type
249
MA5600T
61
MA5626E
62
MA5620E
64
MA5651
65
MA5620G
66
MA5626G
70
MA5610
92
MA5652G
94
MA5603U
95
MA5603T
96
MA5620
97
MA5626
100
MA5616
103
MA5635
104
MA5612
2312
MA5628
2319
MA5621
2313
MA5652
2317
MA5631
2318
MA5632
2321
MA5669
2331
MA5608T
2320
MA5612A
2322
MA5621A NOTE The MA5621A V800R311C00 and later versions support this command.
Issue 01 (2018-03-05)
2323
MA5622A (V800R311C00 and later versions)
2324
MA5623 (V800R311C00 and later versions)
2326
MA5623A (V800R311C01 and later versions)
2333
MA5698
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
112
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Device Type No.
Device Type
2335
MA5694
2336
MA5821
2364
EA5821
2337
MA5822
2338
MA5898
2339
MA5818
2340
MA5611S
2343
MA5694S
2348
MA5683T
2350
MA5811S
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
2354
EDFA3220-D
2368
EDFA3220-D2
Input Parameter
Issue 01 (2018-03-05)
Param eter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
113
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Default
SUBM AP
OCTET STRING
1-64
Indicates the sequence of subnet names. Names of subnets in different layers are separated by backslash (\), for example, \HW\F4. In a distributed system, the parameter value is in the format of \EM subnet name on the NM \Subnet name sequence on the EM, for example, \EmSubmapem_184\H W\F4.
-
DEVIP
IPADDRESS
-
(Optional) Indicates the IP address of the device.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
2686058531
The device does not exist.
Check and ensure that the entered parameters are correct.
Example To delete the device named 10.71.62.30, run the following command: DEL-DEV::DEV=10.71.62.30:119::; The result is as follows: M
7340034 2005-06-08 16:39:39 119 COMPLD EN=0 ENDESC=Succeeded.
;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
114
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Related Command None.
12.2.10 Resetting a Device (RESET-DEV) Usage Note
NOTICE l After a device is reset, all the boards of the device are reset. This results in temporary interruption of the services. l Save the data before resetting a device. Otherwise, the original data is lost. When the system is faulty or the software needs to be upgraded, run this command after the program package file and the matching database file are loaded.
Command Format RESET-DEV::(DID=Device-ID|DEV=Device-name):CTAG::;
Supporting Device Device Type No.
Device Type
34
MA5680T
37
MA5662
44
MA5600V3
57
MA5606T
94
MA5603U
95
MA5603T
219
UA5000(PVM)
249
MA5600T
2320
MA5612A
2322
MA5621A NOTE The MA5621A V800R311C00 and later versions support this command.
Issue 01 (2018-03-05)
253
UA5000(IPMB)
2331
MA5608T
2340
MA5611S Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
115
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
2348
MA5683T
2350
MA5811S
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter Paramete r
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code
Issue 01 (2018-03-05)
ID
Description
Solution
2686058531
The device does not exist.
Check and ensure that the entered ID, name, and IP address of the device are correct.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
116
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Example To reset the device named 10.71.62.30, run the following command: RESET-DEV::DEV=10.71.62.30:120::; The result is as follows: M
7340034 2005-06-08 16:39:39 120 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command SAVE-DEV
12.2.11 Resetting a Board (RESET-BOARD) Usage Note
NOTICE l If the control board is reset, the system is also reset. l If a board is reset, the related services are interrupted temporarily. Therefore, exercise caution when performing this operation. When the services of a board are abnormal or you need to locate test problems, run this command.
Command Format RESET-BOARD::(DID=Device-ID|DEV=Device-name),FN=frame-number,SN=slotnumber:CTAG::;
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
34
MA5680T
37
MA5662
44
MA5600V3
57
MA5606T
94
MA5603U
95
MA5603T
219
UA5000(PVM)
249
MA5600T Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
117
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
2320
MA5612A
2322
MA5621A NOTE The MA5621A V800R311C00 and later versions support this command.
253
UA5000(IPMB)
2331
MA5608T
2340
MA5611S
2348
MA5683T
2350
MA5811S
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Parameter
Type
Range
Description
Defaul t
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
SN
INTEGER
0-35
Indicates the slot ID.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
118
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
1615659120
The board is not supported this kind of function.
The board cannot be reset.
Example To reset the board in slot 0 of shelf 0 of the device named 10.71.62.30, run the following command: RESET-BOARD::DEV=10.71.62.30,FN=0,SN=0:121::; The result is as follows: 7340034 2005-06-08 16:39:39 M 121 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command RESET-DEV
12.2.12 Changing the Device Name and Alias (MOD-DEV) Usage Note This command is used to change device names and aliases displayed on the U2000.
Command Format MOD-DEV::(DID=Device-ID|DEV=Device-name):CTAG::[NAME=device-name][,ALIAS=devicealias];
Supporting Device For information about the supporting devices, see Table 23-1.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
119
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Input Parameter Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
N/A
DEV
OCTET STRING
SIZE (192)
Indicates the default device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
NAME
OCTET STRING
SIZE (32)
Indicates the default new device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
If you do not set this parameter, the device name does not change. ALIAS
OCTET STRING
SIZE (32)
Indicates the new device alias.
N/A
If you do not set this parameter, the device alias does not change.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
120
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format This response format complies with that of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
2686058531
The device does not exist.
Ensure that the entered ID, name, IP address, and alias of the device are correct.
Example To change the device name 10.71.62.41 to UAPVMV1 and the device alias to DevAlias, run the following command: MOD-DEV::DEV=10.71.62.41:1::NAME=UAPVMV1,ALIAS=DevAlias; The result is as follows: 7340032 2006-08-24 22:05:11 M 1 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command LST-DEV
12.2.13 Modifying the Shelf Name and Alias (MOD-FRAME) Usage Note None.
Command Format MOD-FRAME::(DID=Device-ID|DEV=Device-name),FN=frame-num:CTAG::[NAME=frame-name] [,ALIAS=frame-alias];
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
219
UA5000 (PVMV1)
253
UA5000 (IPMB) Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
121
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
249
MA5600T
94
MA5603U
95
MA5603T
34
MA5680T
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter Table 12-1 Parameters required for modifying the shelf name and alias
Issue 01 (2018-03-05)
Paramete r
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-512
Indicates the subrack ID.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
122
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
NAME
OCTET STRING
SIZE (32)
Indicates the new shelf name.
-
If you do not set this parameter, the shelf name does not change. ALIAS
OCTET STRING
SIZE (32)
Indicates the new shelf alias.
-
If you do not set this parameter, the shelf alias does not change.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
1613758569
The resource does not exist or its type is wrong.
Run the LST-FRAME command to obtain the subrack ID and ensure that the subrack ID is correct.
Example To modify the name of shelf 1 of the device named 10.71.62.41 to FRAME1 and the alias for the shelf to framealias, run the following command: MOD-FRAME::DEV=10.71.62.41,FN=1:1::NAME=FRAME1,ALIAS=framealias; The result is as follows: 7340032 2006-08-24 22:02:16 M 1 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command LST-FRAME Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
123
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12.2.14 Modifying the Slot Alias (MOD-SLOT) Usage Note A board must be inserted in the slot.
Command Format MOD-SLOT::(DID=Device-ID|DEV=Device-name),FN=frame-num,SN=slot-num:CTAG:: [ALIAS=slot-alias];
Supporting Device Device Type No.
Device Type
219
UA5000 (PVMV1)
253
UA5000 (IPMB)
249
MA5600T
94
MA5603U
95
MA5603T
34
MA5680T
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Param eter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
124
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
SN
INTEGER
0-35
Indicates the slot ID.
-
ALIAS
OCTET STRING
SIZE (32)
Indicates the new board alias.
-
If you do not set this parameter, the board alias does not change.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
125
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
1613758569
The resource does not exist or its type is wrong.
Run the LST-BOARD command to check whether the slot for the board exists.
Example To modify the alias for slot 8 in shelf 0 of the device named UAPVMV1 to slotalias, run the following command: MOD-SLOT::DEV=UAPVMV1,FN=0,SN=3:1::ALIAS=slotalias; The result is as follows: 7340033 2006-07-10 16:07:38 M 1 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command LST-BOARD
12.2.15 Exporting a Resource File (DMP-INVENTORY) Usage Note l
If the data volume is large, many system resources will be occupied by the command. In a centralized system, a maximum of three export tasks can be run concurrently by default. In a distributed system, only one export task is allowed at a time.
l
This command supports the export of XML and CSV resource files. For details about command usage, see Command Format.
l
When you export the resource file, the type of an MA5683T is related to the TL1_SHOW_MA5683T_SWITCH configuration item setting. For details about the meaning and setting method of the configuration item, see Table 8-1.
l
You can export different inventory resource types by setting the configuration item NBI_INVENTORY_DUMP_VERSION. In addition, the directory and format of the exported XML resource files are different. For details about the meaning and setting method of the configuration item in a centralized system, see Table 8-1. For details about the meaning and setting method of the configuration item in a distributed system, see 9.4 Setting Configuration Items. For details about the directory and format of the exported files, see Description of the directory and format of exported files.
l
You can specify whether to export the version information about the inventory resources by setting the configuration item CMMOREINFO.
l
You can export ADSL/VDSL/POTS Ports of special format by setting the configuration item NBI_INVENTORY_DUMP_ADSL_VDSL_POTS. For details about the meaning and setting method of the configuration item, see Table 8-1.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
126
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Command Format DMP-INVENTORY:::CTAG::[DT=device-type][,DEV=Device-name][,RES=resource-type] [,TYPE=CSV][,FILEPREFIX=file-prefix]; NOTE
l If you need to export XML resource files and NBI_INVENTORY_DUMP_VERSION is 2, the command format is DMP-INVENTORY:::CTAG::[DT=device-type]. l If you need to export XML resource files and NBI_INVENTORY_DUMP_VERSION is 3, the command format is DMP-INVENTORY:::CTAG::[DT=device-type][,DEV=Device-name] [,RES=resource-type]. l If you need to export XML resource files and NBI_INVENTORY_DUMP_VERSION is 4, the command format is DMP-INVENTORY:::CTAG::[DEV=Device-name]. l If you need to export CSV resource files, the command format is DMPINVENTORY:::CTAG::TYPE=CSV[,FILEPREFIX=file-prefix].
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
34
MA5680T
37
MA5662
44
MA5600V3
94
MA5603U
95
MA5603T
100
MA5616
219
UA5000(PVM)
249
MA5600T
253
UA5000(IPMB)
2330
MA5633
2331
MA5608T
2339
MA5818
2340
MA5611S
2326
MA5623A
2348
MA5683T
2350
MA5811S
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
127
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Input Parameter Param eter
Type
Range
Description
Defa ult
DT
Intege r
See Supporting Device.
Indicates the device type.
N/A
DEV
OCTE T STRI NG
SIZE (192)
Indicates the default device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
NOTE The resource information about a specified device can be exported to a file only when the NBI_INVENTORY_DUMP_VERSION configuration item is set to 3 or 4.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
128
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Defa ult
RES
OCTE T STRI NG
l ME
Indicates the resource type.
l SHELF
If you do not enter this parameter, data of all resource types is exported.
ME,S HELF, CARD ,DAU GTHE RCAR Dand PORT
l CARD l DAUGHT ERCARD
The options are as follows:
l PORT
l SHELF: subracks
l POTS
l CARD: boards
l BRA
l DAUGHTERCARD: daughter boards
l LAG
l PORT: ports
l ADSL
l POTS: PSTN users
l VDSL
l BRA: BRA ports
l ONT
l LAG: Ethernet aggregation groups
l SERVICE PORT
l ADSL: ADSL ports
l VLANOF LAG
l ONT: GPON ONT devices
l ETH l PORTOF VLAN l CABLEM ODEM l CMC
l ME: devices
l VDSL: VDSL ports l SERVICEPORT: service virtual ports l VLANOFLAG: Ethernet aggregation groups in a VLAN l ETH: Ethernet ports l PORTOFVLAN: List of ports in a VLAN l CABLEMODEM: CM terminal resources l CMC: CMC devices. Example: MA5633 NOTE l The resource information about a specified resource type can be exported to a file only when the NBI_INVENTORY_DUMP_VERSION parameter is set to 3. l This parameter can be set to one or more values at a time. l The LAG parameter is applicable only to the following devices: MA5600T, MA5680T, MA5662, MA5600 V300, MA5603U, MA5603T and UA5000 (IPMB). l The PORTOFVLAN parameter is applicable only to the following devices: MA5600T, MA5680T, MA5608T, MA5603U, MA5603T, MA5600V3, MA5662, MA5616, MA5611S, MA5623A and UA5000 (IPMB). l The CMC parameter is applicable only to the following devices: MA5600T, MA5603T, MA5608T, MA5680T and MA5633.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
129
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Defa ult
TYPE
OCTE T STRI NG
CSV
Indicates the format of the exported file.
N/A
This parameter is exclusive to the DT, DEV, and RES parameters. After this parameter is set, multiple CSV files will be exported based on the resource types, including the following five types: l container_info_yyyy-mm-dd_hh-mmss.csv: device information file l shelf_info_yyyy-mm-dd_hh-mm-ss.csv: subrack information file l slot_info_yyyy-mm-dd_hh-mm-ss.csv: slot information file l port_info_yyyy-mm-dd_hh-mm-ss.csv: port information file l service_port_yyyy-mm-dd_hh-mm-ss.csv: logic information file If the size of a CSV file exceeds 100 MB, another CSV file will be created. If multiple CSV files are created, they are named in the format port_info_yyyy-mm-dd_hh-mmss_n_m.csv, where n indicates the file serial number and m indicates the total number of files. If the size of data on ports is 260 MB, three CSV files are generated and named as follows: l port_info_2010-12-28_02-02-05_1_3.csv (100 MB) l port_info_2010-12-28_02-02-05_2_3.csv (100 MB) l port_info_2010-12-28_02-02-05_3_3.csv (60 MB) In addition, you can enter a prefix in the file name. Use a device data file as an example. If the FILEPREFIX parameter is set to ftth, the file name changes to ftth_container_info_yyyy-mm-dd_hh-mmss.csv.
FILEP REFIX
Issue 01 (2018-03-05)
OCTE T STRI NG
SIZE (32)
Indicates the file prefix. This parameter is available only when the TYPE parameter is set to CSV. Use a device data file as an example. If the FILEPREFIX parameter is set to ftth, the file name changes to ftth_container_info_yyyy-mm-dd_hh-mmss.csv.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
N/A
130
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format This response format complies with that of the operation command provided in 10.3 Response Format Description. title=" Path information of the device-type "+device-type name of attributes:PATH
Output Parameter Parameter
Type
Range
Description
PATH
OCTET STRING
SIZE (255)
Indicates the path of the resource file.
Description of the directory and format of exported files: In a distributed system, multiple resource files are exported to the oss\server\var\dump\tl1 directory on the NM. In a centralized system, the export directory of resource files varies with the value of the configuration item NBI_INVENTORY_DUMP_VERSION. In distributed and centralized systems, the format of exported files also varies with the value of the configuration item. l
NBI_INVENTORY_DUMP_VERSION=2 (default value): The export directory of resource files is oss\server\nemgr\nemgr_access\conf\bmscommon\resxml. The format of exported files is as follows:
l
NBI_INVENTORY_DUMP_VERSION=3: The export directory of resource files is oss\server\nemgr\nemgr_access\dump\. The format of exported files is as follows:
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
131
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
l
12 Controlling a Session and Performing Operations on a Device
NBI_INVENTORY_DUMP_VERSION=4: The export directory of resource files is oss\server\nemgr\nemgr_access\dump_xml\. The format of exported files is as follows:
Error Code None.
Example l
In a centralized system –
(NBI_INVENTORY_DUMP_VERSION=2) Example 1: To export the resource file of all the MA5680T, run the following command: DMP-INVENTORY:::CTAG::DT=34; The result is as follows: M
Issue 01 (2018-03-05)
0 2011-06-13 15:09:20 CTAG COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
132
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
blktotal=1 Path information of the device-type MA5680T --------PATH server : d:\oss\server\nemgr\nemgr_access\conf\bmscommon\resxml \ofa5920v3_2011-06-13_07-09-16.xml --------;
–
(NBI_INVENTORY_DUMP_VERSION=3) Example 2: To export the resource file of ONTs on the device named 10.78.217.114, run the following command: DMP-INVENTORY:::CTAG::DT=34,DEV=10.78.217.114,RES=ONT; The result is as follows: M
0 2011-06-13 15:13:46 CTAG COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
Path information of the device-type MA5680T --------PATH server : d:\oss\server\nemgr\nemgr_access\dump\MA5680T_10.78.217.114.xml --------;
–
(NBI_INVENTORY_DUMP_VERSION=4) Example 3: To export the resource file of the device named 10.78.217.114, run the following command: DMP-INVENTORY:::CTAG::DEV=10.78.217.114; The result is as follows: M
0 2011-06-13 15:13:46 CTAG COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
Path information of all device-type --------PATH server : d:\oss\server\nemgr\nemgr_access\dump_xml \10.70.35.236_MA5680T_7340034_20110613074004.xml --------;
l
In a distributed system (NBI_INVENTORY_DUMP_VERSION=2) Example 4: To export the resource file of all the MA5680T, run the following command: DMP-INVENTORY:::CTAG::DT=34; The result is as follows: M
Issue 01 (2018-03-05)
0 2014-06-28 22:05:03 CTAG COMPLD EN=0 ENDESC=Succeeded. blktag=1
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
133
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
blkcount=2 blktotal=2 Path information of the device-type MA5680T --------PATH server : /opt/oss/server/var/dump/tl1/em_168_MA5680T_2014-06-28_14-05-0.xml server : /opt/oss/server/var/dump/tl1/em_ccx_MA5680T_2014-06-28_06-09-0.xml ---------
;
Related Command There is no related command.
12.2.16 Exporting Service Port Statistics to Files (DMP-E2EPERF) Usage Note The configuration item DUMP_MAX_FILE_SIZE controls the size of each file, and DUMP_MAX_FILE_SAVE_NUM controls the maximum number of files. For details about the meaning and setting method of the configuration item, see Table 8-2.
Command Format DMP-E2EPERF:::CTAG::DT=device-type[,DEV=Device-name];
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
249
MA5600T
30
MA5605
34
MA5680T
37
MA5662
44
MA5600V3
71
MA5105
72
MA5100V2
74
MA5300V1
95
MA5603T
82
UA5000
86
MA5100V1
92
MA5652G
94
MA5603U Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
134
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
96
MA5620
97
MA5626
100
MA5616
103
MA5635
104
MA5612
232
MA5680T
2331
MA5608T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter Paramet er
Type
Range
Description
Default
DT
INTEGER
See Supporting Device.
Indicates the device type.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name.If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
Response Format It complies with the response format of the query command provided in 10.3 Response Format Description. title="Path information of the device-type "+device-type name of attributes: PATH
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
135
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Output Parameter Parameter
Type
Range
Description
PATH
OCTET STRING
SIZE (255)
Indicates the prefix of the file path. The file name is similar to e2e_MA5600T_2013-10-17_23-1 4-09_n_m.csv, where n indicates the sequence number of a file and m indicates the total number of files.
Error Code ID
Description
Solution
1615003650
Incorrect parameter input.
Set DT to a supported value.
Example Export the service port statistics of an MA5600T to files. l
Run the following command: DMP-E2EPERF:::1::DT=249;
l
The result is as follows: M
-1 2013-10-17 23:14:24 1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
Path information of the device-type MA5600T --------PATH server : d:/oss/server/var/access/dumpperf/e2e_MA5600T_2013-10-17_23-14-09 --------;
Related Command None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
136
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
12.2.17 Exporting Ethernet Port Statistics to Files (DMPETHPERF) Usage Note The configuration item DUMP_MAX_FILE_SIZE controls the size of each file, and DUMP_MAX_FILE_SAVE_NUM controls the maximum number of files. For details about the meaning and setting method of the configuration item, see Table 8-2.
Command Format DMP-ETHPERF:::CTAG::DT=device-type[,DEV=Device-name];
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
249
MA5600T
30
MA5605
34
MA5680T
37
MA5662
44
MA5600V3
71
MA5105
72
MA5100V2
74
MA5300V1
95
MA5603T
82
UA5000
86
MA5100V1
92
MA5652G
94
MA5603U
96
MA5620
97
MA5626
100
MA5616
103
MA5635
104
MA5612
232
MA5680T
2331
MA5608T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
137
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter Paramet er
Type
Range
Description
Default
DT
INTEGER
See Supporting Device.
Indicates the device type.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name.If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
Response Format It complies with the response format of the query command provided in 10.3 Response Format Description. title="Path information of the device-type "+device-type name of attributes: PATH
Output Parameter
Issue 01 (2018-03-05)
Parameter
Type
Range
Description
PATH
OCTET STRING
SIZE (255)
Indicates the prefix of the file path. The file name is similar to eth_MA5600T_2013-10-17_23-1 4-09_n_m.csv, where n indicates the sequence number of a file and m indicates the total number of files.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
138
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Error Code ID
Description
Solution
1615003650
Incorrect parameter input.
Set DT to a supported value.
Example Export the Ethernet port statistics of an MA5600T to files. l
Run the following command: DMP-ETHPERF:::1::DT=249;
l
The result is as follows: M
-1 2013-10-17 23:14:24 1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
Path information of the device-type MA5600T --------PATH server : d:/oss/server/var/access/dumpperf/eth_MA5600T_2013-10-17_23-14-09 --------;
Related Command None.
12.2.18 Exporting PON Port Statistics to Files (DMP-PONPERF) Usage Note The size of the file to be exported cannot succeed 100 MB.
Command Format DMP-PONPERF:::CTAG::DT=device-type[,DEV=Device-name];
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
249
MA5600T
30
MA5605
34
MA5680T
37
MA5662 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
139
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
44
MA5600V3
71
MA5105
72
MA5100V2
74
MA5300V1
95
MA5603T
82
UA5000
86
MA5100V1
92
MA5652G
94
MA5603U
96
MA5620
97
MA5626
100
MA5616
103
MA5635
104
MA5612
232
MA5680T
2331
MA5608T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Paramet er
Type
Range
Description
Default
DT
INTEGER
See Supporting Device.
Indicates the device type.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
140
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramet er
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name.If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
Response Format It complies with the response format of the query command provided in 10.3 Response Format Description. title="Path information of the device-type "+device-type name of attributes: PATH
Output Parameter Parameter
Type
Range
Description
PATH
OCTET STRING
SIZE (255)
Indicates the prefix of the file path. The file name is similar to pon_MA5600T_2013-10-17_2314-09_n_m.csv, where n indicates the sequence number of a file and m indicates the total number of files. NOTE If only one file exists, n and m are not set. For example, pon_MA5600T_2014-03-31_16-1930.CSV.
Error Code
Issue 01 (2018-03-05)
ID
Description
Solution
2686058554
Command does not support this device type
Set DT to a supported value.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
141
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Example Export the Ethernet port statistics of an MA5600T to files. l
Run the following command: DMP-PONPERF:::CTAG::DT=249;
l
The result is as follows: M
-1 2013-10-17 23:14:24 CTAG COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
Path information of the device-type MA5600T --------PATH server : d:/oss/server/var/access/dumpperf/pon_MA5600T_2013-10-17_23-14-09.csv --------;
Related Command None.
12.2.19 Adding a Device (ADD-DEV) Usage Note l
This command is used to add new devices to the subnets on the U2000.
l
The SNMP parameters on the U2000 must be the same as the SNMP parameters on the device. For example, the protocol versions must be the same. Using SNMPv3 is recommended because of its higher security than SNMPv1 and SNMPv2c.
l
The IP addresses of the devices on the U2000 must be different.
l
Ensure that the SNMP parameter profile has been created. Choose Administration > NE Communicate Parameter > Default Access Protocol Parameters (traditional style) from the main menu or select Fix-Network NE Configuration in Application Center and choose Administration > NE Communicate Parameter > Default Access Protocol Parameters (application style) from the main menu. In the dialog box that is displayed, create an SNMP Profile according to the different SNMP version.
Command Format ADD-DEV::DEV=Device-name[,DT=deviceType],DEVIP=device-IP:CTAG:: [NAMESEQUENCE=Sequence of subnet name][,SNMPPROF=parameter profile of snmp] [,SNMPVER=Snmp-Version];
Supporting Device Device Type No. 37
Device Type MA5662 NOTE The MA5662 V800R309C00 and later versions support this command.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
142
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Device Type No.
Device Type
100
MA5616 MA5616 V800R308C00 and later versions
104
MA5612
253
UA5000 (IPMB)
34
MA5680T
94
MA5603U
95
MA5603T
2319
MA5621 NOTE The MA5621 V800R309C00 and later versions support this command.
2313
MA5652 NOTE The MA5652 V800R309C00 and later versions support this command.
2320
MA5612A
2322
MA5621A NOTE The MA5621A V800R311C00 and later versions support this command.
Issue 01 (2018-03-05)
2323
MA5622A (V800R311C00 and later versions)
2324
MA5623 (V800R311C00 and later versions)
249
MA5600T
2331
MA5608T
2339
MA5818
2343
MA5694S
2340
MA5611S
2348
MA5683T
2350
MA5811S
2351
MA5878
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
2354
EDFA3220-D
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
143
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
2561
Third-Party SNMP Device
2562
Third-Party ICMP Device
2368
EDFA3220-D2
Input Parameter Para mete r
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
DT
Integer
See Supporting Device.
Indicates the device type.
-
Indicates the IP address of the device.
-
NOTE To view the MDU type that supports decoupling, see the value of the typeid parameter in the oss\server \nemgr \nemgr_access \dcp\pnp \product\device type\device type.xml file.
DEV IP
Issue 01 (2018-03-05)
IPADDR ESS
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
144
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Para mete r
Type
Range
Description
Default
NAM ESE QUE NCE
OCTET STRING
SIZE (1024)
Indicates the sequence of subnet names. Names of subnets in different layers are separated by backslash (\), for example, \HW \F4. In a distributed system, the parameter value is in the format of \EM subnet name on the NM\Subnet name sequence on the EM, for example, \EmSubmapem_184\HW\F4.
-
If the subnet exists, add the new device to the subnet. Otherwise, create a subnet and add the new device to the subnet. SNM PPR OF
OCTET STRING
SIZE (64)
Indicates the name of the SNMP parameter profile.
-
SNM PVE R
OCTET STRING
l V1(v1)
Indicates the SNMP protocol. It must be the same as that on the device.Using SNMPv3 is recommended because of its higher security than SNMPv1 and SNMPv2c. The meanings of the options are as follows:
-
l V2(v2) l V3(v3)
l V1(v1): Indicates the SNMP V1 protocol. l V2(v2): Indicates the SNMP V2c protocol. l V3(v3): Indicates the SNMP V3 protocol. NOTE Using SNMPv3 is recommended because of its higher security than SNMPv1 and SNMPv2c. The value of this parameter is case insensitive. For example, to use the SNMP V1 protocol, you can enter either V1 or v1.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
145
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
NOTE
l The DEV parameter is mandatory. l The DT parameter is mandatory. l The SNMPPROF parameter (SNMP profile) is optional. If this parameter is not set, the default SNMP profile is used. l The SNMPVER parameter is optional. If this parameter is not set, the SNMP V1 protocol is used by default.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
67108590
The same name sub map has existed.
Modify the device name in the command and ensure that the device name is unique.
1613758516
Device already exists
Change the IP address of the required device.
Example To add a UA5000 (IPMB) that uses the default SNMP profile and whose name and IP address are UA5000IPMB and 10.71.56.153 respectively, run the following command: ADD-DEV::DEV=UA5000IPMB,DT=253,DEVIP=10.71.56.153:2::; The result is as follows: M
7340034 2005-06-08 16:39:39 2 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.2.20 Adding a Board (ADD-BOARD) Usage Note A board can be added successfully only when the slot for the board is idle. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
146
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Command Format ADD-BOARD::(DID=Device-ID|DEV=Devicename),FN=FrameID,SN=SlotID:CTAG::BTDETAIL=BoardType[,SLOTNAME=BoardName];
Supporting Device Device Type No.
Device Type
34
MA5680T
44
MA5600V3
94
MA5603U
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
147
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Parameter
Type
Range
Description
Default
SN
INTEGER
0-35
Indicates the slot ID.
-
BTDETAIL
OCTET STRING
SIZE(48)
Indicates the type of the board.
-
NOTE In order to know the types of board that available for device, please refer to the chapter of board in the corresponding NE product documentation.
SLOTNAME
OCTET STRING
SIZE (32)
Indicates the alias of the board.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
2689009240
A board has already existed
Check whether the configuration data of the board needs to be deleted. Then, run the DELBOARD command to delete the board and add the required board.
Example To add a board named H801GPBC to slot 4 in shelf 0 of the device named 10.71.62.48, run the following command: Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
148
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
ADDBOARD::DEV=10.71.62.48,FN=0,SN=4:120::BTDETAIL=H801GPBC,SLOTNAME=H 801GPBC; The result is as follows: M
7340034 2005-06-08 16:39:39 120 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command DEL-BOARD
12.2.21 Deleting a Board (DEL-BOARD) Usage Note
NOTICE This operation is not retrievable. Exercise caution when running the command, because the data of the board is cleared after this command is executed. l
Only the board that is not configured with service data can be deleted successfully.
l
The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be used as the location information. Before using these two parameters as the location information, make sure that the DEV parameter indicates the IP address of the device. For details, see 22.7 How to Locate a Device According to the IP Address.
Command Format DEL-BOARD::(DID=Device-ID|DEV=Device-name|(DEV=device-oltipaddress,ONULOCATEINFO=onu-locate-infomation)),FN=FrameID,SN=SlotID:CTAG::;
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
44
MA5600V3
34
MA5680T
94
MA5603U
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
149
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Input Parameter Param eter
Type
Range
Description
Default
DID
INTEGE R
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
If you set both the DEV and ONULOCATEINFO parameters for an ONU, that is, enter DEV=device-oltipaddress,ONULOCATEINFO=o nu-locate-infomation, the DEV parameter indicates the IP address of the OLT. ONUL OCAT EINFO
OCTET STRING
SIZE (128)
Indicates the ONU location information. This parameter is used with the DEV parameter (IP address of the OLT).
-
The format is subrack ID/slot ID/ port ID/ONU ID. For example, 0/2/0/0 indicates the ONU 0 that is connected to port slot 0/2/0. FN
INTEGE R
0-255
Indicates the subrack ID.
-
SN
INTEGE R
0-35
Indicates the slot ID.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
150
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
2686058554
Command does not support this device type
Run the LST-DEV command to check whether the entered device type is MA5600V3, MA5680T or MA5603U..
2689009257
Deleting board failure, as service connections or correlative data (for example, dissociative VL, CES channel, FR iwf) exists
Delete the corresponding service configuration and then delete the board again.
Example To delete the board in slot 4 of shelf 0 of the device named 10.71.62.48, run the following command: DEL-BOARD::DEV=10.71.62.48,FN=0,SN=4:120::; The result is as follows: 7340034 2005-06-08 16:39:39 120 COMPLD EN=0 ENDESC=Succeeded.
M ;
Related Command None.
12.2.22 Disabling a Board (DISABLE-BOARD) Usage Note l
The DISABLE-BOARD command is applicable only to the board that is enabled.
l
The DISABLE-BOARD command is not applicable to the board that is automatically discovered.
l
The DISABLE-BOARD command is not applicable to the control board.
Command Format DISABLE-BOARD::(DID=Device-ID|DEV=Device-name),FN=frame-number,SN=slotnumber:CTAG::;
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
44
MA5600V3 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
151
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
94
MA5603U
Input Parameter Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
SN
INTEGER
0-35
Indicates the slot ID.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
152
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
2686058498
Missing, invalid parameter or mandatory parameter is null, or Value of parameter is wrong
Check and ensure that the entered parameters are correct.
2686058554
Command does not support this device type
Run the LST-DEV command to check whether the entered device type is MA5600V3.
2686058531
The device does not exist.
The device does not exist. Check and ensure that the IP address of the required device is correct.
Example To disable the board in slot 0 of shelf 0 of the device named 10.71.62.30, run the following command: DISABLE-BOARD::DEV=10.71.62.30,FN=0,SN=0:121::; The result is as follows: 7340034 2005-06-08 16:39:39 M 121 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command l
LST-DEV
l
LST-BOARD
l
ENABLE-BOARD
12.2.23 Enabling a Board (ENABLE-BOARD) Usage Note l
This command cannot be executed on the control board.
l
Only the board that is disabled or configured can be enabled.
Command Format ENABLE-BOARD::(DID=Device-ID|DEV=Device-name),FN=frame-number,SN=slotnumber:CTAG::;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
153
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Supporting Device Device Type No.
Device Type
44
MA5600V3
94
MA5603U
Input Parameter Table 12-2 Parameters required for enabling a board Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
SN
INTEGER
0-35
Indicates the slot ID.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
154
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
2686058554
Command does not support this device type
Run the LST-DEV command to check whether the entered device type is MA5600V3.
2688746400
Board not prohibited and cannot be enabled
Run the LST-BOARD command to check whether the board is disabled. Only the disabled board can be enabled.
2688746402
Cannot prohibit or rescue main board
-
2688746483
The board has not been configured
Run the LST-BOARD command to check whether the board is configured.
Example To enable the board in slot 0 of shelf 0 of the device named 10.71.62.30, run the following command: ENABLE-BOARD::DEV=10.71.62.30,FN=0,SN=0:121::; The result is as follows:
M
234567 2005-06-08 16:39:39 121 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command l
LST-DEV
l
LST-BOARD
l
DISABLE-BOARD
12.2.24 Confirming a Board (CONFIRM-BOARD) Usage Note This command is used to confirm only the board that is in the auto-discovered state.
Command Format CONFIRM-BOARD::(DID=Device-ID|DEV=Device-name),FN=frame-number,SN=slotnumber:CTAG::;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
155
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Supporting Device Device Type No.
Device Type
44
MA5600V3
94
MA5603U
Input Parameter Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
SN
INTEGER
0-35
Indicates the slot ID.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
156
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
2686058554
Command does not support this device type
Run the LST-DEV command to check whether the entered device type is MA5600V3.
2688746481
The board has been confirmed
Run the LST-BOARD command to check whether the board is in the autodiscovered state. Only the board in the auto-discovered state can be confirmed.
Example To confirm the board in slot 0 of shelf 0 of the device named 10.71.62.30, run the following command: CONFIRM-BOARD::DEV=10.71.62.30,FN=0,SN=0:121::; The result is as follows: 7340034 2005-06-08 16:39:39 121 COMPLD EN=0 ENDESC=Succeeded.
M
;
Related Command l
LST-DEV
l
LST-BOARD
12.2.25 Switching Over the Active and Standby Control Boards (SYSTEM-SWITCH) Usage Note The standby control board must be inserted and run in the normal state.
Command Format SYSTEM-SWITCH::(DID=Device-ID|DEV=Device-name):CTAG::;
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
34
MA5680T Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
157
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Device Type No.
Device Type
249
MA5600T
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
158
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Error Code ID
Description
Solution
2689008524
Standby board fault or not exist
Repair or insert the standby control board.
Example To switch over the active and standby control boards of the device named 10.71.62.48, run the following command: SYSTEM-SWITCH::DEV=10.71.62.48:120::; The result is as follows: M
7340034 2005-06-08 16:39:39 120 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.2.26 Activating a CATV Port (ACT-CATVPORT) Usage Note There is no usage note.
Command Format ACT-CATVPORT::(DID=Device-ID|DEV=Device-name)(,FN=Frame-num)(,SN=Slot-num) (,SSN=SubBoard-num)(,PN=Port-num):CTAG::;
Supporting Device Device Type No.
Device Type
92
MA5652G
Input Parameter
Issue 01 (2018-03-05)
Parame ter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
N/A
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
159
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Parame ter
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the default device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
FN
INTEGER
0-255
(Optional) Indicates the subrack ID.
N/A
SN
INTEGER
0-35
(Optional) Indicates the slot ID.
N/A
SSN
INTEGER
0-63,65535
(Mandatory) Indicates the daughter board ID.
N/A
(Mandatory) Indicates the port ID.
N/A
NOTE If no daughter board exists, set this parameter to 65535.
PN
INTEGER
0-63
Response Format This response format complies with that of the operation command provided in 10.3 Response Format Description.
Output Parameter There in no output parameter.
Error Code
Issue 01 (2018-03-05)
ID
Description
Solution
2686058497
Command syntax error
Check the command according to the "Command Format". Ensure that parameters are entered in correct order and symbols (such as : = , and ;) in the command are correct English symbols.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
160
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
ID
Description
Solution
2686058499
Unknown command
Check whether the command word is correct. If it is incorrect, change it to ACT-CATVPORT and reissue it.
2686058801
The device does not exist
The device does not exist. In this case, ensure that the device IP address is correct.
2686058554
Command does not support this device type
Ensure that the command supports the entered device name or IP address.
Example To activate CATV port 0/1/2 on the device named 10.71.211.85, run the following command: ACT-CATVPORT::DEV=10.71.211.85,FN=0,SN=1,SSN=65535,PN=2:2::; The result is as follows: M
7340034 2009-09-08 16:39:39 2 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command DACT-CATVPORT
12.2.27 Deactivating a CATV Port (DACT-CATVPORT) Usage Note There is no usage note.
Command Format DACT-CATVPORT::(DID=Device-ID|DEV=Device-name)(,FN=Frame-num)(,SN=Slot-num) (,SSN=SubBoard-num)(,PN=Port-num):CTAG::;
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
92
MA5652G
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
161
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Input Parameter Paramete r
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
N/A
DEV
OCTET STRING
SIZE (192)
Indicates the default device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
FN
INTEGER
0-255
(Optional) Indicates the subrack ID.
N/A
SN
INTEGER
0-35
(Optional) Indicates the slot ID.
N/A
SSN
INTEGER
0-63, 65535
(Mandatory) Indicates the daughter board ID.
N/A
(Mandatory) Indicates the port ID.
N/A
NOTE If no daughter board exists, set this parameter to 65535.
PN
INTEGER
0-63
Response Format This response format complies with that of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
162
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
2686058497
Command syntax error
Check the command according to the "Command Format". Ensure that parameters are entered in correct order and symbols (such as : = , and ;) in the command are correct English symbols.
2686058499
Unknown command
Check whether the command word is correct. If it is incorrect, change it to DACT-CATVPORT and reissue it.
2686058801
The device does not exist
The device does not exist. In this case, ensure that the device IP address is correct.
2686058554
Command does not support this device type
Ensure that the command supports the entered device name or IP address.
Example To deactivate CATV port 0/1/2 on the device named 10.71.211.85, run the following command: DACT-CATVPORT::DEV=10.71.211.85,FN=0,SN=1,SSN=65535,PN=2:2::; The result is as follows: 7340034 2009-09-08 16:39:39 M 2 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command ACT-CATVPORT
12.2.28 Changing a Device IP Address (MOD-DEVIP) Usage Note This command is used to change a device IP address on the U2000 if a user has changed the IP address of this device.
Command Format MOD-DEVIP::(DID=Device-ID|DEV=Device-name|DEVIP=device-IP):CTAG::NEWDEVIP=deviceIP;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
163
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Supporting Device Device Type No.
Device Type
37
MA5662 NOTE The MA5662 V800R309C00 and later versions support this command.
44
MA5600v3
249
MA5600T
94
MA5603U
95
MA5603T
2319
MA5621 NOTE The MA5621 V800R309C00 and later versions support this command.
2313
MA5652 NOTE The MA5652 V800R309C00 and later versions support this command.
2322
MA5621A NOTE The MA5621A V800R311C00 and later versions support this command.
2323
MA5622A (V800R311C00 and later versions)
2324
MA5623 (V800R311C00 and later versions)
34
MA5680T
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Parame ter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
N/A
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
164
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Parame ter
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the default device name. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
DEVIP
OCTET STRING
SIZE (32)
Indicates the device IP address.
N/A
NEWD EVIP
OCTET STRING
SIZE (32)
Indicates the new IP address of the device.
N/A
Response Format This response format complies with that of the operation command provided in 10.3 Response Format Description.
Output Parameter The IP address of the device must be valid.
Error Code ID
Description
Solution
2686058498
Missing, invalid parameter or mandatory parameter is null, or Value of parameter is wrong
Ensure that the command is proper according to the following requirements: l The parameter values do not exceed the ranges of the parameters specified by the command. l The entered parameter names are correct. l The parameters are entered in the correct order.
Issue 01 (2018-03-05)
2686058499
Unknown command
Check whether the command word is correct. If it is incorrect, change it to MOD-DEVIP and reissue it.
2686058801
The device does not exist
The device does not exist. In this case, ensure that the device IP address is correct.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
165
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Example To change the device IP address 10.71.62.30 to 10.71.62.31, run the following command: MOD-DEVIP::DEVIP=10.71.62.30:121::NEWDEVIP=10.71.62.31; The result is as follows: 7340034 2005-06-08 16:39:39 121 COMPLD EN=0 ENDESC=Succeeded.
M ;
Related Command LST-DEV
12.2.29 Adding an Alarm to the U2000 (ADD-ALARM) Usage Note The alarm to be added to the U2000 must exist on the device.
Command Format ADD-ALARM::(DID=Device-ID|DEV=Device-name|DEVIP=device-IP)(,NODETYPE=lNodeType) [,CLASS=cFaultClass][,LEVEL=cFaultLevel][,FUNCTION=cFaultFunction] (,FAULTID=sFaultID)[,REASONID=sReasonID][,PARA=strPara][,DETAIL=strDetail] (,FLAG=cFaultFlag):CTAG::;
Supporting Device For information about the supporting devices, see Table 23-1.
Input Parameter
Issue 01 (2018-03-05)
Paramete r
Type
Range
Description
Default
DID
INTEGER
-
(Optional) Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
(Optional) Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
DEVIP
IPADDRE SS
-
(Optional) Indicates the IP address of the device.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
166
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
NODETY PE
INTEGER
1
Indicates the node type. The meanings of the options are as follows:
-
255
l 1: device alarm l 255: U2000 alarm CLASS
INTEGER
1-6
Indicates the classification of the alarm or event on the U2000. The meanings of the options are as follows:
-
1: communication 2: environment 3: device 4: service 5: processing 6: security LEVEL
INTEGER
1-4
Indicates the alarm severity or event level. The meanings of the options are as follows:
-
1: critical 2: major 3: minor 4: warning FUNCTIO N
INTEGER
1-10
Indicates the functional classification. The meanings of the options are as follows:
-
1: power alarm 2: environment alarm 3: signaling alarm 4: trunk alarm 5: hardware alarm 6: software alarm 7: operation alarm 8: communication failure 9: service quality 10: processing error FAULTID
Issue 01 (2018-03-05)
INTEGER
0-999999999
Indicates the alarm or event ID. This parameter and the device type are used to identify an alarm or event.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
-
167
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
REASONI D
INTEGER
0-999999999
Indicates the cause ID of the alarm.
-
PARA
OCTET STRING
SIZE (255)
(Optional) Indicates the location parameters of the alarm or event. The format is "subrack ID/slot ID/ subslot ID/port ID/ONU ID/ONU slot ID/ONU port ID" (if the subslot does not exist, enter 65535 as the subslot ID).
-
DETAIL
OCTET STRING
SIZE (255)
Indicates the details of the alarm or event and explanation of other non-location parameters. For example, MAC#0404-OOAEOOAB and ONUIP#10.10.10.10, where the symbol # means "be equal to". Multiple non-location parameters are separated by a space.
-
FLAG
INTEGER
0-2
Indicates the flag field. The meanings of the options are as follows:
-
0: event alarm 1: fault alarm 2: recovery alarm
NOTE
l You must set one of the DID, DEV, and DEVIP parameters. The NODETYPE and FAULTID parameters are mandatory, and other parameters are optional. l If the PARA parameter is set, the value must be in the format "subrack ID/slot ID/subslot ID/port ID/ONU ID/ONU slot ID/ONU port ID". You can enter only part of the information. For example, if you enter only 0/1, it indicates slot 1 in shelf 0. If the location information contains the port ID, you must enter the subslot ID at first. If the subslot does not exist, enter 65535 as the subslot ID. For example, if you enter 0/1/65535/1, it indicates port 0/1/1.
Response Format The alarm is displayed as an alarm, an event, or a cleared alarm on the U2000.
Output Parameter None.
Error Code None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
168
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Example To add event 120 to the U2000, run the following command: ADD-ALARM::DEV=MA5680T,NODETYPE=255,FAULTID=120,FLAG=1:CTAG::; The result is as follows: 0 2008-12-18 14:21:09 CTAG COMPLD EN=0 ENDESC=Succeeded.
M
;
Related Command None.
12.2.30 Saving the Device Configuration (SAVE-DEV) Usage Note This command is used to save the configuration of the device on the U2000.
Command Format SAVE-DEV::DEV=Device-name|DID=Device-ID|DEVIP=device-IP:CTAG::[TYPE=DATA|CFG];
Supporting Device For information about the supporting devices, see Table 23-1.
Input Parameter
Issue 01 (2018-03-05)
Param eter
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
DID
Integer
-
Indicates the device ID.
-
DEVIP
IPADDRES S
-
Indicates the IP address of the device.
-
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
169
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Default
TYPE
OCTET STRING
l DATA
Save type
-
l CFG
l DATA: Only save data file. l CFG: Only save configuration file. l Not input TYPE parameter: Save data file and configuration file.
NOTE
Each one of the preceding three parameters can uniquely identify a device. Therefore, you need to set only one parameter when saving the device configuration.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code
Issue 01 (2018-03-05)
ID
Description
Solution
1610612769
Wrong SNMP parameter(s) or reading database failed
The access to the device fails because the device is offline or abnormal.
2689017157
System is busy, please try it later
The operation fails because the device is busy. In this case, try to perform the operation later.
2686058531
The device does not exist
The access to the device fails because the device does not exist.
2686058508
Task timeout
The task times out because the process is busy. In this case, try to perform the operation later.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
170
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Example To save the configuration of the device named 10.71.211.15, run the following command: SAVE-DEV::DEV=10.71.211.15:6::; The result is as follows: M
7340225 2009-08-11 11:53:30 6 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
12.2.31 Issuing the Command Configuration Script to a Device (CFG-DEVEX) Usage Note NOTE
To prevent sensitive data from being leaked, the configuration script should not contain security-related information such as service passwords and phone numbers.
l
The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be used as the location information. Before using these two parameters as the location information, make sure that the DEV parameter indicates the IP address of the device. For details, see 22.7 How to Locate a Device According to the IP Address.
l
If MODE is TELNET and the USER and PASSWORD parameters are not specified, configure Telnet and STelnet parameters on the U2000 and the device before running this command. Perform the following operations to configure the parameters on the U2000: NOTE
The STelnet service is securer than the Telent service. Therefore, the STelnet service is recommended.
Issue 01 (2018-03-05)
a.
Choose Administration > NE Communicate Parameter > Set NE Telnet/STelnet Parameter (traditional style) from the main menu or select Fix-Network NE Configuration in Application Center and choose Administration > NE Communicate Parameter > Set NE Telnet/STelnet Parameter (application style) from the main menu.
b.
Select a desired device from the navigation tree on the left, and click
c.
In the dialog box on the right, configure Telnet or STelnet parameters.
.
n
The Protocol Name, Port No., Auth. Mode, User Name, Password, and Private Key configured on the U2000 must be consistent with those on the device.
n
The default value of Port No. is 23 and the default value is recommended when you configure Telnet parameters. Auth. Mode needs to be set to User Auth.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
171
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Figure 12-1 Configuring STelnet parameters
Figure 12-2 Configuring Telnet parameters
d.
Issue 01 (2018-03-05)
(Optional) When Protocol Name is set to STelnet and OPERATION_MODE needs to be verified, verify the device fingerprint. For details about how to set OPERATION_MODE, see Table 8-1. i.
Choose Administration > NE Communicate Parameter > Set NE SSH Fingerprint (traditional style) from the main menu or select Fix-Network NE Configuration in Application Center and choose Administration > NE Communicate Parameter > Set NE SSH Fingerprint (application style) from the main menu.
ii.
Select the desired device in the navigation tree and click Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
. 172
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
iii. In the dialog box that is displayed, modify and verify the device fingerprint. l
This command can be run to execute the command configuration script (.cfg file) in Telnet/STelnet or file loading mode. Then all commands in the command configuration script are issued to the device.
l
The configuration principles of the command configuration script are as follows: With a command configuration script and the TL1 command CFG-DEVEX, you can quickly set parameters for similar services. The file format of the script, usually in the .cfg format, is associated with the value of MODE in the TL1 command. –
–
Issue 01 (2018-03-05)
If the value of MODE is CFGFILE, conform to the following rules: n
Contents in the script are the same as contents in the configuration file backed up on the device by running the backup configuration xxx command.
n
The script loaded to the device takes effect only after the device is restarted. The effect is the same as the operation of loading a configuration file on the device by running the load configuration xxx command.
n
The script can contain character strings such as @para1@ and @para2@ that represent user-defined settings. Before the command configuration script is applied to the device, these character strings are replaced by the value of PARAS in the TL1 command. The script can contain character strings such as @para1@ and @para2@ that represent user-defined settings. Before the command configuration script is applied to the device, these character strings are replaced by the value of PARAS in the TL1 command.
n
You can configure service data on a device and back up the configuration file. The backup becomes a script template after you change user-defined settings in it to character strings such as @para1@ and @para2@.
If the value of MODE is SCRIPTFILE, conform to the following rules: n
Each command in the script is a complete command that can be successfully run in an appropriate mode.
n
The script does not contain any interactive commands. If a command passes verification on the device, it should be submitted to the application module and the application module starts to process settings without requiring any other user input.
n
The script does not contain any system resetting commands or any commands irrelevant to configuration, such as save, load, and backup.
n
Each command in the script is valid. If an invalid command is run unsuccessfully, subsequent commands can be run as usual.
n
The script can contain rows consisting of #, <xxx>, or [xxx] only. The # and [xxx] rows will be ignored. In <xxx>, if xxx is a number, it is regarded as a delay. Otherwise, it is also ignored. If a command is longer than 255 bytes, it will not be run. Instead, it will be written to the buffer of error with the reason provided.
n
The script can contain character strings such as @para1@ and @para2@ that represent user-defined settings. Before the command configuration script is applied to the device, these character strings are replaced by the value of PARAS in the TL1 command. Multiple parameters in the configuration file can be replaced and the parameters are separated with symbol #. Each parameter consists of a maximum of 64 characters. For example, if PARAS is set to 10#20, @para1@ and @para2@ in the command configuration script will be replaced with 10 and 20 respectively. If one parameter needs to be set to a series of values like A, A+1, A+2, and so on, use @para1@, (@para1@ Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
173
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
+1), (@para1@+2), and so on in the command configuration script and set PARAS to A. The following is an example: board add 0/20 h801PRTA alarm output alarmid 0x12345678 vlan @para1@-@para2@ vlan @para3@ <2> sysname Huawei ...
After you run this TL1 command wherein PARAS is set to 10#20#100, the following settings are applied to the device: board add 0/20 h801PRTA alarm output alarmid 0x12345678 vlan 10-20 vlan 100 <2> sysname Huawei ...
–
If the value of MODE is TELNET, conform to the following rules: n
Commands in the command configuration script are the same as those you enter in the device CLI after logging in to the device in Telnet/STelnet mode.
n
The script can contain character strings such as @para1@ and @para2@ that represent user-defined settings. Before the command configuration script is applied to the device, these character strings are replaced by the value of PARAS in the TL1 command. The script can contain character strings such as @para1@ and @para2@ that represent user-defined settings. Before the command configuration script is applied to the device, these character strings are replaced by the value of PARAS in the TL1 command. The following is an example: enable config board add 0/20 h801PRTA alarm output alarmid 0x12345678 vlan @para1@-@para2@ y vlan @para3@ sysname Huawei ...
After you run this TL1 command wherein PARAS is set to 10#20#100, the following settings are applied to the device: enable config board add 0/20 h801PRTA alarm output alarmid 0x12345678 vlan 10-20 y vlan 100
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
174
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
sysname Huawei ...
The device supports a fuzzy match with configuration script files based on the version in the file name. The version number contains eight characters, for example, VxxxRxxx. If there are multiple versions of configuration script files, the device automatically matches the file whose version is the same as the real version of the device. If no such file exists, the device matches the file of an earlier version. For example, there are three files, test.cfg, test-V800R311.cfg, and test-V800R313.cfg. If the device version is earlier than V800R311, the device matches the test.cfg file; if the device version is V800R312, the device matches the test-V800R311.cfg file; if the device version is V800R313, the device matches the test-V800R313.cfg file. l
The method for adding command line-based scripts is as follows: a.
Choose Configuration > FTTx Service Pre-Deployment > Configuration Script Management (traditional style) from the main menu or select Fix-Network NE Configuration in Application Center and choose Access Service > FTTx Service Pre-Deployment > Configuration Script Management (application style) from the main menu.
b.
In the information list, right-click and choose Add from the shortcut menu.
c.
In the Add Configuration Script dialog box, enter a script name, set Execute mode to TL1, and click Add. In the Select Configuration Script dialog box, select the desired command line script profile and click OK.
Command Format CFG-DEVEX::(DID=Device-id|DEV=Device-name|(DEV=device-oltipaddress,ONULOCATEINFO=onu-locateinfomation)):CTAG::(PROFID=file-name) [,MODE=execute-mode][,USER=User_Name,PASSWORD=User_Pwd]([,PARAS=value1#value2]| [,PARAS1NAME=value1[,PARAS2NAME=value2[,PARAS3NAME=value3[,...]]]]);
Supporting Device For information about the supporting devices, see Table 23-1.
Input Parameter
Issue 01 (2018-03-05)
Paramete r
Type
Range
Description
Default
DID
INTEGE R
-
Indicates the device ID.
N/A
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
175
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
If you set both the DEV and ONULOCATEINFO parameters for an ONU, that is, enter DEV=device-oltipaddress,ONULOCATEINF O=onu-locate-infomation, the DEV parameter indicates the IP address of the OLT. ONULOC ATEINFO
OCTET STRING
SIZE (128)
Indicates the ONU location information. This parameter is used with the DEV parameter (IP address of the OLT).
N/A
The format is subrack number/ slot ID/port ID/ONU ID. For example, 0/2/0/0 indicates the ONU 0 that is connected to port 0/2/0. PROFID
Issue 01 (2018-03-05)
OCTET STRING
SIZE (32)
Indicates the name of the command configuration script to be issued.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
N/A
176
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
MODE
OCTET STRING
CFGFILE
Indicates the execution mode of the command configuration script.
N/A
SCRIPTFILE TELNET
The options are as follows: l CFGFILE: Indicates the FTP-based/SFTP-based command configuration script loading mode. In this mode, the loaded command configuration script replaces the original command configuration script of the device. The configuration takes effect only after you restart the device. l SCRIPTFILE: Indicates the FTP-based/SFTP-based command configuration script loading mode. In this mode, the command configuration script is added to the existing configuration file of a device. The configuration takes effect immediately without the restart of the device. NOTE ONUs of V800R307C01 and later versions and OLTs of V800R008C00 and later versions support this mode.
l Telnet: Indicates the Telnet/ STelnet mode. In this mode, you can telnet/STelnet to the device to execute the command configuration script.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
177
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
Paramete r
Type
Range
12 Controlling a Session and Performing Operations on a Device
Description
Default
NOTE l SFTP is securer than FTP and TFTP. Therefore, SFTP is recommended. l When the MODE=TELNET parameter is specified: l If the USER and PASSWORD parameters are specified, the U2000 logs in to the device using the input user information and issues configurations via Telent service. Telent service is not safe. Therefore, this way is not recommended. l If the USER and PASSWORD parameters are not specified, you need to set Telnet/STelnet parameters on the U2000. The U2000 logs in to the device using the configured parameters and issues configurations. The STelnet service is securer than the Telent service. Therefore, the STelnet service is recommended.
USER
OCTET STRING
SIZE (15)
Indicates the user name for logging in to the device.
N/A
NOTE This parameter is supported only when MODE is set to TELNET.
PASSWO RD
OCTET STRING
SIZE (15)
Indicates the password for logging in to the device.
N/A
NOTE This parameter is supported only when MODE is set to TELNET.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
178
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Paramete r
Type
Range
Description
Default
PARAS
OCTET STRING
SIZE (129)
Indicates the custom parameter to be applied to a device. It can replace the @para@ parameter in the command configuration scripts.
N/A
Multiple parameters in the configuration file can be replaced and the parameters are separated with symbol #. Each parameter consists of a maximum of 64 characters. For example, if PARAS is set to 10#20, @para1@ and @para2@ in the command configuration script will be replaced with 10 and 20 respectively. If one parameter needs to be set to a series of values like A, A+1, A+2, and so on, use @para1@, (@para1@+1), (@para1@ +2), and so on in the command configuration script and set PARAS to A. PARASN NAME
OCTET STRING
SIZE (512)
Indicates the custom parameter to be applied to a device. It can replace the @para@ parameter in the PROFID configuration file. This parameter is not fixed but can be customized, for example, VLAN or SYANAME.
N/A
Multiple parameters in the configuration file can be replaced and the parameters are separated with symbol #. Each parameter consists of a maximum of 512 characters. N is an integer ranging from 1, for example, 1, 2, 3...
NOTE
You must enter either the device ID or the device name.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
179
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
1616445446
The configuration script file does not exist.
Upload the required configuration script file to the \server\var\oss_tmp \access\hostcfg directory on the server.
1616445448
Logging in to the device failed.
Verify that the user name and password for logging in to the device are correct or that the number of logins through this user name does not exceed the maximum value.
1618280493
Telnet/STelnet parameters are not set for the NE
Check whether the command contains MODE=TELNET but does not contain the USER or PASSWORD parameter. If yes, set Telnet/STelnet parameters on the U2000 and issue this command again.
Example Example 1: Assume that the user name and password for logging in to the device named 10.78.32.13 are root and mduadmin respectively. To issue the \server\var\oss_tmp\access \hostcfg\test.cfg file on the server to the device and replace @para1@ and @para2@ in the file with 10.0.0.0 and 10.11.12.13 respectively, run the following command: CFGDEVEX::DEV=10.78.32.13:1::PROFID=test.cfg,MODE=TELNET,USER=root,PASSW ORD=mduadmin,PARAS=10.0.0.0#10.11.12.13; The result is as follows: 7340034 2007-04-05 16:39:39 M 1 COMPLD EN=0 ENDESC=Succeeded. ;
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
180
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Example 2: Assume that the user name and password for logging in to the device named 10.78.32.13 are root and mduadmin respectively. To issue the \server\var\oss_tmp\access \hostcfg\test.cfg file on the server to the device and replace @SYSNAME@ and @VLAN@ in the file with MA5600T and 100 respectively, run the following command: CFGDEVEX::DEV=10.78.32.13:1::PROFID=test.cfg,MODE=TELNET,USER=root,PASSW ORD=mduadmin,SYSNAME=MA5600T,VLAN=100; The result is as follows: 7340034 2007-04-05 16:42:51 M 1 COMPLD EN=0 ENDESC=Succeeded. ;
Related Command None.
12.2.32 Issuing the Command Configuration Script to an MDE Device (CFG-MDUEX) Usage Note NOTE
To prevent sensitive data from being leaked, the configuration script should not contain security-related information such as service passwords and phone numbers.
l
This command can be run to execute the command configuration script (.cfg file) in file loading mode. Then all commands in the command configuration script are issued to the device. In this mode, the command configuration script is added to the existing configuration file of a device. The configuration takes effect immediately without the restart of the device. NOTE
EPON MDUs of V800R307C01 and later versions support this mode.
l
The configuration principles of the command configuration script are as follows: With a command configuration script and the TL1 command CFG-MDUEX, you can quickly set parameters for similar services on devices of the same type and with the same number of ports. The script is in the .cfg format and has the following rules: –
Naming rule The naming rule is associated with the PROFID parameter in the TL1 command CFG-MDUEX. The file name format is Device type-PROFID-Version.cfg for the MA5612, MA5616, and MA5610 and Device type-Number of FE electrical portsPROFID-Version.cfg for other types of device, please set Number of FE electrical ports to 0 if the device has no FE electrical ports.
Issue 01 (2018-03-05)
n
PROFID: For broadband services, PROFID must be HSI. For voice services, PROFID must be VOICE. For other common configurations, PROFID must be COMMON.
n
Version: The version number contains eight characters, for example, VxxxRxxx. If there are multiple versions of configuration script files, the device automatically matches the file whose version is the same as the real version of the device. If no such file exists, the device matches the file of an Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
181
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
earlier version. For example, there are three files, MA5616-COMMON.cfg, MA5616-COMMON-V800R311.cfg, and MA5616-COMMONV800R313.cfg. If the device version is earlier than V800R311, the device matches the MA5616-COMMON.cfg file; if the device version is V800R312, the device matches the MA5616-COMMON-V800R311.cfg file; if the device version is V800R313, the device matches the MA5616-COMMONV800R313.cfg file. NOTE
The MA5612, MA5616, and MA5610 must have the NE type-PROFID.cfg file. Other types of NEs must have the NE type-FE electrical port quantity-PROFID.cfg file, please set Number of FE electrical ports to 0 if the device has no FE electrical ports.For example, if the device is the MA5620 V800R313 with eight Ethernet ports and PROFID is COMMON, add a script for importing the MA5620-8-COMMON.cfg file to the Configuration Script Management function.
–
Configuration rule A command configuration script is a collection of device commands and has the following configuration rules: n
Each command in the script is a complete command that can be successfully run in an appropriate mode.
n
The script does not contain any interactive commands. If a command passes verification on the device, it should be submitted to the application module and the application module starts to process settings without requiring any other user input.
n
The script does not contain any system resetting commands or any commands irrelevant to configuration, such as save, load, and backup.
n
Each command in the script is valid. If an invalid command is run unsuccessfully, subsequent commands can be run as usual.
n
The script can contain rows consisting of #, <xxx>, or [xxx] only. The # and [xxx] rows will be ignored. In <xxx>, if xxx is a number, it is regarded as a delay. Otherwise, it is also ignored. If a command is longer than 255 bytes, it will not be run. Instead, it will be written to the buffer of error with the reason provided.
n
The script can contain character strings such as @para1@ and @para2@ that represent user-defined settings. Before the command configuration script is applied to the device, these character strings are replaced by the value of PARAS in the TL1 command. Multiple parameters in the configuration file can be replaced and the parameters are separated with symbol #. Each parameter consists of a maximum of 64 characters. For example, if PARAS is set to 10#20, @para1@ and @para2@ in the command configuration script will be replaced with 10 and 20 respectively. If one parameter needs to be set to a series of values like A, A+1, A+2, and so on, use @para1@, (@para1@ +1), (@para1@+2), and so on in the command configuration script and set PARAS to A. The following is an example: board add 0/20 h801PRTA alarm output alarmid 0x12345678 vlan @para1@-@para2@ vlan @para3@ <2> sysname Huawei ...
After you run this TL1 command wherein PARAS is set to 10#20#100, the following settings are applied to the device: Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
182
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
board add 0/20 h801PRTA alarm output alarmid 0x12345678 vlan 10-20 vlan 100 <2> sysname Huawei ...
l
l
The method for adding command line-based scripts is as follows: a.
Choose Configuration > FTTx Service Pre-Deployment > Configuration Script Management (traditional style) from the main menu or select Fix-Network NE Configuration in Application Center and choose Access Service > FTTx Service Pre-Deployment > Configuration Script Management (application style) from the main menu.
b.
In the information list, right-click and choose Add from the shortcut menu.
c.
In the Add Configuration Script dialog box, enter a script name, set Execute mode to TL1, and click Add. In the Select Configuration Script dialog box, select the desired command line script profile and click OK.
If you enable the TL1 offline predeployment function, a scheduling task is generated in the scheduling center when you run the CFG-MDUEX command, and TL1 commands are added to this task as subitems. After MDUs are powered on, TL1 commands are issued in sequence. If you do not enable the TL1 offline predeployment function, an error message is displayed indicating that devices are offline when you run the CFGMDUEX command. For details about how to set the configuration item LoadOffline, see Table 8-1.
Command Format CFG-MDUEX::(DID=Device-ID|DEV=Device-name),(ONTKEY=ont-password):CTAG:: (PROFID=file-name)([,PARAS=value1#value2]| [,PARAS1NAME=value1[,PARAS2NAME=value2[,PARAS3NAME=value3[,...]]]]);
Supporting Device
Issue 01 (2018-03-05)
Device Type No.
Device Type
70
MA5610
104
MA5612
100
MA5616
61
MA5626E
62
MA5620E
96
MA5620
97
MA5626
2333
MA5698
2335
MA5694
2336
MA5821
2364
EA5821 Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
183
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Device Type No.
Device Type
2337
MA5822
2338
MA5898
2339
MA5818
2343
MA5894S
Input Parameter Param eter
Type
Range
Description
Defau lt
DID
INTEG ER
-
Indicates the OLT device ID.
N/A
DEV
OCTE T STRIN G
SIZE (192)
Indicates the OLT device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
ONTK EY
OCTE T STRIN G
SIZE (32)
Indicates the SN or password of a GPON ONU or the key or MAC address of an EPON ONU. You can locate an MDU according to the OLT device and the ONT key.
N/A
PROFI D
OCTE T STRIN G
SIZE (32)
Indicates the name of the command configuration script to be issued.
N/A
NOTE l When this parameter is set to NULL, only a scheduling task is generated and no command configuration script is issued. l PROFID: For broadband services, PROFID must be HSI. For voice services, PROFID must be VOICE. For other common configurations, PROFID must be COMMON.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
184
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Param eter
Type
Range
Description
Defau lt
PARAS
OCTE T STRIN G
SIZE (129)
Indicates the custom parameter to be applied to a device. It can replace the @para@ parameter in the command configuration scripts.
N/A
Multiple parameters in the configuration file can be replaced and the parameters are separated with symbol #. Each parameter consists of a maximum of 64 characters. For example, if PARAS is set to 10#20, @para1@ and @para2@ in the command configuration script will be replaced with 10 and 20 respectively. If one parameter needs to be set to a series of values like A, A+1, A+2, and so on, use @para1@, (@para1@+1), (@para1@+2), and so on in the command configuration script and set PARAS to A. PARAS NNAM E
OCTE T STRIN G
SIZE (512)
Indicates the custom parameter to be applied to a device. It can replace the @para@ parameter in the PROFID configuration file. This parameter is not fixed but can be customized, for example, VLAN or SYANAME.
-
Multiple parameters in the configuration file can be replaced and the parameters are separated with symbol #. Each parameter consists of a maximum of 512 characters. N is an integer ranging from 1, for example, 1, 2, 3...
NOTE
You must enter either the device ID or the device name.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
185
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
1616445446
The configuration script file does not exist.
Upload the required configuration script file to the \server\var\oss_tmp \access\hostcfg directory on the server.
Example Example 1: To issue the \server\var\oss_tmp\access\hostcfg\MA5620-8-COMMON.cfg file on the server to the device whose ONTKEY is ma5620e and replace @SYSNAME@ and @VLAN@ in the file with MA5620 and 100 respectively, run the following command: CFG-MDUEX::DEV=10.70.32.13,ONTKEY=ma5620e: 1::PROFID=COMMON,SYSNAME=MA5620,VLAN=100; The result is as follows: 7340034 2007-04-05 16:39:39 M 1 COMPLD EN=0 ENDESC=Succeeded.
Example 2: To issue the \server\var\oss_tmp\access\hostcfg\MA5620-8-COMMON.cfg file on the server to the device whose ONTKEY is ma5620e and replace @para1@ and (@para1@+1) in the file with 6 and 7 respectively, run the following command: CFG-MDUEX::DEV=10.70.32.13,ONTKEY=ma5620e: 1::PROFID=COMMON,PARAS=6; The result is as follows: 7340034 2007-04-05 16:39:39 M 1 COMPLD EN=0 ENDESC=Succeeded.
Related Command None.
12.2.33 Configuring the ANCP (CFG-PORTANCPINTERFACE) Usage Note This command is used to distribute ADSL, VDSL2, G.SHDSLto different ANCP domains that are managed by different broadband network gateways (BNGs). Ensure that the ANCP domain is enabled before running this command. The command cannot be used to configure Access Node Control Protocol (ANCP) for ONTs.
Command Format CFG-PORTANCPINTERFACE::(DID=Device-ID|DEV=Device-name),FN=frame-num,SN=slotnum,PN=port-num:CTAG::PARTITIONID=Partition-
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
186
12 Controlling a Session and Performing Operations on a Device
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
ID,ENABLESWITCH=Switch,INTERFACETYPE=InterFace-TYPE[,(VPI=PVC-VPI,VCI=PVC-VCI)| (VLANID=Vlan-ID)];
Supporting Device Device Type No.
Device Type
34
MA5680T
92
MA5652G
94
MA5603U
95
MA5603T
100
MA5616
2331
MA5608T
249
MA5600T
2348
MA5683T
Input Parameter
Issue 01 (2018-03-05)
Parameter
Type
Range
Description
Default
DID
INTEGER
-
Indicates the device ID.
-
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
-
FN
INTEGER
0-255
Indicates the subrack ID.
-
SN
INTEGER
0-35
Indicates the slot ID.
-
PN
INTEGER
0-63
Indicates the port ID.
-
PARTITIO NID
INTEGER
1-255
Indicates the ID of the ANCP domain.
-
ENABLES WITCH
OCTET STRING
l ENABLE
Enables or disables the ANCP function of the ports.
-
l DISABLE
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
187
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Parameter
Type
Range
Description
Default
INTERFA CETYPE
OCTET STRING
l ETH
Indicates the type of the packets during the ANCP session.
-
VPI
INTEGER
0-4095
Indicates the VPI of the ANCP.
-
l ATM
NOTE This parameter can be set only when INTERFACETYPE is set to ATM.
VCI
INTEGER
32-65535
Indicates the VCI of the ANCP. It is used to identify a virtual channel in a virtual path.
-
NOTE This parameter can be set only when INTERFACETYPE is set to ATM.
VLANID
INTEGER
1-4095
Indicates the ID of the user VLAN.
-
NOTE This parameter can be set only when INTERFACETYPE is set to ETH.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
188
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Error Code ID
Description
Solution
2686058498
Missing, invalid parameter or mandatory parameter is null, or Value of parameter is wrong.
Ensure that the command is correct according to the following requirements: l The parameter values do not exceed the ranges of the parameters specified by the command. l The entered parameter names are correct. l The parameters are entered in the correct order.
Example To configure the ANCP of port 0/13/3 on the MA5600T named 10.144.194.11, run the following command: CFGPORTANCPINTERFACE::DEV=10.144.194.11,FN=0,SN=13,PN=3:CTAG::PARTITIO NID=1,ENABLESWITCH=ENABLE,INTERFACETYPE=ATM,VPI=1,VCI=32; The result is as follows: 7340049 2012-05-04 10:55:05 CTAG COMPLD EN=0 ENDESC=Succeeded.
M ;
Related Command There is no related command.
12.2.34 Modifying System Attributes for NEs (CFGDEVSYSPARA) Usage Note Currently, the MAC duplicate function of NEs can be modified.
Command Format CFG-DEVSYSPARA::(DID=Device-ID|DEV=Device-name):CTAG::(MACDUPLICATE=macduplicate);
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
189
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Supporting Device Device Type No.
Device Type
249
MA5600T
95
MA5603T
2331
MA5608T
34
MA5680T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/ MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/ EA5800-X2
Input Parameter
Issue 01 (2018-03-05)
Para met er
Type
Range
Description
Default
DID
INTEG ER
7340032-8 253439
Indicates the device ID.
N/A
DEV
OCTET STRIN G
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
N/A
MA CDU PLIC ATE
OCTET STRIN G
ENABLE
Indicates the MAC duplicate function.
N/A
DISABLE
Before the source MAC address of a port is aged, the access node learns the source MAC address of the port from another port and then updates the mapping between the source MAC address and the port in the MAC address table. This process is called MAC address duplicate (also known as MAC address flapping), because it can be regarded as if the access node copied the MAC address from one port to another port (the MAC address flaps from one port to another port). Setting ACDUPLICATE to DISABLE can prevent the MAC addresses of authorized users or upper-layer devices from being duplicated by malicious users.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
190
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
12 Controlling a Session and Performing Operations on a Device
Response Format This response format complies with that of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code ID
Description
Solution
2686058531
The device does not exist.
Verify that the entered parameters for locating the device are correct.
2686058498
Missing, invalid parameter or mandatory parameter is null, or Value of parameter is wrong
Ensure that the command is correct according to the following requirements: l The parameter values do not exceed the ranges of the parameters specified by the command. l The entered parameter names are correct. l The parameters are entered in the correct order.
Example To modify the system attributes of the NE named 10.144.252.32, run the following command: CFG-DEVSYSPARA::DEV=10.144.252.32:CTAG::MACDUPLICATE=ENABLE; The result is as follows: M
7340038 2014-07-20 17:07:05 CTAG COMPLD EN=0 ENDESC=Succeeded.
;
Related Command There is no related command.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
191
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13
13 Notification of Resource Changes
Notification of Resource Changes
About This Chapter This topic provides the commands for registering, canceling, and querying the notification of resource changes. Device resource management includes the notification of adding or deleting a device, shelf, or board. 13.1 Notifying Resource Changes This topic provides commands and examples for registering, canceling, and querying resource change notifications. 13.2 Notifying Device Resource Changes This topic provides the notifications and examples of device resource changes, including the addition and deletion of devices, shelves, and slots. 13.3 Notifying GPON Resource Changes This topic provides the notifications and examples of GPON resource changes, including the event that an FTTH GPON ONU port is online, automatic ONU discovery, and ONU replacement. 13.4 Notifying EPON Resource Changes This topic provides the notifications and examples of EPON resource changes, including the event that an FTTH ONU port is online, automatic ONU discovery, and ONU replacement.
13.1 Notifying Resource Changes This topic provides commands and examples for registering, canceling, and querying resource change notifications.
13.1.1 Registering the Notification of Resource Changes (REGRESCHGNOTIFY) Usage Note After this command is issued, the OSS/NMS receives the notification of resource changes when the resources such as the device, shelf, and slot change. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
192
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
Command Format REG-RESCHGNOTIFY:::CTAG::;
Supporting Device This command has nothing to do with the type of device.
Input Parameter None.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To register the notification of resource changes for the current user, run the following command: REG-RESCHGNOTIFY:::1::; The result is as follows:
M
0 2005-06-09 16:07:19 1 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
13.1.2 Canceling the Notification of Resource Changes (UREGRESCHGNOTIFY) Usage Note None. Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
193
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
Command Format UREG-RESCHGNOTIFY:::CTAG::;
Supporting Device This command has nothing to do with the type of device.
Input Parameter None.
Response Format It complies with the response format of the operation command provided in 10.3 Response Format Description.
Output Parameter None.
Error Code None.
Example To cancel the notification of resource changes for the current user, run the following command: UREG-RESCHGNOTIFY:::2::; The result is as follows:
M
0 2005-06-09 16:07:19 2 COMPLD EN=0 ENDESC=Succeeded.
;
Related Command None.
13.1.3 Querying the Notification of Resource Changes (LSTBMSRESCHANOTIFY) Usage Note None.
Command Format LST-BMSRESCHANOTIFY:::CTAG::STARTAID=initial AID[,ENDAID=last AID];
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
194
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
Supporting Device This command has nothing to do with the type of device.
Input Parameter Parameter
Type
Range
Description
Default
STARTAID
INTEGER
0-2147483647
Indicates the start access identifier (AID). It is used to query the notifications whose sequence number is greater than or equal to the start AID.
-
ENDAID
INTEGER
0-2147483647
(Optional) Indicates the end AID. It is used to query the notifications whose sequence number is smaller than or equal to the end AID.
-
Response Format It complies with the response format of the query command provided in 10.3 Response Format Description. title="Changed resource notice whose ID from" + STARTAID name of attributes: AID mark DID DEV FN SN
+ " to " + ENDAID
Output Parameter
Issue 01 (2018-03-05)
Descr iption
Type
Range
Description
AID
INTEGE R
0-2147483647
Indicates the sequence number of the notification of resource changes.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
195
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
Descr iption
Type
Range
Description
mark
OCTET STRING
l DEVAFFIRM
Indicates the resource change. The meanings of the options are as follows:
l FRAMEAFFIRM l SLOTAFFIRM l DEVDEL l FRAMEDEL l SLOTDEL
l DEVAFFIRM: A device is confirmed. l FRAMEAFFIRM: A shelf is confirmed. l SLOTAFFIRM: A slot is confirmed. l DEVDEL: A device is deleted. l FRAMEDEL: A shelf is deleted. l SLOTDEL: A slot is deleted.
Issue 01 (2018-03-05)
DID
INTEGE R
-
Indicates the device ID.
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. If the value of the configuration item DEVMEAN is 1, the DEV parameter indicates the IP address of the device. For details about how to modify configuration items, see 22.7 How to Locate a Device According to the IP Address.
FN
INTEGE R
0-255
Indicates the subrack ID.
SN
INTEGE R
0-35
Indicates the slot ID.
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
196
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
Error Code ID
Description
Solution
2686058552
The resource does not exist.
Ensure that the ID of the notification of resource changes exists in the database. Run the LSTBMSRESCHANOTIFY::: 2::STARTAID=0; command to obtain the maximum ID of the notification of resource changes and ensure that the entered ID is not greater than the maximum ID.
Example To query the notifications sequence serial numbers that are greater than or equal to 1, run the following command: LST-BMSRESCHANOTIFY:::2::STARTAID=1; The result is as follows:
M
0 2005-06-09 16:30:53 2 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=5 blktotal=5
Changed resource notice whose ID from 1 -------------------------------AID mark DID DEV FN SN 1 SLOTDEL 7344129 10.71.56.151 0 2 SLOTDEL 7344129 10.71.56.151 0 3 SLOTDEL 7344129 10.71.56.151 0 4 DEVAFFIRM 7344129 10.71.56.151 5 SLOTAFFIRM 7344129 10.71.56.151 --------------------------------
5 6 1 -0
-1
;
Related Command None.
13.2 Notifying Device Resource Changes This topic provides the notifications and examples of device resource changes, including the addition and deletion of devices, shelves, and slots.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
197
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
13.2.1 Notifying Device Confirmation Usage Note The resource change notification must be registered for the current user through the REGRESCHGNOTIFY command.
Response Format It complies with the response format provided in 10.4 Format Description of the Resource Change Notification. < auto id > header::=^^^^-<month>-^:<minute>:<second> ::= A^^^ text block::=((^^^<EN=error-code>) | (^^^)) quotedline::=^^^^^^^^^ result::=(<->*)((()*))(<>*) attribs::=((^^)*) values::=((^^)*) terminator::= (;|>) title="Information of added device" name of attributes: DID DEV FN SN
Output Parameter Parameter
Type
Range
Description
DID
INTEGER
-
Indicates the device ID.
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. When the value of configuration item BMSNB_MSGNOTIFY_DEVMEAN is 1, the DEV parameter indicates the IP address of the device.
FN
INTEGER
0-255
Indicates the subrack ID. It is invalid and is set to - to maintain the unified format.
SN
INTEGER
0-35
Indicates the slot ID. It is invalid and is set to - to maintain the unified format.
Error Code None.
Example If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::1::; command is executed), the OSS system receives a resource change notification when the device with ID 7667723 is added successfully. 7667723 2005-05-23 13:01:09 A 1537 DEVAFFIRM
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
198
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1 Information of added device --------------------DID DEV FN SN 7667723 UA5000(PVM)_10.71.56.139 --------------------;
13 Notification of Resource Changes
--
--
Related Command REG-RESCHGNOTIFY
13.2.2 Notifying Device Deletion Usage Note The resource change notification must be registered for the current user through the REGRESCHGNOTIFY command.
Command Format None. After an OLT is deleted, the U2000 reports a change notification to the OSS.
Supporting Device Device Type No.
Device Type
34
MA5680T
57
MA5606T
94
MA5603U
95
MA5603T
249
MA5600T
2331
MA5608T
2348
MA5683T
2346/2349/2352/2353
MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2369
MA5801
2363/2361/2362/2360
EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
Input Parameter None.
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
199
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
Response Format It complies with the response format provided in 10.4 Format Description of the Resource Change Notification.
Output Parameter Paramete r
Type
Range
Description
DID
INTEGER
-
Indicates the device ID.
DEV
OCTET STRING
SIZE (192)
Indicates the device name by default. When the value of configuration item BMSNB_MSGNOTIFY_DEVME AN is 1, the DEV parameter indicates the IP address of the device.
FN
INTEGER
0-255
Indicates the subrack ID.
SN
INTEGER
0-35
Indicates the slot ID.
Error Code None.
Example If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::1::; command is executed), the OSS system receives a resource change notification when the device with ID 7356419 is deleted successfully. 7356419 2005-05-23 12:51:01 A 1535 DEVDEL EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1 Information of deleted device --------------------DID DEV FN SN 7356419 10.71.56.139 ---------------------;
--
Related Command REG-RESCHGNOTIFY
Issue 01 (2018-03-05)
Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.
200
iManager U2000 Unified Network Management System Northbound TL1 Interface User Guide
13 Notification of Resource Changes
13.2.3 Notifying Device Synchronization Usage Note The resource change notification must be registered for the current user through the REGRESCHGNOTIFY command. By default, the NE synchronization results are not reported to the OSS. If the synchronization results need to be reported, modify the SYNC_COMPLETED_NOTIFY_OSS configuration item of the Table 8-1.
Response Format It complies with the response format provided in 10.4 Format Description of the Resource Change Notification. < auto id > header::=^^^^-<month>-^:<minute>:<second> ::= A^^^ text block::=((^^^<EN=error-code>) | (^^^)) quotedline::=^^^^^^^^^ result::=