You are on page 1of 5203

iMaster NCE

V100R019C10SPC200

Northbound TL1 Interface User


Guide

Issue 01
Date 2020-05-31

HUAWEI TECHNOLOGIES CO., LTD.


Copyright © Huawei Technologies Co., Ltd. 2020. 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: https://www.huawei.com
Email: support@huawei.com

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. i


iMaster NCE
Northbound TL1 Interface User Guide Contents

Contents

1 About This Document.............................................................................................................1


2 Change History.........................................................................................................................4
3 Usage Note................................................................................................................................5
4 TL1 NBI Overview.................................................................................................................... 7
4.1 Introduction to the TL1 NBI................................................................................................................................................. 7
4.2 Position in the Network........................................................................................................................................................ 8
4.3 Communication Protocols.................................................................................................................................................... 8
4.4 Functions and Features......................................................................................................................................................... 9
4.5 Security Mechanism............................................................................................................................................................. 10
4.6 Performance Specifications............................................................................................................................................... 12
4.7 Standards Compliance.........................................................................................................................................................12
4.8 References............................................................................................................................................................................... 12

5 Installing and Enabling the NBI for Provisioning the TL1 Service.............................14
5.1 Configuration Requirements............................................................................................................................................. 14
5.2 Installing a TL1 NBI Component..................................................................................................................................... 15
5.3 Checking the Status of the TL1 NBI............................................................................................................................... 15

6 Maintaining the TL1 NBI..................................................................................................... 17


6.1 Requirements for Maintenance Staff............................................................................................................................. 17
6.2 Routine Maintenance.......................................................................................................................................................... 18
6.3 Starting the TL1 Process..................................................................................................................................................... 19
6.4 Stopping the TL1 Process................................................................................................................................................... 19
6.5 Creating a NCE User for the Access of an OSS and Assign Rights to the User...............................................20

7 SSL Principle and Configuration........................................................................................ 23


7.1 SSL Principle............................................................................................................................................................................23
7.2 Applying for an SSL Certificate........................................................................................................................................ 24
7.3 Interconnecting with an SSL Certificate........................................................................................................................ 26
7.3.1 Updating an SSL Certificate........................................................................................................................................... 27
7.3.2 Verifying the Certificate Identity.................................................................................................................................. 31

8 Setting Configuration Items............................................................................................... 34


9 Command Format................................................................................................................. 62

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. ii


iMaster NCE
Northbound TL1 Interface User Guide Contents

9.1 Format Description............................................................................................................................................................... 62


9.2 Command Format Description......................................................................................................................................... 64
9.3 Response Format Description........................................................................................................................................... 65
9.4 Format Description of the Resource Change Notification...................................................................................... 68

10 Supported Devices of the Same Series.......................................................................... 70


11 Controlling a Session and Performing Operations on a Device...............................71
11.1 Controlling the Session..................................................................................................................................................... 71
11.1.1 Logging in to the NCE (LOGIN)................................................................................................................................. 71
11.1.2 Logging In to the NCE (ACT-USER).......................................................................................................................... 73
11.1.3 Exiting the NCE (LOGOUT)......................................................................................................................................... 74
11.1.4 Exiting the NCE (CANC-USER)................................................................................................................................... 75
11.1.5 Querying the NCE Version (LST-BMSVERSION)................................................................................................... 76
11.1.6 Querying the NMS Information (LST-EMFSYSINFO).......................................................................................... 77
11.1.7 Handshaking (SHAKEHAND)...................................................................................................................................... 80
11.1.8 Handshaking (REPT-STAT)........................................................................................................................................... 81
11.2 Performing Operations on a Device.............................................................................................................................83
11.2.1 Creating a Subnet (ADD-SUBNET)........................................................................................................................... 83
11.2.2 Modifying a Subnet (MOD-SUBNET)...................................................................................................................... 85
11.2.3 Deleting a Subnet (DEL-SUBNET)............................................................................................................................. 86
11.2.4 Adding an NE Link (ADD-NELINK)........................................................................................................................... 88
11.2.5 Modifying an NE Link (MOD-NELINK)................................................................................................................... 90
11.2.6 Deleting an NE Link (DEL-NELINK).......................................................................................................................... 92
11.2.7 Synchronizing the Time (SYNC-DEVTIME)............................................................................................................. 93
11.2.8 Synchronizing NE Data (SYNC-DEV)........................................................................................................................ 95
11.2.9 Deleting a Device (DEL-DEV)......................................................................................................................................98
11.2.10 Resetting a Device (RESET-DEV)........................................................................................................................... 102
11.2.11 Resetting a Board (RESET-BOARD)...................................................................................................................... 104
11.2.12 Changing the Device Name and Alias (MOD-DEV).......................................................................................107
11.2.13 Modifying the Shelf Name and Alias (MOD-FRAME)...................................................................................110
11.2.14 Modifying the Slot Alias (MOD-SLOT)............................................................................................................... 113
11.2.15 Exporting a Resource File (DMP-INVENTORY)................................................................................................ 115
11.2.16 Exporting Service Port Statistics to Files (DMP-E2EPERF)........................................................................... 124
11.2.17 Exporting Ethernet Port Statistics to Files (DMP-ETHPERF)....................................................................... 128
11.2.18 Exporting PON Port Statistics to Files (DMP-PONPERF)..............................................................................132
11.2.19 Adding a Device (ADD-DEV).................................................................................................................................. 135
11.2.20 Adding a Board (ADD-BOARD)............................................................................................................................. 142
11.2.21 Deleting a Board (DEL-BOARD)............................................................................................................................ 145
11.2.22 Disabling a Board (DISABLE-BOARD)................................................................................................................. 148
11.2.23 Enabling a Board (ENABLE-BOARD)................................................................................................................... 150
11.2.24 Confirming a Board (CONFIRM-BOARD).......................................................................................................... 152
11.2.25 Switching Over the Active and Standby Control Boards (SYSTEM-SWITCH)........................................154
11.2.26 Activating a CATV Port (ACT-CATVPORT)......................................................................................................... 157

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. iii


iMaster NCE
Northbound TL1 Interface User Guide Contents

11.2.27 Deactivating a CATV Port (DACT-CATVPORT).................................................................................................159


11.2.28 Changing a Device IP Address (MOD-DEVIP).................................................................................................. 162
11.2.29 Adding an Alarm to the NCE (ADD-ALARM)................................................................................................... 165
11.2.30 Saving the Device Configuration (SAVE-DEV)................................................................................................. 171
11.2.31 Issuing the Command Configuration Script to a Device (CFG-DEVEX)...................................................173
11.2.32 Issuing the Command Configuration Script to an MDE Device (CFG-MDUEX)................................... 188
11.2.33 Configuring the ANCP (CFG-PORTANCPINTERFACE).................................................................................... 196
11.2.34 Modifying System Attributes for NEs (CFG-DEVSYSPARA)......................................................................... 200

12 Performance Management............................................................................................. 205


12.1 Creating a Performance Measurement Task (CRE-PMTSK).............................................................................. 205

13 Notification of Resource Changes.................................................................................216


13.1 Notifying Resource Changes........................................................................................................................................ 216
13.1.1 Registering the Notification of Resource Changes (REG-RESCHGNOTIFY)............................................. 216
13.1.2 Canceling the Notification of Resource Changes (UREG-RESCHGNOTIFY)............................................. 217
13.1.3 Querying the Notification of Resource Changes (LST-BMSRESCHANOTIFY).......................................... 218
13.2 Notifying Device Resource Changes.......................................................................................................................... 221
13.2.1 Notifying Device Confirmation................................................................................................................................ 222
13.2.2 Notifying Device Deletion..........................................................................................................................................223
13.2.3 Notifying Device Synchronization........................................................................................................................... 225
13.2.4 Notifying Shelf Confirmation................................................................................................................................... 227
13.2.5 Notifying the Shelf Deletion..................................................................................................................................... 229
13.2.6 Notifying Slot Confirmation......................................................................................................................................230
13.2.7 Notifying the Slot Deletion....................................................................................................................................... 231
13.2.8 Reporting Notifications of OLT Attribute Changes........................................................................................... 233
13.2.9 Reporting Notifications of MDU Attribute Changes........................................................................................ 235
13.2.10 Reporting Notifications of ONU Addition......................................................................................................... 237
13.2.11 Reporting Notifications of ONU Deletion..........................................................................................................239
13.2.12 Reporting Notifications of Board Attribute Changes..................................................................................... 242
13.2.13 Notifying Plug and Play Deployment Completion..........................................................................................244
13.3 Notifying GPON Resource Changes...........................................................................................................................247
13.3.1 Reporting Notifications on Initial Power-on of GPON ONUs....................................................................... 247
13.3.2 Notifying the Event That an FTTH GPON ONU Port Is Online.................................................................... 250
13.3.3 Notifying the Automatic Discovery of a GPON ONU...................................................................................... 253
13.3.4 Notifying GPON ONU Replacement...................................................................................................................... 256
13.4 Notifying EPON Resource Changes........................................................................................................................... 260
13.4.1 Reporting Notifications on Initial Power-on of EPON ONUs........................................................................ 260
13.4.2 Notifying the Event That an FTTH ONU Port Is Online.................................................................................. 263
13.4.3 Notifying the Automatic Discovery of an EPON ONU.................................................................................... 265
13.4.4 9.4-Format Description of the Resource Change NotificationNotifying EPON ONU Replacement.268

14 Inventory Management...................................................................................................271
14.1 Querying Device Resources.......................................................................................................................................... 273

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. iv


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.1.1 Querying a Subnet (LST-SUBNET).......................................................................................................................... 273


14.1.2 Querying an NE Link (LST-NELINK)....................................................................................................................... 276
14.1.3 Querying the Information About a Device (LST-DEV).....................................................................................279
14.1.4 Querying Device Global Configurations (LST-DEVCFG).................................................................................. 290
14.1.5 Querying CPU and Memory Information about an NE (LST-DEVINFO)................................................... 294
14.1.6 Querying Subrack Information (LST-FRAME)..................................................................................................... 300
14.1.7 Querying the Information About a Board (LST-BOARD)................................................................................ 306
14.1.8 Querying Real-Time Performance Data of Boards (LST-BOARDPERF)...................................................... 316
14.1.9 Querying the Information About a Daughter Board (LST-SUBBOARD)....................................................319
14.1.10 Querying the Information About a Port (LST-PORT).................................................................................... 323
14.1.11 Querying Protection Group Information (LST-PSG)....................................................................................... 333
14.1.12 Querying the Alarms on the NCE (LST-ALARM)............................................................................................. 338
14.1.13 Querying the MAC Addresses Learnt by Devices (LST-OLTLEARNINGMAC).........................................342
14.1.14 Querying Alarm Masking Rules (LST-MASKRULES).......................................................................................346
14.1.15 Querying Upstream Port Information (LST-VNUPLINK-PORT).................................................................. 352
14.2 Querying ADSL Resources............................................................................................................................................. 355
14.2.1 Querying the Basic Information About an ADSL Port (LST-ADSLPORTCFG)...........................................355
14.2.2 Querying Specified Information About ADSL Ports (LST-DSLPORTSPECIFYINFO)................................ 358
14.2.3 Querying the Details of an ADSL Port (LST-DSLPORTDETAILINFO).......................................................... 364
14.2.4 Querying the List of ADSL Line Profiles (LST-ADSLLINEPROFILE).............................................................. 398
14.2.5 Querying the Details of an ADSL Line Profile (LST-ADSLLINEPROFILEDETAIL)..................................... 413
14.2.6 Querying the List of ADSL Alarm Profiles (LST-ADSLALARMPROFILE)..................................................... 427
14.2.7 Querying the List of ADSL Extended Profiles (LST-ADSLEXTENDPROFILE)............................................. 431
14.2.8 Querying the Details of an ADSL Extended Profile (LST-ADSLEXTENDPROFILEDETAIL)....................435
14.2.9 Querying the Alarm Information About an ADSL Port (LST-ADSLPORTALARM).................................. 444
14.2.10 Querying the Alarm Status of an xDSL Port (LST-XDSLPORTALARMSTATE)........................................ 448
14.2.11 Querying the Performance Statistics of an ADSL Port (LST-ADSLPORTPERF)..................................... 454
14.2.12 Querying the Current Performance Statistics of an ADSL Port (LST-ADSLNTPORTPERF)............... 459
14.2.13 Querying Performance of ADSL Port in Current 15 Minutes and Last 15 Minutes (LST-
ADSLPORTQTRPERF)................................................................................................................................................................ 463
14.2.14 Querying the Historical 15-minute Performance Statistics of an ADSL Port (LST-
ADSLPORTHISQTRPERF)......................................................................................................................................................... 480
14.2.15 Querying Bit Allocation Information About an ADSL Port (LST-ADSLBITALLOCINFO)..................... 488
14.2.16 Querying the U-MAC/V-MAC of an xDSL Port (LST-XDSLPORTMACMAPING)....................................491
14.3 Querying G.SHDSL Resources...................................................................................................................................... 495
14.3.1 Querying the Chipset Mode of a Board (LST-SHDSLBOARDCHIPSETMODE)......................................... 495
14.3.2 Querying the Details of an SHDSL Port (LST-SHDSLPORTDETAILINFO).................................................. 498
14.3.3 Querying the List of SHDSL Line Profiles (LST-SHDSLSPANPROFILE)....................................................... 510
14.3.4 Querying the Details of an SHDSL Line Profile (LST-SHDSLSPANPROFILEDETAIL)..............................512
14.3.5 Querying the Devices That Reference an SHDSL Line Profile (LST-DEVBYSP)........................................520
14.3.6 Querying the Ports That Reference an SHDSL Line Profile (LST-PORTBYSP)..........................................522
14.3.7 Querying the List of SHDSL Alarm Profiles (LST-SHDSLALARMPROFILE)............................................... 525
14.3.8 Querying the Details of an SHDSL Alarm Profile (LST-SHDSLALARMPROFILEDETAIL)...................... 528

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. v


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.3.9 Querying the Devices That Reference an SHDSL Alarm Profile (LST-DEVBYAL)....................................531
14.3.10 Querying the Ports That Reference an SHDSL Alarm Profile (LST-PORTBYAL)................................... 533
14.3.11 Querying the Alarm Information About an SHDSL Port (LST-SHDSLPORTALARM).......................... 536
14.3.12 Querying the Performance Statistics of a G.SHDSL Port (LST-SHDSLPORTPERF).............................. 540
14.3.13 Querying the FE1 Attribute of a TDM SHDSL Port (LST-SHDSLPORTFE1)............................................551
14.4 Querying VDSL2 Resources.......................................................................................................................................... 554
14.4.1 Querying the Details of a VDSL2 Port (LST-VDSL2PORTDETAILINFO)......................................................554
14.4.2 Querying Specified Information About VDSL2 Ports (LST-VDSL2PORTSPECIFYINFO)......................... 602
14.4.3 Querying VDSL2 Port Information about Specified NEs (LST-NEVDSL2PORTDETAILINFO).............. 625
14.4.4 Querying the Alarm Information About a VDSL2 Port (LST-VDSLPORTALARM)...................................634
14.4.5 Querying the Performance Statistics of a VDSL2 Port (LST-VDSLPORTPERF)........................................ 638
14.4.6 Querying a VDSL2 Line Profile (LST-VDSLLINEPROFILE)............................................................................... 660
14.4.7 Query the Details of a VDSL2 Line Profile (LST-VDSLLINEPROFILEDETAIL)............................................663
14.4.8 Querying a VDSL2 Alarm Profile (LST-VDSLALARMPROFILE)...................................................................... 683
14.4.9 Query the Details of a VDSL2 Alarm Profile (LST-VDSLALARMPROFILEDETAIL).................................. 685
14.4.10 Querying the Alarm Status of an xDSL Port (LST-XDSLPORTALARMSTATE)........................................ 696
14.4.11 Querying Bit Allocation Information About a VDSL2 Port (LST-VDSL2BITALLOCINFO)................... 702
14.4.12 Querying the U-MAC/V-MAC of an xDSL Port (LST-XDSLPORTMACMAPING)....................................706
14.4.13 Querying Global VDSL2 Profile Names (LST-PROFNAME)..........................................................................709
14.4.14 Querying NE-side VDSL2 Profile Names (TI Mode).......................................................................................712
14.4.14.1 Querying VDSL2 Service Profile Names (LST-VDSLSERVICEPROFILE)................................................. 712
14.4.14.2 Querying VDSL2 UPBO Profile Names (LST-VDSLUPBOPROFILE)........................................................ 715
14.4.14.3 Querying VDSL2 DPBO Profile Names (LST-VDSLDPBOPROFILE)........................................................ 718
14.4.14.4 Querying VDSL2 Spectrum Profile Names (LST-VDSLSPECPROFILE)................................................... 721
14.4.14.5 Querying VDSL2 Alarm Profile Names (LST-VDSLTIALARMPROFILE)..................................................724
14.4.14.6 Querying VDSL2 SNR Margin Profile Names (LST-VDSLNMPROFILE)................................................ 727
14.4.14.7 Querying VDSL2 Delay INP Profiles (LST-VDSLINPPROFILE).................................................................. 730
14.4.15 Querying the Performance Statistics on a GPON ONT VDSL2 Port (LST-ONTVDSLPORTPERF)... 733
14.4.16 Querying the Details of a GPON ONT VDSL2 Port (LST-ONTVDSL2PORTDETAILINFO)..................748
14.4.17 Querying Specified Information About GPON ONT VDSL2 Ports (LST-
ONTVDSL2PORTSPECIFYINFO)............................................................................................................................................. 768
14.5 Querying G.fast Resources............................................................................................................................................ 780
14.5.1 Querying the Details of a G.fast Port (LST-GFASTPORTDETAILINFO)....................................................... 780
14.5.2 Querying G.fast Port Information About Specified NEs (LST-NEGFASTPORTDETAILINFO)............... 807
14.5.3 Querying the Alarm Information About a G.fast Port (LST-GFASTPORTALARM)..................................814
14.5.4 Querying the Performance Statistics on a G.fast Port (LST-GFASTPORTPERF)...................................... 818
14.5.5 Querying the Alarm Status of an xDSL Port (LST-XDSLPORTALARMSTATE)...........................................837
14.5.6 Querying the Bit Allocation Information About a G.fast Port (LST-GFASTBITALLOCINFO)............... 842
14.5.7 Querying the U-MAC/V-MAC of an xDSL Port (LST-XDSLPORTMACMAPING)...................................... 846
14.6 Querying a Bonding Group...........................................................................................................................................849
14.6.1 Querying a Bonding Group (RTRV-BONDGRP)..................................................................................................849
14.6.2 Querying the Details of a Bonding Group (RTRV-BONDGRPDETAIL)........................................................853
14.6.3 Querying Performance Statistics of a VDSL2 Bonding Group (LST-VDSL2BONDINGGROUPPERF)861

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. vi


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.6.4 Querying the Details of a VDSL2 Bonding Group (LST-VDSL2BONDINGDETAILINFO).......................867


14.7 Querying Video Resources............................................................................................................................................ 872
14.7.1 Querying the List of Virtual Upstream Ports in an IGMP VLAN (LST-IGMPUPLINKPORT)................ 872
14.7.2 Querying the Information About Multicast Programs (LST-NTVPROGRAM)..........................................876
14.7.3 Querying the Detail Information of a Multicast User (LST-NTVUSRDETAIL)..........................................885
14.7.4 Querying the List of Multicast Users (LST-NTVPORTBASIC)......................................................................... 899
14.7.5 Querying the Rights Profile of a Multicast User (LST-NTVPORTRP).......................................................... 915
14.7.6 Querying Rights Profiles (LST-NTVRP).................................................................................................................. 931
14.7.7 Querying the Programs Specified in a Rights Profile (LST-RPPROGRAM)................................................934
14.7.8 Querying the Multicast VLAN Information of a Device (RTRV-IGMPVLAN)........................................... 939
14.7.9 Querying the Multicast VLAN of a Multicast User (LST-NTVUSRIGMPVLAN)....................................... 942
14.7.10 Querying the Details of a Multicast VLAN (RTRV-IGMPVLANDETAIL)................................................... 951
14.7.11 Querying the Details of a Multicast VLAN (LST-IGMPVLANDETAIL).......................................................956
14.7.12 Querying the Multicast Subtend Port (LST-NTVCASCADE).........................................................................964
14.8 Querying GPON Resources........................................................................................................................................... 970
14.8.1 Querying the List of GPON Ports (LST-GPONPORT)....................................................................................... 970
14.8.2 Querying the Details of a GPON Port (LST-GPONPORTDETAIL).................................................................976
14.8.3 Querying the Information About an Upstream GPON Port (LST-GPONNNIPORT).............................. 988
14.8.4 Querying the List of ONUs (LST-ONT)................................................................................................................. 992
14.8.5 Querying the Details of an ONT (LST-ONTDETAIL)...................................................................................... 1011
14.8.6 Querying the IP Address of a GPON ONT (LST-ONTIPINFO).....................................................................1025
14.8.7 Querying the Information About Auto-Discovered GPON ONUs (LST-GPONONTAUTOFIND)..... 1031
14.8.8 Querying the Running Status of an ONT (LST-ONTRUNINFO).................................................................1038
14.8.9 Querying the List of ONT Ports (LST-ONTPORT)........................................................................................... 1048
14.8.10 Querying the Details of an ONT Port (LST-ONTPORTDETAIL)................................................................1055
14.8.11 Querying the Ethernet Port Details of a GPON ONT (LST-GPONONTETHPORTDETAIL)..............1064
14.8.12 Querying the Status of an ONU POTS User (LST-ONTPOTSSTATE)......................................................1068
14.8.13 Querying the MAC Addresses Learned by the User Port of an FTTH ONU (LST-
GPONONTPORTMAC)........................................................................................................................................................... 1075
14.8.14 Querying the Details of GPON Optical Modules (LST-GPONSFP)......................................................... 1080
14.8.15 Querying the Parameters of the Optical Module of an ONT (LST-ONTDDMDETAIL)....................1087
14.8.16 Querying the Optical Module Information of an MDU NNI Port (LST-ONUNNIDDMDETAIL)... 1098
14.8.17 Querying the Ethernet Transmission Feature of an Upstream Port of an ONT (LST-
ONTETHPORTPERF)............................................................................................................................................................... 1102
14.8.18 Querying the List of DBA Profiles Bound to an ONT (LST-ONTDBAPROF)........................................ 1112
14.8.19 Querying the List of GEM Ports (LST-GEMPORT)........................................................................................ 1117
14.8.20 Querying the List of GEM Connections (LST-GEMCONNECTION)......................................................... 1125
14.8.21 Querying the Real-Time Performance Data of Ethernet Traffic on a GPON UNI Port (LST-
GPONPORTPERF).................................................................................................................................................................... 1132
14.8.22 Querying the Real-Time Performance Data of a GPON ONT Ethernet Port (LST-
GPONONTETHPORTPERF)................................................................................................................................................... 1139
14.8.23 Querying the ONT WAN Port Information (LST-ONTWAN).................................................................... 1144
14.8.24 Querying the ONT WAN Port Information (LST-ONT-WANINFO)......................................................... 1152

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. vii


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.8.25 Querying ONT SIP User Accounts (LST-ONTSIPINFO)............................................................................... 1160


14.8.26 Querying GPON Line Profile Names (LST-GPONLINEPROFILE)..............................................................1166
14.8.27 Querying GPON Service Profile Names (LST-GPONSRVPROFILE)......................................................... 1170
14.8.28 Query the DHCP IP Configuration of an ONT (LST-ONTIPCONFIG)..................................................... 1173
14.8.29 Querying the VoIP Address of an ONT (LST-ONTVAGVOIP)....................................................................1178
14.8.30 Querying the ONT PSTN User Information (LST-ONTVOIPPSTNUSER)...............................................1184
14.8.31 Querying the VLAN Switching Pair for an Ethernet Port on a GPON ONT (LST-
ONTETHVLANSWTICHPAIR)................................................................................................................................................1195
14.8.32 Querying the Traffic Shaping Information of an ONT Queue (LST-ONTQUEUESHAPING)..........1200
14.8.33 Querying the GPON Optical Module Information (LST-GPONDDMINFO)......................................... 1205
14.8.34 Querying the Transmission Feature of a GPON NNI Port (LST-GPONNNIPERF).............................. 1210
14.8.35 Querying the First Idle GEM Port ID of GPON Ports (LST-FRSTIDLGEM)............................................ 1215
14.8.36 Exporting POTS Service Provisioning Statistical Files (DMP-POTSPERF)............................................. 1218
14.8.37 Exporting GPON ONT Online Status Statistical Files (DMP-ONTPERF)...............................................1221
14.8.38 Querying GPON MDU Replacement Tasks (LST-ONTRM)........................................................................ 1224
14.8.39 Querying Call Record of an ONT Pots (LST-ONTPOTSCALLRECORD).................................................. 1233
14.8.40 Querying Details About a Global GPON Line Profile (LST-GLOBALGPONLINEPROFILEDETAIL).1238
14.8.41 Querying a Global GPON Line Profile Name List (LST-GLOBALGPONLINEPROFILENAME).........1241
14.8.42 Querying Details About a Global GPON Service Profile (LST-GLOBALGPONSRVPROFILEDETAIL)
....................................................................................................................................................................................................... 1244
14.8.43 Querying a Global GPON Service Profile Name List (LST-GLOBALGPONSRVPROFILENAME).....1248
14.8.44 Querying Details About a Global GPON DBA Profile (LST-GLOBALDBAPROFILEDETAIL).............1250
14.8.45 Querying a Global GPON DBA Profile Name List (LST-GLOBALDBAPROFILENAME)..................... 1254
14.8.46 Querying the ONT WLAN Information (LST-ONTUSERWLAN)...............................................................1256
14.8.47 Querying Wi-Fi Statistics (LST-ONTAPWIFISTATISTICS)............................................................................ 1264
14.8.48 Querying the Wi-Fi Device Information (LST-ONTWIFIDEVICE).............................................................1270
14.8.49 Querying the Online External AP Information (LST-ONTEXTERNALAP)..............................................1277
14.8.50 Querying the AP Neighbor Information (LST-ONTAPNEIGHBOR)......................................................... 1282
14.8.51 Querying the number of connected ONT users (LST-ONTUSER)........................................................... 1289
14.8.52 Querying the Queue Packet Loss Statistics of GPON TCONT (LST-GPONONTPRIORITYQUEUE)
....................................................................................................................................................................................................... 1295
14.8.53 Querying VAS Profile (LST-VASPROFILE).........................................................................................................1301
14.8.54 Querying ONT Load Task (LST-ONTLOADTASK).......................................................................................... 1302
14.9 Querying EPON Resources......................................................................................................................................... 1307
14.9.1 Querying Information About an Upstream EPON ONU Port (LST-EPONNNIPORT)......................... 1307
14.9.2 Querying the List of EPON ONTs (LST-EPONONT)....................................................................................... 1311
14.9.3 Querying Information About Auto-discovered EPON ONUs (LST-EPONONTAUTOFIND)............... 1328
14.9.4 Querying the Running Status of an ONT (LST-EPONONTRUNINFO)..................................................... 1332
14.9.5 Querying the Ethernet Port Details of an EPON ONT (LST-EPONONTETHPORTDETAIL)............... 1341
14.9.6 Querying the MAC Addresses Learned by the User Port of an FTTH ONU (LST-
EPONONTPORTMAC)............................................................................................................................................................ 1345
14.9.7 Querying the EPON Information of an MDU Device (LST-EPONBYONUDEV).....................................1351
14.9.8 Querying Optical Module Information About an EPON ONT (LST-EPONONTDDMDETAIL)..........1355

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. viii


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.9.9 Querying the Optical Module Information of an MDU NNI Port (LST-ONUNNIDDMDETAIL)......1363
14.9.10 Querying Details on EPON Optical Modules (LST-EPONSFP)................................................................. 1367
14.9.11 Querying Optical Module Information About an EPON Port (LST-EPONPORTDDMDETAIL).......1373
14.9.12 Querying the EPON Port Details (LST-EPONPORTDETAIL)...................................................................... 1379
14.9.13 Querying Real-Time Performance Data of an EPON Port (LST-EPONPONPORTPERF).................. 1384
14.9.14 Querying Real-Time Performance Data of Ethernet Traffic on an EPON UNI Port (LST-
EPONPORTPERF)..................................................................................................................................................................... 1389
14.9.15 Querying Real-Time Performance Data on an EPON ONT Ethernet Port (LST-
EPONONTETHPORTPERF)....................................................................................................................................................1393
14.9.16 Querying ONT SIP User Accounts (LST-ONTSIPINFOQUERY-ONTSIPINFO)...................................... 1398
14.9.17 Querying the VoIP Address of an ONT (LST-ONTVAGVOIP)....................................................................1404
14.9.18 Querying the ONT PSTN User Information (LST-ONTVOIPPSTNUSER)...............................................1410
14.9.19 Querying Call Record of an ONT Pots (LST-ONTPOTSCALLRECORD).................................................. 1422
14.9.20 Querying the ONT WLAN Information (LST-ONTUSERWLAN)...............................................................1427
14.9.21 Querying Wi-Fi Statistics (LST-ONTAPWIFISTATISTICS)............................................................................ 1436
14.9.22 Querying the Wi-Fi Device Information (LST-ONTWIFIDEVICE).............................................................1442
14.9.23 Querying the Online External AP Information (LST-ONTEXTERNALAP)..............................................1449
14.9.24 Querying the AP Neighbor Information (LST-ONTAPNEIGHBOR)......................................................... 1454
14.9.25 Querying the number of connected ONT users (LST-ONTUSER)........................................................... 1461
14.9.26 Querying the DBA Profile and CAR Profile Bound to an EPON ONT (LST-EPONONTDBACARPROF)
....................................................................................................................................................................................................... 1467
14.9.27 Querying a Global EPON Line Profile Name List(LST-GLOBALEPONLINEPROFILENAME)........... 1471
14.9.28 Querying a Global EPON Service Profile Name List (LST-GLOBALEPONSRVPROFILENAME)......1473
14.9.29 Querying EPON Line Profile Names (LST-EPONLINEPROFILE)............................................................... 1475
14.9.30 Querying EPON Service Profile Names (LST-EPONSRVPROFILE)........................................................... 1478
14.10 CNU Resource Query................................................................................................................................................. 1480
14.10.1 Querying the List of CNUs (LST-CNU)............................................................................................................. 1480
14.10.2 Querying the Details of a CNU (LST-CNUDETAIL).......................................................................................1485
14.11 Querying CM Resources............................................................................................................................................ 1491
14.11.1 Querying the Info of CM (LST-CMINFO)......................................................................................................... 1491
14.11.2 Querying the CPE List of a CM (LST-CMCPELIST)........................................................................................1494
14.11.3 Collecting Statistics on a CM (LST-CMNUMSTATIC)................................................................................... 1498
14.11.4 Querying the List of CMs (LST-CMLIST).......................................................................................................... 1504
14.11.5 Querying the Quality of CM Upstream Channels (LST-CMUPCHANNELINFO).................................1520
14.11.6 Querying the Quality of CM Downstream Channels (LST-CMDOWNCHANNELINFO).................. 1526
14.11.7 Querying the Downstream Channel Info List of RF Ports (LST-DOWNCHANNELINFO)................1531
14.11.8 Querying the Upstream Channel Info List of RF Ports (LST-UPCHANNELINFO).............................. 1536
14.11.9 Querying the Details of a CM (LST-CMDETAIL)............................................................................................1544
14.11.10 Querying the PNM Pre-equalization Coefficients of a CM (LST-CMPNM-EQD).............................1558
14.11.11 Querying the PNM Auxiliary Parameters of a CM (LST-CMPNM-SUB)............................................. 1571
14.11.12 Querying the Layer 2 VPN VLAN of a CM (LST-L2VPNVLAN).............................................................. 1585
14.11.13 Querying Amplifier Details (LST-AMPDETAIL)............................................................................................ 1589
14.12 Querying VLAN Resources....................................................................................................................................... 1595

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. ix


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.12.1 Querying the VLAN Information of a Device (LST-VLAN).........................................................................1596


14.12.2 Querying the Details of a VLAN (LST-VLANDETAIL)................................................................................... 1604
14.12.3 Querying the VLAN ID of an xDSL Port (LST-DSLPORTVLAN)................................................................ 1613
14.12.4 Querying the List of Ports in a VLAN (LST-PORTOFVLAN).......................................................................1617
14.12.5 Querying the VLAN ID of a Port (LST-VLANOFPORT)................................................................................ 1622
14.12.6 Querying the Transmission Feature of a VLAN (LST-VLANPERF)........................................................... 1626
14.12.7 Querying an L3 Interface (LST-VLANL3IF)...................................................................................................... 1635
14.13 Querying Ethernet Resources.................................................................................................................................. 1640
14.13.1 Querying the Details of an Ethernet Port (LST-ETHPORTDETAILINFO)............................................... 1640
14.13.2 Querying an Ethernet Aggregation Group (LST-LAG)................................................................................ 1649
14.13.3 Querying the List of Vlan in Aggregation Group (LST-VLANOFLAG)....................................................1655
14.13.4 Querying the Details of an SFP (LST-SFPDETAILINFO).............................................................................. 1659
14.13.5 Querying the SFP Information of a Device (LST-SFP).................................................................................1666
14.13.6 Querying the Upstream Traffic Information of an Ethernet Port (LST-ETHPORTSTATINFO).......1673
14.13.7 Querying the DDM Details of an Optical Module (LST-DDMDETAILINFO)........................................1679
14.13.8 Querying the Ethernet Transmission Statistics (LST-ETHPORTPERF).................................................... 1684
14.13.9 Querying the List of Ethernet Ports (LST-ETHPORT).................................................................................. 1693
14.13.10 Querying the MAC Addresses Learned by the Service Port of an FTTB ONU (LST-ETHPORTMAC)
....................................................................................................................................................................................................... 1698
14.13.11 Querying the Up Link Ethernet Transmission Statistics (LST-DEVUPLINK).......................................1704
14.14 Querying Service Virtual Port Resources.............................................................................................................1709
14.14.1 Querying Service Virtual Ports (LST-SERVICEPORT)....................................................................................1709
14.14.2 Querying the Service Port Information about NEs (LST-NESERVICEPORTDETAIL).......................... 1757
14.14.3 Querying the Details of a Service Virtual Port (LST-SERVICEPORTDETAIL)........................................1764
14.14.4 Querying the Static IP Addresses of a Service Port (LST-IP2SERVICEPORT)....................................... 1800
14.14.5 Querying the Performance Statistics of Service Ports (LST-SERVICEPORTPERF).............................. 1819
14.14.6 Querying CAR Groups (LST-CARGROUP)........................................................................................................ 1844
14.14.7 Querying Bundles of Service Virtual Ports (LST-SERVICEPORTBUNDLE).............................................1848
14.14.8 Querying the MAC Addresses Learned By a User Port and Its Service Port (LST-
PORTMACADDRESS).............................................................................................................................................................. 1852
14.14.9 Querying the 802.1x of a Service Port (LST-DOT1X2SERVICEPORT)..................................................... 1873
14.14.10 Querying the List of ONUs (LST-ONTSERVICEPORT)...............................................................................1891
14.15 Querying PVC Resources........................................................................................................................................... 1902
14.15.1 Querying the Information About a PVC (LST-PVC)..................................................................................... 1902
14.15.2 Querying the Information About a VPI (LST-VPI)........................................................................................ 1909
14.15.3 Querying the Information About a PVP (LST-PVP)......................................................................................1913
14.15.4 Querying Anti-DoS Attack Information of Service Flows (LST-ANTIDOS).......................................... 1920
14.16 Querying TDM E1 Resources................................................................................................................................... 1925
14.16.1 Querying Local TDM E1 Connections (LST-NATIVETDMCONN).............................................................1925
14.16.2 Querying the Attribute of a PRI E1 Port (LST-PRIE1)..................................................................................1935
14.17 Querying Traffic Profile Resources........................................................................................................................ 1940
14.17.1 Querying a global ATM Traffic Profile (LST-ATMTP).................................................................................. 1940
14.17.2 Querying an IP Traffic Profile (LST-IPTP)........................................................................................................ 1944

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. x


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.17.3 Querying a global MEF IP Traffic Profile (LST-MEFIPTP).......................................................................... 1948


14.17.4 Querying an NE-side MEF IP Traffic Profile (LST-NEMEFIPTP)............................................................... 1956
14.18 Querying PSTN Resources........................................................................................................................................ 1963
14.18.1 Querying a V5 PSTN User (LST-V5PSTNUSER)..............................................................................................1963
14.19 Querying the ISDN Resources................................................................................................................................. 1968
14.19.1 Querying a V5 ISDN BRA User (LST-V5BRAUSER)....................................................................................... 1969
14.19.2 Querying a V5 ISDN PRA User (LST-V5PRAUSER)....................................................................................... 1973
14.20 Querying VoIP Resources.......................................................................................................................................... 1978
14.20.1 Querying a VoIP PSTN User (LST-VOIPPSTNUSER)..................................................................................... 1978
14.20.2 Querying the List of Configured VoIP PSTN Users (LST-VOIPPOTSBASIC)..........................................2005
14.20.3 Querying the Performance Data of a VoIP PSTN Port (LST-VOIPPSTNPERF).................................... 2016
14.20.4 Querying the Extended Telephone Numbers of a VoIP PSTN Port (LST-VOIPPSTNEXTTELNO)..2020
14.20.5 Querying the User Name and Password of a VoIP PSTN Port (LST-VOIPPSTNACCOUNT)...........2023
14.20.6 Querying Members of a CLI a CLI Account Group (LST-CGMEMBER)..................................................2026
14.20.7 Querying CLI Account Groups (LST-CLIGROUP)........................................................................................... 2029
14.20.8 Querying Service Rights and Service Data of VoIP PSTN Users (LST-VOIPPSTNSRV)..................... 2032
14.20.9 Querying a VoIP ISDN BRA User (LST-VOIPBRAUSER)............................................................................... 2045
14.20.10 Querying the List of Configured VoIP ISDN BRA Users (LST-VOIPBRABASIC).................................2070
14.20.11 Querying Authentication Information About a VoIP ISDN BRA Port (LST-VOIPBRAACCOUNT)
....................................................................................................................................................................................................... 2076
14.20.12 Querying Service Rights of a VoIP ISDN BRA Port (LST-VOIPBRASRV).............................................. 2079
14.20.13 Querying the Extended Phone Number of a VoIP ISDN BRA Port (LST-VOIPBRAEXTTELNO)...2086
14.20.14 Querying a VoIP ISDN PRA User (LST-VOIPPRAUSER).............................................................................2089
14.20.15 Querying the List of Configured VoIP ISDN PRA Users (LST-VOIPPRABASIC)................................. 2108
14.20.16 Querying Authentication Information About a VoIP ISDN PRA Port (LST-VOIPPRAACCOUNT)
....................................................................................................................................................................................................... 2114
14.20.17 Querying Service Rights of VoIP ISDN PRA Ports (LST-VOIPPRASRV)................................................ 2118
14.20.18 Querying the Extended Phone Number of a VoIP ISDN PRA Port (LST-VOIPPRAEXTTELNO)...2123
14.20.19 Querying the VBD Parameter of Voice Ports (LST-VOIPVBD)............................................................... 2126
14.20.20 Querying SIP User Groups (LST-USERGROUP)........................................................................................... 2130
14.20.21 Querying an MGC Global Profile (LST-MGCD)........................................................................................... 2136
14.20.22 Querying a VAG (LST-VAG)................................................................................................................................2138
14.20.23 Querying the MGCD Associated with a VAG (LST-MGCDOFVAG).......................................................2145
14.20.24 Querying a VSG (LST-VSG)................................................................................................................................ 2148
14.20.25 Querying an Association (LST-ASSOCIATION)............................................................................................2152
14.20.26 Querying the Hunting Group List (LST-HUNTINGGROU).......................................................................2156
14.20.27 Querying the Hunting Group Member List (LST-HGMEMBER)............................................................ 2162
14.20.28 Querying the Group Account List (LST-GROUPNUMBER)...................................................................... 2168
14.20.29 Querying Service Rights and Service Data for Group Accounts (LST-GROUPNUMBERSRV)......2171
14.20.30 Querying Authentication Information for Group Accounts (LST-GROUPNUMBERAUTH).......... 2177
14.20.31 Querying Call Release Cause Codes in a Hunting Group (LST-HUNTINGSTOPCAUSECODE)... 2181
14.20.32 Querying a Global Number Change Profile (LST-NUMCHGPROFILE)................................................2184
14.20.33 Querying the VBD Parameter of Voice Ports (LST-VOIPVBD)................................................................2187

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xi


iMaster NCE
Northbound TL1 Interface User Guide Contents

14.20.34 Querying Physical Information Corresponding to Telephone Numbers (LST-


TELNUMLOCATIONINFO).................................................................................................................................................... 2191
14.21 Querying SPC Resources........................................................................................................................................... 2193
14.21.1 Querying the List of SPCs (LST-SPC).................................................................................................................2193
14.21.2 Querying the Details of an SPC (DTL-SPC).....................................................................................................2202
14.22 Querying SPCM Resources....................................................................................................................................... 2215
14.22.1 Querying an SPCM User (LST-SPCMUSER).....................................................................................................2215
14.23 Querying ACL and QoS Resources........................................................................................................................ 2220
14.23.1 Querying ACL Groups (LST-ACLGRP)................................................................................................................ 2220
14.23.2 Querying the Subitems of an Extended ACL Group (LST-ACLEXTSUBITEM)...................................... 2224
14.23.3 Querying the Subitems of a Standard ACL Group (LST-ACLBASESUBITEM)...................................... 2232
14.23.4 Querying the Subitems of a Layer 2 ACL Group (LST-ACLLINKSUBITEM).......................................... 2236
14.23.5 Querying Port Rate Limit (LST-QOSRATELIMIT).......................................................................................... 2240
14.23.6 Querying a Traffic Limit on a Port (LST-QOSTRAFFICLIMIT)...................................................................2245
14.24 Querying HQoS Resources....................................................................................................................................... 2252
14.24.1 Querying the Information About a Port VLAN CAR(LST-HQOS)............................................................ 2252

15 Service Provisioning....................................................................................................... 2257


15.1 ADSL Service Provisioning.......................................................................................................................................... 2259
15.1.1 Creating an ADSL Line Profile (CRT-ADSLLINEPROFILE)............................................................................. 2259
15.1.2 Deleting an ADSL Line Profile (DEL-ADSLLINEPROFILE)............................................................................. 2274
15.1.3 Deleting an ADSL Line Profile from a Device (DEL-ADSLLPOFDEV)....................................................... 2276
15.1.4 Creating an ADSL Alarm Profile (CRT-ADSLALARMPROFILE).................................................................... 2278
15.1.5 Deleting an ADSL Alarm Profile (DEL-ADSLALARMPROFILE).................................................................... 2281
15.1.6 Deleting an ADSL Alarm Profile from a Device (DEL-ADSLAPOFDEV)................................................... 2283
15.1.7 Creating an ADSL Extended Profile (CRT-ADSLEXTENDPROFILE)............................................................ 2285
15.1.8 Deleting an ADSL Extended Profile (DEL-ADSLEXTENDPROFILE)............................................................ 2296
15.1.9 Deleting an ADSL Extended Profile from a Device (DEL-ADSLEPOFDEV)............................................. 2298
15.1.10 Activating an ADSL Port (ACT-ADSLPORT).................................................................................................... 2300
15.1.11 Deactivating an ADSL Port (DACT-ADSLPORT)............................................................................................ 2304
15.1.12 Modifying the Attributes of an ADSL Port (MOD-ADSLPORT)............................................................... 2308
15.1.13 Modifying the Attributes of an ADSL Port Through the Enhanced Command (MOD-ADSLPORTEX)
....................................................................................................................................................................................................... 2319
15.1.14 Modifying the Working Mode of an ADSL Port (MOD-ADSLWORKMODE)...................................... 2335
15.1.15 Blocking an ADSL Port (BLK-ADSLPORT)........................................................................................................2337
15.1.16 Unblocking an ADSL Port (UBLK-ADSLPORT)............................................................................................... 2339
15.1.17 Modifying the VLAN ID of an ADSL Port (MOD-DSLPORTVLAN)......................................................... 2342
15.1.18 Modifying the Alias of an ADSL Port (MOD-PORTNAME)....................................................................... 2345
15.1.19 Initializing an ADSL Port (INIT-ADSLPORT)................................................................................................... 2347
15.2 G.SHDSL Service Provisioning....................................................................................................................................2349
15.2.1 Creating an SHDSL Line Profile (CRT-SHDSLSPANPROFILE)...................................................................... 2350
15.2.2 Deleting an SHDSL Line Profile (DEL-SHDSLSPANPROFILE)...................................................................... 2360
15.2.3 Deleting an SHDSL Line Profile from a Device (DEL-SHDSLSPONDEV).................................................2362
15.2.4 Creating an SHDSL Alarm Profile (CRT-SHDSLALARMPROFILE).............................................................. 2364

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xii


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.2.5 Deleting an SHDSL Alarm Profile (DEL-SHDSLALARMPROFILE).............................................................. 2367


15.2.6 Deleting an SHDSL Alarm Profile from a Device (DEL-SHDSLALONDEV).............................................2369
15.2.7 Activating an SHDSL Port (ACT-SHDSLPORT)................................................................................................. 2371
15.2.8 Deactivating an SHDSL Port (DACT-SHDSLPORT)......................................................................................... 2373
15.2.9 Binding SHDSL Ports (BND-SHDSLPORT)......................................................................................................... 2375
15.2.10 Unbinding SHDSL Ports (UBND-SHDSLPORT).............................................................................................. 2378
15.2.11 Modifying the Attributes of an SHDSL Port (MOD-SHDSLPORT)..........................................................2381
15.2.12 Performing a Loopback on an SHDSL Port (LOOPBACK-SHDSLPORT)................................................ 2387
15.2.13 Canceling a Loopback Test on an SHDSL Port (ULOOPBACK-SHDSLPORT)...................................... 2391
15.2.14 Configuring the Chipset Mode of a Board (CFG-SHDSLBOARDCHIPSETMODE)..............................2393
15.2.15 Modifying the FE1 Attribute of a TDM SHDSL Port (MOD-SHDSLPORTFE1)................................... 2395
15.3 VDSL2 Service Provisioning........................................................................................................................................ 2400
15.3.1 Activating a VDSL2 Port (ACT-VDSL2PORT)..................................................................................................... 2400
15.3.2 Deactivating a VDSL2 Port (DACT-VDSL2PORT).............................................................................................2404
15.3.3 Modifying the Attributes of a VDSL2 Port (MOD-VDSL2PORT)................................................................2408
15.3.4 Modifying the Attributes of a VDSL2 Port Through the Enhanced Command (MOD-VDSL2PORTEX)
....................................................................................................................................................................................................... 2414
15.3.5 Activating a GPON ONT VDSL2 Port (ACT-ONTVDSL2PORT)................................................................... 2445
15.3.6 Deactivating a GPON ONT VDSL2 Port (DACT-ONTVDSL2PORT)........................................................... 2451
15.3.7 Modifying the Attributes of a GPON ONT VDSL2 Port (MOD-ONTVDSL2PORT).............................. 2456
15.3.8 Modifying the Attributes of a GPON ONT VDSL2 Port Through the Enhanced Command(MOD-
ONTVDSL2PORTEX)............................................................................................................................................................... 2461
15.4 G.fast Service Provisioning..........................................................................................................................................2472
15.4.1 Activating a G.fast Port (ACT-GFASTPORT)...................................................................................................... 2472
15.4.2 Deactivating a G.fast Port (DACT-GFASTPORT).............................................................................................. 2476
15.4.3 Modifying the Attributes of a G.fast Port (MOD-GFASTPORT)................................................................. 2479
15.4.4 Binding a G.fast TDD Profile (MOD-GFASTPROFILE)....................................................................................2485
15.5 Bonding Group Management....................................................................................................................................2487
15.5.1 Adding a Bonding Group (ENT-BONDGRP)...................................................................................................... 2487
15.5.2 Modifying the Attributes of a Bonding Group (ED-BONDGRP)................................................................ 2494
15.5.3 Deleting a Bonding Group (DLT-BONDGRP).................................................................................................... 2500
15.5.4 Activating a Bonding Group (ACT-BONDGRP)................................................................................................ 2503
15.5.5 Deactivating a Bonding Group (DACT-BONDGRP)........................................................................................ 2506
15.5.6 Associating Ports with a Bonding Group (ASS-BONDGRP).........................................................................2509
15.5.7 Disassociating Ports from a Bonding Group (DASS-BONDGRP)............................................................... 2513
15.6 Video Service Provisioning.......................................................................................................................................... 2516
15.6.1 Provisioning the Multicast Service (JOIN-NTVUSR/JOIN-NTV)................................................................. 2517
15.6.2 Modifying the Attributes of a Multicast User (MOD-NTVUSR/MOD-NTVPORT)...............................2558
15.6.3 Stopping the Multicast Service (QUIT-NTV)..................................................................................................... 2589
15.6.4 Suspending the Multicast Service (BLK-NTVPORT)....................................................................................... 2606
15.6.5 Re-provisioning the Multicast Service (UBLK-NTVPORT)............................................................................ 2621
15.6.6 Adding Rights Profiles for a Multicast User (BND-NTVUSRRP/BND-NTVRP)...................................... 2635
15.6.7 Deleting Rights Profiles of a Multicast User (UBND-NTVUSRRP/UBND-NTVRP)...............................2650

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xiii


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.6.8 Adding a Program Profile to a Device (ADD-NTVPROGRAM)................................................................... 2665


15.6.9 Deleting a Program Profile from a Device (DEL-NTVPROGRAM).............................................................2676
15.6.10 Binding or Unbinding Rights Profiles on Schedule (BND-NTVUSRRP-SCHEDULE)..........................2679
15.6.11 Binding Rights Profiles with an NE (BND-NTVALLUSRRP)....................................................................... 2695
15.6.12 Unbinding Rights Profiles from an NE (UBND-NTVALLUSRRP)..............................................................2699
15.6.13 Adding a Multicast VLAN (ADD-IGMPVLAN)................................................................................................ 2703
15.6.14 Deleting a Multicast VLAN (DEL-IGMPVLAN)............................................................................................... 2712
15.6.15 Adding a Multicast Subtend Port (ADD-NTVCASCADE)............................................................................2715
15.6.16 Deleting a Multicast Subtend Port (DEL-NTVCASCADE)........................................................................... 2722
15.6.17 Adding a Virtual Upstream Port of a Multicast VLAN (ADD-IGMPUPLINKPORT)........................... 2726
15.6.18 Deleting a Virtual Upstream Port of a Multicast VLAN (DEL-IGMPUPLINKPORT).......................... 2730
15.7 GPON Service Provisioning.........................................................................................................................................2734
15.7.1 Adding an ONU (ADD-ONT)................................................................................................................................. 2734
15.7.2 Modifying an ONU (MOD-ONT).......................................................................................................................... 2753
15.7.3 Deleting an ONT (DEL-ONT)................................................................................................................................. 2769
15.7.4 Activating an ONT (ACT-ONT).............................................................................................................................. 2776
15.7.5 Deactivating an ONT (DACT-ONT)...................................................................................................................... 2781
15.7.6 Resetting an ONT (RESET-ONT)........................................................................................................................... 2786
15.7.7 Binding a DBA Profile to an ONT (BIND-ONTDBAPROF)........................................................................... 2791
15.7.8 Modifying the DBA Profile Bound to an ONT (MOD-ONTDBAPROF).................................................... 2796
15.7.9 Unbinding a DBA Profile from an ONT (DBIND-ONTDBAPROF)............................................................. 2801
15.7.10 Adding a User VLAN for an ONT (ADD-ONTPORTVLAN)........................................................................ 2806
15.7.11 Deleting a User VLAN from an ONT (DEL-ONTPORTVLAN)................................................................... 2812
15.7.12 Binding an ONT Port to a User VLAN (BIND-ONTPORTVLAN).............................................................. 2819
15.7.13 Unbinding an ONT Port from a User VLAN (DBIND-ONTPORTVLAN)................................................2826
15.7.14 Adding a Binding Group for Ethernet Ports on a GPON ONT (ADD-ONTPORTBUNDLE)............ 2833
15.7.15 Deleting a Binding Group of Ethernet Ports on a GPON ONT (DEL-ONTPORTBUNDLE)............. 2837
15.7.16 Adding a VLAN Switching Pair for an Ethernet Port on a GPON ONT (ADD-
ONTETHVLANSWTICHPAIR)................................................................................................................................................2841
15.7.17 Deleting a VLAN Switching Pair from an Ethernet Port on a GPON ONT (DEL-
ONTETHVLANSWTICHPAIR)................................................................................................................................................2850
15.7.18 Resetting the Function for Enabling the Discovery of the ONT SN (RESET-ONTSNSWITCH)......2858
15.7.19 Adding a GEM Port (ADD-GEMPORT)............................................................................................................. 2863
15.7.20 Modifying a GEM Port (MOD-GEMPORT)..................................................................................................... 2867
15.7.21 Deleting a GEM Port (DEL-GEMPORT)............................................................................................................ 2874
15.7.22 Binding a GEM Port to an ONT (BIND-ONTGEMPORT)............................................................................2876
15.7.23 Unbinding a GEM Port from an ONT (DBIND-ONTGEMPORT)............................................................. 2881
15.7.24 Adding a GEM Connection (ADD-GEMCONNECTION).............................................................................. 2883
15.7.25 Modifying a GEM Connection (MOD-GEMCONNECTION)...................................................................... 2892
15.7.26 Deleting a GEM Connection (DEL-GEMCONNECTION)............................................................................. 2901
15.7.27 Modifying the User Port of an ONT (MOD-ONTPORT)............................................................................ 2906
15.7.28 Configuring a Customized VAS of a GPON Terminal (CFG-ONTVAINDIV).........................................2923
15.7.29 Configuring the GPON FTTH Service (CFG-ONTSVC)................................................................................ 2943

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xiv


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.7.30 Configuring the GPON FTTB Service (CFG-PORTSVC)............................................................................... 2961


15.7.31 Adding the CoS for a GEM Port (ADD-GEMPORTCOS)............................................................................. 2970
15.7.32 Deleting the CoS of a GEM Port (DEL-GEMPORTCOS).............................................................................. 2978
15.7.33 Modifying the Configuration Information of a GPON Port (MOD-GPONPORT)..............................2983
15.7.34 Adding the IP Configuration to an ONT (ADD-ONTIPCONFIG)............................................................. 2987
15.7.35 Configuring ONT Voice Users (CFG-ONT-POTS).......................................................................................... 2992
15.7.36 Deleting ONT Voice Services (DLT-ONT-POTS)............................................................................................. 3006
15.7.37 Replacing a GPON ONU (REPLACE-ONT)...................................................................................................... 3009
15.7.38 Deleting a GPON MDU Replacement Task (DEL-ONTRM).......................................................................3017
15.7.39 Canceling an MDU Replacement Task (CANCEL-ONTRM)....................................................................... 3024
15.7.40 Configuring the WAN Port VLAN of an ONT (CFG-ONTVLAN)..............................................................3031
15.7.41 Configuring the TR-069 Management Channel for a GPON ONT (CFG-ACSSERVERINFO)......... 3035
15.7.42 Changing the Password for Logging In to the Local ONT Web Page (SET-ONTUSERINFO)........ 3045
15.7.43 Creating a Global GPON Line Profile(ADD-GLOBALGPONLINEPROFILE)...........................................3051
15.7.44 Deleting a Global GPON Line Profile(DEL-GLOBALGPONLINEPROFILE).............................................3055
15.7.45 Creating a Global GPON Service Profile (ADD-GLOBALGPONSRVPROFILE)..................................... 3057
15.7.46 Deleting a Global GPON Service Profile (DEL-GLOBALGPONSRVPROFILE)....................................... 3062
15.7.47 Deleting a Global GPON DBA Profile (DEL-GLOBALDBAPROFILE)........................................................3064
15.7.48 Creating a Global GPON DBA Profile (ADD-GLOBALDBAPROFILE)...................................................... 3066
15.7.49 Add the ONT WLAN (ADD-ONTUSERWLAN)............................................................................................... 3069
15.7.50 Configuring the ONT WLAN (CFG-ONTUSERWLAN)................................................................................. 3075
15.7.51 Delete the ONT WLAN Information (DEL-ONTUSERWLAN)................................................................... 3084
15.8 EPON Service Provisioning......................................................................................................................................... 3089
15.8.1 Adding an EPON ONT (ADD-EPONONT)..........................................................................................................3089
15.8.2 Modifying an EPON ONT (MOD-EPONONT).................................................................................................. 3109
15.8.3 Modifying an EPON ONT Port (MOD-EPONONTPORT)..............................................................................3123
15.8.4 Deleting an EPON ONT (DEL-EPONONT).........................................................................................................3131
15.8.5 Activating an EPON ONT (ACT-EPONONT)..................................................................................................... 3137
15.8.6 Deactivating an EPON ONT (DACT-EPONONT)............................................................................................. 3142
15.8.7 Resetting an EPON ONT (RESET-EPONONT)...................................................................................................3147
15.8.8 Configuring a Customized VAS of an EPON Terminal (CFG-ONTVAINDIV)......................................... 3151
15.8.9 Configuring the EPON FTTB Service (CFG-PORTSVC).................................................................................. 3194
15.8.10 Adding CoS for Rate Limitation of an EPON ONT (ADD-ONTCOS)......................................................3203
15.8.11 Deleting CoS for Rate Limitation of an EPON ONT (DEL-ONTCOS).....................................................3208
15.8.12 Configuration for Querying User-Defined ONT Parameters (SYN-ONTXML)....................................3211
15.8.13 Configuring the WAN Port VLAN of an ONT (CFG-ONTVLAN)..............................................................3214
15.8.14 Configuring the TR-069 Management Channel for an EPON ONT (CFG-EPONACSSERVERINFO)
....................................................................................................................................................................................................... 3217
15.8.15 Changing the Password for Logging In to the Local ONT Web Page (SET-ONTUSERINFO)........ 3227
15.8.16 Add the ONT WLAN (ADD-ONTUSERWLAN)............................................................................................... 3234
15.8.17 Configuring the ONT WLAN (CFG-ONTUSERWLAN)................................................................................. 3241
15.8.18 Delete the ONT WLAN Information (DEL-ONTUSERWLAN)................................................................... 3250
15.8.19 Adding the IP Configuration to an EPON ONT (ADD-EPONONTIPCONFIG).....................................3254

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xv


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.8.20 Modifying the DBA Profile and CAR Profile Bound to an EPON ONT (MOD-
EPONONTDBACARPROF)..................................................................................................................................................... 3260
15.9 CNU Service Provisioning............................................................................................................................................ 3263
15.9.1 Adding a CNU (ADD-CNU).....................................................................................................................................3264
15.9.2 Modifying a CNU (MOD-CNU)............................................................................................................................. 3269
15.9.3 Activating a CNU (ACT-CNU)................................................................................................................................ 3275
15.9.4 Deactivating a CNU (DACT-CNU)........................................................................................................................ 3279
15.9.5 Resetting a CNU (RESET-CNU)..............................................................................................................................3283
15.9.6 Deleting a CNU (DEL-CNU)....................................................................................................................................3287
15.9.7 Modifying a UNI Port on a CNU (MOD-CNUPORT)..................................................................................... 3291
15.9.8 Configuring a CBAT UNI Port (CFG-CBATUNI)................................................................................................3297
15.10 CM Service Provisioning............................................................................................................................................ 3301
15.10.1 Resetting or Deleting a CM (REBOOT-CM).................................................................................................... 3301
15.10.2 Starting a CMC Upstream Frequency Scan (START-CMC-FFT)................................................................ 3304
15.10.3 Stopping a CMC Upstream Frequency Scan (STOP-CMC-FFT)................................................................3308
15.10.4 Querying CMC Upstream Frequency Scan Data (LST-CMC-FFT)............................................................3311
15.10.5 Creating a PNM Performance Monitoring Task (CRE-PNM-TSK)........................................................... 3315
15.10.6 Deleting a PNM Performance Monitoring Task (DEL-PNM-TSK)........................................................... 3321
15.10.7 Modifying a PNM Performance Monitoring Task (MOD-PNM-TSK)..................................................... 3326
15.11 VLAN Service Management..................................................................................................................................... 3333
15.11.1 Adding a VLAN (ADD-VLAN).............................................................................................................................. 3333
15.11.2 Deleting a VLAN (DEL-VLAN)..............................................................................................................................3346
15.11.3 Modifying a VLAN (MOD-VLAN)....................................................................................................................... 3353
15.11.4 Associating an Ethernet Port with a VLAN (ASS-ETHPORTANDVLAN)................................................3363
15.11.5 Disassociating an Ethernet Port from a VLAN (DASS-ETHPORTANDVLAN)...................................... 3370
15.11.6 Setting the VLAN That Is Allowed to Pass Through a Trunk Port (CFG-VLANTRUNKPORT)........3376
15.11.7 Adding an IP Interface (ADD-IPINTERFACE).................................................................................................. 3378
15.11.8 Deleting an IP Interface (DEL-IPINTERFACE)................................................................................................. 3383
15.11.9 Adding an L3 Interface (ADD-VLANL3IF)....................................................................................................... 3387
15.11.10 Deleting an L3 Interface (DEL-VLANL3IF).................................................................................................... 3394
15.11.11 Activating an L3 Interface (ACT-VLANL3IF)................................................................................................. 3399
15.11.12 Deactivating an L3 Interface (DACT-VLANL3IF)......................................................................................... 3403
15.12 Ethernet Service Provisioning.................................................................................................................................. 3407
15.12.1 Configuring an Ethernet Port (MOD-ETHPORT).......................................................................................... 3407
15.12.2 Configuring the LACP Priority of an Ethernet Port (MOD-PORTLACP)................................................3416
15.12.3 Activating an Ethernet Port (ACT-ETHPORT)................................................................................................ 3420
15.12.4 Deactivating an Ethernet Port (DACT-ETHPORT)........................................................................................ 3426
15.12.5 Adding an Ethernet Aggregation Group (ADD-LAG).................................................................................. 3432
15.12.6 Modifying an Ethernet Aggregation Group (MOD-LAG).......................................................................... 3443
15.12.7 Deleting an Ethernet Aggregation Group (DEL-LAG)................................................................................. 3454
15.12.8 Associating Ports with an Ethernet Aggregation Group (ASS-LAG)...................................................... 3458
15.12.9 Disassociating Ports from an Ethernet Aggregation Group (DASS-LAG)............................................ 3465
15.13 Service Virtual Port Provisioning............................................................................................................................ 3469

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xvi


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.13.1 Modifying a Service Virtual Port (MOD-SERVICEPORT)............................................................................ 3469


15.13.2 Adding a Service Virtual Port (CRT-SERVICEPORT)..................................................................................... 3490
15.13.3 Deleting a Service Virtual Port (DEL-SERVICEPORT).................................................................................. 3540
15.13.4 Binding an xDSL Channel to a Service Virtual Port (BIND-CHANNEL)................................................ 3567
15.13.5 Activating a Service Virtual Port (ACT-SERVICEPORT)............................................................................... 3576
15.13.6 Deactivating a Service Virtual Port (DACT-SERVICEPORT)....................................................................... 3600
15.13.7 Adding a Static IP Address to a Service Virtual Port (ADD-IP2SERVICEPORT).................................. 3624
15.13.8 Deleting the Static IP Address of a Service Virtual Port (DEL-IP2SERVICEPORT)............................. 3646
15.13.9 Adding a CAR Group for Service Virtual Ports (ADD-CARGROUP)........................................................ 3669
15.13.10 Modifying a CAR Group for Service Virtual Ports (MOD-CARGROUP).............................................. 3673
15.13.11 Adding a Member to a CAR Group (ADD-CARGROUPMEMBER)........................................................ 3676
15.13.12 Deleting a Member from a CAR Group (DEL-CARGROUPMEMBER).................................................. 3692
15.13.13 Deleting a CAR Group for Service Virtual Ports (DEL-CARGROUP).....................................................3707
15.13.14 Adding a Bundle for Service Virtual Ports (ADD-SERVICEPORTBUNDLE)........................................ 3710
15.13.15 Deleting a Bundle of Service Virtual Ports (DEL-SERVICEPORTBUNDLE)......................................... 3715
15.13.16 Adding a MAC Address to a Service Virtual Port (ADD-MAC2SERVICEPORT)................................ 3718
15.13.17 Deleting the MAC Address of a Service Virtual Port (DEL-MAC2SERVICEPORT)........................... 3739
15.13.18 Config a 802.1x to a Service Virtual Port (CFG-DOT1X2SERVICEPORT)............................................3760
15.14 PVC Service Provisioning........................................................................................................................................... 3780
15.14.1 Creating an ADSL-ATM PVC (CRT-ADSLATMPVC)....................................................................................... 3780
15.14.2 Creating an ADSL-LAN PVC (CRT-ADSLLANPVC)......................................................................................... 3789
15.14.3 Creating an ADSL-CES PVC (CRT-ADSLCESPVC)........................................................................................... 3798
15.14.4 Creating an ATM-ATM PVC (CRT-ATMATMPVC)......................................................................................... 3805
15.14.5 Deleting a PVC (DEL-PVC).................................................................................................................................... 3809
15.14.6 Creating a PVC (CRT-PVC).................................................................................................................................... 3816
15.14.7 Modifying a PVC (MOD-PVC)............................................................................................................................. 3824
15.14.8 Setting the Anti-DoS Attack Parameters (MOD-ANTIDOS)..................................................................... 3834
15.14.9 Activating a PVC (ACT-PVC).................................................................................................................................3838
15.14.10 Deactivating a PVC (DACT-PVC)...................................................................................................................... 3843
15.14.11 Switching the Multi-PVC Service Mode of an ADSL Port (CHG-PVCMD)......................................... 3848
15.15 TDM E1 Service Provisioning................................................................................................................................... 3851
15.15.1 Creating a Local TDM E1 Connection (CRT-NATIVETDMCONN)........................................................... 3851
15.15.2 Deleting a Local TDM E1 Connection (DEL-NATIVETDMCONN)........................................................... 3857
15.15.3 Modifying the Attribute of a PRI E1 Port (MOD-PRIE1)............................................................................ 3864
15.16 Traffic Profile Management.................................................................................................................................... 3872
15.16.1 Creating an ATM Traffic Profile (CRT-TRAFFICPROFILE)........................................................................... 3873
15.16.2 Deleting an ATM Traffic Profile (DEL-TRAFFICPROFILE)........................................................................... 3879
15.16.3 Creating an IP Traffic Profile (CRT-IPTRAFFICPROFILE).............................................................................3881
15.16.4 Deleting an IP Traffic Profile (DEL-IPTRAFFICPROFILE).............................................................................3884
15.16.5 Creating an MEF IP Traffic Profile (CRT-MEFIPTRAFFICPROFILE).......................................................... 3886
15.16.6 Deleting an MEF IP Traffic Profile (DEL-MEFIPTRAFFICPROFILE).......................................................... 3891
15.17 PSTN Service Provisioning........................................................................................................................................ 3894

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xvii


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.17.1 Adding a V5 PSTN User (ADD-V5PSTNUSER)............................................................................................... 3894


15.17.2 Modifying a V5 PSTN User (MOD-V5PSTNUSER)........................................................................................3900
15.17.3 Deleting a V5 PSTN User (DEL-V5PSTNUSER).............................................................................................. 3906
15.17.4 Blocking a V5 PSTN Port (BLK-V5PSTNPORT)...............................................................................................3909
15.17.5 Unblocking a V5 PSTN Port (UBK-V5PSTNPORT)........................................................................................ 3912
15.17.6 Resetting a V5 PSTN Port (RST-V5PSTNPORT)............................................................................................. 3915
15.17.7 Looping Back a V5 PSTN Port (LBK-V5PSTNPORT)..................................................................................... 3917
15.17.8 Canceling the Loopback on a V5 PSTN Port (CLB-V5PSTNPORT)......................................................... 3920
15.18 ISDN Service Provisioning........................................................................................................................................ 3922
15.18.1 Adding a V5 ISDN BRA User (ADD-V5BRAUSER).........................................................................................3923
15.18.2 Modifying a V5 ISDN BRA User (MOD-V5BRAUSER)................................................................................. 3926
15.18.3 Deleting a V5 ISDN BRA User (DEL-V5BRAUSER)........................................................................................3929
15.18.4 Blocking a V5 ISDN BRA Port (BLK-V5BRAPORT)........................................................................................ 3932
15.18.5 Unblocking a V5 ISDN BRA Port (UBK-V5BRAPORT)..................................................................................3935
15.18.6 Resetting a V5 ISDN BRA Port (RST-V5BRAPORT)....................................................................................... 3938
15.18.7 Looping Back a V5 ISDN BRA Port (LBK-V5BRAPORT).............................................................................. 3940
15.18.8 Canceling the Loopback on a V5 ISDN BRA Port (CLB-V5BRAPORT)................................................... 3945
15.18.9 Adding a V5 ISDN PRA User (ADD-V5PRAUSER)......................................................................................... 3948
15.18.10 Modifying a V5 ISDN PRA User (MOD-V5PRAUSER)............................................................................... 3950
15.18.11 Deleting a V5 ISDN PRA User (DEL-V5PRAUSER)......................................................................................3952
15.18.12 Blocking a V5 ISDN PRA Port (BLK-V5PRAPORT)...................................................................................... 3955
15.18.13 Unblocking a V5 ISDN PRA Port (UBK-V5PRAPORT)............................................................................... 3958
15.19 VoIP Service Provisioning.......................................................................................................................................... 3960
15.19.1 Adding a VoIP PSTN User (ADD-VOIPPSTNUSER)....................................................................................... 3960
15.19.2 Modifying a VoIP PSTN User (MOD-VOIPPSTNUSER)............................................................................... 3986
15.19.3 Deleting a VoIP PSTN User (DEL-VOIPPSTNUSER)...................................................................................... 4001
15.19.4 Enabling the VoIP PSTN Service (ACT-VOIPPSTNSERV)............................................................................. 4006
15.19.5 Configuring VoIP PSTN Service Rights and Service Data (CFG-VOIPPSTNSRV)................................ 4011
15.19.6 Disabling a VoIP PSTN Service (DACT-VOIPPSTNSERV).............................................................................4025
15.19.7 Modifying a VoIP PSTN Port (MOD-VOIPPSTNPORT)................................................................................4033
15.19.8 Resetting a VoIP PSTN Port (RST-VOIPPSTNPORT)..................................................................................... 4036
15.19.9 Looping Back a VoIP PSTN Port (LBK-VOIPPSTNPORT).............................................................................4039
15.19.10 Canceling the Loopback on a VoIP PSTN Port (CLB-VOIPPSTNPORT)...............................................4043
15.19.11 Enabling the Automatic Gain of a VoIP PSTN Port (BAG-VOIPPSTNPORT).....................................4046
15.19.12 Configuring the Extended Telephone Number of a VoIP PSTN Port (CFG-VOIPPSTNEXTTELNO)
....................................................................................................................................................................................................... 4050
15.19.13 Configuring the User Name and Password of a VoIP PSTN Port (CFG-VOIPPSTNACCOUNT).. 4053
15.19.14 Adding a VoIP ISDN BRA User (ADD-VOIPBRAUSER).............................................................................. 4056
15.19.15 Modifying a VoIP ISDN BRA User (MOD-VOIPBRAUSER)...................................................................... 4068
15.19.16 Deleting a VoIP ISDN BRA User (DEL-VOIPBRAUSER)............................................................................. 4088
15.19.17 Enabling the VoIP ISDN BRA Service (ACT-VOIPBRASERV).................................................................... 4092
15.19.18 Configuring Service Rights for a VoIP ISDN BRA Port (CFG-VOIPBRASRV)...................................... 4095
15.19.19 Configuring Authentication Information for VoIP ISDN BRA Ports (CFG-VOIPBRAACCOUNT).4101

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xviii


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.19.20 Disabling a VoIP ISDN BRA Service (DACT-VOIPBRASERV)....................................................................4105


15.19.21 Resetting a VoIP ISDN BRA Port (RST-VOIPBRAPORT)............................................................................ 4111
15.19.22 Looping Back a VoIP ISDN BRA Port (LBK-VOIPBRAPORT)....................................................................4114
15.19.23 Canceling the Loopback on a VoIP ISDN BRA Port (CLB-VOIPBRAPORT)........................................ 4119
15.19.24 Activating a VoIP ISDN BRA Port (ACT-VOIPBRAPORT).......................................................................... 4122
15.19.25 Deactivating a VoIP ISDN BRA Port (DACT-VOIPBRAPORT).................................................................. 4125
15.19.26 Configuring the Extended Phone Number of a VoIP ISDN BRA Port (CFG-VOIPBRAEXTTELNO)
....................................................................................................................................................................................................... 4128
15.19.27 Adding a VoIP ISDN PRA User (ADD-VOIPPRAUSER).............................................................................. 4131
15.19.28 Modifying a VoIP ISDN PRA User (MOD-VOIPPRAUSER).......................................................................4141
15.19.29 Deleting a VoIP ISDN PRA User (DEL-VOIPPRAUSER)............................................................................. 4151
15.19.30 Enabling the VoIP ISDN PRA Service (ACT-VOIPPRASERV).................................................................... 4153
15.19.31 Configuring Service Rights for a VoIP ISDN PRA Port (CFG-VOIPPRASRV)...................................... 4155
15.19.32 Configuring Authentication Information for VoIP ISDN PRA Accounts (CFG-VOIPPRAACCOUNT)
....................................................................................................................................................................................................... 4158
15.19.33 Disabling the VoIP ISDN PRA Service (DACT-VOIPPRASERV)................................................................ 4162
15.19.34 Configuring the Extended Phone Number of a VoIP ISDN PRA Port (CFG-VOIPPRAEXTTELNO)
....................................................................................................................................................................................................... 4167
15.19.35 Adding a SIP User Group (ADD-USERGROUP)........................................................................................... 4170
15.19.36 see Usage Note.Modifying a SIP User Group (MOD-USERGROUP)....................................................4176
15.19.37 Deleting a SIP User Group (DEL-USERGROUP).......................................................................................... 4182
15.19.38 Adding an MGC Global Profile (ADD-MGCD).............................................................................................4184
15.19.39 Deleting an MGC Global Profile (DEL-MGCD)............................................................................................4189
15.19.40 Adding a VAG (ADD-VAG)................................................................................................................................. 4190
15.19.41 Modifying a VAG (MOD-VAG)..........................................................................................................................4225
15.19.42 Deleting a VAG (DEL-VAG)................................................................................................................................ 4237
15.19.43 Activating a VAG (ACT-VAG)............................................................................................................................. 4241
15.19.44 Deactivating a VAG (DACT-VAG)..................................................................................................................... 4245
15.19.45 Associating an MGCD with a VAG (ASS-MGCDANDVAG)......................................................................4249
15.19.46 Disassociating an MGCD from a VAG (DASS-MGCDANDVAG)............................................................ 4253
15.19.47 Binding a VAG to a TID Profile (MOD-VAGTIDPROFILE)........................................................................ 4255
15.19.48 Modifying the H.248 Profile Bound to the VAG (MOD-VAGH248PROFILE).................................... 4259
15.19.49 Adding a VSG (ADD-VSG).................................................................................................................................. 4261
15.19.50 Deleting a VSG (DEL-VSG)................................................................................................................................. 4264
15.19.51 Creating an Association (ADD-ASSOCIATION)...........................................................................................4266
15.19.52 Deleting an Association (DEL-ASSOCIATION)............................................................................................ 4269
15.19.53 Adding a Hunting Group (ADD-HUNTINGGROUP).................................................................................. 4272
15.19.54 Modifying a Hunting Group (MOD-HUNTINGGROUP).......................................................................... 4277
15.19.55 Deleting a Hunting Group (DEL-HUNTINGGROUP)................................................................................. 4282
15.19.56 Adding a Hunting Group Member (ADD-HGMEMBER).......................................................................... 4285
15.19.57 Modifying a Hunting Group Member (MOD-HGMEMBER)...................................................................4291
15.19.58 Deleting a Hunting Group Member (DEL-HGMEMBER)......................................................................... 4297
15.19.59 Adding a Group Account (ADD-GROUPNUMBER)....................................................................................4300

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xix


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.19.60 Modifying a Group Account (MOD-GROUPNUMBER)............................................................................ 4304


15.19.61 Activating a Group Account (ACT-GROUPNUMBER)............................................................................... 4308
15.19.62 Deactivating a Group Account (DACT-GROUPNUMBER)....................................................................... 4310
15.19.63 Deleting a Group Account (DEL-GROUPNUMBER)...................................................................................4312
15.19.64 Configuring Service Rights and Service Data for Group Accounts (CFG-GROUPNUMBERSRV)4314
15.19.65 Configuring Authentication Information for Group Accounts (CFG-GROUPNUMBERAUTH)....4322
15.19.66 Adding a CLI Account Group (ADD-CLIGROUP)........................................................................................ 4325
15.19.67 Deleting a CLI Account Group (DEL-CLIGROUP)....................................................................................... 4328
15.19.68 Adding a Member to a CLI Account Group (ADD-CGMEMBER).......................................................... 4331
15.19.69 Deleting a Member from a CLI Account Group (DEL-CGMEMBER)....................................................4334
15.19.70 Adding a Call Release Cause Code to a Hunting Group(ADD-HUNTINGSTOPCAUSECODE).... 4337
15.19.71 Deleting a Call Release Cause Code from a Hunting Group (DEL-HUNTINGSTOPCAUSECODE)
....................................................................................................................................................................................................... 4339
15.19.72 Creating a Global Number Change Profile (CRT-NUMCHGPROFILE)................................................ 4342
15.19.73 Deleting a Global Number Change Profile (DEL-NUMCHGPROFILE)................................................ 4345
15.19.74 Setting VBD Parameters of Voice Ports (CFG-VOIPVBD)........................................................................ 4347
15.20 SPC Service Provisioning........................................................................................................................................... 4350
15.20.1 Adding an SPC (ADD-SPC)................................................................................................................................... 4350
15.20.2 Modifying an SPC (MOD-SPC)............................................................................................................................4360
15.20.3 Deleting an SPC (DEL-SPC).................................................................................................................................. 4363
15.20.4 Setting Up an SPC (CON-SPC)............................................................................................................................ 4367
15.20.5 Releasing an SPC (DISCON-SPC)....................................................................................................................... 4370
15.21 SPCM Service Provisioning....................................................................................................................................... 4374
15.21.1 Adding an SPCM User (ADD-SPCMUSER)...................................................................................................... 4374
15.21.2 Modifying an SPCM User (MOD-SPCMUSER)............................................................................................... 4378
15.21.3 Deleting an SPCM User (DEL-SPCMUSER)..................................................................................................... 4382
15.22 ACL and QoS Management..................................................................................................................................... 4384
15.22.1 Adding an ACL Group (ADD-ACLGRP)............................................................................................................. 4384
15.22.2 Deleting an ACL Group (DEL-ACLGRP)............................................................................................................ 4389
15.22.3 Adding a Subitem to an Extended ACL Group (ADD-ACLEXTSUBITEM)............................................. 4393
15.22.4 Deleting a Subitem from an Extended ACL Group (DEL-ACLEXTSUBITEM)....................................... 4402
15.22.5 Activating the Subitem of an Extended ACL Group (ACT-ACLEXTSUBITEM)..................................... 4405
15.22.6 Deactivating the Subitem of an Extended ACL Group (DACT-ACLEXTSUBITEM)............................. 4408
15.22.7 Adding the QoS Priority (ADD-QOSPRIORITY)............................................................................................. 4410
15.22.8 Deleting the QoS Priority (DEL-QOSPRIORITY)............................................................................................ 4416
15.22.9 Adding a Subitem to a Standard ACL Group (ADD-ACLBASESUBITEM)............................................. 4421
15.22.10 Deleting the Subitem from a Standard ACL Group (DEL-ACLBASESUBITEM).................................4425
15.22.11 Adding a Subitem to a Layer 2 ACL Group (ADD-ACLLINKSUBITEM)............................................... 4428
15.22.12 Deleting a Subitem from a Layer 2 ACL Group (DEL-ACLLINKSUBITEM).........................................4433
15.22.13 Setting a Traffic Limit on a Port (ADD-QOSTRAFFICLIMIT).................................................................. 4435
15.22.14 Removing a Traffic Limit from a Port (DEL-QOSTRAFFICLIMIT)......................................................... 4443
15.22.15 Setting a Rate Limit on a Port (ADD-QOSRATELIMIT)............................................................................4450
15.22.16 Removing a Rate Limit from a Port (DEL-QOSRATELIMIT)................................................................... 4456

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xx


iMaster NCE
Northbound TL1 Interface User Guide Contents

15.23 HQoS Management................................................................................................................................................... 4459


15.23.1 Adding a Port VLAN CAR(CRT-HQOS)............................................................................................................. 4460
15.23.2 Modifying the Information About a Port VLAN CAR(MOD-HQOS)...................................................... 4463
15.23.3 Deleting a Port VLAN CAR(DEL-HQOS).......................................................................................................... 4466
15.23.4 Add One HQoS User(ADD-HQOSUSER)......................................................................................................... 4468
15.23.5 Modifying One HQoS User(MOD-HQOSUSER)............................................................................................ 4473
15.23.6 Querying the Information About a HQoS User(LST-HQOSUSER)..........................................................4478
15.23.7 Deleting One HQoS User(DEL-HQOSUSER).................................................................................................. 4485
15.23.8 Add One Member to the HQoS User(ADD-HQOSUSERMEMBER)........................................................ 4489
15.23.9 Deleting Members from an HQoS User(DEL-HQOSUSERMEMBER)..................................................... 4506
15.23.10 Querying a Member of the HQoS User(LST-HQOSUSERMEMBER).................................................... 4521

16 Performing the Diagnostic Test...................................................................................4539


16.1 OAM Loopback Test (START-ATMOAMBYPVC)...................................................................................................4540
16.2 Searching Tone Test (TST-SEARCHINGTONE)......................................................................................................4544
16.3 Capturing the Test Bus (TST-CONNECT)............................................................................................................... 4546
16.4 Releasing the Test Bus (TST-DISCEXT)................................................................................................................... 4548
16.5 Callee Emulation Test (TST-CALLEDAUTORESP)................................................................................................ 4550
16.6 Call Emulation Test (TST-CALLERAUTODIAL)......................................................................................................4557
16.7 Loop Line Test (TST-OUTSIDE)................................................................................................................................. 4566
16.8 MELT Test (TST-XDSLMELT)....................................................................................................................................... 4584
16.9 Circuit Line Test (TST-POTSCIRCUIT)...................................................................................................................... 4592
16.10 Performing a Signal Tone Test (TST-SIGNALTONE)........................................................................................ 4597
16.11 Setting Up a Line Test Session (CONN-LPACC-MET)..................................................................................... 4600
16.12 Capturing Circuits or Loop Lines (CHG-SPLIT-LILO)....................................................................................... 4606
16.13 Releasing the Test Bus (DISC-TACC)..................................................................................................................... 4609
16.14 Capturing the Test Bus (CHG-SPLIT).................................................................................................................... 4611
16.15 Monitoring the Test bus (CONN-MON)..............................................................................................................4613
16.16 Monitoring the Test bus (CONN-TACC-MET).................................................................................................... 4615
16.17 Remote Ping Test(TST-REMOTEPING)................................................................................................................. 4617
16.18 PPPoE Emulation Test (TST-ONTPPPOE)............................................................................................................ 4625
16.19 ONT Traceroute Test (TST-TRACEROUTE).......................................................................................................... 4632
16.20 ETH OAM....................................................................................................................................................................... 4639
16.20.1 Adding an MD (ENT-ETHOAM-MD)................................................................................................................. 4640
16.20.2 Deleting an MD (DLT-ETHOAM-MD)............................................................................................................... 4645
16.20.3 Querying an MD (RTRV-ETHOAM-MD).......................................................................................................... 4647
16.20.4 Adding an MA (ENT-ETHOAM-MA)..................................................................................................................4651
16.20.5 Modifying an MA (ED-ETHOAM-MA).............................................................................................................. 4657
16.20.6 Deleting an MA (DLT-ETHOAM-MA)................................................................................................................4662
16.20.7 Querying an MA (RTRV-ETHOAM-MA)........................................................................................................... 4665
16.20.8 Adding an MEP (ENT-ETHOAM-MEP)..............................................................................................................4669
16.20.9 Modifying an MEP (ED-ETHOAM-MEP).......................................................................................................... 4677
16.20.10 Deleting an MEP (DLT-ETHOAM-MEP)......................................................................................................... 4685

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xxi


iMaster NCE
Northbound TL1 Interface User Guide Contents

16.20.11 Querying an MEP (RTRV-ETHOAM-MEP).................................................................................................... 4687


16.20.12 Enabling the Transmit of CC (Continuity Check) Packets (STA-ETHOAM-CCSEND).....................4695
16.20.13 Disabling the Transmit of CC Packets (STP-ETHOAM-CCSEND).......................................................... 4699
16.20.14 Enabling the Receiving of CC Packets (STA-ETHOAM-CCRECV).......................................................... 4702
16.20.15 Disabling the Receiving of CC Packets (STP-ETHOAM-CCRECV)......................................................... 4706
16.20.16 Performing the Loopback Test (STA-ETHOAM-LB)................................................................................... 4709
16.20.17 Querying the Bridge MAC Address of a Device (RTRV-ETHOAM-BRIDGEMAC)............................ 4713

17 GPON FTTH Service Provision Example.....................................................................4716


17.1 Overview of GPON FTTH Services........................................................................................................................... 4716
17.2 GPON FTTH Service Provisioning............................................................................................................................. 4719
17.3 GPON FTTH Service Planning................................................................................................................................... 4720
17.4 GPON FTTH Service Deployment.............................................................................................................................4726
17.5 GPON FTTH Service Provisioning Guide................................................................................................................ 4729
17.5.1 Preparing for GPON FTTH Service Provisioning.............................................................................................. 4730
17.5.2 Logging In to the NCE.............................................................................................................................................. 4731
17.5.3 Internet Access Service............................................................................................................................................. 4731
17.5.3.1 Process of Managing an Internet Access Service.........................................................................................4731
17.5.3.2 Internet Access Service Data Planning............................................................................................................ 4736
17.5.3.3 Preconfiguring an Internet Access Service..................................................................................................... 4740
17.5.3.4 Provisioning an Internet Access Service.......................................................................................................... 4742
17.5.3.5 Modifying Internet Access Service Parameters.............................................................................................4746
17.5.3.6 Suspending an Internet Access Service........................................................................................................... 4747
17.5.3.7 Restoring an Internet Access Service............................................................................................................... 4747
17.5.3.8 Deleting an Internet Access Service................................................................................................................. 4748
17.5.3.9 Deregister an Internet Access User...................................................................................................................4748
17.5.3.10 Migrating an Internet Access Service............................................................................................................ 4749
17.5.4 IPTV Service.................................................................................................................................................................. 4749
17.5.4.1 Process of Managing an IPTV Service..............................................................................................................4749
17.5.4.2 IPTV Service Data Planning................................................................................................................................. 4756
17.5.4.3 Preconfiguring an IPTV Service.......................................................................................................................... 4761
17.5.4.4 Provisioning an IPTV Service............................................................................................................................... 4764
17.5.4.5 Modifying IPTV Service Parameters................................................................................................................. 4768
17.5.4.6 Suspending an IPTV Service................................................................................................................................ 4768
17.5.4.7 Restoring an IPTV Service.................................................................................................................................... 4769
17.5.4.8 Deleting an IPTV Service...................................................................................................................................... 4769
17.5.4.9 Deregistering an IPTV User................................................................................................................................. 4770
17.5.4.10 Migrating an IPTV Service................................................................................................................................. 4770
17.5.5 VoIP Service.................................................................................................................................................................. 4771
17.5.5.1 Process of Managing a VoIP Service................................................................................................................ 4771
17.5.5.2 VoIP Service Data Planning................................................................................................................................. 4778
17.5.5.3 Preconfiguring a VoIP Service.............................................................................................................................4790
17.5.5.4 Provisioning a VoIP Service..................................................................................................................................4796

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xxii


iMaster NCE
Northbound TL1 Interface User Guide Contents

17.5.5.5 Modifying VoIP Service Parameters..................................................................................................................4801


17.5.5.6 Suspending a VoIP Service................................................................................................................................... 4802
17.5.5.7 Restoring a VoIP Service....................................................................................................................................... 4803
17.5.5.8 Deleting a VoIP Service......................................................................................................................................... 4803
17.5.5.9 Deregistering a VoIP User.................................................................................................................................... 4803
17.5.5.10 Migrating a VoIP Service.................................................................................................................................... 4804
17.5.6 Logging Out of the NCE.......................................................................................................................................... 4804

18 GPON FTTB/C Service Provision Example................................................................. 4806


18.1 Overview of GPON FTTB/FTTC Services................................................................................................................ 4806
18.2 Overview of GPON FTTB/FTTC Service Provisioning......................................................................................... 4809
18.3 GPON FTTB/FTTC Service Planning.........................................................................................................................4810
18.4 GPON FTTB/FTTC Service Deployment.................................................................................................................. 4815
18.5 GPON FTTB/FTTC Service Provisioning.................................................................................................................. 4817
18.5.1 Preparing for Service Provisioning........................................................................................................................4817
18.5.2 Logging In to the NCE.............................................................................................................................................. 4817
18.5.3 Internet Access Service............................................................................................................................................. 4818
18.5.3.1 Process of Managing an Internet Access Service.........................................................................................4818
18.5.3.2 Internet Access Service Data Planning............................................................................................................ 4823
18.5.3.3 Preconfiguring an Internet Access Service..................................................................................................... 4829
18.5.3.4 Provisioning an Internet Access Service.......................................................................................................... 4832
18.5.3.5 Modifying Internet Access Service Parameters.............................................................................................4838
18.5.3.6 Suspending an Internet Access Service........................................................................................................... 4838
18.5.3.7 Restoring an Internet Access Service............................................................................................................... 4839
18.5.3.8 Deleting an Internet Access Service................................................................................................................. 4839
18.5.3.9 Deregistering an Internet Access Service User............................................................................................. 4840
18.5.3.10 Migrating an Internet Access Service............................................................................................................ 4840
18.5.4 IPTV Service.................................................................................................................................................................. 4841
18.5.4.1 Process of Managing an IPTV Service..............................................................................................................4841
18.5.4.2 IPTV Service Data Planning................................................................................................................................. 4845
18.5.4.3 Preconfiguring an IPTV Service.......................................................................................................................... 4851
18.5.4.4 Provisioning an IPTV Service............................................................................................................................... 4855
18.5.4.5 Modifying IPTV Service Parameters................................................................................................................. 4864
18.5.4.6 Suspending an IPTV Service................................................................................................................................ 4864
18.5.4.7 Restoring an IPTV Service.................................................................................................................................... 4865
18.5.4.8 Deleting an IPTV Service...................................................................................................................................... 4865
18.5.4.9 Deregistering an IPTV User................................................................................................................................. 4866
18.5.4.10 Migrating an IPTV Service................................................................................................................................. 4866
18.5.5 VoIP Service.................................................................................................................................................................. 4867
18.5.5.1 Process of Managing a VoIP Service................................................................................................................ 4867
18.5.5.2 VoIP Service Data Planning................................................................................................................................. 4871
18.5.5.3 Preconfiguring a VoIP Service.............................................................................................................................4877
18.5.5.4 Provisioning a VoIP Service..................................................................................................................................4881

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xxiii


iMaster NCE
Northbound TL1 Interface User Guide Contents

18.5.5.5 Modifying VoIP Service Parameters..................................................................................................................4886


18.5.5.6 Suspending a VoIP Service................................................................................................................................... 4886
18.5.5.7 Restoring a VoIP Service....................................................................................................................................... 4887
18.5.5.8 Deleting VoIP Services........................................................................................................................................... 4887
18.5.5.9 Migrating a VoIP Service...................................................................................................................................... 4888
18.5.6 Logging Out of the NCE.......................................................................................................................................... 4888

19 DSLAM/MSAN Service Provision Example................................................................ 4889


19.1 Overview of DSLAM/MSAN Services...................................................................................................................... 4889
19.2 DSLAM/MSAN Service Provisioning........................................................................................................................ 4892
19.3 DSLAM/MSAN Service Plan....................................................................................................................................... 4893
19.4 DSLAM/MSAN Service Deployment........................................................................................................................ 4897
19.5 DSLAM/MSAN Service Provisioning Guide........................................................................................................... 4899
19.5.1 Preparing for DSLAM/MSAN Services Provisioning........................................................................................ 4899
19.5.2 Logging In to the NCE.............................................................................................................................................. 4900
19.5.3 Internet Access Service............................................................................................................................................. 4900
19.5.3.1 Process of Managing Internet Access Services............................................................................................. 4900
19.5.3.2 Data Plan for Internet Access Services............................................................................................................ 4909
19.5.3.3 Preconfiguring an Internet Access Service..................................................................................................... 4918
19.5.3.4 Provisioning an xDSL PPPoE Internet Access Service................................................................................. 4921
19.5.3.5 Provisioning an xDSL PPPoA Internet Access Service................................................................................. 4925
19.5.3.6 Modifying Parameters for Internet Access Services.................................................................................... 4931
19.5.3.7 Suspending an Internet Access Service........................................................................................................... 4932
19.5.3.8 Restoring an Internet Access Service............................................................................................................... 4932
19.5.3.9 Deleting an Internet Access Service................................................................................................................. 4933
19.5.3.10 Deregistering an Internet Access Service User........................................................................................... 4933
19.5.3.11 Migrating an Internet Access Service............................................................................................................ 4934
19.5.4 IPTV Services................................................................................................................................................................ 4934
19.5.4.1 Process of Managing an IPTV Service..............................................................................................................4935
19.5.4.2 Data Plan for IPTV Services................................................................................................................................. 4942
19.5.4.3 Preconfiguring an IPTV Service.......................................................................................................................... 4952
19.5.4.4 Provisioning an IPTV Service............................................................................................................................... 4956
19.5.4.5 Modifying IPTV Service Parameters................................................................................................................. 4961
19.5.4.6 Suspending an IPTV Service................................................................................................................................ 4962
19.5.4.7 Restoring an IPTV Service.................................................................................................................................... 4962
19.5.4.8 Deleting an IPTV Service...................................................................................................................................... 4963
19.5.4.9 Deregistering an IPTV Service User.................................................................................................................. 4964
19.5.4.10 Migrating an IPTV Service................................................................................................................................. 4964
19.5.5 VoIP Services................................................................................................................................................................ 4964
19.5.5.1 Process of Managing VoIP Services.................................................................................................................. 4965
19.5.5.2 Data Plan for VoIP Services................................................................................................................................. 4971
19.5.5.3 Preconfiguring a VoIP Service.............................................................................................................................4982
19.5.5.4 Provisioning a VoIP Service..................................................................................................................................4986

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xxiv


iMaster NCE
Northbound TL1 Interface User Guide Contents

19.5.5.5 Modifying VoIP Service Parameters..................................................................................................................4987


19.5.5.6 Suspending a VoIP Service................................................................................................................................... 4988
19.5.5.7 Restoring a VoIP Service....................................................................................................................................... 4988
19.5.5.8 Deregistering a VoIP User.................................................................................................................................... 4989
19.5.5.9 Migrating a VoIP Service...................................................................................................................................... 4989
19.5.6 Triple Play Services.....................................................................................................................................................4990
19.5.6.1 Data Plan for Triple Play Services..................................................................................................................... 4991
19.5.6.2 Preconfiguring a Triple Play Service................................................................................................................. 5002
19.5.6.3 Provisioning a Triple Play Service...................................................................................................................... 5007
19.5.7 Logging Out of the NCE.......................................................................................................................................... 5012

20 List of Customized TL1 Commands............................................................................ 5013


21 Troubleshooting Common Faults................................................................................5045
21.1 Diagnosing a Failure to Issue TL1 Commands.................................................................................................... 5045
21.2 Failure for the OSS to Connect To the NCE..........................................................................................................5050
21.3 No XML File Generated After TL1 Commands Are Run................................................................................... 5051
21.4 Common Error Codes................................................................................................................................................... 5052
21.4.1 2686058516/2686058596........................................................................................................................................5052
21.4.2 2686058497/2686058499........................................................................................................................................5052
21.4.3 2686058508..................................................................................................................................................................5053
21.4.4 2686058500..................................................................................................................................................................5053
21.4.5 102690820/2689014791.......................................................................................................................................... 5053
21.4.6 1615069195..................................................................................................................................................................5054
21.4.7 1615462437..................................................................................................................................................................5055
21.4.8 1610614842/1616445483/1616445484/1616445485.................................................................................... 5056
21.4.9 2686058552..................................................................................................................................................................5057
21.4.10 76546022.................................................................................................................................................................... 5058
21.4.11 76546023.................................................................................................................................................................... 5060
21.4.12 1610612765............................................................................................................................................................... 5061
21.4.13 15658136501/2686058531................................................................................................................................... 5062
21.4.14 2689008176............................................................................................................................................................... 5063
21.4.15 1615069206............................................................................................................................................................... 5064
21.4.16 2686058603............................................................................................................................................................... 5064
21.4.17 2689023090............................................................................................................................................................... 5065
21.4.18 2689020327............................................................................................................................................................... 5066
21.4.19 2688880284............................................................................................................................................................... 5066
21.5 Collecting Fault Information...................................................................................................................................... 5066

A FAQ.......................................................................................................................................5068
A.1 Session Connection......................................................................................................................................................... 5068
A.2 Interaction Between the OSS, NCE, and NE........................................................................................................... 5069
A.3 User Control.......................................................................................................................................................................5070
A.4 Logging In to the Gauss Database............................................................................................................................ 5070

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xxv


iMaster NCE
Northbound TL1 Interface User Guide Contents

A.5 Database Upgrade...........................................................................................................................................................5070


A.6 TL1 Command Performance........................................................................................................................................ 5071
A.7 Identifying a Device by Using the Device Name Instead of the Device ID................................................. 5071
A.8 How to Locate a Device According to the IP Address.........................................................................................5071
A.9 Virtual Subslot.................................................................................................................................................................. 5073
A.10 Certain Port Status Defined Inconsistently in the TL1 Specifications and the Client............................ 5073
A.11 Global TL1 Character Encoding................................................................................................................................ 5074
A.12 Recording TL1 User Logs............................................................................................................................................ 5074
A.13 How to Modify the Format of the Returned SN................................................................................................ 5075
A.14 Which Characters Are Supported by String-Type Parameters?......................................................................5077
A.15 Logging In to the Management Plane of NCE....................................................................................................5077
A.16 Logging In to the O&M Plane of NCE....................................................................................................................5077
A.17 Querying and Modifying NCE Configuration Items.......................................................................................... 5078

B Command Parameter Reference................................................................................... 5082


B.1 Parameters Related to the Device Type................................................................................................................... 5082
B.2 Parameters Related To the Board Type.................................................................................................................... 5084
B.3 Parameters Related To the Port Type....................................................................................................................... 5085
B.4 Parameters Related To the Port Status.................................................................................................................... 5094
B.5 Parameters Related To the ADSL Working Mode.................................................................................................5096
B.6 Mapping Between FTTH ONU Types and ASCII Codes.......................................................................................5096
B.7 Mapping Between FTTO&FTTD ONU Types and ASCII Codes......................................................................... 5122
B.8 Mapping Between FTTH ONU Types and Function of Configuring the VAS.............................................. 5125
B.9 Mapping Between FTTO&FTTD ONU Types and Function of Configuring the VAS.................................5150
B.10 Parameters Related To the Range of VLAN IDs for Different Devices........................................................5153
B.11 Parameters Related To the PVC Connection Type..............................................................................................5154
B.12 Parameters Related To the Traffic Profile............................................................................................................. 5157
B.13 Parameters Related To the Voice Gain...................................................................................................................5162
B.14 Parameters Related To the Valid Values of Level.............................................................................................. 5163
B.15 TST-OUTSIDE Results................................................................................................................................................... 5164
B.16 Country and Region Abbreviations..........................................................................................................................5169

C Acronyms and Abbreviations......................................................................................... 5174

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. xxvi


iMaster NCE
Northbound TL1 Interface User Guide 1 About This Document

1 About This Document

Purpose
This document provides the commands and examples related to the TL1 NBI
based on inventory management and services of the iManager. 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.

NCE is oriented to carriers and provides a large-scale management capability. NCE


Lite is a lightweight version of NCE, which is oriented to enterprises and provides a
low-cost small-sized solution.

Based on the unified service-oriented architecture of NCE, NCE Lite provides


single-domain and multi-domain management capabilities and small-sized SDN
solutions for IP, transport, and access devices. NCE Lite provides the same GUI and
operation experience as NCE.

NCE is used for both NCE and NCE Lite mentioned in the document.

Intended Audience
This document is intended for:

● Application developers
● Data configuration engineers

Symbol Conventions
The symbols that may be found in this document are defined as follows.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1


iMaster NCE
Northbound TL1 Interface User Guide 1 About This Document

Symbol Description

Indicates a hazard with a high level of risk which,


if not avoided, will result in death or serious
injury.

Indicates a hazard with a medium level of risk


which, if not avoided, could result in death or
serious injury.

Indicates a hazard with a low level of risk which,


if not avoided, could 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.

Supplements the important information in the


main text.
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.

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 braces 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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 2


iMaster NCE
Northbound TL1 Interface User Guide 1 About This Document

Convention Description

[ x | y | ... ]* Optional items are grouped in braces and separated


by vertical bars. Several items or no item can be
selected.

GUI Conventions
The GUI conventions that may be found in this document are defined as follows.

Convention Description

Boldface Buttons, menus, parameters, tabs, window, and


dialog titles are in boldface. For example, click OK.

> Multi-level menus are in boldface and separated by


the ">" signs. For example, choose File > Create >
Folder.

Change History
For details about the change history, see 2 Change History.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 3


iMaster NCE
Northbound TL1 Interface User Guide 2 Change History

2 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 (2020-05-31) Based on Version V100R019C10SPC200


The initial commercial release.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 4


iMaster NCE
Northbound TL1 Interface User Guide 3 Usage Note

3 Usage Note

This topic describes the usage note of TL1 commands.

To use the TL1 NBI properly, ensure that:


● You have logged in to the NCE using LOGIN command. 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.
● You have selected the NCE(Access Domain) check box in the Domain area
when installing the NCE.
● You have logged in to the NCE through TL1 NBI 9819. The SSL authentication
mode is used by default. If you want to modify the authentication mode, see
4.5 Security Mechanism.
● . Themanagement plane of NCE TL1NBiDm and related service processes are
running properly.
● TL1 users exist on the NCE and have been assigned with the required rights.
You can create TL1 users in the NMS user management window or use the
existing users in the management plane of NCE. See 6.5 Creating a NCE User
for the Access of an OSS and Assign Rights to the User.

The dusernameer name is admin, For details about the initial password and security
requirements, see "User and Password Management" in NCE Administrator Guide.
● You have set configuration items by running the specific TL1 commands.
● You have synchronized data on the NCE before issuing TL1 commands to keep
data consistency between the NCE and NEs. If the data is inconsistent, the
commands may fail to be issued.
● You have learned about 4.6 Performance Specifications and 9 Command
Format of the TL1 NBI.
● You have commissioned TL1 commands before interconnecting the NCE with
the OSS. Run the telnet NCE server's IP address 9819 command in the CLI,
or log in to a more secure SSL client tool and enter the NCE server's IP
address and port 9819 to connect to the NCE TL1 NBI. Then run TL1
commands to test command correctness(When the Service node is deployed
in a cluster, the NCE server's IP here is the IP address of the NMS floating

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 5


iMaster NCE
Northbound TL1 Interface User Guide 3 Usage Note

node; when the Service node is a single instance, the NCE server IP here is the
IP address of NMS node).
● 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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 6


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

4 TL1 NBI Overview

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
standards compliance of TL1 NBI.

4.1 Introduction to the TL1 NBI


This topic briefly describes the TL1 NBI.
4.2 Position in the Network
This topic describes the position of the TL1 NBI in the network.
4.3 Communication Protocols
This topic describes the communication protocols that the TL1 NBI uses.
4.4 Functions and Features
This topic describes the functions and features that the TL1 NBI supports.
4.5 Security Mechanism
This topic describes the security mechanism that the TL1 NBI uses.
4.6 Performance Specifications
This topic describes the performance specifications that the TL1 NBI supports.
4.7 Standards Compliance
This topic describes the standard that the TL1 NBI complies with.
4.8 References
This topic provides the references for this user guide.

4.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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 7


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

4.2 Position in the Network


This topic describes the position of the TL1 NBI in the network.
Figure 4-1 shows the position of the TL1 NBI in the network.

Figure 4-1 Position of the TL1 NBI in the network

The functions of the entities are as follows:


● OSS/NMS refers to the operation support system or network management
system of carriers. The OSS or NMS issues TL1 commands to the NCE for
automatic service provisioning.
● TL1 NBI for Service Provisioning provides an interface between the OSS/NMS
and the NCE. In this way, the OSS/NMS can perform multi-service
provisioning and resource querying operations.
● NCE: This system is an innovative network cloudification engine developed by
Huawei. Positioned as the brain of future cloud-based networks, NCE
integrates functions such as network management, service control, and
network analysis. It is the core enablement system for network resource
pooling, network connection automation and self-optimization, and O&M
automation. It supports all functions of the element and network
management layers and providing NBIs.
● Network element (NE) refers to the element device in the network. It is
managed by the NCE.

4.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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 8


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

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 4-2 shows the protocol stack for the TL1 NBI.

Figure 4-2 Protocol stack for the TL1 NBI

● OSS: operation support system


● NMS: network management system
● SSL: Secure Sockets Layer
● TCP/IP: Transmission Control Protocol/Internet Protocol

4.4 Functions and Features


This topic describes the functions and features that the TL1 NBI supports.

Functions
The TL1 NBI supports the following functions:
● Resource change notification: The TL1 NBI supports the function of notifying
changes of devices, EPON resources, and Ethernet resources.
● 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.
● 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.
● Diagnostic test: The TL1 NBI supports the function of performing the
diagnostic test, such as the OAM loopback test and ETH OAM function.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 9


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

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 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 NCE and the
OSS before the OSS can issue any TL1 command. Then, by using the login
command, the OSS can log in to the NCE successfully after passing the
authentication. During the interaction, the OSS and the NCE set handles for
each command. Generally, the OSS system issues the next command only
after receiving the response to the previous command from the NCE. 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 NCE terminates the
session after ten-minute-period 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.

4.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 NCE. To activate this
mechanism, you need to add NBI users and configure the access control list (ACL)
on the NCE server.

The NCE system supports up to 30 concurrent connections.

The security mechanism of the TL1 NBI is as follows:


● 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 username and
password for login are the same as those of the O&M plane of NCE. User
rights depend on the NCE user rights and TL1 license. The

default username is admin. For details about the initial password and security
requirements, see "User and Password Management" in NCE Administrator Guide.

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.

● Operation and domain authentication: The NCE provides operation rights and
domain rights for access users. Only users who have related operation rights

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 10


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

can invoke the TL1 NBI. For details, see 6.5 Creating a NCE User for the
Access of an OSS and Assign Rights to the User.
● Automatic release of the connection: If no message is transmitted through a
connection within 10 minutes, the connection will be released automatically.
● Communication protocol: The NCE TL1 NBI provides SSL and TCP connections.
The NCE uses the SSL authentication mode by default to connect to the OSS
to ensure their communication security.

● 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. 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. Log in to the database as the dbuser and run the select CfgValue from
BMSDB.bms_cfg_tab where strLocateName='AN.NBFRAME' and
CfgName = 'PROTOCOL'; script to query the current connection mode. If
n CfgValue is displayed as 2 (default value), the SSL protocol is used.
If
n CfgValue is displayed as 0, the TCP protocol is used.
b. Log in to the database as the dbuser and 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';commit;
n TCP: update BMSDB.bms_cfg_tab set CfgValue='0' where
strLocateName='AN.NBFRAME' and
CfgName='PROTOCOL';commit;
c. On the management plane of NCE, restart the TL1NBiDm process for the
configuration to take effect.
i. Log in to the management plane of NCE.
See A.15 Logging In to the Management Plane of NCE.
ii. Choose Product > System Monitoring from the main menu. In the
upper left corner of the System Monitoring page, move the pointer
to and select the product NCE-NMS or NCE_FAN. On the Service
Management page, click the Process tab.
iii. Choose the TL1NBiDm-*-* process and click Stop.
iv. After the TL1NBiDm-*-* process stops, choose it and click Start.
● 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.
● IP address blacklist: If the number of failed login attempts of an IP address
exceeds the limit in a specified duration, the NCE 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,

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 11


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

NBIFRAME_MAX_ALLOWED_LOGIN_FAILS, and
NBIFRAME_MAX_BLOCK_TIME.

4.6 Performance Specifications


This topic describes the performance specifications that the TL1 NBI supports.

Table 4-1 lists the performance specifications of the TL1 NBI.

Table 4-1 Performance specifications of the TL1 NBI

Item Specification

Maximum number of OSS ● Common- and medium-scale networks: 20


connections that can be It is recommended that the number of OSS
received at one time connections of each function interface be
allocated as follows:
– Service provisioning: 15
– Inventory query: 2
– Diagnosis and test: 3
● 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 NCE
Product Description.

Processing capability for 10 per second (only for configuration


requesting commands of TL1 commands)

Response time for requesting Within two minutes (excluding test


commands of TL1 commands)

4.7 Standards Compliance


This topic describes the standard that the TL1 NBI complies with.

The TL1 NBI complies with the Generic Requirements (GR) 831 standard.

4.8 References
This topic provides the references for this user guide.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 12


iMaster NCE
Northbound TL1 Interface User Guide 4 TL1 NBI Overview

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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 13


iMaster NCE 5 Installing and Enabling the NBI for Provisioning
Northbound TL1 Interface User Guide the TL1 Service

5 Installing and Enabling the NBI for


Provisioning the TL1 Service

This topic describes how to install and enable the NBI for provisioning the TL1
service on Euler OS.

5.1 Configuration Requirements


Because the NCE TL1 NBI and the NCE server run on the same PC or Sun
workstation, no additional configuration is required.
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.

5.1 Configuration Requirements


Because the NCE TL1 NBI and the NCE server run on the same PC or Sun
workstation, no additional configuration is required.

Hardware Configuration
● In practice, the NCE TL1 interface and the NCE server run on the same PC or
SUN workstation. The hardware is configured to ensure the proper installation
and running of the NCE server. Any additional hardware configuration is not
required the NCE TL1 interface.
● For details of hardware requirements of NCE Server, refer to section
"Configuration Requirements" in the NCE Produce Description.

Software Configuration
● Since the TL1 interface is integrated into the NCE installation software, no
additional software configuration is required for the installation of the NCE
TL1 interface.
● For details of software requirements NCE Server, refer to section
"Configuration Requirements" in the NCE Product Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 14


iMaster NCE 5 Installing and Enabling the NBI for Provisioning
Northbound TL1 Interface User Guide the TL1 Service

5.2 Installing a TL1 NBI Component


This topic describes how to install a TL1 NBI component.

Procedure
Step 1 The NCE TL1 NBI is installed together with NCE (Access Domain) Manager. You do
not need to install the TL1 NBI again. In the Manager scenario, you need to select
NCE-NMS as the product type on EasySuite.
For details on the installation steps, see the NCE 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.

Prerequisites
After the NCE is installed, the OS is restarted and the NCE service is started.

If the NCE service is not started, start the NCE service manually.
● Log in to the system through sopuser. Run the following command to switch to the ossadm
user on Euler OS:
$ su - ossadm
Password: password for the ossadm user
Run the following commands to start service.
$ cd /opt/oss/manager/bin
$ . engr_profile.sh
$ ipmc_adm -cmd stopnode
$ ipmc_adm -cmd startnode
● For details about the initial password and security requirements, see "User and Password
Management" in NCE Administrator Guide.

Procedure
Step 1 Check the status of the TL1 process.
1. Log in to the management plane of NCE. See A.15 Logging In to the
Management Plane of NCE.
2. Choose Product > System Monitoring from the main menu. In the upper left
corner of the System Monitoring page, move the pointer to and select the
product NCE-NMS or NCE-FAN. Click the Service tab.
3. In the Instance Name column, click NCE/AccessTL1NBI/AccessTL1NBI_*.
4. check whether the TL1NBiDm-*-* process is running.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 15


iMaster NCE 5 Installing and Enabling the NBI for Provisioning
Northbound TL1 Interface User Guide the TL1 Service

If the process is not started, choose TL1NBiDm and click Start from the shortcut menu.

----End

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 16


iMaster NCE
Northbound TL1 Interface User Guide 6 Maintaining the TL1 NBI

6 Maintaining the TL1 NBI

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 Starting the TL1 Process
This topic describes how to start the TL1 process in the Stopped state using the
management plane of NCE.
6.4 Stopping the TL1 Process
This topic describes how to stop the TL1 process using the management plane of
NCE.
6.5 Creating a NCE User for the Access of an OSS and Assign Rights to the User
If the NCE TL1 interface runs in the normal state and the network communication
is normal, you need to create a network management user on the NCE for the
access of an OSS before the OSS accesses the NCE through the TL1 interface.

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 personnel are required to have the following experiences:

● Be familiar with the basic operations of the Euler operating systems.


● Have a good understanding of the TL1 technology.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 17


iMaster NCE
Northbound TL1 Interface User Guide 6 Maintaining the TL1 NBI

● Understand concepts of the telecommunication management network (TMN)


and know the basic networking architecture of the NCE well.
● Be familiar with the configuration and the operations of enabling and
disabling theNCE TL1 interface.

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


● Log in to the management plane of NCE. Choose Product > System
Monitoring from the main menu. In the upper left corner of the System
Monitoring page, move the pointer to and select the product NCE-NMS or
NCE-FAN . On the Service Management page, click the Service tab. In the
Instance Name column, click NCE/AccessTL1NBI/AccessTL1NBI_*. Check
whether the TL1NBiDm-*-* processes is running properly.

Backing up the logs of the NCE 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 A.12 Recording TL1 User Logs.

The log information of the NCE TL1 NBI is as follows:


● /opt/oss/log/NCE/TL1NBIService/Develop/TL1NBiDm/TL1NBiDm_%y%m%d_
%H%M%S.*
● /opt/oss/log/NCE/TL1NBIService/Develop/TL1NBiDm/BootLog_%y%m%d_%H
%M%S.*
● /opt/oss/log/NCE/TL1NBIService/mrblog/iMAPBase_p47_%y%m%d_%H%M
%S.*
● /opt/oss/log/NCE/MRBService/mrblog/iMAPMrb_p2_%y%m%d_%H%M%S.*

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 NCE TL1 NBI and the
operation performed by the NMS/OSS through the NCE TL1 NBI. If an error occurs
when the NCE 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 NCE TL1 NBI,
manually copy the log information to a specified directory.

Alternatively, choose Security > Log Management from the main menu, in the
left navigation tree, select Operation Logs tab. In the Query Operation Logs
window, select the required log to view the operation result and details.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 18


iMaster NCE
Northbound TL1 Interface User Guide 6 Maintaining the TL1 NBI

Dumping operation logs of the NCE TL1 NBI


Dump the log files regularly in case they occupy too much of the system disk
space.

● Manually dump in the O&M plane of NCE.


a. Log in to the OM plane of NCE.
b. Choose SystemTask Management from the main menu.
c. In the Task Management window, choose Manual Dump > Operation
Log Manual Dump from the navigation tree.
d. In the right pane, right-click the manual dump task and choose Run from
the shortcut menu.

6.3 Starting the TL1 Process


This topic describes how to start the TL1 process in the Stopped state using the
management plane of NCE.

Prerequisites
● The NCE server runs in the normal state.
● The system, which monitoring process, runs in the normal state.
● Services on the management plane of NCE are running properly.
● The TL1NBiDm process is in the Stopped state.

Procedure
Step 1 Log in to the management plane of NCE. See A.15 Logging In to the
Management Plane of NCE.

Step 2 Choose Product > System Monitoring from the main menu. In the upper left
corner of the System Monitoring page, move the pointer to and select the
product NCE-NMS or NCE-FAN. On the Service Management page, click the
Service tab.

Step 3 In the Instance Name column, click NCE/AccessTL1NBI/AccessTL1NBI_*.

Step 4 Choose the TL1NBiDm-*-* process and click Start.

----End

6.4 Stopping the TL1 Process


This topic describes how to stop the TL1 process using the management plane of
NCE.

Prerequisites
● The NCE server runs in the normal state.
● The system, which monitoring process, runs in the normal state.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 19


iMaster NCE
Northbound TL1 Interface User Guide 6 Maintaining the TL1 NBI

● Services on the management plane of NCE are running properly.


● The TL1NBiDm process is in the Running state.

Context

NOTICE

Stopping a service affects the functions of the TL1 NBI. Therefore, perform this
operation with caution.

Procedure
Step 1 Login to the management plane of NCE. See A.15 Logging In to the
Management Plane of NCE.

Step 2 Choose Product > System Monitoring from the main menu. In the upper left
corner of the System Monitoring page, move the pointer to and select the
product NCE-NMS or NCE-FAN. On the Service Managementpage, click the
Service tab.

Step 3 In the Instance Name column, click NCE/AccessTL1NBI/AccessTL1NBI_*.

Step 4 Select TL1NBiDm-*-* process, click stop.

----End

6.5 Creating a NCE User for the Access of an OSS and


Assign Rights to the User
If the NCE TL1 interface runs in the normal state and the network communication
is normal, you need to create a network management user on the NCE for the
access of an OSS before the OSS accesses the NCE through the TL1 interface.

Context

NOTICE

To ensure system security, when the OSS accesses the NCE through the NBI, the
NCE will authenticate user logins. The NCE provides operation rights and domain
rights for access users. Only users who have related operation rights can invoke
the TL1 NBI.

For more details about the NMS user management, see the online help of NCE.

Procedure
Step 1 Log in to the O&M plane of NCE. See A.16 Logging In to the O&M Plane of NCE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 20


iMaster NCE
Northbound TL1 Interface User Guide 6 Maintaining the TL1 NBI

Step 2 Open the Network Management app, and choose Security > NMS Security >
User Management from the main menu. Alternatively, open the Security
Management app and choose Security > User Management from the main
menu.
Step 3 Choose Users from the navigation pane.
Step 4 On the Users page, click Create.
Step 5 On the displayed page, set basic user information.
The username 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 NCE by TL1 NBI, some user attributes are valid, as the following table
shown.

Attribut Description Operations


e

Normal The OSS use the username or On the New User dialog box, set
propertie password access NCE by TL1 NBI. user properties, such as
s username, description content,
and password.
NOTE
● The type of the user for the
access of an OSS must be set to
Local or Remote, and cannot be
set to Third-party.
● Local users: users who are
authenticated and log in to NCE.
● Remote users: users for
interconnecting with Lightweight
Directory Access Protocol (LDAP)
or Remote Authentication Dial In
User Service (RADIUS) servers.

Domain For the user that access NCE by 1. Click the created user and
TL1 NBI can manage the click the Roles tab.
equipment in the domain only. 2. Choose Roles from the
navigation pane, and click the
role that is found.
3. Click the Managed Objects
tab. When selecting a
managed object, select the
type of the managed object
and then select a specific
managed object.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 21


iMaster NCE
Northbound TL1 Interface User Guide 6 Maintaining the TL1 NBI

Attribut Description Operations


e

Operatio ● TL1 Query Operation Set: TL1 1. Click the created user and
n Rights NBI query rights (including click the Roles tab.
performing diagnostic test 2. Choose Roles from the
and notifying resource navigation pane, and click the
change) role that is found.
● TL1 Configure Operation Set: 3. Click the Operation Rights
TL1 NBI configuration rights tab. On the displayed tab,
click Add Application-Level
Operation Rights to set the
application-level operation
rights of the role, and then
click Add Device-Level
Operation Rights to set the
device-level operation rights
of each managed object in
the managed object scope of
the role.

Access You cannot access NCE if the IP Click the created user and click
control is not in the access control list. the Access Policies tab. Click
list (ACL) Edit in the upper right corner
and select the desired client IP
address policies. You can also
click Create to create a client IP
address policy as needed.

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 6 In the New User dialog box, click OK. The user account is created.

----End

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 22


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

7 SSL Principle and Configuration

The SSL encryption mechanism is used to ensure the security of the messages
transmitted between the NCE and the OSS.

7.1 SSL Principle


This section describes the principle of SSL.
7.2 Applying for an SSL Certificate
The NCE 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 NCE 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 Interconnecting with an 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 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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 23


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

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 NCE 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 NCE 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 NCE


Table 7-1 shows the TL1 NBI certificates and paths.

Table 7-1 SSL certificate and path


Certificate Descriptio Path
n

server.p12 Server NMS node:


identity /opt/oss/envs/Product-TL1NBIService/*/etc/ssl/
certificate. access/keyStore/PFX
The file is
in the
encoding
format of
PKCS12
and
includes
the private
key and
identity
certificate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 24


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

Certificate Descriptio Path


n

client.p12 Client NMS node:


identity /opt/oss/envs/Product-TL1NBIService/*/etc/ssl/
certificate. access/keyStore/PFX
The file is
in the
encoding
format of
PKCS12
and
includes
the private
key and
identity
certificate.

trust.cer Trust NMS node: /opt/oss/envs/Product-


certificate TL1NBIService/*/etc/ssl/access/trust/PEM

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 NCE must meet the requirements
listed in Table 7-2 because the NCE 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 NCE 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 NCE TL1 NBI
Certificate Type Requirement

Server identity ● The file encoding format is PFX.


certificate ● The RSA asymmetric encryption algorithm is used.
● The private key contains a minimum of 1024 bits.

Client identity ● The file encoding format is PFX.


certificate ● The RSA asymmetric encryption algorithm is used.
● The private key contains a minimum of 1024 bits.

Trust certificate. The file encoding format is PEM.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 25


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

NOTICE

● The NCE 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 NCE with a special certificate after converting it
to a format supported by the NCE.
● If the default certificate on the NCE 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 Interconnecting with an SSL Certificate


The northbound security authentication mechanism is SSL two-way
authentication. The certificate deployed on NCE is the service certificate of the
server. The service certificate of the corresponding client is required for the
interconnection with the OSS.

Context
● Identity certificates are used by the peer system to verify the identity of NCE.
Trust certificates are used by NCE to verify the identity of the peer systems.
● If you need to update the trust certificate of the peer system, contact the
system administrator to obtain the trust certificate.
● The trusted root certificate is a root certificate that issues the identity
certificate, which is also called the CA certificate. The trusted root certificate is
usually saved as trust.cer.
● The local trust certificate list must contain the trusted root certificate of the
peer certificate.

Interconnection Scenario

● Replace the digital certificate on the OSS, which is planned and implemented by the
OSS maintenance engineers.
● Importing the trusted root certificate means adding a new trusted root certificate to the
trust certificate list. Replacing the trusted root certificate means deleting an unnecessary
trusted root certificate and then adding a new trusted root certificate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 26


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

Table 7-3 Scenarios and operations


Scenario Operations on the OSS Operations on NCE

Using the existing Import or replace the trusted Import or replace the
certificates of the root certificate of the NCE trusted root certificate of
OSS and NCE certificate in the trust the OSS certificate in the
certificate list on the OSS. trust certificate list
(trust.cer) on NCE.

Changing the OSS Replace the digital Import or replace the


certificate certificate (client.p12) on trusted root certificate of
the OSS. the new OSS certificate in
the trust certificate list on
NCE.

Changing the NCE Import or replace the trusted Replace the digital
certificate root certificate of the new certificate (server.p12) on
NCE certificate in the trust NCE.
certificate list on the OSS.

7.3.1 Updating an SSL Certificate


The NCE 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 NCE SSL
certificate.

Prerequisites
You have obtained Identity certificate (*.p12) and Trust certificate (*.cer).

Context
The TL1 NBI supports P12 identity certificates and PEM trust certificates only.
The default certificate and its directory are as follows.

Table 7-4 SSL certificate and path


Certificate Description Path

server.p12 Server identity NMS node:


certificate. The file is in /opt/oss/envs/Product-
the encoding format of TL1NBIService/*/etc/ssl/access/
PKCS12 and includes the keyStore/PFX/server.p12
private key and device
certificate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 27


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

Certificate Description Path

trust.cer Trust certificate used to NMS node:


identify trusted access /opt/oss/envs/Product-
objects. TL1NBIService/*/etc/ssl/access/
trust/PEM/trust.cer

The new identity certificate is automatically changed to server.p12 and stored in the preceding
directory to replace the original certificate.

Procedure
Step 1 Log in to the O&M plane. For details, see A.16 Logging In to the O&M Plane of
NCE.
Step 2 Open the System Settings app and choose System Settings > Certificate
Management from the main menu.
Step 3 In the navigation pane, choose Service Certificate Management.
Step 4 On the service list page, click TL1NBIService.
Step 5 Update certificates based on Table 7-5.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 28


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

Table 7-5 Updating certificates


Certificat Precautions Procedure
e Type

Identity ● Identity certificates 1. Click the Identity Certificate tab.


Certificat must be in .p12 2. Click Import.
e format and the size
must be less than 3. Configure the certificate information.
50 KB. – Enter the name of the certificate file
● If an original in the text box next to Certificate
certificate exists in alias. This parameter can be
the certificate list, it customized.
will be replaced – Click next to Certificate file. In
during the the displayed dialog box, select the
certificate update. certificate to be uploaded and click
NOTICE Open.
Before updating the
identity certificate, – Enter the password of the certificate
ensure that the new in the Certificate password text
certificate is correct. box.
An incorrect identity
certificate may cause – (Optional) Enter the description of
communication the certificate in the text box next to
exceptions. Remarks to facilitate subsequent
identification and maintenance.
4. Click Submit.
5. In the High Risk dialog box that is
displayed, read the information
carefully and confirm whether to
update the certificate.
– If yes, select I understand the risk
and want to continue, and click
OK.
– If no, click Cancel.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 29


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

Certificat Precautions Procedure


e Type

Trust Trust certificates must 1. Click the Trust Certificate tab.


Certificat be in .pem, .der, .cer, 2. (Optional) Delete the trust certificate.
e or .crt format and the
size must be less than a. In the trust certificates list, click
50 KB. Delete in the Operation column of
the row that contains the trust
certificate to be deleted.
b. In the High Risk dialog box that is
displayed, read the information
carefully and confirm whether to
delete the trust certificate.
n If yes, select I understand the
risk and want to continue, and
click OK.
n If no, click Cancel.
c. In the dialog box that is displayed,
click OK.
3. Click Import.
4. Configure the certificate information.
– Enter the name of the certificate file
in the text box next to Certificate
alias. This parameter can be
customized.
– Select PEM from the Certificate
format drop-down list.

– Click next to Certificate file. In


the displayed dialog box, select the
certificate to be uploaded and click
Open.
– (Optional) Enter the description of
the certificate in the text box next to
Remarks to facilitate subsequent
identification and maintenance.
5. Click Submit.

Step 6 If a dialog box is displayed indicating a certificate update success, click OK.
Otherwise, handle the problem according to the information in the dialog box.
Step 7 Wait about 10 seconds, restart the related process to enable the new certificate to
take effect.
1. Log in to the management plane. For details, see A.15 Logging In to the
Management Plane of NCE.
2. Choose Product > System Monitoring from the main menu. In the upper left
corner of the System Monitoring page, move the pointer to and select the
product NCE-NMS or NCE-FAN.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 30


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

3. .On the Service Management page, click the Service tab. In the Instance
Name column, click NCE/AccessTL1NBI/AccessTL1NBI_TL1NBIService.
4. Choose TL1NBiDm-*-* process, click Stop. In the dialog box that is displayed,
click Yes.
5. Choose TL1NBiDm-*-* process, click Start. In the dialog box that is displayed,
click Yes.

----End

Result
On the Service Certificate Management page, click Certificate Update Status
tab to view the replacement result.

7.3.2 Verifying the Certificate Identity


During SSL communication, the local end verifies the validity of the peer
certificate, including the validity period, usage, whether is issued by a trusted CA,
and whether the certificate has been revoked. The most important, basic, and
error-prone is verified whether the certificate is issued by a trusted CA. The local
end uses the trust certificate list (trust.cer) to verify the signature of the peer
certificate. If the signature passes the verification, the peer certificate is trusted by
the local end. That is, the peer certificate is issued by the CA trusted by the local
end, and the certificate identity passes the verification.

Viewing Certificate Information


1. View the issuer of the identity certificate. The following uses the .p12
certificate as an example.
– Run the openssl command.
openssl pkcs12 -info -in client.p12

Subject indicates the owner information, and Issuer indicates the issuer
information.
– View the identity certificate of a specific NCE service on the NCE GUI.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 31


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

2. View information about the trusted root CA certificate in the trust certificate
list.
– Run the openssl command.
openssl x509 -text -in trust.cer

The trust.cer file may contain information about multiple CA certificates. You can use a
text tool to open the file and will view the obviously split text blocks. Each text block is a
certificate. You can use the preceding command to query only the information about the
first certificate. Therefore, you need to copy the information about the other certificates to
a separate file and run the command to view related information.
● View the information about the NCE trust certificate

If the issuer of the local trust certificate is consistent with that of the peer
identity certificate, the peer certificate can be trusted.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 32


iMaster NCE
Northbound TL1 Interface User Guide 7 SSL Principle and Configuration

Running the openssl Command to Verify the Certificate


Run the following command: openssl s_client -connect nceip:port -cert
client.pem -key client.key -verify 10 -state -CAfile trust.cer
The command output contains Verification: OK.
client.pem is a .pem certificate that does not contain a private key and is
extracted from the OSS identity certificate, for example, client.p12.
client.key is the RSA private key extracted from the OSS identity certificate, for
example, client.p12.
● For example, run the following command to extract client.pem from the
client.p12 certificate:
openssl pkcs12 -in client.p12 -out client.pem -nodes -nokeys
● For example, run the following commands to extract client.key from the
client.p12 certificate:
openssl pkcs12 -nocerts -out client.key.pem -in client.p12
openssl rsa -in client.key.pem -out client.key

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 33


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

8 Setting Configuration Items

This topic describes how to set configuration items before running TL1 commands.
● Virtualization configuration items
Before running TL1 commands, set configuration items listed in Table 8-1
based on actual needs.
a. Log in to the O&M plane of NCE, choose System > Settings >
Configuration Item Management from the main menu, and modify the
configuration item values in an appropriate manner based on actual
needs.
b. Log in to the management plane of NCE and restart the related
microservices by following Table 8-1.

Table 8-1 Configuration item description


Configur Confi Description De Rec Resta Remarks
ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

DEVMEA 0 Indicates that in 0 1 TL1N For details, see


N the TL BIServ A.8 How to
commands ice Locate a
except for the inTL1 Device
notification of NBISe According to
resource rvice the IP Address.
changes, the
DEV parameter
is used to locate
a device
according to the
device name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 34


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

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.

BMSNB_ 0 Indicates that in 0 1 Acces


MSGNOTI the notification sNeM
FY_DEVM of resource grSer
EAN changes, the vice
DEV parameter
is used to locate
a device
according to the
device name.

1 Indicates that in
the notification
of resource
changes, the
DEV parameter
is used to locate
a device
according to the
IP address.

TL1_ONT_ 12 Indicates that 16 12 Acces Command


SN_LENG the returned SN sNeM involved by the
TH is in the format grSer configuration
of 12-byte vice item: LST-ONT
character string. TL1N
BIServ
16 Indicates that
ice
the returned SN
is in the format inTL1
of 16-byte NBISe
character string. rvice
PonE
msTL

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 35


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

TL1_SN_L ONU Specifies the - - 1Servi


EN_SPECI type. format of the ce
AL_ONUT The SN returned by
YPE value some GPON
depen ONU types in
ds on the exported
the resource file. To
EQUI set the SN
PMEN format returned
TID by some ONU
return types to be
ed by different from
the that returned by
LST- all other ONU
ONT types and
comm defined in the
and. TL1_ONT_SN_L
Use ENGTH
comm parameter, set
as (,) this parameter.
to For example, if
separ TL1_ONT_SN_L
ate ENGTH is set to
multi 16, it indicates
ple that the
ONU returned SN is
types, in the format of
for 16-byte
exam character string.
ple, However, the
HG82 HG8240A needs
40A,H to support an
G824 SN in the
5A. format of 12-
byte character
string. In this
case, set
TL1_SN_LEN_SP
ECIAL_ONUTYP
E to HG8240A.
In contrast, if
TL1_ONT_SN_L
ENGTH is set to
12, it indicates

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 36


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

that the
returned SN is
in the format of
12-byte
character string.
However, the
HG8240A needs
to support an
SN in the
format of 16-
byte character
string. In this
case, set
TL1_SN_LEN_SP
ECIAL_ONUTYP
E to HG8240A.

SYNC_CO 0 Indicates that 0 0 Acces Command


MPLETED the NE sNeM involved by the
_NOTIFY_ synchronization grSer configuration
OSS results are not vice item: Notifying
reported to the Device
OSS. Synchronizatio
n
1 Indicates that
the NE
synchronization
results are
reported to the
OSS.

TL1_USE_ 0 Indicates that 0 0 TL1N Command


HAZY_QR the ALIAS BIServ involved by the
Y_AT_LST parameter in ice configuration
_PORT LST-PORT uses item: LST-
the exact match PORT
mode to filter When you
ports when the query ports in
DID and DEV fuzzy match
parameters are mode, it takes
not set. a long time to
run the
command. If
the entered
alias matches

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 37


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

1 Indicates that many ports, the


the ALIAS command may
parameter in time out. You
LST-PORT uses are advised to
the fuzzy match query ports in
mode to filter exact match
ports when the mode or enter
DID and DEV filter criteria as
parameters are precise as
not set. possible when
querying ports
in fuzzy match
mode. Set the
configuration
item based on
actual needs.

TL1_SHO 0 Indicates that in 0 1 TL1N Commands


W_MA568 the exported BIServ involved by the
3T_SWITC resource files or ice configuration
H response, the inTL1 item: DMP-
device type of NBISe INVENTORY,
the MA5683T is rvice LST-DEV, and
displayed as LST-DEVINFO
MA5680T.

1 Indicates that in
the exported
resource files or
response, the
device type of
the MA5683T is
displayed as
MA5683T.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 38


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

NBI_INVE 2 Indicates that 2 2 TL1N Command


NTORY_D you can export BIServ involved by the
UMP_VER the list of ice configuration
SION inventory inTL1 item: DMP-
resources NBISe INVENTORY
including rvice The directory
devices, and format of
subracks, exported XML
boards, ports resource file
and Ethernet vary with the
aggregation value of the
groups of a configuration
specified type to item
a file. NBI_INVENTO
RY_DUMP_VER
SION. For
details, see
Description of
the directory
and format of
exported files.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 39


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

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,
DAUGTHERCAR
D, and PORT. To
export data of
other resource
types, set the
RES parameter
in the
command. For
example, run
the DMP-
INVENTORY:::C

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 40


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

TAG::RES=ME
SHELF CARD
DAUGHTERCAR
D PORT POTS
BRA LAG ADSL
VDSL ONT
SERVICEPORT
VLANOFLAG
ETH command.

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.

LoadOffli 0 Disables the TL1 0 0 TL1N Command


ne offline BIServ involved by the
predeployment ice configuration
function. An PonE item: CFG-
error message is msTL MDUEX
displayed 1Servi
indicating that ce
devices are
offline when
you run the
CFG-MDUEX
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 41


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

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.

xPON_CH 0 Indicates that 0 1 Acces The values of


ECK_PASS the NCE does sNeM the PWD
WORD_R not provide the grSer parameter may
EPEAT_S function of vice be duplicate,
WITCH detecting ONT which may
authentication affect current
password services.
(corresponding Commands
to PWD) involved by the
conflicts. configuration
1 Indicates that item: ADD-
the NCE ONT and
provides the MOD-ONT
function of
detecting ONT
authentication
password
(corresponding
to PWD)
conflicts.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 42


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

xPON_CH 0 Indicates that 0 1 Acces Ensure that the


ECK_IADI the NCE does sNeM parameter is
P_REPEAT not provide the grSer set to a unique
_SWITCH function of vice value to avoid
detecting voice affecting
IP address or provisioned
Layer 3 services.
interface IP Commands
address involved by the
conflicts. configuration
1 Indicates that item: CFG-
the NCE ONTVAINDIV
provides the and ADD-
function of VLANL3IF
detecting voice
IP address or
Layer 3
interface IP
address
conflicts.

xPON_CH 0 Indicates that 0 1 Ensure that


ECK_ONT the NCE does parameters are
DOMAIN_ not provide the set to a unique
REPEAT_S function of value to avoid
WITCH detecting affecting
domain name provisioned
conflicts. services.

1 Indicates that Command


the NCE involved by the
provides the configuration
function of item: CFG-
detecting ONTVAINDIV
domain name
conflicts.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 43


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

xPON_CH 0 Indicates that 0 1


ECK_PHO the NCE does
NENUM_ not provide the
REPEAT_S function of
WITCH detecting
telephone
number
(corresponding
to
SIPUSERNAME_
N if SIP is used
and
corresponding
to H248DN_N if
H.248 is used)
conflicts.

1 Indicates that
the NCE
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.

xPON_CH 0 Indicates that 0 1 Acces Commands


ECK_MAC the NCE does sNeM involved by the
_REPEAT_ not provide the grSer configuration
SWITCH function of vice item: ADD-
detecting ONU EPONONT and
MAC addresses MOD-
conflicts. EPONONT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 44


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

1 Indicates that
the NCE
provides the
function of
detecting ONU
MAC addresses
conflicts.

xPON_CH 0 Indicates that 0 1 Acces Commands


ECK_SN_R the NCE does sNeM involved by the
EPEAT_S not provide the grSer configuration
WITCH function of vice item: ADD-
detecting ONU ONT and
SN conflicts. MOD-ONT

0 Indicates that
the NCE provide
the function of
detecting ONU
SN conflicts.

CMTS_CM 0 Indicates that 0 0 Acces Commands


_SNMPQ some sNeM involved by the
UERYSWI parameters are grSer configuration
TCH obtained from vice item: LST-
the cable CMPNM-EQD
modem and LST-
termination CMPNM-SUB
system (CMTS)
side, and is
returned during
periodic polling.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 45


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

1 Indicates that
some
parameters are
obtained from
the CM side,
and is returned
in real time. The
prerequisite is
that the NCE
and CM are
reachable to
each other and
the CM is
online.

TL1_USER 0 Indicates that 1 1 TL1N For details, see


OPERLOG user operation BIServ A.12
_SWITCH logs will not be ice Recording TL1
recorded. PonE User Logs.

1 Indicates that msTL


user operation 1Servi
logs will be ce
recorded. PonAl
armT
L1Ser
vice

BMS_TL1_ defaul If this def def TL1N For details, see


NBI_IP t configuration aul ault BIServ How to Set the
NOTE item is set to t ice IP Address
Before default, the inTL1 Listening
using the listening IP NBISe Range.
configura address does
tion item,
rvice
not need to be
modify PonE
the set. At this
msTL
ListenAllI moment, the
1Servi
p c... first. listening IP
ce
address is the
floating IP PonAl
address. armT
L1Ser
vice

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 46


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

IP ● If this
addre configuration
ss item is set to
a valid IP
address, the
TL1 NBI only
listens to the
messages
sent from the
IP address. If
● this
configuration
item is set to
an invalid IP
address, the
listening IP
address is the
floating IP
address.

xPON_SU 0 Indicates that 0 0 Acces Command


PPORT_L the IP address sNeM involved by the
AN_IP_CO segment of ONT grSer configuration
NFIG LAN ports vice item: CFG-
cannot be set. ONTVAINDIV

1 Indicates that
the IP address
segment of ONT
LAN ports can
be set.

NBI_CHEC 0 Indicates that 0 0 TL1N Command


K_RID_IN the value of the BIServ involved by the
PUT_SWIT RID parameter ice configuration
CH can be set to inTL1 item: MOD-
quotation marks NBISe SERVICEPORT
except for two rvice and CRT-
single quotation SERVICEPORT
marks (''), such
as one single
quotation mark
(') or three
single quotation
marks (''').

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 47


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

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 (''').

OPERATI 0 Indicates that 0 0 - Command


ON_MOD the NCE does involved by the
E not verify the configuration
NE SSH item: CFG-
fingerprint. DEVEX

1 Indicates that
the NCE verifies
the NE SSH
fingerprint.

CMMOREI 0 Indicates that 0 0 TL1N Command


NFO no other BIServ involved by the
information is ice configuration
exported when item: DMP-
the CM INVENTORY
resources are
exported
through the
NBI.

1 Indicates that
the DOC version
is exported
when the CM
resources are
exported
through the
NBI.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 48


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

TL1_IS_A 0 Default output 0 0 TL1N Command


DD_BASIC parameter is: BIServ involved by the
PROPERT DID DEV FN ice configuration
Y FRAMENAME inTL1 item: LST-
FRAMESTAT NBISe FRAME

1 Default output rvice


parameter is:
DID DEV FN
FRAMENAME
FRAMESTAT
FRAMELOCALN
AME SHELF
FRAMESUPPLIE
R

xPONCO 0 Returns CIGG as 0 0 Acces Command


MMON_T the terminal sNeM involved by the
HIRDONT types of CIGG grSer configuration
_EQUIPM vendors' ONUs. vice item: LST-
ENT_FOR TL1N GPONONTAUT
MAT 1 Returns the OFIND and
actual ONU BIServ
ice LST-
types as the EPONONTAUT
terminal types inTL1 OFIND
of CIGG NBISe
vendors' ONUs. rvice

TL1_MAX 30 Maximum 30 30 TL1N If the network


_SESSION number of BIServ management
COUNT concurrent ice scale is 50,000
logins allowed or more
by the TL1 NBI equivalent NEs,
(value range: the
1-128). recommended
value is 50.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 49


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

TL1_CHA AutoS Chinese GB GB TL1N -


RSET elect environment K K BIServ
uses the GBK ice
encoding
format. English
environment
uses the
ISO-8859–1
encoding
format. Other
environments
use the UTF-8
encoding
format.

UTF-8 Uses the UTF-8


encoding
format.

ISO– Uses the


8859– ISO-8859–1
1 encoding
format.

GBK Uses the GBK


encoding
format.

TL1_MAX 15 Maximum 15 15 TL1N If the network


_IP_CONN number of BIServ management
ECTION connection ice scale is 50,000
established with or more
a single IP equivalent NEs,
address (value the
range: 1-1024). recommended
value is 50.

NBIFRAM 60 Login failure 60 60 TL1N -


E_LOGIN_ count interval BIServ
FAIL_COU (value range: ice
NT_INTER 1-86400, unit:
VAL s).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 50


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

NBIFRAM 3 Maximum 3 3 TL1N -


E_MAX_A number of BIServ
LLOWED_ failed login ice
LOGIN_FA attempts (value
ILS range: 1-10).

NBIFRAM 180 Duration in the 18 180 TL1N -


E_MAX_B blacklist (value 0 BIServ
LOCK_TI range: 1-86400, ice
ME unit: s).

xPON_SU 0 TR069 operation 0 0 Acces Command


PPORT_T switch is sNeM involved by the
R069_OV disabled. grSer configuration
ER_GENE vice item: GET-
RIC 1 TR069 operation ONTTR069NO
switch is DEVALUE and
enabled. SET-
ONTTR069NO
DEVALUE.

BMS_LST_ 0 Indicates GMT 0 0 TL1N Command


DEV_CRT is not displayed BIServ involved by the
DATE_SH in the CRTDATE ice configuration
OW_GMT parameter when inTL1 item: LST-DEV
querying the NBISe
time that an NE rvice
is created.

1 Indicates GMT
is displayed in
the CRTDATE
parameter when
querying the
time that an NE
is created.

GPON_P 0 Indicates the 0 0 Acces Command


WD_FOR storage format sNeM involved by the
MAT_IN_ of the grSer configuration
DB authentication vice item: LST-
password is HEX FRAME and so
when the GPON on.
ONT data is
imported into
the database.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 51


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

1 Indicates the
storage format
of the
authentication
password is
common when
the GPON ONT
data is imported
into the
database.

TL1_LISTE 9819 Indicates the 98 981 TL1N -


NPORT port of the 19 9 BIServ
TL1NBiDm ice
northbound
service (default:
9819).

TL1_IDLE 600 Indicates the 60 600 TL1N -


TIME idle time of the 0 BIServ
TL1NBiDm ice
northbound
service (default:
600).

BMS_DEV 0 Disables query 0 0 Acces Command


_QUERY_S data from NEs. sNeM involved by the
ERVICEPO grSer configuration
RT 1 Enables query vice item: DEL-
data from NEs. SERVICEPORT

BUFFER_C 10 Indicates the 10 10 TL1N -


HECK_INT interval of TL1 BIServ
ERVAL buffer check ice
time (unit: s). inTL1
NBISe
rvice
PonE
msTL
1Servi
ce
PonAl
armT
L1Ser
vice

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 52


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

BUFFER_E 80 Indicates the 80 80 TL1N -


XCEED_AL value of TL1 BIServ
ARM_THR buffer exceeds ice
ESHOLD the alarm inTL1
threshold (value NBISe
range: 0–100; rvice
unit: %).
PonE
msTL
1Servi
ce
PonAl
armT
L1Ser
vice

BUFFER_E 75 Indicates the 75 75 TL1N -


XCEED_CL value of TL1 BIServ
EAR_THR buffer threshold ice
ESHOLD exceeding alarm inTL1
is cleared (value NBISe
range: 0–100; rvice
unit: %).
PonE
msTL
1Servi
ce
PonAl
armT
L1Ser
vice

NBI_INVE 0 Export ADSL/ 0 0 inTL1 Command


NTORY_D VDSL/POTS NBISe involved by the
UMP_ADS Ports of rvice configuration
L_VDSL_P common item: DMP-
OTS format. INVENTORY

1 Export ADSL/
VDSL/POTS
Ports of special
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 53


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

BMS_LST 0 The output of 0 0 TL1N Command


ONTPORT the LST- BIServ involved by the
_SHOW_ ONTPORT ice configuration
NNI command does inTL1 item: LST-
not contain NBISe ONTPORT
information rvice
about the NNI
ports.

1 The output of
the LST-
ONTPORT
command
contains
information
about the NNI
ports.

xPON_ON 0 Indicates the 0 0 Acces Command


U_NAME_ name of ONU sNeM involved by the
REPEAT_S cannot be grSer configuration
WITCH repeated. vice item: ADD-
Acces ONT ADD-
1 Indicates the EPONONT
name of ONU sCom
monS MOD-ONT
can be repeated. MOD-
ervice
EPONONT

DEV_ERR 0 Tolerance switch 0 0 Acces Command


OR_TOLE for error of sNeM involved by the
RANCE device is grSer configuration
disabled. vice item: DEL-
Acces SERVICEPORT
sCom and so on.
monS Configuration
ervice item
XMLS TL1_TOLERAN
oapN CCE_ERROR
BIServ will not be
ice available when
DEV_ERROR_T
TL1N
OLERANCE is
BIServ
enabled.
ice

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 54


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configur Confi Description De Rec Resta Remarks


ation gurat fa om rting
Item ion ult me Micro
Item Va nde servic
Value lu d es
e Val
ue

1 Tolerance switch inTL1


for error of NBISe
device is rvice
enabled.

PON_POR 0 The maximum 0 0 Acces Commands


T_MAX_O number of sNeM involved by the
NU_NUM ONUs grSer configuration
connected to a vice item: ADD-
PON port is not Acces ONT and ADD-
controlled. sCom EPONONT

1-255 Controls the monS


maximum ervice
number of
ONUs
connected to a
PON port.

BMS_TL1_ TL1 commands TL1N Command


PRIORITY are run BIServ involved by the
_USER_LIS regardless of ice configuration
T users. inTL1 item: all
NBISe commands
List of If enabled, TL1 except DMP-
usern commands rvice
INVENTORYan
ames issued by users dTST-SELT
in the username
list are run in
priority.

IS_SHORT 0 Show long type 1 1 TL1N Commands


_ONT_TY name of ONT. BIServ involved by the
PE_NAME ice configuration
1 Show short type item: LST-ONT
name of ONT. inTL1
NBISe and so on.
rvice
PonE
msTL
1Servi
ce
PonAl
armT
L1Ser
vice

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 55


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

● 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';commit;
c. Run the following SQL statement to check whether the modification
succeeds:
select CfgValue from BMSDB.bms_cfg_tab where CfgName =
'TL1_LSTSERVICEPORT_PT';
d. Log in to the management plane of NCE and restart the TL1NBIService
microservice.
See A.15 Logging In to the Management Plane of NCE.
e. Issue the command again and check whether the value of PT returned
meets requirements.

Table 8-2 Configuration item description


Configura Co Description Def Rec Rest Remarks
tion Item nfi aul om artin
gu t me g
rat Val nde Micr
io ue d oSer
n Val vices
Ite ue
m
Va
lu
e

PROTOCO 0 Indicates that the 2 2 TL1N For details,


L NCE and OSS use BISer see 7 SSL
the TCP protocol to vice Principle and
communicate with Configuratio
each other. n.

2 Indicates that the


NCE and OSS use
the SSL protocol to
communicate with
each other.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 56


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configura Co Description Def Rec Rest Remarks


tion Item nfi aul om artin
gu t me g
rat Val nde Micr
io ue d oSer
n Val vices
Ite ue
m
Va
lu
e

TL1_TOLE 0 Indicates that an 1 1 - For details,


RANCCE_E error message is see Deleting
RROR displayed when a a Service
user runs the DEL- Virtual Port
SERVICEPORT (DEL-
command to delete SERVICEPOR
nonexistent service T).
ports for the Configuration
MA5600T, MA5680T, item
MA5603T TL1_TOLERA
V800R006C02 and NCCE_ERROR
later versions, will not be
MA5608T, MA5800 available
series, EA5800 when
series, and all DEV_ERROR_
MDUs. TOLERANCE
1 Indicates that a is enabled.
success message is
displayed when a
user runs the DEL-
SERVICEPORT
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 20 Indicates the size of 20 20 Acces Commands


X_FILE_SIZ each exported file. sNe involved by
E The value indicates MgrS the
that the maximum ervic configuration
size of each e item: DMP-
exported file is 20 E2EPERF,
MB. DMP-

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 57


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configura Co Description Def Rec Rest Remarks


tion Item nfi aul om artin
gu t me g
rat Val nde Micr
io ue d oSer
n Val vices
Ite ue
m
Va
lu
e

DUMP_MA 20 Indicates the 20 20 ETHPERF,


X_FILE_SA maximum number DMP-
VE_NUM of files that can be ONTPERF,
saved. The value and DMP-
indicates that a POTSPERF
maximum of 20
files can be
exported.

UseRightP 0 Indicates that the 0 1 TL1N Command


araNameF original spelling BISer involved by
orPotsStat format FAILED- vice the
e REGISTRATTION is configuration
retained. item: LST-
ONTPOTSST
1 Indicates that the ATE
correct spelling
format FAILED-
REGISTRATION is
used.

IsSupportX 0 Disables query of 0 0 Acces Command


MLSyn user-defined ONT sNe involved by
parameters. MgrS the
ervic configuration
1 Enables query of e item: SYN-
user-defined ONT ONTXML
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 58


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configura Co Description Def Rec Rest Remarks


tion Item nfi aul om artin
gu t me g
rat Val nde Micr
io ue d oSer
n Val vices
Ite ue
m
Va
lu
e

TL1_LSTSE 0 Indicates that the 0 0 TL1N Command


RVICEPOR values of the output BISer involved by
T_PT parameter PT of the vice the
LST-SERVICEPORT configuration
command are as item: LST-
follows: SERVICEPOR
● LAN-ADSL T
● LAN-SHDSL
● LAN-ATM
● LAN-LAN
● LAN-ETH
● LAN-VDSL2
● LAN-GFAST
● LAN-GPON
● LAN-EPON
● SPU-GPON
● SPU-SPU
● SPU-LAN
● LAN-SPU
● LAN-EPONONT
LAN
● LAN-GPONONT
LAN
● LAN-ONT
IPHOST
● LAN-ONT
● LAN-GPONONT
VDSL2
● UPLINKPORT-
ETHER
● UPLINKPORT-
LAN
● UPLINKPORT-
GPON

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 59


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configura Co Description Def Rec Rest Remarks


tion Item nfi aul om artin
gu t me g
rat Val nde Micr
io ue d oSer
n Val vices
Ite ue
m
Va
lu
e

1 Indicates that the


values of the output
parameter PT of the
LST-SERVICEPORT
command are as
follows:
● ADSL
● SHDSL
● ATM
● LAN
● ETH
● VDSL2
● GFAST
● GPON
● EPON
● SPU
● CNULAN
● xPON

NEED_REF 0 Indicates that the 1 0 re- For details,


RESH_WIN NCE does not impo see
refresh aliases on rt the Modifying
the client after the mem the
aliases are modified ory Attributes of
through an NBI. You table an ADSL Port
can query the (MOD-
aliases again to ADSLPORT),
refresh them. Modifying
the
Attributes of
an ADSL Port
Through the
Enhanced
Command
(MOD-
ADSLPORTEX
),Modifying

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 60


iMaster NCE
Northbound TL1 Interface User Guide 8 Setting Configuration Items

Configura Co Description Def Rec Rest Remarks


tion Item nfi aul om artin
gu t me g
rat Val nde Micr
io ue d oSer
n Val vices
Ite ue
m
Va
lu
e

1 Indicates that the the


NCE refreshes Attributes of
aliases on the client an SHDSL
after the aliases are Port (MOD-
modified through SHDSLPORT)
an NBI. ,Modifying
the
Attributes of
a VDSL2 Port
(MOD-
VDSL2PORT)
or Modifying
the
Attributes of
a VDSL2 Port
Through the
Enhanced
Command
(MOD-
VDSL2PORTE
X).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 61


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

9 Command Format

This topic describes the formats of the commands, responses, and resource change
notifications.

9.1 Format Description


This topic describes the functions of the TL1 NBI commands.
9.2 Command Format Description
This topic describes the formats and parameters of the TL1 NBI commands.
9.3 Response Format Description
This topic describes the parameters of the responses to the TL1 NBI commands.
9.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

9.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:
● Commands for operation: All the character strings match with each other
precisely.
● 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.
● 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 configuration file. In this case, the methods for
inputting and outputting must be the same.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 62


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

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:
● Reports the alarming or non-alarming emergencies
● Reports the scheduled test and diagnosis to NEs
● Reports inspection data on performance specifications
● Reports the change of the data in the NE database
● Reports the preceding information regularly according to the selection criteria
of the NE

Command Symbol
Table 9-1 provides the description of command symbols enclosed in different
formats.

Table 9-1 Command symbol description


Symbol Description

<> Encloses an identifier, for example, <int-num> 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.

^ 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 <digit> ::= (0|1|~|9) indicates that the
value <digit> is any figure ranges from 0 to 9.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 63


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

9.2 Command Format Description


This topic describes the formats and parameters of the TL1 NBI commands.

Command Format
<command_code>:<staging_parameter_blocks>:<message_payload_block>;
<command code>::=<verb>[-<modifier>[-<modifiers>]]
Staging Parameter Block::=[<target identifier>]:<access identifier(s)>:<ctag>:

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 <target
identifier> does not exist, the ":" follows it must remain.

Parameter Description
Table 9-2 describes the parameters of the TL1 command.

Table 9-2 Parameters of the TL1 command

Parameter Description

command_code Refers to the command code, and indicates what needs to


be executed.
● verb: a mandatory parameter and specifies the
operations that the command executes. In NCE, it is
defined as the name of the notice message
● modifier: optional value in the verb parameter. There
are two such values in the parameter and are
separated by a hyphen (-) symbol.

staging_parameter_ Command parameter.


blocks ● target identifier: not applicable in this case
● access identifier: Is used for location
● 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:
● English letters: A-Z and a-z.
● Numbers: 0-9.
● Symbols: ( ) _ - + . / \ and space.
Some commands allow single quotation marks '' in the Alias
field or certain fields, indicating that they are left blank.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 64


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

Parameter Description

message_payload_b Refers to the main content of the message and is named


lock pay-load; It can be either a null value or multiple data
block in the format of: "(<Px>(,<Px>)*)*".
"Px" indicates a data item. Use a comma (,) to separate
several data items. The format of the data item is shown
as "<keyword>=<value>".

Example
The LST-FRAME command is used as an example to describe the command
format.

9.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:
● Format of the response to the operation command:
– <header><response identification><text block><terminator>

– header::=<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:<second>

– response identification::=<cr><lf>M^^<ctag>^<completion code>

– text block::=(<cr><lf>^^^<EN=error-code>^^^<ENDESC=error-description>)
terminator::=<cr><lf>(;|>)

● Format of the response to the query command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 65


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

– <header><response identification><text block><terminator>

– header::=<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:<second>

– response identification::=<cr><lf>M^^<ctag>^<completion code>

– text block::=(<cr><lf>^^^<EN=error-code>^^^<ENDESC=error-description>)[(<cr>
<lf>^^^<quoted line>)]

– quoted line::=<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<
blktotal=total-count><cr><lf><result>

– result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>

– attribs::=<attrib>((<tab><attrib>)*)<cr><lf>

– values::=<value>((<tab><value>)*)<cr><lf>

– terminator::=<cr><lf>(;|>)

Parameter Description
Table 9-3 describes the parameters of the responses to the TL1 NBI commands.

Table 9-3 Parameters of the responses to the TL1 NBI commands


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.

response Indicates the response identifier.


identification ● 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.
● completion code: functions as an ending identifier.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 66


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

Parameter Description

text block Indicates the body text of the responding message.


● EN: error code.
● 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.
● 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.
● title: character string type, indicates the title of the
response.
● attrib: character string type, indicates the attribute
name.
● 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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 67


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

9.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><auto id>[<text block>]<terminator>
header::=<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:<second>
auto id::=<cr><lf><almcde>^^<atag>^<verb>[^<modifier>[^<modifier>]]
text block::=(<cr><lf>^^^<unquotedline>)|(<cr><lf>^^^<quoted line>)|(<cr><lf>^^^<comment>)
terminator::=<cr><lf>(;|>)

Parameter Description
Table 9-4 describes the parameters required for the resource change notification.

Table 9-4 Parameters required for the resource change notification


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.

auto id Indicates the level and state of automatic reported


message.
● almcde: indicates the severity different alarms, such as
*C (Critical), ** (Major), * (Minor) and A (Warning).
● 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.
● verb: a mandatory parameter and specifies the
operations that the command executes. In NCE, "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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 68


iMaster NCE
Northbound TL1 Interface User Guide 9 Command Format

Parameter Description

text block Indicates the body text of the responding messages.


● unquoted line: error code. In the notification, it is
always "0".
● quoted line: content of the message packets. It is used
to deposit the notification.
● comment: located between "/*" and "*/", and is used
to explain a message.

terminator The ending identifier of the responding messages,


including">"and";".

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 69


iMaster NCE
Northbound TL1 Interface User Guide 10 Supported Devices of the Same Series

10 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 10-1 Device type parameters


Device Device Device Types of Remarks
Type No. Type the Same Series

96 MA5620 MA5620A, TL1 commands that apply to


MA5620B, and the MA5620 also apply to
MA5620H the MA5620A, MA5620B,
and MA5620H.

97 MA5626 MA5626A, TL1 commands that apply to


MA5626B, and the MA5626 also apply to
MA5626H 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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 70


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11 Controlling a Session and


Performing Operations on a Device

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 NCE, 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.
11.1 Controlling the Session
This topic provides the commands and examples for controlling the session.
11.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.

11.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 NCE, 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.

11.1.1 Logging in to the NCE (LOGIN)


Usage Note
When using the TL1 NBI function, make sure the OSS communicates with the NCE
using port 9819.
This command is used to log in to the NCE 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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 71


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Command Format
LOGIN:::CTAG::UN=user-name,PWD=password;

Input Parameter
Parameter Type Range Description Default

UN OCTET SIZE (20) Indicates the -


STRING username.

PWD OCTET SIZE (16) Indicates the -


STRING password.

The default username is admin. For details about the initial password and security
requirements, see "User and Password Management" in NCE Administrator Guide.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

7654603 Invalid username or password. Enter the correct username and


1 password.

7654596 Invalid license. Apply for a new license and


7 update it.

2686058 User relogin error. Do not log in to the NCE again


556 because you have logged in.

1618280 The number of sessions exceeds Check the TL1 client that you
737 the maximum limit. Contact the have logged in to. If the upper
administrator. limit is reached, modify the
configuration item
TL1_MAX_SESSIONCOUNT.

Example
To log in to the NCE by entering the username tester and the password
Changeme_321 after a connection is successfully set up between the server and
the client, run the following command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 72


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

LOGIN:::1::UN=tester,PWD=Changeme_321;

The result is as follows:


0 2005-06-08 16:39:39
M 1 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

11.1.2 Logging In to the NCE (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 NCE from the NMS
with a user account that is created on the NCE EMS client.

Command Format
ACT-USER:[<TID>]:<UID>:<CTAG>::<PID>;

Response Format
● Normal
<cr><lf><lf>
^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf
M^^<ctag>ˆCOMPLD cr lf
;

● Error
<cr><lf><lf>
^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf
M^^<ctag>ˆDENY cr lf
^^^<errcode><cr><lf>
^^^/*<error description>*/<cr><lf>
;

Output Parameter
None.

Error Code
ID Description Solution

2686058556 User relogin Do not log in to the NCE again because you
error. have logged in.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 73


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Example
To log in to the NCE by entering the username admin and the password
Changeme_321, run the following command:
ACT-USER::admin:100::Changeme_321;
The result is as follows:
● Normal
N2000BMS 09-01-01 02:15:27
M 100 COMPLD
;

● Error
N2000BMS 09-01-01 02:49:08
M 100 DENY
IDMS
/*Invalid username or password.*/
;

Related Command
There is no related command.

11.1.3 Exiting the NCE (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 9.3
Response Format Description.

Output Parameter
None.

Error Code
None.

Example
To exit the NCE, run the following command:
LOGOUT:::8::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 74


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

The result is as follows:


0 2005-06-08 16:39:39
M 8 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

11.1.4 Exiting the NCE (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>]:[<UID>]:<CTAG>;

Input Parameter
Parameter Type Range Description Default

<TID> OCTET SIZE (20) Indicates the target N/A


STRING identifier. The value
of this parameter is
blank here. TID is
represented by two
successive colons.

<UID> OCTET SIZE (16) Indicates the N/A


STRING existing usernames
in the EMS.

The default username is admin. For details about the initial password and security
requirements, see "User and Password Management" in NCE Administrator Guide.

Response Format
● Normal
<cr><lf><lf>
^^^<rsphdr><cr><lf>
M^^<ctag>^^COMPLD<cr><lf>
;
;
● Error
<cr><lf><lf>
^^^<rsphdr><cr><lf>

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 75


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

M^^<ctag>^DENY<cr><lf>
^^^<errcode><cr><lf>
^^^/*<error description>*/<cr><lf>
;

Output Parameter
None.

Error Code
ID Description Solution

989855937 User does not Ensure that the entered username is the
log in. same as the name of the current user that
has logged in to the system.

Example
To exit the NCE by entering the username admin, run the following command:

CANC-USER::admin:100;

The result is as follows:

● Normal
N2000BMS 04-01-01 15:23:20
M 100 COMPLD
;

● Error
N2000BMS 04-01-01 14:30:00
M 100 DENY
IDMS
/*User does not log in*/
;

Related Command
There is no related command.

11.1.5 Querying the NCE Version (LST-BMSVERSION)

Usage Note
None.

Command Format
LST-BMSVERSION:::CTAG::;

Input Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 76


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Response Format
It complies with the response format of the query command provided in 9.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


NCE version.

Error Code
None.

Example
To query the NCE version, run the following command:
LST-BMSVERSION:::1::;
The result is as follows:
0 2005-12-11 17:14:14
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

V200R017C60
------------
Version
V200R017C60
------------

Related Command
None.

11.1.6 Querying the NMS Information (LST-EMFSYSINFO)


Usage Note
None.

Command Format
LST-EMFSYSINFO:::CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 77


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Supporting Device
None.

Response Format
It complies with the response format of the query command provided in 9.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
Para Type Range Description
meter

ID INTEGER 1 Indicates the NMS ID from a vendor.

NAME OCTET HUAWEIEMS Indicates the NMS name from a


STRING vendor.

TYPE OCTET EMS Indicates the NMS type from a


STRING vendor.

MAN OCTET HUAWEI Indicates the vendor name.


UFATC STRING
TURE

IP OCTET SIZE (255) Indicates the IP address and port


STRING 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 OCTET SIZE (255) Indicates the NMS version from a


FACE STRING vendor.

MAN OCTET SIZE (255) Indicates the location of the NMS


UADD STRING server.
RESS

OPER OCTET normal Indicates the running status of the


ATEST STRING NMS from a vendor.
ATE

SYSW OCTET Critical Indicates the alarm status of the NMS


ARNS STRING Major from a vendor. The highest severity of
TATE alarm is returned.
Minor
Warn
none

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 78


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Para Type Range Description


meter

MAXN OCTET SIZE (255) Indicates the maximum NEs that the
ECOU STRING NMS from a vendor can manage.
NT

NECO OCTET SIZE (255) Indicates the number of NEs that the
UNT STRING NMS from a vendor is managing.

CREAT OCTET SIZE (255) Indicates the ID of the installation


OR STRING engineer of the NMS.

CREAT OCTET SIZE (255) Indicates the NMS installation date.


EDAT STRING
E

HARD OCTET LINUX Indicates the hardware information


WARE STRING about the NMS server.
INFO

SOFT OCTET LINUX Indicates the software information


WARE STRING about the NMS server.
INFO

CREAT OCTET SIZE (255) Indicates the address of the NMS


ORAD STRING installation engineer.
DRESS

CREAT OCTET SIZE (255) Indicates the telephone number of


ORTE STRING the NMS installation engineer.
L

REMA OCTET SIZE (255) Indicates the NMS remarks.


RK STRING

VERSI OCTET SIZE (255) Indicates the software version of the


ON STRING NMS from a vendor.

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:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 79


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

LST-EMFSYSINFO:::1::;

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 V200R017C60 shenzhen normal none 15000 0.390625
huawei -- LINUX LINUX shenzhen 400-830-2118 Remark V200R017C60
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------
;

Related Command
None.

11.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 9.3
Response Format Description.

Output Parameter
None.

Error Code
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 80


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide 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
M 8 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

11.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>::<CTAG>;

Supporting Device
Device Type No. Device Type

94 MA5603U
NOTE
MA5603U V800R202C01 and later versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 81


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

TID OCTET SIZE (128) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
● Normal
<cr><lf><lf>
^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf
M^^<ctag>ˆCOMPLD cr lf
;

● Error
<cr><lf><lf>
^^^<sid>ˆYY-MM-DDˆHH:MM:SS cr lf
M^^<ctag>ˆDENY cr lf
^^^<errcode><cr><lf>
^^^/*<error description>*/<cr><lf>
;

Output Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 82


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

1611604226 The TAP does The entered TAP number is


not exist. different from the TAP number
specified by the device. In this
case, enter the specified TAP
number and re-issue the CONN-
LPACC-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:

● Normal
7340116 11-01-30 11:08:37
M CTAG COMPLD
;

● Error
7340116 11-01-30 11:06:55
M CTAG DENY
IDMS
/*The TAP does not exist*/
;

Related Command
● CONN-LPACC-MET
● DISC-TACC

11.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.

If there is no description for the time format, the time of related commands is in UTC format by
default.

11.2.1 Creating a Subnet (ADD-SUBNET)

Usage Note
This command is used to create a subnet on the NCE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 83


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Command Format
ADD-SUBNET::NAMESEQUENCE=sequence of subnet name:CTAG::[COMMENT=subnet-comment];

Supporting Device
This command is used to perform operations on the NCE. Device type is not
specified.

Input Parameter
Parameter Type Range Description Default

NAMESEQUE OCTET SIZE (1024) Indicates the N/A


NCE STRING sequence of
subnet
names.
Names of
subnets in
different
layers are
separated by
backslash (\),
for example,
\HW\F4.

COMMENT OCTET SIZE (255) Indicates the N/A


STRING remarks for
the subnet.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

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:


0 2011-05-01 16:39:39
M 2 COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 84


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.2.2 Modifying a Subnet (MOD-SUBNET)

Usage Note
This command is used to modify the name and remarks of a subnet on the NCE.

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 NCE. Device type is not
specified.

Input Parameter
Parameter Type Range Description Default

NAMESEQUE OCTET SIZE (1024) Indicates the N/A


NCE STRING sequence of
subnet
names.
Names of
subnets in
different
layers are
separated by
backslash (\),
for example,
\HW\F4.

NAME OCTET SIZE (128) Indicates the N/A


STRING 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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 85


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

COMMENT OCTET SIZE (255) Indicates the N/A


STRING remarks for
the subnet.

Response Format
It complies with the response format of the operation command provided in 9.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:


0 2011-05-01 16:39:39
M 2 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.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 NCE. Device type is not
specified.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 86


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

NAMESEQUE OCTET SIZE (1024) Indicates the N/A


NCE STRING sequence of
subnet
names.
Names of
subnets in
different
layers are
separated by
backslash (\),
for example,
\HW\F4. 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 9.3
Response Format Description.

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
M 2 COMPLD
EN=0 ENDESC=Succeeded.
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 87


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Related Command
None.

11.2.4 Adding an NE Link (ADD-NELINK)

Usage Note
This command is used to add an NE link on the NCE. A source and a sink end
must exist on the NCE.

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 NCE. Device type is not
specified.

Input Parameter
Parameter Type Range Description Default

NAME OCTET SIZE (128) Indicates the -


STRING name of the
link.

TYPE OCTET IPLINK Indicates the -


STRING L2LINK type of the
link.
VIRTUALLINK
● IP link
● Layer 2
link
● Virtual link
NOTE
The
SOURCEFN,
SOURCESN,
SOURCEPN,
SINKFN,
SINKSN, and
SINKPN
parameters
are
mandatory if
you set this
parameter to
IPLINK or
L2LINK.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 88


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

SOURCEDEV OCTET SIZE (128) Indicates the -


STRING name of the
source end.

SOURCEFN Integer 0-255 Indicates the -


subrack ID at
the source
end.

SOURCESN Integer 0-35 Indicates the -


slot ID at the
source end.

SOURCEPN Integer 0-63 Indicates the -


port ID at the
source end.

SINKDEV OCTET SIZE (128) Indicates the -


STRING name of the
sink end.

SINKFN Integer 0-255 Indicates the -


subrack ID of
the sink end.

SINKSN Integer 0-35 Indicates the -


slot ID of the
sink end.

SINKPN Integer 0-63 Indicates the -


port ID of the
sink end.

NETTYPE OCTET IPV4 Indicates the -


STRING IPV6 network
protocol type.
DUALSTACK

COMMENT OCTET SIZE (64) Indicates the -


STRING remarks.

ALIAS OCTET SIZE (64) Indicates the -


STRING alias of the
link.

OWNER OCTET SIZE (64) Indicates the -


STRING owner of the
link.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 89


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Output Parameter
None.

Error Code
None.

Example
To add an NE link named link_name, run the following command:

ADD-
NELINK::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,
SINKPN=1:CTAG::NETTYPE=IPV4,COMMENT=link_comment,ALIAS=link_alias,O
WNER=link_owner;

The result is as follows:


0 2011-08-01 16:39:39
M CTAG COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

11.2.5 Modifying an NE Link (MOD-NELINK)

Usage Note
This command is used to modify information about an NE link on the NCE.

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=link-owner];

Supporting Device
This command is used to perform operations on the NCE. Device type is not
specified.

Input Parameter
Parameter Type Range Description Default

LINKID OCTET SIZE (32) Indicates the -


STRING ID of the link.

NAME OCTET SIZE (128) Indicates the -


STRING name of the
link.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 90


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

MNAME OCTET SIZE (128) Indicates the -


STRING name of a
new link.

NETTYPE OCTET IPV4 Indicates the -


STRING IPV6 network
protocol type
DUALSTACK after
modification.

COMMENT OCTET SIZE (64) Indicates the -


STRING new remarks.

ALIAS OCTET SIZE (64) Indicates the -


STRING new alias of
the link.

OWNER OCTET SIZE (64) Indicates the -


STRING new owner of
the link.

Response Format
It complies with the response format of the operation command provided in 9.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-new-
name,NETTYPE=IPV6,COMMENT=new-comment,ALIAS=new-
alias,OWNER=new-owner;
The result is as follows:
0 2011-05-01 16:39:39
M 2 COMPLD
EN=0 ENDESC = Succeeded.

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 91


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11.2.6 Deleting an NE Link (DEL-NELINK)


Usage Note
This command is used to delete an NE link on the NCE.

Command Format
DEL-NELINK::[LINKID=link-id][,NAME=link-name]:CTAG::;

Supporting Device
This command is used to perform operations on the NCE. Device type is not
specified.

Input Parameter
Parameter Type Range Description Default

LINKID OCTET SIZE (32) Indicates the -


STRING ID of the link.

NAME OCTET SIZE (128) Indicates the -


STRING name of the
link.

Response Format
It complies with the response format of the operation command provided in 9.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:
0 2011-08-01 16:39:39
M CTAG COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 92


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11.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 NCE 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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 93


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

DT INTEGER See Device Type. -


Supporting
Device.

Response Format
It complies with the response format of the operation command provided in 9.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

2686058 The device does not exist. Verify that the entered ID, name,
531 and IP address of the device are
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 94


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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 NCE 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
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.

11.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 NCE and the NE.
The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be used as
location information. Before using these two parameters as location information,
make sure that the DEV parameter indicates the IP address of the device. For
details, see A.8 How to Locate a Device According to the IP Address.
Currently, the TL1 NBI uses the asynchronous mechanism to process NE
synchronization requests. After a synchronization task is successfully requested,
the system schedules the task and the TL1 NBI does not wait for the
synchronization result.

Command Format
SYNC-DEV::(DID=device-ID|DEV=device-name|(DEV=device-olt-ipaddress, ONULOCATEINFO=onu-locate-
information))[,SRV=sync-service-name]:CTAG::;

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 95


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.
If you set
both the DEV
and
ONULOCATEI
NFO
parameters
for an ONU,
that is, enter
DEV=device-
olt-ipaddress,
ONULOCATEI
NFO=onu-
locate-
information,
the DEV
parameter
indicates the
OLT IP
address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 96


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

ONULOCATEI OCTET SIZE (128) Indicates the N/A


NFO STRING ONU location
information.
This
parameter is
used with the
DEV
parameter (IP
address of the
OLT).
The format is
subrack
number/slot
ID/port
ID/ONU ID.
For example,
0/2/0/0
indicates
ONU 0 that is
connected to
port 0/2/0.

SRV OCTET ● PHYRES Indicates the -


STRING ● ADSL types of
services to be
● VDSL synchronized.
● ETH Data of the
● SERVICEPO entire NE is
RT synchronized
if this
● IGMP parameter is
● PROTOCOL blank.
● VOIP
● GPON
● EPON

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Example
To synchronize the data of the NE 10.78.217.114, run the following command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 97


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

SYNC-DEV::DEV=10.78.217.114:CTAG::;

The result is as follows:


7340071 2010-12-20 21:07:34
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.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=device-IP])):CTAG::;

Supporting Device
Device Type No. Device Type

219 UA5000 (PVM)

37 MA5662

44 MA5600V3

253 UA5000 (IPMB)

34 MA5680T

57 MA5606T

249 MA5600T

61 MA5626E

62 MA5620E

64 MA5651

65 MA5620G

66 MA5626G

70 MA5610

92 MA5652G

94 MA5603U

95 MA5603T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 98


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

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.

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 99


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

2348 MA5683T

2350 MA5811S

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

2354 EDFA3220-D

2368 EDFA3220-D2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 100


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

SUBMAP OCTET 1-64 Indicates the -


STRING sequence of
subnet
names.
Names of
subnets in
different
layers are
separated by
backslash (\),
for example,
\HW\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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2686058531 The device does not exist. Verify 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:
7340034 2005-06-08 16:39:39
M 119 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 101


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11.2.10 Resetting a Device (RESET-DEV)

Usage Note

NOTICE

● After a device is reset, all the boards of the device are reset. This results in
temporary interruption of the services.
● 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.

253 UA5000(IPMB)

2331 MA5608T

2340 MA5611S

2348 MA5683T

2350 MA5811S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 102


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 103


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Output Parameter
None.

Error Code
ID Description Solution

2686058 The device does not exist. Verify that the entered ID, name,
531 and IP address of the device are
correct.

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:
7340034 2005-06-08 16:39:39
M 120 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
SAVE-DEV

11.2.11 Resetting a Board (RESET-BOARD)


Usage Note

NOTICE

● If the control board is reset, the system is also reset.


● 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=slot-number:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 104


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

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.

253 UA5000(IPMB)

2331 MA5608T

2340 MA5611S

2348 MA5683T

2350 MA5811S

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 105


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

1615659120 The board is not supported this The board cannot be


kind of function. reset.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 106


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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

11.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 NCE.

Command Format
MOD-DEV::(DID=Device-ID|DEV=Device-name):CTAG::[NAME=device-name][,ALIAS=device-alias];

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 107


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 108


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

NAME OCTET SIZE (32) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.
If you do not
set this
parameter,
the device
name does
not change.

ALIAS OCTET SIZE (32) Indicates the N/A


STRING new device
alias.
If you do not
set this
parameter,
the device
alias does not
change.

Response Format
This response format complies with that of the operation command provided in
9.3 Response Format Description.

Output Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 109


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

2686058 The device does not exist. Ensure that the entered ID,
531 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

11.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
Device Type No. Device Type

219 UA5000 (PVMV1)

253 UA5000 (IPMB)

249 MA5600T

94 MA5603U

95 MA5603T

34 MA5680T

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 110


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter

Table 11-1 Parameters required for modifying the shelf name and alias
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-512 Indicates the -


subrack ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 111


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

NAME OCTET SIZE (32) Indicates the -


STRING new shelf
name.
If you do not
set this
parameter,
the shelf
name does
not change.

ALIAS OCTET SIZE (32) Indicates the -


STRING 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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

1613758569 The resource does not Run the LST-FRAME command


exist or its type is to obtain the subrack ID and
wrong. 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 of 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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 112


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

EN=0 ENDESC=Succeeded.
;

Related Command
LST-FRAME

11.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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 113


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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 SIZE (32) Indicates the -


STRING 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 9.3
Response Format Description.

Output Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 114


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

1613758 The resource does not exist or its Run the LST-BOARD command
569 type is wrong. to check whether the slot for the
board exists.

Example
To modify the alias of 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

11.2.15 Exporting a Resource File (DMP-INVENTORY)

Usage Note
● If the data volume is large, many system resources will be occupied by the
command. A maximum of three export tasks can be run concurrently by
default.
● This command supports the export of XML and CSV resource files. For details
about command usage, see Command Format.
● 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 .
● 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, see Table 8-1. For
details about the directory and format of the exported files, see Description
of the directory and format of exported files.
● You can specify whether to export the version information about the
inventory resources by setting the configuration item CMMOREINFO.
● 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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 115


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Command Format
DMP-INVENTORY:::CTAG::[DT=device-type][,DEV=Device-name][,RES=resource-type][,TYPE=CSV]
[,FILEPREFIX=file-prefix];

● 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].
● 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].
● 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].
● If you need to export CSV resource files, the command format is DMP-
INVENTORY:::CTAG::TYPE=CSV[,FILEPREFIX=file-prefix].

Supporting Device

Table 11-2 Supporting Device


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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 116


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Para Type Range Description Defa
mete ult
r

DT Integer See Table Indicates the device type. N/A


11-2.

DEV OCTET SIZE (192) Indicates the default device name. N/A
STRING 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 A.8 How to Locate a
Device According to the IP
Address.
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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 117


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Para Type Range Description Defa


mete ult
r

RES OCTET ● ME Indicates the resource type. ME,S


STRING ● SHELF If you do not enter this parameter, HELF,
data of all resource types is CARD
● CARD ,DAU
exported.
● DAUGHTE GTHE
RCARD The options are as follows: RCAR
● PORT ● ME: devices Dand
● SHELF: subracks PORT
● POTS
● BRA ● CARD: boards
● LAG ● DAUGHTERCARD: daughter
boards
● ADSL
● PORT: ports
● VDSL
● POTS: PSTN users
● ONT
● BRA: BRA ports
● SERVICEPO
RT ● LAG: Ethernet aggregation
groups
● VLANOFLA
G ● ADSL: ADSL ports
● ETH ● VDSL: VDSL ports
● PORTOFVL ● ONT: GPON ONT devices
AN ● SERVICEPORT: service virtual
● CABLEMO ports
DEM ● VLANOFLAG: Ethernet
● CMC aggregation groups in a VLAN
● ETH: Ethernet ports
● PORTOFVLAN: List of ports in a
VLAN
● CABLEMODEM: CM terminal
resources
● CMC: CMC devices. Example:
MA5633

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 118


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Para Type Range Description Defa


mete ult
r
NOTE
● The resource information about a
specified resource type can be
exported to a file only when the
NBI_INVENTORY_DUMP_VERSIO
N parameter is set to 3.
● This parameter can be set to one
or more values at a time.
● The LAG parameter is applicable
only to the following devices:
MA5600T, MA5680T, MA5662,
MA5600 V300, MA5603U,
MA5603T and UA5000 (IPMB).
● The PORTOFVLAN parameter is
applicable only to the following
devices: MA5600T, MA5680T,
MA5608T, MA5603U, MA5603T,
MA5600V3, MA5662, MA5616,
MA5611S, MA5623A and UA5000
(IPMB).
● The CMC parameter is applicable
only to the following devices:
MA5600T, MA5603T, MA5608T,
MA5680T and MA5633.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 119


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Para Type Range Description Defa


mete ult
r

TYPE OCTET CSV Indicates the format of the N/A


STRING exported file.
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:
● container_info_yyyy-mm-
dd_hh-mm-ss.csv: device
information file
● shelf_info_yyyy-mm-dd_hh-
mm-ss.csv: subrack information
file
● slot_info_yyyy-mm-dd_hh-mm-
ss.csv: slot information file
● port_info_yyyy-mm-dd_hh-mm-
ss.csv: port information file
● 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-mm-ss_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:
● port_info_2010-12-28_02-02-05
_1_3.csv (100 MB)
● port_info_2010-12-28_02-02-05
_2_3.csv (100 MB)
● 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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 120


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Para Type Range Description Defa


mete ult
r

ftth_container_info_yyyy-mm-
dd_hh-mm-ss.csv.

FILEP OCTET SIZE (32) Indicates the file prefix. This N/A
REFIX STRING 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-mm-ss.csv.

Response Format
This response format complies with that of the operation command provided in
9.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:


If the Service node is deployed in a cluster, the exported file is stored on the
Common Service node. If the Service node is deployed in single-instance mode,
the exported file is stored on the NMS node.There are multiple exported files. The
format and path of the exported files are related to the value of the
NBI_INVENTORY_DUMP_VERSION configuration item.
● NBI_INVENTORY_DUMP_VERSION=2 (default value): The export directory
of resource files is hfs_public/bms/server/nemgr/nemgr_access/conf/
bmscommon/resxml/. The absolute path is: /opt/backup/ftpboot/
hfs_public/bms/server/nemgr/nemgr_access/conf/bmscommon/resxml/.
The format of exported files is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 121


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

● NBI_INVENTORY_DUMP_VERSION=3: The export directory of resource files is


hfs_public/bms/server/nemgr/nemgr_access/dump/. The Absolute path
is: /opt/backup/ftpboot/hfs_public/bms/server/nemgr/nemgr_access/
dump/. The format of exported files is as follows:

● NBI_INVENTORY_DUMP_VERSION=4: The export directory of resource files is


hfs_public/bms/server/nemgr/nemgr_access/dump_xml/. The absolute
path is: /opt/backup/ftpboot/hfs_public/bms/server/nemgr/nemgr_access/
dump_xml/. The format of exported files is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 122


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
None.

Example
● (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:
0 2011-06-13 15:09:20
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of the device-type MA5680T


---------
PATH
server : hfs_public/bms/server/nemgr/nemgr_access/conf/bmscommon/resxml/
ofa5920v3_2018-02-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:
0 2011-06-13 15:13:46
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of the device-type MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 123


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

---------
PATH
server : hfs_public/bms/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:
0 2011-06-13 15:13:46
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of all device-type


---------
PATH
server : hfs_public/bms/server/nemgr/nemgr_access/dump_xml/
10.70.35.236_MA5680T_7340034_20180113074004.xml
---------

Related Command
There is no related command.

11.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 .

Command Format
DMP-E2EPERF:::CTAG::DT=device-type[,DEV=Device-name];

Supporting Device

Table 11-3 Supporting Device

Device Type No. Device Type

249 MA5600T

30 MA5605

34 MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 124


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

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

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Table Indicates the -


11-3 . device type.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 125


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Path information of the device-type "+device-type
name of attributes: PATH

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 126


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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_20
13-10-17_23-14-0
9_n_m.csv, where
n indicates the
sequence number
of a file and m
indicates the total
number of files.If
the Service node
is deployed in a
cluster, the
exported file is
stored on the
Common Service
node. If the
Service node is
deployed in
single-instance
mode, the
exported file is
stored on the
NMS node.

Error Code
ID Description Solution

1615003650 Incorrect parameter Set DT to a supported


input. value.

Example
Export the service port statistics of an MA5600T to files.
● Run the following command:
DMP-E2EPERF:::1::DT=249;
● The result is as follows:
-1 2013-10-17 23:14:24
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 127


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Path information of the device-type MA5600T


---------
PATH
server : hfs_public/var/access/dumpperf/e2e_MA5600T_2018-01-17_23-14-09
---------
;

Related Command
None.

11.2.17 Exporting Ethernet Port Statistics to Files (DMP-


ETHPERF)
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

Table 11-4 Supporting Device

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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 128


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Table Indicates the -


11-4. device type.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 129


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Path information of the device-type "+device-type
name of attributes: PATH

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 130


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Output Parameter
Parameter Type Range Description

PATH OCTET STRING SIZE (255) Indicates the


prefix of the file
path. The file
name is similar to
eth_MA5600T_20
13-10-17_23-14-0
9_n_m.csv, where
n indicates the
sequence number
of a file and m
indicates the total
number of files.If
the Service node
is deployed in a
cluster, the
exported file is
stored on the
Common Service
node. If the
Service node is
deployed in
single-instance
mode, the
exported file is
stored on the
NMS node.

Error Code
ID Description Solution

1615003650 Incorrect parameter Set DT to a supported


input. value.

Example
Export the Ethernet port statistics of an MA5600T to files.
● Run the following command:
DMP-ETHPERF:::1::DT=249;
● The result is as follows:
-1 2013-10-17 23:14:24
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 131


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Path information of the device-type MA5600T


---------
PATH
server : hfs_public/var/access/dumpperf/eth_MA5600T_2018-01-17_23-14-09
---------
;

Related Command
None.

11.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

Table 11-5 Supporting Device

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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 132


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

103 MA5635

104 MA5612

232 MA5680T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Table Indicates the -


11-5. device type.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 133


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Response Format
It complies with the response format of the query command provided in 9.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_2
013-10-17_23-14-
09_n_m.csv,
where n indicates
the sequence
number of a file
and m indicates
the total number
of files.If the
Service node is
deployed in a
cluster, the
exported file is
stored on the
Common Service
node. If the
Service node is
deployed in
single-instance
mode, the
exported file is
stored on the
NMS node.
NOTE
If only one file
exists, n and m are
not set. For
example,
pon_MA5600T_201
4-03-31_16-19-30.
CSV.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 134


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

2686058554 Command does not Set DT to a supported


support this device type. value.

Example
Export the Ethernet port statistics of an MA5600T to files.

● Run the following command:


DMP-PONPERF:::CTAG::DT=249;
● The result is as follows:
-1 2013-10-17 23:14:24
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of the device-type MA5600T


---------
PATH
server : /opt/backup/hfs/hfs_public/var/access/dumpperf/pon_MA5600T_2018-01-17_23-14-09.csv
---------
;

Related Command
None.

11.2.19 Adding a Device (ADD-DEV)

Usage Note
● This command is used to add new devices to the subnets on the NCE.
● The SNMP parameters on the NCE 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.
● The IP addresses of the devices on the NCE must be different.
● Ensure that the SNMP parameter profile has been created. Log in to the OM
plane of NCE. Open the Network Management app and choose System > NE
Communication Parameters from the main menu. Then click Default Access
Protocol Parameters. 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];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 135


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Supporting Device

Table 11-6 Supporting Device


Device Type No. Device Type

37 MA5662
NOTE
The MA5662 V800R309C00 and later
versions support this command.

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.

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

249 MA5600T

2331 MA5608T

2339 MA5818

2343 MA5694S

2340 MA5611S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 136


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

2348 MA5683T

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

2354 EDFA3220-D

2561 Third-Party SNMP Device

2562 Third-Party ICMP Device

2368 EDFA3220-D2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 137


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

DT Integer See Table Indicates the -


11-6. device type.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

DEVIP IPADDRESS - Indicates the -


IP address of
the device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 138


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

NAMESEQUE OCTET SIZE (1024) Indicates the -


NCE STRING sequence of
subnet
names.
Names of
subnets in
different
layers are
separated by
backslash (\),
for example,
\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.

SNMPPROF OCTET SIZE (64) Indicates the -


STRING name of the
SNMP
parameter
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 139


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

SNMPVER OCTET ● V1(v1) Indicates the -


STRING ● V2(v2) SNMP
protocol. It
● V3(v3) 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:
● V1(v1):
Indicates
the
SNMPv1
protocol.
● V2(v2):
Indicates
the SNMP
V2c
protocol.
● V3(v3):
Indicates
the
SNMPv3
protocol.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 140


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default


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
SNMPv1
protocol, you
can enter
either V1 or
v1.

● The DEV parameter is mandatory.


● The DT parameter is mandatory.
● The SNMPPROF parameter (SNMP profile) is optional. If this parameter is not set, the
profile named default should be created first, then the default SNMP profile is used.
● The SNMPVER parameter is optional. If this parameter is not set, the SNMPv1 protocol
is used by default.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

67108590 The same name sub map Modify the device name in
exists. the command and ensure
that the device name is
unique.

1613758516 Device exists. Change the IP address of


the required device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 141


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a 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:


7340034 2005-06-08 16:39:39
M 2 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.2.20 Adding a Board (ADD-BOARD)

Usage Note
A board can be added successfully only when the slot for the board is idle.

Command Format
ADD-BOARD::(DID=Device-ID|DEV=Device-
name),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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 142


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

BTDETAIL OCTET SIZE (48) Indicates the -


STRING 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
documentatio
n.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 143


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

SLOTNAME OCTET SIZE (32) Indicates the -


STRING alias of the
board.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2689009 A board exists. Check whether the configuration


240 data of the board needs to be
deleted. Then, run the DEL-
BOARD 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:
ADD-
BOARD::DEV=10.71.62.48,FN=0,SN=4:120::BTDETAIL=H801GPBC,SLOTNAME=H
801GPBC;
The result is as follows:
7340034 2005-06-08 16:39:39
M 120 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
DEL-BOARD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 144


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11.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.

● Only the board that is not configured with service data can be deleted
successfully.
● The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be
used as location information. Before using these two parameters as location
information, make sure that the DEV parameter indicates the IP address of
the device. For details, see A.8 How to Locate a Device According to the IP
Address.

Command Format
DEL-BOARD::(DID=Device-ID|DEV=Device-name|(DEV=device-olt-ipaddress, ONULOCATEINFO=onu-locate-
information)),FN=FrameID,SN=SlotID:CTAG::;

Supporting Device
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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 145


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.
If you set
both the DEV
and
ONULOCATEI
NFO
parameters
for an ONU,
that is, enter
DEV=device-
olt-ipaddress,
ONULOCATEI
NFO=onu-
locate-
information,
the DEV
parameter
indicates the
OLT IP
address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 146


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

ONULOCATEI OCTET SIZE (128) Indicates the -


NFO STRING 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
ONU 0 that is
connected to
port 0/2/0.

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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2686058 Command does not support this Run the LST-DEV command to
554 device type. check whether the entered
device type is MA5600V3,
MA5680T or MA5603U..

2689009 Deleting board failure, as service Delete the corresponding service


257 connections or correlative data configuration and then delete
(for example, dissociative VL, the board again.
CES channel, FR iwf) exists.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 147


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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
M 120 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.2.22 Disabling a Board (DISABLE-BOARD)


Usage Note
● The DISABLE-BOARD command is applicable only to the board that is
enabled.
● The DISABLE-BOARD command is not applicable to the board that is
automatically discovered.
● 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=slot-number:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

94 MA5603U

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 148


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the entered


parameter or mandatory parameters are correct.
parameter is blank, or
the parameter value is
wrong.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 149


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

ID Description Solution

2686058554 Command does not Run the LST-DEV


support this device type. command to check
whether the entered
device type is
MA5600V3.

2686058531 The device does not The device does not


exist. exist. Verify 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
● LST-DEV
● LST-BOARD
● ENABLE-BOARD

11.2.23 Enabling a Board (ENABLE-BOARD)

Usage Note
● This command cannot be executed on the control board.
● 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=slot-number:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

94 MA5603U

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 150


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter

Table 11-7 Parameters required for enabling a board


Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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 9.3
Response Format Description.

Output Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 151


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

2686058554 Command does not Run the LST-DEV


support this device type. command to check
whether the entered
device type is
MA5600V3.

2688746400 Board not prohibited and Run the LST-BOARD


cannot be enabled. 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 Run the LST-BOARD


configured. 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:


234567 2005-06-08 16:39:39
M 121 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
● LST-DEV
● LST-BOARD
● DISABLE-BOARD

11.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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 152


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Command Format
CONFIRM-BOARD::(DID=Device-ID|DEV=Device-name),FN=frame-number,SN=slot-number:CTAG::;

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 SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 153


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2686058554 Command does not Run the LST-DEV


support this device type. command to check
whether the entered
device type is
MA5600V3.

2688746481 The board has been Run the LST-BOARD


confirmed. command to check
whether the board is in
the auto-discovered
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
M 121 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
● LST-DEV
● LST-BOARD

11.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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 154


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Command Format
SYSTEM-SWITCH::(DID=Device-ID|DEV=Device-name):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 155


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2689008 Standby board fault or not exist. Repair or insert the standby
524 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::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 156


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

The result is as follows:


7340034 2005-06-08 16:39:39
M 120 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.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
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 157


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) N/A


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) N/A


Indicates the
slot ID.

SSN INTEGER 0-63,65535 (Mandatory) N/A


NOTE Indicates the
If no daughter daughter
board exists, board ID.
set this
parameter to
65535.

PN INTEGER 0-63 (Mandatory) N/A


Indicates the
port ID.

Response Format
This response format complies with that of the operation command provided in
9.3 Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 158


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Output Parameter
There in no output parameter.

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 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 Ensure that the command


support this device type. 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:


7340034 2009-09-08 16:39:39
M 2 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
DACT-CATVPORT

11.2.27 Deactivating a CATV Port (DACT-CATVPORT)

Usage Note
There is no usage note.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 159


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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
Device Type No. Device Type

92 MA5652G

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) N/A


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) N/A


Indicates the
slot ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 160


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

SSN INTEGER 0-63, 65535 (Mandatory) N/A


NOTE Indicates the
If no daughter daughter
board exists, board ID.
set this
parameter to
65535.

PN INTEGER 0-63 (Mandatory) N/A


Indicates the
port ID.

Response Format
This response format complies with that of the operation command provided in
9.3 Response Format Description.

Output Parameter
None.

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 Ensure that the command


support this device type. supports the entered device
name or IP address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 161


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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

11.2.28 Changing a Device IP Address (MOD-DEVIP)

Usage Note
This command is used to change a device IP address on the NCE 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=device-IP;

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 162


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 163


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

DEVIP OCTET SIZE (32) Indicates the N/A


STRING device IP
address.

NEWDEVIP OCTET SIZE (32) Indicates the N/A


STRING new IP
address of the
device.

Response Format
This response format complies with that of the operation command provided in
9.3 Response Format Description.

Output Parameter
The IP address of the device must be valid.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 164


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the command is proper


parameter or according to the following
mandatory parameter requirements:
is blank, or the ● The parameter values do not
parameter value is exceed the ranges of the
wrong. parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

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 The device does not exist. In this
exist. case, ensure that the device IP
address is correct.

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
M 121 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
LST-DEV

11.2.29 Adding an Alarm to the NCE (ADD-ALARM)

Usage Note
The alarm to be added to the NCE 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::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 165


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - (Optional) -


Indicates the
device ID.

DEV OCTET SIZE (192) (Optional) -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

DEVIP IPADDRESS - (Optional) -


Indicates the
IP address of
the device.

NODETYPE INTEGER 1 Indicates the -


255 node type.
The meanings
of the options
are as follows:
● 1: device
alarm
● 255: NCE
alarm

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 166


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

CLASS INTEGER 1-6 Indicates the -


classification
of the alarm
or event on
the NCE. The
meanings of
the options
are as follows:
1:
communicatio
n
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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 167


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

FUNCTION 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:
communicatio
n failure
9: service
quality
10: processing
error

FAULTID INTEGER 0-999999999 Indicates the -


alarm or
event ID. This
parameter
and the
device type
are used to
identify an
alarm or
event.

REASONID INTEGER 0-999999999 Indicates the -


cause ID of
the alarm.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 168


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

PARA OCTET SIZE (255) (Optional) -


STRING 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 SIZE (255) Indicates the -


STRING details of the
alarm or
event and
explanation
of other non-
location
parameters.
For example,
MAC#0404-
OOAE-OOAB
and
ONUIP#10.10
.10.10, where
the symbol #
means "be
equal to".
Multiple non-
location
parameters
are separated
by a space.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 169


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

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

● You must set one of the DID, DEV, and DEVIP parameters. The NODETYPE and
FAULTID parameters are mandatory, and other parameters are optional.
● 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 NCE.

Output Parameter
None.

Error Code
None.

Example
To add event 120 to the NCE, 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
M CTAG COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 170


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11.2.30 Saving the Device Configuration (SAVE-DEV)


Usage Note
This command is used to save the configuration of the device on the NCE.

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 B.1 Parameters Related to the
Device Type.

Input Parameter
Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

DID Integer - Indicates the -


device ID.

DEVIP IPADDRESS - Indicates the -


IP address of
the device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 171


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

TYPE OCTET ● DATA Save type -


STRING ● CFG ● DATA:
Only save
data file.
● CFG: Only
save
configurati
on file.
● Not input
TYPE
parameter:
Save data
file and
configurati
on file.

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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

1610612769 Wrong SNMP The access to the device


parameter(s) or reading fails because the device
database failed. is offline or abnormal.

2689017157 System is busy, please try The operation fails


it later. because the device is
busy. In this case, try to
perform the operation
later.

2686058531 The device does not The access to the device


exist. fails because the device
does not exist.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 172


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

ID Description Solution

2686058508 Task timeout. The task times out


because the process is
busy. In this case, try to
perform the operation
later.

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:


7340225 2009-08-11 11:53:30
M 6 COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
None.

11.2.31 Issuing the Command Configuration Script to a Device


(CFG-DEVEX)

Usage Note

To prevent sensitive data from being leaked, the configuration script should not contain
security-related information such as service passwords and phone numbers.
● The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be
used as location information. Before using these two parameters as location
information, make sure that the DEV parameter indicates the IP address of
the device. For details, see A.8 How to Locate a Device According to the IP
Address.
● If MODE is TELNET and the USER and PASSWORD parameters are not
specified, configure Telnet and STelnet parameters on the NCE and the device
before running this command. Perform the following operations to configure
the parameters on the NCE:

The STelnet service is more secure than the Telnet service. Therefore, the STelnet service is
recommended.

a. Log in to the OM plane of NCE.


See A.16 Logging In to the O&M Plane of NCE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 173


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

b. Open the Network Management app and choose System > NE


Communication Parameters from the main menu. Then click Set NE
Telnet/STelnet Parameter.
c. Select a desired device from the navigation tree on the left, and click

.
d. 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 NCE 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.

Figure 11-1 Configuring STelnet parameters

Figure 11-2 Configuring Telnet parameters

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 174


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

e. (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 11.2.31 Issuing the
Command Configuration Script to a Device (CFG-DEVEX).
i. Open the Network Management app and choose System > NE
Communication Parameters from the main menu. Then click Set
NE SSH Fingerprint.

ii. Select the desired device in the navigation tree and click .
iii. In the dialog box that is displayed, modify and verify the device
fingerprint.
● 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.
● 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. 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. The
n 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. The
n 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. The
n 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. The

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 175


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

n 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. The
n 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. The
n 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:
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. The
n 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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 176


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

config

board add 0/20 h801PRTA

alarm output alarmid 0x12345678

vlan @para1@-@para2@

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

vlan 100

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.
● The method for adding command line-based scripts is as follows:
a. Choose Configuration > FTTx Service Pre-Deployment, click Common >
Configuration Script Management 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-olt-ipaddress, ONULOCATEINFO=onu-
locateinformation)):CTAG::(PROFID=file-name)[,MODE=execute-mode]
[,USER=User_Name,PASSWORD=User_Pwd]([,PARAS=value1#value2]|
[,PARAS1NAME=value1[,PARAS2NAME=value2[,PARAS3NAME=value3[,...]]]]);

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 177


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 178


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.
If you set
both the DEV
and
ONULOCATEI
NFO
parameters
for an ONU,
that is, enter
DEV=device-
olt-ipaddress,
ONULOCATEI
NFO=onu-
locate-
information,
the DEV
parameter
indicates the
OLT IP
address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 179


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

ONULOCATEI OCTET SIZE (128) Indicates the N/A


NFO STRING ONU location
information.
This
parameter is
used with the
DEV
parameter (IP
address of the
OLT).
The format is
subrack
number/slot
ID/port
ID/ONU ID.
For example,
0/2/0/0
indicates
ONU 0 that is
connected to
port 0/2/0.

PROFID OCTET SIZE (32) Indicates the N/A


STRING name of the
command
configuration
script to be
issued.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 180


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

MODE OCTET CFGFILE Indicates the N/A


STRING SCRIPTFILE execution
mode of the
TELNET command
configuration
script.
The options
are as follows:
● CFGFILE:
Indicates
the FTP-
based/
SFTP-
based
command
configurati
on script
loading
mode. In
this mode,
the loaded
command
configurati
on script
replaces
the
original
command
configurati
on script of
the device.
The
configurati
on takes
effect only
after you
restart the
device.
● SCRIPTFILE
: Indicates
the FTP-
based/
SFTP-
based
command
configurati
on script
loading
mode. In

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 181


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

this mode,
the
command
configurati
on script is
added to
the
existing
configurati
on file of a
device. The
configurati
on takes
effect
immediatel
y without
the restart
of the
device.
NOTE
ONUs of
V800R307
C01 and
later
versions
and OLTs
of
V800R008
C00 and
later
versions
support
this mode.
● Telnet:
Indicates
the Telnet/
STelnet
mode. In
this mode,
you can
telnet/
STelnet to
the device
to execute
the
command
configurati
on script.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 182


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

USER OCTET SIZE (15) Indicates the N/A


STRING username for
logging in to
the device.
NOTE
This
parameter is
supported
only when
MODE is set
to TELNET.

PASSWORD OCTET SIZE (15) Indicates the N/A


STRING password for
logging in to
the device.
NOTE
This
parameter is
supported
only when
MODE is set
to TELNET.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 183


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

PARAS OCTET SIZE (129) Indicates the N/A


STRING custom
parameter to
be applied to
a device. It
can replace
the @para@
parameter in
the command
configuration
scripts.
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@

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 184


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

+2), and so
on in the
command
configuration
script and set
PARAS to A.

PARASNNAM OCTET SIZE (512) Indicates the N/A


E STRING 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...

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 185


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

You must enter either the device ID or the device name.


When setting the MODE parameter,
● SFTP is more secure than FTP and TFTP. Therefore, SFTP is recommended.
● When the MODE=TELNET parameter is specified:
● If the USER and PASSWORD parameters are specified, the NCE in to the device
using the input user information and issues configurations via Telnet service. Telnet
service is not safe. Therefore, this way is not recommended.
● If the USER and PASSWORD parameters are not specified, you need to set Telnet/
STelnet parameters on the NCE. The logs in to the device using the configured
parameters and issues configurations. The STelnet service is more secure than the
Telnet service. Therefore, the STelnet service is recommended.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

1616445446 The configuration script Upload the required


file does not exist. configuration script file
to the server. For details
about how to upload a
script file, see "The
method for adding
command line-based
scripts" in the preceding
description.

1616445448 Logging in to the device Verify that the username


failed. and password for
logging in to the device
are correct or that the
number of logins
through this username
does not exceed the
maximum value.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 186


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

ID Description Solution

1618280493 Telnet/STelnet Check whether the


parameters are not set command contains
for the NE. MODE=TELNET but does
not contain the USER or
PASSWORD parameter.
If yes, set Telnet/STelnet
parameters on the NCE
and issue this command
again.

Example
Example 1: Assume that the username 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:
CFG-
DEVEX::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.
;

Example 2: Assume that the username 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:
CFG-
DEVEX::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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 187


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

11.2.32 Issuing the Command Configuration Script to an MDE


Device (CFG-MDUEX)
Usage Note

To prevent sensitive data from being leaked, the configuration script should not contain
security-related information such as service passwords and phone numbers.
● 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.

EPON MDUs of V800R307C01 and later versions support this mode.


● 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 ports-PROFID-Version.cfg for other types of
device, please set Number of FE electrical ports to 0 if the device has no
FE electrical ports.
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 earlier version. For example, there are three
files, MA5616-COMMON.cfg, MA5616-COMMON-V800R311.cfg,
and MA5616-COMMON-V800R313.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-COMMON-
V800R313.cfg file. The

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 188


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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 appropriat. Thede.
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. Theut.
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. Theal.
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 pr. Theed.
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 PARA. TheA.
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>

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 189


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

sysname Huawei
...
● The method for adding command line-based scripts is as follows:
a. Choose Configuration > FTTx Service Pre-Deployment , click Common
> Configuration Script Management 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 CFG-MDUEX 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
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

2337 MA5822

2338 MA5898

2339 MA5818

2343 MA5894S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 190


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


OLT device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

ONTKEY OCTET SIZE (32) Indicates the N/A


STRING 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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 191


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

PROFID OCTET SIZE (32) Indicates the N/A


STRING name of the
command
configuration
script to be
issued.
NOTE
● When this
parameter
is set to
NULL,
only a
scheduling
task is
generated
and no
command
configurati
on script is
issued.
● PROFID:
For
broadband
services,
PROFID
must be
HSI. For
voice
services,
PROFID
must be
VOICE. For
other
common
configurati
ons,
PROFID
must be
COMMON
.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 192


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

PARAS OCTET SIZE (129) Indicates the N/A


STRING custom
parameter to
be applied to
a device. It
can replace
the @para@
parameter in
the command
configuration
scripts.
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@

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 193


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

+2), and so
on in the
command
configuration
script and set
PARAS to A.

PARASNNAM OCTET SIZE (512) Indicates the -


E STRING 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...

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 194


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

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 9.3
Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

1616445446 The configuration script Upload the required


file does not exist. configuration script file
to the server. For details
about how to upload a
script file, see "The
method for adding
command line-based
scripts" in the preceding
description.

Example
Example 1: To issue the \bms\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 \bms\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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 195


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Related Command
None.

11.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=slot-num,PN=port-
num:CTAG::PARTITIONID=Partition-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

2340 MA5611S

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 196


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONU ID.
If the UNI NOTE
port is of 10G This
GPON or 10G parameter is
EPON, the available only
value range is in FTTH
0-255; if the scenarios.
UNI port is of
1G GPON, the
value range is
0-127; if the
UNI port is of
1G EPON, the
value range is
0-63.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 197


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

PARTITIONID INTEGER 1-255 Indicates the -


ID of the
ANCP
domain.

ENABLESWIT OCTET ● ENABLE Enables or -


CH STRING ● DISABLE disables the
ANCP
function of
the ports.

INTERFACETY OCTET ● ETH Indicates the -


PE STRING ● ATM type of the
packets
during the
ANCP session.
NOTE
This
parameter is
not supported
in FTTH
scenarios.

VPI INTEGER 0-4095 Indicates the -


VPI of the
ANCP.
NOTE
This
parameter
can be set
only when
INTERFACETY
PE is set to
ATM.
This
parameter is
not supported
in FTTH
scenarios.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 198


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

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
INTERFACETY
PE is set to
ATM.
This
parameter is
not supported
in FTTH
scenarios.

VLANID INTEGER 1-4095 Indicates the -


ID of the user
VLAN.
NOTE
This
parameter
can be set
only when
INTERFACETY
PE is set to
ETH.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Output Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 199


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Error Code
ID Description Solution

2686058498 Missing, invalid parameter Verify that the command is


or mandatory parameter is correct according to the following
blank, or the parameter requirements:
value is wrong. ● The parameter values do not
exceed the ranges of the
parameters specified by the
command.
● The entered parameter names
are correct.
● 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:
CFG-
PORTANCPINTERFACE::DEV=10.144.194.11,FN=0,SN=13,PN=3:CTAG::PARTITION
ID=1,ENABLESWITCH=ENABLE,INTERFACETYPE=ATM,VPI=1,VCI=32;
The result is as follows:
7340049 2012-05-04 10:55:05
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
There is no related command.

11.2.34 Modifying System Attributes for NEs (CFG-


DEVSYSPARA)
Usage Note
Currently, the MAC duplicate function of NEs can be modified.

Command Format
CFG-DEVSYSPARA::(DID=Device-ID|DEV=Device-name):CTAG::(MACDUPLICATE=mac-duplicate);

Supporting Device
Device Type No. Device Type

249 MA5600T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 200


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Device Type No. Device Type

95 MA5603T

2331 MA5608T

34 MA5680T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the N/A


3439 device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 201


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

MACDUPLICA OCTET ENABLE Indicates the N/A


TE STRING DISABLE MAC
duplicate
function.
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
ACDUPLICAT
E to DISABLE
can prevent
the MAC
addresses of

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 202


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

Parameter Type Range Description Default

authorized
users or
upper-layer
devices from
being
duplicated by
malicious
users.

Response Format
This response format complies with that of the operation command provided in
9.3 Response Format Description.

Output Parameter
None.

Error Code
ID Description Solution

2686058531 The device does not Verify that the entered


exist. parameters for locating
the device are correct.

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
the parameter value is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● 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:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 203


iMaster NCE 11 Controlling a Session and Performing Operations
Northbound TL1 Interface User Guide on a Device

CFG-DEVSYSPARA::DEV=10.144.252.32:CTAG::MACDUPLICATE=ENABLE;
The result is as follows:
7340038 2014-07-20 17:07:05
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
;

Related Command
There is no related command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 204


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

12 Performance Management

12.1 Creating a Performance Measurement Task (CRE-PMTSK)

12.1 Creating a Performance Measurement Task (CRE-


PMTSK)
Usage Note
● Measurement objects, such as devices and boards, have been configured.
● Before running this command, change TL1_ENABLED = 0 in the
U2000\server\common\pms\conf\pms.cfg configuration file to
TL1_ENABLED = 1 and log in to the System Monitor client to restart the
PMSDm process.

Command Format
CRE-PMTSK::(DID=Device-ID|DEV=Device-name):CTAG::TASKNAME=task-name,MUID=mu-id,MOLIST=mo-
list,REPTINVL=period[,STARTDATE=start-date][,ENDDATE=end-date][,COLLINTVL=period];

Supporting Device

Table 12-1 Supporting Device

Device Type No. Device Type

34 MA5680T

57 MA5606T

249 MA5600T

61 MA5626E

62 MA5620E

64 MA5651

65 MA5620G

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 205


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Device Type No. Device Type

66 MA5626G

70 MA5610

92 MA5652G

95 MA5603T

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2312 MA5628

2320 MA5612A

2321 MA5669

2331 MA5608T

2346 MA5800

2390 / 2391 / 2389 MA5800C-X6 / MA5800C-X14 /


MA5800C-X16

Input Parameter

Table 12-2 Input Parameter


Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


OLT device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 206


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING default OLT
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
How to
Locate a
Device
According to
the IP
Address.

TASKNAME OCTET SIZE (1-300) Indicates the N/A


STRING name of a
performance
measurement
task.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 207


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

MUID INTEGER 1-429496729 Indicates the N/A


6 ID of a data
monitoring
template.
Options are
as follows:
● 90016:
CPU
occupancy
● 90017:
memory
occupancy
● 90018:
Ethernet
port
performan
ce
collection
● 90019:
Ethernet
port traffic
performan
ce
collection
template
● 90020:
Ethernet
port
packet
statistics
template
● 90021:
VLAN
network
flow
collection
template
● 90022:
VLAN
service
flow
collection
template
● 90023:
EPON UNI
port up
and down

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 208


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

stream
rate
● 90024:
EPON port
Ethernet
statistic
template
● 90025:
EPON ONT
Ethernet
statistics
template
● 90026:
EPON UNI
port
optical
module
statistics
template
● 90027:
EPON ONT
optical
module
performan
ce
● 90028:
EPON UNI
port
optical
module
statistics
template
(profile
mode)
● 90029:
GPON
ONT
optical
module
statistics
template
(profile
mode)
● 90030:
GPON UNI
port
Ethernet
statistics

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 209


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

template
(profile
mode)
● 90031:
GPON UNI
Ethernet
port
statistics
template
(profile
mode)
● 90032:
GPON
ONU TDM
E1 port
error
statistics
template
● 90033:
GPON UNI
port
optical
module
statistics
template
● 90034:
GPON
ONT
optical
module
statistics
template
● 90035:
GPON UNI
port
Ethernet
statistics
template
● 90036:
GPON
ONT
Ethernet
port
statistics
template
● 90037:
EPON OLT
LLID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 210


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

statistics
template
● 90038:
EPON ONT
up and
down
stream
rate
● 90039: SIP
performan
ce
template
● 90060:
ADSL KPI
● 90061:
VDSL KPI

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 211


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

MOLIST OCTET SIZE (1-255) Indicates the N/A


STRING measurement
object. One or
more
measurement
objects can be
entered at a
time. Multiple
measurement
objects must
be separated
by ampersand
(&).
Measurement
objects are
entered in the
following
formats:
● For boards:
CARD-
Frame-
Slot, for
example,
CARD-0-10
.
● For
Ethernet
ports: ETH-
shelf-slot-
port, for
example,
ETH-0-1-0.
● For ADSL
ports:
ADSL-
shelf-slot-
port, for
example,
ADSL-0-1-
0.
● For VDSL
ports:
VDSL-
shelf-slot-
port, for
example,
VDSL-0-1-
0.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 212


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

● For VLANs:
VLAN-
vlanid, for
example,
VLAN-1.
● For
STACKING
VLANs:
STACKING
VLAN-
vlanid-
vlanid, for
example,
TACKINGV
LAN-1-2.
The two
VLAN IDs
include
one inner
VLAN ID
and one
outer
VLAN ID.
● For PON
ports:
PON-shelf-
slot-port,
for
example,
PON-0-1-2
.
● For ONT
ports:
ONTPORT-
shelf-slot-
port-
OntID-UNI
ID, for
example,
ONTPORT-
0-1-1-2.
● For ONTs:
PON-shelf-
slot-port-
ONTID, for
example,
PON-0-1-2
-3.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 213


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Parameter Type Range Description Default

● For media
gateways
(MGs):
MG-MG
ID, for
example,
MG-1.
● For IGMP:
IGMP-
IGMP ID,
for
example,
IGMP-1.

REPTINVL OCTET ● 5 MIN Indicates the N/A


STRING ● 10 MIN collection
granularity.
● 15 MIN
● 30 MIN
● 60 MIN
● 1440 MIN
● 10080 MIN

STARTDATE OCTET YY-MM-DD- Indicates the N/A


STRING HH-MM-SS collection
start time.

ENDDATE OCTET YY-MM-DD- Indicates the N/A


STRING HH-MM-SS collection end
time.

COLLINTVL OCTET ● 5 MIN Indicates the N/A


STRING ● 10 MIN polling
interval. The
● 15 MIN value of this
● 30 MIN parameter
● 60 MIN must be the
same as that
● 1440 MIN of REPTINVL.
● 10080 MIN

The device ID or the device name must be set.

Response Format
This response format complies with that of the operation command provided in
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 214


iMaster NCE
Northbound TL1 Interface User Guide 12 Performance Management

Output Parameter
Paramet Type Range Description
er

TaskID INTEGER 1000001-429 Indicates the ID of a performance


4967296 measurement task, which is generated
automatically by the U2000.

Error Code
ID Description Solution

2686058531 The device Ensure that the device is successfully added to


does not the U2000. If the device is located by device
exist. name, enter the device name as the value of the
DEV parameter. If the device is not located by
device name, enter the IP address of the device.

2686058498 Missing, Ensure that the command is correct according


invalid to the following requirements:
parameter ● The parameter value does not exceed the
or
mandatory parameter range specified by the command.
parameter is ● Entered parameter names are correct.
blank, or
the value of ● Parameters are entered in the correct order.
the
parameter is
wrong.

Example
To create a CPU usage measurement task for board 0/9 on the device named
10.71.62.138 by using the data monitoring template (ID: 90016), run the
following command:

CRE-
PMTSK::DEV=10.71.62.138:100::TASKNAME=cputaskname,MUID=90016,MOLIS
T=CARD-0-9,REPTINVL=5MIN,COLLINTVL=5MIN;

The result is as follows:


7340035 2010-10-28 15:24:55
M COMPLD
EN=0 ENDESC=Succeeded.
; TaskID: 1000062

Related Command
There is no related command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 215


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

13 Notification of Resource Changes

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 (REG-


RESCHGNOTIFY)

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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 216


iMaster NCE
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 9.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:
0 2005-06-09 16:07:19
M 1 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

13.1.2 Canceling the Notification of Resource Changes (UREG-


RESCHGNOTIFY)
Usage Note
None.

Command Format
UREG-RESCHGNOTIFY:::CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 217


iMaster NCE
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
None.

Response Format
It complies with the response format of the operation command provided in 9.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:
0 2005-06-09 16:07:19
M 2 COMPLD
EN=0 ENDESC=Succeeded.

Related Command
None.

13.1.3 Querying the Notification of Resource Changes (LST-


BMSRESCHANOTIFY)
Usage Note
None.

Command Format
LST-BMSRESCHANOTIFY:::CTAG::STARTAID=initial AID[,ENDAID=last AID];

Supporting Device
This command has nothing to do with the type of device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 218


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Input Parameter
Parameter Type Range Description Default

STARTAID INTEGER 0-214748364 Indicates the -


7 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-214748364 (Optional) -


7 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 9.3
Response Format Description.
title="Changed resource notice whose ID from" + STARTAID + " to " + ENDAID
name of attributes: AID mark DID DEV FN SN

Output Parameter
Description Type Range Description

AID INTEGER 0-2147483647 Indicates the


sequence number
of the notification
of resource
changes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 219


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Description Type Range Description

mark OCTET STRING ● DEVAFFIRM Indicates the


● FRAMEAFFIRM resource change.
The meanings of
● SLOTAFFIRM the options are as
● DEVDEL follows:
● FRAMEDEL ● DEVAFFIRM: A
● SLOTDEL device is
confirmed.
● FRAMEAFFIRM:
A shelf is
confirmed.
● SLOTAFFIRM: A
slot is
confirmed.
● DEVDEL: A
device is
deleted.
● FRAMEDEL: A
shelf is deleted.
● SLOTDEL: A
slot is deleted.

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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 220


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Error Code
ID Description Solution

2686058 The resource does not exist. Ensure that the ID of the
552 notification of resource changes
exists in the database.
Run the LST-
BMSRESCHANOTIFY:::
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:
0 2005-06-09 16:30:53
M 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 5
2 SLOTDEL 7344129 10.71.56.151 0 6
3 SLOTDEL 7344129 10.71.56.151 0 1
4 DEVAFFIRM 7344129 10.71.56.151 -- --
5 SLOTAFFIRM 7344129 10.71.56.151 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 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 221


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

13.2.1 Notifying Device Confirmation


Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY command.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<DEVAFFIRM>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-
count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
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_MSGNOT
IFY_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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 222


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

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
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 -- --
---------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.2 Notifying Device Deletion

Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY command.

Command Format
None. After an OLT is deleted, the NCE reports a change notification to the OSS.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 223


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

94 MA5603U

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.

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_MSGNOT
IFY_DEVMEAN is
1, the DEV
parameter
indicates the IP
address of the
device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 224


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

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
None.

13.2.3 Notifying Device Synchronization


Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY 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 9.4 Format Description of the
Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<DEVAFFIRM>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 225


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
title="Information of data synchronization."
name of attributes: DID DEV SRV RESULT REASON

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_MSGNOT
IFY_DEVMEAN is
1, the DEV
parameter
indicates the IP
address of the
device.

SRV OCTET STRING SIZE (128) Indicates the


synchronized
service module.

RESULT OCTET STRING SIZE (128) Indicates the


synchronization
results.

REASON OCTET STRING SIZE (128) Indicates the


reason of the
synchronization
failure. If the
synchronization
succeeds, this
parameter is
displayed as "--".

Error Code
None.

Example
After running the REG-RESCHGNOTIFY:::1::; command to enable the NBI alarming
function, change value of the SYNC_COMPLETED_NOTIFY_OSS configuration

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 226


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

item to 1. After the NE named 10.144.194.164 is synchronized successfully, the


OSS receives resource change notifications.
4294967295 2013-05-28 17:20:17
A 27 SYNCRESULT
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=10
blktotal=10

Information of data synchronization.


----------------------------------
DID DEV SRV RESULT REASON
7340032 10.144.194.164 ADSL Synchronization succeeded. --
7340032 10.144.194.164 EPON Synchronization succeeded. --
7340032 10.144.194.164 ETH Synchronization succeeded. --
7340032 10.144.194.164 GPON Synchronization succeeded. --
7340032 10.144.194.164 IGMP Synchronization succeeded. --
7340032 10.144.194.164 PHYRES Synchronization succeeded. --
7340032 10.144.194.164 PROTOCOL Synchronization succeeded. --
7340032 10.144.194.164 SERVICEPORT Synchronization succeeded. --
7340032 10.144.194.164 VDSL Synchronization succeeded. --
7340032 10.144.194.164 VOIP Synchronization succeeded. --
----------------------------------

Related Command
REG-RESCHGNOTIFY

13.2.4 Notifying Shelf Confirmation

Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY command.

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.
title="Information of added frame "
name of attributes: DID DEV FN SN

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 227


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

DEV OCTET STRING SIZE (192) Indicates the


device name by
default. When the
value of
configuration
item
BMSNB_MSGNOT
IFY_DEVMEAN 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. 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 shelf with ID 1 is added successfully.
7667714 2005-06-07 15:17:29
A 3937 FRAMEAFFIRM
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of added frame
---------------------
DID DEV FN SN
7667714 AMG_10.71.60.22 1 --
---------------------
;

Related Command
REG-RESCHGNOTIFY

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 228


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

13.2.5 Notifying the Shelf Deletion


Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY command.

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.
title="Information of deleted frame "
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_MSGNOT
IFY_DEVMEAN 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. It is invalid
and is set to - to
maintain the
unified format.

Error Code
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 229


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

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 shelf with ID 7667714 is deleted successfully.
7667714 2005-06-10 11:59:49
A 16 FRAMEDEL
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of deleted frame
---------------------
DID DEV FN SN
7667714 10.71.60.22 1 --
---------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.6 Notifying Slot Confirmation


Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY command.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<SLOTAFFIRM>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-
count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
title="Information of added slot "
name of attributes: DID DEV FN SN

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 230


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

DEV OCTET STRING SIZE (192) Indicates the


device name by
default. When the
value of
configuration
item
BMSNB_MSGNOT
IFY_DEVMEAN 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 slot 11 of shelf 0 is added successfully.
7712779 2005-05-23 13:10:51
A 1539 SLOTAFFIRM
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of added slot
---------------------
DID DEV FN SN
7712779 MA5600V3_10.71.60.53 0 11
---------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.7 Notifying the Slot Deletion


Usage Note
The resource change notification must have been registered for the current user
through the REG-RESCHGNOTIFY command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 231


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.
title="Information of deleted slot "
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_MSGNOT
IFY_DEVMEAN 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 slot 1 in shelf 0 is deleted successfully.
7344129 2005-06-09 16:29:41
A 7 SLOTDEL
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 232


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

blktotal=1
Information of deleted slot
---------------------
DID DEV FN SN
7344129 10.71.56.151 0 1
---------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.8 Reporting Notifications of OLT Attribute Changes


Usage Note
The notification of resource changes must have been registered for the current
user through the REG-RESCHGNOTIFY command.

Command Format
There is no command format. The NCE automatically reports a notification to the
OSS after the name, alias or remark of an OLT is changed.

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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
There is no input parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 233


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Response Format
This response format complies with that provided in 9.4 Format Description of
the Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<OLTMODNOTIFY>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-
count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
title="Information of modified device"
name of attributes: DID NAME ALIAS DLOC REMARK

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the OLT


ID.

NAME OCTET STRING SIZE (128) Indicates the OLT


name.

ALIAS OCTET STRING SIZE (192) Indicates the OLT


alias.

DLOC OCTET STRING SIZE (100) Indicates the OLT


location.

REMARK OCTET STRING SIZE (255) Indicates the OLT


remark.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), and the alias of the OLT (ID: 7340034) is changed, the
OSS system receives a corresponding resource change notification as follows:
Command:
There is no command.
The result is as follows:
7340034 2011-02-16 16:27:03
A 1 OLTMODNOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 234


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Information of modified device


-----------------------------------------------
DID NAME ALIAS DLOC REMARK
7340034 -- 123_ -- --
-----------------------------------------------

Related Command
REG-RESCHGNOTIFY

13.2.9 Reporting Notifications of MDU Attribute Changes


Usage Note
The notification of resource changes must have been registered for the current
user through the REG-RESCHGNOTIFY command.

Command Format
There is no command format. The NCE automatically reports a notification to the
OSS after the name, alias, location or remark of an MDU is changed.

Supporting Device
Device Type No. Device Type

37 MA5662

61 MA5626E

62 MA5620E

64 MA5651

65 MA5620G

66 MA5626G

70 MA5610

92 MA5652G

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2312 MA5628

2321 MA5669

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 235


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

2320 MA5612A

Input Parameter
There is no input parameter.

Response Format
This response format complies with that provided in 9.4 Format Description of
the Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<MXUMODNOTIFY>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-
count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
title="Information of modifyed device"
name of attributes: DID NAME ALIAS DLOC REMARK

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


MDU ID.

NAME OCTET STRING SIZE (128) Indicates the


MDU name.

ALIAS OCTET STRING SIZE (192) Indicates the


MDU alias.

DLOC OCTET STRING SIZE (100) Indicates the


MDU location.

REMARK OCTET STRING SIZE (255) Indicates the


MDU remark.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), and the attributes of the MDU (ID: 7340038) are
changed, the OSS system receives a resource change notification.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 236


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Command:
None.
The result is as follows:
7340038 2011-02-18 14:35:05
A 1 MXUMODNOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of modified device
-------------------------------------------
DID NAME ALIAS DLOC REMARK
7340038 -- 123_ -- --
-------------------------------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.10 Reporting Notifications of ONU Addition


Usage Note
● The OLT has discovered xPON boards and xPON ports.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
There is no command format.
FTTH ONU ports report notifications of ONU addition automatically. Therefore,
you do not need to run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 237


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
There is no input parameter.

Response Format
This response format complies with that provided in 9.4 Format Description of
the Resource Change Notification.

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_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 238


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), and ONU 13 connected to port 0/3/0 on the device
named 10.144.79.135 is added, the system receives a resource change notification.
Command:
There is no command.
The result is as follows:
7340134 2010-11-24 15:32:54
A 1 ONUADDNOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of added onu
---------------------------------------------
DID DEV FN SN PN ONTID
7340134 10.144.79.135 0 3 0 13
---------------------------------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.11 Reporting Notifications of ONU Deletion


Usage Note
● The OLT must be online.
● The OLT must already discover xPON boards and xPON ports.
● The ONT information must have been added to the OLT correctly.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 239


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Command Format
There is no command format.
FTTH ONU ports report notifications of ONU deletion automatically. Therefore,
you do not need to run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
There is no input parameter.

Response Format
This response format complies with that provided in 9.4 Format Description of
the Resource Change Notification.

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 240


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

DEV OCTET STRING SIZE (192) Indicates the


device name by
default. When the
value of
configuration
item
BMSNB_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), and ONU 13 connected to port 0/3/0 on the device
named 10.144.79.135 is deleted, the system receives a resource change
notification.
Command:
There is no command.
The result is as follows:
7340134 2010-11-24 15:33:32
A 1 ONUDELNOTIFY

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 241


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of deleted onu


--------------------------------
DID DEV FN SN PN ONTID
7340134 10.144.79.135 0 3 0 13
--------------------------------
;

Related Command
REG-RESCHGNOTIFY

13.2.12 Reporting Notifications of Board Attribute Changes


Usage Note
The notification of resource changes must have been registered for the current
user through the REG-RESCHGNOTIFY command.

Command Format
There is no command format. The NCE automatically reports a notification to the
OSS after the alias of a board is changed.

Supporting Device
Device Type No. Device Type

44 MA5600 V300

219 UA5000 (PVM)

253 UA5000(IPMB)

249 MA5600T

95 MA5603T

34 MA5680T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 242


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Input Parameter
There is no input parameter.

Response Format
This response format complies with that provided in 9.4 Format Description of
the Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<BOARDMODNOTIFY>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-
count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
title="Information of modified board"
name of attributes: DID FN SN ALIAS

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

ALIAS OCTET STRING SIZE (32) Indicates the new


alias of the board.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), and the alias of the board on the device (ID: 7340034)
is changed to lwy123112323, the OSS system receives a resource change
notification.
Command:
There is no command.
The result is as follows:
4294967295 2011-02-16 16:47:04
A 1 BOARDMODNOTIFY
EN=0 ENDESC=Succeeded.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 243


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

blktag=1
blkcount=1
blktotal=1

Information of the modified board.


-----------------------
DID FN SN ALIAS
7340034 0 9 lwy123112323
-----------------------

Related Command
REG-RESCHGNOTIFY

13.2.13 Notifying Plug and Play Deployment Completion

Usage Note
The resource change notification is registered for the current user by running the
REG-RESCHGNOTIFY command.

Command Format
None. When a certain ONU is deployed by using the plug and play (PnP) policy,
the NCE reports a PnP deployment completion notification to the OSS.

Supporting Device
All MDUs and ONTs.

Input Parameter
None

Response Format
It complies with the command output format provided in 9.4 Format Description
of the Resource Change Notification.
<header>< auto id ><text block><terminator>
header::=<cr><lf><lf>^^^<DID>^<year>-<month>-<day>^<hour>:<minute>:<second>
<auto id>::=<cr><lf> A^^<atag>^<PONFREEONUDEPLOYED>
text block::=((<cr><lf>^^^<EN=error-code>) | (<cr><lf>^^^<quoted line>))
quotedline::=^^^<blktag=block-tag><cr><lf>^^^<blkcount=currentblock-count><cr><lf>^^^<blktotal=total-
count><cr><lf><result>
result::=<cr><lf><title><cr><lf>(<->*)<cr><lf>(<attribs>((<values>)*))(<->*)<cr><lf><cr><lf>
attribs::=<attrib>((^^<attrib>)*)<cr><lf>
values::=<value>((^^<value>)*)<cr><lf>
terminator::= <cr><lf>(;|>)
title="Information of the free onu deployed."
name of attributes: OLTNAME OLTIP OLTID FRAME SLOT PORT ONUID MXUDID ONUNAME ONUIP
ONUTYPE VENDORID VERSION AUTHINFO

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 244


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Output Parameter
Parameter Type Range Description

OLTNAME OCTET STRING SIZE (128) Indicates the


name of the OLT
to which the ONU
belongs.

OLTIP OCTET STRING SIZE (128) Indicates the IP


address of the
OLT to which the
ONU belongs.

OLTID INTEGER - Indicates the


device ID of the
OLT to which the
ONU belongs.

FRAME INTEGER 0-255 Indicates the


subrack ID of the
OLT to which the
ONU belongs.

SLOT INTEGER 0-35 Indicates the slot


ID of the OLT to
which the ONU
belongs.

PORT INTEGER 0-63 Indicates the port


ID of the OLT to
which the ONU
belongs.

ONUID INTEGER 0-255 Indicates the ONU


ID. Note: the GE
upstream port
does not have an
ONU ID, this
parameter is
displayed as -.

MXUDID INTEGER - Indicates the ID of


the MxU
corresponding to
the ONU. Note: If
the ONU is an
ONT, this
parameter is
displayed as -.

ONUNAME OCTET STRING SIZE (255) Indicates the


name of the ONU.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 245


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

ONUIP OCTET STRING SIZE (128) Indicates the IP


address of the
ONU.

ONUTYPE OCTET STRING SIZE (128) Indicates the type


of the ONU.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID of the
ONU.

VERSION OCTET STRING SIZE (128) Indicates the


version of the
ONU.

AUTHINFO OCTET STRING SIZE (128) Indicates the


authentication
information of the
ONU.

Error Code
None

Example
After the REG-RESCHGNOTIFY:::1::; command is run, the OSS receives a resource
change notification when a certain ONU is deployed by using the PnP policy.
● Command issued:
None
● Response message:
3145728 2014-08-08 14:05:39

3145728 2014-08-08 14:05:39


A 8 PONFREEONUDEPLOYED
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the free onu deployed.


----------------------------------------------------------------------------------------------------------
OLTNAME OLTIP OLTID FRAME SLOT PORT ONUID MXUDID ONUNAME ONUIP ONUTYPE
VENDORID VERSION AUTHINFO
10.144.252.40 10.144.252.40 3145728 0 12 0 -- -- 10.144.252.210 10.144.252.210 MA5633 --
MA5633V800R315C00B533 60-DE-44-7E-0A-C3
----------------------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 246


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Related Command
REG-RESCHGNOTIFY

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.3.1 Reporting Notifications on Initial Power-on of GPON


ONUs
Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the GPON board and the GPON port.
● The trap information must be configured correctly on the OLT, which ensures
that the NCE server can receive the traps and alarms reported by the OLT.
● The function of discovering an ONU automatically must be enabled on the
GPON port that receives the alarm, and the optical port must be open.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
None.
To report notifications on initial power-on of GPON ONUs, you do not need to to
run any command.

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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 247


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.

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_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 248


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number
(SN). This
parameter is valid
only when the
authorization
mode is set to SN.

PWD OCTET STRING SIZE (36) Indicates the


NOTE password. This
For the OLTs parameter is valid
earlier than only when the
V800R011C00, the authorization is in
maximum length
password mode.
of password for
ONTs connected to
the OLTs is 10
characters.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQID OCTET STRING SIZE (40) Indicates the ONU


ID.

MAINSOFTVER OCTET STRING SIZE (15) Indicates the


software version.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when an ONU is discovered automatically on port
0/12/1 on the device named 10.144.194.129, the system receives the resource
change notification.
Command:
None.
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 249


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

7340043 2013-11-06 13:54:09


A 1 PONONUFIRSTONLINE
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the onu first online.


----------------------------------------------------------------------
DID DEV FN SN PN ONTID SERIALNUM PWD VENDORID EQID MAINSOFTVER
7340043 10.144.194.129 0 12 1 5 48575443348B0909 -- HWTC 240 V1R006C00S122
----------------------------------------------------------------------

Related Command
REG-RESCHGNOTIFY

13.3.2 Notifying the Event That an FTTH GPON ONU Port Is


Online
Usage Note
● The OLT and the ONU must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the GPON board and the GPON port.
● The ONU information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.
● The trap information must be configured correctly on the OLT, which ensures
that the NCE server can receive the traps and alarms reported by the OLT.

Command Format
There is no command format.
The FTTH ONU port automatically reports that it is online. Therefore, you do not
need to run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

249 MA5600T

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 250


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
There is no input parameter.

Response Format
This response format complies with that provided in 9.4 Format Description of
the Resource Change Notification.

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_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 251


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPORTTYPE OCTET STRING ETH Indicates the type


of user port of the
ONU.

ONTPORTID INTEGER 1-64 Indicates the user


port ID of the
ONU. The number
of the user ports
is defined in the
ONT capability
profile.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when FE port 1 of ONU 1 connected to port 0/15/0 on
the device named 10.71.211.96 is replaced manually, the system receives the
resource change notification.
Command:
None.
The result is as follows:
7340047 2010-12-13 14:26:45
A 1 GPONFTTHONUPORTUPNOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the FTTH onu port up.


--------------------------------------------------------
DID DEV FN SN PN ONTID ONTPORTTYPE ONTPORTID
7340047 10.78.217.114 0 17 0 0 ETH 1
--------------------------------------------------------
;

Related Command
REG-RESCHGNOTIFY

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 252


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

13.3.3 Notifying the Automatic Discovery of a GPON ONU


Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the GPON board and the GPON port.
● The trap information must be configured correctly on the OLT, which ensures
that the NCE server can receive the traps and alarms reported by the OLT.
● The function of discovering an ONU automatically must be enabled on the
EPON port that receives the alarm, and the optical port must be open.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
None.
The notification of the automatic discovery of the ONU is reported automatically.
You need not run any command.

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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 253


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.

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_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

MAC OCTET STRING SIZE (17) Indicates the MAC


address of the
ONU that is
discovered
automatically.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 254


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number.
Format: 12-byte
character string
XXXXXXXXXXXX or
16-byte character
string
XXXXXXXXXXXXXX
XX. For details
about how to
modify the format
of the returned
SN, see A.13 How
to Modify the
Format of the
Returned SN.
This parameter is
valid only when
the authorization
mode is set to SN.

PWD OCTET STRING SIZE (36) Indicates the


NOTE password. This
For the OLTs parameter is valid
earlier than only when the
V800R011C00, the authorization is in
maximum length
password mode.
of password for
ONTs connected to
the OLTs is 10
characters.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQID OCTET STRING SIZE (40) Indicates the ONU


type.

MAINSOFTVER OCTET STRING SIZE (15) Indicates the


software version.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when an ONU is discovered automatically on port
0/12/1 on the device named 10.144.194.129, the system receives the resource
change notification.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 255


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Command:

None.

The result is as follows:


7340033 2009-03-06 13:53:36
A 1 GPONONUAUTOFINDNOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the onu autofind.


----------------------------------------------------------------------
DID DEV FN SN PN SERIALNUM PWD VENDORID EQID MAINSOFTVER
7340043 10.144.194.129 0 12 1 48575443348B0909 -- HWTC 240 V1R006C00S122
----------------------------------------------------------------------
;

Related Command
REG-RESCHGNOTIFY

13.3.4 Notifying GPON ONU Replacement

Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086
● The OLT must already discover the GPON board and the GPON port.
● The ONU information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● The notification (alarm) is generated when an MDU is replaced manually.
● The notification (alarm) is generated when the MAC address of an ONT is
changed.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
None.

The notification of ONU replacement is reported automatically. Therefore, you do


not need to run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 256


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Response Format
It complies with the format provided in 9.4 Format Description of the Resource
Change Notification.

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_MSGNOT
IFY_DEVMEAN is
1, the DEV
parameter
indicates the IP
address of the
device.

FN INTEGER 0-255 Indicates the


subrack ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 257


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

EQID OCTET STRING SIZE (40) Indicates the ONU


type.

OLDSN OCTET STRING SIZE (17) Indicates the SN


of the ONU
before the ONU is
replaced.
Indicates the
serial number.
Format: 12-byte
character string
XXXXXXXXXXXX or
16-byte character
string
XXXXXXXXXXXXXX
XX. For details
about how to
modify the format
of the returned
SN, see A.13 How
to Modify the
Format of the
Returned SN.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 258


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

NEWSN OCTET STRING SIZE (17) Indicates the SN


of the ONU after
the ONU is
replaced.
Indicates the
serial number.
Format: 12-byte
character string
XXXXXXXXXXXX or
16-byte character
string
XXXXXXXXXXXXXX
XX. For details
about how to
modify the format
of the returned
SN, see A.13 How
to Modify the
Format of the
Returned SN.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when ONU 0 connected to port 0/15/0 on the device
named 10.71.211.96 is replaced manually, the system receives the resource
change notification.
Command:
None.
The result is as follows:
7340119 2009-03-06 11:53:30
A 1 ONUAUTOREPLACENOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of the onu auto replace.
---------------------------
DID DEV FN SN PN ONTID EQID OLDSN NEWSN
7340119 10.71.211.96 0 15 0 0 5620 3454545656 676878798989
---------------------------
;

Related Command
REG-RESCHGNOTIFY

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 259


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

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.4.1 Reporting Notifications on Initial Power-on of EPON


ONUs

Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the EPON board and the EPON port.
● The trap information must be configured correctly on the OLT, which ensures
that the NCE server can receive the traps and alarms reported by the OLT.
● The function of discovering an ONU automatically must be enabled on the
EPON port that receives the alarm, and the optical port must be open.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
None.

To report notifications on initial power-on of EPON ONUs, you do not need to to


run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

249 MA5600T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 260


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Input Parameter
None.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.

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_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

MAC OCTET STRING SIZE (17) Indicates the MAC


address of the
ONU that is
discovered
automatically.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 261


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

ONTKEY OCTET STRING SIZE (32) Indicates the


authentication
password of the
ONU.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQID OCTET STRING SIZE (40) Indicates the ONU


ID.

MAINSOFTVER OCTET STRING SIZE (15) Indicates the


software version.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when an ONU is discovered automatically on port
0/12/1 on the device named 10.144.194.129, the system receives the resource
change notification.
Command:
None.
The result is as follows:
7340043 2013-11-06 13:54:09
A 1 PONONUFIRSTONLINE
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the onu first online.


----------------------------------------------------------------------
DID DEV FN SN PN ONTID MAC ONTKEY VENDORID EQID MAINSOFTVER
7340043 10.144.194.129 0 12 1 5 00-1E-E3-22-A9-93 000000000000 HWTC 240 V1R006C00S122
----------------------------------------------------------------------

Related Command
REG-RESCHGNOTIFY

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 262


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

13.4.2 Notifying the Event That an FTTH ONU Port Is Online

Usage Note
● The OLT and the ONT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the EPON board and the EPON port.
● The ONT information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.
● The trap information must be configured correctly on the OLT, which ensures
that the NCE server can receive the traps and alarms reported by the OLT.

Command Format
None.

The FTTH ONU port automatically reports that it is online. Therefore, you do not
need to run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

2331 MA5608T

249 MA5600T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 263


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

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_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

ONTPORTTYPE OCTET STRING ETH Indicates the type


of user port of the
ONT.

ONTPORTID INTEGER 1-64 Indicates the ID of


the user port of
the ONT. The
range of the user
ports is restricted
by the capability
set profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 264


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when FE port 1 of ONT 1 connected to port 0/15/0 on
the device named 10.71.211.96 is replaced manually, the system receives the
resource change notification.

Command:

None.

The result is as follows:


7340033 2009-03-06 13:54:09
A 1 FTTHONUPORTUPNOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the FTTH onu port up.


--------------------------------------------------------
DID DEV FN SN PN ONTID ONTPORTTYPE ONTPORTID
7340033 10.71.211.96 0 15 0 1 FE 1
--------------------------------------------------------
;

Related Command
REG-RESCHGNOTIFY

13.4.3 Notifying the Automatic Discovery of an EPON ONU

Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the EPON board and the EPON port.
● The trap information must be configured correctly on the OLT, which ensures
that the NCE server can receive the traps and alarms reported by the OLT.
● The function of discovering an ONU automatically must be enabled on the
EPON port that receives the alarm, and the optical port must be open.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
None.

The notification of the automatic discovery of the ONU is reported automatically.


You need not run any command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 265


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

249 MA5600T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Response Format
It complies with the response format provided in 9.4 Format Description of the
Resource Change Notification.

Output Parameter
Parameter Type Range Description

DEVID INTEGER - Indicates the


device ID.

DEV OCTET STRING SIZE (192) Indicates the


device name by
default. When the
value of
configuration
item
BMSNB_MSGNOT
IFY_DEVMEAN is
1, the DEV
parameter
indicates the IP
address of the
device.

FN INTEGER 0-255 Indicates the


subrack ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 266


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

MAC OCTET STRING SIZE (17) Indicates the MAC


address of the
ONU that is
discovered
automatically.

ONTKEY OCTET STRING SIZE (32) Indicates the


authentication
password of the
ONU.
NOTE
To ensure system
security, password
must be complex
enough.
Remember to
change passwords
regularly.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONU


type.

MAINSOFTVERSI OCTET STRING SIZE (15) Indicates the


ON software version.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when an ONU is discovered automatically on port
0/15/0 on the device named 10.71.211.96, the system receives the resource
change notification.
Command:
None.
The result is as follows:
7340033 2009-03-06 13:53:36
A 1 ONUAUTOFINDNOTIFY
EN=0 ENDESC=Succeeded.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 267


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

blktag=1
blkcount=1
blktotal=1

Information of the onu autofind.


--------------------------------------------------------------------------------
DEVID DEV FN SN PN MAC ONTKEY VENDORID EQUIPMENTID MAINSOFTVERSION
7340033 10.71.211.96 0 15 0 00-1E-E3-22-A9-93 000000000000 2011 850e
V100R001C03B055
--------------------------------------------------------------------------------
;

Related Command
REG-RESCHGNOTIFY

13.4.4 9.4-Format Description of the Resource Change


NotificationNotifying EPON ONU Replacement
Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086
● The OLT must already discover the EPON board and the EPON port.
● The ONU information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● The notification (alarm) is generated when an MDU is replaced manually.
● The notification (alarm) is generated when the MAC address of an ONT is
changed.
● The notification of resource changes must have been registered for the
current user through the REG-RESCHGNOTIFY command.

Command Format
None.
The notification of ONU replacement is reported automatically. Therefore, you do
not need to run any command.

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

249 MA5600T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 268


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Device Type No. Device Type

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
None.

Response Format
It complies with the format provided in 9.4 Format Description of the Resource
Change Notification.

Output Parameter
Parameter Type Range Description

DEVID INTEGER - Indicates the


device ID.

DEV OCTET STRING SIZE (192) Indicates the


device name by
default. When the
value of
configuration
item
BMSNB_MSGNOT
IFY_DEVMEAN 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.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 269


iMaster NCE
Northbound TL1 Interface User Guide 13 Notification of Resource Changes

Parameter Type Range Description

EQID OCTET STRING SIZE (40) Indicates the ONT


type.

OLDMAC OCTET STRING SIZE (17) Indicates the MAC


address of the
ONU before the
ONU is replaced.

NEWMAC OCTET STRING SIZE (17) Indicates the MAC


address of the
ONU after the
ONU is replaced.

Error Code
None.

Example
If the reporting of TL1 NBI alarms is enabled (that is, the REG-RESCHGNOTIFY:::
1::; command is executed), when ONU 0 connected to port 0/15/0 on the device
named 10.71.211.96 is replaced manually, the system receives the resource
change notification.
Command:
None.
The result is as follows:
7340119 2009-03-06 11:53:30
A 1 ONUAUTOREPLACENOTIFY
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the onu auto replace.


---------------------------
DEVID DEV FN SN PN ONTID EQID OLDMAC NEWMAC
7340119 10.71.211.96 0 15 0 0 5620 00-18-82-5D-D2-29 00-18-82-5D-D2-28
---------------------------
;

Related Command
REG-RESCHGNOTIFY

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 270


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14 Inventory Management

This topic provides the commands and examples for querying resources, including
the devices, xDSL (ADSL, G.SHDSL, and VDSL2), videos, xPON (GPON and EPON),
VLANs, Ethernet, service virtual ports, PVCs, VoIP, and ACL&QoS.

● Before inventory resources are queried, the latest data on an NE has been synchronized to
the NCE.
● If there is no description for the time format, the time of related commands is in UTC format
by default.

14.1 Querying Device Resources


This topic provides the commands and examples for querying resources, including
the devices, shelves, boards, and ports.
14.2 Querying ADSL Resources
This topic provides the commands and examples for querying ADSL resources,
including the ADSL ports, profiles, alarms, and performance statistics.
14.3 Querying G.SHDSL Resources
This topic provides the commands and examples for querying G.SHDSL resources,
including the G.SHDSL ports, profiles, alarms, and performance statistics.
14.4 Querying VDSL2 Resources
This topic provides the commands and examples for querying VDSL2 resources,
including the VDSL2 ports, profiles, alarms, and performance statistics.
14.5 Querying G.fast Resources
This topic provides the commands and examples for querying G.fast resources,
including the G.fast ports, profiles, alarms, and performance statistics.
14.6 Querying a Bonding Group
This topic provides the commands and examples for querying the bonding group
on the device and the details of the bonding group.
14.7 Querying Video Resources
This topic provides the commands and examples for querying video resources,
including the information about NTV programs, the NTV users, and the NTV rights
profiles.
14.8 Querying GPON Resources

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 271


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

This command is used to query GPON resources, including the GPON ports, ONTs,
and GEM ports.
14.9 Querying EPON Resources
This topic provides the commands and examples for querying the EPON ONTs.
14.10 CNU Resource Query
This topic describes commands and examples for querying a CNU list or details
about a CNU.
14.11 Querying CM Resources
This command is used to query CM (cable modem) resources.
14.12 Querying VLAN Resources
This topic provides the commands and examples for querying VLAN resources,
including the VLAN information of devices, VLAN IDs of ports, and transmission
features of VLANs.
14.13 Querying Ethernet Resources
This topic provides the commands and examples for querying Ethernet resources,
including the information about Ethernet ports, Ethernet aggregation groups, SFP
information, and transmission feature statistics of Ethernet ports.
14.14 Querying Service Virtual Port Resources
This command is used to query the service virtual ports.
14.15 Querying PVC Resources
This topic provides the commands and examples for querying PVC resources,
include the PVC traffic profiles and the information about PVCs, VPIs, and PVPs.
14.16 Querying TDM E1 Resources
This topic describes the commands for querying local TDM E1 connections and
usage examples.
14.17 Querying Traffic Profile Resources
This topic provides the commands and examples for querying traffic profile
resources, including the ATM traffic profiles, IP traffic profiles, and MEF IP traffic
profiles.
14.18 Querying PSTN Resources
This topic provides the command and example for querying a V5 PSTN user.
14.19 Querying the ISDN Resources
This topic provides the commands and examples for querying V5 ISDN BRA users
and V5 ISDN PRA users.
14.20 Querying VoIP Resources
This topic provides the commands and examples for querying VoIP resources,
including the VoIP PSTN users, VoIP ISDN BRA users, VoIP ISDN PRA users, VAGs,
and VSGs.
14.21 Querying SPC Resources
This topic provides the commands and examples for querying SPC resources,
including the SPC list and details of an SPC.
14.22 Querying SPCM Resources
This topic provides the command and example for querying an SPCM user.
14.23 Querying ACL and QoS Resources

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 272


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

This topic provides the commands and examples for querying ACL and QoS
resources, including the ACL groups and subitems of extended ACL groups.
14.24 Querying HQoS Resources
This topic provides the command and the example for querying an HQoS user
group.

14.1 Querying Device Resources


This topic provides the commands and examples for querying resources, including
the devices, shelves, boards, and ports.

14.1.1 Querying a Subnet (LST-SUBNET)


Usage Note
This command is used to query information about all subnets or a specified
subnet on the NCE.

Command Format
LST-SUBNET::[NAMESEQUENCE=sequence of subnet name]:CTAG::;

Supporting Device
This command is used to perform operations on the NCE. Device type is not
specified.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 273


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

NAMESEQUE OCTET SIZE (1024) Indicates the -


NCE STRING sequence of
subnet
names.
Names of
subnets in
different
layers are
separated by
backslash (\),
for example,
\HW\F4.
● Queries
informatio
n about
the root
subnet and
its lower-
level
subnets if
this
parameter
is not
entered.
● Queries
informatio
n about a
specified
subnet and
its lower-
level
subnets if
this
parameter
is entered.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=Information of subnet
name of attributes: NAMESEQUENCE COMMENT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 274


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

NAMESEQUENCE OCTET STRING SIZE (1024) Indicates the


sequence of
subnet names.
Names of subnets
in different layers
are separated by
backslash (\), for
example, \HW\F4.

COMMENT OCTET STRING SIZE (255) Indicates the


remarks for the
subnet.

Error Code
None.

Example
Example 1: To query information about the root subnet and its lower-level
subnets, run the following command:
LST-SUBNET:::2::;
The result is as follows:
0 2005-12-11 19:57:58
M 2 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4

Information of subnet
--------------------------
NAMESEQUENCE COMMENT
\
\10.78.217.216
\HW
\A HELLOA
--------------------------

Example 2: To query information about the subnet named \HW\F3 and its lower-
level subnets, run the following command:
LST-SUBNET::NAMESEQUENCE=\HW\F3:2::;
The result is as follows:
0 2005-12-11 19:57:58
M 2 COMPLD
EN=0 ENDESC=Succeeded.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 275


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktag=1
blkcount=4
blktotal=4

Information of subnet
--------------------------
NAMESEQUENCE COMMENT
\HW\F3
\HW\F3\WLS HELLOzzw
\HW\F3\CYC HELLOCYC
--------------------------

Related Command
None.

14.1.2 Querying an NE Link (LST-NELINK)

Usage Note
This command is used to query information about an NE link on the NCE.

Command Format
LST-NELINK::[LINKID=link-id][,NAME=link-name]:CTAG::;

Supporting Device
This command is used to perform operations on the NCE. Device type is not
specified.

Input Parameter
Parameter Type Range Description Default

LINKID OCTET SIZE (32) Indicates the -


STRING ID of the link.

NAME OCTET SIZE (128) Indicates the -


STRING name of the
link.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=NE Link information
name of attributes: LINKID NAME ALIAS OWNER TYPE SOURCEDEV SOURCEFN SOURCESN SOURCEPN
SINKDEV SINKFN SINKSN SINKPN NETTYPE LEVEL SPEED COMMENT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 276


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

LINKID OCTET STRING SIZE (128) Indicates the ID of


the link.

NAME OCTET STRING SIZE (128) Indicates the


name of the link.

ALIAS OCTET STRING SIZE (64) Indicates the alias


of the link.

OWNER OCTET STRING SIZE (64) Indicates the


owner of the link.

TYPE OCTET STRING IPLINK Indicates the type


L2LINK of the link.
VIRTUALLINK ● IP link
● Layer 2 link
● Virtual link

SOURCEDEV OCTET STRING SIZE (128) Indicates the


name of the
source end.

SOURCEFN Integer 0-255 Indicates the


subrack ID at the
source end.

SOURCESN Integer 0-35 Indicates the slot


ID at the source
end.

SOURCEPN Integer 0-63 Indicates the port


ID at the source
end.

SINKDEV OCTET STRING SIZE (128) Indicates the


name of the sink
end.

SINKFN Integer 0-255 Indicates the


subrack ID of the
sink end.

SINKSN Integer 0-35 Indicates the slot


ID of the sink end.

SINKPN Integer 0-63 Indicates the port


ID of the sink end.

NETTYPE OCTET STRING IPV4 Indicates the


IPV6 network protocol
type.
DUALSTACK

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 277


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LEVEL Integer -1 to 20484 Indicates the link


level.
The options are as
follows:
● 100: 100 m
● 1000: 1000 m
● 4097: E1
● 6401: STM-1
● 6404: STM-4
● 6416: STM-16
● 6464: STM-64
● 6656: STM-256
● 10753: OC-1
● 10755: OC-3
● 10764: OC-12
● 10800: OC-48
● 10944: OC-192
● 11520: OC-768
● 12289: WDM
● 16387: FE
● 16388: GE
● 16389: 10GE
● 16401: ADSL
● 16402:
G.SHDSL
● 20481: ATM
STM-1
● 20482: ATM
STM-2
● 20483: ATM
STM-3
● 20484: ATM
STM-4
● -1: --

SPEED OCTET STRING SIZE (128) Indicates the link


rate.

COMMENT OCTET STRING SIZE (64) Indicates the


remarks.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 278


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
None.

Example
To query information of the link1-name link, run the following command:

LST-NELINK::NAME=link1-name:CTAG::;

The result is as follows:


0 2014-05-20 10:47:22
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

NE Link information
------------------------------------------------------------------------------------------------------------------------------
-----------------
LINKID NAME ALIAS OWNER TYPE SOURCEDEV SOURCEFN SOURCESN SOURCEPN
SINKDEV SINKFN SINKSN SINKPN NETTYPE LEVEL SPEED COMMENT
VLINK=0:3:1400553977:3145730:-1:-1:3145770:-1:-1 link1-name -- VIRTUALLINK 10.144.194.40
-1 -1 -1 10.144.252.40 -1 -1 -1 UNKNOWN -- -- --
------------------------------------------------------------------------------------------------------------------------------
-----------------

Related Command
None.

14.1.3 Querying the Information About a Device (LST-DEV)

Usage Note
The DEV (IP address of an optical line terminal) and ONULOCATEINFO
parameters can be used as the location information. Before using these two
parameters as location information, make sure that the DEV parameter indicates
the device IP address. For details, see A.8 How to Locate a Device According to
the IP Address.

Command Format
LST-DEV::[(DID=Device-ID)|(DEV=Device-name)|(DEVIP=device-IP)|(DT=device-type)|(DEVVER=device-ver)|
(DEV=device-olt-ipaddress, ONULOCATEINFO=onu-locate-information)]:CTAG::[SHOWOPTION=option of
result's attributes][,USERID=user id];

Supporting Device
Device Type No. Device Type

219 UA5000(PVMV1)

37 MA5662

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 279


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

44 MA5600V3

253 UA5000(IPMB)

34 MA5680T

57 MA5606T

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

2319 MA5621
NOTE
The MA5621 V800R309C00 and later versions support
this command.

2312 MA5628

2313 MA5652
NOTE
The MA5652 V800R309C00 and later versions support
this command.

2317 MA5631
NOTE
The MA5631 V800R308C02 and later versions support
this command.

2320 MA5612A

2321 MA5669

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 280


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later versions support
this command.

2323 MA5622A V800R311C00 and later versions

2324 MA5623 V800R311C00 and later versions

2326 MA5623A V800R311C01 and later versions

2318 MA5632
NOTE
The MA5632 V800R310 and later versions support this
command.

2331 MA5608T

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

2348 MA5683T

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/MA5800-
X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/MA5801-FL16/
MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2

2368 EDFA3220-D2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 281


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description De
fau
lt

DID INTEGER - Indicates the device ID. -

DEV OCTET SIZE (192) Indicates the device name -


STRING 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 A.8 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-
olt-ipaddress,
ONULOCATEINFO=onu-
locate-information, the
DEV parameter indicates
the IP address of the
optical line terminal (OLT).

ONULOCAT OCTET SIZE (128) Indicates the ONU location -


EINFO STRING 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
ONU 0 that is connected to
port 0/2/0.

DEVIP IPADDRESS - Indicates the IP address of -


the device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 282


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description De


fau
lt

DT INTEGER See Indicates the device type. -


Supporting
Device.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

DEVVER OCTET SIZE (252) Indicates the device -


STRING version.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 283


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description De


fau
lt

SHOWOPTI OCTET ● DLOC Specifies the optional -


ON STRING ● AdminStat attributes that can be
displayed.
● WorkMode
● If you do not set this
● ADDITION parameter, the optional
ALINFO attributes are not
● CRTID displayed.
● CRTADDR ● If you set this
● CRTTEL parameter, the optional
attributes are displayed.
● CRTDATE
● REMARK
● TYPE
● NERATELIS
T
● NEPROV
● TOPXY
● EMSID
● ALIAS
● PCBVER
● MAINTAINI
D
● MAINTAIN
ADDR
● MAINTAIN
TEL
● REGISTERS
TAT
● POLLSTAT
US
● ESN

USERID INTEGER - Indicates the user ID. If you -


set this parameter, the
devices managed by only
this user are displayed,
thereby implementing
rights- and domain-based
management.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 284


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The DID, DEV, DEVIP, DT, and DEVVER parameters are optional and can be used as query
criteria. If you do not enter the value of any parameter, all the devices are displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=Information of Device
name of attributes: DID DEV DEVIP DT DVER DSTAT
DLOC AdminStat WorkMode ADDITIONALINFO CRTID CRTADDR CRTTEL CRTDATE REMARK TYPE
NERATELIST NEPROV
TOPXY EMSID ALIAS PCBVER MAINTAINID MAINTAINADDR MAINTAINTEL REGISTERSTAT POLLSTATUS

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the device ID.

DEV OCTET STRING SIZE (192) Indicates the device


name.

DEVIP IPADDRESS - Indicates the IP address


of the device.

DT OCTET STRING See Supporting Indicates the device type.


Device. When you query
information about an
MA5683T, DT in the
response message is
related to the
TL1_SHOW_MA5683T_S
WITCH configuration
item setting. For details
about the meaning and
setting method of the
configuration item, see
Table 8-1.

DVER OCTET STRING SIZE (252) Indicates the device


version.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 285


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DSTAT OCTET STRING ● Connecting Indicates the status of


● Disconnecting the device.
● WarningFault
● MinorFault
● MajorFault
● CriticalFault
● Loop
● Test
● Unknown

DLOC OCTET STRING SIZE (252) (Optional) Indicates the


location of the device. By
default, this parameter is
not displayed. If you
enter
SHOWOPTION=DLOC in
the command, this
parameter is displayed.

AdminStat OCTET STRING ● UNKOWN Indicates the


● Plan management status of
the device.
● Install

WorkMode OCTET STRING ● CMSAN Indicates the working


● AMSAN mode of the device. Only
the UA5000 (IPMB)
supports this parameter.
The meanings of the
options are as follows:
● CMSAN: It is short for
copper multi-service
access node.
● AMSAN: It is short for
aggregator multi-
service access node.

ADDITION OCTET STRING SIZE (252) Indicates the location of


ALINFO the MDU.
The format of the value
is OLT device name/
subrack ID of the PON
port/slot ID of the PON
port/number of the PON
port/MDUID (ONTID),
such as
10.71.35.172/0/14/0/0.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 286


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CRTID OCTET STRING SIZE (255) Indicates the ID of an NE


creator.

CRTADDR OCTET STRING SIZE (255) Indicates the address of


an NE creator.

CRTTEL OCTET STRING SIZE (255) Indicates the telephone


number of an NE
creator.
The parameter value is a
character string in any
format that represents a
telephone number.

CRTDATE OCTET STRING SIZE (255) Indicates the time when


an NE is created.
● the value of
configuration item
BMS_LST_DEV_CRTD
ATE_SHOW_GMT is
set to 0. Format: year-
month-day
hour:minute:second.
For example,
2010-12-16 07:22:57.
● the value of
configuration item
BMS_LST_DEV_CRTD
ATE_SHOW_GMT is
set to 1. Format: year-
month-day
hour:minute:second
time zone. For
example, 2010-12-16
07:22:57 GMT.
For details about the
meaning and setting
method of the
configuration item, see
Table 8-1.

REMARK OCTET STRING SIZE (255) Indicates remarks.

TYPE OCTET STRING ● OLT Indicates the role of the


● ONU NE.
● OTHER Options are as follows:
● OLT: OLTs
● ONU: ONUs
● OTHER: Other devices

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 287


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NERATELIS OCTET STRING ● 155 M/620 M/ Indicates the upstream


T 1000 M/10000 M port rate supported by
● 1000 M/10000 M an NE.
Options are as follows:
● 155M, 620M, 1000M,
10000M: An OLT or
another device
supports the
upstream port rate of
155 Mbit/s, 620
Mbit/s, 1000 Mbit/s,
or 10000 Mbit/s.
● 1000 M, 10000 M: An
ONU supports the
upstream port rate of
1000 Mbit/s or 10000
Mbit/s at s.

NEPROV OCTET STRING HUAWEI Indicates the NE vendor


name.

TOPXY OCTET STRING SIZE (255) Indicates the relative


coordinate of an NE in
the Main Topology.
Format: (horizontal
coordinate, vertical
coordinate). For
example, (106, 225).

EMSID OCTET STRING HUAWEIEMS Indicates the ID of an


EMS.

ALIAS OCTET STRING SIZE (255) Indicates the NE alias.

PCBVER OCTET STRING SIZE (255) Indicates the hardware


version of an NE, that is,
the control board
version.

MAINTAINI OCTET STRING SIZE (255) Indicates the ID of an NE


D maintenance engineer.

MAINTAIN OCTET STRING SIZE (255) Indicates the address of


ADDR an NE maintenance
engineer.
The parameter value is
an email address. For
example:
w11<huawei.com.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 288


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAINTAIN OCTET STRING SIZE (255) Indicates the telephone


TEL number of an NE
maintenance engineer.
The parameter value is a
character string in any
format that represents a
telephone number.

REGISTERS OCTET STRING ● registered Indicates the registration


TAT ● unregistered status of an ONU.
Options are as follows:
● registered: The ONU
has been registered.
● unregistered: The
ONU has not been
registered.

POLLSTAT OCTET STRING ● Waiting Indicates the


US ● Synchronizing synchronization status of
device.
● Finished
● UNKNOWN

ESN OCTET STRING SIZE (255) The vendor-specific


serial number string for
the physical entity.

You may use personal information of users when querying the information about the devices.
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
ID Description Solution

2686058531 The device does not exist. Verify that the entered
parameters for locating the
device are correct.

Example
To query all the information about MA5600_10.71.62.26, run the following
command:
LST-DEV::DEV=MA5600_10.71.62.26:19::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 289


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The result is as follows:


0 2005-12-11 19:57:58
M 19 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Information of Device
---------------------------------------
DID DEV DEVIP DT DVER DSTAT
7712769 MA5600_10.71.62.26 10.71.62.26 MA5600V3 MA5600V300R001B01D086SP06
Connecting
---------------------------------------
;

14.1.4 Querying Device Global Configurations (LST-DEVCFG)


Usage Note
None.

Command Format
LST-DEVCFG::(DID=Device-ID|DEV=Device-name):CTAG::SHOWOPTION=option of result's attributes;

Supporting Device
Device Type No. Device Type

37 MA5662

34 MA5680T

57 MA5606T

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

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 290


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

103 MA5635

104 MA5612

2319 MA5621

2312 MA5628

2313 MA5652

2317 MA5631

2322 MA5621A

2320 MA5612A

2321 MA5669

2318 MA5632

2323 MA5622A

2324 MA5623

2326 MA5623A

2331 MA5608T

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

2348 MA5683T

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/
MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/MA5801-
FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 291


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Def
ault

DID INTEGER - Indicates the device N/A


ID.

DEV OCTET SIZE (192) Indicates the default N/A


STRING device name. If the
value of the
configuration item
DEVMEAN is 1, the
DEV parameter
indicates the IP
address of the device.

SHOWOPTIO OCTET ● MACAgingTi Specifies the optional N/A


N STRING me attributes that can be
● DHCPOptio displayed.
n82 ● If you do not set
● MaxLenDHC this parameter, the
PPacket optional attributes
are not displayed.
● DHCPSubOp
tion7 ● If you set this
parameter, the
● DHCPSubOp optional attributes
tion90 are displayed.
● IGMPPacket
Encap

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description
title="Configure information of the device" +device-name
name of attributes: DID MACAgingTime DHCPOption82 MaxLenDHCPPacket DHCPSubOption7
DHCPSubOption90 IGMPPacketEncap

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 292


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGE - Indicates the device ID.


R

MACAging INTEGE 0 Indicates the MAC address aging time. The


Time R 10-100000 value 0 indicates that MAC address aging
0 is disabled.
Unit: s

DHCPOptio OCTET ● ENABLE Indicates the DHCP Option82 function


n82 STRING ● DISABL status. DHCP Option82 is a security
E mechanism used to improve the DHCP
function.
● FORWA
RD
● REBUIL
D

MaxLenDH INTEGE 500-1500 Indicates the maximum length of DHCP


CPPacket R packets.
Unit: Byte

DHCPSubO OCTET ● ENABLE Indicates the DHCP Sub-option7 function


ption7 STRING ● DISABL status. DHCP Sub-option7 is a security
E mechanism used to improve the DHCP
function.

DHCPSubO OCTET ● ENABLE Indicates the DHCP Sub-option90 function


ption90 STRING ● DISABL status. DHCP Sub-option90 is a security
E mechanism used to improve the DHCP
function.

IGMPPacke OCTET ● ALL Indicates the IGMP packet encapsulation


tEncap STRING ● PPP format.
● IP Options are as follows:
● ALL: The IGMP packet encapsulation
format supports PPPoE, IPoA, and IPoE.
● PPP: The IGMP packet encapsulation
format supports PPPoE.
● IP: The IGMP packet encapsulation
format supports IPoA and IPoE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 293


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058531 The device does not Verify that the entered


exist. parameters for locating
the device are correct.

Example
To query global configurations on device 10.144.194.40, run the following
command:
LST-DEVCFG::DEV=10.144.194.40:CTAG::SHOWOPTION=MACAgingTime
DHCPOption82 MaxLenDHCPPacket DHCPSubOption7 DHCPSubOption90
IGMPPacketEncap;
The result is as follows:
7340032 2014-03-28 21:37:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Configure information of the device 10.144.194.40
--------------------------------------------------------------------------------------------------------
DID MACAgingTime DHCPOption82 MaxLenDHCPPacket DHCPSubOption7 DHCPSubOption90
IGMPPacketEncap
7340032 300 ENABLE 1500 DISABLE DISABLE PPP
--------------------------------------------------------------------------------------------------------
;

Related Command
None.

14.1.5 Querying CPU and Memory Information about an NE


(LST-DEVINFO)
Usage Note
This command allows you to query the type, software version, memory usage,
CPU usage, and temperature of an OLT or ONU.

Command Format
LST-DEVINFO::(DID=Device-ID|DEV=Device-name)[,(FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-id)|
NAME=ont-name]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 294


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

249 MA5600T

94 MA5603U
MA5603U V800R203C00 and later
versions

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

37 MA5662

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2319 MA5621

2312 MA5628

2313 MA5652

2317 MA5631

2321 MA5669

2318 MA5632

2324 MA5623

2333 MA5698

2335 MA5694

2336 MA5821

2337 MA5822

2338 MA5898

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 295


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2339 MA5818

2340 MA5611S

2343 MA5694S

2351 MA5878

61 MA5626E

62 MA5620E

64 MA5651

65 MA5620G

66 MA5626G

92 MA5652G

94 MA5603U

2320 MA5612A

2322 MA5621A

2323 MA5622A

2326 MA5623A

2350 MA5811S

2342 MA5622A-16

2341 MA5622A-8

2330 MA5633

2325 MA5661

70 MA5610

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 296


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 297


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONU ID. This
If the UNI parameter,
port is of 10G the device
GPON or 10G name or ID,
EPON, the
and the shelf,
value range is
0-255; if the slot, and port
UNI port is of IDs are used
1G GPON or together to
1G EPON, the locate the
value range is ONU.
0-127.
NOTE
In the case of
the GPBD
board, the
value ranges
from 0 to 127.
In the case of
the GPBC
board, the
value ranges
from 0 to 63.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONU.

You must set the parameters specified in one of the following items:
● Device name
● Device ID
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
Only one record is displayed after the query.
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 298


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="List of Device Info "


name of attributes: DEVNAME DEVIP DT DEVER MEM CPU TEMPERATURE

Output Parameter
Parameter Type Range Description

DEVNAME OCTET STRING SIZE (128) Indicates the NE


name.

DEVIP OCTET STRING SIZE (128) Indicate the IP


address of an NE.

DT OCTET STRING SIZE (255) Indicates the NE


type.
When you query
information about
an MA5683T, DT
in the response
message is related
to the
TL1_SHOW_MA5
683T_SWITCH
configuration
item setting. For
details about the
meaning and
setting method of
the configuration
item, see Table
8-1.

DEVER OCTET STRING SIZE (255) Indicates the NE


version.

MEM INTEGER 0-100 Indicates the NE


memory usage.
Unit: %

CPU INTEGER 0-100 Indicates the NE


CPU usage.
Unit: %

TEMPERATURE INTEGER 0-150 Indicates the NE


temperature.
Unit: °C

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 299


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not The resource does not


exist. exist. In this case, enter
the parameters to locate
an existing resource and
then issue the command.

Example
To query the CPU and memory information about NE 10.71.215.160, run the
following command:

LST-DEVINFO::DEV=10.71.215.160:CTAG::;

The result is as follows:


7340038 2011-09-13 18:19:09
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

List of Device Info


-----------------------------------------------------
DEVNAME DEVIP DT DEVER MEM CPU TEMPERATURE
10.71.215.160 10.71.215.160 MA5603U MA5600V800R203C00 48 10 --
-----------------------------------------------------
;

Related Command
LST-DEV

14.1.6 Querying Subrack Information (LST-FRAME)

Usage Note
There is no usage note.

Command Format
LST-FRAME::(DID=Device-ID|DEV=Device-name)[,FN=Frame-num]:CTAG::[SHOWOPTION=option of result's
attributes];

Supporting Device
Device Type No. Device Type

219 UA5000 (PVM)

44 MA5600V3

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 300


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

253 UA5000 (IPMB)

34 MA5680T

57 MA5606T

249 MA5600T

94 MA5603U

96 MA5620

97 MA5626

100 MA5616

2321 MA5669

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

95 MA5603T

2330 MA5633

2331 MA5608T

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

2344 RPS

2348 MA5683T

2350 MA5811S

2351 MA5878

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 301


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Device in the predeployed state do not support the function of querying information about
a subrack.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 302


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FN INTEGER 0-999 (Optional) -


Indicates the
subrack
number.

SHOWOPTIO OCTET ● ELABEL Specifies the -


N STRING ● FT optional
attributes
● SubFrame that can be
ONTID displayed.
● SubFrame ● If you do
ONTSN not set this
● SubFrameE parameter,
xtendPort the
● SubFrameE optional
xtendType attributes
are not
displayed.
● If you set
this
parameter,
the
optional
attributes
are
displayed.

● You can enter the device ID or device name and the subrack ID to query the information
about the subrack of the specified device.
● You must enter either the device ID or the device name. The subrack ID is optional.
● If you do not enter the shelf ID, information about all subracks of the device is
displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
Title=Frame Information of the device + Device name
Name of attributes: DID DEV FN FRAMENAME FRAMESTAT
ELABEL FRAMELOCALNAME SHELF FRAMESUPPLIER FT SubFrameONTID SubFrameONTSN
SubFrameExtendPort SubFrameExtendType

● TL1_IS_ADD_BASICPROPERTY=0(Default Value)

Default output parameter is: DID DEV FN FRAMENAME FRAMESTAT

● TL1_IS_ADD_BASICPROPERTY=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 303


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Default output parameter is: DID DEV FN FRAMENAME FRAMESTAT


FRAMELOCALNAME SHELF FRAMESUPPLIER

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

FN INTEGER 0-999 Indicates the


subrack number.

FRAMENAME OCTET STRING SIZE (32) Indicates the


subrack name.

FRAMESTAT OCTET STRING ● normal Indicates the


● fault status of the
subrack.
● other
● discovery
● Unknown

ELABEL OCTET STRING SIZE (32) Indicates the


electronic label of
the subrack.

FRAMELOCALNA OCTET STRING SIZE (128) Indicates the


ME subrack alias.

SHELF INTEGER 0 Indicates the rack


that houses the
subrack.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 304


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FRAMESUPPLIER OCTET STRING HUAWEI Indicated the


subrack vendor
name.

FT OCTET STRING SIZE (32) Indicates the


subrack type.

SubFrameONTID INTEGER 0-128 Indicates the ONT


ID of the slave
subrack.

SubFrameONTSN OCTET STRING SIZE (16) Indicates the ONT


SN of the slave
subrack.

SubFrameExtendP OCTET STRING FN-SN-PN Indicates the ID of


ort the port to which
the slave subrack
connects.

SubFrameExtendT OCTET STRING ● GPON Indicates the


ype ● GE cascading type of
the slave subrack.

You may use personal information of users when querying the information about the subracks.
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
ID Description Solution

2686058554 Command does not The MDU does not support the
support this device type. function of querying subrack
information.

2686058531 The device does not exist. Verify that the entered ID, name,
and IP address of the device are
correct.

Example
● Example1: To query the information about all the shelves of the device named
MA5600_10.144.195.45, run the following command:
LST-FRAME::DEV=MA5600_10.144.195.45:19::;
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 305


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340034 2014-09-24 10:05:11


M 19 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Frame information of the device MA5600_10.144.195.45


-----------------------------------------------------------------------------------------
DID DEV FN FRAMENAME FRAMESTAT FRAMELOCALNAME SHELF FRAMESUPPLIER
7340034 MA5600_10.144.195.45 0 Frame: 0 normal -- 0 HUAWEI
-----------------------------------------------------------------------------------------

● Example2: To query information about the subrack 0 of the device named


MA5600_10.144.195.45, run the following command:
LST-
FRAME::DEV=MA5600_10.144.195.45,FN=0:CTAG::SHOWOPTION=ELABEL;
The result is as follows:
7340034 2014-09-24 10:09:51
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Frame information of the device 5600_10.144.195.45


-----------------------------------------------------------------------------------------------
DID DEV FN FRAMENAME FRAMESTAT ELABEL FRAMELOCALNAME SHELF
FRAMESUPPLIER
7340034 5600_10.144.195.45 0 Frame: 0 normal -- -- 0 HUAWEI
-----------------------------------------------------------------------------------------------

Related Command
LST-DEV

14.1.7 Querying the Information About a Board (LST-BOARD)


Usage Note
The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be used as
location information. Before using these two parameters as location information,
make sure that the DEV parameter indicates the IP address of the device. For
details, see A.8 How to Locate a Device According to the IP Address.

Command Format
LST-BOARD::(DID=Device-ID|DEV=Device-name|(DEV=device-olt-ipaddress, ONULOCATEINFO=onu-locate-
information))[,FN=Frame-num[,SN=Slot-num]][,BT=board-type]:CTAG::[SHOWOPTION=optionof result's
attributes];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 306


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

219 UA5000(PVM)

37 MA5662

44 MA5600V3

253 UA5000(IPMB)

34 MA5680T

57 MA5606T

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
NOTE
The MA5631 V800R308C02 and later
versions support this command.

2320 MA5612A

2321 MA5669

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 307


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2318 MA5632
NOTE
The MA5632 V800R310 and later versions
support this command.

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

2331 MA5608T

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

2344 RPS

2348 MA5683T

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 308


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.
If you set
both the DEV
and
ONULOCATEI
NFO
parameters
for an ONU,
that is, enter
DEV=device-
olt-ipaddress,
ONULOCATEI
NFO=onu-
locate-
information,
the DEV
parameter
indicates the
OLT IP
address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 309


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONULOCATEI OCTET SIZE (128) Indicates the -


NFO STRING 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
ONU 0 that is
connected to
port 0/2/0.

FN INTEGER 0-999 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

BT INTEGER See B.2 (Optional) -


Parameters Indicates the
Related To type of the
the Board board.
Type.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 310


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● DEV Specifies the -


N STRING ● BNAME optional
attributes
● NAME that can be
● ALIAS displayed.
● ELABEL ● If you do
● PCBVER not set this
parameter,
● SWVER the
● ROLE optional
● ALARM attributes
are not
● ST
displayed.
● PROTECTM
● If you set
ODE
this
● PORTCOU parameter,
NT the
● PORTTYPE optional
attributes
● WORKMO
are
DE
displayed.
● REPLACE
● SERVICECF
GTYPE

● You can enter the query criteria, such as the device ID, device name, subrack ID, slot ID,
and board type, to query the information about the boards of the specified device.
● You must enter either the device ID or the device name. Other parameters are optional.
● You can enter a slot ID only after entering a subrack ID. Otherwise, the operation is
invalid.
● If you do not specify the board but enter only the device name, the information about
all the boards of the device is displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=Board Information of the device+device-name
name of attributes:DID FN SN BT BVER BSTAT DEV
BNAME NAME ALIAS ELABEL PCBVER SWVER ROLE ALARM ST PROTECTMODE
PORTCOUNT PORTTYPE WORKMODE REPLACE SERVICECFGTYPE

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 311


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-999 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

BT OCTET STRING See B.2 Indicates the type


Parameters of the board.
Related To the
Board Type.

BVER OCTET STRING SIZE (64) Indicates the


version of the
board.

BSTAT OCTET STRING ● Unknown Indicates the


● Uninstall status of the
board.
● Normal
● Fault
● Forbidden
● Discovery
● Config
● Offline
● Abnormal

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 312


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DEV OCTET STRING SIZE (192) Indicates the


device name. By
default, this
parameter is not
displayed. It is
displayed only
after you enter
SHOWOPTION=D
EV in the
command.
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 A.8
How to Locate a
Device According
to the IP
Address.

BNAME OCTET STRING SIZE (32) Indicates the


subtype of the
board.

NAME OCTET STRING SIZE (255) Indicates the


board name.

ALIAS OCTET STRING SIZE (64) Indicates the alias


of the board.

ELABEL OCTET STRING SIZE (255) Indicates the


sequence number
of the board.

PCBVER OCTET STRING SIZE (255) Indicates the


hardware version
of the board.

SWVER OCTET STRING SIZE (255) Indicates the


software version
of the board.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 313


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ROLE OCTET STRING SIZE (255) Indicates the role


of the board. The
options are as
follows:
● UP: Indicates
upstream
transmission.
● CAS: Indicates
subtend.

ALARM OCTET STRING ● CRITICAL Indicates the


● MAJOR alarm status of a
board.
● MINOR
Options are as
● WARNING follows:
● CRITICAL:
critical alarms
● MAJOR: major
alarms
● MINOR: minor
alarms
● WARNING:
warnings

ST OCTET STRING ● VOIP Indicates the


● ALL service types that
are supported by
a board.
Options are as
follows:
● VOIP: A board
that houses
POTS ports.
POTS ports are
used to carry
voice over IP
(VOIP)
services.
● ALL: A Board
that houses
other ports.

PROTECTMODE OCTET STRING NONE Indicates the


protection mode
of a board.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 314


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PORTCOUNT OCTET STRING SIZE (32) Indicates the port


quantity on a
board.

PORTTYPE OCTET STRING Parameters Indicates the port


related to the type on a board.
port type

WORKMODE OCTET STRING ● active Indicates the


● standby working mode of
a board.
● —
Options are as
follows:
● active: active
control board
● standby:
standby control
board
● —: non-control
board

REPLACE OCTET STRING Yes Specifies whether


a board is
replaceable.

SERVICECFGTYPE OCTET STRING ● portvlan Indicates the


● serviceport service type of the
board.
Options are as
follows:
● portvlan: The
board does not
process
packets.
● serviceport:
The board
strips S-VLANs
from upstream
packets and
adds S-VLANs
to downstream
packets.
NOTE
The service-port
option takes effect
only when an
NXED or NXLC
board functions as
the uplink board.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 315


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
None.

Example
To query the information about the thirteenth board in shelf 0 of the device
named 10.71.60.26, run the following command:

LST-BOARD::DEV=10.71.60.26,FN=0,SN=13:2::;

The result is as follows:

7667713 2006-04-08 17:55:32


M 2 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Board information of the device 10.71.60.26
-----------------------------------------
DID FN SN BT BVER BSTAT
7667713 0 13 Other -- Normal
-----------------------------------------
;

Related Command
None.

14.1.8 Querying Real-Time Performance Data of Boards (LST-


BOARDPERF)

Usage Note
● Boards to be queried must exist. Otherwise, the message "Operation object
does not exist" will be displayed.
● Run this command to collect the CPU usage and memory usage of boards
only when the boards work properly on online NEs and support this
collection.
● This command can be used to collect the CPU usage and memory usage of
only one board at a time.

Command Format
LST-BOARDPERF::(DID=Device-ID|DEV=Device-name),FN=frame-number,SN=slot-number:CTAG::;

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 316


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

The device ID or the device name must be set.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Board perf information of the device" name of attributes: DID FN SN CPUUSAGE
MEMUSAGE

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 317


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

CPUUSAGE INTEGER 0-100 Indicates board


CPU usage.
Unit: %.

MEMUSAGE INTEGER 0-100 Indicates board


memory usage.
Unit: %.

Error Code
ID Description Solution

2686058531 The device does Ensure that the device is successfully


not exist. added to the NCE. If the device is located
according to the device name, enter the
device name as the value of the DEV
parameter. Otherwise, enter the IP
address of the device.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following requirements:
mandatory ● The parameter values do not exceed
parameter is the ranges of the parameters specified
blank, or the by the command.
parameter value
is wrong. ● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

1610612783 Operation object Ensure that the board exists and the
does not exist. correct slot ID is entered.

Example
To query the real-time performance data of the board in slot 10 of shelf 0 on
device named 10.78.217.216, run the following command:
LST-BOARDPERF::DEV=10.78.217.216,FN=0,SN=10:1::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 318


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The result is as follows:


0 2010-11-08 15:13:40
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Board perf information of the device
----------------------------------------
DID FN SN CPUUSAGE MEMUSAGE
7340032 0 10 17 29
----------------------------------------
;

Related Command
There is no related command.

14.1.9 Querying the Information About a Daughter Board


(LST-SUBBOARD)
Usage Note
The daughter board must be inserted and the information must be synchronized.

Command Format
LST-SUBBOARD::(DID=Device-ID|DEV=Device-name)[,FN=Frame-num[,SN=Slot-num[,SBN=SubBoard-
num]]]:CTAG::SHOWOPTION=PCBVER SWVER;

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 319


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

SBN INTEGER 0-63 (Optional) -


Indicates the
number of
the daughter
board.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 320


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET PCBVER Specifies the -


N STRING SWVER optional
attributes
that can be
displayed. If
you enter
SHOWOPTIO
N=PCBVER in
the
command,
the
corresponding
attribute is
displayed in
the response
to the
command. By
default, the
attribute is
not displayed.

● You can enter the query criteria, such as the device ID, device name, subrack ID, slot ID,
and the number of the daughter board, to query the information about the daughter
board of the specified device.
● You must enter either the device ID or the device name. Other parameters are optional.
● You can enter a slot ID only after entering a subrack ID. Otherwise, the operation is
invalid.
● When entering the number of the daughter board, ensure that subrack ID and slot ID
are entered. Otherwise, the TL1 NBI considers that the entered slot ID or the number of
the daughter board is invalid when analyzing the command. In this case, the TL1 NBI
sends only other filtering criteria to the service daemon.
● If you do not specify the daughter board but enter only the device name, the
information about all the daughter boards of the device is displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="SubBoard information of the device "+device-name
name of attributes:DID FN SN SBN SBNAME ELABEL SBSTAT SBVER PCBVER SWVER

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 321


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

SBN INTEGER 0-63 Indicates the


number of the
daughter board.

SBNAME OCTET STRING SIZE (32) Indicates the


subtype of the
daughter board.

ELABEL OCTET STRING SIZE (255) Indicates the


sequence number
of the daughter
board.

SBSTAT OCTET STRING ● Normal Indicates the


● Fault status of the
daughter board.

SBVER OCTET STRING SIZE (640) Indicates the


version of the
daughter board.

PCBVER OCTET STRING SIZE (255) Indicates the


hardware version
of the daughter
board.

SWVER OCTET STRING SIZE (255) Indicates the


software version
of the daughter
board.

Error Code
ID Description Solution

2686058 The resource does not exist. Insert the daughter board,
552 synchronize the information, and
then query the information
about the daughter board.

Example
To query the information about all the daughter boards in shelf 0 of the device
named 10.71.60.26, run the following command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 322


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

LST-SUBBOARD::DEV=10.71.60.26,FN=0:9::;

The result is as follows:


7409669 2005-12-19 10:23:11
M 9 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4
SubBoard information of the device 10.71.60.26
-------------------------------
DID FN SN SBN SBNAME ELABEL SBSTAT SBVER
7409669 0 7 0 H601O1GNA 1394421 Normal --
7409669 0 7 1 H601O1FNB -- Fault --
7409669 0 8 0 O1CTB -- Fault --
7409669 0 8 1 O2CTB -- Fault --
-------------------------------
;

Related Command
None.

14.1.10 Querying the Information About a Port (LST-PORT)


Usage Note
The DEV (IP address of an OLT) and ONULOCATEINFO parameters can be used as
location information. Before using these two parameters as location information,
make sure that the DEV parameter indicates the IP address of the device. For
details, see A.8 How to Locate a Device According to the IP Address.

Command Format
LST-PORT::[ALIAS=Port-Alias][,](DID=Device-ID|DEV=Device-name|(DEV=device-olt-ipaddress,
ONULOCATEINFO=onu-locate-information))[,FN=Frame-num[,SN=Slot-num[,PN=Port-num]]][,PT=Port-
type][,PSTAT=Port-status][,DBONLY=DBOnlyValue]:CTAG::[SHOWOPTION=option of result's attributes];

Supporting Device
Device Type No. Device Type

219 UA5000(PVM)

37 MA5662

44 MA5600V3

253 UA5000(IPMB)

34 MA5680T

57 MA5606T

249 MA5600T

61 MA5626E

62 MA5620E

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 323


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

64 MA5651

65 MA5620G

66 MA5626G

70 MA5610

92 MA5652G

94 MA5603U

95 MA5603T

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2319 MA5621
NOTE
The MA5621 V800R309C00 and later versions
support this command.

2312 MA5628

2313 MA5652
NOTE
The MA5652 V800R309C00 and later versions
support this command.

2317 MA5631
NOTE
The MA5631 V800R308C02 and later versions
support this command.

2320 MA5612A

2321 MA5669

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later versions
support this command.

2318 MA5632
NOTE
The MA5632 V800R310 and later versions support
this command.

2323 MA5622A V800R311C00 and later versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 324


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2324 MA5623 V800R311C00 and later versions

2326 MA5623A V800R311C01 and later versions

2330 MA5633

2331 MA5608T

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

2344 RPS

2348 MA5683T

2350 MA5811S

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/
MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/MA5801-FL16/
MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 325


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

ALIAS OCTET SIZE (64) (Optional) -


STRING Indicates the
alias of the
port.
When using
the ALIAS
parameter to
filter and
query ports,
you can
choose to
enable exact
query or fuzzy
query by
setting the
TL1_USE_HA
ZY_QRY_AT_L
ST_PORT
configuration
item. For
details about
the meaning
and setting
method of
the
configuration
item, see
Table 8-1.

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 326


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.
If you set
both the DEV
and
ONULOCATEI
NFO
parameters
for an ONU,
that is, enter
DEV=device-
olt-ipaddress,
ONULOCATEI
NFO=onu-
locate-
information,
the DEV
parameter
indicates the
OLT IP
address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 327


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONULOCATEI OCTET SIZE (128) Indicates the -


NFO STRING 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
ONU 0 that is
connected to
port 0/2/0.

FN INTEGER 0-999 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

PN INTEGER 0-63 (Optional) -


Indicates the
port ID.

PT INTEGER Parameters (Optional) -


related to Indicates the
the port type type of the
port.

PSTAT INTEGER B.4 (Optional) -


Parameters Indicates the
Related To status of the
the Port port.
Status

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 328


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DBONLY INTEGER 0–1 (Optional) 0


Indicates the
switch for fast
query.
When this
switch is
enabled, the
query
efficiency will
be improved.
However,
parameters
LOOPSTAT,
TESTSTAT,
FEC, and
AState are
unavailable.
The value for
the PSTAT
parameter is
correct in the
inventory
data.
When this
switch is
disabled,
values for the
preceding
parameters
are queried
from NEs in
real time.
The meanings
of the options
are as follows:
● 0: Disable
● 1: Enable

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 329


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● NAME Specifies the -


N STRING ● ALIAS optional
attributes
● PSPEED that can be
● PDIRECT displayed.
● LOOPSTAT ● If you do
● TESTSTAT not set this
parameter,
● FEC the
● RN optional
● AState attributes
are not
● MAXUPSPE
displayed.
ED
● If you set
● MAXDOW
this
NSPEED
parameter,
the
optional
attributes
are
displayed.

● If you do not enter the alias, you must enter either the device name or the device ID.
Other parameters are optional.
● When entering the slot ID, ensure that the subrack ID is entered. When entering the
port ID, ensure that the subrack ID and the slot ID are entered. Otherwise, the TL1 NBI
considers that the entered slot ID or port ID is invalid when analyzing the command. In
this case, the TL1 NBI sends only other filtering criteria to the service daemon.
● If you enter only the device name, the information about all the ports on the device is
displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=Port Information of the device +device-name
name of attributes:DID FN SN PN PT PSTAT NAME ALIAS PSPEED PDIRECT LOOPSTAT TESTSTAT FEC
RN AState MAXUPSPEED MAXDOWNSPEED

Output Parameter
Parameter Type Range Description

ALIAS OCTET STRING SIZE (64) Indicates the alias


of the port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 330


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-999 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

PT OCTET STRING See Parameters Indicates the type


related to the of the port.
port type. NA: If the
displayed port
type is not
included in the list
of port types, the
character string
"NA(subtype of
the port)" is
displayed.
For example, if
the BRUS type is
not included in
the list of port
types,
"NA(BRUS)" is
displayed for the
corresponding
port.

PSTAT OCTET STRING See B.4 Indicates the


Parameters status of the port.
Related To the
Port Status.

NAME OCTET STRING SIZE (64) Indicates the port


name.

PSPEED OCTET STRING SIZE (64) Indicates the port


rate.
Unit: bit/s.

PDIRECT OCTET STRING bidirectional Indicates the port


direction.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 331


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LOOPSTAT OCTET STRING ● noLoop Indicates the


● remoteLoop loopback status of
a port.
● localLoop
Options are as
● unknown follows:
● noLoop: no
loopback
● remoteLoop:
remote
loopback
● localLoop: local
loopback
● unknown: The
loopback
status is
unknown.

TESTSTAT OCTET STRING ● noTest Indicates the test


● Test status of a port.
● unknown

FEC OCTET STRING ● enable Specifies whether


● disable the forward error
correction (FEC)
● unknown function is
enabled.

RN OCTET STRING SIZE (64) Indicates the rack


identifier.

AState OCTET STRING ● up Indicates the


● down management
status of a port.
● testing
Options are as
follows:
● up: activated
● down:
deactivated

MAXUPSPEED OCTET STRING SIZE (64) Upstream


maximum rate.

MAXDOWNSPEED OCTET STRING SIZE (64) Downstream


maximum rate.

Error Code
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 332


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query information about port 0/2/0 on the device named 10.78.217.216, run
the following command:

LST-PORT::DEV=10.78.217.216,FN=0,SN=2,PN=0:CATG::SHOWOPTION=NAME
ALIAS PSPEED PDIRECT LOOPSTAT TESTSTAT FEC RN AState;

The result is as follows:


0 2010-12-20 13:03:19
M CATG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port information of the device 10.78.217.216
----------------------------------------------------------------------------------------------------
DID FN SN PN PT PSTAT NAME ALIAS PSPEED PDIRECT LOOPSTAT TESTSTAT
FEC RN AState
7340087 0 2 0 OPT_FE Deactive frame:0/slot:2/port:0 10.78.217.216/0/2/0 100M
bidirectional noLoop noTest disable 0 up
----------------------------------------------------------------------------------------------------
;

Related Command
None.

14.1.11 Querying Protection Group Information (LST-PSG)

Usage Note
● The device must be online.
● A protection group is configured on the device.

Command Format
LST-PSG::(DID=Device-ID|DEV=Device-name)[,PSGID=name of PROTECT group]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 333


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PSGID INTEGER 0-511 Indicates the -


ID of the
protection
group.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title=Information of the protect group
name of attributes: DID DEV PSGID TYPE REVERTIVE STATUS RESTOREWAITTIME ALARMTIME
WORKMEMBER PROTECTMEMBER SWITCHREASON

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 334


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

PSGID INTEGER 0-511 Indicates the ID of


the protection
group.

TYPE OCTET STRING ● active-standby- Indicates the type


board of the protection
● active-standby- group.
port
● active-standby-
lag
● eth-nni-port
● eth-nni-lag-
member
● epon-uni-port
● gpon-uni-port
● stm-nni-port
● service-
process-board

REVERTIVE OCTET STRING SIZE (128) Indicates the


reversion status of
the protection
group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 335


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

STATUS OCTET STRING SIZE (128) Indicates the


switching status
of the protection
group.

RESTOREWAITTIM OCTET STRING SIZE (128) Indicates the WTR


E time of the
protection group.
Unit: s.
The value -1
indicates that the
WTR time is
unknown.

ALARMTIME OCTET STRING SIZE (128) Indicates the


alarm duration of
the protection
group, that is, the
alarm period
before the
protection
switching is
performed.
Unit: ms
The value -1
indicates that the
alarm duration is
unknown.

WORKMEMBER OCTET STRING SIZE (128) Indicates the


working member,
that is, the
protected object.

PROTECTMEMBER OCTET STRING SIZE (128) Indicates a


protection
member, that is,
the protecting
object.

SWITCHREASON OCTET STRING SIZE (128) Indicates the


reason that
triggers the
protection
switching of the
protection group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 336


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Verify that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write community
names are set incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Verify that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8 How to
Locate a Device According to the IP
Address.

2686058554 Command does not Verify that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following requirements:
mandatory ● The parameter values do not exceed
parameter is blank, the ranges of the parameters
or the parameter specified by the command.
value is wrong.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

2686058582 The specified No protection group exists on the


resource does not device.
exist.

Example
To query the protection group information of device 7340035, run the following
command:
LST-PSG::DID=7340035,PSGID=12:CTAG::;
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 337


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

0 2010-12-07 19:49:49
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Information of the protect group.


--------------------------------------------------------------
DID DEV PSGID TYPE REVERTIVE STATUS RESTOREWAITTIME ALARMTIME WORKMEMBER
PROTECTMEMBER SWITCHREASON
7340035 MA5680T 12 active-standby-board true idle -1 -1 frame:0/slot:8 -- --

-------------------------------------------------------------
;

Related Command
There is no command format.

14.1.12 Querying the Alarms on the NCE (LST-ALARM)


Usage Note
This command is used to query all the alarms or the alarms of the device that are
not lower than a certain alarm severity on the NCE.

Command Format
LST-ALARM::(DID=Device-ID|DEV=Device-name|DEVIP=device-IP)[,SEVERITY=alarm-level]:CTAG::;

Supporting Device
For information about the supporting devices, see B.1 Parameters Related to the
Device Type.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 338


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

DEVIP IPADDRESS - Indicates the -


IP address of
the device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 339


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SEVERITY INTEGER 1-4 Indicates the -


alarm
severity.
The value of
this
parameter
indicates the
lowest alarm
severity to be
queried. If
you set
SEVERITY to
3, the queried
alarm severity
is not lower
than the
uncleared
minor alarms.
The meanings
of the options
are as follows:
1: critical
2: major
3: minor
4: warning

You must set one of the DID, DEV, and DEVIP parameters, and other parameters are
optional.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= Alarm information of the device (+device-name) which Alarm-level is not lower than (+Alarm-level)
name of attributes: DID ALARM-NAME SEVERITY

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

ALARM-NAME OCTET STRING SIZE (255) Indicates the


alarm name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 340


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SEVERITY OCTET STRING ● CRITICAL Indicates the


● MAJOR alarm severity.
● MINOR
● WARNING

Error Code
None.

Example
● To query all the alarms of the device named 10.71.211.68, run the following
command:
LST-ALARM::DEVIP=10.71.211.68:6::;
The result is as follows:
7340162 2009-04-20 17:03:08
M 6 COMPLD
EN=0 ENDESC=succeeeded.
blktag=1
blkcount=3
blktotal=3

Alarm information of the device 10.71.211.68 which Alarm-level is not lower than WARNING
------------------------------
DID ALARM-NAME SEVERITY
7340162 Failed to communicate with the device CRITICAL
7340162 Failed to communicate with the device CRITICAL
7340162 Failed to communicate with the device CRITICAL
------------------------------
;

● To query the alarms that are not lower than the minor alarm on the device
named 10.71.211.68, run the following command:
LST-ALARM::DEV=10.78.217.111,SEVERITY=3:7::;
The result is as follows:
7340186 2009-07-13 15:44:29
M 7 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=7
blktotal=7

Alarm information of the device 10.78.217.111 which Alarm-level is not lower than MINOR
------------------------------
DID ALARM-NAME SEVERITY
7340186 The LOS occurs on the Ethernet optical port CRITICAL
7340186 The LOS occurs on the Ethernet optical port CRITICAL
7340186 The LOS occurs on the Ethernet optical port CRITICAL
7340186 The LOS occurs on the Ethernet optical port CRITICAL
7340186 The LOS occurs on the Ethernet optical port CRITICAL
7340186 The LOS occurs on the Ethernet optical port CRITICAL
7340186 The LOS occurs on the Ethernet optical port CRITICAL
------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 341


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None.

14.1.13 Querying the MAC Addresses Learnt by Devices (LST-


OLTLEARNINGMAC)
Usage Note
This command is used to query the MAC addresses learnt by devices.

Command Format
LST-OLTLEARNINGMAC::(DID=Device-ID|DEV=Device-name):CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

MA5800-X17s are supported from V100R015C00.MA5800-X7s are supported from V100R016C00.


MA5800-X15s are supported from V100R017C00. MA5800-X2s are supported from
V100R017C10. Other OLTs are supported from V800R015C00.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 342


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
list of MAC Address:
SRVPORTID BUNDLEID MACTYPE MAC FN SN PN VPI VCI ONTID GEMPORTID
VLANID

Output Parameter
Parameter Type Range Description

SRVPORTID INTEGER 1-999999 Indicates the


NOTE service port ID.
The parameter This parameter
value is larger than uniquely identifies
that displayed on a service port.
the CLI by 1.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 343


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

BUNDLEID INTEGER 1-32768 Indicates the


● MA5608T: bundle ID.
1-2048
● MA5800 series:
For the MPSC
board, the
value ranges
from 1 to
4096. For other
boards, the
value ranges
from 1 to
32768.
● Other devices:
For the SCUH
board, the
value ranges
from 1 to
16384. For
other boards,
the value
ranges from 1
to 8192.

MACTYPE OCTET STRING ● static Indicates the MAC


● dynamic type.

MAC OCTET STRING SIZE (17) Indicates the


learnt MAC
address. The
format is XXXX-
XXXX-XXXX.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

VPI OCTET STRING ● 0-4095 Indicates the


● auto virtual path
identifier.

VCI OCTET STRING ● 32-65535 Indicates the


● auto virtual channel
identifier.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 344


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

GEMPORTID INTEGER 0-3999 Indicates the GEM


port ID.
● In discrete
mode, the
value range of
the
GEMPORTID
parameter is
from 128 to
3999.
● In template
mode, the
value range of
the
GEMPORTID
parameter is
from 0 to
1023.

VLANID INTEGER 0-4095 indicates Indicates the


the maximum VLAN ID.
range. For the
value range of
different devices,
see Table B-11.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 345


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058531 The device does ● Verify whether the device is successfully


not exist. added.
● By default, the device is located
according to 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 A.8 How to
Locate a Device According to the IP
Address.

Example
To query the MAC address learnt by the device named 10.144.195.224, run the
following command:

● LST-OLTLEARNINGMAC::DEV=10.144.195.224:dd::;
● Response message:
7340032 2014-09-15 15:12:41
M dd COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=6
blktotal=6

list of MAC Address


--------------------------------------------------------------------------------------
SRVPORTID BUNDLEID MACTYPE MAC FN SN PN VPI VCI ONTID GEMPORTID
VLANID
-- -- dynamic CA-00-08-70-00-00 0 19 1 -- -- -- -- 10
-- -- dynamic 70-7B-E8-89-45-FC 0 19 0 -- -- -- -- 9
-- -- dynamic 28-6E-D4-21-20-FE 0 19 0 -- -- -- -- 9
-- -- dynamic 08-00-3E-01-BF-FF 0 19 0 -- -- -- -- 9
5 -- dynamic 08-19-A6-7E-0A-6D 0 6 0 -- -- 4 -- 9
36 -- dynamic 00-E0-FD-12-25-36 0 16 0 0 2 -- -- 9
--------------------------------------------------------------------------------------

Related Command
None

14.1.14 Querying Alarm Masking Rules (LST-MASKRULES)

Usage Note
This command is used to query alarm masking rules on the NCE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 346


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-MASKRULES::[CATEGORY=maskrules-category][,ACTIVE=maskrules-active]:CTAG::;

Support Device
For information about the supporting devices, see B.1 Parameters Related to the Device Type.

Input Parameter
Parameter Type Range Description Default

CATEGORY OCTET ● ALARM Indicates the -


STRING ● EVENT type of the
masking rules
to be queried.
The meanings
of the options
are as follows:
● ALARM:
Alarm
masking
rules
● EVENT:
Event
masking
rules
NOTE
If this
parameter
is not
specified,
the
masking
rules of all
types are
queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 347


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ACTIVE OCTET ● TRUE Specifies -


STRING ● FALSE whether the
masking rule
to be queried
is enabled.
The meanings
of these
options are as
follows:
● TRUE:
Enabled
● FALSE:
Disabled
NOTE
If this
parameter
is not
specified,
all
masking
rules are
queried.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

title= Information of the alarm shield rules name of attributes: RULEID ACTIVE
NTLIST NELIST OBJLIST CATEGORY ALARMNAME SEVERITY TYPE TIMEMODE
STARTTIME ENDTIME DELAYTIME DAYCOND TIMECOND PRIORITY MEMO

OutPut Parameters
Parameter Type Range Description

RULEID INTEGER 0-2147483647 Indicates the ID of


the masking rule.

ACTIVE OCTET STRING ● TRUE Specifies whether


● FALSE the masking rule
is enabled.
The meanings of
the options are as
follows:
● TRUE: Enabled
● FALSE:
Disabled

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 348


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NTLIST OCTET STRING SIZE (256) Indicates the NE


type list. Multiple
NE types are
separated by
semicolons (;), for
example,
MA5800-
X17;MA5603T.

NELIST OCTET STRING SIZE (256) Indicates the NE


list. Multiple NEs
are separated by
semicolons (;), for
example,
10.185.214.103;tes
t-OLT.

OBJLIST OCTET STRING SIZE (256) Indicates the list


of objects under
an NE. Multiple
objects are
separated by
semicolons (;). For
example,
FRAME:test/
0;SLOT:test/0 /
1;PORT:test/0 /
1/1;ONU:test/0 /
1/1/1.

CATEGORY OCTET STRING ● ALARM Indicates the type


● EVENT of the masking
rule.
The meanings of
the options are as
follows:
● ALARM: Alarm
masking rules
● EVENT: Event
masking rules

ALARMNAME OCTET STRING SIZE (256) Indicates the


alarm name.
Multiple names
are separated by
semicolons (;).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 349


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SEVERITY OCTET STRING ● Critical Indicates the


● Major alarm severity.
Multiple severities
● Minor are separated by
● Warning semicolons (;).
The value -
indicates all
severities.

TYPE OCTET STRING ● Environment Indicates the


● Equipment alarm type.
Multiple types are
● Communicatio separated by
n semicolons (;).
● Service The value -
● Process indicates all types.
● Security

TIMEMODE OCTET STRING ● NE Time Indicates the time


● Server Time mode.
● Client Time The meanings of
the options are as
follows:
● NE Time: Time
of NEs
● Server Time:
Time of the
server
● Client Time:
Time of clients

STARTTIME OCTET STRING SIZE (256) Indicates the start


time when the
rule validity. The
value – indicates
that the start time
is not limited.

ENDTIME OCTET STRING SIZE (256) Indicates the end


time of the rule
validity. The value
– indicates that
the end time is
not limited.

DELAYTIME INTEGER 0-1000 Indicates the


delay mask time.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 350


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DAYCOND OCTET STRING ● SUN Indicates the


● MON masking days in a
week. Multiple
● TUE days are
● WED separated by
● THUR semicolons (;).
The value -
● FRI indicates all days
● SAT in a week.

TIMECOND OCTET STRING SIZE (256) Indicates the


masking period,
for example,
00:00:00-07:00:00.
Multiple periods
are separated by
semicolons (;).
The value -
indicates all
periods.

PRIORITY INTEGER (-1000000000) - Indicates the


(1000000000) priority.

MEMO OCTET STRING SIZE (256) Indicates the


remarks.

Error Code
None

Example
To query the masking rules of alarm types that have been enabled on the NCE,
● run the following commands:
LST-MASKRULES::CATEGORY=ALARM,ACTIVE=TRUE:CTAG::;
● The result is as follows:
0 2018-04-01 20:45:20
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1

Information of the alarm shield rules.


-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------
RULEID ACTIVE NTLIST NELIST OBJLIST CATEGORY ALARMNAME
SEVERITY TYPE TIMEMODE STARTTIME ENDTIME DELAYTIME DAYCOND
TIMECOND PRIORITY MEMO
1 TRUE - - - ALARM L3VPN VRF Down - - Server Time - -
0 SUN;MON;TUE;WED;THUR;FRI;SAT - 0
-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 351


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Commands
None

14.1.15 Querying Upstream Port Information (LST-VNUPLINK-


PORT)

Usage Note
For MA5800, EA5800 and EA5801 series, upstream ports must meet the following
requirements for them to be queried:(1) Belong to an H902NXED/H901NXED/
H901OXHG/H901OXEG upstream board or

an H901MPSC/H901MPLE/H901MPLC/H903MPLA/H902MPLA/H901MPLA/
H902MPLB/H901MPLB

control board;

(2) Must be of the uplink role;

(3) Cannot be a slave port of an aggregation group.

Command Format
LST-VNUPLINK-PORT::(DID=Device-ID|DEV=Device-name):CTAG::;

Support Device
Device Type Device Type
No.

2346/2349/235 MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2
2/2353

2369/2370/239 MA5801-GP08/MA5801-CG04/MA5801-FL16/MA5801S-FL16
8/2399

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/236 EA5800-X17/EA5800-X7/EA5800-X15/EA5800-X2
2/2360

Input Parameter
Parameter Type Range Description Def
ault

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 352


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Def


ault

DEV OCTET SIZE (192) Indicates the device -


STRING 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 A.8 How to
Locate a Device
According to the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Uplink port of the device" + device-name
name of attributes: DID FN SN PN Name NetWorkRole AggrType

OutPut Parameters
Parameter Type Range Description

DID INTEGE - Indicates the device ID.


R

FN INTEGE 0-999 Indicates the subrack ID.


R

SN INTEGE 0-35 Indicates the slot ID.


R

PN INTEGE 0-63 Indicates the port ID.


R

Name OCTET SIZE (255) Indicates the port name.


STRING

NetWorkRole OCTET ● uplink Indicates the port role in the network.


STRING ● cascade
● access
● extend

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 353


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AggrType OCTET ● NotAgg Indicates the port role in an aggregation


STRING red group.
● AggrMa
in
● AggrSu
b

Error Code
ID Description Solution

2686058 The device does Verify that the


531 not exist. entered device information is
correct.

Example
To query the available upstream ports of the device named
172.120.11.171
● run the following command:
LST-VNUPLINK-PORT::DEV=172.120.11.171:CTAG::;;
● The result is as follows:
167772171 2018-09-18 19:44:24
M CTAG COMPLD
EN=0 ENDESC=Successful.
blktag=1
blkcount=1
blktotal=1
Uplink port of the device 172.120.11.171
------------------------------------------------------------------------------------DID FN SN PN Name
NetWorkRole AggrType
167772171 0 9 0 Frame:0/Slot:9/Port:0 uplink NotAggred
167772171 0 9 1 Frame:0/Slot:9/Port:1 uplink NotAggred
167772171 0 9 2 Frame:0/Slot:9/Port:2 uplink NotAggred
167772171 0 9 3 Frame:0/Slot:9/Port:3 uplink NotAggred
167772171 0 14 0 Frame:0/Slot:14/Port:0 uplink NotAggred
167772171 0 14 1 Frame:0/Slot:14/Port:1 uplink NotAggred
167772171 0 14 2 Frame:0/Slot:14/Port:2 uplink NotAggred
167772171 0 14 3 Frame:0/Slot:14/Port:3 uplink NotAggred
167772171 0 14 4 Frame:0/Slot:14/Port:4 uplink NotAggred
167772171 0 14 5 Frame:0/Slot:14/Port:5 uplink NotAggred
167772171 0 14 6 Frame:0/Slot:14/Port:6 uplink NotAggred
167772171 0 14 7 Frame:0/Slot:14/Port:7 uplink NotAggred
--------------------------------------------------------------------------------------------------------
;

Related Commands
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 354


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.2 Querying ADSL Resources


This topic provides the commands and examples for querying ADSL resources,
including the ADSL ports, profiles, alarms, and performance statistics.

14.2.1 Querying the Basic Information About an ADSL Port


(LST-ADSLPORTCFG)

Usage Note
This command is used to query the basic information about an ADSL port,
including the name and type of the line profile that is referenced by the port. The
device ID (or device name), subrack ID, slot ID, and port ID are mandatory for the
command.

This command applies only to the common mode (RFC2662).

Command Format
LST-ADSLPORTCFG::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-num:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

95 MA5603T

100 MA5616

103 MA5635

2331 MA5608T

253 UA5000 (IPMB)

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 355


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

You must specify either the device name or the device ID and three other parameters for
locating a port. Only one record is displayed after the query.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port attributes of the device" +device-name + "Frame number:" + frameId + "slot ID:" +slotID + "port
ID:" +portID
name of attributes: DID FN SN PN LineProfile LineType

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 356


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

LineProfile OCTET STRING SIZE (32) Indicates the


name of the line
profile.

LineType OCTET STRING ● Fast Indicates the type


● Interleaved of the line profile.

Error Code
ID Description Solution

1610940 Failed to read the ADSL port Verify that the database is
639 information from the database. started.
Check whether the database is
opened.

Example
To query the basic information about port 0/8/1 on the device named 10.71.60.26,
run the following command:
LST-ADSLPORTCFG::DEV=10.71.60.26,FN=0,SN=8,PN=1:16::;
The result is as follows:
7340033 2007-07-02 12:04:52
M 16 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port attributes of the device 10.71.59.28 Frame number:0 slot ID:8 port ID:1
-------------------------------------------
DID FN SN PN LineProfile LineType
7340033 0 8 1 ADSL LINE PROFILE 1002 Interleaved
-------------------------------------------

Related Command
LST-DSLPORTDETAILINFO

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 357


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.2.2 Querying Specified Information About ADSL Ports (LST-


DSLPORTSPECIFYINFO)
Usage Note
This command is used to quickly query specified information about ADSL ports on
NEs.
This command applies only to the common mode (RFC2662).

Command Format
LST-DSLPORTSPECIFYINFO::(DID=Device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::[SHOWOPTION=Alias Type AtucStatus AturStatus LineProfile LineType AtucTxRate AturTxRate
AtucSnrMgn AturSnrMgn AtucAtn AturAtn AtucOutputPwr AturOutputPwr AtucAttainableRate
AturAttainableRate];

Supporting Device
Device Type No. Device Type

44 MA5600V3

57 MA5606T

95 MA5603T

100 MA5616

253 UA5000 (IPMB)

2331 MA5608T

249 MA5600T

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 358


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 359


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● Alias (Optional) -


N STRING ● Type Specifies
whether the
● AtucStatus attributes are
● AturStatus displayed. If
● LineProfile you enter
SHOWOPTIO
● LineType N=Alias in
● AtucTxRate the
● AturTxRate command,
the
● AtucSnrMg
corresponding
n
attribute is
● AturSnrMg displayed in
n the response
● AtucAtn to the
command. By
● AturAtn
default, the
● AtucOutpu attribute is
tPwr not displayed.
● AturOutpu
tPwr
● AtucAttain
ableRate
● AturAttain
ableRate

You must specify either the device name or the device ID and three other parameters for
locating a port. Only one record is displayed after the query.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port attributes of the device" +device-name + "Frame number:" + frameId + "slot ID:" +slotID + "port
ID:" +portID
name of attributes: DID FN SN PN Alias Type AtucStatus AturStatus LineProfile LineType AtucTxRate
AturTxRate AtucSnrMgn AturSnrMgn AtucAtn AturAtn AtucOutputPwr AturOutputPwr AtucAttainableRate
AturAttainableRate

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 360


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Alias OCTET STRING SIZE (64) Indicates the alias


NOTE of the port.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 32 digit.

Type OCTET STRING ● Adsl Indicates the type


● Adsl2+ of the port.

AtucStatus OCTET STRING ● Active Indicates the


● Deactive status of the
central office.
● Block
● Activating
● Testing
● Fault
● Unknown

AturStatus OCTET STRING ● Active Indicates the


● Deactive status of the
remote end.
● Block
● Activating
● Testing
● Fault
● Unknown

LineProfile OCTET STRING SIZE (32) Indicates the


name of the line
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 361


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LineType OCTET STRING ● Fast Indicates the line


● Interleaved type.

AtucTxRate INTEGER 0-4294967295 Indicates the


transmission rate
of the
downstream
channel.
Unit: kbit/s.

AturTxRate INTEGER 0-4294967295 Indicates the


transmission rate
of the upstream
channel.
Unit: kbit/s.

AtucSnrMgn FLOAT -64 to 64 Indicates the


upstream noise
margin.
Unit: dB.

AturSnrMgn FLOAT -64 to 64 Indicates the


downstream noise
margin.
Unit: dB.

AtucAtn FLOAT 0-127 Indicates the


upstream channel
attenuation.
Unit: dB.

AturAtn FLOAT 0-127 Indicates the


downstream
channel
attenuation.
Unit: dB.

AtucOutputPwr FLOAT -31 to 31 Indicates the


downstream
output power.
Unit: dBm.

AturOutputPwr FLOAT -31 to 31 Indicates the


upstream output
power.
Unit: dBm.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 362


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucAttainableR- INTEGER 0-4294967295 Indicates the


ate downstream
attainable rate.
Unit: kbit/s.

AturAttainableR- INTEGER 0-4294967295 Indicates the


ate upstream
attainable rate.
Unit: kbit/s.

Error Code
ID Description Solution

2686124034 Resource information is Enter an existing ADSL port


empty. ID or synchronize the ADSL
port on NEs to the NMS.

2686058604 The type of port is not Ensure that an ADSL port ID


supported. is entered.

Example
To query the specified information about port 0/5/3 on the device named
10.78.217.219, run the following command:
LST-
DSLPORTSPECIFYINFO::DEV=10.78.217.219,FN=0,SN=5,PN=0:3::SHOWOPTION=
Alias Type AtucStatus AturStatus LineProfile LineType;
The result is as follows:
7340081 2011-03-31 17:55:56
M 3 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port attributes of the device 10.78.217.219 Frame number:0 Slot number:2 Port number:18
--------------------------------------------------------------------------------------------------------------------
DID FN SN PN Alias Type AtucStatus AturStatus LineProfile LineType
7340081 0 5 0 10.78.217.219/0/5/0 Adsl2+ Activating Unknown ADSL LINE PROFILE 1002 Interleaved
--------------------------------------------------------------------------------------------------------------------
;

Related Command
LST-DSLPORTDETAILINFO

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 363


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.2.3 Querying the Details of an ADSL Port (LST-


DSLPORTDETAILINFO)

Usage Note
This command is used to query the details of an ADSL port. The device ID (or
device name), subrack ID, slot ID, and port ID are mandatory for the command.

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

This command applies to the common mode (RFC2662), NGADSL mode


(RFC4706), and TR165 mode.

Command Format
LST-DSLPORTDETAILINFO::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::[SHOWOPTION=PORTMODE PORTCAPABILITY EPROF PPPOE OPTION82 NGADSLPARA
ATUCCHANCURRINP ATURCHANCURRINP IfInOcts IfOutOcts TR165PARA TR165PARAINDEX
QUENESHAPINGPARA TRANSSYS TRAPSWITCH];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

95 MA5603T

253 UA5000 (IPMB)

100 MA5616

2331 MA5608T

103 MA5635

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 364


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 365


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● PORTMOD (Optional) -


N STRING E Specifies
● PORTCAPA whether the
BILITY attributes are
displayed. If
● EPROF you enter
● PPPoE SHOWOPTIO
● OPTION82 N=PORTMOD
E in the
● NGADSLPA command,
RA the
● ATUCCHA corresponding
NCURRINP attribute is
● ATURCHA displayed in
NCURRINP the response
to the
● IfInOcts
command. By
● IfOutOcts default, the
● TR165PAR attribute is
A not displayed.
● TR165PAR
AINDEX
● QUENESH
APINGPAR
A
● TRANSSYS
● TRAPSWIT
CH

You must specify either the device name or the device ID and three other parameters for
locating a port. Only one record is displayed after the query.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port attributes of the device" +device-name + "Frame number:" + frameId + "Slot number:" +slotID +
"Port number:" +portID name of attributes: DID FN SN PN Label Alias Type AtucStatus AturStatus
LineProfile AlarmProfile LastActiveTime AdminStatus Coding LineType AtucTxRate AturTxRate
AtucInterleaveDelay AturInterleaveDelay AtucInvSerialNumber AturInvSerialNumber AtucInvVendorID
AturInvVendorID AtucInvVersionNumber AturInvVersionNumber AtucSnrMgn AturSnrMgn AtucAtn
AturAtn AtucOutputPwr AturOutputPwr AtucAttainableRate AturAttainableRate AdslLineVpi AdslLineVci
AdslIpPriority MacLearnNum LastActiveTxRate SysTime AdslLineTrellis AdslLineHandshake
AdslLineBitSwapping AdslLineType PORTMODE PORTCAPABILITY EPROF PPPOE OPTION82,
PWRMNGSTATE, INITRESULT, SIGATTENDS, SIGATTENUS, ACTPSDDS, ACTPSDUS, CH1PREVDATARATEDS,
CH1ACTDELAYDS, CH1ATMSTATUSDS, CH1PTMSTATUSDS, CH1PREVDATARATEUS, CH1ACTDELAYUS,
CH1ATMSTATUSUS, CH1PTMSTATUSUS ATUCCHANCURRINP ATURCHANCURRINP IfInOcts IfOutOcts
TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF TR165RFIPROF TR165NMPROF

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 366


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

TR165CH1USPROF TR165CH1UARR TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF TR165CH1DARR


TR165CH2DSPROF TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF TR165VNPROFINDEX
TR165SPECTRUMPROFINDEX TR165DPBOPROFINDEX TR165UPBOPROFINDEX
TR165RFIPROFINDEX TR165NMPROFINDEX TR165CH1USPROFINDEX TR165CH2USPROFINDEX
TR165CH1DSPROFINDEX TR165CH2DSPROFINDEX TR165CH1INPPROFINDEX
TR165CH2INPPROFINDEX QUENE1 QUENE2 OUTBOUNDTRAFFICPROF TRANSSYS TRAPSWITCH
TR165INMPROF

Output Parameter

If no mode is specified for a parameter, the parameter is supported by all modes: common
mode (RFC2662), NGADSL mode (RFC4706), and TR165 mode.

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Label OCTET STRING SIZE (32) Indicates the


name of the port.

Alias OCTET STRING SIZE (64) Indicates the alias


NOTE of the port.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 32 digit.

Type OCTET STRING ● Adsl Indicates the type


● Adsl2+ of the port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 367


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucStatus OCTET STRING ● Active Indicates the


● Deactive status of the
central office.
● Block
● Activating
● Testing
● Fault
● Unknown

AturStatus OCTET STRING ● Active Indicates the


● Deactive status of the
remote end. The
● Block parameter value
● Activating can only be
● Testing Active or
Unknown for
● Fault MA5600Ts and
● Unknown MxUs.

LineProfile OCTET STRING SIZE (32) Indicates the


name of the line
profile.
This parameter is
supported by the
common mode
(RFC2662) and
NGADSL mode
(RFC4706).

AlarmProfile OCTET STRING SIZE (32) Indicates the


name of the
alarm profile. The
corresponding
parameter in
TR165 mode is
TR165ALARMPRO
F.
This parameter is
supported by the
common mode
(RFC2662) and
NGADSL mode
(RFC4706).

LastActiveTime OCTET STRING SIZE (32) Indicates the time


of the last
activation. It is
UTC time.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 368


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AdminStatus OCTET STRING ● Not Indicates the


Manageable management
● Manageable status. The value
is always Not
Manageable for
MA5600Ts and
MxUs.

Coding OCTET STRING ● DMT Indicates the


● CAP coding mode.
● QAM This parameter is
supported only by
● OTHER the common
mode (RFC2662).

LineType OCTET STRING ● Fast Indicates the line


● Interleaved type.
This parameter is
supported only by
the common
mode (RFC2662).

AtucTxRate INTEGER - Indicates the


transmission rate
of the
downstream
channel.
Unit: kbit/s.

AturTxRate INTEGER - Indicates the


transmission rate
of the upstream
channel.
Unit: kbit/s.

AtucInterleaveDe- INTEGER - Indicates the


lay downstream
interleave delay.
The corresponding
parameter in
TR165 mode is
CH1ACTDELAYDS.
Unit: ms.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 369


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AturInterleaveDe- INTEGER - Indicates the


lay upstream
interleave delay.
The corresponding
parameter in
TR165 mode is
CH1ACTDELAYUS.
Unit: ms.

AtucInvSerialNum OCTET STRING SIZE (0-32) Indicates the


ber serial number of
the vendor of the
central office
system.

AturInvSerialNum OCTET STRING SIZE (0-32) Indicates the


ber serial number of
the vendor of the
remote end
system.

AtucInvVendorID OCTET STRING SIZE (0-16) Indicates the


vendor ID of the
central office
system.

AturInvVendorID OCTET STRING SIZE (0-16) Indicates the


vendor ID of the
remote end
system.

AtucInvVersionNu OCTET STRING SIZE (0-16) Indicates the


mber version of the
central office
system.

AturInvVersionNu OCTET STRING SIZE (0-16) Indicates the


mber version of the
remote end
system.

AtucSnrMgn FLOAT -64 to +64 Indicates the


upstream noise
margin.
Unit: dB.

AturSnrMgn FLOAT -64 to +64 Indicates the


downstream noise
margin.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 370


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucAtn FLOAT 0-127 Indicates the


upstream channel
attenuation.
Unit: dB.

AturAtn FLOAT 0-127 Indicates the


downstream
channel
attenuation.
Unit: dB.

AtucOutputPwr FLOAT -31 to +31 Indicates the


downstream
output power.
Unit: dBm.

AturOutputPwr FLOAT -31 to +31 Indicates the


upstream output
power.
Unit: dBm.

AtucAttainableR- INTEGER - Indicates the


ate downstream
attainable rate.
Unit: kbit/s.

AturAttainableR- INTEGER - Indicates the


ate upstream
attainable rate.
Unit: kbit/s.

AdslLineVpi INTEGER 0-255 Indicates the


virtual path
identifier of the
ADSL link. Only
the MA5300V1
supports this
parameter.

AdslLineVci INTEGER 0-511 Indicates the


virtual channel
identifier of the
ADSL link. Only
the MA5300V1
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 371


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AdslIpPriority INTEGER 0-7 Indicates the IP


precedence of the
port. Only the
MA5300V1
supports this
parameter.

MacLearnNum INTEGER 0-255 Indicates the


number of MAC
addresses that are
learned by the
ADSL port itself.
Only the
MA5100V2
supports this
parameter.

LastActiveTxRate INTEGER - Indicates the last


activation rate of
the ADSL port.
The corresponding
parameter in
TR165 mode is
CH1PREVDATAR
ATEDS.
Unit: kbit/s.
Currently, the NCE
does not support
this parameter.

SysTime OCTET STRING SIZE (32) Indicates the


system time.
Currently, the NCE
does not support
this parameter.

AdslLineTrellis OCTET STRING ● DISABLED Specifies whether


● ENABLED the enumerated
value of the ADSL
trellis coding is
used. Currently,
the NCE does not
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 372


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AdslLineHandshak OCTET STRING ● All Indicates the


e ● Full rate enumerated value
of the ADSL
● Glite only handshaking
● T1413 only protocol.
● Gdmt only Currently, the NCE
does not support
● Ghs this parameter.
● G9921
● G9922
● G9923
● G9924
● G9925
● AdslAllOnly
● Unknown

AdslLineBitSwap- OCTET STRING ● DISABLED Specifies whether


ping ● ENABLED the enumerated
value of the bit
swapping is used.
Currently, the NCE
does not support
this parameter.

AdslLineType OCTET STRING ● NoChannel Indicates the


● FastOnly ADSL line type.
Currently, the NCE
does not support
this parameter.

PORTMODE OCTET STRING ● ADSL-ONLY Indicates the


● COMBO working mode of
the ADSL port.
● BYPASS Currently, only the
UA5000 (IPMB)
supports this
parameter.

PORTCAPABILITY OCTET STRING ● BOTH Indicates the


● Line One capability of the
ADSL port.
Currently, only the
UA5000 (IPMB)
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 373


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

EPROF OCTET STRING SIZE (32) Indicates the


name of the
extended profile.
This parameter
cannot be queried
in TR165 mode.
This parameter is
supported only by
the common
mode (RFC2662).

PPPOE OCTET STRING ● ON Specifies whether


● OFF the PPPoE
function is
enabled.
Currently, only the
MA5600T,
MA5603T and the
MA5606T support
this parameter.

OPTION82 OCTET STRING ● ON Specifies whether


● OFF the option 82
function is
enabled.
Currently, only the
MA5600T,
MA5603T and the
MA5606T support
this parameter.

PWRMNGSTATE OCTET STRING ● L0 Indicates the


● L1 power
management
● L2 status. This
● L3 parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 374


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

INITRESULT OCTET STRING ● NoFailure Indicates the


● ConfigError result of the last
complete
● ConfigNotFeasi initialization. This
ble parameter can be
● CommFail queried only in
● NoPeerAtu NGADSL and
TR165 modes.
● OtherCause
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.

SIGATTENDS INTEGER 0-127 Indicates the


downstream
signal
attenuation. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: dB.

SIGATTENUS INTEGER 0-127 Indicates the


upstream signal
attenuation. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 375


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTPSDDS INTEGER -90 to 0 Indicates the


downstream PSD.
This parameter
can be queried
only in NGADSL
and TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: dBm/Hz.

ACTPSDUS INTEGER -90 to 0 Indicates the


upstream PSD.
This parameter
can be queried
only in NGADSL
and TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: dBm/Hz.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 1. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 376


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1ACTDELAYDS INTEGER 0-4294967295 Indicates the


downstream delay
of channel 1. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: ms.

CH1ATMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat downstream ATM
ion data status of
channel 1. This
● LossOfCellDeli parameter can be
neation queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.

CH1PTMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● OutOfSync downstream PTM
data status of
channel 1. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 377


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 1. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: bit/s.

CH1ACTDELAYUS INTEGER 0-4294967295 Indicates the


upstream delay of
channel 1. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.
Unit: ms.

CH1ATMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat upstream ATM
ion data status of
channel 1. This
● LossOfCellDeli parameter can be
neation queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 378


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1PTMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● OutOfSync upstream PTM
data status of
channel 1. This
parameter can be
queried only in
NGADSL and
TR165 modes.
This parameter is
returned only
when you entered
SHOWOPTION=
NGADSLPARA in
the command.

ATUCCHANCURRI FLOAT 0-254 Indicates


NP downstream
impulse noise
protection (INP).
Unit: DMT Symbol

ATURCHANCURRI FLOAT 0-254 Indicates


NP upstream INP.
Unit: DMT Symbol

IfInOcts INTEGER 1-4294967295 Indicates the total


number of octets
received by the
ADSL port,
including framing
characters.

IfOutOcts INTEGER 1-4294967295 Indicates the total


number of octets
transmitted from
the ADSL port,
including framing
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 379


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165VNPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 virtual
noise profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165SPECTRUM OCTET STRING SIZE (32) Indicates the


PROF name of the
TR165 spectrum
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 380


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165ALARMPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 alarm
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165DPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 DPBO
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165RFIPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 RFI profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 381


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 382


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
upstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
upstream rate
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 383


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
upstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 384


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
downstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
downstream rate
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 385


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
downstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 386


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2INPPRO OCTET STRING SIZE (32) Indicates the


F delay INP profile
of the TR165
channel 2.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165VNPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 virtual
noise profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 387


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165SPECTRUM INTEGER 1-4294967294 Indicates the


PROFINDEX index of the
TR165 spectrum
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165DPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 DPBO
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165UPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 UPBO
profile.
The NCE does not
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 388


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165RFIPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 RFI profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165NMPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 noise
margin profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 389


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
upstream rate
profile. This
parameter is valid
only when the
TR165CH1UARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH2USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 2
upstream rate
profile. This
parameter is valid
only when the
TR165CH2UARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 390


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
downstream
profile. This
parameter is valid
only when the
TR165CH1DARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH2DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 2
downstream rate
profile. This
parameter is valid
only when the
TR165CH2DARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 391


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
impulse noise
protection (INP)
profile of the
TR165 channel 1.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH2INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
impulse noise
protection (INP)
profile of the
TR165 channel 2.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

QUENE1 INTEGER 3 Indicates queue 1.


This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 392


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

QUENE2 INTEGER 4 Indicates queue 2.


This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

OUTBOUNDTRAF OCTET STRING SIZE (32) Indicates the


FICPROF name of the
outbound traffic
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 393


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● G.992.1 TCM- Indicates the


ISDN non- transmission
overlapped mode of ADSL
● G.992.1 TCM- ports. This
ISDN parameter can be
overlapped queried only in
TR165 modes.
● G.992.1 TCM-
This parameter is
ISDN
returned only
symmetric
when you entered
● G.992.2 with SHOWOPTION=T
TCM-ISDN RANSSYS in the
non- command.
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G992.1-Annex
A
● G992.1-Annex
B
● G992.2-Annex
A
● G992.3-Annex
A
● G992.3-Annex
B
● G992.3-Annex I
● G992.3-Annex J
● G992.3-Annex
L Mask 1
● G992.3-Annex
L Mask 2
● G992.3-Annex
L Mask 3
● G992.3-Annex
L Mask 4
● G992.3-Annex
M
● G992.4 Annex
A
● G992.4-Annex
A
● G992.4-Annex I

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 394


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G992.5-Annex
A
● G992.5-Annex
B
● G992.5-Annex I
● G992.5-Annex J
● G992.5-Annex
M
● Regional Std.
● T1.413

TRAPSWITCH OCTET STRING ● ON Specifies whether


● OFF the trap function
is enabled.
Options are as
follows:
● ON: reports
alarms from
ports to the
NCE.
● OFF:
suppresses
alarms from
ports.

TR165INMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 INM
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 395


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610940467 Reading port information Check whether the device is


from the device failed. offline or times out.

1611268098 Querying the details of the Log in to the management plane


ports fails. of NCE and check whether the
xDSL service management
process is started. If the process
is not started, start the process.
See A.15 Logging In to the
Management Plane of NCE.

Example
To query the details of port 0/13/0 on the device named 10.144.199.35, run the
following command:
LST-
DSLPORTDETAILINFO::DEV=10.144.199.35,FN=0,SN=13,PN=0:3::SHOWOPTION
=NGADSLPARA ATUCCHANCURRINP ATURCHANCURRINP IfInOcts IfOutOcts
TR165PARA QUENESHAPINGPARA;
The result is as follows:
7340178 2011-07-09 17:20:38
M 3 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port attributes of the device 10.144.199.35 Frame number:0 Slot number:13 Port number:0
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------------------------------------
DID FN SN PN Label Alias Type AtucStatus AturStat
us LineProfile AlarmProfile LastActiveTime AdminStatus Coding
LineType AtucTxRate AturTxRate AtucInterleaveDelay AturInte
rleaveDelay AtucInvSerialNumber AturInvSerialNumber AtucInvVendorID
AturInvVendorID AtucInvVersionNumber AturInvVersionNumber AtucSnrMgn
AturSnrMgn AtucAtn AturAtn AtucOutputPwr AturOutputPwr AtucAttainableRa
te AturAttainableRate AdslLineVpi AdslLineVci AdslIpPriority
MacLearnNum LastActiveTxRate SysTime AdslLineTrellis AdslLineHandshak
e AdslLineBitSwapping AdslLineType PWRMNGSTATE INITRESULT
SIGATTENDS SIGATTENUS ACTPSDDS ACTPSDUS CH1PREVDATARATED
S CH1ACTDELAYDS CH1ATMSTATUSDS CH1PTMSTATUSDS CH1PREVDATARATEUS
CH1ACTDELAYUS CH1ATMSTATUSUS CH1PTMSTATUSUS ATUCCHANCURRINP ATURCHANCURRINP
IfInOcts IfOutOcts TR165VNPROF TR165SPECTRUMPROF TR165ALA
RMPROF TR165DPBOPROF TR165RFIPROF TR165NMPROF TR165CH1USPROF TR165CH1
UARR TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF TR165CH1DARR TR165CH2
DSPROF TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF QUENE1 QUENE2 OUTBOUND
TRAFFICPROF TR165INMPROF
7340178 0 13 0 Frame:0/Slot:13/Port:0 test1234 --
Deactive Unknown -- -- -- Not Manageable -- --
-- -- -- -- 16l v09.07.21, 2008-10-20 -- 0xFFB542

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 396


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

44434D4D54 -- VE_9_7_21 -- -- -- -- --
-- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- --
-- -- DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL UPSTREAM
100 -- -- DEFVAL DOWNSTREAM 100 -- -- DEFVAL
-- 3 4 -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------------------------------------
;

To query the details of port 0/11/15 on the device named 10.71.59.35, run the
following command:
● LST-
DSLPORTDETAILINFO::DEV=10.71.59.35,FN=0,SN=11,PN=15:CTAG::SHOWO
PTION=PORTMODE PORTCAPABILITY EPROF PPPOE OPTION82
NGADSLPARA ATUCCHANCURRINP ATURCHANCURRINP IfInOcts
IfOutOcts TR165PARA QUENESHAPINGPARA TRANSSYS;
● The result is as follows:
7340032 2011-08-10 17:20:38
M 3 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port attributes of the device 10.71.59.35 Frame number:0 Slot number:11 Port number:15
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------
DID FN SN PN Label Alias Type AtucStatus AturStatus LineProfile AlarmProfile
LastActiveTime AdminStatus Coding LineType AtucTxRate AturTxRate
AtucInterleaveDelay AturInterleaveDelay AtucInvSerialNumber AturInvSerialNumber
AtucInvVendorID AturInvVendorID AtucInvVersionNumber AturInvVersionNumber
AtucSnrMgn AturSnrMgn AtucAtn AturAtn AtucOutputPwr AturOutputPwr
AtucAttainableRate AturAttainableRate AdslLineVpi AdslLineVci AdslIpPriority
MacLearnNum LastActiveTxRate SysTime AdslLineTrellis AdslLineHandshake
AdslLineBitSwapping AdslLineType PORTMODE PORTCAPABILITY EPROF PPPOE
OPTION82 PWRMNGSTATE INITRESULT SIGATTENDS SIGATTENUS ACTPSDDS
ACTPSDUS CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS
CH1PTMSTATUSDS CH1PREVDATARATEUS CH1ACTDELAYUS CH1ATMSTATUSUS
CH1PTMSTATUSUS ATUCCHANCURRINP ATURCHANCURRINP IfInOcts IfOutOcts
TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF TR165RFIPROF
TR165NMPROF TR165CH1USPROF TR165CH1UARR TR165CH2USPROF TR165CH2UARR
TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF TR165CH2DARR TR165CH1INPPROF
TR165CH2INPPROF QUENE1 QUENE2 OUTBOUNDTRAFFICPROF TRANSSYS TR165INMPROF
7340032 0 11 15 Frame:0/Slot:11/Port:15 test -- Active Active -- -- -- Not
Manageable -- -- -- -- -- -- 3.30.0.33 000000000000 0xB5004946544E827A
0x00005443544E0000 08.27.0A.00.2F V.3.7.9.15 6.50 7.10 0.00 1.10 16.30 12.60
25420 1172 -- -- -- -- -- -- -- -- -- -- -- -- -- ON ON L0
NoFailure 0.00 1.10 -45.10 -38.00 24076 5 NoFailure -- 1185 13 NoFailure
-- 0.10 0.40 35378 0 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL
DEFVAL UPSTREAM 60 DEFVAL UPSTREAM 40 DEFVAL DOWNSTREAM 70 DEFVAL
UPSTREAM 30 DEFVAL DEFVAL 3 4 ip-traffic-table_0 G992.1-Annex B --
-----------------------------------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 397


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------
;

The values of most of the parameters are not displayed but displayed as -- because the port
is not activated.

Related Command
● LST-ADSLPORTALARM
● LST-ADSLPORTPERF
● LST-ADSLPORTCFG

14.2.4 Querying the List of ADSL Line Profiles (LST-


ADSLLINEPROFILE)
Usage Note
This command applies to the common mode (RFC2662).

Command Format
LST-ADSLLINEPROFILE:::CTAG::DT=device-type[,LPROFID=line-profile-name][,COM=channel-operation-
mode][,LTYPE=line-profile-type][,ATUCMINRT=Central-Office-End-Minimum-stream-TX-rate]
[,ATUCMAXRT=Central-Office-End-Maximum-stream-TX-rate][,ATURMINRT=Remote-End-Minimum-stream-
TX-rate][,ATURMAXRT=Remote-End-Maximum-stream-TX-rate][,SCOPEPROFID=Scope-Profile-Name]
[,SHOWOPTION=SCOPEPROFID];

Supporting Device

Table 14-1 Supporting Device

Device Type No. Device Type

44 MA5600V3

249 MA5600T

253 UA5000 (IPMB)

57 MA5606T

74 MA5300V1

100 MA5616

95 MA5603T

103 MA5635

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 398


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2331 MA5608T

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Table Indicates the N/A


14-1. device type.

LPROFID OCTET SIZE (32) (Optional) N/A


STRING Indicates the
name of the
ADSL line
profile.

COM OCTET 0-2 (Optional) N/A


STRING Indicates the
channel
working
mode. The
meanings of
the options
are as follows:
● 0: Fast
● 1:
Interleave
● 2:
FastOrInter
leaved
In the case of
low delay,
select the 0
mode. In the
case of stable
connection,
select the 1
mode.
Only the
MA5300V1
supports the
2 mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 399


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LTYPE INTEGER ● 1: Adsl Indicates the N/A


● 2: Adsl2+ type of the
supported
port, which
can be ADSL
or ADSL2+.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 400


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ATUCMINRT INTEGER MA5300V1: (Optional) N/A


32-28799 Indicates the
MA5615, minimum
MA5605, downstream
MA5600V3, transmission
MA5105, rate.
MA5100V1, Unit: kbit/s.
MA5100V2, ● If COM is
UA5000, set to 0,
UA5000 this
(IPMB), parameter
MA5603T, is
MA5606T, displayed
MA5616, as ATU-C
MA5635, (Downstre
MA5600T: am) Fast
32-31999 Min. Tx
Rate.
● If COM is
set to 1,
this
parameter
is
displayed
as ATU-C
(Downstre
am)
Interleave
d Min. Tx
Rate.
● If COM is
set to 2,
this
parameter
is
displayed
as ATU-C
(Downstre
am) Fast
Min. Tx
Rate/ATU-
C
(Downstre
am)
Interleave
d Min. Tx
Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 401


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ATUCMAXRT INTEGER MA5300V1: (Optional) N/A


33-28800 Indicates the
MA5615, maximum
MA5605, downstream
MA5600V3, transmission
MA5105, rate. It is
MA5100V1, recommended
MA5100V2, that you set
UA5000, this
UA5000 parameter to
(IPMB), 6144.
MA5603T, Unit: kbit/s.
MA5606T, ● If COM is
MA5616, set to 0,
MA5635, this
MA5600T: parameter
33-32000 is
displayed
as ATU-C
(Downstre
am) Fast
Max. Tx
Rate.
● If COM is
set to 1,
this
parameter
is
displayed
as ATU-C
(Downstre
am)
Interleave
d Max. Tx
Rate.
● If COM is
set to 2,
this
parameter
is
displayed
as ATU-C
(Downstre
am) Fast
Max. Tx
Rate/ATU-
C
(Downstre
am)

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 402


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

Interleave
d Max. Tx
Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 403


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ATURMINRT INTEGER MA5300V1: (Optional) N/A


32-3479 Indicates the
UA5000, minimum
MA5615, upstream
MA5605, transmission
MA5105, rate. It is
MA5100V1, recommended
MA5100V2: that you set
32-3000 this
parameter to
MA5600V3, 640.
UA5000
(IPMB), Unit: kbit/s.
MA5603T, ● If COM is
MA5606T, set to 0,
MA5616, this
MA5635, parameter
MA5600T: is
32-6000 displayed
as ATU-R
(Upstream
) Fast Min.
Tx Rate.
● If COM is
set to 1,
this
parameter
is
displayed
as ATU-R
(Upstream
)
Interleave
d Min. Tx
Rate.
● If COM is
set to 2,
this
parameter
is
displayed
as ATU-R
(Upstream
) Fast Min.
Tx Rate/
ATU-R
(Upstream
)
Interleave

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 404


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

d Min. Tx
Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 405


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ATURMAXRT INTEGER MA5300V1: (Optional) N/A


33-3480 Indicates the
UA5000, maximum
MA5615, upstream
MA5605, transmission
MA5105, rate.
MA5100V1, Unit: kbit/s.
MA5100V2: ● If COM is
32-3000 set to 0,
MA5600V3, this
UA5000 parameter
(IPMB), is
MA5603T, displayed
MA5606T, as ATU-R
MA5616, (Upstream
MA5635, ) Fast
MA5600T: Max. Tx
32-6000 Rate.
● If COM is
set to 1,
this
parameter
is
displayed
as ATU-R
(Upstream
)
Interleave
d Max. Tx
Rate.
● If COM is
set to 2,
this
parameter
is
displayed
as ATU-R
(Upstream
) Fast
Max. Tx
Rate/ATU-
R
(Upstream
)
Interleave
d Max. Tx
Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 406


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

● The DT parameter is mandatory. Other parameters are optional.


● You can perform the fuzzy search by profile name and obtain all the profiles whose
names contain the entered character string. The PROFID parameter does not support
fuzzy search.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=ADSL Activation Profile of the device type +device-type
DT LPROFID COM ATUCMINRT ATUCMAXRT ATURMINRT ATURMAXRT SCOPEPROFID

Output Parameter
Parameter Type Range Description

DT OCTET STRING See Table 14-1. Indicates the


device type.

LPROFID OCTET STRING SIZE (32) (Optional)


Indicates the
name of the ADSL
line profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 407


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COM OCTET STRING ● Fast (Optional)


● Interleave Indicates the
channel working
● FastOrInterleav mode.
ed
In the case of low
delay, select the
Fast mode. In the
case of stable
connection, select
the Interleave
mode.
Only the
MA5300V1
supports the
FastOrInterleave
d mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 408


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATUCMINRT INTEGER MA5300V1: (Optional)


32-28799 Indicates the
MA5615, minimum
MA5605, downstream
MA5600V3, transmission rate.
MA5105, Unit: kbit/s.
MA5100V1, ● If the value of
MA5100V2, the COM is
UA5000, UA5000 Fast, this
(IPMB), MA5603T, parameter is
MA5606T, displayed as
MA5616, ATU-C
MA5635, (Downstream)
MA5600T: Fast Min. Tx
32-31999 Rate.
● If the value of
the COM is
Interleave, this
parameter is
displayed as
ATU-C
(Downstream)
Interleaved
Min. Tx Rate.
● If the value of
the COM is
FastOrInterlea
ved, this
parameter is
displayed as
ATU-C
(Downstream)
Fast Min. Tx
Rate/ATU-C
(Downstream)
Interleaved
Min. Tx Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 409


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATUCMAXRT INTEGER MA5300V1: (Optional)


33-28800 Indicates the
MA5615, maximum
MA5605, downstream
MA5600V3, transmission rate.
MA5105, It is
MA5100V1, recommended
MA5100V2, that you set this
UA5000, UA5000 parameter to
(IPMB), MA5603T, 6144.
MA5606T, Unit: kbit/s.
MA5616, ● If the value of
MA5635, the COM is
MA5600T: Fast, this
33-32000 parameter is
displayed as
ATU-C
(Downstream)
Fast Max. Tx
Rate.
● If the value of
the COM is
Interleave, this
parameter is
displayed as
ATU-C
(Downstream)
Interleaved
Max. Tx Rate.
● If the value of
the COM is
FastOrInterlea
ved, this
parameter is
displayed as
ATU-C
(Downstream)
Fast Max. Tx
Rate/ATU-C
(Downstream)
Interleaved
Max. Tx Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 410


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURMINRT INTEGER MA5300V1: (Optional)


32-3479 Indicates the
UA5000, MA5615, minimum
MA5605, upstream
MA5105, transmission rate.
MA5100V1, It is
MA5100V2: recommended
32-3000 that you set this
parameter to 640.
MA5600V3,
UA5000 (IPMB), Unit: kbit/s.
MA5603T, ● If the value of
MA5606T, the COM is
MA5616, Fast, this
MA5635, parameter is
MA5600T: displayed as
32-6000 ATU-R
(Upstream)
Fast Min. Tx
Rate.
● If the value of
the COM is
Interleave, this
parameter is
displayed as
ATU-R
(Upstream)
Interleaved
Min. Tx Rate.
● If the value of
the COM is
FastOrInterlea
ved, this
parameter is
displayed as
ATU-R
(Upstream)
Fast Min. Tx
Rate/ATU-R
(Upstream)
Interleaved
Min. Tx Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 411


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURMAXRT INTEGER MA5300V1: (Optional)


33-3480 Indicates the
UA5000, MA5615, maximum
MA5605, upstream
MA5105, transmission rate.
MA5100V1, Unit: kbit/s.
MA5100V2: ● If the value of
32-3000 the COM is
MA5600V3, Fast, this
UA5000 (IPMB), parameter is
MA5603T, displayed as
MA5606T, ATU-R
MA5616, (Upstream)
MA5635, Fast Max. Tx
MA5600T: Rate.
32-6000 ● If the value of
the COM is
Interleave, this
parameter is
displayed as
ATU-R
(Upstream)
Interleaved
Max. Tx Rate.
● If the value of
the COM is
FastOrInterlea
ved, this
parameter is
displayed as
ATU-R
(Upstream)
Fast Max. Tx
Rate/ATU-R
(Upstream)
Interleaved
Max. Tx Rate.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 412


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058498 Invalid parameter or Verify that the


value of parameter is parameter values do not
wrong. exceed the ranges of the
parameters specified by
the command, the
parameter names are
correct, and the
parameters are entered
in the correct order.

2686058552 The resource does not The required profile does


exist. not exist.

Example
To query the list of the global line profiles of the MA5300V1, run the following
command:
LST-ADSLLINEPROFILE:::1::DT=74;
The result is as follows:
0 2012-09-17 13:44:39
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2
ADSL Activation Profile of the device type MA5300V1
-----------------------------------------------------------------
DT LPROFID COM ATUCMINRT ATUCMAXRT ATURMINRT ATURMAXRT
MA5300V1 LINE-PROFILE-1 Fast 32/-- 6144/-- 32/-- 640/--
MA5300V1 LINE-PROFILE-2 Interleave --/32 --/6144 --/32 --/640
-----------------------------------------------------------------
;

Related Command
LST-ADSLLINEPROFILEDETAIL

14.2.5 Querying the Details of an ADSL Line Profile (LST-


ADSLLINEPROFILEDETAIL)
Usage Note
The specified ADSL line profile must exist.
This command applies to the common mode (RFC2662).

Command Format
LST-ADSLLINEPROFILEDETAIL:::CTAG::DT=device-type,LPROFID=line-profile-name[,SCOPEPROFID=Scope-
Profile-Name][,SHOWOPTION=EOC ATUCRATEMODE ATURRATEMODE ATUCDOWNSHIFTSNRMGN

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 413


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ATUCUPSHIFTSNRMGN ATUCMINUPSHIFTTIME ATUCMINDOWNSHIFTTIME ATURDOWNSHIFTSNRMGN


ATURUPSHIFTSNRMGN ATURMINUPSHIFTTIME ATURMINDOWNSHIFTTIME SCOPEPROFID];

Supporting Device

Table 14-2 Supporting Device


Device Type No. Device Type

44 MA5600V3

249 MA5600T

253 UA5000 (IPMB)

57 MA5606T

100 MA5616

95 MA5603T

2331 MA5608T

103 MA5635

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Table Indicates the N/A


14-2. device type.

LPROFID OCTET SIZE (32) Indicates the N/A


STRING name of the
ADSL line
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 414


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● EOC (Optional) N/A


N STRING ● ATUCRATE Specifies the
MODE attributes
that can be
● ATURRATE displayed. If
MODE you set this
● ATUCDOW parameter,
NSHIFTSN the
RMGN corresponding
● ATUCUPSH attributes are
IFTSNRMG displayed. By
N default, the
attributes are
● ATUCMIN not displayed.
UPSHIFTTI
ME For example,
if you enter
● ATUCMIN EOC, the
DOWNSHI information
FTTIME about this
● ATURDOW attribute is
NSHIFTSN displayed.
RMGN The
● ATURUPSH ATURRATEM
IFTSNRMG ODE attribute
N is valid only
● ATURMIN for the
UPSHIFTTI MA5300V1.
ME
● ATURMIN
DOWNSHI
FTTIME
● SCOPEPRO
FID

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ADSL Activation Profile " + LPROFID + " of the device type "+device-type
name of attributes:
DT LPROFID ConfRateMode COM ATUCTGTSNR ATUCMAXSNR ATUCMINSNR
ATUCCHANCONFFASTMINTXRATE ATUCCHANCONFINTERLEAVEMINTXRATE
ATUCCHANCONFFASTMAXTXRATE ATUCCHANCONFINTERLEAVEMAXTXRATE ATUCINTLAT ATURTGTSNR
ATURMAXSNR ATURMINSNR ATURCHANCONFFASTMINTXRATE ATURCHANCONFINTERLEAVEMINTXRATE
ATURCHANCONFFASTMAXTXRATE ATURCHANCONFINTERLEAVEMAXTXRATE ATURINTLAT ATUCBITSW
ATURBITSW TRELMOD TM EOC ATUCRATEMODE ATURRATEMODE ATUCDOWNSHIFTSNRMGN
ATUCUPSHIFTSNRMGN ATUCMINUPSHIFTTIME ATUCMINDOWNSHIFTTIME ATURDOWNSHIFTSNRMGN
ATURUPSHIFTSNRMGN ATURMINUPSHIFTTIME ATURMINDOWNSHIFTTIME SCOPEPROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 415


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DT OCTET STRING See Table 14-2. Indicates the


device type.

LPROFID OCTET STRING SIZE (32) Indicates the


name of the ADSL
line profile.

ConfRateMode OCTET STRING ● Fixed Indicates the


● AutoAdaptAtSt channel
artup configuration
mode. The
● AutoAdaptAtR options are as
unning follows:
● Fixed: The
channel
configuration
mode is fixed.
● AutoAdaptAtSt
artup: The
channel
configuration
is adapted
automatically
when the
system is
started.
● AutoAdaptAtR
unning: The
channel
configuration
is adapted
automatically
when the
system is
running.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 416


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COM OCTET STRING ● 0: Fast Indicates the


● 1: Interleave channel working
mode. In the case
● 2: of low delay,
FastOrInterleav select the Fast
ed mode. In the case
of stable
connection, select
the Interleave
mode.
Only the
MA5300V1
supports the
FastOrInterleave
d mode.

ATUCTGTSNR INTEGER 0-31 Indicates the


upstream target
SNR margin.
Unit: dB.

ATUCMAXSNR INTEGER 6-31 Indicates the


maximum
upstream SNR
margin.
Unit: dB.

ATUCMINSNR INTEGER 0-15 Indicates the


minimum
upstream SNR
margin.
Unit: dB.

ATUCCHANCONF INTEGER MA5300V1: Indicates the


FASTMINTXRATE 32-28799 minimum
MA5615, downstream rate
MA5605, of the fast
MA5600V3, channel.
MA5105, Unit: kbit/s.
MA5100V1,
MA5100V2,
UA5000, UA5000
(IPMB), MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
32-31999

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 417


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATUCCHANCONFI INTEGER MA5300V1: Indicates the


NTERLEAVEMINT 32-28799 minimum
XRATE MA5615, downstream rate
MA5605, of the interleave
MA5600V3, channel.
MA5105, Unit: kbit/s.
MA5100V1,
MA5100V2,
UA5000, UA5000
(IPMB), MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
32-31999

ATUCCHANCONF INTEGER MA5300V1: Indicates the


FASTMAXTXRATE 33-28800 maximum
MA5615, downstream rate
MA5605, of the fast
MA5600V3, channel.
MA5105, Unit: kbit/s.
MA5100V1,
MA5100V2,
UA5000, UA5000
(IPMB), MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
33-32000

ATUCCHANCONFI INTEGER MA5300V1: Indicates the


NTERLEAVEMAXT 33-28800 maximum
XRATE MA5615, downstream rate
MA5605, of the interleave
MA5600V3, channel.
MA5105, Unit: kbit/s.
MA5100V1,
MA5100V2,
UA5000, UA5000
(IPMB), MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
33-32000

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 418


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATUCINTLAT INTEGER 0-255 Indicates the


downstream
interleave delay.
Unit: ms.

ATURTGTSNR INTEGER 0-15 Indicates the


downstream
target SNR
margin.
Unit: dB.

ATURMAXSNR INTEGER 0-31 Indicates the


maximum
downstream SNR
margin.
Unit: dB.

ATURMINSNR INTEGER 0-15 Indicates the


minimum
downstream SNR
margin.
Unit: dB.

ATURCHANCONF INTEGER MA5300V1: Indicates the


FASTMINTXRATE 32-3479 minimum
UA5000, MA5615, upstream rate of
MA5605, the fast channel.
MA5105, Unit: kbit/s.
MA5100V1,
MA5100V2:
32-3000
MA5600V3,
UA5000 (IPMB),
MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
32-6000

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 419


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURCHANCONFI INTEGER MA5300V1: Indicates the


NTERLEAVEMINT 32-3479 minimum
XRATE UA5000, MA5615, upstream rate of
MA5605, the interleave
MA5105, channel.
MA5100V1, Unit: kbit/s.
MA5100V2:
32-3000
MA5600V3,
UA5000 (IPMB),
MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
32-6000

ATURCHANCONF INTEGER MA5300V1: Indicates the


FASTMAXTXRATE 33-3480 maximum
UA5000, MA5615, upstream rate of
MA5605, the fast channel.
MA5105, Unit: kbit/s.
MA5100V1,
MA5100V2:
32-3000
MA5600V3,
UA5000 (IPMB),
MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
32-6000

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 420


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURCHANCONFI INTEGER MA5300V1: Indicates the


NTERLEAVEMAXT 33-3480 maximum
XRATE UA5000, MA5615, upstream rate of
MA5605, the interleave
MA5105, channel.
MA5100V1, Unit: kbit/s.
MA5100V2:
32-3000
MA5600V3,
UA5000 (IPMB),
MA5603T,
MA5606T,
MA5616,
MA5635,
MA5600T:
32-6000

ATURINTLAT INTEGER 0-255 Indicates the


upstream
interleave delay.
Unit: ms.

ATUCBITSW OCTET STRING ● ON Indicates the


● OFF downstream
channel bit swap.

ATURBITSW OCTET STRING ● ON Indicates the


● OFF upstream channel
bit swap.

TRELMOD OCTET STRING ● ON Indicates the


● OFF trellis coding.

TM OCTET STRING See Table B-6. Indicates the


transmission
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 421


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

EOC OCTET STRING ● Transparent Indicates the EOC


Mode mode, namely,
● HDLC Frame transparent mode
Mode and HDLC frame
mode.
This parameter is
displayed only
when the preset
SHOWOPTION
parameter
contains the EOC
attribute. By
default, this
parameter is not
displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 422


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATUCRATEMODE OCTET STRING ● Fixed Indicates the


● AutoAdaptAtSt adaptation mode
artup of downstream
transmission rate.
● AutoAdaptAtR The options are as
unning follows:
● Fixed: The
adaptation
mode is fixed.
● AutoAdaptAtSt
artup: The
downstream
transmission
rate is adapted
automatically
when the
system is
started.
● AutoAdaptAtR
unning: The
downstream
transmission
rate is
automatically
adapted when
the system is
running.
The following four
parameters are
valid only when
the value of this
parameter is
AutoAdaptAtRun
ning:
● ATUCDOWNS
HIFTSNRMGN
● ATUCUPSHIFTS
NRMGN
● ATUCMINUPS
HIFTTIME
● ATUCMINDOW
NSHIFTTIME

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 423


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURRATEMODE OCTET STRING ● Fixed Indicates the


● AutoAdaptAtSt adaptation mode
artup of upstream
transmission rate.
● AutoAdaptAtR The options are as
unning follows:
● Fixed: The
adaptation
mode is fixed.
● AutoAdaptAtSt
artup: The
upstream
transmission
rate is adapted
automatically
when the
system is
started.
● AutoAdaptAtR
unning: The
upstream
transmission
rate is
automatically
adapted when
the system is
running.
The following four
parameters are
valid only when
the value of this
parameter is
AutoAdaptAtRun
ning:
● ATURDOWNS
HIFTSNRMGN
● ATURUPSHIFTS
NRMGN
● ATURMINUPS
HIFTTIME
● ATURMINDOW
NSHIFTTIME
This parameter is
valid only for the
MA5300V1.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 424


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATUCDOWNSHIF INTEGER 0-31 Indicates the SNR


TSNRMGN margin threshold
for the downshift
of the upstream
transmission rate.
Unit: dB.

ATUCUPSHIFTSN INTEGER 0-31 Indicates the SNR


RMGN margin threshold
for the upshift of
the upstream
transmission rate.
Unit: dB.

ATUCMINUPSHIF INTEGER 0-16383 Indicates the


TTIME required
minimum time for
the upshift of the
downstream
transmission rate.
Unit: s.

ATUCMINDOWNS INTEGER 0-16383 Indicates the


HIFTTIME required
minimum time for
the downshift of
the downstream
transmission rate.
Unit: s.

ATURDOWNSHIF INTEGER 0-31 Indicates the SNR


TSNRMGN margin threshold
for the downshift
of the
downstream
transmission rate.
Unit: dB.

ATURUPSHIFTSN INTEGER 0-31 Indicates the SNR


RMGN margin threshold
for the upshift of
the downstream
transmission rate.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 425


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURMINUPSHIF INTEGER 0-16383 Indicates the


TTIME required
minimum time for
the upshift of the
upstream
transmission rate.
Unit: s.

ATURMINDOWNS INTEGER 0-16383 Indicates the


HIFTTIME required
minimum time for
the downshift of
the upstream
transmission rate.
Unit: s.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

1026294 The profile does not exist. Ensure that the entered profile
27 name is correct.

Example
To query the details of LINE-PROFILE-1 on the MA5300V1, run the following
command:
LST-ADSLLINEPROFILEDETAIL:::1::DT=74,LPROFID=LINE-PROFILE-1;
The result is as follows:
0 2012-10-25 19:51:45
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
ADSL Activation Profile LINE-PROFILE-1 of the device type MA5300V1
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------
DT LPROFID ConfRateMode COM ATUCTGTSNR ATUCMAXSNR ATUCMINSNR
ATUCCHANCONFFASTMINTXRATE ATUCCHANCONFINTERLEAVEMINTXRATE
ATUCCHANCONFFASTMAXTXRATE ATUCCHANCONFINTERLEAVEMAXTXRATE ATUCINTLAT
ATURTGTSNR ATURMAXSNR ATURMINSNR ATURCHANCONFFASTMINTXRATE
ATURCHANCONFINTERLEAVEMINTXRATE ATURCHANCONFFASTMAXTXRATE
ATURCHANCONFINTERLEAVEMAXTXRATE ATURINTLAT ATUCBITSW ATURBITSW TRELMOD TM

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 426


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

MA5300V1 LINE-PROFILE-1 AutoAdaptAtStartup Fast 12 31 0 32 -- 6144 -- -- 12


31 0 32 -- 640 -- -- OFF OFF ON All
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------
;

Related Command
LST-ADSLLINEPROFILE

14.2.6 Querying the List of ADSL Alarm Profiles (LST-


ADSLALARMPROFILE)

Usage Note
This command applies to the common mode (RFC2662).

Command Format
LST-ADSLALARMPROFILE:::CTAG::DT=device-type[,APROFID=ADSL-Alarm-Profile-ID][,ATURLOS15=Remote-
End-15-minute-LOS][,ATURES15=Errored-seconds-at-far-end-15-minutes][,ATUCLOS15=Central-Office-
End-15-minute-LOS][,ATUCES15=Errored-seconds-in-15-minutes-at-near-end][,SCOPEPROFID=Scope-
Profile-Name][,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

253 UA5000 (IPMB)

57 MA5606

100 MA5616

95 MA5603T

103 MA5635

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 427


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

APROFID OCTET SIZE (32) (Optional) -


STRING Indicates the
name of the
ADSL alarm
profile.

ATURLOS15 INTEGER 0-900 (Optional) -


Indicates the
threshold of
the upstream
loss of signal
(LOS) in 15
minutes.
Unit: s.

ATURES15 INTEGER 0-900 (Optional) -


Indicates the
threshold of
the upstream
error seconds
in 15 minutes.
Unit: s.

ATUCLOS15 INTEGER 0-900 (Optional) -


Indicates the
threshold of
the
downstream
LOS in 15
minutes.
Unit: s.

ATUCES15 INTEGER 0-900 (Optional) -


Indicates the
threshold of
the
downstream
error seconds
in 15 minutes.
Unit: s.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 428


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET SCOPEPROFI Specifies -


N STRING D whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

● The DT parameter is mandatory. Other parameters are optional.


● You can perform the fuzzy search by profile name and obtain all the profiles whose
names contain the entered character string. The PROFID parameter does not support
fuzzy search.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ADSL Alarm Profile of the device type" + device-type
DT APROFID ATURLOS15 ATURES15 ATUCLOS15 ATUCES15 SCOPEPROFID

Parameter Type Range Description

DT OCTET STRING See Supporting Indicates the


Device. device type.

APROFID OCTET STRING SIZE (32) Indicates the


name of the ADSL
alarm profile.

ATURLOS15 INTEGER 0-900 Indicates the


threshold of the
upstream loss of
signal (LOS) in 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 429


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATURES15 INTEGER 0-900 Indicates the


threshold of the
upstream error
seconds in 15
minutes.
Unit: s.

ATUCLOS15 INTEGER 0-900 Indicates the


threshold of the
downstream LOS
in 15 minutes.
Unit: s.

ATUCES15 INTEGER 0-900 Indicates the


threshold of the
downstream error
seconds in 15
minutes.
Unit: s.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Output Parameter
None.

Error Code
ID Description Solution

2686058 Invalid parameter or value of Verify that the parameter values


498 parameter is wrong. do not exceed the ranges of the
parameters specified by the
command, the parameter names
are correct, and the parameters
are entered in the correct order.

2686058 The resource does not exist. Ensure that the desired profile
552 (corresponding to the APROFID
parameter) exists on the NCE.

Example
To query the list of the global alarm profiles of the MA5600T, run the following
command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 430


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

LST-ADSLALARMPROFILE:::5::DT=249;
The result is as follows:
0 2012-10-25 20:20:51
M 5 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2
ADSL Alarm Profile of the device type MA5600T
----------------------------------------------------------
DT APROFID ATURLOS15 ATURES15 ATUCLOS15 ATUCES15
MA5600T HGFJJ 0 0 0 0
MA5600T fbhfgj 0 0 0 0
----------------------------------------------------------
;

Related Command
None

14.2.7 Querying the List of ADSL Extended Profiles (LST-


ADSLEXTENDPROFILE)
Usage Note
This command applies to the common mode (RFC2662).

Command Format
LST-ADSLEXTENDPROFILE:::CTAG::DT=device-type[,EPROFID=extend-profile-name][,SCOPEPROFID=Scope-
Profile-Name][,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

253 UA5000 (IPMB)

100 MA5616

95 MA5603T

2331 MA5608T

103 MA5635

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 431


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

EPROFID OCTET SIZE (64) Indicates the -


STRING name of the
ADSL
extended
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

SHOWOPTIO OCTET SCOPEPROFI Specifies -


N STRING D whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

● The DT parameter is mandatory. Other parameters are optional.


● You can perform the fuzzy search by profile name and obtain all the profiles whose
names contain the entered character string.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=" ADSL Extend Profile of the device type "+device-type
name of attributes:DT EPROFID FLAG1 BEGINDEX1 ENDINDEX1
FLAG2 BEGINDEX2 ENDINDEX2 FLAG3 BEGINDEX3 ENDINDEX3
FLAG4 BEGINDEX4 ENDINDEX4 SCOPEPROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 432


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DT OCTET STRING See Supporting Indicates the


Device. device type.

EPROFID OCTET STRING SIZE (32) Indicates the


name of the ADSL
extended profile.

FLAG1 OCTET STRING ● Enable Indicates the flag


● Disable of interval 1.

BEGINDEX1 INTEGER 0-511 Indicates the start


index of interval
1.

ENDINDEX1 INTEGER 0-511 Indicates the end


index of interval
1.

FLAG2 OCTET STRING ● Enable Indicates the flag


● Disable of interval 2.

BEGINDEX2 INTEGER 0-511 Indicates the start


index of interval
2.

ENDINDEX2 INTEGER 0-511 Indicates the end


index of interval
2.

FLAG3 OCTET STRING ● Enable Indicates the flag


● Disable of interval 3.

BEGINDEX3 INTEGER 0-511 Indicates the start


index of interval
3.

ENDINDEX3 INTEGER 0-511 Indicates the end


index of interval
3.

FLAG4 OCTET STRING ● Enable Indicates the flag


● Disable of interval 4.

BEGINDEX4 INTEGER 0-511 Indicates the start


index of interval
4.

ENDINDEX4 INTEGER 0-511 Indicates the end


index of interval
4.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 433


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

2686058498 Invalid parameter or Verify that the parameter


value of parameter is values do not exceed the
wrong. ranges of the parameters
specified by the
command, the parameter
names are correct, and
the parameters are
entered in the correct
order.

2686058552 The resource does not The required profile does


exist. not exist.

Example
To query the list of the global extended profiles of the MA5300V1, run the
following command:
LST-ADSLEXTENDPROFILE:::CTAG::DT=74;
The result is as follows:
0 2012-10-25 20:24:05
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
ADSL Extend Profile of the device type MA5300V1
------------------------------------------------------------------------------------------------------------------------------
------
DT EPROFID FLAG1 BEGINDEX1 ENDINDEX1 FLAG2 BEGINDEX2 ENDINDEX2 FLAG3
BEGINDEX3 ENDINDEX3 FLAG4 BEGINDEX4 ENDINDEX4
MA5300V1 TTYJY Disable 0 0 Disable 0 0 Disable 0 0 Disable 0 0
------------------------------------------------------------------------------------------------------------------------------
------
;

Related Command
LST-ADSLEXTENDPROFILEDETAIL

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 434


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.2.8 Querying the Details of an ADSL Extended Profile (LST-


ADSLEXTENDPROFILEDETAIL)
Usage Note
The specified ADSL extended profile must exist.
This command applies to the common mode (RFC2662).

Command Format
LST-ADSLEXTENDPROFILEDETAIL:::CTAG::DT=device-type,EPROFID=line-profile-
name[,SCOPEPROFID=Scope-Profile-Name][,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

44 MA5600V3

57 MA5606T

100 MA5616

95 MA5603T

103 MA5635

2331 MA5608T

249 MA5600T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

EPROFID OCTET SIZE (64) Indicates the -


STRING name of the
ADSL
extended
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 435


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ADSL Extend Profile " + EPROFID + " of the device type "+device-type name of attributes:DT EPROFID
FLAG1 BEGINDEX1 ENDINDEX1 FLAG2 BEGINDEX2 ENDINDEX2 FLAG3 BEGINDEX3 ENDINDEX3 FLAG4
BEGINDEX4 ENDINDEX4 MININPD MININPU TRANSMODE ANNEXTYPE TONENUM TONEID1 PSDVAL1
TONEID2 PSDVAL2 …… …… TONEID32 PSDVAL32 DSMAXPSD L2STATE L2GUARDTIME L2INTERTIME
L2INTERPOWER L2TOTALPOWER SCOPEPROFID

Output Parameter
Parameter Type Range Description

DT OCTET STRING See Supporting Indicates the


Device. device type.

EPROFID OCTET STRING SIZE (32) Indicates the


name of the ADSL
extended profile.

FLAG1 OCTET STRING ● Enable Indicates the flag


● Disable of interval 1.

BEGINDEX1 INTEGER 0-511 Indicates the start


index of interval
1.

ENDINDEX1 INTEGER 0-511 Indicates the end


index of interval
1.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 436


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FLAG2 OCTET STRING ● Enable Indicates the flag


● Disable of interval 2.

BEGINDEX2 INTEGER 0-511 Indicates the start


index of interval
2.

ENDINDEX2 INTEGER 0-511 Indicates the end


index of interval
2.

FLAG3 OCTET STRING ● Enable Indicates the flag


● Disable of interval 3.

BEGINDEX3 INTEGER 0-511 Indicates the start


index of interval
3.

ENDINDEX3 INTEGER 0-511 Indicates the end


index of interval
3.

FLAG4 OCTET STRING ● Enable Indicates the flag


● Disable of interval 4.

BEGINDEX4 INTEGER 0-511 Indicates the start


index of interval
4.

ENDINDEX4 INTEGER 0-511 Indicates the end


index of interval
4.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 437


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MININPD OCTET STRING ● 0 Indicates the


● 1 minimum
downstream
● 2 impulse noise
● 4 protection (INP).
● 6 The unit of this
parameter is 0.5
● 8 DMT symbol.
● 10 ● 0: noProtection
● 12 ● 1: 0.5 DMT
● 14 symbol
● 16 ● 2: 1 DMT
● 18 symbol
● 20 ● 4: 2 DMT
symbols
● 22
● 6: 3 DMT
● 24
symbols
● 26
● 8: 4 DMT
● 28 symbols
● 30 ● 10: 5 DMT
● 32 symbols
● auto ● 12: 6 DMT
symbols
● 14: 7 DMT
symbols
● 16: 8 DMT
symbols
● 18: 9 DMT
symbols
● 20: 10 DMT
symbols
● 22: 11 DMT
symbols
● 24: 12 DMT
symbols
● 26: 13 DMT
symbols
● 28: 14 DMT
symbols
● 30: 15 DMT
symbols
● 32: 16 DMT
symbols
● auto: This
parameter is

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 438


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

customized by
the device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 439


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MININPU OCTET STRING ● 0 Indicates the


● 1 minimum
upstream INP. The
● 2 unit of this
● 4 parameter is 0.5
● 6 DMT symbol.
● 8 ● 0: noProtection
● 10 ● 1: 0.5 DMT
symbol
● 12
● 2: 1 DMT
● 14 symbol
● 16 ● 4: 2 DMT
● 18 symbols
● 20 ● 6: 3 DMT
● 22 symbols
● 24 ● 8: 4 DMT
symbols
● 26
● 10: 5 DMT
● 28
symbols
● 30
● 12: 6 DMT
● 32 symbols
● auto ● 14: 7 DMT
symbols
● 16: 8 DMT
symbols
● 18: 9 DMT
symbols
● 20: 10 DMT
symbols
● 22: 11 DMT
symbols
● 24: 12 DMT
symbols
● 26: 13 DMT
symbols
● 28: 14 DMT
symbols
● 30: 15 DMT
symbols
● 32: 16 DMT
symbols
● auto: This
parameter is

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 440


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

customized by
the device.

TRANSMODE OCTET STRING ● G992.1 Indicates the


● G992.2 transmission
standard.
● G992.3
● G992.5
● T1.413
● ETSI

ANNEXTYPE OCTET STRING ● Annex.A Indicates the


● Annex.B transmission
annex. The
● Annex.J UA5000 does not
● Annex.L support this
● Annex.M parameter.

TONENUM INTEGER 0-32 Indicates the


number of tones.
The MA5600V3,
MA5603T and
MA5600T do not
support this
parameter.

TONEIDn INTEGER 32-511 Indicates tone


index n. n ranges
from 1 to 32.
The MA5600V3,
MA5603T and
MA5600T do not
support this
parameter.

PSDVALn INTEGER 0-190 Indicates PSD


value n. n ranges
from 1 to 32.
The MA5600V3,
MA5603T and
MA5600T do not
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 441


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DSMAXPSD INTEGER -52 to -40 Indicates the


maximum
downstream
transmit power
density. The
MA5300V1 does
not support this
parameter.
Unit: dBm/Hz.

L2STATE INTEGER ● Disable Indicates the


● Enable status of the L2
mode.
● Forced
The MA5600V3
supports this
parameter.

L2GUARDTIME INTEGER 0-255 Indicates the


duration in which
the current
transmission rate
is smaller than
the net rate
threshold.
The MA5600V3
supports this
parameter.
Unit: s.

L2INTERTIME INTEGER 0-255 Indicates the


interval between
two L2 modes.
The MA5600V3
supports this
parameter.
Unit: s.

L2INTERPOWER INTEGER 0-31 Indicates the


power decrease
each time when
the L2 mode is
switched. The
MA5600V3
supports this
parameter.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 442


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

L2TOTALPOWER INTEGER 0-31 Indicates the total


power decrease
when the L2
mode is switched.
This parameter
should not be
smaller than the
L2INTERPOWER
parameter. The
MA5600V3
supports this
parameter.
Unit: dB.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

1026294 The profile does not exist. Ensure that the entered profile
27 name is correct.

Example
To query the details of shmi on the MA5600T, run the command:
LST-ADSLEXTENDPROFILEDETAIL:::CTAG::DT=249,EPROFID=shmi;
The result is as follows:
0 2012-10-25 20:34:49
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
ADSL Extend Profile shmi of the device type MA5600T
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------
DT EPROFID FLAG1 BEGINDEX1 ENDINDEX1 FLAG2 BEGINDEX2 ENDINDEX2 FLAG3
BEGINDEX3 ENDINDEX3 FLAG4 BEGINDEX4 ENDINDEX4 MININPD MININPU TRANSMODE
ANNEXTYPE TONENUM TONEID1 PSDVAL1 TONEID2 PSDVAL2 TONEID3 PSDVAL3
TONEID4 PSDVAL4 TONEID5 PSDVAL5 TONEID6 PSDVAL6 TONEID7 PSDVAL7 TONEID8
PSDVAL8 TONEID9 PSDVAL9 TONEID10 PSDVAL10 TONEID11 PSDVAL11 TONEID12
PSDVAL12 TONEID13 PSDVAL13 TONEID14 PSDVAL14 TONEID15 PSDVAL15 TONEID16
PSDVAL16 TONEID17 PSDVAL17 TONEID18 PSDVAL18 TONEID19 PSDVAL19 TONEID20

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 443


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

PSDVAL20 TONEID21 PSDVAL21 TONEID22 PSDVAL22 TONEID23 PSDVAL23 TONEID24


PSDVAL24 TONEID25 PSDVAL25 TONEID26 PSDVAL26 TONEID27 PSDVAL27 TONEID28
PSDVAL28 TONEID29 PSDVAL29 TONEID30 PSDVAL30 TONEID31 PSDVAL31 TONEID32
PSDVAL32 DSMAXPSD L2STATE L2GUARDTIME L2INTERTIME L2INTERPOWER L2TOTALPOWER
MA5600T shmi Disable 0 0 Disable 0 0 Disable 0 0 Disable 0 0 auto auto
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -40 -- -- -- --
--
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------
;

Related Command
LST-ADSLEXTENDPROFILE

14.2.9 Querying the Alarm Information About an ADSL Port


(LST-ADSLPORTALARM)

Usage Note
This command is used to query the alarm information about an ADSL port.

This command applies to the common mode (RFC2662), NGADSL mode


(RFC4706), and TR165 mode.

Command Format
LST-ADSLPORTALARM::(DID=device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

95 MA5603T

249 MA5600T

57 MA5606T

253 UA5000 (IPMB)

103 MA5635

2331 MA5608T

100 MA5616

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 444


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack
number.

SN INTEGER 0-35 Indicates the -


slot ID.

PN INTEGER 0-63 Indicates the -


port ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port alarm of the device " + device name + "frameId" + frame number + "slotId" + slot-number +
"portId"+ port number
name of attributes: SerialNo FaultID Severity FunctionType strName ReasonID
Reason Repair Meaning FaultFlag faultTime ackTime clearTime strAckUserName Location

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 445


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Description

SerialNo INTEGER Indicates the serial


number generated by
the daemon.

FaultID INTEGER Indicates the alarm or


event ID. This parameter
and the device are used
to identify an alarm or
event.

Severity INTEGER Indicates the alarm


severity or event level.

FunctionType INTEGER Indicates the type of the


alarm or event.

strName OCTET STRING Indicates the name of


the alarm or event.

ReasonID INTEGER Indicates the cause ID of


the alarm.

Reason OCTET STRING Indicates the alarm


cause.

Repair OCTET STRING Indicates the suggestion


for clearing the alarm.

Meaning OCTET STRING Indicates the description


of the alarm.

FaultFlag INTEGER Indicates the type of the


fault.

faultTime OCTET STRING Indicates the time when


the alarm or event is
generated.
The time is in UTC
format.

ackTime OCTET STRING Indicates the time when


the alarm is
acknowledged.
The time is in UTC
format.

clearTime OCTET STRING Indicates the time when


the alarm is cleared.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 446


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Description

strAckUserName OCTET STRING Indicates the


acknowledged username.

Location OCTET STRING Indicates the location of


the alarm or event.
The format is
Device=device ID
Frame=subrack ID
Slot=slot ID
Subslot=subslot ID
Port=port ID. For
example,
Device=7340049
Frame=0 Slot=1
Subslot=65535 Port=5.

Error Code
ID Description Solution

1612644886 No port alarm Verify that the traps


information. reporting function is
enabled on the server.

1610612785 Getting alarm Check whether the


information timed out. device is offline or the
network delay occurs.

1610612784 Querying alarm ● Check whether the


information failed. device reports alarms.
● Check whether the
failure to query
alarms is caused by
network delay or
discarded packets.
Check whether the
device supports the
query of alarm
information.

Example
To query the alarm information about ADSL port 0/12/0 on the device named
10.144.73.167, run the following command:
LST-ADSLPORTALARM::DEV=10.144.73.167,FN=0,SN=12,PN=0:2::;
7340149 2011-01-19 16:01:59
M 2 COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 447


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port alarm of the device 10.144.73.167 Frame number:0 Slot number:12 Port number:0
------------------------------------------------------------------------------------------------------------------------------
--------------------------------
SerialNo FaultID Severity FunctionType strName ReasonID Reason Repair Meaning FaultFlag faultTime
ackTime clearTime strAckUserName Location
11328 170983425 1 3 Signal Degraded (SD) occurs at the ATM port. 170983425 The Signal Degraded
(SD) message is received from the board. 1 2011-1-18 5:59:12 -- -- -- Device=7340149 Frame=0 Slot=12
Subslot=65535 Port=0
------------------------------------------------------------------------------------------------------------------------------
--------------------------------
;

Related Command
● LST-ADSLPORTPERF
● LST-DSLPORTDETAILINFO
● LST-ADSLPORTCFG

14.2.10 Querying the Alarm Status of an xDSL Port (LST-


XDSLPORTALARMSTATE)

Usage Note
This command is used to query the alarm status of an xDSL port or a G.fast port
in the common mode (RFC2662), TI mode or TR165 mode.

Command Format
LST-XDSLPORTALARMSTATE::(DID=device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T
● TR165 mode and TI mode: MA5600
V800R008 and later versions
● Common mode: MA5600
V800R006C02, MA5600
V800R007C01, MA5600V800R008
and later versions

100 MA5616
● ADSL port in TR165 mode: MA5616
V800R308C00 and later versions
● VDSL2 port in common mode:
MA5616 V800R309C00 and later
versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 448


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2331 MA5608T
VDSL2 port in TR165 mode

249 MA5600T
● TR165 mode and TI mode: MA5600
V800R008 and later versions
● Common mode: MA5600
V800R006C02, MA5600
V800R007C01, MA5600V800R008
and later versions

2340 MA5611S
VDSL2 port in TR165 mode

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 449


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port alarm of the device: " + device name + "frameId:" + frame number + "slotId:" + slot-number +
"portId:"+ port number
name of attributes:DID FN SN PN COLOF COLOS COLPR COLOSQ COLOL CODIF COCIF COPIF COIF
CONPAP CPELOF CPELOS CPELPR CPELOSQ

Output Parameter

If no mode is specified for a parameter, the parameter is supported by the common mode
(RFC2662), TI mode, and TR165 mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 450


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

COLOF OCTET STRING ● Yes Specifies whether


● No Loss of Frame
alarms are
generated at the
central office
(CO).

COLOS OCTET STRING ● Yes Specifies whether


● No Loss of Signal
alarms are
generated at the
CO.

COLPR OCTET STRING ● Yes Specifies whether


● No Loss of Power
alarms are
generated at the
CO.

COLOSQ OCTET STRING ● Yes Specifies whether


● No Loss of Signal
Quality alarms
are generated at
the CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COLOL OCTET STRING ● Yes Specifies whether


● No Loss of Link
alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 451


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CODIF OCTET STRING ● Yes Specifies whether


● No Data Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COCIF OCTET STRING ● Yes Specifies whether


● No Configuration
Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COPIF OCTET STRING ● Yes Specifies whether


● No Protocol
Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COIF OCTET STRING ● Yes Specifies whether


● No Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 452


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CONPAP OCTET STRING ● Yes Specifies whether


● No No Peer ATU
Present alarms
are generated at
the CO.
NOTE
ADSL ports in
common mode
support this
parameter.

CPELOF OCTET STRING ● Yes Specifies whether


● No Loss of Frame
alarms are
generated at the
remote end.

CPELOS OCTET STRING ● Yes Specifies whether


● No Loss of Signal
alarms are
generated at the
remote end.

CPELPR OCTET STRING ● Yes Specifies whether


● No Loss of Power
alarms are
generated at the
remote end.

CPELOSQ OCTET STRING ● Yes Specifies whether


● No Loss of Signal
Quality alarms
are generated at
the remote end.
NOTE
ADSL ports in
common mode
support this
parameter.

Error Code
ID Description Solution

2689014668 Port type is invalid Verify that the input port


type is ADSL, VDSL2 or
G.fast.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 453


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058552 The resource does not exist. Verify that the input port
exists. If it exists,
synchronize the port on the
NMS.

Example
To query the alarm status of port 0/8/5 on the device named 10.71.59.35, an
ADSL port in TR165 mode, run the following command:

LST-XDSLPORTALARMSTATE::DEV=10.71.59.35,FN=0,SN=8,PN=5:CTAG::;
The result is as follows:
7340032 2011-09-06 10:43:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Port alarm of the device:10.71.59.35 frameId:0 slotId:8 portId:5


--------------------------------------------------------------------------------
--------------------------------------------
DID FN SN PN COLOF COLOS COLPR COLOSQ COLOL CODIF
COCIF COPIF COIF CONPAP CPELOF CPELOS CPELPR CPELOSQ
7340032 0 8 5 No No No -- -- --
-- -- No -- No No No --
--------------------------------------------------------------------------------
--------------------------------------------

Related Command
None

14.2.11 Querying the Performance Statistics of an ADSL Port


(LST-ADSLPORTPERF)

Usage Note
This command is used to query the performance statistics on a specified ADSL
port of a device. A device must be switched to the RFC2662 mode to query the
performance statistics of a port, and the required ADSL port must be in the
activated state.

This command applies only to the common mode (RFC2662).

Command Format
LST-ADSLPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-num:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 454


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

253 UA5000 (IPMB)

57 MA5606T

100 MA5616

95 MA5603T

2331 MA5608T

103 MA5635

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 455


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SN INTEGER 0-35 Indicates the -


slot ID.

PN INTEGER 0-63 Indicates the -


port ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port performance of the device " + device-name + " frameId " + frame-number + " slotId " + slot-
number + " portId "+ port-number
name of attributes: InOctets OutOctets AtucPerfInit AtucPerfLofs AtucPerfLoss AtucPerfLprs AtucPerfESs
AturPerfLofs AturPerfLoss AturPerfLprs AturPerfESs

Output Parameter
Parameter Type Range Description

InOctets INTEGER 0-4294967295 Indicates the


receive traffic of
the ADSL terminal
unit (ATU).
Unit: byte.

OutOctets INTEGER 0-4294967295 Indicates the


transmit traffic of
the ATU.
Unit: byte.

AtucPerfInit INTEGER 0-4294967295 Indicates the


number of link
retraining of the
ADSL transceiver
unit - central
office end (ATU-
C).

AtucPerfLofs INTEGER 0-4294967295 Indicates the


number of frame
loss of the ATU-C.

AtucPerfLoss INTEGER 0-4294967295 Indicates the


number of signal
loss of the ATU-C.

AtucPerfLprs INTEGER 0-4294967295 Indicates the


number of power
failures of the
ATU-C.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 456


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfESs INTEGER 0-4294967295 Indicates the


number of error
seconds of the
ATU-C.
Unit: s.

AturPerfLofs INTEGER 0-4294967295 Indicates the


number of frame
loss of the ADSL
transceiver unit -
remote end (ATU-
R).

AturPerfLoss INTEGER 0-4294967295 Indicates the


number of signal
loss of the ATU-R.

AturPerfLprs INTEGER 0-4294967295 Indicates the


number of power
failures of the
ATU-R.

AturPerfESs INTEGER 0-4294967295 Indicates the


number of error
seconds of the
ATU-R.
Unit: s.

Error Code
ID Description Solution

1613561871 The performance Verify that the


statistics task does not performance statistics of
exist. the specified port is
available. If the
performance statistics is
not available, create the
performance statistics
collection task for the
port on the GUI.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 457


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

1613561870 Interacting with the Verify that the


performance and performance statistics
statistic daemon failed, collection process runs in
please check the the normal state. For
performance and example, verify that the
statistic daemon. performance statistics
collection task is started
normally.

1613234209 Get performance's index Verify that the required


failed. index for the
performance statistics
collection task is
available.

Example
To query the performance statistics of ADSL port 0/8/0 on the device named
10.71.60.26, run the following command:
LST-ADSLPORTPERF::DEV=10.71.60.26,FN=0,SN=8,PN=0:3::;
The result is as follows:
7409669 2005-06-09 10:58:06
M 3 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port performance of the device 10.71.60.26 frameId 0 slotId 8 portId 0
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------
InOctets OutOctets AtucPerfInit AtucPerfLofs AtucPerfLoss AtucPerfLprs AtucPerfESs
AturPerfLofs AturPerfLoss AturPerfLprs AturPerfESs
0 0 1 0 0 0 0 0 0 0 0
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------
;

Related Command
● LST-ADSLPORTQTRPERF
● LST-DSLPORTDETAILINFO
● ACT-ADSLPORT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 458


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.2.12 Querying the Current Performance Statistics of an


ADSL Port (LST-ADSLNTPORTPERF)
Usage Note
This command is used to query the current performance statistics of an ADSL port
in TR165 mode and NGADSL mode (RFC4706 mode).

Command Format
LST-ADSLNTPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T

100 MA5616
TR165 mode: MA5616 V800R308C00
and later versions

2331 MA5608T

249 MA5600T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 459


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port performance of the device " + device-name + " frameId " + frame-number+ " slotId " + slot-
number + " portId "+ port-number
name of attributes: DID FN SN PN UpRate DwRate AtucPerfUas AtucPerfSEs AtucPerfLoss
AtucPerfFECs AtucPerfESs AturPerfUas AturPerfSEs AturPerfLoss
AturPerfFECs AturPerfESs

Output Parameter

If no mode is specified for a parameter, the parameter is supported by the NGADSL mode
(RFC4706) and TR165 mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 460


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

UpRate INTEGER 0-4294967295 Indicates the


number of
upstream bytes.
Unit: byte

DwRate INTEGER 0-4294967295 Indicates the


number of
downstream
bytes.
Unit: byte

AtucPerfUas INTEGER 0-4294967295 Indicates the


number of current
unavailable
seconds (UASs) of
the ATU-C.
Unit: s.

AtucPerfSEs INTEGER 0-4294967295 Indicates the


number of current
severely errored
seconds of the
ATU-C.
Unit: s.

AtucPerfLoss INTEGER 0-4294967295 Indicates the


number of current
loss of signal
(LOS) seconds of
the ATU-C.
Unit: s.

AtucPerfFECs INTEGER 0-4294967295 Indicates the


number of current
FEC seconds of
the ATU-C.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 461


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfESs INTEGER 0-4294967295 Indicates the


number of current
errored seconds of
the ATU-C.
Unit: s.

AturPerfUas INTEGER 0-4294967295 Indicates the


number of current
UASs of the ATU-
R.
Unit: s.

AturPerfSEs INTEGER 0-4294967295 Indicates the


number of current
severely errored
seconds of the
ATU-R.
Unit: s.

AturPerfLoss INTEGER 0-4294967295 Indicates the


number of current
LOS seconds of
the ATU-R.
Unit: s.

AturPerfFECs INTEGER 0-4294967295 Indicates the


number of current
FEC seconds of
the ATU-R.
Unit: s.

AturPerfESs INTEGER 0-4294967295 Indicates the


number of current
errored seconds of
the ATU-R.
Unit: s.

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 462


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid Check whether the port to be


queried is an ADSL port.

Example
To query the current performance statistics of ADSL port 0/13/30 on the device
named 10.144.199.35, run the following command:

LST-ADSLNTPORTPERF::DEV=10.144.199.35,FN=0,SN=13,PN=30:CTAG::;

The result is as follows:


7340178 2011-07-09 15:28:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Port performance of the device 10.144.199.35 frameId:0 slotId:13 portId:30
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
----------
DID FN SN PN UPRATE DWRATE AtucPerfUas AtucPerfSEs
AtucPerfLoss AtucPerfFECs AtucPerfESs AturPerfUas AturPerfSEs
AturPerfLoss AturPerfFECs AturPerfESs
7340178 0 13 30 726132 822577 110 0 0 16
2 110 0 0 5 3
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
----------

Related Command
● ACT-ADSLPORT
● LST-ADSLPORTHISQTRPERF

14.2.13 Querying Performance of ADSL Port in Current 15


Minutes and Last 15 Minutes (LST-ADSLPORTQTRPERF)

Usage Note
● The required ADSL port must be in the activated state.
● The performance statistics of the port must be available.
● This command applies only to the common mode (RFC2662).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 463


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-ADSLPORTQTRPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

57 MA5606T

95 MA5603T

100 MA5616

103 MA5635

249 MA5600T

2331 MA5608T

253 UA5000 (IPMB)

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 464


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port performance of the device " + device-name + " frameId " + frame-number + " slotId " + slot-
number + " portId "+ port-number
name of attributes:HecErrors PortElapsedTime Last15MinHecErrors InOctets OutOctets
TrafficElapsedTime Last15MinInOctets Last15MinOutOctets AtucPerfESs AtucPerfLofs AtucPerfLoss
AtucPerfLprs AtucPerfSES AtucPerfUAS AtucPerfInitFail AtucPerfLols AtucPerfFECS AtucInfElapsedTime
AtucPerfLast15MinESs AtucPerfLast15MinLofs AtucPerfLast15MinLoss AtucPerfLast15MinLprs
AtucPerfLast15MinSES AtucPerfLast15MinUAS AtucPerfLast15MinInitFail AtucPerfLast15MinLols
AtucPerfLast15MinFECS AturPerfESs AturPerfLofs AturPerfLoss AturPerfLprs AturPerfSES AturPerfUAS
AturPerfFECS AturInfElapsedTime AturPerfLast15MinESs AturPerfLast15MinLofs AturPerfLast15MinLoss
AturPerfLast15MinLprs AturPerfLast15MinSES AturPerfLast15MinUAS AturPerfLast15MinFECS
SessionStartTime SessionEndTime SessionUpTime Retains InitFail AtucCurrAtn AturCurrAtn
AtucCurrSnrMgn AturCurrSnrMgn AturChanCurrTxRate AtucChanCurrTxRate AtucAttainableRate
AturAttainableRate ChannelATUCElapsedTime ChannelATURElapsedTime AturCorrectedBlks
AtucCorrectedBlks Last15MinAturCorrectedBlks Last15MinAtucCorrectedBlks AturReceivedBlks
AtucReceivedBlks Last15MinAturRxBlks Last15MinAtucRxBlks AturTxBlks AtucTxBlks

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 465


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Last15MinAturTxBlks Last15MinAtucTxBlks AturUncorrectBlks AtucUncorrectBlks


Last15MinAturUncorrectBlks Last15MinAtucUncorrectBlks AtucPerfCVS AturPerfLast15MinCVS
ChannelType ntePowerStatus

Output Parameter
Parameter Type Range Description

HecErrors INTEGER 0-2147483647 Indicates the


number of HEC
error cells that are
discarded in the
current 15
minutes.
This parameter
applies only to
the
UA5000(IPMB).

PortElapsedTime INTEGER 0-900 Indicates the


elapsed time of
the port in the
current 15
minutes.
Unit: s.
This parameter
applies only to
the
UA5000(IPMB).

Last15MinHecErro INTEGER 0-2147483647 Indicates the


rs number of HEC
error cells that are
discarded in the
last 15 minutes.
This parameter
applies only to
the
UA5000(IPMB).

InOctets INTEGER 0-2147483647 Indicates the


number of bytes
that the port
receives in the
current 15
minutes.
Unit: byte.
This parameter
applies only to
the
UA5000(IPMB).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 466


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OutOctets INTEGER 0-2147483647 Indicates the


number of bytes
that the port
transmits in the
current 15
minutes.
Unit: byte.
This parameter
applies only to
the
UA5000(IPMB).

TrafficElapsedTim INTEGER 0-900 Indicates the


e elapsed time of
the traffic in the
current 15
minutes.
Unit: s.
This parameter
applies only to
the
UA5000(IPMB).

Last15MinInOctet INTEGER 0-2147483647 Indicates the


s number of bytes
that the port
receives in the last
15 minutes.
Unit: byte.
This parameter
applies only to
the
UA5000(IPMB).

Last15MinOutOct INTEGER 0-2147483647 Indicates the


ets number of bytes
that the port
transmits in the
last 15 minutes.
Unit: byte.
This parameter
applies only to
the
UA5000(IPMB).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 467


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfESs INTEGER 0-900 Indicates the


threshold of
downstream
errored seconds in
the current 15
minutes.
Unit: s.

AtucPerfLofs INTEGER 0-900 Indicates the


number of
downstream loss
of frame seconds
in the current 15
minutes.
Unit: s.

AtucPerfLoss INTEGER 0-900 Indicates the


number of
downstream loss
of signal seconds
in the current 15
minutes.
Unit: s.

AtucPerfLprs INTEGER 0-900 Indicates the


number of
downstream loss
of power seconds
in the current 15
minutes.
Unit: s.

AtucPerfSES INTEGER 0-900 Indicates the


number of
downstream
severely errored
seconds in the
current 15
minutes.
Unit: s.

AtucPerfUAS INTEGER 0-900 Indicates the


number of
downstream
unavailable
seconds in the
current 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 468


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfInitFail INTEGER 0-2147483647 Indicates the


number of
downstream
training failures in
the current 15
minutes.

AtucPerfLols INTEGER 0-900 Indicates the


number of
downstream loss
of link seconds in
the current 15
minutes.
Unit: s.

AtucPerfFECS INTEGER 0-900 Indicates the


number of
downstream FEC
seconds in the
current 15
minutes.
Unit: s.
This parameter
applies only to
the
UA5000(IPMB).

AtucInfElapsedTi INTEGER 0-900 Indicates the


me downstream
elapsed time in
the current 15
minutes.
Unit: s.

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nESs number of
downstream
errored seconds in
the last 15
minutes.
Unit: s.

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nLofs number of
downstream loss
of frame seconds
in the last 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 469


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nLoss number of
downstream loss
of signal seconds
in the last 15
minutes.
Unit: s.

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nLprs number of
downstream loss
of power seconds
in the last 15
minutes.
Unit: s.

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nSES number of
downstream
severely errored
seconds in the
last 15 minutes.
Unit: s.

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nUAS number of
downstream
unavailable
seconds in the
last 15 minutes.
Unit: s.

AtucPerfLast15Mi INTEGER 0-2147483647 Indicates the


nInitFail number of
downstream
training failures in
the last 15
minutes.

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nLols number of
downstream loss
of link seconds in
the last 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 470


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfLast15Mi INTEGER 0-900 Indicates the


nFECS number of
downstream FEC
seconds in the
last 15 minutes.
Unit: s.
This parameter
applies only to
the
UA5000(IPMB).

AturPerfESs INTEGER 0-900 Indicates the


number of
upstream errored
seconds in the
current 15
minutes.
Unit: s.

AturPerfLofs INTEGER 0-900 Indicates the


number of
upstream loss of
frame seconds in
the current 15
minutes.
Unit: s.

AturPerfLoss INTEGER 0-900 Indicates the


number of
upstream loss of
signal seconds in
the current 15
minutes.
Unit: s.

AturPerfLprs INTEGER 0-900 Indicates the


number of
upstream loss of
power seconds in
the current 15
minutes.
Unit: s.

AturPerfSES INTEGER 0-900 Indicates the


number of
upstream severely
errored seconds in
the current 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 471


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AturPerfUAS INTEGER 0-900 Indicates the


number of
upstream
unavailable
seconds in the
current 15
minutes.
Unit: s.

AturPerfFECS INTEGER 0-900 Indicates the


number of
upstream FEC
seconds in the
current 15
minutes.
Unit: s.
This parameter
applies only to
the
UA5000(IPMB).

AturInfElapsedTim INTEGER 0-900 Indicates the


e upstream elapsed
time in the
current 15
minutes.
Unit: s.

AturPerfLast15Mi INTEGER 0-900 Indicates the


nESs number of
upstream errored
seconds in the
last 15 minutes.
Unit: s.

AturPerfLast15Mi INTEGER 0-900 Indicates the


nLofs number of
upstream loss of
frame seconds in
the last 15
minutes.
Unit: s.

AturPerfLast15Mi INTEGER 0-900 Indicates the


nLoss number of
upstream loss of
signal seconds in
the last 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 472


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AturPerfLast15Mi INTEGER 0-900 Indicates the


nLprs number of
upstream loss of
power seconds in
the last 15
minutes.
Unit: s.

AturPerfLast15Mi INTEGER 0-900 Indicates the


nSES number of
upstream severely
errored seconds in
the last 15
minutes.
Unit: s.

AturPerfLast15Mi INTEGER 0-900 Indicates the


nUAS number of
upstream
unavailable
seconds in the
last 15 minutes.
Unit: s.

AturPerfLast15Mi INTEGER 0-900 Indicates the


nFECS number of
upstream FEC
seconds in the
last 15 minutes.
Unit: s.
This parameter
applies only to
the
UA5000(IPMB).

SessionStartTime OCTET STRING SIZE (32) Indicates the last


activation time of
the port.
The time is in UTC
format.

SessionEndTime OCTET STRING SIZE (32) Indicates the last


deactivation time
of the port.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 473


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SessionUpTime INTEGER 0-2147483647 Indicates the


duration in which
the port is
activated.

Retains INTEGER 0-2147483647 Indicates the


number of
successful port
trainings.
This parameter
applies only to
the
UA5000(IPMB).

InitFail INTEGER 0-2147483647 Indicates the


number of port
training failures.

AtucCurrAtn INTEGER 0-630 Indicates the


upstream channel
attenuation.
Unit: 0.1 dB.

AturCurrAtn INTEGER 0-630 Indicates the


downstream
channel
attenuation.
Unit: 0.1 dB.

AtucCurrSnrMgn INTEGER -640 to 640 Indicates the


downstream SNR
margin.
Unit: 0.1 dB.

AturCurrSnrMgn INTEGER -640 to 640 Indicates the


upstream SNR
margin.
Unit: 0.1 dB.

AturChanCurrTxRa INTEGER 32-32000 Indicates the


te transmission rate
of the upstream
channel.
Unit: kbit/s.

AtucChanCurrTxR INTEGER 32-32000 Indicates the


ate transmission rate
of the
downstream
channel.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 474


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucAttainableR- INTEGER 32-3000 Indicates the


ate maximum
attainable rate in
the downstream
direction.
Unit: kbit/s.

AturAttainableR- INTEGER 32-3000 Indicates the


ate maximum
attainable rate in
the upstream
direction.
Unit: kbit/s.

ChannelATUCElap INTEGER 0-900 Indicates the


sedTime elapsed time of
the downstream
channel in the
current 15
minutes.
Unit: s.

ChannelATURElap INTEGER 0-900 Indicates the


sedTime elapsed time of
the upstream
channel in the
current 15
minutes.
Unit: s.

AturCorrectedBlks INTEGER 0-2147483647 Indicates the


number of
upstream
corrected blocks
in the current 15
minutes.

AtucCorrectedBlks INTEGER 0-2147483647 Indicates the


number of
downstream
corrected blocks
in the current 15
minutes.

Last15MinAturCor INTEGER 0-2147483647 Indicates the


rectedBlks number of
upstream
corrected blocks
in the last 15
minutes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 475


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

Last15MinAtucCor INTEGER 0-2147483647 Indicates the


rectedBlks number of
downstream
corrected blocks
in the last 15
minutes.

AturReceivedBlks INTEGER 0-2147483647 Indicates the


number of
upstream received
blocks in the
current 15
minutes.

AtucReceivedBlks INTEGER 0-2147483647 Indicates the


number of
downstream
received blocks in
the current 15
minutes.

Last15MinAturRxB INTEGER 0-2147483647 Indicates the


lks number of
upstream received
blocks in the last
15 minutes.

Last15MinAtucRx INTEGER 0-2147483647 Indicates the


Blks number of
downstream
received blocks in
the last 15
minutes.

AturTxBlks INTEGER 0-2147483647 Indicates the


number of
upstream
transmitted blocks
in the current 15
minutes.

AtucTxBlks INTEGER 0-2147483647 Indicates the


number of
downstream
transmitted blocks
in the current 15
minutes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 476


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

Last15MinAturTxB INTEGER 0-2147483647 Indicates the


lks number of
upstream
transmitted blocks
in the last 15
minutes.

Last15MinAtucTxB INTEGER 0-2147483647 Indicates the


lks number of
downstream
transmitted blocks
in the last 15
minutes.

AturUncorrectBlks INTEGER 0-2147483647 Indicates the


number of
upstream
uncorrected
blocks in the
current 15
minutes.

AtucUncorrectBlks INTEGER 0-2147483647 Indicates the


number of
downstream
uncorrected
blocks in the
current 15
minutes.

Last15MinAturUn INTEGER 0-2147483647 Indicates the


correctBlks number of
upstream
uncorrected
blocks in the last
15 minutes.

Last15MinAtucUn INTEGER 0-2147483647 Indicates the


correctBlks number of
downstream
uncorrected
blocks in the last
15 minutes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 477


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucPerfCVS INTEGER 0-2147483647 Indicates the


downstream code
violation in the
current 15
minutes.
This parameter
applies only to
the
UA5000(IPMB).

AturPerfLast15Mi INTEGER 0-2147483647 Indicates the


nCVS upstream code
violation in the
last 15 minutes.
This parameter
applies only to
the
UA5000(IPMB).

ChannelType OCTET STRING ● Fast Indicates the


● Interleave channel working
mode.

ntePowerStatus OCTET STRING ● ON Indicates the


● OFF upstream power
status.
● Unknown

Error Code
ID Description Solution

1613561871 The performance statistics Verify that the performance


task does not exist. statistics of the specified
port is available. If the
performance statistics is not
available, create the
performance statistics
collection task for the port
on the GUI.

Example
To query the performance statistics of ADSL port 0/8/0 on the device named
10.71.60.26, run the following command:
LST-ADSLPORTQTRPERF::DEV=10.71.60.26,FN=0,SN=8,PN=0:CTAG::;
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 478


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340033 2006-12-27 16:44:15


M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Port performance
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-------------------------------------------------
HecErrors PortElapsedTime Last15MinHecErrors InOctets OutOctet
s TrafficElapsedTime Last15MinInOctets Last15MinOutOctets
AtucPerfESs AtucPerfLofs AtucPerfLoss AtucPerfLprs AtucPerfSES
AtucPerfUAS AtucPerfInitFail AtucPerfLols AtucPerfFECS AtucInfE
lapsedTime AtucPerfLast15MinESs AtucPerfLast15MinLofs AtucPerfLast15Mi
nLoss AtucPerfLast15MinLprs AtucPerfLast15MinSES AtucPerfLast15MinUAS
AtucPerfLast15MinInitFail AtucPerfLast15MinLols AtucPerfLast15MinFECS
AturPerfESs AturPerfLofs AturPerfLoss AturPerfLprs AturPerfSES
AturPerfUAS AturPerfFECS AturInfElapsedTime AturPerfLast15MinESs
AturPerfLast15MinLofs AturPerfLast15MinLoss AturPerfLast15MinLprs AturPerf
Last15MinSES AturPerfLast15MinUAS AturPerfLast15MinFECS SessionStartTime
SessionEndTime SessionUpTime Retains InitFail AtucCurrAtn
AturCurrAtn AtucCurrSnrMgn AturCurrSnrMgn AturChanCurrTxRate AtucChan
CurrTxRate AtucAttainableRate AturAttainableRate ChannelATUCElaps
edTime ChannelATURElapsedTime AturCorrectedBlks AtucCorrectedBlks
Last15MinAturCorrectedBlks Last15MinAtucCorrectedBlks AturReceivedBlks
AtucReceivedBlks Last15MinAturRxBlks Last15MinAtucRxBlks
AturTxBlks AtucTxBlks Last15MinAturTxBlks Last15MinAtucTxBlks
AturUncorrectBlks AtucUncorrectBlks Last15MinAturUncorrectBlks
Last15MinAtucUncorrectBlks AtucPerfCVS AturPerfLast15MinCVS ChannelT
yp ntePowerStatuse
0 708 0 0 0 708 0 0 -- --
-- -- -- -- 0 -- 0 -- 0 0
0 0 0 0 0 0 0 -- -- --
-- -- -- 0 -- 0 0 0 0 0
0 0 2006-12-26 17:13:55 2006-12-26 21:03:12 158437 0
0 13 -- 90 -- 1020 24473 28316 -- --
-- -- -- 0 0 -- -- 52941 49508 --
-- 49508 52941 -- -- 0 0 0 0 Interlea
ve ON
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 479


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-------------------------------------------------

Related Command
● ACT-ADSLPORT
● LST-ADSLPORTPERF

14.2.14 Querying the Historical 15-minute Performance


Statistics of an ADSL Port (LST-ADSLPORTHISQTRPERF)
Usage Note
This command is used to query the historical 15-minute performance statistics of
an ADSL port in TR165 mode and NGADSL mode (RFC4706 mode).

Command Format
LST-ADSLPORTHISQTRPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T

100 MA5616

2331 MA5608T

249 MA5600T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 480


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port performance of the device " + device-name + " frameId " + frame-number + " slotId " + slot-
number + " portId "+ port-number
name of attributes:DID FN SN PN AtucElapsedTime AtucFECs AtucEs AtucSEs AtucLoss AtucUAs
AturElapsedTime AturFECs AturEs AturSEs AturLoss AturUAs Last15MinAtucFECs Last15MinAtucEs
Last15MinAtucSEs Last15MinAtucLoss Last15MinAtucUAs Last15MinAturFECs Last15MinAturEs
Last15MinAturSEs Last15MinAturLoss Last15MinAturUAs FullInit FailFullInit ShortInit FailShortInit
Last15MinFullInit Last15MinFailFullInit Last15MinShortInit Last15MinFailShortInit

Output Parameter

If no mode is specified for a parameter, the parameter is supported by the NGADSL mode
(RFC4706) and TR165 mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 481


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

AtucElapsedTime INTEGER 0-900 Indicates the


elapsed time of
the ATU-C in the
current 15
minutes.
Unit: s.

AtucFECs INTEGER 0-900 Indicates the


number of
forwarding error
check (FEC)
seconds of the
ATU-C in the
current 15
minutes.
Unit: s.

AtucEs INTEGER 0-900 Indicates the


number of errored
seconds of the
ATU-C in the
current 15
minutes.
Unit: s.

AtucSEs INTEGER 0-900 Indicates the


number of
severely errored
seconds of the
ATU-C in the
current 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 482


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AtucLoss INTEGER 0-900 Indicates the


number of loss of
signal (LOS)
seconds of the
ATU-C in the
current 15
minutes.
Unit: s.

AtucUAs INTEGER 0-900 Indicates the


number of
unavailable
seconds (UASs) of
the ATU-C in the
current 15
minutes.
Unit: s.

AturElapsedTime INTEGER 0-900 Indicates the


elapsed time of
the ATU-R in the
current 15
minutes.
Unit: s.

AturFECs INTEGER 0-900 Indicates the


number of FEC
seconds of the
ATU-R in the
current 15
minutes.
Unit: s.

AturEs INTEGER 0-900 Indicates the


number of errored
seconds of the
ATU-R in the
current 15
minutes.
Unit: s.

AturSEs INTEGER 0-900 Indicates the


number of
severely errored
seconds of the
ATU-R in the
current 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 483


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AturLoss INTEGER 0-900 Indicates the


number of LOS
seconds of the
ATU-R in the
current 15
minutes.
Unit: s.

AturUAs INTEGER 0-900 Indicates the


number of
unavailable
seconds of the
ATU-R in the
current 15
minutes.
Unit: s.

Last15MinAtucFE INTEGER 0-900 Indicates the


Cs number of FEC
seconds of the
ATU-C in the last
15 minutes.
Unit: s.

Last15MinAtucEs INTEGER 0-900 Indicates the


number of errored
seconds of the
ATU-C in the last
15 minutes.
Unit: s.

Last15MinAtucSEs INTEGER 0-900 Indicates the


number of
severely errored
seconds of the
ATU-C in the last
15 minutes.
Unit: s.

Last15MinAtucLos INTEGER 0-900 Indicates the


s number of LOS
seconds of the
ATU-C in the last
15 minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 484


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

Last15MinAtucUA INTEGER 0-900 Indicates the


s number of
unavailable
seconds of the
ATU-C in the last
15 minutes.
Unit: s.

Last15MinAturFEC INTEGER 0-900 Indicates the


s number of FEC
seconds of the
ATU-R in the last
15 minutes.
Unit: s.

Last15MinAturEs INTEGER 0-900 Indicates the


number of errored
seconds of the
ATU-R in the last
15 minutes.
Unit: s.

Last15MinAturSEs INTEGER 0-900 Indicates the


number of
severely errored
seconds of the
ATU-R in the last
15 minutes.
Unit: s.

Last15MinAturLos INTEGER 0-900 Indicates the


s number of LOS
seconds of the
ATU-R in the last
15 minutes.
Unit: s.

Last15MinAturUA INTEGER 0-900 Indicates the


s number of
unavailable
seconds of the
ATU-R in the last
15 minutes.
Unit: s.

FullInit INTEGER 0-2147483647 Indicates the full


initialization times
in the current 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 485


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FailFullInit INTEGER 0-2147483647 Indicates the full


initialization
failure times in
the current 15
minutes.
Unit: s.

ShortInit INTEGER 0-2147483647 Indicates the


short initialization
times in the
current 15
minutes.
Unit: s.

FailShortInit INTEGER 0-2147483647 Indicates the


short initialization
failure times in
the current 15
minutes.
Unit: s.

Last15MinFullInit INTEGER 0-2147483647 Indicates the full


initialization times
in the last 15
minutes.
Unit: s.

Last15MinFailFullI INTEGER 0-2147483647 Indicates the full


nit initialization
failure times in
the last 15
minutes.
Unit: s.

Last15MinShortIni INTEGER 0-2147483647 Indicates the


t short initialization
times in the last
15 minutes.
Unit: s.

Last15MinFailShor INTEGER 0-2147483647 Indicates the


tInit short initialization
failure times in
the last 15
minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 486


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid Check whether the port to be


queried is an ADSL port.

Example
To query the historical 15-minute performance statistics of ADSL port 0/13/4 on
the device named 10.144.73.188, run the following command:

LST-ADSLPORTHISQTRPERF::DEV=10.144.73.188,FN=0,SN=13,PN=4:CTAG::;

The result is as follows:


7340042 2011-12-27 14:29:59
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Port performance of the device 10.144.73.188 frameId:0 slotId:13 portId:4


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------
DID FN SN PN AtucElapsedTime AtucFECs AtucEs AtucSEs AtucLoss AtucUAs
AturElapsedTime AturFECs AturEs AturSEs AturLoss AturUAs Last15MinAtucFECs
Last15MinAtucEs Last15MinAtucSEs Last15MinAtucLoss Last15MinAtucUAs Last15MinAturFECs
Last15MinAturEs Last15MinAturSEs Last15MinAturLoss Last15MinAturUAs FullInit FailFullInit
ShortInit FailShortInit Last15MinFullInit Last15MinFailFullInit Last15MinShortInit
Last15MinFailShortInit
7340042 0 13 4 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------

Related Command
● ACT-ADSLPORT
● LST-ADSLNTPORTPERF

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 487


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.2.15 Querying Bit Allocation Information About an ADSL


Port (LST-ADSLBITALLOCINFO)
Usage Note
The ADSL port must be in the activated state.
This command applies only to the NGADSL mode (RFC4706) and TR165 mode.

Command Format
LST-ADSLBITALLOCINFO::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::DIRECTION=line-direction;

Supporting Device
Device Type No. Device Type

95 MA5603T

100 MA5616

2331 MA5608T

249 MA5600T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 488


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

DIRECTION OCTET UP Indicates the -


STRING DOWN bit allocation
direction of
the ADSL
port.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The bit allot information of adsl port " + device-name + " frameId " + frame-number
+ " slotId " + slot-number + " portId "+ port-number + " direction " + line-direction
name of attributes: DID FN SN PN SubcarrierId BitInfo

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 489


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter

If no mode is specified for a parameter, the parameter is supported by the NGADSL mode
(RFC4706) and TR165 mode.

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

SubcarrierId INTEGER Indicates the ID of Indicates the ID of


the downstream the upstream/
sub-carrier. Value downstream sub-
range: 0-511 carrier.
Indicates the ID of
the upstream sub-
carrier. Value
range: 0-63

BitInfo INTEGER 0-15 Indicates bit


allocation
information about
the sub-carrier.
Unit: byte.

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid Check whether the port to be


queried is an ADSL port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 490


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query the bit allocation information about ADSL port 0/13/30 on the device
named 10.144.199.35, run the following command:

LST-
ADSLBITALLOCINFO::DEV=10.144.199.35,FN=0,SN=13,PN=30:CTAG::DIRECTION
=DOWN;

The result is as follows:


7340178 2011-07-09 15:28:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

The bit allot information of adsl port 10.144.199.35 frameId:0 slotId:13 portId:30 direction:DOWN
-------------------------------------------
DID FN SN PN SubcarrierId BitInfo
7340110 0 13 30 0 0
7340110 0 13 30 1 0
7340110 0 13 30 2 0
7340110 0 13 30 3 0
7340110 0 13 30 4 0
7340110 0 13 30 5 0
7340110 0 13 30 6 0
7340110 0 13 30 7 7
7340110 0 13 30 8 9
7340110 0 13 30 9 11
......
7340110 0 13 30 505 11
7340110 0 13 30 506 11
7340110 0 13 30 507 11
7340110 0 13 30 508 11
7340110 0 13 30 509 11
7340110 0 13 30 510 11
7340110 0 13 30 511 11
-------------------------------------------
;

Related Command
ACT-ADSL2PORT

14.2.16 Querying the U-MAC/V-MAC of an xDSL Port (LST-


XDSLPORTMACMAPING)

Usage Note
This command is used to query the U-MAC and V-MAC of an ADSL, VDSL2, or
G.fast port.

Command Format
LST-XDSLPORTMACMAPING::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 491


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

95 MA5603T

100 MA5616
● ADSL port in TR165 mode: MA5616
V800R308C00 and later versions
● VDSL2 port in common mode:
MA5616 V800R309C00 and later
versions

2331 MA5608T

249 MA5600T

2340 MA5611S

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 492


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The mac address information of xdsl port " + device-name + " frameId " + frame-number
+ " slotId " + slot-number + " portId "+ port-number
name of attributes: DID FN SN PN UMAC VMAC

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 493


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

UMAC OCTET STRING SIZE (1-17) Indicates the U-


MAC list.

VMAC OCTET STRING SIZE (1-17) Indicates the V-


MAC list.

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid Check whether the port to be


queried is an ADSL, VDSL2, or
G.fast port.

Example
To query the U-MAC and V-MAC of xDSL port 0/13/30 on the device named
10.144.199.35, run the following command:
LST-XDSLPORTMACMAPING::DEV=10.144.199.35,FN=0,SN=13,PN=30:CTAG::;
The result is as follows:
7340178 2011-07-09 15:28:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=10
blktotal=10

The mac address information of xdsl port 10.144.199.35 frameId:0 slotId:13 portId:30
--------------------------------
DID FN SN PN UMAC VMAC
7340110 0 13 30 00-50-BA-50-73-2E 02-00-00-06-0A-40

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 494


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340110 0 13 30 00-50-BA-50-73-25 02-00-00-06-0A-41


7340110 0 13 30 00-50-BA-50-73-26 02-00-00-06-0A-42
7340110 0 13 30 00-50-BA-50-73-27 02-00-00-06-0A-43
7340110 0 13 30 00-50-BA-50-73-28 02-00-00-06-0A-44
7340110 0 13 30 00-50-BA-50-73-29 02-00-00-06-0A-45
7340110 0 13 30 00-50-BA-50-73-2A 02-00-00-06-0A-46
7340110 0 13 30 00-50-BA-50-73-2B 02-00-00-06-0A-47
7340110 0 13 30 00-50-BA-50-73-2C 02-00-00-06-0A-48
7340110 0 13 30 00-50-BA-50-73-2D 02-00-00-06-0A-49
--------------------------------

Related Command
● ACT-ADSLPORT
● ACT-VDSL2PORT
● ACT-GFASTPORT

14.3 Querying G.SHDSL Resources


This topic provides the commands and examples for querying G.SHDSL resources,
including the G.SHDSL ports, profiles, alarms, and performance statistics.

14.3.1 Querying the Chipset Mode of a Board (LST-


SHDSLBOARDCHIPSETMODE)
Usage Note
None

Command Format
LST-SHDSLBOARDCHIPSETMODE::(DID=Device-ID|DEV=Device-name),(FN=Frame-num),(SN=Slot-
num):CTAG::(CHIPSETID=chipset-index);

Supporting Device
Device Type No. Device Type

249 MA5600T

2331 MA5608T

95 MA5603T

100 MA5616

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 495


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

CHIPSETID INTEGER 0-3 Indicates the -


chipset ID of
the board.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Lst gshdslBoardMode "+device-name
name of attributes: DID FN SN CHIPSETID ChipSetMode

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 496


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

CHIPSETID INTEGER 0-3 Indicates the


chipset ID of the
board.

ChipSetMode OCTET STRING ATM Indicates the


PTM chipset mode of
the board.

Error Code
None

Example
To query the chipset mode of the board that resides in slot 16, subrack 0 of the
device 10.78.217.218, with chipset ID of 2, run the following command:

LST-
SHDSLBOARDCHIPSETMODE::DEV=10.78.217.218,FN=0,SN=16:111::CHIPSETID=
2;

The result is as follows:


7340033 2009-09-10 09:31:07
M 111 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Lst gshdslBoardMode 10.78.217.218 Frame number:0 Slot number:16


----------------------------------------
DID FN SN CHIPSETID ChipSetMode
7340033 0 16 2 ATM
----------------------------------------

Related Command
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 497


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.3.2 Querying the Details of an SHDSL Port (LST-


SHDSLPORTDETAILINFO)
Usage Note
This command is used to query the details of an SHDSL port. The device ID (or
device name), subrack ID, slot ID, and port ID are mandatory for the command.

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

Command Format
LST-SHDSLPORTDETAILINFO::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::[SHOWOPTION=MODE RATE LINEATTENUATION LINESNRMARGIN PPPOE OPTION82
BINDMODE BINDMAINPORT BINDNUM CHPMODE TRAPSWITCH];

Supporting Device
Device Type No. Device Type

44 MA5600V3

95 MA5603T

100 MA5616

103 MA5635

219 UA5000 (PVM)

249 MA5600T

253 UA5000 (IPMB)

2331 MA5608T

57 MA5606T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 498


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 499


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● MODE Specifies the -


N STRING ● RATE optional
attributes
● LINEATTE that can be
NUATION displayed.
● LINESNRM ● If you do
ARGIN not set this
● PPPOE parameter,
● OPTION82 the
optional
● BINDMOD attributes
E are not
● BINDMAIN displayed.
PORT ● If you set
● BINDNUM this
● CHPMODE parameter,
the
● TRAPSWIT
optional
CH
attributes
● GroupPayl are
oadRate displayed.
● COVENDO
RID
● COVENDO
RMODE
● COVENDO
RSN
● COSOFTW
ARE
● CPEVENDO
RID
● CPEVENDO
RMODE
● CPEVENDO
RSN
● CPESOFTW
ARE

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= "Port attributes of the device" + device-name + " frameId "+ frame-number + " slotId "+ slot-number
+ " portId "+ port-number
name of attributes: DID FN SN PN Alias Status LineProfile AlarmProfile VPI VCI Priority
LastActiveTime UnitID UnitSide PowerBackoff WirePair MaxLineRate PracticeLineRate CurrTranMode
LoopAttenuation

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 500


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EndpointSNRMargin MODE RATE LINEATTENUATION LINESNRMARGIN PPPOE OPTION82 BINDMODE


BINDMAINPORT BINDNUM CHPMODE TRAPSWITCH

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Alias OCTET STRING SIZE (64) Indicates the alias


NOTE of the port.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 32 digit.

Status OCTET STRING See Table B-5. Indicates the


status of the port.

LineProfile OCTET STRING SIZE (32) Indicates the


name of the line
profile.

AlarmProfile OCTET STRING SIZE (32) Indicates the


name of the
alarm profile.

VPI INTEGER 0-4095 Indicates the


virtual path
identifier.
Only the MA5300
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 501


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VCI INTEGER 32-65535 Indicates the


virtual channel
identifier.
Only the MA5300
supports this
parameter.

Priority INTEGER 0-7 Indicates the IP


precedence of the
port.

LastActiveTime OCTET STRING SIZE (32) Indicates the time


of the last
activation.

UnitID OCTET STRING ● NetworkSide Indicates a local


● CustomerSide HDSL2 unit or
SHDSL unit that is
referenced.

UnitSide OCTET STRING ● NetworkSide Indicates a


● CustomerSide remote HDSL2
unit or SHDSL
unit that is
referenced.

PowerBackoff OCTET STRING ● Default Indicates the


● Enhanced power mode of a
backplane.

WirePair OCTET STRING ● One pair In the case of the


● Two pair EFM binding, this
parameter is
● Three pair displayed as -. In
● Four pair the case of the M-
pair binding, this
parameter is
displayed as
Second pair,
Third pair, or
Fourth pair. If the
port is not bound,
this parameter is
displayed as First
pair.

MaxLineRate INTEGER 0-4294967295 Indicates the


maximum
attainable rate.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 502


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PracticeLineRate INTEGER 0-4294967295 Indicates the


actual rate limit
on a port.
Unit: kbit/s.

CurrTranMode OCTET STRING ● ITU-T G.991.2 Indicates the


Annex A current power
● ITU-T G.991.2 spectral density
Annex B (PSD) regional
setting.
● ITU-T G.991.2
Annex A&B

LoopAttenuation INTEGER -127 to +128 Indicates the


power
attenuation of the
current channel.
Unit: dB.

EndpointSNRMarg INTEGER -127 to +128 Indicates the


in current SNR
margin.
Unit: dB.

MODE OCTET STRING ● FE1 Indicates the


● V35 module type.

RATE INTEGER 3-32 In the case of the


FE1 mode, this
parameter is
always 32. In the
case of the V35
mode, this
parameter ranges
from 3 to 32.

LINEATTENUATIO INTEGER 0-127 Indicates the line


N attenuation.

LINESNRMARGIN INTEGER -127 to +127 Indicates the line


SNR.

PPPOE OCTET STRING ● ON Specifies whether


● OFF the PPPoE
function is
enabled.
Currently, only the
MA5600T,
MA5603T and
MA5606T support
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 503


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTION82 OCTET STRING ● ON Specifies whether


● OFF the option 82
function is
enabled.
Currently, only the
MA5600T,
MA5603T and
MA5606T support
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 504


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

BINDMODE OCTET STRING ● UNBIND Indicates the


● M-PAIR binding mode of
the port.
● EFM
The meanings of
the options are as
follows:
● UNBIND: The
port is not
bound.
● M-PAIR: The
port is bound
in the M-pair
mode.
Currently, the
system
supports the
function of
binding two,
three, or four
ports.
● EFM: The port
is bound in the
EFM mode.
The ports
bound in the
EFM mode can
be configured
with different
line profile.
The binding
group is not
affected when
a port in the
binding group
is offline.
Currently, only the
UA5000 (IPMB),
MA5600T,
MA5603T and
MA5608T
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 505


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

BINDMAINPORT INTEGER 0-62 Indicates the


number of the
master port in the
bound ports.
The value of this
parameter is
displayed as --
when the
BINDMODE
parameter is set
to UNBIND.
Currently, only the
UA5000 (IPMB),
MA5600T,
MA5603T and
MA5608T
supports this
parameter.

BINDNUM INTEGER 2-4 Indicates the


number of bound
ports.
The value of this
parameter is
displayed as --
when the
BINDMODE
parameter is set
to UNBIND.
Currently, only the
UA5000 (IPMB),
MA5600T,
MA5603T and
MA5608T
supports this
parameter.

CHPMODE OCTET STRING ● ATM Indicates the


● PTM mode of the
SHDSL chip
● TDM group.
Currently, only the
MA5600T and
MA5603T support
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 506


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRAPSWITCH OCTET STRING ● ON Specifies whether


● OFF the trap function
is enabled.
Options are as
follows:
● ON: reports
alarms from
ports to the
NCE.
● OFF:
suppresses
alarms from
ports.

GroupPayloadRat INTEGER 0–4294967295 Actual payload


e line rate of group
EFM.
Unit: kbit/s
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

COVENDORID OCTET STRING SIZE (32) Indicates the


vendor ID of the
ATU-C.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

COVENDORMOD OCTET STRING SIZE (32) Indicates the


E model of the
vendor of the
ATU-C.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 507


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COVENDORSN OCTET STRING SIZE (32) Indicates the


serial number of
the vendor of the
ATU-C.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

COSOFTWARE OCTET STRING SIZE (32) Indicates the


version of the
ATU-C.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

CPEVENDORID OCTET STRING SIZE (32) Indicates the


vendor ID of the
ATU-R.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

CPEVENDORMOD OCTET STRING SIZE (32) Indicates the


E model of the
vendor of the
ATU-R.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

CPEVENDORSN OCTET STRING SIZE (32) Indicates the


serial number of
the vendor of the
ATU-R.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 508


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPESOFTWARE OCTET STRING SIZE (32) Indicates the


version of the
ATU-R.
Currently, only the
MA5600T,
MA5603T and
MA5608T support
this parameter.

Error Code
ID Description Solution

1611268098 Querying the details of Check whether the failure to query


the ports fails. the details of the ports is caused by
network delay or discarded packets.
Check whether the device supports
the query of port details.

Example
To query the details of SHDSL port 0/2/31 on the device named 10.78.217.111,
run the following command:
LST-
SHDSLPORTDETAILINFO::DEV=10.78.217.111,FN=0,SN=2,PN=31:62::SHOWOPTI
ON=BINDMODE BINDMAINPORT BINDNUM;
The result is as follows:
7340034 2010-11-19 22:36:40
M 62 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
G.SHDSL Port Detail Information of the Device 10.78.217.111 Frame number 0 slot ID 2 port ID 31
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------------
DID FN SN PN Alias Status LineProfile AlarmProfile VPI VCI Priority LastActiveTime
UnitID UnitSide PowerBackoff WirePair MaxLineRate PracticeLineRate CurrTranMode
LoopAttenuation EndpointSNRMargin BINDMODE BINDMAINPORT BINDNUM
7340034 0 2 31 -- Activating DEFVAL TDM_E1 DEFVAL -- -- -- -- STU-C
CustomerSide Default One pair -- -- -- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 509


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
● LST-SHDSLPORTPERF
● LST-SHDSLPORTALARM

14.3.3 Querying the List of SHDSL Line Profiles (LST-


SHDSLSPANPROFILE)

Usage Note
The device line profiles must exist.

Command Format
LST-SHDSLSPANPROFILE:::CTAG::DT=device-type[,SPANPROFID=line profile][,SCOPEPROFID=Scope-profile-
name];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

253 UA5000 (IPMB)

57 MA5606T

100 MA5616

2331 MA5608T

95 MA5603T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

SPANPROFID OCTET SIZE (32) Indicates the -


STRING name of the
global line
profile.

SCOPEPROFI OCTET SIZE (32) Indicates the -


D STRING device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 510


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=G.SHDSL Activation Profile of the device type + device-type
SPANPROFID

Output Parameter
Parameter Type Range Description

SPANPROFID OCTET STRING SIZE (32) Indicates the


name of the
global line profile.

Error Code
ID Description Solution

2686058 Invalid parameter or value of Verify that the command is


498 parameter is wrong. correct according to the
following requirements:
● The parameter values do not
exceed the ranges of the
parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

Example
To query the list of the names of the SHDSL line profile of the UA5000 (IPMB),
run the following command:

LST-SHDSLSPANPROFILE:::1::DT=253;

The result is as follows:


0 2005-09-08 20:08:31
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
G.SHDSL Activation Profile of the device type UA5000 (IPMB)
---------------
SPANPROFID
shmi
---------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 511


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
LST-SHDSLSPANPROFILEDETAIL

14.3.4 Querying the Details of an SHDSL Line Profile (LST-


SHDSLSPANPROFILEDETAIL)

Usage Note
The specified SHDSL line profile must exist.

Command Format
LST-SHDSLSPANPROFILEDETAIL:::CTAG::DT=device-type,SPANPROFID=line profile[,SCOPEPROFID=Scope-
Profile-Name][,SHOWOPTION=MODULATIONMODE FRAMETYPE CLKALIGN REFERENCECLOCK
SCOPEPROFID];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

253 UA5000 (IPMB)

100 MA5616

2331 MA5608T

95 MA5603T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

SPANPROFID OCTET SIZE (32) Indicates the -


STRING name of the
line profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 512


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● MODULATI (Optional) -


N STRING ONMODE Specifies the
● FRAMETYP attributes
E that can be
displayed in
● CLKALIGN the returned
● REFERENC result. If you
ECLOCK set this
● SCOPEPRO parameter,
FID the
corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="G.SHDSL Activation Profile" + SPANPROFID + "of the device type "+device-type
SPANPROFID SPANIFMODE SPANMINTRRT SPANMAXTRRT SPANPSD
SPANTRMODE SPANREMOTEEN SPANCCTMD SPANWCTMD
SPANCCTMU SPANWCTMU SPANUTMDC SPANUTMDW SPANUTMUC
SPANUTMUW SPANLPEN PATHMODE
MODULATIONMODE FRAMETYPE CLKALIGN REFERENCECLOCK SCOPEPROFID

Output Parameter
Parameter Type Range Description

SPANPROFID OCTET STRING - Indicates the


name of the
global line profile.

SPANIFMODE OCTET STRING ● 2 Wire Indicates the line


● 4 Wire interface mode
(two-wire, four-
● 6 Wire wire, six-wire, or
● 8 Wire eight-wire).
NOTE
For information
about the devices
that support the
six-wire or eight-
wire mode, see
Line Transmission
Rate.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 513


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SPANMINTRRT INTEGER 192 kbit/s-22784 Indicates the


kbit/s. For details, minimum line
see Line transmission rate.
Transmission The line
Rate. transmission rate
varies according
to the specific
device. For details,
see Line
Transmission
Rate.
Unit: kbit/s.

SPANMAXTRRT INTEGER 192 kbit/s-22784 Indicates the


kbit/s. For details, maximum line
see Line transmission rate.
Transmission The line
Rate. transmission rate
varies according
to the specific
device. For details,
see Line
Transmission
Rate.
Unit: kbit/s.

SPANPSD OCTET STRING ● Symmetric Indicates the PSD


● Asymmetric mode.

SPANTRMODE OCTET STRING ● G.991.2 Annex Indicates the line


A transmission
● G.991.2 Annex mode.
B
● G.991.2 Annex
A&B

SPANREMOTEEN OCTET STRING ● Yes Specifies whether


● No to enable the
remote
configuration
management
function.

SPANCCTMD INTEGER 0-10 Indicates the


downstream SNR
margin.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 514


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SPANWCTMD INTEGER 0-10 Indicates the


downstream SNR
margin in the
worst situation.
Unit: dB.

SPANCCTMU INTEGER 0-10 Indicates the


upstream SNR
margin.
Unit: dB.

SPANWCTMU INTEGER 0-10 Indicates the


upstream SNR
margin in the
worst situation.
Unit: dB.

SPANUTMDC OCTET STRING ● Yes Specifies whether


● No to enable the
current
downstream
target SNR
margin.

SPANUTMDW OCTET STRING ● Yes Specifies whether


● No to enable the
downstream
target SNR
margin in the
worst situation.

SPANUTMUC OCTET STRING ● Yes Specifies whether


● No to enable the
current upstream
target SNR
margin.

SPANUTMUW OCTET STRING ● Yes Specifies whether


● No to enable the
upstream target
SNR margin in the
worst situation.

SPANLPEN OCTET STRING ● Yes Specifies whether


● No to enable the
probe function.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 515


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PATHMODE OCTET STRING ● ATM Indicates the line


● PTM transmission
mode.
NOTE
This parameter is
valid only for the
MA5600
V300R003C03,
UA5000IPMB
V100R017,
MA5606T, and
later versions.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 516


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MODULATIONM OCTET STRING ● Auto Indicates the


ODE ● Tcpam16 modulation mode,
that is, the
● Tcpam32 digital-to-analog
conversion mode.
The options are as
follows:
● AUTO:
Indicates that
the
transmission
rate is
dynamically
generated by
the host.
● TCPAM-16:
Indicates that
the rate range
is 192-3840
kbit/s.
● TCPAM-32:
Indicates that
the supported
rate range is
768-5696
kbit/s.
NOTE
This parameter is
applicable only to
the following
devices:
● MA5600T:
MA5600
V800R008C01
or later
versions
● MA5603T:
MA5603
V800R008 or
later versions
● MA5600V3:
MA5600
V300R003C03B
072 or later
versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 517


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FRAMETYPE OCTET STRING ● E1 Indicates the


● V35 frame mode.
NOTE
This parameter is
applicable only to
the following
devices:
● MA5600T:
MA5600
V800R008C01
or later
versions
● MA5603T:
MA5603
V800R008 or
later versions

CLKALIGN OCTET STRING ● Syn Indicates the clock


● NotSyn synchronization
mode.
The options are as
follows:
● Syn:
synchronous
● NotSyn:
asynchronous
NOTE
This parameter is
applicable only to
the following
devices:
● MA5600T:
MA5600
V800R008C01
or later
versions
● MA5603T:
MA5603
V800R008 or
later versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 518


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

REFERENCECLOCK OCTET STRING ● FreeRun Indicates the clock


● System mode.
The options are as
follows:
● FreeRun: local
lock
● System: system
lock
NOTE
This parameter is
applicable only to
the following
devices:
● MA5600T:
MA5600
V800R008C01
or later
versions
● MA5603T:
MA5603
V800R008 or
later versions

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

1026908 G.SHDSL Line Profile does not Ensure that the entered profile
29 exist name is correct.

Example
To query the details of the SHDSL line profile named jet1 on the UA5000 (IPMB),
run the following command:
LST-SHDSLSPANPROFILEDETAIL:::
1::DT=253,SPANPROFID=jet1,SHOWOPTION=MODULATIONMODE FRAMETYPE
CLKALIGN REFERENCECLOCK;
The result is as follows:
0 2005-09-08 20:11:21
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 519


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktotal=1

G.SHDSL Activation Profile jet1 of the device type UA5000 (IPMB)


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------
SPANPROFID SPANIFMODE SPANMINTRRT SPANMAXTRRT SPANPSD SPANTRMO
DE SPANREMOTEEN SPANCCTMD SPANWCTMD SPANCCTMU SPANWCTM
U SPANUTMDC SPANUTMDW SPANUTMUC SPANUTMUW SPANLPEN
PATHMODE MODULATIONMODE FRAMETYPE CLKALIGN REFERENCECLOCK
jet1 2 Wire 256 256 Symmetric G.991.2 Annex A. Yes
0 0 0 0 Yes No No No No PTM
Auto E1 Syn System
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------
;

Related Command
LST-SHDSLSPANPROFILE

14.3.5 Querying the Devices That Reference an SHDSL Line


Profile (LST-DEVBYSP)
Usage Note
This command is used to query the devices that reference an SHDSL line profile.

Command Format
LST-DEVBYSP:::CTAG::DT=device-type,SPANPROFID=line profile;

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

253 UA5000(IPMB)

100 MA5616

95 MA5603T

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 520


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

SPANPROFID OCTET SIZE (32) Indicates the -


STRING name of the
line profile.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="device list which cite the span profile" + span profile + "of the device type" +device-type
name of attributes: DID DEV

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 521


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not Ensure that the entered profile
exist. name is correct. If the profile
name is correct, it indicates that
the SHDSL line profile is not
referenced by any device.

Example
To query the UA5000 (IPMB) that references the SHDSL line profile named jet1,
run the following command:

LST-DEVBYSP:::1::DT=253,SPANPROFID=jet1;

The result is as follows:


0 2005-09-08 20:12:45
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
port list which cite the span profile jet1 of the device type UA5000(IPMB)
-------------
DID DEV
7729154 10.71.62.38
-------------
;

Related Command
LST-PORTBYSP

14.3.6 Querying the Ports That Reference an SHDSL Line


Profile (LST-PORTBYSP)

Usage Note
This command is used to query the ports that reference an SHDSL line profile.

Command Format
LST-PORTBYSP::(DID=Device-ID|DEV=Device-name):CTAG::SPANPROFID=line profile;

Supporting Device
Device Type No. Device Type

44 MA5600V3

95 MA5603T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 522


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

249 MA5600T

57 MA5606T

2331 MA5608T

253 UA5000 (IPMB)

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

SPANPROFID OCTET SIZE (32) Indicates the -


STRING name of the
line profile.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 523


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="port list which cite the span profile"+ span profile + "on the device" +device-name
name of attributes: DID DEV FN SN PN

Output Parameter
Parameter Type Range Description

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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 524


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058498 Invalid parameter or Verify that the command is


value of parameter is correct according to the
wrong. following requirements:
● The parameter values do not
exceed the ranges of the
parameters specified by the
command.
● The entered parameter
names are correct.
● The parameters are entered
in the correct order.

2686058552 The resource does not The required port does not
exist. reference the SHDSL line profile.

Example
To query the ports that are located on the device named 10.71.62.38 and that
reference the SHDSL line profile jet1, run the following command:

LST-PORTBYSP::DEV=10.71.62.38:1::SPANPROFID=jet1;

The result is as follows:


0 2005-09-08 20:13:31
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2
port list which cite the span profile jet1 on the device10.71.62.38
-------------------------
DID DEV FN SN PN
7729154 10.71.62.38 0 12 0
7729154 10.71.62.38 0 14 13
-------------------------
;

Related Command
LST-DEVBYSP

14.3.7 Querying the List of SHDSL Alarm Profiles (LST-


SHDSLALARMPROFILE)

Usage Note
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 525


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-SHDSLALARMPROFILE:::CTAG::DT=device-type[,ALARMPROFID=alarm-profile-name]
[,SCOPEPROFID=Scope-profile-name];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

100 MA5616

95 MA5603T

2331 MA5608T

253 UA5000 (IPMB)

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

ALARMPROFI OCTET SIZE (32) Indicates the -


D STRING name of the
alarm profile.

SCOPEPROFI OCTET SIZE (32) Indicates the -


D STRING device scope
profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="G.SHDSL Activation Profile of the device type " + device-type
ALARMPROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 526


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

ALARMPROFID OCTET STRING SIZE (32) Indicates the


name of the
alarm profile.

Error Code
ID Description Solution

2686058 Invalid parameter or value of Verify that the command is


498 parameter is wrong. correct according to the
following requirements:
● The parameter values do not
exceed the ranges of the
parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

2686058 The resource does not exist. The required profile does not
552 exist.

Example
To query the list of the alarm profiles on the UA5000 (IPMB), run the following
command:

LST-SHDSLALARMPROFILE:::1::DT=253;

The result is as follows:


0 2005-09-08 20:20:13
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
G.SHDSL Activation Profile of the device type UA5000 (IPMB)
----------------
ALARMPROFID
DEFVAL
----------------
;

Related Command
LST-SHDSLALARMPROFILEDETAIL

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 527


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.3.8 Querying the Details of an SHDSL Alarm Profile (LST-


SHDSLALARMPROFILEDETAIL)
Usage Note
The specified SHDSL alarm profile must exist.

Command Format
LST-SHDSLALARMPROFILEDETAIL:::CTAG::DT=device-type,ALARMPROFID=alarm-profile-
name[,SCOPEPROFID=Scope-Profile-Name][,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

100 MA5616

95 MA5603T

2331 MA5608T

253 UA5000 (IPMB)

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

ALARMPROFI OCTET SIZE (32) Indicates the -


D STRING name of the
alarm profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 528


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="G.SHDSL Activation Profile" + SPANPROFID + "of the device type"+ device-type:
ALARMPROFID ALARMTHLA ALARMTHSNRM ALARMTHES ALARMTHSES ALARMTHCRCA
ALARMTHLOSWS ALARMTHUAS SCOPEPROFID

Output Parameter
Parameter Type Range Description

ALARMPROFID OCTET STRING SIZE (32) Indicates the


name of the
alarm profile.

ALARMTHLA INTEGER 0-127 Indicates the loop


attenuation
threshold.
Unit: dB.

ALARMTHSNRM INTEGER 0-15 Indicates the


threshold of the
SNR margin.
Unit: dB.

ALARMTHES INTEGER 0-900 Indicates the


threshold of the
error seconds in
15 minutes.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 529


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALARMTHSES INTEGER 0-900 Indicates the


threshold of the
severe errored
seconds in 15
minutes.
Unit: s.

ALARMTHCRCA INTEGER 0-58981500 Indicates the


duration threshold
of the abnormal
CRC.

ALARMTHLOSWS INTEGER 0-900 Indicates the


duration threshold
of the LOSW fault
in 15 minutes.
Unit: s.

ALARMTHUAS INTEGER 0-900 Indicates the


threshold of the
unavailable
seconds in 15
minutes.
Unit: s.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

1026294 The profile does not exist. Verify that the entered profile
27 name is correct.

Example
To query the details of the SHDSL alarm profile DEFVAL of the UA5000 (IPMB),
run the following command:
LST-SHDSLALARMPROFILEDETAIL:::1::DT=253,ALARMPROFID=DEFVAL;
The result is as follows:
0 2005-09-08 20:21:12
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 530


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktotal=1
G.SHDSL Activation Profile DEFVAL of the device type UA5000 (IPMB)
--------------------------------------------------------------------------------
----------------------
ALARMPROFID ALARMTHLA ALARMTHSNRM ALARMTHES ALARMTHSES
ALARMTHCRCA ALARMTHLOSWS ALARMTHUAS
DEFVAL 0 0 0 0 0 0 0
--------------------------------------------------------------------------------
----------------------
;

Related Command
LST-SHDSLALARMPROFILE

14.3.9 Querying the Devices That Reference an SHDSL Alarm


Profile (LST-DEVBYAL)

Usage Note
This command is used to query the devices that reference the specified SHDSL
alarm profile.

Command Format
LST-DEVBYAL:::CTAG::DT=device-type,ALARMPROFID=alarm-profile-name;

Supporting Device
Device Type No. Device Type

44 MA5600V3

249 MA5600T

57 MA5606T

100 MA5616

95 MA5603T

253 UA5000(IPMB)

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 531


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ALARMPROFI OCTET SIZE (32) Indicates the -


D STRING name of the
alarm profile.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="device list which cite the alarm profile " + alarm profile + " of the device type "+device-type
name of attributes:DID DEV

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

Error Code
ID Description Solution

2686058 The resource does not exist. Ensure that the entered profile
552 name is correct. If the profile
name is correct, it indicates that
the SHDSL line profile is not
referenced by any device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 532


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query the UA5000 (IPMB) that references the SHDSL alarm profile named
DEFVAL, run the following command:
LST-DEVBYAL:::1::DT=253,ALARMPROFID=DEFVAL;
The result is as follows:
0 2005-09-08 20:15:54
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
port list which cite the alarm profile DEFVAL of the device type UA5000(IPMB)
-------------
DID DEV
7729154 10.71.62.38
-------------
;

Related Command
LST-PORTBYAL

14.3.10 Querying the Ports That Reference an SHDSL Alarm


Profile (LST-PORTBYAL)
Usage Note
This command is used to query the ports that reference the specified SHDSL alarm
profile.

Command Format
LST-PORTBYAL::(DID=Device-ID|DEV=Device-name):CTAG::ALARMPROFID=alarm-profile-name;

Supporting Device
Device Type No. Device Type

44 MA5600V3

95 MA5603T

249 MA5600T

57 MA5606T

2331 MA5608T

100 MA5616

253 UA5000 (IPMB)

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 533


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

ALARMPROFI OCTET SIZE (32) Indicates the -


D STRING name of the
alarm profile.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="port list which cite the alarm profile " + alarm profile + " on the device "+device-name
name of attributes:DID DEV FN SN PN
;

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 534


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

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 A.8
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.

Error Code
ID Description Solution

2686058 Invalid parameter or value of Verify that the command is


498 parameter is wrong. correct according to the
following requirements:
● The parameter values do not
exceed the ranges of the
parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

2686058 The resource does not exist. The required port does not
552 reference the specified SHDSL
alarm profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 535


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query the ports that reference the SHDSL alarm profile named DEFVAL on the
device named 10.71.62.38, run the following command:
LST-PORTBYAL::DEV=10.71.62.38:1::ALARMPROFID=DEFVAL;
The result is as follows:
0 2005-09-08 20:19:20
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=48
blktotal=48
port list which cite the alarm profile DEFVAL on the device10.71.62.38
-------------------------
DID DEV FN SN PN
7729154 10.71.62.38 0 10 0
7729154 10.71.62.38 0 10 1
7729154 10.71.62.38 0 10 2
7729154 10.71.62.38 0 10 3
7729154 10.71.62.38 0 10 4
?-?-
7729154 10.71.62.38 0 14 5
7729154 10.71.62.38 0 14 6
7729154 10.71.62.38 0 14 7
7729154 10.71.62.38 0 14 8
7729154 10.71.62.38 0 14 9
7729154 10.71.62.38 0 14 10
7729154 10.71.62.38 0 14 11
7729154 10.71.62.38 0 14 12
7729154 10.71.62.38 0 14 13
7729154 10.71.62.38 0 14 14
7729154 10.71.62.38 0 14 15
-------------------------
;

Related Command
LST-DEVBYAL

14.3.11 Querying the Alarm Information About an SHDSL Port


(LST-SHDSLPORTALARM)
Usage Note
This command is used to query the required alarm information about an SHDSL
port in the system.

Command Format
LST-SHDSLPORTALARM::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 536


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) If the value of -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="alarm on Port of the device " + device name + "frameId" + frame number + "slotId" + slot-number +
"portId"+ port ID
name of attributes: SerialNo FaultID Severity FunctionType strName ReasonID
Reason Repair Meaning FaultFlag faultTime ackTime clearTime strAckUserName Location

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 537


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Description

SerialNo INTEGER Indicates the serial


number generated by
the daemon.

FaultID INTEGER Indicates the alarm or


event ID. This parameter
and the device are used
to identify an alarm or
event.

Severity INTEGER Indicates the alarm


severity or event level.

FunctionType INTEGER Indicates the type of the


alarm or event.

strName OCTET STRING Indicates the name of


the alarm or event.

ReasonID INTEGER Indicates the cause ID of


the alarm.

Reason OCTET STRING Indicates the alarm


cause.

Repair OCTET STRING Indicates the suggestion


for clearing the alarm.

Meaning OCTET STRING Indicates the description


of the alarm.

FaultFlag INTEGER Indicates the type of the


fault.

faultTime OCTET STRING Indicates the time when


the alarm or event is
generated.
The time is in UTC
format.

ackTime OCTET STRING Indicates the time when


the alarm is
acknowledged.
The time is in UTC
format.

clearTime OCTET STRING Indicates the time when


the alarm is cleared.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 538


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Description

strAckUserName OCTET STRING Indicates the


acknowledged username.

Location OCTET STRING Indicates the location of


the alarm or event.

Error Code
ID Description Solution

1610612784 Querying alarm Verify that the traps


information failed. reporting function is
enabled on the server.

1610612785 Getting alarm ● Verify that the alarm


information timed out. module runs in the
normal state.
● Verify that the device
is online.

1612644886 No port alarm -


information.

Example
To query the alarm information about SHDSL port 0/5/9 on the MA5600_30, run
the following command:

LST-SHDSLPORTALARM::DEV=MA5600_30,FN=0,SN=5,PN=9:2::;

The result is as follows:


7340033 2008-05-20 12:16:40
M 2 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

alarm on Port of the device MA5600_30 frameId 0 slotId 5 portId 9


----------------------------------------------------------------------------------------------------------------------
SerialNo FaultID Severity FunctionType strName ReasonID Reason Repair Meaning
FaultFlag faultTime ackTime clearTime strAckUserName Location
210 170918060 4 9 G.SHDSL Port manual deactivation 167772321 The user inputs
the deactivation command. No need to proceed G.SHDSL Port manual deactivation. 0
2008-5-28 7:41:13 -- -- -- FRAME=0 SLOT=5 SUBSLOT=65535 PORT=9
----------------------------------------------------------------------------------------------------------------------
;

Related Command
● LST-SHDSLPORTDETAILINFO

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 539


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● LST-SHDSLPORTPERF

14.3.12 Querying the Performance Statistics of a G.SHDSL Port


(LST-SHDSLPORTPERF)
Usage Note
This command is used to query the performance statistics on a specified G.SHDSL
port of a device. The required G.SHDSL port must be in the activated state.

Command Format
LST-SHDSLPORTPERF::(DID=device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-num:CTAG::
[SHOWOPTION=TOTALINOCTETS TOTALOUTOCTETS];

Supporting Device
Device Type No. Device Type

44 MA5600V3

100 MA5616

253 UA5000 (IPMB)

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 540


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 541


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● TOTALINO Specifies the -


N STRING CTETS attributes
● TOTALOUT that can be
OCTETS displayed in
the returned
result. If this
parameter is
not set, the
corresponding
attributes are
not displayed.
If you set this
parameter,
the
corresponding
attributes are
displayed.
The MA5600
V300R003C05
and the later
versions
support this
parameter.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port performance of the device " + device-name + " frameId " + frame-number + " slotId " + slot-
number + " portId "+ port-number
name of attributes:
HecErrors
PortElapsedTime
Last15MinHecErrors
InOctets
OutOctets
PortElapsedTime
Last15MinInOctets
Last15MinOutOctets
NTEPowerStatus
SessionStartTime
SessionEndTime
SessionUpTime
Retains
InitFail
StucCurrAtn
SturCurrAtn
StucCurrSnrMgn
SturCurrSnrMgn
ChanCurrTxRate
AttainableRate
ChannelElapsedTime
SturCRCAnomalies
StucCRCAnomalies
SturLast15MinCRCAnomalies

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 542


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

StucLast15MinCRCAnomalies
SturES
StucES
SturLast15MinES
StucLast15MinES
SturSES
StucSES
SturLast15MinSES
StucLast15MinSES
SturUAS
StucUAS
SturLast15MinUAS
StucLast15MinUAS
SturLOSWS
StucLOSWS
SturLast15MinLOSWS
StucLast15MinLOSWS
TOTALINOCTETS
TOTALOUTOCTETS

Output Parameter
Parameter Type Range Description

HecErrors INTEGER 0-2147483647 Indicates the


number of HEC
error cells that are
discarded in the
current 15
minutes.

PortElapsedTime INTEGER 0-900 Indicates the


elapsed time of
the port in the
current 15
minutes.
Unit: s.

Last15MinHecErro INTEGER 0-2147483647 Indicates the


rs number of HEC
error cells that are
discarded in the
last 15 minutes.

InOctets INTEGER 0-2147483647 Indicates the


number of bytes
that the port
receives in the
current 15
minutes.
Unit: byte.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 543


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OutOctets INTEGER 0-2147483647 Indicates the


number of bytes
that the port
transmits in the
current 15
minutes.
Unit: byte.

TrafficElapsedTim INTEGER 0-900 Indicates the


e elapsed time of
the traffic in the
current 15
minutes.
Unit: s.

Last15MinInOctet INTEGER 0-2147483647 Indicates the


s number of bytes
that the port
receives in the last
15 minutes.
Unit: byte.

Last15MinOutOct INTEGER 0-2147483647 Indicates the


ets number of bytes
that the port
transmits in the
last 15 minutes.
Unit: byte.

NTEPowerStatus OCTET STRING ● ON Indicates the


● OFF upstream power
status.
● UNKNOWN

SessionStartTime OCTET STRING SIZE (32) Indicates the last


activation time of
the port.
Unit: s.
The time is in UTC
format.

SessionEndTime OCTET STRING SIZE (32) Indicates the last


deactivation time
of the port.
Unit: s.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 544


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SessionUpTime INTEGER 0-2147483647 Indicates the


duration in which
the port is
activated.
Unit: s.

Retains INTEGER 0-900 Indicates the


number of
successful
trainings.

InitFail INTEGER 0-900 Indicates the


number of
training failures.

StucCurrAtn INTEGER -127-128 Indicates the


attenuation of the
loop where the
network-side
endpoint is
located.
Unit: dB.

SturCurrAtn INTEGER -127-128 Indicates the


attenuation of the
loop where the
user-side endpoint
is located.
Unit: dB.

StucCurrSnrMgn INTEGER -127-128 Indicates the SNR


margin of the
network-side
endpoint.
Unit: dB.

SturCurrSnrMgn INTEGER -127-128 Indicates the SNR


margin of the
user-side
endpoint.
Unit: dB.

ChanCurrTxRate INTEGER 0-4294967295 Indicates the


transmission rate
of the channel.
Unit: bit/s.

AttainableRate INTEGER 0-4294967295 Indicates the


maximum
available rate.
Unit: bit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 545


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

StucChannelElap- INTEGER 0-4294967295 Indicates the


sedTime elapsed time in
the current 15
minutes on the
network side.
Unit: s.

SturChannelElap- INTEGER 0-4294967295 Indicates the


sedTime elapsed time in
the current 15
minutes on the
user side.
Unit: s.

SturCRCAnomalie INTEGER 0-2147483647 Indicates the


s number of CRC
abnormalities in
the current 15
minutes on the
user side.

StucCRCAnomalie INTEGER 0-2147483647 Indicates the


s number of CRC
abnormalities in
the current 15
minutes on the
network side.

SturLast15MinCRC INTEGER 0-2147483647 Indicates the


Anomalies number of CRC
abnormalities in
the last 15
minutes on the
user side.

StucLast15MinCR INTEGER 0-2147483647 Indicates the


CAnomalies number of CRC
abnormalities in
the last 15
minutes on the
network side.

SturES INTEGER 0-900 Indicates the


number of errored
seconds in the
current 15
minutes on the
user side.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 546


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

StucES INTEGER 0-900 Indicates the


number of errored
seconds in the
current 15
minutes on the
network side.
Unit: s.

SturLast15MinES INTEGER 0-900 Indicates the


number of errored
seconds in the
last 15 minutes
on the user side.
Unit: s.

StucLast15MinES INTEGER 0-900 Indicates the


number of errored
seconds in the
last 15 minutes
on the network
side.
Unit: s.

SturSES INTEGER 0-900 Indicates the


number of
severely errored
seconds in the
current 15
minutes on the
user side.
Unit: s.

StucSES INTEGER 0-900 Indicates the


number of
severely errored
seconds in the
current 15
minutes on the
network side.
Unit: s.

SturLast15MinSES INTEGER 0-900 Indicates the


number of
severely errored
seconds in the
last 15 minutes
on the user side.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 547


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

StucLast15MinSES INTEGER 0-900 Indicates the


number of
severely errored
seconds in the
last 15 minutes
on the network
side.
Unit: s.

SturUAS INTEGER 0-900 Indicates the


number of
unavailable
seconds in the
current 15
minutes on the
user side.
Unit: s.

StucUAS INTEGER 0-900 Indicates the


number of
unavailable
seconds in the
current 15
minutes on the
network side.
Unit: s.

SturLast15MinUA INTEGER 0-900 Indicates the


S number of
unavailable
seconds in the
last 15 minutes
on the user side.
Unit: s.

StucLast15MinUA INTEGER 0-900 Indicates the


S number of
unavailable
seconds in the
last 15 minutes
on the network
side.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 548


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SturLOSWS INTEGER 0-900 Indicates the


number of LOSW
seconds in the
current 15
minutes on the
user side.
Unit: s.

StucLOSWS INTEGER 0-900 Indicates the


number of LOSW
seconds in the
current 15
minutes on the
network side.
Unit: s.

SturLast15MinLOS INTEGER 0-900 Indicates the


WS number of LOSW
seconds in the
last 15 minutes
on the user side.
Unit: s.

StucLast15MinLO INTEGER 0-900 Indicates the


SWS number of LOSW
seconds in the
last 15 minutes
on the network
side.
Unit: s.

TOTALINOCTETS INTEGER 0-2147483647 Indicates the total


number of
received bytes.
The MA5600
V300R003C05 and
the later versions
support this
parameter.
Unit: byte.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 549


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TOTALOUTOCTET INTEGER 0-2147483647 Indicates the total


S number of
transmitted bytes.
The MA5600
V300R003C05 and
the later versions
support this
parameter.
Unit: byte.

Error Code
ID Description Solution

1613561870 Interacting with the Verify that the


performance and performance statistics
statistic daemon failed, collection process runs in
please check the the normal state.
performance and
statistic daemon.

1613561871 The performance Verify that the


statistics task does not performance statistics of
exist. the specified port is
available. If the
performance statistics is
not available, create the
performance statistics
collection task for the
port on the GUI.

Example
To query the performance statistics of G.SHDSL port 0/8/0 on the device named
10.71.60.26, run the following command:
LST-SHDSLPORTPERF::DEV=10.71.60.26,FN=0,SN=8,PN=0:3::;
The result is as follows:
7340032 2006-09-21 19:35:22
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Port performance
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 550


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-----------------------
HecErrors PortElapsedTime Last15MinHecErrors InOctets OutOctet
s TrafficElapsedTime Last15MinInOctets Last15MinOutOctets
NTEPowerStatus SessionStartTime SessionEndTime SessionUpTime Retains
InitFail StucCurrAtn SturCurrAtn StucCurrSnrMgn SturCurrSnrMgn
ChanCurrTxRate AttainableRate StucChannelElapsedTime SturChannelElapsedTime
SturCRCAnomalies StucCRCAnomalies SturLast15MinCRCAnomalies
StucLast15MinCRCAnomalies SturES StucES SturLast15MinES StucLast15MinES
SturSES StucSES SturLast15MinSES StucLast15MinSES SturUAS StucUAS
SturLast15MinUAS StucLast15MinUAS SturLOSWS StucLOSWS
SturLast15MinLOSWS StucLast15MinLOSWS
-- 692 -- 89185167 128033531 692 96131135
112748119 on 2006-09-21 19:30:52 0000-00-00 00:00:37 7
15 1899 -- 0 -- 13 1544000 1544000 -- 598
4621 -- 0 -- 0 -- 0 -- 4 --
0 -- 123 -- 0 -- 127 -- 0 --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-----------------------

Related Command
● LST-SHDSLPORTDETAILINFO
● LST-SHDSLPORTALARM
● ACT-SHDSLPORT

14.3.13 Querying the FE1 Attribute of a TDM SHDSL Port (LST-


SHDSLPORTFE1)
Usage Note
This command is used to query the FE1 attribute of a TDM SHDSL port.

Command Format
LST-SHDSLPORTFE1::((DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num):CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 551


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=" G.SHDSL Port FE1 Attributes of the Device "+device-name +"Frame number:" + frameId + "Slot
number:" +slotID + "Port number:" +portID
name of attributes: DID FN SN PN SIGNAL CRCMode L2Monitor

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 552


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

SIGNAL OCTET STRING CCS Indicates the


CAS signaling mode.
UNFRAME

CRCMode OCTET STRING Enable Indicates the


Disable frame verification
mode.

L2Monitor OCTET STRING Enable Indicates the


Disable Layer 2
monitoring
switch.

Error Code
None

Example
To query the FE1 attribute of TDM SHDSL port 0/6/16 on the NE named
10.71.214.41, run the following command:

LST-SHDSLPORTFE1::DEV=10.71.214.41,FN=0,SN=6,PN=16:3::;

The result is as follows:


7340049 2013-09-17 19:22:16
M 3 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

G.SHDSL Port FE1 Attributes of the Device 10.71.214.41 Frame number:0 Slot number:6 Port number:16
------------------------------------------------
DID FN SN PN SIGNAL CRCMode L2Monitor
7340049 0 6 16 CCS Disable Disable
------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 553


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4 Querying VDSL2 Resources


This topic provides the commands and examples for querying VDSL2 resources,
including the VDSL2 ports, profiles, alarms, and performance statistics.

14.4.1 Querying the Details of a VDSL2 Port (LST-


VDSL2PORTDETAILINFO)

Usage Note
This command is used to query the details of a VDSL2 port. The device ID (or
device name), subrack ID, slot ID, and port ID are mandatory for the command.

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

Command Format
LST-VDSL2PORTDETAILINFO::(DID=Device-ID|DEV=Device-name),FN=frame-num,SN=slot-num,PN=port-
num:CTAG::[SHOWOPTION=NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS
CH1INPUS TISRVPROF TISPTRMPROF TIDPBOPROF TIUPBOPROF TINMARPROF TIDINPPROF TIAPROF
CH2INPDS CH2INPUS COSYSVENDOR CPESYSVENDOR PPPOESESSION ADMINSTAT COVERSION
CPEVERSION COSERIALNUM CPESERIALNUM TR165PARA TR165PARAINDEX
QUENESHAPINGPARATRAPSWITCH VECTORINGSTATUS LEGACYCPEPOLICY CPETYPE ACTUALRATEUS
ACTUALRATEDS LASTRETRAININFO CH1NETRATEUS CH1NETRATEDS CH1LATENCYPATHUS
CH1LATENCYPATHDS CH1AGAINSTREINUS CH1AGAINSTREINDS CH2NETRATEUS CH2NETRATEDS
CH2LATENCYPATHUS CH2LATENCYPATHDS CH2AGAINSTREINUS CH2AGAINSTREINDS ACTUALCOKL0
ACTUALCPEKL0 SPLITTERMODE ACTRATEADAPTUS ACTRATEADAPTDS ACTROCINPUS ACTROCINPDS
ACTROCSNRMUS ACTROCSNRMDS TR165SOSPROF TR165SOSPROFINDEX ACTIVEDLINETECH
DATACHANNELMODE TR165INMPROFILE TR165INMPROFINDEX VECTORROF];

Supporting Device
Device Type No. Device Type

249 MA5600T

37 MA5662

57 MA5606T

44 MA5600V3

64 MA5651

92 MA5652G

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 554


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

94 MA5603U

95 MA5603T

100 MA5616

103 MA5635

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2331 MA5608T

2339 MA5818

2340 MA5611S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 555


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 556


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● NTEPOWE (Optional) -


N STRING RSTATUS Specifies the
● LASTUPTI attributes
ME that can be
displayed in
● LASTDOW the returned
NTIME result. If you
● UPTIME set this
● CH1INPDS parameter,
the
● CH1INPUS corresponding
● TISRVPROF attributes are
● TISPTRMP returned. By
ROF default, the
attributes are
● TIDPBOPR not displayed.
OF
For example,
● TIUPBOPR if you enter
OF NTEPOWERS
● TINMARPR TATUS, the
OF result
● TIDINPPRO contains the
F information
about this
● TIAPROF attribute.
● CH2INPDS NOTE
● CH2INPUS Only the
MA5600T and
● COSYSVEN MA5603T
DOR support the
PPPOESESSIO
● CPESYSVE N attributes.
NDOR
Querying
● PPPOESES TR165PARA
SION and
TR165PARAI
● ADMINSTA NDEX are
T supported
● COVERSIO only when the
port works in
N TR165 mode.
● CPEVERSIO
N
● COSERIAL
NUM
● CPESERIAL
NUM
● TR165PAR
A
● TR165PAR
AINDEX

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 557


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

● QUENESH
APINGPAR
A
● TRAPSWIT
CH
● VECTORIN
GSTATUS
● LEGACYCP
EPOLICY
● CPETYPE
● ACTUALRA
TEUS
● ACTUALRA
TEDS
● LASTRETR
AININFO
● CH1NETRA
TEUS
● CH1NETRA
TEDS
● CH1LATEN
CYPATHUS
● CH1LATEN
CYPATHDS
● CH1AGAIN
STREINUS
● CH1AGAIN
STREINDS
● CH2NETRA
TEUS
● CH2NETRA
TEDS
● CH2LATEN
CYPATHUS
● CH2LATEN
CYPATHDS
● CH2AGAIN
STREINUS
● CH2AGAIN
STREINDS
● ACTUALCO
KL0
● ACTUALCP
EKL0

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 558


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

● SPLITTERM
ODE
● ACTRATEA
DAPTUS
● ACTRATEA
DAPTDS
● ACTROCIN
PUS
● ACTROCIN
PDS
● ACTROCSN
RMUS
● ACTROCSN
RMDS
● TR165SOS
PROF
● TR165SOS
PROFINDE
X
● ACTIVEDLI
NETECH
● DATACHA
NNELMOD
E
● TR165INM
PROFILE
● TR165INM
PROFINDE
X
● VECTORRO
F

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 Port Detail Information of the Device" +device-name
name of attributes: DID FN SN PN ALIAS PSTAT LPROFID APROFID TRANSSYS PWRMNGSTATE INITRESULT
LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS SNRMARGINUS ATTAINABLERATEDS
ATTAINABLERATEUS ACTPSDDS ACTPSDUS ACTATPDS ACTATPUS CH1ACTDATARATEDS
CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS CH1PTMSTATUSDS CH1ACTDATARATEUS
CH1PREVDATARATEUS CH1ACTDELAYUS CH1ATMSTATUSUS CH1PTMSTATUSUS CH2ACTDATARATEDS
CH2PREVDATARATEDS CH2ACTDELAYDS CH2ATMSTATUSDS CH2PTMSTATUSDS CH2ACTDATARATEUS
CH2PREVDATARATEUS CH2ACTDELAYUS CH2ATMSTATUSUS CH2PTMSTATUSUS NTEPOWERSTATUS
LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS CH1INPUS TISRVPROF TISPTRMPROF TIDPBOPROF
TIUPBOPROF TINMARPROF TIDINPPROF TIAPROF PPPOE OPTION82 CH2INPDS CH2INPUS COSYSVENDOR
CPESYSVENDOR PPPOESESSION ADMINSTAT COVERSION CPEVERSION COSERIALNUM CPESERIALNUM

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 559


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF, TR165UPBOPROF


TR165RFIPROF TR165NMPROF TR165CH1USPROF TR165CH1UARR TR165CH2USPROF TR165CH2UARR
TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF TR165CH2DARR TR165CH1INPPROF
TR165CH2INPPROF TR165VNPROFINDEX TR165SPECTRUMPROFINDEX TR165DPBOPROFINDEX
TR165UPBOPROFINDEX TR165RFIPROFINDEX TR165NMPROFINDEX TR165CH1USPROFINDEX
TR165CH2USPROFINDEX TR165CH1DSPROFINDEX TR165CH2DSPROFINDEX TR165CH1INPPROFINDEX
TR165CH2INPPROFINDEX QUENE1 QUENE2 OUTBOUNDTRAFFICPROF TRAPSWITCH VECTORINGSTATUS
LEGACYCPEPOLICY CPETYPE ACTUALRATEUS ACTUALRATEDS LASTRETRAININFO CH1NETRATEUS
CH1NETRATEDS CH1LATENCYPATHUS CH1LATENCYPATHDS CH1AGAINSTREINUS CH1AGAINSTREINDS
CH2NETRATEUS CH2NETRATEDS CH2LATENCYPATHUS CH2LATENCYPATHDS CH2AGAINSTREINUS
CH2AGAINSTREINDS ACTUALCOKL0 ACTUALCPEKL0 SPLITTERMODE ACTRATEADAPTUS
ACTRATEADAPTDS ACTROCINPUS ACTROCINPDS ACTROCSNRMUS ACTROCSNRMDS TR165SOSPROF
TR165SOSPROFINDEX ACTIVEDLINETECH DATACHANNELMODE TR165INMPROFILE TR165INMPROFINDEX
VECTORROF

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 line profile.

APROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 alarm
profile.

ALIAS OCTET STRING SIZE (64) Indicates the alias


NOTE of the VDSL2
● For
port.
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 32 digit.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 560


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PPPOE OCTET STRING ● ON Specifies whether


● OFF the PPPoE
function is
enabled. Only the
MA5600T,
MA5603T and the
MA5606T support
this parameter.

OPTION82 OCTET STRING ● ON Specifies whether


● OFF the option 82
function is
enabled. Only the
MA5600T,
MA5603T and the
MA5606T support
this parameter.

PSTAT OCTET STRING ● Fault Indicates the


● Test status of the port.
● Active
● Activating
● Deactive
● LoopBack

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 561


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 562


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 563


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 564


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN

PWRMNGSTATE OCTET STRING ● Level 0 Indicates the


● Level 1 power
management
● Level 2 status.
● Level 3

INITRESULT OCTET STRING ● NoFailure Indicates the


● ConfigError result of the last
complete
● ConfigNotFeasi initialization.
ble
● CommFail
● NoPeerAtu
● OtherCause

LNATTENDS INTEGER 0-127 Indicates the


downstream
power
attenuation.
Unit: dB.

LNATTENUS INTEGER 0-127 Indicates the


upstream power
attenuation.
Unit: dB.

SIGATTENDS INTEGER 0-127 Indicates the


downstream
signal
attenuation.
Unit: dB.

SIGATTENUS INTEGER 0-127 Indicates the


upstream signal
attenuation.
Unit: dB.

SNRMARGINDS INTEGER -64 dB to +63 dB Indicates the


downstream SNR
margin.
Unit: dB.

SNRMARGINUS INTEGER -64 to +63 Indicates the


upstream SNR
margin.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 565


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

ACTPSDDS INTEGER -90 to 0 Indicates the


downstream PSD.
Unit: dBm/Hz.

ACTPSDUS INTEGER -90 to 0 Indicates the


upstream PSD.
Unit: dBm/Hz.

ACTATPDS INTEGER -31 to +31 Indicates the


downstream
power.
Unit: dBm.

ACTATPUS INTEGER -31 to +31 Indicates the


upstream power.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 1.
Unit: kbit/s.

CH1ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 1.
Unit: ms.

CH1ATMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat downstream ATM
ion data status of
channel 1.
● LossOfCellDeli
neation

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 566


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1PTMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● OutOfSync downstream PTM
data status of
channel 1.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 1.
Unit: kbit/s.

CH1ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 1.
Unit: ms.

CH1ATMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat upstream ATM
ion data status of
channel 1.
● LossOfCellDeli
neation

CH1PTMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● OutOfSync upstream PTM
data status of
channel 1.

CH2ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 2.
Unit: kbit/s.

CH2PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 2.
Unit: kbit/s.

CH2ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 2.
Unit: ms.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 567


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2ATMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat downstream ATM
ion data status of
channel 2.
● LossOfCellDeli
neation

CH2PTMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● OutOfSync downstream PTM
data status of
channel 2.

CH2ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 2.
Unit: kbit/s.

CH2PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 2.
Unit: kbit/s.

CH2ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 2.
Unit: ms.

CH2ATMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat upstream ATM
ion data status of
channel 2.
● LossOfCellDeli
neation

CH2PTMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● OutOfSync upstream PTM
data status of
channel 2.

NTEPOWERSTATU OCTET STRIN ● on Indicates the NTE


S ● off power status of
the VDSL2 port.
● unknown

LASTUPTIME OCTET STRING - Indicates the time


when the VDSL2
port is online.
The format is YY-
MM-DD
hh:mm:ss.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 568


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LASTDOWNTIME OCTET STRING - Indicates the time


when the VDSL2
port is
disconnected.
The format is YY-
MM-DD
hh:mm:ss.
The time is in UTC
format.

UPTIME INTEGER 0-4294967295 Indicates the


duration during
which the VDSL2
port is activated.

CH1INPDS FLOAT 0-25.4 Indicates the


downstream
impulse noise
protection (INP)
of channel 1.
Unit: dmt.

CH1INPUS FLOAT 0-25.4 Indicates the


upstream INP of
channel 1.
Unit: dmt.

TISRVPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
service profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TISPTRMPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
spectrum profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 569


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TIDPBOPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
DPBO profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TIUPBOPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
DPBO profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TINMARPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
noise margin
profile bound to
the VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TIDINPPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
delay INP profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TIAPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
alarm profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 570


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2INPDS FLOAT 0-25.4 Indicates the


downstream INP
of channel 2.
Unit: dmt.

CH2INPUS FLOAT 0-25.4 Indicates the


upstream INP of
channel 2.
Unit: dmt.

COSYSVENDOR OCTET STRING - Indicates the


vendor ID of the
central office
system.

CPESYSVENDOR OCTET STRING - Indicates the


vendor ID of the
remote end
system.

PPPOESESSION INTEGER 0-8 Indicates the


number of online
PPPoE single-MAC
users on each
physical port.
NOTE
Only the MA5600T
and MA5603T
support the
PPPOESESSION
attributes.

ADMINSTAT OCTET STRING ● UP Indicates the


● DOWN activation state of
a VDSL2 port.
Options are as
follows:
● UP: activated
● DOWN:
deactivated

COVERSION OCTET STRING SIZE (32) Indicates the


version of the
central office
system.

CPEVERSION OCTET STRING SIZE (32) Indicates the


version of the
remote end
system.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 571


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COSERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the central office.

CPESERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the remote end
system.

TR165VNPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 virtual
noise profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 572


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165SPECTRUM OCTET STRING SIZE (32) Indicates the


PROF name of the
TR165 spectrum
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165ALARMPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 alarm
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 573


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165DPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 DPBO
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165UPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 UPBO
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 574


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165RFIPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 RFI profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 575


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
upstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 576


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
upstream rate
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
upstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 577


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
downstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 578


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
downstream rate
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
downstream rate.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 579


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2INPPRO OCTET STRING SIZE (32) Indicates the


F delay INP profile
of the TR165
channel 2.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 580


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165VNPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 virtual
noise profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165SPECTRUM INTEGER 1-4294967294 Indicates the


PROFINDEX index of the
TR165 spectrum
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 581


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165DPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 DPBO
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165UPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 UPBO
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 582


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165RFIPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 RFI profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165NMPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 noise
margin profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 583


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
upstream rate
profile. This
parameter is valid
only when the
TR165CH1UARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 584


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 2
upstream rate
profile. This
parameter is valid
only when the
TR165CH2UARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 585


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
downstream
profile. This
parameter is valid
only when the
TR165CH1DARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 586


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 2
downstream rate
profile. This
parameter is valid
only when the
TR165CH2DARR
parameter is set.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 587


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
INP profile of the
TR165 channel 1.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH2INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
INP profile of the
TR165 channel 2.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 588


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

QUENE1 INTEGER 3 Indicates queue 1.


This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

QUENE2 INTEGER 4 Indicates queue 2.


This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

OUTBOUNDTRAF OCTET STRING SIZE (32) Indicates the


FICPROF name of the
outbound traffic
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A,
MA5616 and
MA5611S.
This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 589


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRAPSWITCH OCTET STRING ● ON Specifies whether


● OFF the trap function
is enabled.
Options are as
follows:
● ON: reports
alarms from
ports to the
NCE.
● OFF:
suppresses
alarms from
ports.

VECTORINGSTAT OCTET STRING ● Vectoring ON Indicates the


US ● Vectoring OFF global vectoring
switch.
Options are as
follows:
● ON: reports
alarms from
ports to the
NCE.
● OFF:
suppresses
alarms from
ports.

LEGACYCPEPOLIC OCTET STRING ● No Limit Indicates the


Y ● Block legacy CPE
activation policy.
● Limit
● Force Friendly
Downstream
with Upstream
Limited
● Force Friendly
Downstream

CPETYPE OCTET STRING ● Vectoring Indicates the CPE


● Vectoring full type.
friendly
● Vectoring
friendly DS
● VDSL2
● ADSL/2/2+
● Unknown

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 590


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTUALRATEUS INTEGER 0-4294967295 Indicates the


actual upstream
data transmission
rate.
Unit: kbit/s.

ACTUALRATEDS INTEGER 0-4294967295 Indicates the


actual
downstream data
transmission rate.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 591


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LASTRETRAININF OCTET STRING ● none Indicates the


O ● cpe-l3-trigger reason of the last
deactivation.
● lom-us-trigger-
dra
● lom-ds-trigger-
dra
● cpe-never-
answer-oam
● cpe-no-more-
answer-oam
● persistent-ncd-
us
● persistent-ncd-
ds
● persistent-lcd-
us
● persistent-lcd-
ds
● l2-problem-co-
drop
● l2-problem-
cpe-drop
● bitswap-
refused-us-co-
drop
● bitswap-
refused-us-
cpe-drop
● channel-
change-us-co-
drop
● channel-
change-us-cpe-
drop
● noise-increase-
us-co-drop
● noise-increase-
us-cpe-drop
● bitswap-
refused-ds-co-
drop
● bitswap-
refused-ds-
cpe-drop

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 592


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● channel-
change-ds-co-
drop
● channel-
change-ds-cpe-
drop
● noise-increase-
ds-co-drop
● noise-increase-
ds-cpe-drop
● lom-us-co-
drop
● lom-us-cpe-
drop
● lom-ds-co-
drop
● lom-ds-cpe-
drop
● sra-problem-
us-co-drop
● sra-problem-
us-cpe-drop
● sra-failed-us-
co-drop
● sra-failed-us-
cpe-drop
● sra-problem-
ds-co-drop
● sra-problem-
ds-cpe-drop
● sra-rejected-
ds-co-drop
● sra-rejected-
ds-cpe-drop
● bitswap-
problem-us-co-
drop
● bitswap-
problem-us-
cpe-drop
● bitswap-failed-
us-co-drop
● bitswap-failed-
us-cpe-drop

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 593


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● bitswap-
problem-ds-co-
drop
● bitswap-
problem-ds-
cpe-drop
● bitswap-
rejected-ds-co-
drop
● bitswap-
rejected-ds-
cpe-drop
● cpe-switched-
off
● cpe-lost
● co-reset
● co-stop
● unknown

CH1NETRATEUS INTEGER 0-4294967295 Indicates the


upstream payload
rate of channel 1.
Unit: kbit/s.

CH1NETRATEDS INTEGER 0-4294967295 Indicates the


downstream
payload rate of
channel 1.
Unit: kbit/s.

CH2NETRATEUS INTEGER 0-4294967295 Indicates the


upstream payload
rate of channel 2.
Unit: kbit/s.

CH2NETRATEDS INTEGER 0-4294967295 Indicates the


downstream
payload rate of
channel 2.
Unit: kbit/s.

CH1LATENCYPAT INTEGER 0-3 Indicates the


HUS upstream channel
ID of channel 1.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 594


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1LATENCYPAT INTEGER 0-3 Indicates the


HDS downstream
channel ID of
channel 1.

CH2LATENCYPAT INTEGER 0-3 Indicates the


HUS upstream channel
ID of channel 2.

CH2LATENCYPAT INTEGER 0-3 Indicates the


HDS downstream
channel ID of
channel 2.

CH1AGAINSTREIN INTEGER 0-4294967295 Indicates the INP


US value for defense
against repetitive
electric impulsive
noise (REIN) in
the upstream
direction of
channel 1.
Unit: dmt.

CH1AGAINSTREIN INTEGER 0-4294967295 Indicates the INP


DS value for defense
against REIN in
the downstream
direction of
channel 1.
Unit: dmt.

CH2AGAINSTREIN INTEGER 0-4294967295 Indicates the INP


US value for defense
against REIN in
the upstream
direction of
channel 2.
Unit: dmt.

CH2AGAINSTREIN INTEGER 0-4294967295 Indicates the INP


DS value for defense
against REIN in
the downstream
direction of
channel 2.
Unit: dmt.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 595


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTUALCOKL0 INTEGER 0-4294967295 Indicates the


actual value of
the KL0_CO
parameter.
Unit: 0.1 dB

ACTUALCPEKL0 INTEGER 0-4294967295 Indicates the


actual value of
the KL0_CPE
parameter.
Unit: 0.1 dB

SPLITTERMODE OCTET STRING ● Connect Indicates the


● Bypass splitter mode.
Options are as
follows:
● Connect:
Connect ports
to the splitter.
● Bypass: Enable
ports to bypass
the splitter.
NOTE
Only the MA5611S
supports this
parameter.

ACTRATEADAPTU OCTET STRING ● Manual Indicates the


S ● Rainit upstream rate
auto-adaptation
● Dynamic mode at the
● Dynamic with remote end.
SOS NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, MA5818,
and MA5611S
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 596


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTRATEADAPTD OCTET STRING ● Manual Indicates the


S ● Rainit downstream rate
auto-adaptation
● Dynamic mode at the
● Dynamic with central office end.
SOS NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, MA5818,
and MA5611S
whose versions are
later than
V800R015C10.

ACTROCINPUS INTEGER 0-254 Indicates the


actual INP of the
upstream robust
overhead channel
(ROC) at the
remote end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, MA5818,
and MA5611S
whose versions are
later than
V800R015C10.

ACTROCINPDS INTEGER 0-254 Indicates the


actual INP of the
downstream ROC
channel at the
central office end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, MA5818,
and MA5611S
whose versions are
later than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 597


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTROCSNRMUS INTEGER -2147483648-214 Indicates the


7483647 actual signal-to-
noise ratio (SNR)
margin of the
upstream ROC
channel at the
remote end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, MA5818,
and MA5611S
whose versions are
later than
V800R015C10.

ACTROCSNRMDS INTEGER -2147483648-214 Indicates the


7483647 actual SNR
margin of the
downstream ROC
channel at the
central office end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, MA5818,
and MA5611S
whose versions are
later than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 598


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165SOSPROF OCTET STRING SIZE (32) Indicates the


TR165 SOS
profile.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than V800R015C10
in TR165 mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165SOSPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 SOS
profile.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than V800R015C10
in TR165 mode.
The value of this
parameter is
returned only
when
SHOWOPTION=T
R165PARAINDEX
is entered in the
command.

ACTIVEDLINETEC OCTET STRING ● Unknown Indicates the


H ● ADSL actual activation
mode of the port.
● ADSL2
● ADSL2PLUS
● VDSL
● VDSL2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 599


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DATACHANNELM OCTET STRING ● Unknown Indicates the work


ODE ● ATM mode of the
current channel.
● PTM

TR165INMPROFIL OCTET STRING SIZE (32) Indicates the


E name of the INM
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A,
MA5611S and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165INMPROFILE
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 600


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165INMPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the INM
profile.
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5652,
MA5662,
MA5622A,
MA5623,
MA5623A,
MA5611S and
MA5616 in TR165
mode.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165INMPROFIN
DEX in the
command.

VECTORROF OCTET STRING SIZE (32) Indicates the


vectoring profile
name.

Error Code
ID Description Solution

2689007617 The instance does not exist, Verify that the command is
or the feature is not correct according to the
supported or not following requirements:
configured. ● Check whether the
entered port is a VDSL2
port.
● Check whether the
entered port exists.

Example
To query the details of port 0/1/31 on the device named 10.78.217.111, run the
following command:
LST-
VDSL2PORTDETAILINFO::DEV=10.78.217.111,FN=0,SN=1,PN=31:1::SHOWOPTIO

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 601


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

N=NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS


CH1INPUS COSYSVENDOR CPESYSVENDOR;
The result is as follows:
7340034 2010-11-19 18:16:56
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
VDSL2 Port Detail Information of the Device 10.78.217.111
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------
DID FN SN PN ALIAS PSTAT LPROFID APROFID TRANSSYS PWRMNGSTATE
INITRESULT LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS
SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS ACTPSDDS ACTPSDUS ACTATPDS
ACTATPUS CH1ACTDATARATEDS CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS
CH1PTMSTATUSDS CH1ACTDATARATEUS CH1PREVDATARATEUS CH1ACTDELAYUS
CH1ATMSTATUSUS CH1PTMSTATUSUS CH2ACTDATARATEDS CH2PREVDATARATEDS
CH2ACTDELAYDS CH2ATMSTATUSDS CH2PTMSTATUSDS CH2ACTDATARATEUS
CH2PREVDATARATEUS CH2ACTDELAYUS CH2ATMSTATUSUS CH2PTMSTATUSUS
NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS CH1INPUS PPPOE
OPTION82 COSYSVENDOR CPESYSVENDOR
7340034 0 1 31 -- Activating DEFVAL DEFVAL -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- unknown -- -- -- -- -- ON ON -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------
;

Related Command
● LST-VDSLPORTPERF
● LST-VDSLPORTALARM

14.4.2 Querying Specified Information About VDSL2 Ports


(LST-VDSL2PORTSPECIFYINFO)
Usage Note
This command is used to query the details of a VDSL2 port. The device ID (or
device name), subrack ID, slot ID, and port ID are mandatory for the command.
Because the SHOWOPTION field in this command supports a lot of parameters,
the total length of the query command must be no more than 1024 characters.

Command Format
LST-VDSL2PORTSPECIFYINFO::(DID=Device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::[SHOWOPTION=ALIAS PSTAT LPROFID APROFID TRANSSYS PWRMNGSTATE INITRESULT
LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS SNRMARGINUS ATTAINABLERATEDS
ATTAINABLERATEUS ACTPSDDS ACTPSDUS ACTATPDS ACTATPUS CH1ACTDATARATEDS
CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS CH1PTMSTATUSDS CH1ACTDATARATEUS
CH1PREVDATARATEUS CH1ACTDELAYUS CH1ATMSTATUSUS CH1PTMSTATUSUS CH2ACTDATARATEDS
CH2PREVDATARATEDS CH2ACTDELAYDS CH2ATMSTATUSDS CH2PTMSTATUSDS CH2ACTDATARATEUS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 602


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

CH2PREVDATARATEUS CH2ACTDELAYUS CH2ATMSTATUSUS CH2PTMSTATUSUS NTEPOWERSTATUS


LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS CH1INPUS TISRVPROF TISPTRMPROF TIDPBOPROF
TIUPBOPROF TINMARPROF TIDINPPROF TIAPROF PPPOE OPTION82 CH2INPDS CH2INPUS COSYSVENDOR
CPESYSVENDOR PPPOESESSION COVERSION CPEVERSION COSERIALNUM CPESERIALNUM TR165VNPROF
TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF TR165UPBOPROF TR165RFIPROF
TR165NMPROF TR165CH1USPROF TR165CH1UARR TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF
TR165CH1DARR TR165CH2DSPROF TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF
TR165SOSPROF TR165INMPROFILE VECTORROF QUENE1 QUENE2 OUTBOUNDTRAFFICPROF
PHYRSWITCH ACTRATEADAPTUS ACTRATEADAPTDS ACTROCINPUS ACTROCINPDS ACTROCSNRMUS
ACTROCSNRMDS];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 603


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FN INTEGER 0-255 Indicates the -


subrack ID.

SN INTEGER 0-35 Indicates the -


slot ID.

PN INTEGER 0-63 Indicates the -


port ID.

SHOWOPTIO OCTET See the (Optional) -


N STRING SHOWOPTIO Specifies the
N parameter attributes
value in the that can be
command displayed in
format. the returned
result. If you
set this
parameter,
the
corresponding
attributes are
returned. By
default, the
attributes are
not displayed.
NOTE
This
command
applies to the
V800R007 and
later versions
of the
MA5600T and
MA5603T.
Some devices
may support
certain
parameters of
the
SHOWOPTIO
N field.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 port attributes of the device " +device-name
name of attributes: DID FN SN PN ALIAS PSTAT LPROFID APROFID TRANSSYS
PWRMNGSTATE INITRESULT LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS
SNRMARGINDS SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS ACTPSDDS
ACTPSDUS ACTATPDS ACTATPUS CH1ACTDATARATEDS CH1PREVDATARATEDS
CH1ACTDELAYDS CH1ATMSTATUSDS CH1PTMSTATUSDS CH1ACTDATARATEUS
CH1PREVDATARATEUS CH1ACTDELAYUS CH1ATMSTATUSUS CH1PTMSTATUSUS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 604


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

CH2ACTDATARATEDS CH2PREVDATARATEDS CH2ACTDELAYDS CH2ATMSTATUSDS


CH2PTMSTATUSDS CH2ACTDATARATEUS CH2PREVDATARATEUS CH2ACTDELAYUS
CH2ATMSTATUSUS CH2PTMSTATUSUS NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME
UPTIME CH1INPDS CH1INPUS TISRVPROF TISPTRMPROF TIDPBOPROF TIUPBOPROF
TINMARPROF TIDINPPROF TIAPROF PPPOE OPTION82 CH2INPDS CH2INPUS
COSYSVENDOR CPESYSVENDOR PPPOESESSION COVERSION CPEVERSION COSERIALNUM
CPESERIALNUM TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF
TR165UPBOPROF TR165RFIPROF TR165NMPROF TR165CH1USPROF TR165CH1UARR
TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF
TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF QUENE1 QUENE2
OUTBOUNDTRAFFICPROF PHYRSWITCH ACTRATEADAPTUS ACTRATEADAPTDS ACTROCINPUS
ACTROCINPDS ACTROCSNRMUS ACTROCSNRMDS TR165SOSPROF TR165INMPROFILE VECTORROF

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ALIAS OCTET STRING SIZE (64) Indicates the alias


NOTE of the VDSL2
● For
port.
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 32 digit.

PSTAT OCTET STRING ● Fault Indicates the


● Test status of the port.
● Active
● Activating
● Deactive
● LoopBack

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 605


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 line profile.

APROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 alarm
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 606


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 607


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 608


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 609


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN

PWRMNGSTATE OCTET STRING ● Level 0 Indicates the


● Level 1 power
management
● Level 2 status.
● Level 3

INITRESULT OCTET STRING ● NoFailure Indicates the


● ConfigError result of the last
complete
● ConfigNotFeasi initialization.
ble
● CommFail
● NoPeerAtu
● OtherCause

LNATTENDS INTEGER 0-127 Indicates the


downstream
power
attenuation.
Unit: dB.

LNATTENUS INTEGER 0-127 Indicates the


upstream power
attenuation.
Unit: dB.

SIGATTENDS INTEGER 0-127 Indicates the


downstream
signal
attenuation.
Unit: dB.

SIGATTENUS INTEGER 0-127 Indicates the


upstream signal
attenuation.
Unit: dB.

SNRMARGINDS INTEGER -64 dB to +63 dB Indicates the


downstream
signal-to-noise
ratio (SNR)
margin.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 610


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SNRMARGINUS INTEGER -64 to +63 Indicates the


upstream SNR
margin.
Unit: dB.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

ACTPSDDS INTEGER -90 to 0 Indicates the


downstream PSD.
Unit: dBm/Hz.

ACTPSDUS INTEGER -90 to 0 Indicates the


upstream PSD.
Unit: dBm/Hz.

ACTATPDS INTEGER -31 to +31 Indicates the


downstream
power.
Unit: dBm.

ACTATPUS INTEGER -31 to +31 Indicates the


upstream power.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 1.
Unit: kbit/s.

CH1ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 1.
Unit: ms.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 611


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1ATMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat downstream ATM
ion data status of
channel 1.
● LossOfCellDeli
neation

CH1PTMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● OutOfSync downstream PTM
data status of
channel 1.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 1.
Unit: kbit/s.

CH1ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 1.
Unit: ms.

CH1ATMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat upstream ATM
ion data status of
channel 1.
● LossOfCellDeli
neation

CH1PTMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● OutOfSync upstream PTM
data status of
channel 1.

CH2ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 2.
Unit: kbit/s.

CH2PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 2.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 612


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 2.
Unit: ms.

CH2ATMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat downstream ATM
ion data status of
channel 2.
● LossOfCellDeli
neation

CH2PTMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● OutOfSync downstream PTM
data status of
channel 2.

CH2ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 2.
Unit: kbit/s.

CH2PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 2.
Unit: kbit/s.

CH2ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 2.
Unit: ms.

CH2ATMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat upstream ATM
ion data status of
channel 2.
● LossOfCellDeli
neation

CH2PTMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● OutOfSync upstream PTM
data status of
channel 2.

NTEPOWERSTATU OCTET STRIN ● on Indicates the NTE


S ● off power status of
the VDSL2 port.
● unknown

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 613


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LASTUPTIME OCTET STRING - Indicates the time


when the VDSL2
port is online.
The format is YY-
MM-DD
hh:mm:ss.
The time is in UTC
format.

LASTDOWNTIME OCTET STRING - Indicates the time


when the VDSL2
port is
disconnected.
The format is YY-
MM-DD
hh:mm:ss.
The time is in UTC
format.

UPTIME INTEGER 0-4294967295 Indicates the


duration during
which the VDSL2
port is activated.

CH1INPDS FLOAT 0-25.4 Indicates the


downstream INP
of channel 1.
Unit: dmt.

CH1INPUS FLOAT 0-25.4 Indicates the


upstream INP of
channel 1.
Unit: dmt.

TISRVPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
service profile
bound to the
VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 614


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TISPTRMPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
spectrum profile
bound to the
VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

TIDPBOPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
DPBO profile
bound to the
VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

TIUPBOPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
DPBO profile
bound to the
VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

TINMARPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
noise margin
profile bound to
the VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 615


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TIDINPPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
delay INP profile
bound to the
VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

TIAPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
alarm profile
bound to the
VDSL2 port.
This parameter is
available only for
the MA5600T and
MA5603T in TI
mode.

PPPOE OCTET STRING ● ON Specifies whether


● OFF the PPPoE
function is
enabled. Only the
MA5600T and the
MA5603T support
this parameter.

OPTION82 OCTET STRING ● ON Specifies whether


● OFF the option 82
function is
enabled. Only the
MA5600T and the
MA5603T support
this parameter.

CH2INPDS FLOAT 0-25.4 Indicates the


downstream INP
of channel 2.
Unit: dmt.

CH2INPUS FLOAT 0-25.4 Indicates the


upstream INP of
channel 2.
Unit: dmt.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 616


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COSYSVENDOR OCTET STRING - Indicates the


vendor ID of the
central office
system.

CPESYSVENDOR OCTET STRING - Indicates the


vendor ID of the
remote end
system.

PPPOESESSION INTEGER 0-8 Indicates the


number of online
PPPoE single-MAC
users on each
physical port.

COVERSION OCTET STRING SIZE (32) Indicates the


version of the
central office
system.

CPEVERSION OCTET STRING SIZE (32) Indicates the


version of the
remote end
system.

COSERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the central office
system.

CPESERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the remote end
system.

TR165VNPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 virtual
noise profile.

TR165SPECTRUM OCTET STRING SIZE (32) Indicates the


PROF name of the
TR165 spectrum
profile.

TR165ALARMPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 alarm
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 617


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165DPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 DPBO
profile.

TR165UPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 UPBO
profile.

TR165RFIPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 RFI profile.

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.

TR165CH1UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
upstream rate.

TR165CH2USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
upstream rate
profile.

TR165CH2UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
upstream rate.

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 618


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
downstream rate.

TR165CH2DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
downstream rate
profile.

TR165CH2DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
downstream rate.

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.

TR165CH2INPPRO OCTET STRING SIZE (32) Indicates the


F delay INP profile
of the TR165
channel 2.

QUENE1 INTEGER 3 Indicates queue 1.

QUENE2 INTEGER 4 Indicates queue 2.

OUTBOUNDTRAF OCTET STRING SIZE (32) Indicates the


FICPROF name of the
outbound traffic
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 619


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PHYRSWITCH OCTET STRING ● ENABLE Specifies whether


● DISABLE the physical-layer
retransmission
function is
enabled.
Only the
following devices
in TR165 mode
support this
parameter:
● MA5600T and
MA5603T
V800R009C00
and later
versions
● MA5608T
V800R012C00
and later
versions

ACTRATEADAPTU OCTET STRING ● Manual Indicates the


S ● Rainit upstream rate
auto-adaptation
● Dynamic mode at the
● Dynamic with remote end.
SOS NOTE
This parameter is
only applicable to
MA5600T
V800R015C10,
MA5603T
V800R015C10,
MA5608T
V800R015C10,
MA5616
V800R015C10, and
MA5611S
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 620


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTRATEADAPTD OCTET STRING ● Manual Indicates the


S ● Rainit downstream rate
auto-adaptation
● Dynamic mode at the
● Dynamic with central office end.
SOS NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

ACTROCINPUS INTEGER 0-254 Indicates the


actual INP of the
upstream robust
overhead channel
(ROC) at the
remote end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

ACTROCINPDS INTEGER 0-254 Indicates the


actual INP of the
downstream ROC
channel at the
central office end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 621


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTROCSNRMUS INTEGER -2147483648-214 Indicates the


7483647 actual signal-to-
noise ratio (SNR)
margin of the
upstream ROC
channel at the
remote end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

ACTROCSNRMDS INTEGER -2147483648-214 Indicates the


7483647 actual SNR
margin of the
downstream ROC
channel at the
central office end.
NOTE
This parameter is
applicable only to
the MA5600T,
MA5603T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 622


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165SOSPROF OCTET STRING SIZE (32) Indicates the


name of VDSL2
SOS profile in
TR165 mode.
NOTE
This parameter is
only applicable to
MA5600T
V800R015C10,
MA5603T
V800R015C10,
MA5608T
V800R015C10,
MA5616
V800R015C10,
MA5611S
V800R015C10 and
later versions in
TR165 mode.

TR165INMPROFIL OCTET STRING SIZE (32) Indicates the


E name of VDSL2
INM profile in
TR165 mode.
NOTE
This parameter is
only applicable to
MA5600T
V800R015C10,
MA5603T
V800R015C10,
MA5608T
V800R015C10,
MA5616
V800R015C10,
MA5611S
V800R015C10 and
later versions in
TR165 mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 623


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VECTORROF OCTET STRING SIZE (32) Indicates the


name of VDSL2
VECTORING
profile in TR165
mode.
NOTE
This parameter is
only applicable to
MA5600T
V800R015C10,
MA5603T
V800R015C10,
MA5608T
V800R015C10,
MA5616
V800R015C10,
MA5611S
V800R015C10 and
later versions in
TR165 mode.

Error Code
ID Description Solution

2686124034 Resource information is Enter an existing VDSL2 port


empty. ID or synchronize the VDSL2
port on NEs to the NMS.

2686058604 The port type is not Ensure that a VDSL2 port ID


supported. is entered.

Example
To query the specified details of port 0/0/15 on the device named 10.144.195.118,
run the following command:
LST-
VDSL2PORTSPECIFYINFO::DEV=10.144.195.118,FN=0,SN=0,PN=15:1::SHOWOPT
ION=ALIAS PSTAT LPROFID APROFID TRANSSYS PWRMNGSTATE INITRESULT
LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS
SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS ACTPSDDS
ACTPSDUS ACTATPDS ACTATPUS CH1ACTDATARATEDS CH1PREVDATARATEDS
CH1ACTDELAYDS CH1ATMSTATUSDS CH1PTMSTATUSDS
CH1ACTDATARATEUS CH1PREVDATARATEUS CH1ACTDELAYUS
CH1ATMSTATUSUS CH1PTMSTATUSUS CH2ACTDATARATEDS
CH2PREVDATARATEDS CH2ACTDELAYDS CH2ATMSTATUSDS
CH2PTMSTATUSDS CH2ACTDATARATEUS CH2PREVDATARATEUS
CH2ACTDELAYUS CH2ATMSTATUSUS CH2PTMSTATUSUS NTEPOWERSTATUS
LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS CH1INPUS TISRVPROF

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 624


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

TISPTRMPROF TIDPBOPROF TIUPBOPROF TINMARPROF TIDINPPROF TIAPROF


PPPOE OPTION82 CH2INPDS CH2INPUS COSYSVENDOR CPESYSVENDOR
PPPOESESSION COVERSION CPEVERSION COSERIALNUM CPESERIALNUM;

The result is as follows:


7340054 2012-02-17 17:04:30
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 port attributes of the device 10.144.195.118 Frame number:0 Slot number:0 Port number:15
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------
DID FN SN PN ALIAS PSTAT LPROFID APROFID TRANSSYS PWRMNGSTATE
INITRESULT LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS
SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS ACTPSDDS ACTPSDUS ACTATPDS
ACTATPUS CH1ACTDATARATEDS CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS
CH1PTMSTATUSDS CH1ACTDATARATEUS CH1PREVDATARATEUS CH1ACTDELAYUS
CH1ATMSTATUSUS CH1PTMSTATUSUS CH2ACTDATARATEDS CH2PREVDATARATEDS
CH2ACTDELAYDS CH2ATMSTATUSDS CH2PTMSTATUSDS CH2ACTDATARATEUS
CH2PREVDATARATEUS CH2ACTDELAYUS CH2ATMSTATUSUS CH2PTMSTATUSUS
NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS CH1INPUS
TISRVPROF TISPTRMPROF TIDPBOPROF TIUPBOPROF TINMARPROF TIDINPPROF TIAPROF
PPPOE OPTION82 CH2INPDS CH2INPUS COSYSVENDOR CPESYSVENDOR PPPOESESSION
COVERSION CPEVERSION COSERIALNUM CPESERIALNUM
7340054 0 0 15 2121 Active DEFVAL DEFVAL G.993.2 Annex B POTS Level 0
NoFailure -- -- -- -- -- -- -- -- -- -- -- -- 88798 88798 0 -- NoFailure
59186 59893 1 -- NoFailure -- -- -- -- -- -- -- -- -- -- on 2012-02-17
08:29:30 2012-02-17 07:57:36 2126 0.0 0.0 -- -- -- -- -- -- -- OFF OFF -- --
0xffb54244434d0000 0xb5004244434d0000 4 v10.03.14 A2pv6bC012a VE_10_03_14 --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------

Related Command
LST-VDSL2PORTDETAILINFO

14.4.3 Querying VDSL2 Port Information about Specified NEs


(LST-NEVDSL2PORTDETAILINFO)

Usage Note
This command is used to query VDSL2 port information about specified NEs from
the database. The queried data is the same as the data that is last synchronized to
the NCE but differs from the real-time data on the NEs.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 625


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-NEVDSL2PORTDETAILINFO::(DID=device-ID|DEV=device-name):CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T V800R007C01 and later


versions

95 MA5603T V800R007C01 and later


versions

2331 MA5608T

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 626


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 Port Detail Information of the Device" +device-name
name of attributes: DID FN SN PN TISRVPROF TISPTRMPROF TIDPBOPROF TIUPBOPROF TINMARPROF
TIDINPPROF TIAPROF ALIAS PSTAT ATTAINABLERATEUS ATTAINABLERATEDS APROFID LPROFID TRANSSYS
PPPOESESSION

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

TISRVPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
service profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TISPTRMPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
spectrum profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TIDPBOPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
DPBO profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 627


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TIUPBOPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
UPBO profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TINMARPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
noise margin
profile bound to
the VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TIDINPPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
delay INP profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

TIAPROF OCTET STRING SIZE (32) In TI mode, this


parameter
indicates the
alarm profile
bound to the
VDSL2 port. In
non-TI mode, this
parameter is
displayed as -.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 628


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALIAS OCTET STRING SIZE (64) Indicates the alias


NOTE of the VDSL2
● For
port.
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 32 digit.

PSTAT OCTET STRING ● Fault Indicates the


● Test status of the port.
● Active
● Activating
● Deactive
● LoopBack

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

APROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 alarm
profile.

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 line profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 629


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 630


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 631


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 632


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN

PPPOESESSION INTEGER 0-8 Indicates the


number of online
PPPoE single-MAC
users on each
physical port.

Error Code
ID Description Solution

2686058531 The device does not exist. Verify that the device is
successfully added to the
NCE.

Example
To query the VDSL2 port information about NE 10.144.195.45, run the following
command:
LST-NEVDSL2PORTDETAILINFO::DEV=10.144.195.45:CTAG::;
The result is as follows:
7340056 2012-07-20 10:35:40
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=100
blktotal=112

VDSL2 Port Detail Information of the Device 10.144.195.45


------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------
DID FN SN PN TISRVPROF TISPTRMPROF TIDPBOPROF TIUPBOPROF TINMARPROF
TIDINPPROF TIAPROF ALIAS PSTAT ATTAINABLERATEUS ATTAINABLERATEDS APROFID
LPROFID TRANSSYS PPPOESESSION
7340056 0 3 0 TTT DEFVAL DEFVAL TTT TTT TTT DEFVAL 111 Activating 0 0
-- -- -- 8
7340056 0 3 1 TTT DEFVAL DEFVAL TTT TTT TTT DEFVAL -- Activating 0 0
-- -- -- 8
7340056 0 3 2 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Deactive 0 0 -- -- -- 8
7340056 0 3 3 TTT TTT DEFVAL DEFVAL TTT TTT DEFVAL 01-54100200 Deactive
0 0 -- -- -- 8
7340056 0 3 4 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Deactive 0 0 -- -- -- 8
7340056 0 3 5 yewumoban pinpumoban DPBOmoban UPBOmoban zaoshengmoban
DEFVAL gaojingmoban -- Activating 0 0 -- -- -- 8
7340056 0 3 6 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Deactive 0 0 -- -- -- 8
7340056 0 3 7 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Activating 0 0 -- -- -- 8
7340056 0 3 8 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 633


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Deactive 0 0 -- -- -- 8
7340056 0 3 9 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Activating 0 0 -- -- -- 8
7340056 0 3 10 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Activating 0 0 -- -- -- 8
7340056 0 3 11 DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL DEFVAL --
Activating 0 0 -- -- -- 8
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------

Related Command
LST-VDSL2PORTDETAILINFO

14.4.4 Querying the Alarm Information About a VDSL2 Port


(LST-VDSLPORTALARM)
Usage Note
This command is used to query the alarm information about an existing VDSL2
port in the system. A maximum of 10 latest alarms and 20 events can be
displayed when you run this command.

Command Format
LST-VDSLPORTALARM::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

95 MA5603T

100 MA5616

249 MA5600T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 634


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2339 MA5818

2340 MA5611S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 635


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="alarm on Port of the device " + device name + "frameId" + frame number + "slotId" + slot-number +
"portId"+ port ID
name of attributes: SerialNo FaultID Severity FunctionType strName ReasonID
Reason Repair Meaning FaultFlag faultTime ackTime clearTime strAckUserName Location

Output Parameter
Parameter Type Description

SerialNo INTEGER Indicates the serial


number generated by
the daemon.

FaultID INTEGER Indicates the alarm or


event ID. This parameter
and the device are used
to identify an alarm or
event.

Severity INTEGER Indicates the alarm


severity or event level.

FunctionType INTEGER Indicates the type of the


alarm or event.

strName OCTET STRING Indicates the name of


the alarm or event.

ReasonID INTEGER Indicates the cause ID of


the alarm.

Reason OCTET STRING Indicates the alarm


cause.

Repair OCTET STRING Indicates the suggestion


for clearing the alarm.

Meaning OCTET STRING Indicates the description


of the alarm.

FaultFlag INTEGER Indicates the type of the


fault.

faultTime OCTET STRING Indicates the time when


the alarm or event is
generated.
The time is in UTC
format.

ackTime OCTET STRING Indicates the time when


the alarm is
acknowledged.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 636


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Description

clearTime OCTET STRING Indicates the time when


the alarm is cleared.
The time is in UTC
format.

strAckUserName OCTET STRING Indicates the


acknowledged username.

Location OCTET STRING Indicates the location of


the alarm or event.

Error Code
ID Description Solution

1610612784 Querying alarm Verify that the entered


information failed. values of the parameters
are correct.

1610612785 Getting alarm ● Verify that the alarm


information timed out. module runs in the
normal state.
● Verify that the device
is online.

1612644886 No port alarm -


information.

Example
To query the alarm information about VDSL2 port 0/5/9 on the MA5600_30, run
the following command:
LST-VDSLPORTALARM::DEV=MA5600_30,FN=0,SN=5,PN=9:2::;
The result is as follows:
7340033 2008-05-19 12:19:40
M 2 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

alarm on Port of the device MA5600_30 frameId 0 slotId 5 portId 9


------------------------------------------------------------------------------------------------------------------------------
--------------------------------
SerialNo FaultID Severity FunctionType strName ReasonID Reason Repair Meaning
FaultFlag faultTime ackTime clearTime strAckUserName Location
448 1026555906 4 5 VDSL port deactivation 1023410177 The user runs the command to
deactivate the port successfully No need to proceed VDSL port deactivation 0 2008-5-28
8:17:43 -- -- -- FRAME=0 SLOT=5 SUBSLOT=65535 PORT=9 Description of the port(only for
NMS)(Type:string)=--

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 637


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

----------------------------------------------------------------------------------------------------------------------
;

Related Command
● LST-VDSL2PORTDETAILINFO
● LST-VDSLPORTPERF

14.4.5 Querying the Performance Statistics of a VDSL2 Port


(LST-VDSLPORTPERF)

Usage Note
This command is used to query the performance statistics on a specified VDSL2
port of a device. The required VDSL2 port must be in the activated state.

Command Format
LST-VDSLPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-num:CTAG::
[SHOWOPTION=COCVS CPECVS COES1DAY CPEES1DAY COSES1DAY CPESES1DAY CURR1DAYINITFULL
CURR1DAYINITFAIL COCURR15SOS CPECURR15SOS COCURR24SOS CPECURR24SOS COALLSOS CPEALLSOS
COLAST15SOS CPELAST15SOS COLAST24SOS CPELAST24SOS];

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

64 MA5651

92 MA5652G

94 MA5603U

95 MA5603T

100 MA5616

103 MA5635

249 MA5600T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 638


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2331 MA5608T

2339 MA5818

2340 MA5611S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 639


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● COCVS (Optional) -


N STRING ● CPECVS Specifies the
attributes
● COES1DAY that can be
● CPEES1DA displayed. If
Y you set this
● COSES1DA parameter,
Y the
corresponding
● CPESES1D attributes are
AY displayed. By
● CURR1DAY default, the
INITFULL attributes are
● CURR1DAY not displayed.
INITFAIL
● COCURR15
SOS
● CPECURR1
5SOS
● COCURR24
SOS
● CPECURR2
4SOS
● COALLSOS
● CPEALLSO
S
● COLAST15
SOS
● CPELAST15
SOS
● COLAST24
SOS
● CPELAST24
SOS

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL PORT Performance Stat Info of the device " + device name
name of attributes:
DID FN SN PN COFECS COES COSES COLOSS COUS COCURR15MINLOFS COCURR15MINLOLS
COCURR15MINLOPS COCURR15MINES COCURR15MINLOSS COCURR15MINSES COCURR15MINUAS
LATUCCURR15MTIMEELAPSED CPFECS CPEES CPESES CPELOSS CPEUS CPECURR15MINLOFS
CPECURR15MINLOLS CPECURR15MINLOPS CPECURR15MINES CPECURR15MINLOSS
CPECURR15MINSES CPECURR15MINUAS LATURCURR15MTIMEELAPSED RETRAINS INITFAILS
ATURSPEED TNTO TNRO COCURR15MINEBS COCURR15MINUCBS COCURR15MINATMCELLS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 640


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

COCURR15MINPTMPKTS CHATUCCURR15MTIMEELAPSED COCURR15MINCBS COCURR15MINCVS


CPECURR15MINEBS CPECURR15MINUCBS CPECURR15MINATMCELLS CPECURR15MINPTMPKTS
CHATURCURR15MTIMEELAPSED CPECURR15MINCBS CPECURR15MINCVS COLAST15MINLOFS
COLAST15MINLOLS COLAST15MINLOPS COLAST15MINES COLAST15MINLOSS COLAST15MINSES
COLAST15MINUAS CPELAST15MINLOFS CPELAST15MINLOLS CPELAST15MINLOPS CPELAST15MINES
CPELAST15MINLOSS CPELAST15MINSES CPELAST15MINUAS COLAST15MINEBS COLAST15MINUCBS
COLAST15MINATMCELLS COLAST15MINPTMPKTS COLAST15MINCBS COLAST15MINCVS
CPELAST15MINEBS CPELAST15MINUCBS CPELAST15MINATMCELLS CPELAST15MINPTMPKTS
CPELAST15MINCBS CPELAST15MINCVS COLAST15MININITFULL COLAST15MININITFAIL
COCURR15MININITFULL COCURR15MININITFAIL COCVS CPECVS COES1DAY CPEES1DAY COSES1DAY
CPESES1DAY CURR1DAYINITFULL CURR1DAYINITFAIL COCURR15SOS CPECURR15SOS COCURR24SOS
CPECURR24SOS COALLSOS CPEALLSOS COLAST15SOS CPELAST15SOS COLAST24SOS CPELAST24SOS

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

COFECS INTEGER 0-4294967295 Indicates the


number of
forward error
correction seconds
(FECSs) of the
channel at the
central office end.
Unit: s.

COES INTEGER 0-4294967295 Indicates the


number of errored
seconds at the
central office end.
Unit: s.

COSES INTEGER 0-4294967295 Indicates the


number of
severely errored
seconds at the
central office end.
Unit: s.

COLOSS INTEGER 0-4294967295 Indicates the


number of LOSS
seconds at the
central office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 641


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COUS INTEGER 0-4294967295 Indicates the


number of
unavailable
seconds at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


FS number of loss of
frame seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


PS number of loss of
power seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


LS number of loss of
link seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINES INTEGER 0-4294967295 Indicates the


number of errored
seconds in the
current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


SS number of loss of
signal seconds in
the current 15
minutes at the
central office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 642


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINSE INTEGER 0-4294967295 Indicates the


S number of
severely errored
seconds in the
current 15
minutes at the
central office end.
Unit: s.

COCURR15MINU INTEGER 0-4294967295 Indicates the


AS number of
unavailable
seconds in the
current 15
minutes at the
central office end.
Unit: s.

LATUCCURR15MT INTEGER 0-4294967295 Indicates the


IMEELAPSED elapsed time in
the current 15
minutes at the
central office end.
Unit: s.

CPFECS INTEGER 0-4294967295 Indicates the


number of FECSs
of the channel at
the remote end.
Unit: s.

CPEES INTEGER 0-4294967295 Indicates the


number of errored
seconds at the
remote end.
Unit: s.

CPESES INTEGER 0-4294967295 Indicates the


number of
severely errored
seconds at the
remote end.
Unit: s.

CPELOSS INTEGER 0-4294967295 Indicates the


number of LOSS
seconds at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 643


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPEUS INTEGER 0-4294967295 Indicates the


number of
unavailable
seconds at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OFS number of loss of
frame seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OLS number of loss of
link seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OPS number of loss of
power seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINE INTEGER 0-4294967295 Indicates the


S number of errored
seconds in the
current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OSS number of loss of
signal seconds in
the current 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 644


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR15MINS INTEGER 0-4294967295 Indicates the


ES number of
severely errored
seconds in the
current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINU INTEGER 0-4294967295 Indicates the


AS number of
unavailable
seconds in the
current 15
minutes at the
remote end.
Unit: s.

LATURCURR15MT INTEGER 0-4294967295 Indicates the


IMEELAPSED elapsed time in
the current 15
minutes at the
remote end.
Unit: s.

RETRAINS INTEGER 0-2147483647 Indicates the


number of
complete line
initializations.

INITFAILS INTEGER 0-2147483647 Indicates the


number of
initialization
failures.

ATURSPEED INTEGER 0-4294967295 Indicates the port


rate at the remote
end.
Unit: bit/s.

TNTO INTEGER 0-2147483647 Indicates the total


number of
upstream bytes.

TNRO INTEGER 0-2147483647 Indicates the total


number of
downstream
bytes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 645


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
current 15
minutes at the
central office end.

COCURR15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected
automatically in
the current 15
minutes at the
central office end.

COCURR15MINAT INTEGER 0-4294836225 Indicates the


MCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
current 15
minutes at the
central office end.

COCURR15MINPT INTEGER 0-4294836225 Indicates the


MPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
current 15
minutes at the
central office end.

CHATUCCURR15 INTEGER 0-4294836225 Indicates the


MTIMEELAPSED elapsed time in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the current 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 646


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
current 15
minutes at the
central office end.

CPECURR15MINE INTEGER 0-4294836225 Indicates the


BS number of FEC
code blocks in the
current 15
minutes at the
remote end.

CPECURR15MINU INTEGER 0-4294836225 Indicates the


CBS number of blocks
that cannot be
corrected
automatically in
the current 15
minutes at the
remote end.

CPECURR15MINA INTEGER 0-4294836225 Indicates the


TMCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
current 15
minutes at the
remote end.

CPECURR15MINP INTEGER 0-4294836225 Indicates the


TMPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
current 15
minutes at the
remote end.

CHATURCURR15 INTEGER 0-4294836225 Indicates the


MTIMEELAPSED elapsed time in
the current 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 647


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR15MINC INTEGER 0-4294836225 Indicates the


BS number of
corrected blocks
in the channel in
the current 15
minutes at the
remote end.

CPECURR15MINC INTEGER 0-4294836225 Indicates the


VS number of the
abnormal CRC
codes in the
channel in the
current 15
minutes at the
remote end.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


FS number of loss of
frame seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


PS number of loss of
power seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


LS number of loss of
link seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINES INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 648


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MINLO INTEGER 0-4294836225 Indicates the


SS number of loss of
signal seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINSES INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

COLAST15MINUA INTEGER 0-4294836225 Indicates the


S number of
unavailable
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


FS number of loss of
frame seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


PS number of loss of
power seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


LS number of loss of
link seconds in
the last 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 649


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINES INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
last 15 minutes at
the remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


SS number of loss of
signal seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINSE INTEGER 0-4294836225 Indicates the


S number of
severely errored
seconds in the
last 15 minutes at
the remote end.
Unit: s.

CPELAST15MINU INTEGER 0-4294836225 Indicates the


AS number of
unavailable
seconds in the
last 15 minutes at
the remote end.
Unit: s.

COLAST15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected in the
channel
automatically in
the last 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 650


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MINAT INTEGER 0-4294836225 Indicates the


MCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINPT INTEGER 0-4294836225 Indicates the


MPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the last 15
minutes at the
central office end.

COLAST15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
last 15 minutes at
the central office
end.

CPELAST15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
channel in the
last 15 minutes at
the remote end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 651


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected in the
channel
automatically in
the last 15
minutes at the
remote end.

CPELAST15MINAT INTEGER 0-4294836225 Indicates the


MCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
last 15 minutes at
the remote end.

CPELAST15MINPT INTEGER 0-4294836225 Indicates the


MPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
last 15 minutes at
the remote end.

CPELAST15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the last 15
minutes at the
remote end.

CPELAST15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
last 15 minutes at
the remote end.

COLAST15MININI INTEGER 0-4294836225 Indicates the


TFULL number of full
initialization times
in the last 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 652


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MININI INTEGER 0-4294836225 Indicates the


TFAIL number of full
initialization
failures in the
past 15 minutes
at the central
office end.

COCURR15MININI INTEGER 0-4294836225 Indicates the


TFULL number of full
initialization times
within the current
15 minutes at the
central office end.

COCURR15MININI INTEGER 0-4294836225 Indicates the


TFAIL number of fill
initialization
failures within the
current 15
minutes at the
central office end.

COCVS INTEGER 0-4294836225 Indicates the


number of
abnormal CRC
codes in the
channel at the
central office end.

CPECVS INTEGER 0-4294836225 Indicates the


number of
abnormal CRC
codes in the
channel at the
remote end.

COES1DAY INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
current day at the
central office end.
Unit: s.

CPEES1DAY INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
current day at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 653


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COSES1DAY INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
current day at the
central office end.
Unit: s.

CPESES1DAY INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
current day at the
remote end.
Unit: s.

CURR1DAYINITFU INTEGER 0-4294836225 Indicates the


LL number of errored
seconds in the
current day.

CURR1DAYINITFAI INTEGER 0-4294836225 Indicates the


L number of errored
seconds in the
current day.

COCURR15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 15-minute
performance
statistics at the
central office end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 654


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 15-minute
performance
statistics at the
remote end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

COCURR24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 24-hour
performance
statistics at the
central office end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 655


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 24-hour
performance
statistics at the
remote end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

COALLSOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in all
current
performance
statistics at the
central office end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 656


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPEALLSOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in all
current
performance
statistics at the
remote end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

COLAST15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
historical 15-
minute
performance
statistics at the
central office end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 657


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
historical 15-
minute
performance
statistics at the
remote end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

COLAST24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
historical 24-hour
performance
statistics at the
central office end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 658


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
last 24-hour
performance
statistics at the
remote end.
NOTE
This parameter is
applicable only to
the MA5603T,
MA5600T,
MA5608T,
MA5616, and
MA5611S whose
versions are later
than
V800R015C10.

Error Code
ID Description Solution

1613561870 Interacting with the Verify that the


performance and performance statistics
statistic daemon failed, daemon runs in the
please check the normal state.
performance and
statistic daemon

1613561871 The performance Verify that the


statistics task does not performance statistics of
exist. the specified port is
available. If the
performance statistics is
not available, create the
performance statistics
collection task for the
port on the GUI.

Example
To query the performance statistics of VDSL2 port 0/3/15 on the 10.144.73.70, run
the following command:

LST-VDSLPORTPERF::DEV=10.144.73.70,FN=0,SN=3,PN=15:2::;

The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 659


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340047 2010-12-08 12:12:49


M 2 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
VDSL PORT Performance Stat Info of the device 10.144.73.70
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------------
DID FN SN PN COFECS COES COSES COLOSS COUS COCURR15MINLOFS
COCURR15MINLOLS COCURR15MINLOPS COCURR15MINES COCURR15MINLOSS
COCURR15MINSES COCURR15MINUAS LATUCCURR15MTIMEELAPSED CPFECS CPEES CPESES
CPELOSS CPEUS CPECURR15MINLOFS CPECURR15MINLOLS CPECURR15MINLOPS
CPECURR15MINES CPECURR15MINLOSS CPECURR15MINSES CPECURR15MINUAS
LATURCURR15MTIMEELAPSED RETRAINS INITFAILS ATURSPEED TNTO TNRO
COCURR15MINEBS COCURR15MINUCBS COCURR15MINATMCELLS COCURR15MINPTMPKTS
CHATUCCURR15MTIMEELAPSED COCURR15MINCBS COCURR15MINCVS CPECURR15MINEBS
CPECURR15MINUCBS CPECURR15MINATMCELLS CPECURR15MINPTMPKTS
CHATURCURR15MTIMEELAPSED CPECURR15MINCBS CPECURR15MINCVS COLAST15MINLOFS
COLAST15MINLOLS COLAST15MINLOPS COLAST15MINES COLAST15MINLOSS
COLAST15MINSES COLAST15MINUAS CPELAST15MINLOFS CPELAST15MINLOLS
CPELAST15MINLOPS CPELAST15MINES CPELAST15MINLOSS CPELAST15MINSES
CPELAST15MINUAS COLAST15MINEBS COLAST15MINUCBS COLAST15MINATMCELLS
COLAST15MINPTMPKTS COLAST15MINCBS COLAST15MINCVS CPELAST15MINEBS
CPELAST15MINUCBS CPELAST15MINATMCELLS CPELAST15MINPTMPKTS CPELAST15MINCBS
CPELAST15MINCVS COLAST15MININITFULL COLAST15MININITFAIL COCURR15MININITFULL
COCURR15MININITFAIL COCVS CPECVS COES1DAY CPEES1DAY COSES1DAY CPESES1DAY
CURR1DAYINITFULL CURR1DAYINITFAIL
7340047 0 3 15 41 37 0 0 15 0 0 0 0 0 0 0 778 0 38 0 0 15 0
0 0 0 0 0 0 778 1 0 200000000 0 0 318229 0 0 0 778 0 0 548283
0 0 0 778 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 368131 0 0 0 0
0 634261 0 0 0 0 0 0 0 0 0 65 48 7 7 0 0 0 0
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------
;

Related Command
● LST-VDSL2PORTDETAILINFO
● LST-VDSLPORTALARM
● ACT-VDSL2PORT

14.4.6 Querying a VDSL2 Line Profile (LST-VDSLLINEPROFILE)


Usage Note
This command is used to query a VDSL2 line profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 660


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-VDSLLINEPROFILE:::CTAG::DT=device-type[,LPROFID=line-profile-name][,SCOPEPROFID=Scope-profile-
name];

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

64 MA5651

92 MA5652G

94 MA5603U

95 MA5603T

100 MA5616

103 MA5635

2331 MA5608T

249 MA5600T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

2339 MA5818

2340 MA5611S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 661


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

LPROFID OCTET SIZE (32) (Optional) -


STRING Indicates the
name of the
VDSL2 line
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= VDSL Activation Profile of the device type+ device-type
name of attributes:LPROFID

Output Parameter
Parameter Type Range Description

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 line profile.

Error Code
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 662


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query the list of the global VDSL2 line profiles of the MA5603U, run the
following command:

LST-VDSLLINEPROFILE:::CTAG::DT=94;

The result is as follows:


0 2009-04-09 10:16:31
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
VDSL Activation Profile of the device type MA5603U
------------
LPROFID
LineTemp
------------
;

Related Command
LST-VDSLLINEPROFILEDETAIL

14.4.7 Query the Details of a VDSL2 Line Profile (LST-


VDSLLINEPROFILEDETAIL)
Usage Note
This command is used to query the details of a VDSL2 line profile.

Command Format
LST-VDSLLINEPROFILEDETAIL:::CTAG::DT=device-type,LPROFID=line-profile-name[,SCOPEPROFID=Scope-
Profile-Name][,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

64 MA5651

67 MA5651G

92 MA5652G

94 MA5603U

95 MA5603T

100 MA5616

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 663


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

103 MA5635

2331 MA5608T

249 MA5600T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

2339 MA5818

2340 MA5611S

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

LPROFID OCTET SIZE (32) Indicates the -


STRING name of the
VDSL2 line
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 664


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= VDSL Activation Profile + LPROFID + of the device type + device-type
LPROFID LCFPROFILE ADMODINDS ADMODINUS TGSNRMGDS MINSNRMGDS
MAXSNRMGDS TGSNRMGUS MINSNRMGUS MAXSNRMGUS DPBOESDEL
DPBOASEHPSDMSNUM DPBOSMINFRETN DPBOSMAXFRETN DPBOSDABMDSCA
DPBOSDABMDSCB DPBOSDABMDSCC DPBOMINABSN UPPBFTUS1 UPPBFTUS2 UPPBFTUS3
UPBOUELTC UPBORLEH CH1CFLPROFID CH1DOWNRATERATIO CH1UPRATERATIO
CH1MINRATEDS CH1MAXRATEDS CH1MINRATEUS CH1MAXRATEUS CH1MAXITDELAYDS
CH1MAXITDELAYUS CH1DATPHMOD CH1MINIMNOPTDS CH1MINIMNOPTUS CH2CFLPROFID
CH2DOWNRATERATIO CH2UPRATERATIO CH2MINRATEDS CH2MAXRATEDS CH2MINRATEUS
CH2MAXRATEUS CH2MAXITDELAYDS CH2MAXITDELAYUS CH2DATPHMOD CH2MINIMNOPTDS
CH2MINIMNOPTUS SCOPEPROFID

Output Parameter
Parameter Type Range Description

LPROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
line profile.

LCFPROFILE OCTET STRING SIZE (32) Indicates the


name of a line
configuration
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 665


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ADMODINDS OCTET STRING Fixed Indicates the


Adapt. At Startup adaptation mode
of the line
Adapt. At transmission rate
Runtime in the
Adapt. At downstream
Runtime With direction.
SOS

ADMODINUS OCTET STRING Fixed Indicates the


Adapt. At Startup adaptation mode
of the line
Adapt. At transmission rate
Runtime in the upstream
Adapt. At direction.
Runtime With
SOS

TGSNRMGDS INTEGER 0-310 Indicates the


mandatory
downstream SNR
margin for a
successful training
whose bit error
code ratio is lower
than or equal to
10-7.
The target SNR
margin functions
only during the
training.
Unit: 0.1 dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 666


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MINSNRMGDS INTEGER 0-60 Indicates the


minimum
downstream SNR
margin.
When the line
condition is
deteriorated and
the SNR margin is
less than the
minimum SNR
margin, it
indicates that the
current line
condition (SNR)
cannot bear so
many bits. In this
case, you need to
increase the line
SNR by increasing
the transmit
power, so as to
meet the
requirement of
the current line
rate. If the
minimum SNR
margin cannot be
reached even by
increasing the
transmit power,
the line must be
re-trained.
The minimum
SNR margin
functions after
the line is
activated.
Unit: 0.1 dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 667


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAXSNRMGDS INTEGER 60-310 Indicates the


maximum
downstream SNR
margin.
The SNR margin
refers to the space
that is reserved
when the system
allocates bits to
sub-channels.
When the line
environment
change (such as
the environment
temperature,
humidity, and
background
noise) results in
the decrease of
the sub-channel
SNR, if the
decrease range is
within the SNR
margin, the bit
error code ratio of
the transmission
can stay less than
10-7.
When the line is
in good condition
good and the SNR
margin exceeds
the maximum
SNR margin, the
VDSL2 chipset
reduces the line
SNR by reducing
the transmit
power which can
still meet the
requirement of
the current line
rate.
The maximum
SNR margin
functions after
the line is
activated.
Unit: 0.1 dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 668


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TGSNRMGUS INTEGER 0-310 Indicates the


mandatory
upstream SNR
margin for a
successful training
whose bit error
code ratio is lower
than or equal to
10-7.
The target SNR
margin functions
only during the
training.
Unit: 0.1 dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 669


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MINSNRMGUS INTEGER 0-60 Indicates the


minimum
upstream SNR
margin.
When the line
condition is
deteriorated and
the SNR margin is
less than the
minimum SNR
margin, it
indicates that the
current line
condition (SNR)
cannot bear so
many bits. In this
case, you need to
increase the line
SNR by increasing
the transmit
power, so as to
meet the
requirement of
the current line
rate. If the
minimum SNR
margin cannot be
reached even by
increasing the
transmit power,
the line must be
re-trained.
The minimum
SNR margin
functions after
the line is
activated.
Unit: 0.1 dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 670


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAXSNRMGUS INTEGER 60-310 Indicates the


maximum
upstream SNR
margin.
The SNR margin
refers to the space
that is reserved
when the system
allocates bits to
sub-channels.
When the line
environment
change (such as
the environment
temperature,
humidity, and
background
noise) results in
the decrease of
the sub-channel
SNR, if the
decrease range is
within the SNR
margin, the bit
error code ratio of
the transmission
can stay less than
10-7.
When the line is
in good condition
good and the SNR
margin exceeds
the maximum
SNR margin, the
VDSL2 chipset
reduces the line
SNR by reducing
the transmit
power which can
still meet the
requirement of
the current line
rate.
The maximum
SNR margin
functions after
the line is
activated.
Unit: 0.1 dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 671


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DPBOESDEL INTEGER 0-511 Indicates the


electrical distance
between the
central office and
the remote mini-
DSLAM, that is,
the attenuation
(dB) from the
central office to
the remote mini-
DSLAM.
Dependency on
other
parameters:
If this parameter
is set to 0, it
indicates that the
DPBO function is
disabled. That is,
the other DPBO
parameters gray
out and become
read-only.
Unit: 0.5 dB.

DPBOASEHPSDM INTEGER - Indicates the


SNUM number of DPBO
PSD masks.

DPBOSMINFRETN INTEGER 0-2048 Indicates the


minimum
frequency point
within the
frequency range
of the DPBO
function.
Dependency on
other
parameters:
When DPBO E-
side electrical
length is set to
other values than
0, this parameter
is available.
Unit: Tone

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 672


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DPBOSMAXFRETN INTEGER 32-6956 Indicates the


maximum
frequency point
within the
frequency range
of the DPBO
function.
Dependency on
other
parameters:
When DPBO E-
side electrical
length is set to
other values than
0, this parameter
is available.
Unit: Tone

DPBOSDABMDSC INTEGER 0-640 Indicates the


A DPBO E-side cable
model scalar A.

DPBOSDABMDSC INTEGER 0-640 Indicates the


B DPBO E-side cable
model scalar B.

DPBOSDABMDSC INTEGER 0-640 Indicates the


C DPBO E-side cable
model scalar C.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 673


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DPBOMINABSN INTEGER - Indicates the


virtual minimum
valid PSD for the
cabinet. That is,
the noise PSD on
the line, or the
base noise value.
If the calculated
PSD value is less
than the base
noise value, the
part below the
base noise value
must be shaped
accordingly during
the process for
setting the actual
PSD mask. This
also reduces the
maximum
frequency points
that are in
function.
Dependency on
other
parameters:
When DPBO E-
side electrical
length is set to
other values than
0, this parameter
is available.

UPPBFTUS1 INTEGER - Indicates a


parameter of
upstream
frequency bands
1.

UPPBFTUS2 INTEGER - Indicates a


parameter of
upstream
frequency bands
2.

UPPBFTUS3 INTEGER - Indicates a


parameter of
upstream
frequency bands
3.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 674


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

UPBOUELTC OCTET STRING Force Specifies whether


Auto to forcibly use the
distance
attenuation value
specified by the
central office, that
is, whether the
CPE is forcibly to
use the electrical
length specified
by the central
office to calculate
the UPBO.

UPBORLEH INTEGER 0-1280 Indicates the


upstream
electrical length,
that is, the
distance
attenuation value
set by the central
office.
Dependency on
other
parameters:
When
UPBOUELTC used
to compute UPBO
is set to Force,
this parameter is
available.
Unit: 0.1 dB.

CH1CFLPROFID OCTET STRING SIZE (32) Indicates the


channel
configuration
profile for channel
1 on the VDSL2
line.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 675


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1DOWNRATER INTEGER 0-100 Indicates the


ATIO downstream rate
adaptation ratio
of channel 1.
NOTE
When the
downstream rate
adaptation ratio of
channel 1 is less
than 100%, the
downstream rate
adaptation ratio of
channel 1 is
automatically
calculated as 100%
minus the
upstream rate
adaptation ratio of
channel 1.

CH1UPRATERATI INTEGER 0-100 Indicates the


O upstream rate
adaptation ratio
of channel 1.
NOTE
When the
upstream rate
adaptation ratio of
channel 1 is less
than 100%, the
upstream rate
adaptation ratio of
channel 1 is
automatically
calculated as 100%
minus the
downstream rate
adaptation ratio of
channel 1.

CH1MINRATEDS INTEGER 32-200000 Indicates the


minimum
downstream
transmission rate
of channel 1.
Unit: kbit/s.

CH1MAXRATEDS INTEGER 32-200000 Indicates the


maximum
downstream
transmission rate
of channel 1.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 676


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1MINRATEUS INTEGER 32-200000 Indicates the


minimum
upstream
transmission rate
of channel 1.
Unit: kbit/s.

CH1MAXRATEUS INTEGER 32-200000 Indicates the


maximum
upstream
transmission rate
of channel 1.
Unit: kbit/s.

CH1MAXITDELAY INTEGER 0-200 Indicates the


DS maximum
downstream
interleaving delay
of channel 1.
Unit: ms.

CH1MAXITDELAY INTEGER 0-200 Indicates the


US maximum
upstream
interleaving delay
of channel 1.
Unit: ms.

CH1DATPHMOD OCTET STRING ATM Indicates the


PTM format of channel
1.
Both

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 677


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1MINIMNOPT OCTET STRING noProtection Indicates the


DS halfSymbol minimum
downstream
singleSymbol impulse noise
twoSymbols protection of
threeSymbols channel 1.
fourSymbols
fiveSymbols
sixSymbols
sevenSymbols
eightSymbols
nineSymbols
tenSymbols
elevenSymbols
twelveSymbols
thirteenSymbols
fourteenSymbols
fifteenSymbols
sixteenSymbols

CH1MINIMNOPT OCTET STRING noProtection Indicates the


US halfSymbol minimum
upstream impulse
singleSymbol noise protection
twoSymbols of channel 1.
threeSymbols
fourSymbols
fiveSymbols
sixSymbols
sevenSymbols
eightSymbols
nineSymbols
tenSymbols
elevenSymbols
twelveSymbols
thirteenSymbols
fourteenSymbols
fifteenSymbols
sixteenSymbols

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 678


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2CFLPROFID OCTET STRING SIZE (32) Indicates the


channel
configuration
profile for channel
2 on the VDSL2
line.

CH2DOWNRATER INTEGER 0-100 Indicates the


ATIO downstream rate
adaptation ratio
of channel 2.
NOTE
When the
downstream rate
adaptation ratio of
channel 2 is less
than 100%, the
downstream rate
adaptation ratio of
channel 2 is
automatically
calculated as 100%
minus the
upstream rate
adaptation ratio of
channel 2.

CH2UPRATERATI INTEGER 0-100 Indicates the


O upstream rate
adaptation ratio
of channel 2.
NOTE
When the
upstream rate
adaptation ratio of
channel 2 is less
than 100%, the
upstream rate
adaptation ratio of
channel 2 is
automatically
calculated as 100%
minus the
downstream rate
adaptation ratio of
channel 2.

CH2MINRATEDS INTEGER 32-200000 Indicates the


minimum
downstream
transmission rate
of channel 2.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 679


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2MAXRATEDS INTEGER 32-200000 Indicates the


maximum
downstream
transmission rate
of channel 2.
Unit: kbit/s.

CH2MINRATEUS INTEGER 32-200000 Indicates the


minimum
upstream
transmission rate
of channel 2.
Unit: kbit/s.

CH2MAXRATEUS INTEGER 32-200000 Indicates the


maximum
upstream
transmission rate
of channel 2.
Unit: kbit/s.

CH2MAXITDELAY INTEGER 0-200 Indicates the


DS maximum
downstream
impulse noise
protection of
channel 2.
Unit: ms.

CH2MAXITDELAY INTEGER 0-200 Indicates the


US maximum
upstream impulse
noise protection
of channel 2.
Unit: ms.

CH2DATPHMOD OCTET STRING ATM Indicates the


PTM format of channel
2.
Both

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 680


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2MINIMNOPT OCTET STRING noProtection Indicates the


DS halfSymbol minimum
downstream
singleSymbol impulse noise
twoSymbols protection of
threeSymbols channel 2.
fourSymbols
fiveSymbols
sixSymbols
sevenSymbols
eightSymbols
nineSymbols
tenSymbols
elevenSymbols
twelveSymbols
thirteenSymbols
fourteenSymbols
fifteenSymbols
sixteenSymbols

CH2MINIMNOPT OCTET STRING noProtection Indicates the


US halfSymbol minimum
upstream impulse
singleSymbol noise protection
twoSymbols of channel 2.
threeSymbols
fourSymbols
fiveSymbols
sixSymbols
sevenSymbols
eightSymbols
nineSymbols
tenSymbols
elevenSymbols
twelveSymbols
thirteenSymbols
fourteenSymbols
fifteenSymbols
sixteenSymbols

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 681


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
None

Example
To query the details of a VDSL2 line profile, run the following command.
LST-VDSLLINEPROFILEDETAIL:::CTAG::DT=94,LPROFID=DEFVAL;
The result is as follows:
0 2009-04-09 10:17:08
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
VDSL Activation Profile DEFVAL of the device type MA5603U
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-----------------------
LPROFID LCFPROFILE ADMODINDS ADMODINUS TGSNRMGDS MINSNRMGDS
MAXSNRMGDS TGSNRMGUS MINSNRMGUS MAXSNRMGUS DPBOESDEL
DPBOASEHPSDMSNUM DPBOSMINFRETN DPBOSMAXFRETN DPBOSDABMDSCA
DPBOSDABMDSCB DPBOSDABMDSCC DPBOMINABSN UPPBFTUS1 UPPBFTUS2 UPPBFTUS3
UPBOUELTC UPBORLEH CH1CFLPROFID CH1DOWNRATERATIO CH1UPRATERATIO
CH1MINRATEDS CH1MAXRATEDS CH1MINRATEUS CH1MAXRATEUS CH1MAXITDELAYDS
CH1MAXITDELAYUS CH1DATPHMOD CH1MINIMNOPTDS CH1MINIMNOPTUS CH2CFLPROFID
CH2DOWNRATERATIO CH2UPRATERATIO CH2MINRATEDS CH2MAXRATEDS CH2MINRATEUS
CH2MAXRATEUS CH2MAXITDELAYDS CH2MAXITDELAYUS CH2DATPHMOD CH2MINIMNOPTDS
CH2MINIMNOPTUS
DEFVAL LineConf Adapt. At Startup Adapt. At Startup 60 12 300 60 13 300 0 0 0
32 0 0 0 0 1650, 1020 1650, 615 0, 0 Auto 0 100 100 128 100000 128
100000 21 22 Both noProtection noProtection -- -- -- -- -- -- -- -- -- -- --
--
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-----------------------
;

Related Command
LST-VDSLLINEPROFILE

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 682


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.4.8 Querying a VDSL2 Alarm Profile (LST-


VDSLALARMPROFILE)
Usage Note
This command is used to query the VDSL2 alarm profiles.

Command Format
LST-VDSLALARMPROFILE:::CTAG::DT=device-type[,APROFID=alarm-profile-name][,SCOPEPROFID=Scope-
profile-name];

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

64 MA5651

92 MA5652G

94 MA5603U

95 MA5603T

100 MA5616

103 MA5635

2331 MA5608T

249 MA5600T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

2339 MA5818

2340 MA5611S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 683


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

APROFID OCTET SIZE (32) (Optional) -


STRING Indicates the
name of the
VDSL2 alarm
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Specifies
whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=VDSL Activation Profile of the device type +device-type
APROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 684


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

APROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 alarm
profile.

Error Code
None

Example
To query the list of the global VDSL2 alarm profiles of the MA5603U, run the
following command:
LST-VDSLALARMPROFILE:::CTAG::DT=94,SCOPEPROFID=Default;
The result is as follows:
0 2009-04-09 10:17:38
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
VDSL Activation Profile of the device type MA5603U
------------
APROFID
AlarmTemp
------------
;

Related Command
LST-VDSLALARMPROFILEDETAIL

14.4.9 Query the Details of a VDSL2 Alarm Profile (LST-


VDSLALARMPROFILEDETAIL)
Usage Note
This command is used to query the details of a VDSL2 alarm profile.

Command Format
LST-VDSLALARMPROFILEDETAIL:::CTAG::DT=device-type,APROFID=alarm-profile-
name[,SCOPEPROFID=Scope-Profile-Name][,SHOWOPTION=SCOPEPROFID];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 685


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

64 MA5651

92 MA5652G

94 MA5603U

95 MA5603T

100 MA5616

103 MA5635

2331 MA5608T

249 MA5600T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

253 UA5000 (IPMB)

2339 MA5818

2340 MA5611S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 686


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

APROFID OCTET SIZE (32) (Optional) -


STRING Indicates the
name of the
VDSL2 alarm
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 687


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= VDSL Activation Profile AlarmTemp of the device type + device-type
APROFID LACFPROFILE COTVFEC COTVE COTVSE COTVSL COTVU CPTVFEC CPTVE
CPTVSE CPTVSL CPTVU TVFUF CH1ACFPROFILE CH1CVCV CH1CVCB CH1CVCV CH1CVCB
CH1TCMRDS CH1TCMRUS CH2ACFPROFILE CH2CVCV CH2CVCB CH2CVCV CH2CVCB
CH2TCMRDS CH2TCMRUS SCOPEPROFID

Output Parameter
Parameter Type Range Description

APROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 alarm
profile.

LACFPROFILE OCTET STRING SIZE (32) Indicates the


name of a line
alarm
configuration
profile. It uniquely
identifies a line
alarm
configuration
profile.

COTVFEC INTEGER 0-900 Indicates the


threshold of the
FECS at the
central office.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

COTVE INTEGER 0-900 Indicates the ES


threshold at the
central office.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 688


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COTVSE INTEGER 0-900 Indicates the SES


threshold at the
central office.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

COTVSL INTEGER 0-900 Indicates the


LOSS threshold at
the central office.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

COTVU INTEGER 0-900 Indicates the UAS


threshold at the
central office.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

CPTVFEC INTEGER 0-900 Indicates the FECS


threshold at the
remote end.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 689


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPTVE INTEGER 0-900 Indicates the ES


threshold at the
remote end.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

CPTVSE INTEGER 0-900 Indicates the SES


threshold at the
remote end.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

CPTVSL INTEGER 0-900 Indicates the


LOSS threshold at
the remote end.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

CPTVU INTEGER 0-900 Indicates the UAS


threshold at the
remote end.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 690


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TVFUF INTEGER 0-900 Indicates the


threshold of VTU-
R full initialization
failures.
Unit: s.

CH1ACFPROFILE OCTET STRING SIZE (32) Indicates the


channel alarm
configuration
profile for channel
1 on the VDSL2
line.

CH1CVCV INTEGER 0-60000 Indicates the


count of the cyclic
redundancy code
errors for channel
1 at the central
office or remote
end. When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
NOTE
In the response
message, the first
returned CH1CVCV
represents the
count of the cyclic
redundancy code
errors for channel
1 at the central
office; the second
returned CH1CVCV
represents the
count of the cyclic
redundancy code
errors for channel
1 at the remote
end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 691


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1CVCB INTEGER 0-60000 Indicates the


count of
correctable data
blocks in the
forward error
code check for
channel 1 at the
central office or
remote end.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
NOTE
In the response
message, the first
returned CH1CVCB
represents the
count of
correctable data
blocks in the
forward error code
check for channel
1 at the central
office; the second
returned CH1CVCB
represents the
count of
correctable data
blocks in the
forward error code
check for channel
1 at the remote
end.

CH1TCMRDS INTEGER 0-100000 Indicates the


threshold of the
downstream rate
for channel 1,
which monitors
the channel
activation rate. If
the activation rate
of the current
channel does not
reach the
threshold, an
alarm is
generated.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 692


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1TCMRUS INTEGER 0-100000 Indicates the


threshold of the
upstream rate for
channel 1, which
monitors the
channel activation
rate. If the
activation rate of
the current
channel does not
reach the
threshold, an
alarm is
generated.
Unit: kbit/s.

CH2ACFPROFILE OCTET STRING SIZE (32) Indicates the


channel alarm
configuration
profile for channel
2 on the VDSL2
line.

CH2CVCV INTEGER 0-60000 Indicates the


count of the cyclic
redundancy code
errors for channel
2 at the central
office. When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
NOTE
In the response
message, the first
returned CH2CVCV
represents the
count of cyclic
redundancy code
errors for channel
2 at the central
office; the second
returned CH2CVCV
represents the
count of cyclic
redundancy code
errors for channel
2 at the remote
end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 693


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2CVCB INTEGER 0-60000 Indicates the


count of
correctable data
blocks in the
forward error
code check for
channel 2 at the
central office.
When the
measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.
NOTE
In the response
message, the first
returned CH2CVCB
represents the
count of
correctable data
blocks in the
forward error code
check for channel
2 at the central
office; the second
returned CH2CVCB
represents the
count of
correctable data
blocks in the
forward error code
check for channel
2 at the remote
end.

CH2CVCV INTEGER 0-60000 Indicates the


count of the cyclic
redundancy code
errors at the
remote end for
channel 2. When
the measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 694


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2CVCB INTEGER 0-60000 Indicates the


count of
correctable data
blocks in the
forward error
code check at the
remote end for
channel 2. When
the measurement
entry reaches the
threshold within
15 minutes, an
alarm is
generated.

CH2TCMRDS INTEGER 0-100000 Indicates the


threshold of the
downstream rate
for channel 2,
which monitors
the channel
activation rate. If
the activation rate
of the current
channel does not
reach the
threshold, an
alarm is
generated.
Unit: kbit/s.

CH2TCMRUS INTEGER 0-100000 Indicates the


threshold of the
upstream rate for
channel 2, which
monitors the
channel activation
rate. If the
activation rate of
the current
channel does not
reach the
threshold, an
alarm is
generated.
Unit: kbit/s.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 695


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
None

Example
To query the details of a VDSL2 alarm profile, run the following command.
LST-VDSLALARMPROFILEDETAIL:::CTAG::DT=94,APROFID=AlarmTemp;
The result is as follows:
0 2009-04-09 10:18:03
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
VDSL Activation Profile AlarmTemp of the device type MA5603U
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----
APROFID LACFPROFILE COTVFEC COTVE COTVSE COTVSL COTVU CPTVFEC CPTVE
CPTVSE CPTVSL CPTVU TVFUF CH1ACFPROFILE CH1CVCV CH1CVCB CH1CVCV CH1CVCB
CH1TCMRDS CH1TCMRUS CH2ACFPROFILE CH2CVCV CH2CVCB CH2CVCV CH2CVCB
CH2TCMRDS CH2TCMRUS
AlarmTemp LineAlarmConf 1 2 3 4 5 6 7 8 9 10 11 ChannelAlarmConf 1 2
3 4 5 6 -- -- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----
;

Related Command
LST-VDSLALARMPROFILE

14.4.10 Querying the Alarm Status of an xDSL Port (LST-


XDSLPORTALARMSTATE)
Usage Note
This command is used to query the alarm status of an xDSL port or a G.fast port
in the common mode (RFC2662), TI mode or TR165 mode.

Command Format
LST-XDSLPORTALARMSTATE::(DID=device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 696


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

95 MA5603T
● TR165 mode and TI mode: MA5600
V800R008 and later versions
● Common mode: MA5600
V800R006C02, MA5600
V800R007C01, MA5600V800R008
and later versions

100 MA5616
● ADSL port in TR165 mode: MA5616
V800R308C00 and later versions
● VDSL2 port in common mode:
MA5616 V800R309C00 and later
versions

2331 MA5608T
● VDSL2 port in TR165 mode

249 MA5600T
● TR165 mode and TI mode: MA5600
V800R008 and later versions
● Common mode: MA5600
V800R006C02, MA5600
V800R007C01, MA5600V800R008
and later versions

2340 MA5611S
● VDSL2 port in TR165 mode

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 697


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port alarm of the device: " + device name + "frameId:" + frame number + "slotId:" + slot-number +
"portId:"+ port number
name of attributes:DID FN SN PN COLOF COLOS COLPR COLOSQ COLOL CODIF COCIF COPIF COIF
CONPAP CPELOF CPELOS CPELPR CPELOSQ

Output Parameter

If no mode is specified for a parameter, the parameter is supported by the common mode
(RFC2662), TI mode, and TR165 mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 698


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

COLOF OCTET STRING ● Yes Specifies whether


● No Loss of Frame
alarms are
generated at the
central office
(CO).

COLOS OCTET STRING ● Yes Specifies whether


● No Loss of Signal
alarms are
generated at the
CO.

COLPR OCTET STRING ● Yes Specifies whether


● No Loss of Power
alarms are
generated at the
CO.

COLOSQ OCTET STRING ● Yes Specifies whether


● No Loss of Signal
Quality alarms
are generated at
the CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COLOL OCTET STRING ● Yes Specifies whether


● No Loss of Link
alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 699


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CODIF OCTET STRING ● Yes Specifies whether


● No Data Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COCIF OCTET STRING ● Yes Specifies whether


● No Configuration
Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COPIF OCTET STRING ● Yes Specifies whether


● No Protocol
Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COIF OCTET STRING ● Yes Specifies whether


● No Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 700


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CONPAP OCTET STRING ● Yes Specifies whether


● No No Peer ATU
Present alarms
are generated at
the CO.
NOTE
ADSL ports in
common mode
support this
parameter.

CPELOF OCTET STRING ● Yes Specifies whether


● No Loss of Frame
alarms are
generated at the
remote end.

CPELOS OCTET STRING ● Yes Specifies whether


● No Loss of Signal
alarms are
generated at the
remote end.

CPELPR OCTET STRING ● Yes Specifies whether


● No Loss of Power
alarms are
generated at the
remote end.

CPELOSQ OCTET STRING ● Yes Specifies whether


● No Loss of Signal
Quality alarms
are generated at
the remote end.
NOTE
ADSL ports in
common mode
support this
parameter.

Error Code
ID Description Solution

2689014668 Port type is invalid Verify that the input port


type is ADSL, VDSL2 or
G.fast.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 701


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058552 The resource does not exist. Verify that the input port
exists. If it exists,
synchronize the port on the
NMS.

Example
To query the alarm status of port 0/8/5 on the device named 10.71.59.35, an
ADSL port in TR165 mode, run the following command:

LST-XDSLPORTALARMSTATE::DEV=10.71.59.35,FN=0,SN=8,PN=5:CTAG::;
The result is as follows:
7340032 2011-09-06 10:43:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Port alarm of the device:10.71.59.35 frameId:0 slotId:8 portId:5


--------------------------------------------------------------------------------
--------------------------------------------
DID FN SN PN COLOF COLOS COLPR COLOSQ COLOL CODIF
COCIF COPIF COIF CONPAP CPELOF CPELOS CPELPR CPELOSQ
7340032 0 8 5 No No No -- -- --
-- -- No -- No No No --
--------------------------------------------------------------------------------
--------------------------------------------

Related Command
None

14.4.11 Querying Bit Allocation Information About a VDSL2


Port (LST-VDSL2BITALLOCINFO)

Usage Note
The VDSL2 port must be in the activated state.

Command Format
LST-VDSL2BITALLOCINFO::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::DIRECTION=line-direction;

Supporting Device
Device Type No. Device Type

95 MA5603T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 702


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

100 MA5616

2331 MA5608T

249 MA5600T

2339 MA5818

2340 MA5611S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 703


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DIRECTION OCTET UP Indicates the -


STRING DOWN bit allocation
direction of
the VDSL2
port.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The bit allot information of vdsl2 port " + device-name + " frameId " + frame-number
+ " slotId " + slot-number + " portId "+ port-number + " direction " + line-direction
name of attributes: DID FN SN PN SubcarrierId BitInfo

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

SubcarrierId INTEGER 0-4095 Indicates the ID of


the upstream/
downstream sub-
carrier.

BitInfo INTEGER 0-15 Indicates bit


allocation
information about
the sub-carrier.
Unit: byte.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 704


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid Check whether the port to be


queried is a VDSL2 port.

Example
To query the bit allocation information about VDSL2 port 0/13/30 on the device
named 10.144.199.35, run the following command:
LST-
VDSL2BITALLOCINFO::DEV=10.144.199.35,FN=0,SN=13,PN=30:CTAG::DIRECTIO
N=DOWN;
The result is as follows:
7340178 2011-07-09 15:28:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4096
blktotal=4096
The bit allot information of adsl port 10.144.199.35 frameId:0 slotId:13 portId:30 direction:DOWN
-------------------------------------------
DID FN SN PN SubcarrierId BitInfo
7340110 0 13 30 0 0
7340110 0 13 30 1 0
7340110 0 13 30 2 0
7340110 0 13 30 3 0
7340110 0 13 30 4 0
7340110 0 13 30 5 0
7340110 0 13 30 6 0
7340110 0 13 30 7 7
7340110 0 13 30 8 9
7340110 0 13 30 9 11
......
7340110 0 13 30 4090 11
7340110 0 13 30 4091 11
7340110 0 13 30 4092 11
7340110 0 13 30 4093 11
7340110 0 13 30 4094 11
7340110 0 13 30 4095 11
-------------------------------------------
;

Related Command
ACT-VDSL2PORT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 705


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.4.12 Querying the U-MAC/V-MAC of an xDSL Port (LST-


XDSLPORTMACMAPING)
Usage Note
This command is used to query the U-MAC and V-MAC of an ADSL, VDSL2, or
G.fast port.

Command Format
LST-XDSLPORTMACMAPING::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T

100 MA5616
● ADSL port in TR165 mode: MA5616
V800R308C00 and later versions
● VDSL2 port in common mode:
MA5616 V800R309C00 and later
versions

2331 MA5608T

249 MA5600T

2340 MA5611S

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 706


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The mac address information of xdsl port " + device-name + " frameId " + frame-number
+ " slotId " + slot-number + " portId "+ port-number
name of attributes: DID FN SN PN UMAC VMAC

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 707


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

UMAC OCTET STRING SIZE (1-17) Indicates the U-


MAC list.

VMAC OCTET STRING SIZE (1-17) Indicates the V-


MAC list.

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid Check whether the port to be


queried is an ADSL, VDSL2, or
G.fast port.

Example
To query the U-MAC and V-MAC of xDSL port 0/13/30 on the device named
10.144.199.35, run the following command:
LST-XDSLPORTMACMAPING::DEV=10.144.199.35,FN=0,SN=13,PN=30:CTAG::;
The result is as follows:
7340178 2011-07-09 15:28:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=10
blktotal=10

The mac address information of xdsl port 10.144.199.35 frameId:0 slotId:13 portId:30
--------------------------------
DID FN SN PN UMAC VMAC
7340110 0 13 30 00-50-BA-50-73-2E 02-00-00-06-0A-40

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 708


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340110 0 13 30 00-50-BA-50-73-25 02-00-00-06-0A-41


7340110 0 13 30 00-50-BA-50-73-26 02-00-00-06-0A-42
7340110 0 13 30 00-50-BA-50-73-27 02-00-00-06-0A-43
7340110 0 13 30 00-50-BA-50-73-28 02-00-00-06-0A-44
7340110 0 13 30 00-50-BA-50-73-29 02-00-00-06-0A-45
7340110 0 13 30 00-50-BA-50-73-2A 02-00-00-06-0A-46
7340110 0 13 30 00-50-BA-50-73-2B 02-00-00-06-0A-47
7340110 0 13 30 00-50-BA-50-73-2C 02-00-00-06-0A-48
7340110 0 13 30 00-50-BA-50-73-2D 02-00-00-06-0A-49
--------------------------------

Related Command
● ACT-ADSLPORT
● ACT-VDSL2PORT
● ACT-GFASTPORT

14.4.13 Querying Global VDSL2 Profile Names (LST-


PROFNAME)
Usage Note
This command is used to query names of global VDSL2 profiles.

Command Format
LST-PROFNAME:::CTAG::DT=device-type,PROFTYPE=profile-type[,PROFNAME=profile-name]
[,SCOPEPROFID=Scope-profile-name];

Supporting Device
Device Type No. Device Type

95 MA5603T

2331 MA5608T

249 MA5600T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the N/A


Supporting device type.
Device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 709


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PROFTYPE INTEGER ● 15 Indicates the N/A


● 19 profile type.
● 42 The meanings
of the options
● 45 are as follows:
● 46 ● 15: VDSL2
● 47 line profile
● 48 ● 19: VDSL2
● 49 alarm
profile
● 42: VDSL2
spectrum
profile
● 45: VDSL2
UPBO
profile
● 46: VDSL2
DPBO
profile
● 47: VDSL2
SNR
margin
profile
● 48: VDSL2
delay-INP
profile
● 49: VDSL2
service
profile

PROFNAME OCTET SIZE (32) (Optional) N/A


STRING Indicates the
name of the
profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=Profile name of the device type + device-type and profile type "+profile-type"
name of attributes: PROFNAME

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 710


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

PROFNAME OCTET STRING SIZE (32) Indicates the


name of the
profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
To query the names of the global VDSL2 line profiles of the MA5603T, run the
following command:
LST-PROFNAME:::CTAG::DT=95,PROFTYPE=15;
The result is as follows:
0 2012-08-22 10:12:06
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2

Profile name of the device type MA5603T and profile type 15


-------------
PROFNAME
lianlu
lianlu2
-------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 711


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.4.14 Querying NE-side VDSL2 Profile Names (TI Mode)


In TI mode, parameters in the VDSL2 profiles are regrouped and classified by
items such as type and application frequency. Through northbound TL1 interfaces
(TL1 NBIs), you can query names of the following NE-side VDSL2 profiles in TI
mode: VDSL2 service profile, VDSL2 UPBO profile, VDSL2 DPBO profile, VDSL2
spectrum profile, VDSL2 alarm profile, VDSL2 SNR margin profile, and VDSL2
delay-INP profile.

14.4.14.1 Querying VDSL2 Service Profile Names (LST-VDSLSERVICEPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 service profiles in TI
mode. You can query all NE-side VDSL2 service profiles or query specific profiles
by common characters in profile names.
To ensure accurate query results, synchronize NE-side VDSL2 service profiles to the
NCE before running this command.

Command Format
LST-VDSLSERVICEPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=service-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 712


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2 service
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 Service Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 713


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
service profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 service profile whose name contains characters
"aa" on the device named 10.78.217.230, run the following command:
LST-VDSLSERVICEPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;
The result is as follows:
0 2010-11-17 11:30:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 Service Profile of the Device


----------------
DID PROFID
7340375 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 714


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.14.2 Querying VDSL2 UPBO Profile Names (LST-VDSLUPBOPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 UPBO profiles in TI
mode. You can query all NE-side VDSL2 UPBO profiles or query specific profiles by
common characters in profile names.
To ensure accuracy query results, synchronize NE-side VDSL2 UPBO profiles to the
NCE before running this command.

Command Format
LST-VDSLUPBOPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=UPBO-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 715


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2 UPBO
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 UPBO Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 716


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
UPBO profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 UPBO profile whose name contains characters
"aa" on the device named 10.78.217.230, run the following command:
LST-VDSLUPBOPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;
The result is as follows:
0 2010-11-17 11:30:53
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 UPBO Profile of the Device


----------------
DID PROFID
7340375 aaa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 717


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.14.3 Querying VDSL2 DPBO Profile Names (LST-VDSLDPBOPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 DPBO profiles in TI
mode. You can query all NE-side VDSL2 DPBO profiles or query specific profiles by
common characters in profile names.
To ensure accurate query results, synchronize NE-side VDSL2 DPBO profiles to the
NCE before running this command.

Command Format
LST-VDSLDPBOPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=DPBO-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 718


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2 DPBO
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 DPBO Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 719


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
DPBO profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 DPBO profile whose name contains characters
"aa" on the device named 10.78.217.230, run the following command:
LST-VDSLDPBOPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;
The result is as follows:
0 2010-11-17 11:31:14
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 DPBO Profile of the Device


----------------
DID PROFID
7340375 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 720


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.14.4 Querying VDSL2 Spectrum Profile Names (LST-VDSLSPECPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 spectrum profiles in TI
mode. You can query all NE-side VDSL2 spectrum profiles or query specific profiles
by common characters in profile names.
To ensure accurate query result, synchronize NE-side VDSL2 spectrum profiles to
the NCE before you run this command.

Command Format
LST-VDSLSPECPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=spectrum-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 721


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2
spectrum
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 SPEC Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 722


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
spectrum profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 spectrum profile whose name contains characters
"aa" on the device named 10.78.217.230, run the following command:
LST-VDSLSPECPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;
The result is as follows:
0 2010-11-17 11:31:34
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 SPEC Profile of the Device


----------------
DID PROFID
7340375 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 723


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.14.5 Querying VDSL2 Alarm Profile Names (LST-VDSLTIALARMPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 alarm profiles in TI
mode. You can query all NE-side VDSL2 alarm profiles or query specific profiles by
common characters in profile names.
To ensure accurate query results, synchronize NE-side VDSL2 alarm profiles to the
NCE before running this command.

Command Format
LST-VDSLTIALARMPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=alarm-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 724


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2 alarm
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 ALARM Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 725


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
alarm profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 alarm profile whose name contains characters
"aa" on the device named 10.78.217.230, run the following command:
LST-VDSLTIALARMPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;
The result is as follows:
0 2010-11-17 11:31:59
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 ALARM Profile of the Device


----------------
DID PROFID
7340375 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 726


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.14.6 Querying VDSL2 SNR Margin Profile Names (LST-VDSLNMPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 noise margin profiles in
TI mode. You can query all NE-side VDSL2 noise margin profiles or query specific
profiles by common characters in profile names.
To ensure accurate query results, synchronize NE-side VDSL2 noise margin profiles
to the NCE before running this command.

Command Format
LST-VDSLNMPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=noise-margin-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 727


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2 noise
margin
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 NM Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 728


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
noise margin
profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 noise margin profile whose name contains
characters "aa" on the device named 10.78.217.230, run the following command:

LST-VDSLNMPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;

The result is as follows:


0 2010-11-17 11:32:28
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 NM Profile of the Device


----------------
DID PROFID
7340375 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 729


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.14.7 Querying VDSL2 Delay INP Profiles (LST-VDSLINPPROFILE)

Usage Note
This command is used to query names of NE-side VDSL2 delay impulse noise
protection (INP) profiles in TI mode. You can query all NE-side VDSL2 delay INP
profiles or query specific profiles by common characters in profile names.
To ensure accurate query results, synchronize NE-side VDSL2 delay INP profiles to
the NCE before running this command.

Command Format
LST-VDSLINPPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=delay-inp-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 730


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
VDSL2 delay
INP profiles.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 INP Profile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 731


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a VDSL2
delay INP profiles.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
In TI mode, to query the VDSL2 delay INP profile whose name contains characters
"aa" on the device named 10.78.217.230, run the following command:
LST-VDSLINPPROFILE:::CTAG::DEV=10.78.217.230,PROFID=aa;
The result is as follows:
0 2010-11-17 11:32:51
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 INP Profile of the Device


----------------
DID PROFID
7340375 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 732


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.4.15 Querying the Performance Statistics on a GPON ONT


VDSL2 Port (LST-ONTVDSLPORTPERF)
Usage Note
This command is used to query the performance statistics on a specified GPON
ONT VDSL2 port of a device. The required GPON ONT VDSL2 port must be in the
activated state.

Command Format
LST-ONTVDSLPORTPERF::((DID=Device-ID|DEV=Device-name,)((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|NAME=ont-name))|ALIAS=ont-alias,ONTPORTID=ont-port-id:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T

249 MA5600T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 733


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 734


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING alias. It is
used to locate
the ONT.

ONTPORTID INTEGER 1-64 Indicates the -


ID of the ONT
user port. The
range of the
user ports is
restricted by
the capability
set profile.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon ONT VDSL2 PORT Performance Stat Info of the device " + device name
name of attributes:
DID FN SN PN ONTID ONTPORTID COFECS COES COSES COLOSS COUS
COCURR15MINLOFS COCURR15MINLOLS COCURR15MINLOPS COCURR15MINES
COCURR15MINLOSS COCURR15MINSES COCURR15MINUAS CPFECS CPEES CPESES CPELOSS
CPEUS CPECURR15MINLOFS CPECURR15MINLOLS CPECURR15MINLOPS CPECURR15MINES
CPECURR15MINLOSS CPECURR15MINSES CPECURR15MINUAS RETRAINS INITFAILS
COCURR15MINEBS COCURR15MINUCBS COCURR15MINCBS COCURR15MINCVS
CPECURR15MINEBS CPECURR15MINUCBS CPECURR15MINCBS CPECURR15MINCVS
COLAST15MINLOFS COLAST15MINLOLS COLAST15MINLOPS COLAST15MINES
COLAST15MINLOSS COLAST15MINSES COLAST15MINUAS CPELAST15MINLOFS
CPELAST15MINLOLS CPELAST15MINLOPS CPELAST15MINES CPELAST15MINLOSS
CPELAST15MINSES CPELAST15MINUAS COLAST15MINEBS COLAST15MINUCBS
COLAST15MINCBS COLAST15MINCVS CPELAST15MINEBS CPELAST15MINUCBS
CPELAST15MINCBS CPELAST15MINCVS COLAST15MININITFULL COLAST15MININITFAIL
COCURR15MININITFULL COCURR15MININITFAIL COCVS CPECVS COES1DAY COSES1DAY
CPEES1DAY CPESES1DAY CURR1DAYINITFULL CURR1DAYINITFAIL

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 735


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPORTID INTEGER 1-64 Indicates the ID of


the ONT user
port. The range of
the user ports is
restricted by the
capability set
profile.

COFECS INTEGER 0-4294967295 Indicates the


number of
forward error
correction seconds
(FECSs) of the
channel at the
central office end.
Unit: s.

COES INTEGER 0-4294967295 Indicates the


number of errored
seconds at the
central office end.
Unit: s.

COSES INTEGER 0-4294967295 Indicates the


number of
severely errored
seconds at the
central office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 736


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLOSS INTEGER 0-4294967295 Indicates the


number of LOSSs
at the central
office end.
Unit: s.

COUS INTEGER 0-4294967295 Indicates the


number of
unavailable
seconds at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


FS number of loss of
frame seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


PS number of loss of
power seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


LS number of loss of
link seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINES INTEGER 0-4294967295 Indicates the


number of errored
seconds in the
current 15
minutes at the
central office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 737


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINLO INTEGER 0-4294967295 Indicates the


SS number of loss of
signal seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINSE INTEGER 0-4294967295 Indicates the


S number of
severely errored
seconds in the
current 15
minutes at the
central office end.
Unit: s.

COCURR15MINU INTEGER 0-4294967295 Indicates the


AS number of
unavailable
seconds in the
current 15
minutes at the
central office end.
Unit: s.

CPFECS INTEGER 0-4294967295 Indicates the


number of FECSs
of the channel at
the remote end.
Unit: s.

CPEES INTEGER 0-4294967295 Indicates the


number of errored
seconds at the
remote end.
Unit: s.

CPESES INTEGER 0-4294967295 Indicates the


number of
severely errored
seconds at the
remote end.
Unit: s.

CPELOSS INTEGER 0-4294967295 Indicates the


number of LOSSs
at the remote
end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 738


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPEUS INTEGER 0-4294967295 Indicates the


number of
unavailable
seconds at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OFS number of loss of
frame seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OLS number of loss of
link seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OPS number of loss of
power seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINE INTEGER 0-4294967295 Indicates the


S number of errored
seconds in the
current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OSS number of loss of
signal seconds in
the current 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 739


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR15MINS INTEGER 0-4294967295 Indicates the


ES number of
severely errored
seconds in the
current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINU INTEGER 0-4294967295 Indicates the


AS number of
unavailable
seconds in the
current 15
minutes at the
remote end.
Unit: s.

RETRAINS INTEGER 0-2147483647 Indicates the


number of
complete line
initializations.

INITFAILS INTEGER 0-2147483647 Indicates the


number of
initialization
failures.

COCURR15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
current 15
minutes at the
central office end.

COCURR15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected
automatically in
the current 15
minutes at the
central office end.

COCURR15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the current 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 740


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
current 15
minutes at the
central office end.

CPECURR15MINE INTEGER 0-4294836225 Indicates the


BS number of FEC
code blocks in the
current 15
minutes at the
remote end.

CPECURR15MINU INTEGER 0-4294836225 Indicates the


CBS number of blocks
that cannot be
corrected
automatically in
the current 15
minutes at the
remote end.

CPECURR15MINC INTEGER 0-4294836225 Indicates the


BS number of
corrected blocks
in the channel in
the current 15
minutes at the
remote end.

CPECURR15MINC INTEGER 0-4294836225 Indicates the


VS number of the
abnormal CRC
codes in the
channel in the
current 15
minutes at the
remote end.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


FS number of loss of
frame seconds in
the last 15
minutes at the
central office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 741


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MINLO INTEGER 0-4294836225 Indicates the


PS number of loss of
power seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


LS number of loss of
link seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINES INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


SS number of loss of
signal seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINSES INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

COLAST15MINUA INTEGER 0-4294836225 Indicates the


S number of
unavailable
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 742


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


FS number of loss of
frame seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


PS number of loss of
power seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


LS number of loss of
link seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINES INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
last 15 minutes at
the remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


SS number of loss of
signal seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINSE INTEGER 0-4294836225 Indicates the


S number of
severely errored
seconds in the
last 15 minutes at
the remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 743


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINU INTEGER 0-4294836225 Indicates the


AS number of
unavailable
seconds in the
last 15 minutes at
the remote end.
Unit: s.

COLAST15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected in the
channel
automatically in
the last 15
minutes at the
central office end.

COLAST15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the last 15
minutes at the
central office end.

COLAST15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
last 15 minutes at
the central office
end.

CPELAST15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
channel in the
last 15 minutes at
the remote end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 744


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected in the
channel
automatically in
the last 15
minutes at the
remote end.

CPELAST15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the last 15
minutes at the
remote end.

CPELAST15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
last 15 minutes at
the remote end.

COLAST15MININI INTEGER 0-4294836225 Indicates the


TFULL number of full
initialization times
in the last 15
minutes at the
central office end.

COLAST15MININI INTEGER 0-4294836225 Indicates the


TFAIL number of full
initialization
failures in the
past 15 minutes
at the central
office end.

COCURR15MININI INTEGER 0-4294836225 Indicates the


TFULL number of full
initialization times
within the current
15 minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 745


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MININI INTEGER 0-4294836225 Indicates the


TFAIL number of fill
initialization
failures within the
current 15
minutes at the
central office end.

COCVS INTEGER 0-4294836225 Indicates the


number of
abnormal CRC
codes in the
channel at the
central office end.

CPECVS INTEGER 0-4294836225 Indicates the


number of
abnormal CRC
codes in the
channel at the
remote end.

COES1DAY INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
current day at the
central office end.
Unit: s.

CPEES1DAY INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
current day at the
remote end.
Unit: s.

COSES1DAY INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
current day at the
central office end.
Unit: s.

CPESES1DAY INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
current day at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 746


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CURR1DAYINITFU INTEGER 0-4294836225 Indicates the


LL number of errored
seconds in the
current day.

CURR1DAYINITFAI INTEGER 0-4294836225 Indicates the


L number of errored
seconds in the
current day.

Error Code
ID Description Solution

2686058531 The device does not Verify that the device is


exist. successfully added to the
NCE.

Example
To query the performance statistics of GPON ONT VDSL2 port 0/3/0/1/1 on the
10.144.194.224, run the following command:
LST-
ONTVDSLPORTPERF::DEV=10.144.194.224,FN=0,SN=3,PN=0,ONTID=1,ONTPOR
TID=1:200::;
The result is as follows:
7340032 2013-09-08 15:38:16
M 200 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gpon ONT VDSL2 PORT Performance Stat Info of the device 10.144.194.224
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------
DID FN SN PN ONTID ONTPORTID COFECS COES COSES COLOSS COUS
COCURR15MINLOFS COCURR15MINLOLS COCURR15MINLOPS COCURR15MINES
COCURR15MINLOSS COCURR15MINSES COCURR15MINUAS CPFECS CPEES CPESES CPELOSS
CPEUS CPECURR15MINLOFS CPECURR15MINLOLS CPECURR15MINLOPS CPECURR15MINES
CPECURR15MINLOSS CPECURR15MINSES CPECURR15MINUAS RETRAINS INITFAILS
COCURR15MINEBS COCURR15MINUCBS COCURR15MINCBS COCURR15MINCVS
CPECURR15MINEBS CPECURR15MINUCBS CPECURR15MINCBS CPECURR15MINCVS
COLAST15MINLOFS COLAST15MINLOLS COLAST15MINLOPS COLAST15MINES
COLAST15MINLOSS COLAST15MINSES COLAST15MINUAS CPELAST15MINLOFS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 747


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

CPELAST15MINLOLS CPELAST15MINLOPS CPELAST15MINES CPELAST15MINLOSS


CPELAST15MINSES CPELAST15MINUAS COLAST15MINEBS COLAST15MINUCBS
COLAST15MINCBS COLAST15MINCVS CPELAST15MINEBS CPELAST15MINUCBS
CPELAST15MINCBS CPELAST15MINCVS COLAST15MININITFULL COLAST15MININITFAIL
COCURR15MININITFULL COCURR15MININITFAIL COCVS CPECVS COES1DAY COSES1DAY
CPEES1DAY CPESES1DAY CURR1DAYINITFULL CURR1DAYINITFAIL
7340032 0 3 0 1 1 1 0 0 0 28 -- -- -- 0 0 0 0 11 7542 4362 --
27 -- -- -- 1 0 0 0 0 0 -- -- -- -- -- -- -- -- -- -- -- 0 0 0 28
-- -- -- 7541 176 4362 27 -- -- -- -- -- -- -- -- 0 0 0 0 0 17216
-- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------

Related Command
● LST-ONTVDSL2PORTDETAILINFO
● LST-ONTVDSL2PORTSPECIFYINFO

14.4.16 Querying the Details of a GPON ONT VDSL2 Port (LST-


ONTVDSL2PORTDETAILINFO)

Usage Note
This command is used to query the details of a GPON ONT VDSL2 port. The
device ID (or device name), slot ID, port ID, ONTID and ONTPORTID are
mandatory for the command.

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

Command Format
LST-ONTVDSL2PORTDETAILINFO::((DID=Device-ID|DEV=Device-name,)((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|NAME=ont-name))|ALIAS=ont-alias,ONTPORTID=ont-port-id:CTAG::
[SHOWOPTION=TRANSSYS CURPROFILE LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS
SNRMARGINDS SNRMARGINUS CH1PREVDATARATEDS CH1ACTDELAYDS CH1PREVDATARATEUS
CH1ACTDELAYUS COSYSVENDOR CPESYSVENDOR COVERSION CPEVERSION COSERIALNUM
CPESERIALNUM TR165PARA TR165PARAINDEX];

Supporting Device
Device Type No. Device Type

249 MA5600T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 748


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

95 MA5603T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 749


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SN INTEGER 0-35 Indicates the -


slot ID.

PN INTEGER 0-63 Indicates the -


port ID.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING alias. It is
used to locate
the ONT.

ONTPORTID INTEGER 1-64 Indicates the -


ID of the ONT
user port. The
range of the
user ports is
restricted by
the capability
set profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 750


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● TRANSSYS (Optional) -


N STRING ● CURPROFI Specifies the
LE attributes
that can be
● LNATTEND displayed in
S the returned
● LNATTENU result. If you
S set this
● SIGATTEN parameter,
DS the
corresponding
● SIGATTEN attributes are
US returned. By
● SNRMARGI default, the
NDS attributes are
● SNRMARGI not displayed.
NUS For example,
● CH1PREVD if you enter
ATARATED TR165PARA,
S the result
contains the
● CH1ACTDE
information
LAYDS
about this
● CH1PREVD attribute.
ATARATEU NOTE
S Querying
● CH1ACTDE TR165PARA
and
LAYUS
TR165PARAI
● COSYSVEN NDEX are
DOR supported
only when the
● CPESYSVE port works in
NDOR TR165 mode.
● COVERSIO
N
● CPEVERSIO
N
● COSERIAL
NUM
● CPESERIAL
NUM
● TR165PAR
A
● TR165PAR
AINDEX

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 751


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon ONT VDSL2 Port Detail Information of the Device" +device-name
name of attributes: DID FN SN PN ONTID ONTPORTID PSTAT LPROFID TRANSSYS
CURPROFILE LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS
SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS CH1ACTDATARATEDS
CH1PREVDATARATEDS CH1ACTDELAYDS CH1ACTDATARATEUS CH1PREVDATARATEUS
CH1ACTDELAYUS CH2ACTDATARATEDS CH2ACTDATARATEUS ADMINSTAT COSYSVENDOR
CPESYSVENDOR COVERSION CPEVERSION COSERIALNUM CPESERIALNUM TR165VNPROF
TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF TR165UPBOPROF TR165RFIPROF
TR165NMPROF TR165INMPROF TR165CH1USPROF TR165CH1UARR TR165CH2USPROF
TR165CH2UARR TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF TR165CH2DARR
TR165CH1INPPROF TR165CH2INPPROF TR165VNPROFINDEX TR165SPECTRUMPROFINDEX
TR165DPBOPROFINDEX TR165UPBOPROFINDEX TR165RFIPROFINDEX TR165NMPROFINDEX
TR165INMPROFINDEX TR165CH1USPROFINDEX TR165CH2USPROFINDEX TR165CH1DSPROFINDEX
TR165CH2DSPROFINDEX TR165CH1INPPROFINDEX TR165CH2INPPROFINDEX

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the In the case of the
value range is GPBD board, the
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

ONTPORTID INTEGER 1-64 Indicates the ID of


the ONT user
port. The range of
the user ports is
restricted by the
capability set
profile.

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 line profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 752


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 753


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 754


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 755


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN

CURPROFILE OCTET STRING ● profile8a Indicates the


● profile8b current VDSL2
profile.
● profile8c
● profile8d
● profile12a
● profile12b
● profile17a
● profile30a

LNATTENDS INTEGER 0-127 Indicates the


downstream
power
attenuation.
Unit: dB.

LNATTENUS INTEGER 0-127 Indicates the


upstream power
attenuation.
Unit: dB.

SIGATTENDS INTEGER 0-127 Indicates the


downstream
signal
attenuation.
Unit: dB.

SIGATTENUS INTEGER 0-127 Indicates the


upstream signal
attenuation.
Unit: dB.

SNRMARGINDS INTEGER -64 to 63 Indicates the


downstream SNR
margin.
Unit: dB.

SNRMARGINUS INTEGER -64 to 63 Indicates the


upstream SNR
margin.
Unit: dB.

PSTAT OCTET STRING ● activated Indicates the


● activating status of the port.
● deactivated

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 756


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 1.
Unit: kbit/s.

CH1ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 1.
Unit: ms.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 1.
Unit: kbit/s.

CH1ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 1.
Unit: ms.

CH2ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 2.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 757


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH2ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 2.
Unit: kbit/s.

ADMINSTAT OCTET STRING ● UP Indicates the


● DOWN activation state of
a VDSL2 port.
Options are as
follows:
● UP: activated
● DOWN:
deactivated

COSYSVENDOR OCTET STRING - Indicates the


vendor ID of the
central office
system.

CPESYSVENDOR OCTET STRING - Indicates the


vendor ID of the
remote end
system.

COVERSION OCTET STRING SIZE (32) Indicates the


version of the
central office
system.

CPEVERSION OCTET STRING SIZE (32) Indicates the


version of the
remote end
system.

COSERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the central office
system.

CPESERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the remote end
system.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 758


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165VNPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 virtual
noise profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165SPECTRUM OCTET STRING SIZE (32) Indicates the


PROF name of the
TR165 spectrum
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165ALARMPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 alarm
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165DPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 DPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 759


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165UPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 UPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165RFIPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 RFI profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165INMPROF OCTET STRING SIZE (32) Indicates the


TR165INM profile
name.

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 760


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
upstream rate.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
upstream rate
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
upstream rate.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 761


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
downstream rate.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
downstream rate
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH2DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
downstream rate.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 762


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2INPPRO OCTET STRING SIZE (32) Indicates the


F delay INP profile
of the TR165
channel 2.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165VNPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 virtual
noise profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165SPECTRUM INTEGER 1-4294967294 Indicates the


PROFINDEX index of the
TR165 spectrum
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165DPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 DPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 763


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165UPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 UPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165RFIPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 RFI profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165NMPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 noise
margin profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165INMPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 INM
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 764


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
upstream rate
profile. This
parameter is valid
only when the
TR165CH1UARR
parameter is set.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH2USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 2
upstream rate
profile. This
parameter is valid
only when the
TR165CH2UARR
parameter is set.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH1DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
downstream
profile. This
parameter is valid
only when the
TR165CH1DARR
parameter is set.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 765


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 2
downstream rate
profile. This
parameter is valid
only when the
TR165CH2DARR
parameter is set.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH1INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
impulse noise
protection (INP)
profile of the
TR165 channel 1.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH2INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
impulse noise
protection (INP)
profile of the
TR165 channel 2.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 766


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058531 The device does not exist. Verify that the device is
successfully added to the
NCE.

Example
To query the details of GPON ONT VDSL2 port 0/3/0/1/1 on the device named
10.144.194.224, run the following command:

LST-
ONTVDSL2PORTDETAILINFO::DEV=10.144.194.224,FN=0,SN=3,PN=0,ONTID=1,
ONTPORTID=1:200::SHOWOPTION=TR165PARA TR165PARAINDEX;

The result is as follows:


7340032 2013-09-08 12:04:36
M 200 COMPLD
EN=0 ENDESC=Succeeded.

blktag=1
blkcount=1
blktotal=1

Gpon ONT VDSL2 Port Detail Information of the Device 10.144.194.224


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------
DID FN SN PN ONTID ONTPORTID PSTAT LPROFID ATTAINABLERATEDS
ATTAINABLERATEUS CH1ACTDATARATEDS CH1ACTDATARATEUS CH2ACTDATARATEDS
CH2ACTDATARATEUS ADMINSTAT TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF
TR165DPBOPROF TR165UPBOPROF TR165RFIPROF TR165NMPROF TR165INMPROF
TR165CH1USPROF TR165CH1UARR TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF
TR165CH1DARR TR165CH2DSPROF TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF
TR165VNPROFINDEX TR165SPECTRUMPROFINDEX TR165DPBOPROFINDEX
TR165UPBOPROFINDEX TR165RFIPROFINDEX TR165NMPROFINDEX TR165INMPROFINDEX
TR165CH1USPROFINDEX TR165CH2USPROFINDEX TR165CH1DSPROFINDEX
TR165CH2DSPROFINDEX TR165CH1INPPROFINDEX TR165CH2INPPROFINDEX
7340032 0 3 0 1 1 activated DEFVAL 88736 59049 88734 59049 0 0 UP --
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------

Related Command
● LST-ONTVDSLPORTPERF
● LST-ONTVDSL2PORTSPECIFYINFO

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 767


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.4.17 Querying Specified Information About GPON ONT


VDSL2 Ports (LST-ONTVDSL2PORTSPECIFYINFO)
Usage Note
This command is used to query the specified information of a GPON ONT VDSL2
port. The device ID (or device name), slot ID, port ID, ONTID, and ONTPORTID are
mandatory for the command. Because the SHOWOPTION field in this command
supports a lot of parameters, the total length of the query command must be no
more than 1024 characters.

Command Format
LST-ONTVDSL2PORTSPECIFYINFO::((DID=Device-ID|DEV=Device-name,)((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|NAME=ont-name))|ALIAS=ont-alias,ONTPORTID=ont-port-id:CTAG::
[SHOWOPTION=PSTAT LPROFID APROFID TRANSSYS CURPROFILE LNATTENDS LNATTENUS SIGATTENDS
SIGATTENUS SNRMARGINDS SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS
CH1ACTDATARATEDS CH1PREVDATARATEDS CH1ACTDELAYDS CH1ACTDATARATEUS
CH1PREVDATARATEUS CH1ACTDELAYUS COSYSVENDOR CPESYSVENDOR COVERSION CPEVERSION
COSERIALNUM CPESERIALNUM TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF
TR165DPBOPROF TR165UPBOPROF TR165RFIPROF TR165NMPROF TR165INMPROF TR165CH1USPROF
TR165CH1UARR TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF
TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 768


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI NOTE
port is of 10G In the case of
GPON, the the GPBD
value range is board, the
0-255; if the value ranges
UNI port is of from 0 to 127.
1G GPON, the In the case of
value range is the GPBC
0-127. board, the
value ranges
from 0 to 63.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 769


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING alias. It is
used to locate
the ONT.

ONTPORTID INTEGER 1-64 Indicates the -


ID of the ONT
user port. The
range of the
user ports is
restricted by
the capability
set profile.

SHOWOPTIO OCTET See the (Optional) -


N STRING SHOWOPTIO Specifies the
N parameter attributes
value in the that can be
command displayed in
format. the returned
result. If you
set this
parameter,
the
corresponding
attributes are
returned. By
default, the
attributes are
not displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="GPON ONT VDSL2 port attributes of the device " +device-name
name of attributes: DID FN SN PN ONTID ONTPORTID PSTAT LPROFID APROFID
TRANSSYS CURPROFILE LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS
SNRMARGINUS ATTAINABLERATEDS ATTAINABLERATEUS CH1ACTDATARATEDS
CH1PREVDATARATEDS CH1ACTDELAYDS CH1ACTDATARATEUS TR165VNPROF CH1PREVDATARATEUS
CH1ACTDELAYUS COSYSVENDOR CPESYSVENDOR COVERSION CPEVERSION COSERIALNUM
CPESERIALNUM TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF TR165UPBOPROF

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 770


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

TR165RFIPROF TR165NMPROF TR165INMPROF TR165CH1USPROF TR165CH1UARR


TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF
TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the In the case of the
value range is GPBD board, the
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

ONTPORTID INTEGER 1-64 Indicates the ID of


the ONT user
port. The range of
the user ports is
restricted by the
capability set
profile.

PSTAT OCTET STRING ● activated Indicates the


● activating status of the port.
● deactivated

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 line profile.

APROFID OCTET STRING SIZE (32) Indicates the


name of the
VDSL2 alarm
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 771


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 772


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 773


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 774


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN

CURPROFILE OCTET STRING ● profile8a Indicates the


● profile8b current VDSL2
profile.
● profile8c
● profile8d
● profile12a
● profile12b
● profile17a
● profile30a

LNATTENDS INTEGER 0-127 Indicates the


downstream
power
attenuation.
Unit: dB.

LNATTENUS INTEGER 0-127 Indicates the


upstream power
attenuation.
Unit: dB.

SIGATTENDS INTEGER 0-127 Indicates the


downstream
signal
attenuation.
Unit: dB.

SIGATTENUS INTEGER 0-127 Indicates the


upstream signal
attenuation.
Unit: dB.

SNRMARGINDS INTEGER -64 to 63 Indicates the


downstream SNR
margin.
Unit: dB.

SNRMARGINUS INTEGER -64 to 63 Indicates the


upstream SNR
margin.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 775


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 1.
Unit: kbit/s.

CH1ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 1.
Unit: ms.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 1.
Unit: kbit/s.

CH1ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 1.
Unit: ms.

COSYSVENDOR OCTET STRING - Indicates the


vendor ID of the
central office
system.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 776


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPESYSVENDOR OCTET STRING - Indicates the


vendor ID of the
CPE.

COVERSION OCTET STRING SIZE (32) Indicates the


version of the
central office
system.

CPEVERSION OCTET STRING SIZE (32) Indicates the


version of the
remote end
system.

COSERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the central office
system.

CPESERIALNUM INTEGER SIZE (32) Indicates the


serial number of
the remote end
system.

TR165VNPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 virtual
noise profile.

TR165SPECTRUM OCTET STRING SIZE (32) Indicates the


PROF name of the
TR165 spectrum
profile.

TR165ALARMPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 alarm
profile.

TR165DPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 DPBO
profile.

TR165UPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 UPBO
profile.

TR165RFIPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 RFI profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 777


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.

TR165iNMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 INM
profile.

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.

TR165CH1UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
upstream rate.

TR165CH2USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
upstream rate
profile.

TR165CH2UARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
upstream rate.

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.

TR165CH1DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 1
downstream rate.

TR165CH2DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 2
downstream rate
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 778


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH2DARR INTEGER 0-100 Indicates the


adaptive ratio of
the TR165
channel 2
downstream rate.

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.

TR165CH2INPPRO OCTET STRING SIZE (32) Indicates the


F delay INP profile
of the TR165
channel 2.

Error Code
ID Description Solution

2686058531 The device does not exist. Verify that the device is
successfully added to the
NCE.

Example
To query the specified details of GPON ONT VDSL2 port 0/3/0/1/1 on the device
named 10.144.194.224, run the following command:
LST-
ONTVDSL2PORTSPECIFYINFO::DEV=10.144.194.224,FN=0,SN=3,PN=0,ONTID=1,
ONTPORTID=1:200::SHOWOPTION=PSTAT LPROFID APROFID
ATTAINABLERATEDS ATTAINABLERATEUS CH1ACTDATARATEDS
CH1ACTDATARATEUS TR165VNPROF TR165SPECTRUMPROF
TR165ALARMPROF TR165DPBOPROF TR165UPBOPROF TR165RFIPROF
TR165NMPROF TR165INMPROF TR165CH1USPROF TR165CH1UARR
TR165CH2USPROF TR165CH2UARR TR165CH1DSPROF TR165CH1DARR
TR165CH2DSPROF TR165CH2DARR TR165CH1INPPROF TR165CH2INPPROF;
The result is as follows:
7340032 2013-09-08 14:57:51
M 200 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

GPON ONT VDSL2 port attributes of the device 10.144.194.224 Frame number:0 Slot number:3 Port number:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 779


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

0
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------
DID FN SN PN ONTID ONTPORTID PSTAT LPROFID APROFID ATTAINABLERATEDS
ATTAINABLERATEUS CH1ACTDATARATEDS CH1ACTDATARATEUS TR165VNPROF
TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF TR165UPBOPROF TR165RFIPROF
TR165NMPROF TR165INMPROF TR165CH1USPROF TR165CH1UARR TR165CH2USPROF
TR165CH2UARR TR165CH1DSPROF TR165CH1DARR TR165CH2DSPROF TR165CH2DARR
TR165CH1INPPROF TR165CH2INPPROF
7340032 0 3 0 1 1 activated 123 -- 62524 86376 62508 86376 -- -- -- --
-- -- -- -- -- -- -- -- -- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------

Related Command
● LST-ONTVDSLPORTPERF
● LST-ONTVDSL2PORTDETAILINFO

14.5 Querying G.fast Resources


This topic provides the commands and examples for querying G.fast resources,
including the G.fast ports, profiles, alarms, and performance statistics.

14.5.1 Querying the Details of a G.fast Port (LST-


GFASTPORTDETAILINFO)

Usage Note
This command is used to query the details of a G.fast port. The device ID (or
device name), subrack ID, slot ID, and port ID are mandatory for the command.

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

Command Format
LST-GFASTPORTDETAILINFO::(DID=Device-ID|DEV=Device-name),FN=frame-num,SN=slot-num,PN=port-
num:CTAG::[SHOWOPTION=NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS
CH1INPUS COSYSVENDOR CPESYSVENDOR PPPOESESSION ADMINSTAT COVERSION CPEVERSION
COSERIALNUM CPESERIALNUM TR165PARA TR165PARAINDEX QUENESHAPINGPARA TRAPSWITCH
VECTORINGSTATUS LEGACYCPEPOLICY CPETYPE ACTUALRATEUS ACTUALRATEDS LASTRETRAININFO
CH1NETRATEUS CH1NETRATEDS CH1LATENCYPATHUS CH1LATENCYPATHDS CH1AGAINSTREINUS
CH1AGAINSTREINDS ACTUALCOKL0 ACTUALCPEKL0 SPLITTERMODE ACTRATEADAPTUS
ACTRATEADAPTDS ACTROCINPUS ACTROCINPDS ACTROCSNRMUS ACTROCSNRMDS ACTIVEDLINETECH
DATACHANNELMODE VECTORROF];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 780


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R017C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 781


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● NTEPOWE (Optional) -


N STRING RSTATUS Specifies the
● LASTUPTI attributes
ME that can be
displayed in
● LASTDOW the returned
NTIME result. If you
● UPTIME set this
parameter,
● CH1INPDS
the
● CH1INPUS corresponding
● COSYSVEN attributes are
DOR returned. By
default, the
● CPESYSVE
attributes are
NDOR
not displayed.
● PPPOESES
For example,
SION
if you enter
● ADMINSTA NTEPOWERS
T TATUS, the
● COVERSIO result
N contains the
information
● CPEVERSIO about this
N attribute.
● COSERIAL
NUM
● CPESERIAL
NUM
● TR165PAR
A
● TR165PAR
AINDEX
● QUENESH
APINGPAR
A
● TRAPSWIT
CH
● VECTORIN
GSTATUS
● LEGACYCP
EPOLICY
● CPETYPE
● ACTUALRA
TEUS
● ACTUALRA
TEDS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 782


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

● LASTRETR
AININFO
● CH1NETRA
TEUS
● CH1NETRA
TEDS
● CH1LATEN
CYPATHUS
● CH1LATEN
CYPATHDS
● CH1AGAIN
STREINUS
● CH1AGAIN
STREINDS
● ACTUALCO
KL0
● ACTUALCP
EKL0
● SPLITTERM
ODE
● ACTRATEA
DAPTUS
● ACTRATEA
DAPTDS
● ACTROCIN
PUS
● ACTROCIN
PDS
● ACTROCSN
RMUS
● ACTROCSN
RMDS
● ACTIVEDLI
NETECH
● DATACHA
NNELMOD
E
● VECTORRO
F

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 783


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="GFAST Port Detail Information of the Device" +device-name


name of attributes: DID FN SN PN ALIAS LPROFID APROFID TRANSSYS PWRMNGSTATE INITRESULT
LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS SNRMARGINUS ATTAINABLERATEDS
ATTAINABLERATEUS ACTPSDDS ACTPSDUS ACTATPDS ACTATPUS CH1ACTDATARATEDS
CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS CH1PTMSTATUSDS CH1ACTDATARATEUS
CH1PREVDATARATEUS CH1ACTDELAYUS CH1ATMSTATUSUS CH1PTMSTATUSUS NTEPOWERSTATUS
LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS CH1INPUS PPPOE OPTION82 COSYSVENDOR
CPESYSVENDOR PPPOESESSION ADMINSTAT COVERSION CPEVERSION COSERIALNUM CPESERIALNUM
TR165VNPROF TR165SPECTRUMPROF TR165ALARMPROF TR165DPBOPROF, TR165UPBOPROF
TR165RFIPROF TR165NMPROF TR165CH1USPROF TR165CH1DSPROF TR165CH1INPPROF
TR165VNPROFINDEX TR165SPECTRUMPROFINDEX TR165DPBOPROFINDEX TR165UPBOPROFINDEX
TR165RFIPROFINDEX TR165NMPROFINDEX TR165CH1USPROFINDEX TR165CH1DSPROFINDEX
TR165CH1INPPROFINDEX TR165CH2INPPROFINDEX QUENE1 QUENE2 OUTBOUNDTRAFFICPROF
TRAPSWITCH VECTORINGSTATUS LEGACYCPEPOLICY CPETYPE ACTUALRATEUS ACTUALRATEDS
LASTRETRAININFO CH1NETRATEUS CH1NETRATEDS CH1LATENCYPATHUS CH1LATENCYPATHDS
CH1AGAINSTREINUS CH1AGAINSTREINDS ACTUALCOKL0 ACTUALCPEKL0 SPLITTERMODE
ACTRATEADAPTUS ACTRATEADAPTDS ACTROCINPUS ACTROCINPDS ACTROCSNRMUS ACTROCSNRMDS
DATARATEDS DATARATEUS ACTIVEDLINETECH DATACHANNELMODE VECTORROF GFASTROFID

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

LPROFID OCTET STRING SIZE (32) Indicates the


name of the
G.fast line profile.

APROFID OCTET STRING SIZE (32) Indicates the


name of the
G.fast alarm
profile.

ALIAS OCTET STRING SIZE (32) Indicates the alias


of the G.fast port.

PPPOE OCTET STRING ● ON Specifies whether


● OFF the PPPoE
function is
enabled.

OPTION82 OCTET STRING ● ON Specifies whether


● OFF the option 82
function is
enabled.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 784


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PSTAT OCTET STRING ● Fault Indicates the


● Test status of the port.
● Active
● Activating
● Deactive
● LoopBack

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 785


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 786


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 787


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 788


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN
● G.fast(G.9701)

PWRMNGSTATE OCTET STRING ● Level 0 Indicates the


● Level 1 power
management
● Level 2 status.
● Level 3

INITRESULT OCTET STRING ● NoFailure Indicates the


● ConfigError result of the last
complete
● ConfigNotFeasi initialization.
ble
● CommFail
● NoPeerAtu
● OtherCause

LNATTENDS INTEGER 0-127 Indicates the


downstream
power
attenuation.
Unit: dB.

LNATTENUS INTEGER 0-127 Indicates the


upstream power
attenuation.
Unit: dB.

SIGATTENDS INTEGER 0-127 Indicates the


downstream
signal
attenuation.
Unit: dB.

SIGATTENUS INTEGER 0-127 Indicates the


upstream signal
attenuation.
Unit: dB.

SNRMARGINDS INTEGER -64 dB to +63 dB Indicates the


downstream SNR
margin.
Unit: dB.

SNRMARGINUS INTEGER -64 to +63 Indicates the


upstream SNR
margin.
Unit: dB.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 789


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

ACTPSDDS INTEGER -90 to 0 Indicates the


downstream PSD.
Unit: dBm/Hz.

ACTPSDUS INTEGER -90 to 0 Indicates the


upstream PSD.
Unit: dBm/Hz.

ACTATPDS INTEGER -31 to +31 Indicates the


downstream
power.
Unit: dBm.

ACTATPUS INTEGER -31 to +31 Indicates the


upstream power.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EDS downstream rate
of channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEDS downstream rate
of channel 1.
Unit: kbit/s.

CH1ACTDELAYDS INTEGER 0-8176 Indicates the


downstream delay
of channel 1.
Unit: ms.

CH1ATMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat downstream ATM
ion data status of
channel 1.
● LossOfCellDeli
neation

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 790


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1PTMSTATUSD OCTET STRING ● NoFailure Indicates the


S ● OutOfSync downstream PTM
data status of
channel 1.

CH1ACTDATARAT INTEGER 0-4294967295 Indicates the


EUS upstream rate of
channel 1.
Unit: kbit/s.

CH1PREVDATARA INTEGER 0-4294967295 Indicates the last


TEUS upstream rate of
channel 1.
Unit: kbit/s.

CH1ACTDELAYUS INTEGER 0-8176 Indicates the


upstream delay of
channel 1.
Unit: ms.

CH1ATMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● NoCellDelineat upstream ATM
ion data status of
channel 1.
● LossOfCellDeli
neation

CH1PTMSTATUSU OCTET STRING ● NoFailure Indicates the


S ● OutOfSync upstream PTM
data status of
channel 1.

NTEPOWERSTATU OCTET STRIN ● on Indicates the NTE


S ● off power status of
the G.fast port.
● unknown

LASTUPTIME OCTET STRING - Indicates the time


when the G.fast
port is online.
The format is YY-
MM-DD
hh:mm:ss.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 791


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LASTDOWNTIME OCTET STRING - Indicates the time


when the G.fast
port is
disconnected.
The format is YY-
MM-DD
hh:mm:ss.
The time is in UTC
format.

UPTIME INTEGER 0-4294967295 Indicates the


duration during
which the G.fast
port is activated.

CH1INPDS FLOAT 0-25.4 Indicates the


downstream
impulse noise
protection (INP)
of channel 1.
Unit: dmt.

CH1INPUS FLOAT 0-25.4 Indicates the


upstream INP of
channel 1.
Unit: dmt.

COSYSVENDOR OCTET STRING - Indicates the


vendor ID of the
central office
system.

CPESYSVENDOR OCTET STRING - Indicates the


vendor ID of the
CPE.

PPPOESESSION INTEGER 0-8 Indicates the


number of online
PPPoE single-MAC
users on each
physical port.

ADMINSTAT OCTET STRING ● UP Indicates the


● DOWN activation state of
a G.fast port.
Options are as
follows:
● UP: activated
● DOWN:
deactivated

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 792


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COVERSION OCTET STRING SIZE (32) Indicates the


version of the
central office
system.

CPEVERSION OCTET STRING SIZE (32) Indicates the


version of the
central office
system.

COSERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the central office
system.

CPESERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
the central office
system.

TR165VNPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 virtual
noise profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165SPECTRUM OCTET STRING SIZE (32) Indicates the


PROF name of the
TR165 spectrum
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 793


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165ALARMPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 alarm
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165DPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 DPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165UPBOPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 UPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165RFIPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 RFI profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 794


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 795


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165VNPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 virtual
noise profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165SPECTRUM INTEGER 1-4294967294 Indicates the


PROFINDEX index of the
TR165 spectrum
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165DPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 DPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165UPBOPROFI INTEGER 1-4294967294 Indicates the


NDEX index of the
TR165 UPBO
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 796


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165RFIPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 RFI profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165NMPROFIN INTEGER 1-4294967294 Indicates the


DEX index of the
TR165 noise
margin profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH1USPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
upstream rate
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

TR165CH1DSPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the
TR165 channel 1
downstream
profile.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 797


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1INPPRO INTEGER 1-4294967294 Indicates the


FINDEX index of the delay
INP profile of the
TR165 channel 1.
This parameter is
returned only
when you entered
SHOWOPTION=T
R165PARAINDEX
in the command.

QUENE1 INTEGER 3 Indicates queue 1.


This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

QUENE2 INTEGER 4 Indicates queue 2.


This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

OUTBOUNDTRAF OCTET STRING SIZE (32) Indicates the


FICPROF name of the
outbound traffic
profile.
This parameter is
returned only
when you entered
SHOWOPTION=
QUENESHAPING
PARA in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 798


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRAPSWITCH OCTET STRING ● ON Specifies whether


● OFF the trap function
is enabled.
Options are as
follows:
● ON: reports
alarms from
ports to the
NCE.
● OFF:
suppresses
alarms from
ports.

VECTORINGSTAT OCTET STRING ● Vectoring ON Indicates the


US ● Vectoring OFF global vectoring
switch.
Options are as
follows:
● ON: reports
alarms from
ports to the
NCE.
● OFF:
suppresses
alarms from
ports.

LEGACYCPEPOLIC OCTET STRING ● No Limit Indicates the


Y ● Block legacy CPE
activation policy.
● Limit
● Force Friendly
Downstream
with Upstream
Limited
● Force Friendly
Downstream

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 799


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPETYPE OCTET STRING ● Vectoring Indicates the CPE


● Vectoring full type.
friendly
● Vectoring
friendly DS
● VDSL2
● ADSL/2/2+
● Unknown
● G.fast

ACTUALRATEUS INTEGER 0-4294967295 Indicates the


upstream data
line rate.
Unit: kbit/s.

ACTUALRATEDS INTEGER 0-4294967295 Indicates the


downstream data
line rate.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 800


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LASTRETRAININF OCTET STRING ● none Indicates the


O ● cpe-l3-trigger reason of the last
deactivation.
● lom-us-trigger-
dra
● lom-ds-trigger-
dra
● cpe-never-
answer-oam
● cpe-no-more-
answer-oam
● persistent-ncd-
us
● persistent-ncd-
ds
● persistent-lcd-
us
● persistent-lcd-
ds
● l2-problem-co-
drop
● l2-problem-
cpe-drop
● bitswap-
refused-us-co-
drop
● bitswap-
refused-us-
cpe-drop
● channel-
change-us-co-
drop
● channel-
change-us-cpe-
drop
● noise-increase-
us-co-drop
● noise-increase-
us-cpe-drop
● bitswap-
refused-ds-co-
drop
● bitswap-
refused-ds-
cpe-drop

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 801


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● channel-
change-ds-co-
drop
● channel-
change-ds-cpe-
drop
● noise-increase-
ds-co-drop
● noise-increase-
ds-cpe-drop
● lom-us-co-
drop
● lom-us-cpe-
drop
● lom-ds-co-
drop
● lom-ds-cpe-
drop
● sra-problem-
us-co-drop
● sra-problem-
us-cpe-drop
● sra-failed-us-
co-drop
● sra-failed-us-
cpe-drop
● sra-problem-
ds-co-drop
● sra-problem-
ds-cpe-drop
● sra-rejected-
ds-co-drop
● sra-rejected-
ds-cpe-drop
● bitswap-
problem-us-co-
drop
● bitswap-
problem-us-
cpe-drop
● bitswap-failed-
us-co-drop
● bitswap-failed-
us-cpe-drop

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 802


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● bitswap-
problem-ds-co-
drop
● bitswap-
problem-ds-
cpe-drop
● bitswap-
rejected-ds-co-
drop
● bitswap-
rejected-ds-
cpe-drop
● cpe-switched-
off
● cpe-lost
● co-reset
● co-stop
● unknown

CH1NETRATEUS INTEGER 0-4294967295 Indicates the


upstream payload
rate of channel 1.
Unit: kbit/s.

CH1NETRATEDS INTEGER 0-4294967295 Indicates the


downstream
payload rate of
channel 1.
Unit: kbit/s.

CH1LATENCYPAT INTEGER 0-3 Indicates the


HUS upstream channel
ID of channel 1.

CH1LATENCYPAT INTEGER 0-3 Indicates the


HDS downstream
channel ID of
channel 1.

CH1AGAINSTREIN INTEGER 0-4294967295 Indicates the INP


US value for defense
against repetitive
electric impulsive
noise (REIN) in
the upstream
direction of
channel 1.
Unit: dmt.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 803


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CH1AGAINSTREIN INTEGER 0-4294967295 Indicates the INP


DS value for defense
against REIN in
the downstream
direction of
channel 1.
Unit: dmt.

ACTUALCOKL0 INTEGER 0-4294967295 Indicates the


actual value of
the KL0_CO
parameter.
Unit: 0.1 dB

ACTUALCPEKL0 INTEGER 0-4294967295 Indicates the


actual value of
the KL0_CPE
parameter.
Unit: 0.1 dB

SPLITTERMODE OCTET STRING ● Connect Indicates the


● Bypass splitter mode.
Options are as
follows:
● Connect:
Connect ports
to the splitter.
● Bypass: Enable
ports to bypass
the splitter.

ACTRATEADAPTU OCTET STRING ● Manual Indicates the


S ● Rainit upstream rate
auto-adaptation
● Dynamic mode at the
● Dynamic with remote end.
SOS

ACTRATEADAPTD OCTET STRING ● Manual Indicates the


S ● Rainit downstream rate
auto-adaptation
● Dynamic mode at the
● Dynamic with central office end.
SOS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 804


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ACTROCINPUS INTEGER 0-254 Indicates the


actual INP of the
upstream robust
overhead channel
(ROC) at the
remote end.

ACTROCINPDS INTEGER 0-254 Indicates the


actual INP of the
downstream ROC
channel at the
central office end.

ACTROCSNRMUS INTEGER -2147483648-214 Indicates the


7483647 actual signal-to-
noise ratio (SNR)
margin of the
upstream ROC
channel at the
remote end.

ACTROCSNRMDS INTEGER -2147483648-214 Indicates the


7483647 actual SNR
margin of the
downstream ROC
channel at the
central office end.

ACTIVEDLINETEC OCTET STRING ● Unknown Indicates the


H ● ADSL actual activation
mode of the port.
● ADSL2
● ADSL2PLUS
● VDSL
● VDSL2
● G.fast

DATACHANNELM OCTET STRING ● Unknown Indicates the work


ODE ● ATM mode of the
current channel.
● PTM

VECTORROF OCTET STRING SIZE (32) Indicates the


name of the
VECTORING
profile.

GFASTROFID OCTET STRING SIZE (32) Indicates the


name of the
G.fast profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 805


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2689007617 The instance does not exist, Verify that the command is
or the feature is not correct according to the
supported or not following requirements:
configured. ● Check whether the
entered port is a G.fast
port.
● Check whether the
entered port exists.

Example
To query the details of port 0/1/0 on the device named 10.144.195.65, run the
following command:
LST-
GFASTPORTDETAILINFO::DEV=10.144.195.65,FN=0,SN=1,PN=0:1::SHOWOPTIO
N=NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME UPTIME CH1INPDS
CH1INPUS COSYSVENDOR CPESYSVENDOR;
The result is as follows:
7340068 2015-04-16 19:05:42
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
GFAST Port Detail Information of the Device 10.144.195.65
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------
DID FN SN PN ALIAS PSTAT APROFID TRANSSYS PWRMNGSTATE INITRESULT
LNATTENDS LNATTENUS SIGATTENDS SIGATTENUS SNRMARGINDS SNRMARGINUS
ATTAINABLERATEDS ATTAINABLERATEUS ACTPSDDS ACTPSDUS ACTATPDS ACTATPUS
CH1ACTDATARATEDS CH1PREVDATARATEDS CH1ACTDELAYDS CH1ATMSTATUSDS
CH1PTMSTATUSDS CH1ACTDATARATEUS CH1PREVDATARATEUS CH1ACTDELAYUS
CH1ATMSTATUSUS CH1PTMSTATUSUS NTEPOWERSTATUS LASTUPTIME LASTDOWNTIME
UPTIME CH1INPDS CH1INPUS PPPOE OPTION82 COSYSVENDOR CPESYSVENDOR
GFASTROFID
7340068 0 1 0 -- Activating AT_Alarm_001 -- -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- -- -- -- -- -- unknown -- -- -- -- -- -- --
-- -- --
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
--------------------------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 806


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
● LST-GFASTPORTPERF
● LST-GFASTPORTALARM

14.5.2 Querying G.fast Port Information About Specified NEs


(LST-NEGFASTPORTDETAILINFO)
Usage Note
This command is used to query G.fast port information about specified NEs from
the database. The queried data is the same as the data that is last synchronized to
the NCE but differs from the real-time data on the NEs.

Command Format
LST-NEGFASTPORTDETAILINFO::(DID=device-ID|DEV=device-name):CTAG::;

Supporting Device
Device Type No. Device Type

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 807


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="G.fast Port Detail Information of the Device" +device-name
name of attributes: DID FN SN PN TR165CH1USPROF TR165CH1DSPROF TR165CH1INPPROF
TR165NMPROF ALIAS PSTAT ATTAINABLERATEDS ATTAINABLERATEUS TRANSSYS PPPOESESSION

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 808


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TR165CH1USPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
upstream rate
profile.

TR165CH1DSPRO OCTET STRING SIZE (32) Indicates the


F name of the
TR165 channel 1
downstream
profile.

TR165CH1INPPRO OCTET STRING SIZE (32) Indicates the


F delay impulse
noise protection
(INP) profile of
the TR165
channel 1.

TR165NMPROF OCTET STRING SIZE (32) Indicates the


name of the
TR165 noise
margin profile.

ALIAS OCTET STRING SIZE (32) Indicates the alias


of the G.fast port.

PSTAT OCTET STRING ● Fault Indicates the


● Test status of the port.
● Active
● Activating
● Deactive
● LoopBack

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


DS maximum
downstream
attainable data
transmission rate.
Unit: bit/s.

ATTAINABLERATE INTEGER 0-4294967295 Indicates the


US maximum
upstream
attainable data
transmission rate.
Unit: bit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 809


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRANSSYS OCTET STRING ● ANSI T1.413 Indicates the


● ETSI DTS/ current
TM06006 transmission
system.
● G.992.1 POTS
non-
overlapped
● G.992.1 POTS
overlapped
● G.992.1 ISDN
non-
overlapped
● G.992.1 ISDN
overlapped
● G.992.1 TCM-
ISDN non-
overlapped
● G.992.1 TCM-
ISDN
overlapped
● G.992.2 POTS
non-
overlapped
● G.992.2 POTS
overlapped
● G.992.2 with
TCM-ISDN
non-
overlapped
● G.992.2 with
TCM-ISDN
overlapped
● G.992.1 TCM-
ISDN
symmetric
● G.992.3 POTS
non-
overlapped
● G.992.3 POTS
overlapped
● G.992.3 ISDN
non-
overlapped
● G.992.3 ISDN
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 810


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.4 POTS
non-
overlapped
● G.992.4 POTS
overlapped
● G.992.3 Annex
I All-Digital
non-
overlapped
● G.992.3 Annex
I All-Digital
overlapped
● G.992.3 Annex
J All-Digital
non-
overlapped
● G.992.3 Annex
J All-Digital
overlapped
● G.992.4 Annex
I All-Digital
non-
overlapped
● G.992.4 Annex
I All-Digital
overlapped
● G.992.3 Annex
L POTS non-
overlapped,mo
de1,wide U/S
● G.992.3 Annex
L POTS non-
overlapped,mo
de2,narrow
U/S
● G.992.3 Annex
L POTS
overlapped,mo
de3,wide U/S
● G.992.3 Annex
L POTS
overlapped,mo
de4,narrow
U/S
● G.992.3 Annex
M POTS non-
overlapped

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 811


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.992.3 Annex
M POTS
overlapped
● G.992.5 POTS
non-
overlapped
● G.992.5 POTS
overlapped
● G.992.5 ISDN
non-
overlapped
● G.992.5 ISDN
overlapped
● G.992.5 Annex
I All-Digital
non-
overlapped
● G.992.5 Annex
I All-Digital
overlapped
● G.992.5 Annex
J All-Digital
non-
overlapped
● G.992.5 Annex
J All-Digital
overlapped
● G.992.5 Annex
M POTS non-
overlapped
● G.992.5 Annex
M POTS
overlapped
● G.993.1
● G.993.2 Annex
A POTS
● G.993.2 Annex
A ISDN
● G.993.2 Annex
B POTS
● G.993.2 Annex
B ISDN
● G.993.2 Annex
C POTS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 812


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● G.993.2 Annex
C ISDN
● G.fast(G.9701)

PPPOESESSION INTEGER 0-8 Indicates the


number of online
PPPoE single-MAC
users on each
physical port.

Error Code
ID Description Solution

2686058531 The device does not exist. Verify that the device is
successfully added to the
NCE.

Example
To query the G.fast port information about NE 10.144.195.65, run the following
command:
LST-NEGFASTPORTDETAILINFO::DEV=10.144.195.65:CTAG::;
The result is as follows:
7340068 2015-04-17 05:10:34
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=16
blktotal=16

G.fast Port Detail Information of the Device 10.144.195.65


------------------------------------------------------------------------------------------------------------------------------
------------------------------
DID FN SN PN TR165CH1USPROF TR165CH1DSPROF TR165CH1INPPROF TR165NMPROF
ALIAS PSTAT ATTAINABLERATEDS ATTAINABLERATEUS TRANSSYS PPPOESESSION
7340068 0 1 0 DEFVAL UPSTREAM DEFVAL UPSTREAM DEFVAL AT_Gfast_Noise003 --
Activating -- -- -- 8
7340068 0 1 1 AT_C50Rate_005 AT_C50Rate_005 AT_INP-Delay_006 AT_Gfast_Noise002
-- Activating -- -- -- 8
7340068 0 1 2 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Deactive -- -- -- 1
7340068 0 1 3 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Deactive -- -- -- 8
7340068 0 1 4 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 5 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 6 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 7 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 813


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340068 0 1 8 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --


Activating -- -- -- 8
7340068 0 1 9 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 10 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 11 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 12 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 13 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 14 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
7340068 0 1 15 DEFVAL UPSTREAM DEFVAL DOWNSTREAM DEFVAL DEFVAL --
Activating -- -- -- 8
------------------------------------------------------------------------------------------------------------------------------
------------------------------

Related Command
LST-GFASTPORTDETAILINFO

14.5.3 Querying the Alarm Information About a G.fast Port


(LST-GFASTPORTALARM)
Usage Note
This command is used to query the alarm information about an existing G.fast
port in the system. A maximum of 10 latest alarms and 20 events are displayed
when you run this command.

Command Format
LST-GFASTPORTALARM::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 814


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="alarm on Port of the device " + device name + "frameId" + frame number + "slotId" + slot-number +
"portId"+ port ID
name of attributes: SerialNo FaultID Severity FunctionType strName ReasonID
Reason Repair Meaning FaultFlag faultTime ackTime clearTime strAckUserName Location

Output Parameter
Parameter Type Description

SerialNo INTEGER Indicates the serial


number generated by
the daemon.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 815


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Description

FaultID INTEGER Indicates the alarm or


event ID. This parameter
and the device are used
to identify an alarm or
event.

Severity INTEGER Indicates the alarm


severity or event level.

FunctionType INTEGER Indicates the type of the


alarm or event.

strName OCTET STRING Indicates the name of


the alarm or event.

ReasonID INTEGER Indicates the cause ID of


the alarm.

Reason OCTET STRING Indicates the alarm


cause.

Repair OCTET STRING Indicates the suggestion


for clearing the alarm.

Meaning OCTET STRING Indicates the description


of the alarm.

FaultFlag INTEGER Indicates the type of the


fault.

faultTime OCTET STRING Indicates the time when


the alarm or event is
generated.
The time is in UTC
format.

ackTime OCTET STRING Indicates the time when


the alarm is
acknowledged.
The time is in UTC
format.

clearTime OCTET STRING Indicates the time when


the alarm is cleared.
The time is in UTC
format.

strAckUserName OCTET STRING Indicates the


acknowledged username.

Location OCTET STRING Indicates the location of


the alarm or event.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 816


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612784 Querying alarm Verify that the entered


information failed. values of the parameters
are correct.

1610612785 Getting alarm ● Verify that the alarm


information timed out. module runs in the
normal state.
● Verify that the device
is online.

1612644886 No port alarm -


information.

Example
To query the alarm information about G.fast port 0/1/14 on the 10.144.76.227,
run the following command:
LST-GFASTPORTALARM::DEV=10.144.76.227,FN=0,SN=1,PN=14:CTAG::;
The result is as follows:
7340106 2015-04-28 17:55:38
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

alarm on Port of the device 10.144.76.227 frameId 0 slotId 1 portId 14


------------------------------------------------------------------------------------------------------------------------------
--------------------------------
SerialNo FaultID Severity FunctionType strName ReasonID Reason Repair Meaning
FaultFlag faultTime ackTime clearTime strAckUserName Location
30579 1026621480 4 5 The port pilot sequence is abnormal 0 Such kind of alarms happen too
frequently Query such kind of alarms to find out the cause. The port pilot sequence is abnormal (the
CPE does not respond or the configuration fails) 1 2015-4-28 1:20:50 -- -- -- Frame=0, Slot=1,
Subslot=65535, Port=14
------------------------------------------------------------------------------------------------------------------------------
--------------------------------

Related Command
● LST-GFASTPORTDETAILINFO
● LST-GFASTPORTPERF

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 817


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.5.4 Querying the Performance Statistics on a G.fast Port


(LST-GFASTPORTPERF)
Usage Note
This command is used to query the performance statistics on a specified G.fast
port of a device. The required G.fast port must be in the activated state.

Command Format
LST-GFASTPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::[SHOWOPTION=COCVS CPECVS COES1DAY CPEES1DAY COSES1DAY CPESES1DAY
CURR1DAYINITFULL CURR1DAYINITFAIL COCURR15SOS CPECURR15SOS COCURR24SOS CPECURR24SOS
COALLSOS CPEALLSOS COLAST15SOS CPELAST15SOS COLAST24SOS CPELAST24SOS];

Supporting Device
Device Type No. Device Type

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 818


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 819


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● COCVS (Optional) -


N STRING ● CPECVS Specifies the
attributes
● COES1DAY that can be
● CPEES1DA displayed. If
Y you set this
● COSES1DA parameter,
Y the
corresponding
● CPESES1D attributes are
AY displayed. By
● CURR1DAY default, the
INITFULL attributes are
● CURR1DAY not displayed.
INITFAIL
● COCURR15
SOS
● CPECURR1
5SOS
● COCURR24
SOS
● CPECURR2
4SOS
● COALLSOS
● CPEALLSO
S
● COLAST15
SOS
● CPELAST15
SOS
● COLAST24
SOS
● CPELAST24
SOS

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="G.fast PORT Performance Stat Info of the device " + device name
name of attributes:
DID FN SN PN COFECS COES COSES COLOSS COUS COCURR15MINLOFS COCURR15MINLOLS
COCURR15MINLOPS COCURR15MINES COCURR15MINLOSS COCURR15MINSES COCURR15MINUAS
LATUCCURR15MTIMEELAPSED CPFECS CPEES CPESES CPELOSS CPEUS CPECURR15MINLOFS
CPECURR15MINLOLS CPECURR15MINLOPS CPECURR15MINES CPECURR15MINLOSS
CPECURR15MINSES CPECURR15MINUAS LATURCURR15MTIMEELAPSED RETRAINS INITFAILS
ATURSPEED TNTO TNRO COCURR15MINEBS COCURR15MINUCBS COCURR15MINATMCELLS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 820


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

COCURR15MINPTMPKTS CHATUCCURR15MTIMEELAPSED COCURR15MINCBS COCURR15MINCVS


CPECURR15MINEBS CPECURR15MINUCBS CPECURR15MINATMCELLS CPECURR15MINPTMPKTS
CHATURCURR15MTIMEELAPSED CPECURR15MINCBS CPECURR15MINCVS COLAST15MINLOFS
COLAST15MINLOLS COLAST15MINLOPS COLAST15MINES COLAST15MINLOSS COLAST15MINSES
COLAST15MINUAS CPELAST15MINLOFS CPELAST15MINLOLS CPELAST15MINLOPS CPELAST15MINES
CPELAST15MINLOSS CPELAST15MINSES CPELAST15MINUAS COLAST15MINEBS COLAST15MINUCBS
COLAST15MINATMCELLS COLAST15MINPTMPKTS COLAST15MINCBS COLAST15MINCVS
CPELAST15MINEBS CPELAST15MINUCBS CPELAST15MINATMCELLS CPELAST15MINPTMPKTS
CPELAST15MINCBS CPELAST15MINCVS COLAST15MININITFULL COLAST15MININITFAIL
COCURR15MININITFULL COCURR15MININITFAIL COCURR15SOS CPECURR15SOS COCURR24SOS
CPECURR24SOS COALLSOS CPEALLSOS COLAST15SOS CPELAST15SOS COLAST24SOS CPELAST24SOS

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

COFECS INTEGER 0-4294967295 Indicates the


number of
forward error
correction seconds
(FECSs) of the
channel at the
central office end.
Unit: s.

COES INTEGER 0-4294967295 Indicates the


number of errored
seconds at the
central office end.
Unit: s.

COSES INTEGER 0-4294967295 Indicates the


number of
severely errored
seconds at the
central office end.
Unit: s.

COLOSS INTEGER 0-4294967295 Indicates the


number of LOSSs
at the central
office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 821


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COUS INTEGER 0-4294967295 Indicates the


number of
unavailable
seconds at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


FS number of loss of
frame seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


PS number of loss of
power seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


LS number of loss of
link seconds in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINES INTEGER 0-4294967295 Indicates the


number of errored
seconds in the
current 15
minutes at the
central office end.
Unit: s.

COCURR15MINLO INTEGER 0-4294967295 Indicates the


SS number of loss of
signal seconds in
the current 15
minutes at the
central office end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 822


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINSE INTEGER 0-4294967295 Indicates the


S number of
severely errored
seconds in the
current 15
minutes at the
central office end.
Unit: s.

COCURR15MINU INTEGER 0-4294967295 Indicates the


AS number of
unavailable
seconds in the
current 15
minutes at the
central office end.
Unit: s.

LATUCCURR15MT INTEGER 0-4294967295 Indicates the


IMEELAPSED elapsed time in
the current 15
minutes at the
central office end.
Unit: s.

CPFECS INTEGER 0-4294967295 Indicates the FECS


of the channel at
the remote end.
Unit: s.

CPEES INTEGER 0-4294967295 Indicates the


number of errored
seconds at the
remote end.
Unit: s.

CPESES INTEGER 0-4294967295 Indicates the


number of
severely errored
seconds at the
remote end.
Unit: s.

CPELOSS INTEGER 0-4294967295 Indicates the


number of LOSSs
at the remote
end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 823


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPEUS INTEGER 0-4294967295 Indicates the


number of
unavailable
seconds at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OFS number of loss of
frame seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OLS number of loss of
link seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the


OPS number of loss of
power seconds in
the current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINE INTEGER 0-4294967295 Indicates the


S number of errored
seconds in the
current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINL INTEGER 0-4294967295 Indicates the loss


OSS of signal seconds
in the current 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 824


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR15MINS INTEGER 0-4294967295 Indicates the


ES number of
severely errored
seconds in the
current 15
minutes at the
remote end.
Unit: s.

CPECURR15MINU INTEGER 0-4294967295 Indicates the


AS number of
unavailable
seconds in the
current 15
minutes at the
remote end.
Unit: s.

LATURCURR15MT INTEGER 0-4294967295 Indicates the


IMEELAPSED elapsed time in
the current 15
minutes at the
remote end.
Unit: s.

RETRAINS INTEGER 0-2147483647 Indicates the


number of
complete line
initializations.

INITFAILS INTEGER 0-2147483647 Indicates the


number of
initialization
failures.

ATURSPEED INTEGER 0-4294967295 Indicates the port


rate at the remote
end.
Unit: bit/s.

TNTO INTEGER 0-2147483647 Indicates the total


number of
upstream bytes.

TNRO INTEGER 0-2147483647 Indicates the total


number of
downstream
bytes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 825


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
current 15
minutes at the
central office end.

COCURR15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected
automatically in
the current 15
minutes at the
central office end.

COCURR15MINAT INTEGER 0-4294836225 Indicates the


MCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
current 15
minutes at the
central office end.

COCURR15MINPT INTEGER 0-4294836225 Indicates the


MPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
current 15
minutes at the
central office end.

CHATUCCURR15 INTEGER 0-4294836225 Indicates the


MTIMEELAPSED elapsed time in
the current 15
minutes at the
central office end.
Unit: s.

COCURR15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the current 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 826


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COCURR15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
current 15
minutes at the
central office end.

CPECURR15MINE INTEGER 0-4294836225 Indicates the


BS number of FEC
code blocks in the
current 15
minutes at the
remote end.

CPECURR15MINU INTEGER 0-4294836225 Indicates the


CBS number of blocks
that cannot be
corrected
automatically in
the current 15
minutes at the
remote end.

CPECURR15MINA INTEGER 0-4294836225 Indicates the


TMCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
current 15
minutes at the
remote end.

CPECURR15MINP INTEGER 0-4294836225 Indicates the


TMPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
current 15
minutes at the
remote end.

CHATURCURR15 INTEGER 0-4294836225 Indicates the


MTIMEELAPSED elapsed time in
the current 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 827


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR15MINC INTEGER 0-4294836225 Indicates the


BS number of
corrected blocks
in the channel in
the current 15
minutes at the
remote end.

CPECURR15MINC INTEGER 0-4294836225 Indicates the


VS number of the
abnormal CRC
codes in the
channel in the
current 15
minutes at the
remote end.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


FS number of loss of
frame seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


PS number of loss of
power seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINLO INTEGER 0-4294836225 Indicates the


LS number of loss of
link seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINES INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 828


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MINLO INTEGER 0-4294836225 Indicates the


SS number of loss of
signal seconds in
the last 15
minutes at the
central office end.
Unit: s.

COLAST15MINSES INTEGER 0-4294836225 Indicates the


number of
severely errored
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

COLAST15MINUA INTEGER 0-4294836225 Indicates the


S number of
unavailable
seconds in the
last 15 minutes at
the central office
end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


FS number of loss of
frame seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


PS number of loss of
power seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


LS number of loss of
link seconds in
the last 15
minutes at the
remote end.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 829


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINES INTEGER 0-4294836225 Indicates the


number of errored
seconds in the
last 15 minutes at
the remote end.
Unit: s.

CPELAST15MINLO INTEGER 0-4294836225 Indicates the


SS number of loss of
signal seconds in
the last 15
minutes at the
remote end.
Unit: s.

CPELAST15MINSE INTEGER 0-4294836225 Indicates the


S number of
severely errored
seconds in the
last 15 minutes at
the remote end.
Unit: s.

CPELAST15MINU INTEGER 0-4294836225 Indicates the


AS number of
unavailable
seconds in the
last 15 minutes at
the remote end.
Unit: s.

COLAST15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected in the
channel
automatically in
the last 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 830


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MINAT INTEGER 0-4294836225 Indicates the


MCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINPT INTEGER 0-4294836225 Indicates the


MPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
last 15 minutes at
the central office
end.

COLAST15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the last 15
minutes at the
central office end.

COLAST15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
last 15 minutes at
the central office
end.

CPELAST15MINEB INTEGER 0-4294836225 Indicates the


S number of FEC
code blocks in the
channel in the
last 15 minutes at
the remote end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 831


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPELAST15MINUC INTEGER 0-4294836225 Indicates the


BS number of blocks
that cannot be
corrected in the
channel
automatically in
the last 15
minutes at the
remote end.

CPELAST15MINAT INTEGER 0-4294836225 Indicates the


MCELLS number of ATM
cells that are
received and
transmitted by the
channel in the
last 15 minutes at
the remote end.

CPELAST15MINPT INTEGER 0-4294836225 Indicates the


MPKTS number of PTM
packets that are
received and
transmitted by the
channel in the
last 15 minutes at
the remote end.

CPELAST15MINCB INTEGER 0-4294836225 Indicates the


S number of
corrected blocks
in the channel in
the last 15
minutes at the
remote end.

CPELAST15MINCV INTEGER 0-4294836225 Indicates the


S number of the
abnormal CRC
codes in the
channel in the
last 15 minutes at
the remote end.

COLAST15MININI INTEGER 0-4294836225 Indicates the


TFULL number of full
initialization times
in the last 15
minutes at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 832


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST15MININI INTEGER 0-4294836225 Indicates the


TFAIL number of full
initialization
failures in the
past 15 minutes
at the central
office end.

COCURR15MININI INTEGER 0-4294836225 Indicates the


TFULL number of full
initialization times
within the current
15 minutes at the
central office end.

COCURR15MININI INTEGER 0-4294836225 Indicates the


TFAIL number of fill
initialization
failures within the
current 15
minutes at the
central office end.

COCURR15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 15-minute
performance
statistics at the
central office end.

CPECURR15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 15-minute
performance
statistics at the
remote end.

COCURR24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 24-hour
performance
statistics at the
central office end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 833


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CPECURR24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
current 24-hour
performance
statistics at the
remote end.

COALLSOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in all
current
performance
statistics at the
central office end.

CPEALLSOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in all
current
performance
statistics at the
remote end.

COLAST15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
historical 15-
minute
performance
statistics at the
central office end.

CPELAST15SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
historical 15-
minute
performance
statistics at the
remote end.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 834


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLAST24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
historical 24-hour
performance
statistics at the
central office end.

CPELAST24SOS INTEGER 0-4294836225 Indicates the


number of SOSs
that are added
successfully in the
last 24-hour
performance
statistics at the
remote end.

Error Code
ID Description Solution

1613561870 Interacting with the Verify that the


performance and performance statistics
statistic daemon failed, daemon runs in the
please check the normal state.
performance and
statistic daemon

1613561871 The performance Verify that the


statistics task does not performance statistics of
exist. the specified port is
available. If the
performance statistics is
not available, create the
performance statistics
collection task for the
port on the GUI.

Example
To query the performance statistics of G.fast port 0/1/15 on the 10.144.195.65,
run the following command:
LST-GFASTPORTPERF::DEV=10.144.195.65,FN=0,SN=1,PN=15:2::;
The result is as follows:
7340068 2015-04-16 20:03:14
M 2 COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 835


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

G.fast PORT Performance Stat Info of the device 10.144.195.65


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------
DID FN SN PN COFECS COES COSES COLOSS COUS COCURR15MINLOFS
COCURR15MINLOLS COCURR15MINLOPS COCURR15MINES COCURR15MINLOSS
COCURR15MINSES COCURR15MINUAS LATUCCURR15MTIMEELAPSED CPFECS CPEES CPESES
CPELOSS CPEUS CPECURR15MINLOFS CPECURR15MINLOLS CPECURR15MINLOPS
CPECURR15MINES CPECURR15MINLOSS CPECURR15MINSES CPECURR15MINUAS
LATURCURR15MTIMEELAPSED RETRAINS INITFAILS ATURSPEED TNTO TNRO
COCURR15MINEBS COCURR15MINUCBS COCURR15MINATMCELLS COCURR15MINPTMPKTS
CHATUCCURR15MTIMEELAPSED COCURR15MINCBS COCURR15MINCVS CPECURR15MINEBS
CPECURR15MINUCBS CPECURR15MINATMCELLS CPECURR15MINPTMPKTS
CHATURCURR15MTIMEELAPSED CPECURR15MINCBS CPECURR15MINCVS COLAST15MINLOFS
COLAST15MINLOLS COLAST15MINLOPS COLAST15MINES COLAST15MINLOSS
COLAST15MINSES COLAST15MINUAS CPELAST15MINLOFS CPELAST15MINLOLS
CPELAST15MINLOPS CPELAST15MINES CPELAST15MINLOSS CPELAST15MINSES
CPELAST15MINUAS COLAST15MINEBS COLAST15MINUCBS COLAST15MINATMCELLS
COLAST15MINPTMPKTS COLAST15MINCBS COLAST15MINCVS CPELAST15MINEBS
CPELAST15MINUCBS CPELAST15MINATMCELLS CPELAST15MINPTMPKTS CPELAST15MINCBS
CPELAST15MINCVS COLAST15MININITFULL COLAST15MININITFAIL COCURR15MININITFULL
COCURR15MININITFAIL
7340068 0 1 15 -- -- -- -- -- -- -- -- -- -- -- -- 0 -- -- -- -- -- --
-- -- -- -- -- -- 0 -- -- 200000000 -- -- -- -- -- -- 0 -- -- -- -- --
-- 0 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- -- -- -- -- -- -- -- --
----------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------

Related Command
● LST-GFASTPORTDETAILINFO
● LST-GFASTPORTALARM
● ACT-GFASTPORT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 836


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.5.5 Querying the Alarm Status of an xDSL Port (LST-


XDSLPORTALARMSTATE)
Usage Note
This command is used to query the alarm status of an xDSL port or a G.fast port
in the common mode (RFC2662), TI mode or TR165 mode.

Command Format
LST-XDSLPORTALARMSTATE::(DID=device-ID|DEV=device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T
● TR165 mode and TI mode: MA5600
V800R008 and later versions
● Common mode: MA5600
V800R006C02, MA5600
V800R007C01, MA5600V800R008
and later versions

100 MA5616
● ADSL port in TR165 mode: MA5616
V800R308C00 and later versions
● VDSL2 port in common mode:
MA5616 V800R309C00 and later
versions

2331 MA5608T
● VDSL2 port in TR165 mode

249 MA5600T
● TR165 mode and TI mode: MA5600
V800R008 and later versions
● Common mode: MA5600
V800R006C02, MA5600
V800R007C01, MA5600V800R008
and later versions

2340 MA5611S
● VDSL2 port in TR165 mode

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 837


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Port alarm of the device: " + device name + "frameId:" + frame number + "slotId:" + slot-number +
"portId:"+ port number
name of attributes:DID FN SN PN COLOF COLOS COLPR COLOSQ COLOL CODIF COCIF COPIF COIF
CONPAP CPELOF CPELOS CPELPR CPELOSQ

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 838


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter

If no mode is specified for a parameter, the parameter is supported by the common mode
(RFC2662), TI mode, and TR165 mode.

Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

COLOF OCTET STRING ● Yes Specifies whether


● No Loss of Frame
alarms are
generated at the
central office
(CO).

COLOS OCTET STRING ● Yes Specifies whether


● No Loss of Signal
alarms are
generated at the
CO.

COLPR OCTET STRING ● Yes Specifies whether


● No Loss of Power
alarms are
generated at the
CO.

COLOSQ OCTET STRING ● Yes Specifies whether


● No Loss of Signal
Quality alarms
are generated at
the CO.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 839


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COLOL OCTET STRING ● Yes Specifies whether


● No Loss of Link
alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

CODIF OCTET STRING ● Yes Specifies whether


● No Data Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COCIF OCTET STRING ● Yes Specifies whether


● No Configuration
Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

COPIF OCTET STRING ● Yes Specifies whether


● No Protocol
Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 840


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

COIF OCTET STRING ● Yes Specifies whether


● No Initialization
Failure alarms are
generated at the
CO.
NOTE
ADSL ports in
common mode
support this
parameter.

CONPAP OCTET STRING ● Yes Specifies whether


● No No Peer ATU
Present alarms
are generated at
the CO.
NOTE
ADSL ports in
common mode
support this
parameter.

CPELOF OCTET STRING ● Yes Specifies whether


● No Loss of Frame
alarms are
generated at the
remote end.

CPELOS OCTET STRING ● Yes Specifies whether


● No Loss of Signal
alarms are
generated at the
remote end.

CPELPR OCTET STRING ● Yes Specifies whether


● No Loss of Power
alarms are
generated at the
remote end.

CPELOSQ OCTET STRING ● Yes Specifies whether


● No Loss of Signal
Quality alarms
are generated at
the remote end.
NOTE
ADSL ports in
common mode
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 841


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2689014668 Port type is invalid. Verify that the input port


type is ADSL, VDSL2 or
G.fast.

2686058552 The resource does not exist. Verify that the input port
exists. If it exists,
synchronize the port on the
NMS.

Example
To query the alarm status of port 0/8/5 on the device named 10.71.59.35, an
ADSL port in TR165 mode, run the following command:

LST-XDSLPORTALARMSTATE::DEV=10.71.59.35,FN=0,SN=8,PN=5:CTAG::;
The result is as follows:
7340032 2011-09-06 10:43:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Port alarm of the device:10.71.59.35 frameId:0 slotId:8 portId:5


--------------------------------------------------------------------------------
--------------------------------------------
DID FN SN PN COLOF COLOS COLPR COLOSQ COLOL CODIF
COCIF COPIF COIF CONPAP CPELOF CPELOS CPELPR CPELOSQ
7340032 0 8 5 No No No -- -- --
-- -- No -- No No No --
--------------------------------------------------------------------------------
--------------------------------------------

Related Command
None

14.5.6 Querying the Bit Allocation Information About a G.fast


Port (LST-GFASTBITALLOCINFO)

Usage Note
The G.fast port must be in the activated state.

Command Format
LST-GFASTBITALLOCINFO::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::DIRECTION=line-direction;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 842


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R017C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 843


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DIRECTION OCTET UP Indicates the -


STRING DOWN bit allocation
direction of
the G.fast
port.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The bit allot information of G.fast port " + device-name + " frameId " + frame-number
+ " slotId " + slot-number + " portId "+ port-number + " direction " + line-direction
name of attributes: DID FN SN PN SubcarrierId BitInfo

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

SubcarrierId INTEGER 0-4095 Indicates the ID of


the upstream/
downstream sub-
carrier.

BitInfo INTEGER 0-15 Indicates bit


allocation
information about
the sub-carrier.
Unit: byte.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 844


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid. Check whether the port to be


queried is a G.fast port.

Example
To query the bit allocation information of G.fast port 0/1/1 on the device named
10.144.85.122, run the following command:

LST-
GFASTBITALLOCINFO::DEV=10.144.85.122,FN=0,SN=1,PN=1:CTAG::DIRECTION=
DOWN;

The result is as follows:


7340081 2015-04-20 16:47:20
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=100
blktotal=4096

The bit allot information of G.fast port 10.144.85.122


-------------------------------------------
DID FN SN PN SubcarrierId BitInfo
7340081 0 1 1 0 0
7340081 0 1 1 1 0
7340081 0 1 1 2 0
7340081 0 1 1 3 0
7340081 0 1 1 4 0
7340081 0 1 1 5 0
......
7340081 0 1 1 92 12
7340081 0 1 1 93 12
7340081 0 1 1 94 12
7340081 0 1 1 95 12
7340081 0 1 1 96 12
7340081 0 1 1 97 12
7340081 0 1 1 98 12
7340081 0 1 1 99 12
-------------------------------------------
;

Related Command
● ACT-GFASTPORT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 845


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.5.7 Querying the U-MAC/V-MAC of an xDSL Port (LST-


XDSLPORTMACMAPING)
Usage Note
This command is used to query the U-MAC and V-MAC of an ADSL, VDSL2, or
G.fast port.

Command Format
LST-XDSLPORTMACMAPING::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T

100 MA5616
● ADSL port in TR165 mode: MA5616
V800R308C00 and later versions
● VDSL2 port in common mode:
MA5616 V800R309C00 and later
versions

2331 MA5608T

249 MA5600T

2340 MA5611S

2350 MA5811S V800R16C00 and later


versions

2339 MA5818 V800R17C00 and later


versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 846


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The mac address information of xdsl port " + device-name + " frameId " + frame-number
+ " slotId " + slot-number + " portId "+ port-number
name of attributes: DID FN SN PN UMAC VMAC

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 847


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

UMAC OCTET STRING SIZE (1-17) Indicates the U-


MAC list.

VMAC OCTET STRING SIZE (1-17) Indicates the V-


MAC list.

Error Code
ID Description Solution

1610612765 Device offline error. Check the network and device


status. Ensure that you reissue
the command after the device
goes online.

2686058552 The resource does not If the queried resource does not
exist. exist, enter a parameter to locate
an available resource and then
reissue the command.

2689014668 Port type is invalid. Check whether the port to be


queried is an ADSL, VDSL2, or
G.fast port.

Example
To query the U-MAC and V-MAC of xDSL port 0/13/30 on the device named
10.144.199.35, run the following command:
LST-XDSLPORTMACMAPING::DEV=10.144.199.35,FN=0,SN=13,PN=30:CTAG::;
The result is as follows:
7340178 2011-07-09 15:28:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=10
blktotal=10

The mac address information of xdsl port 10.144.199.35 frameId:0 slotId:13 portId:30
--------------------------------
DID FN SN PN UMAC VMAC
7340110 0 13 30 00-50-BA-50-73-2E 02-00-00-06-0A-40

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 848


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340110 0 13 30 00-50-BA-50-73-25 02-00-00-06-0A-41


7340110 0 13 30 00-50-BA-50-73-26 02-00-00-06-0A-42
7340110 0 13 30 00-50-BA-50-73-27 02-00-00-06-0A-43
7340110 0 13 30 00-50-BA-50-73-28 02-00-00-06-0A-44
7340110 0 13 30 00-50-BA-50-73-29 02-00-00-06-0A-45
7340110 0 13 30 00-50-BA-50-73-2A 02-00-00-06-0A-46
7340110 0 13 30 00-50-BA-50-73-2B 02-00-00-06-0A-47
7340110 0 13 30 00-50-BA-50-73-2C 02-00-00-06-0A-48
7340110 0 13 30 00-50-BA-50-73-2D 02-00-00-06-0A-49
--------------------------------

Related Command
● ACT-ADSLPORT
● ACT-VDSL2PORT
● ACT-GFASTPORT

14.6 Querying a Bonding Group


This topic provides the commands and examples for querying the bonding group
on the device and the details of the bonding group.

14.6.1 Querying a Bonding Group (RTRV-BONDGRP)


Usage Note
None.

Command Format
RTRV-BONDGRP::(DID=Device-ID|DEV=Device-name)[,NAME=bonding-group-name]:CTAG::PT=port-type;

Supporting Device
Device Type No. Device Type

37 MA5662

94 MA5603U

100 MA5616

249 MA5600T

2331 MA5608T

95 MA5603T

2340 MA5611S

2350 MA5811S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 849


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

NAME OCTET SIZE (32) Indicates the -


STRING name of the
bonding
group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 850


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PT INTEGER 1 Indicates the -


25 port type.
The meanings
of the options
are as follows:
● 1: ADSL
port. The
MA5616,
MA5603T
or
MA5600T
supports
the ADSL
port type.
● 25: VDSL
port. The
MA5662,
MA5603U,
MA5603T
or
MA5600T
supports
the VDSL
port type.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Bonding group of the device "+device-name
DID NAME

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

NAME OCTET STRING SIZE (32) Indicates the


name of the
bonding group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 851


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the entered


parameter or mandatory command is correct
parameter is blank, or according to the
the parameter value is following requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The parameter names
are correct.
● The parameters are
entered in the correct
order.

2686058531 The device does not Ensure that the entered


exist. device name or device ID
is correct.

Example
To query the bonding group on the device named 10.71.211.105, run the
following command:
RTRV-
BONDGRP::DEV=10.71.211.105,NAME=012345678901234567890123456789AB:-
1502219035::PT=25;
The result is as follows:
7340032 2009-07-02 15:52:45
M -1502219035 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Bonding group of the device 10.71.211.105
------------------------------------------
DID NAME
7340032 012345678901234567890123456789AB
------------------------------------------

Related Command
RTRV-BONDGRPDETAIL

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 852


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.6.2 Querying the Details of a Bonding Group (RTRV-


BONDGRPDETAIL)
Usage Note
None.

Command Format
RTRV-BONDGRPDETAIL::(DID=Device-ID|DEV=Device-name),NAME=bonding-group-name:CTAG::PT=port-
type[,SHOWOPTION=BGPROF];

Supporting Device
Device Type No. Device Type

37 MA5662

94 MA5603U

95 MA5603T

100 MA5616

2331 MA5608T

249 MA5600T

2340 MA5611S

2350 MA5811S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 853


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

NAME OCTET SIZE (32) Indicates the -


STRING name of the
bonding
group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 854


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PT INTEGER 1 Indicates the -


25 port type.
The meanings
of the options
are as follows:
● 1: ADSL
port. The
MA5616,
MA5603T
or
MA5600T
supports
the ADSL
port type.
● 25: VDSL
port. The
MA5616,
MA5662,
MA5603U,
MA5603T
or
MA5600T
supports
the VDSL
port type.

SHOWOPTIO OCTET BGPROF Specifies the -


N STRING attributes
that can be
displayed in
the returned
result. If you
set this
parameter,
the
corresponding
attributes are
displayed. For
example, if
you enter
BGPROF, the
result
contains the
information
about this
attribute. By
default, the
attributes are
not displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 855


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Bonding group information of the device "+device-name
DID NAME ALIAS DISCOVERYCODE SCHEME PEERSCHEME ALMTHRATESW UPTHRATE DNTHRATE
TARGETUPRATE TARGETDNRATE PRIMARYPORT SUBPORT BGPROF

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

NAME OCTET STRING SIZE (32) Indicates the


name of the
bonding group.

ALIAS OCTET STRING SIZE (32) Indicates the alias


of the bonding
group.

DISCOVERYCODE OCTET STRING SIZE (17) Indicates the


discovery code.
The format of this
parameter is
XXXX-XXXX-XXXX,
where XXXX
ranges from 0 to
9 and A to F.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 856


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SCHEME OCTET STRING ATM Indicates the


EFM bonding scheme.
The options are as
TDIM follows:
● ATM: Indicates
the X digital
subscriber line
(xDSL) access
bonding based
on the ATM
traffic stream.
● EFM: Indicates
the xDSL
access bonding
based on the
Ethernet traffic
stream.
● TDIM: Indicates
the xDSL
access bonding
based on a mix
of service
modes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 857


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PEERSCHEME OCTET STRING ATM Indicates the peer


EFM bonding scheme.
The options are as
TDIM follows:
● ATM: Indicates
the X digital
subscriber line
(xDSL) access
bonding based
on the ATM
traffic stream.
● EFM: Indicates
the xDSL
access bonding
based on the
Ethernet traffic
stream.
● TDIM: Indicates
the xDSL
access bonding
based on a mix
of service
modes.
Note: Currently,
the value of this
parameter is the
same as the value
of the SCHEME
parameter.

ALMTHRATESW OCTET STRING ONOFF Specifies whether


to enable the
function of
reporting the
threshold alarm
of the rate.

UPTHRATE INTEGER 1-1000000 Indicates the


threshold of the
upstream rate.
Unit: kbit/s.

DNTHRATE INTEGER 1-1000000 Indicates the


threshold of the
downstream rate.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 858


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TARGETUPRATE INTEGER 1-1000000 or Indicates the


9999999 target upstream
rate.
Unit: kbit/s.
If this parameter
is set to 9999999,
it indicates that
the rate is not
limited.

TARGETDNRATE INTEGER 1-1000000 or Indicates the


9999999 target
downstream rate.
Unit: kbit/s.
If this parameter
is set to 9999999,
it indicates that
the rate is not
limited.

PRIMARYPORT OCTET STRING SIZE (12) Indicates the


primary port of
the bonding
group.
The format is
FN/SN/PN.

SUBPORT OCTET STRING SIZE (64) Indicates the


secondary ports
of the bonding
group.
The format is
FN/SN/
PN#FN/SN/PN.

BGPROF OCTET STRING SIZE (64) Indicates the


name of the
bonding group
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 859


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the entered


parameter or mandatory command is correct
parameter is blank, or according to the
the parameter value is following requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The parameter names
are correct.
● The parameters are
entered in the correct
order.

2686058531 The device does not Ensure that the entered


exist. device name or device ID
is correct.

Example
To query the details of the bonding group on the device named 10.144.195.221,
run the following command:
RTRV-
BONDGRPDETAIL::DEV=10.144.195.221,NAME=VDSL2BONDING-0/15/5:137722
403::PT=25;
The result is as follows:
7340047 2012-08-25 10:20:58
M 137722403 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Bonding group information of the device 10.144.195.221


------------------------------------------------------------------------------------------------------------------------------
---------------
DID NAME ALIAS DISCOVERYCODE SCHEME PEERSCHEME ALMTHRATESW UPTHRATE
DNTHRATE TARGETUPRATE TARGETDNRATE PRIMARYPORT SUBPORT
7340047 VDSL2BONDING-0/15/5 -- 1234-5678-9002 EFM EFM OFF 1000000 1000000
999999 999999 0/15/5 0/15/6
------------------------------------------------------------------------------------------------------------------------------
---------------

Related Command
RTRV-BONDGRP

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 860


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.6.3 Querying Performance Statistics of a VDSL2 Bonding


Group (LST-VDSL2BONDINGGROUPPERF)
Usage Note
This command is used to query performance statistics of a VDSL2 bonding group
on a specified device. The queried bonding group must exist and the entered port
ID in the command must be the ID of the primary port in the bonding group.

Command Format
LST-VDSL2BONDINGGROUPPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-
num,PN=Port-num:CTAG::;

Supporting Device
Device Type No. Device Type

37 MA5662
MA5662 V800R203C00 and later
versions

94 MA5603U
MA5600 V800R10C00 and later
versions

95 MA5603T
MA5600 V800R10C00 and later
versions

2331 MA5608T

249 MA5600T
MA5600 V800R10C00 and later
versions

2340 MA5611S

2350 MA5811S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 861


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 Bonding Group Performance Stat Information of the Device " + device name
DID FN SN PN NAME RXERRORS RXSMALLFRAGMENTS RXLARGEFRAGMENTS RXBADFRAGMENTS
RXLOSTFRAGMENTS RXLOSTSTARTS RXLOSTENDS RXOVERFLOWS CURR15MINRXERRORS
CURR15MINRXSMALLFRAGMENTS CURR15MINRXLARGEFRAGMENTS CURR15MINRXBADFRAGMENTS
CURR15MINRXLOSTFRAGMENTS CURR15MINRXLOSTSTARTS CURR15MINRXLOSTENDS
CURR15MINRXOVERFLOWS CURR1DAYRXERRORS CURR1DAYRXSMALLFRAGMENTS
CURR1DAYRXLARGEFRAGMENTS CURR1DAYRXBADFRAGMENTS CURR1DAYRXLOSTFRAGMENTS
CURR1DAYRXLOSTSTARTS CURR1DAYRXLOSTENDS CURR1DAYRXOVERFLOWS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 862


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

NAME OCTET STRING SIZE (128) Indicates the


name of the
bonding group.

RXERRORS INTEGER 0-2147483647 Indicates the


number of error
data chunks
received and
dropped.
Unit: number.

RXSMALLFRAGME INTEGER 0-2147483647 Indicates the


NTS number of data
chunks smaller
than 64 bytes.
Unit: number.

RXLARGEFRAGME INTEGER 0-2147483647 Indicates the


NTS number of data
chunks larger
than 512 bytes.
Unit: number.

RXBADFRAGMEN INTEGER 0-2147483647 Indicates the


TS number of data
chunks with
inconsecutive SNs.
Unit: number

RXLOSTFRAGMEN INTEGER 0-2147483647 Indicates the


TS number of data
chunks with
inconsecutive SNs.
Unit: number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 863


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RXLOSTSTARTS INTEGER 0-2147483647 Indicates the


number of lost
start indicators for
packets.
Unit: number.

RXLOSTENDS INTEGER 0-2147483647 Indicates the


number of lost
end indicators for
packets.
Unit: number.

RXOVERFLOWS INTEGER 0-2147483647 Indicates the


number of data
chunks received
and dropped.
Unit: number

CURR15MINRXER INTEGER 0-2147483647 Indicates the


RORS number of error
data chunks
received and
dropped in the
current 15
minutes.
Unit: number.

CURR15MINRXSM INTEGER 0-2147483647 Indicates the


ALLFRAGMENTS number of data
chunks smaller
than 64 bytes in
the current 15
minutes.
Unit: number.

CURR15MINRXLA INTEGER 0-2147483647 Indicates the


RGEFRAGMENTS number of data
chunks larger
than 512 bytes in
the current 15
minutes.
Unit: number.

CURR15MINRXBA INTEGER 0-2147483647 Indicates the


DFRAGMENTS number of data
chunks with
inconsecutive SNs
in the current 15
minutes.
Unit: number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 864


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CURR15MINRXLO INTEGER 0-2147483647 Indicates the


STFRAGMENTS number of data
chunks with
inconsecutive SNs
in the current 15
minutes.
Unit: number.

CURR15MINRXLO INTEGER 0-2147483647 Indicates the


STSTARTS number of lost
start indicators for
packets in the
current 15
minutes.

CURR15MINRXLO INTEGER 0-2147483647 Indicates the


STENDS number of lost
end indicators for
packets in the
current 15
minutes.

CURR15MINRXOV INTEGER 0-2147483647 Indicates the


ERFLOWS number of data
chunks received
and dropped in
the current 15
minutes.
Unit: number.

CURR1DAYRXERR INTEGER 0-2147483647 Indicates the


ORS number of error
data chunks
received and
dropped in the
current 24 hours.
Unit: number.

CURR1DAYRXSMA INTEGER 0-2147483647 Indicates the


LLFRAGMENTS number of data
chunks smaller
than 64 bytes in
the current 24
hours.
Unit: number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 865


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CURR1DAYRXLAR INTEGER 0-2147483647 Indicates the


GEFRAGMENTS number of data
chunks larger
than 512 bytes in
the current 24
hours.
Unit: number.

CURR1DAYRXBAD INTEGER 0-2147483647 Indicates the


FRAGMENTS number of data
chunks with
inconsecutive SNs
in the current 24
hours.
Unit: number.

CURR1DAYRXLOS INTEGER 0-2147483647 Indicates the


TFRAGMENTS number of data
chunks with
inconsecutive SNs
in the current 24
hours.
Unit: number.

CURR1DAYRXLOS INTEGER 0-2147483647 Indicates the


TSTARTS number of lost
start indicators for
packets in the
current 24 hours.

CURR1DAYRXLOS INTEGER 0-2147483647 Indicates the


TENDS number of lost
end indicators for
packets in the
current 24 hours.

CURR1DAYRXOVE INTEGER 0-2147483647 Indicates the


RFLOWS number of data
chunks received
and dropped in
the current 24
hours.
Unit: number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 866


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2689018463 The bonding Check whether a bonding group for the


group does not specified primary port has been
exist. configured for the specified primary
port.

Example
To query performance statistics of the bonding group for the primary VDSL2 port
0/2/1 on NE 10.78.217.213, run the following command:

LST-VDSL2BONDINGGROUPPERF::DEV=10.78.217.213,FN=0,SN=2,PN=1:CTAG::;

The result is as follows:


7340034 2011-10-13 18:28:17
M CTAG COMPLD
EN=0 ENDESC=Succeeded.

blktag=1
blkcount=1
blktotal=1

VDSL2 Bonding Group Performance Stat Information of the Device 10.78.217.213


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------ DID FN SN PN NAME RXERRORS RXSMALLFRAGMENTS RXLARGEFRAGMENTS
RXBADFRAGMENTS RXLOSTFRAGMENTS RXLOSTSTARTS RXLOSTENDS RXOVERFLOWS
CURR15MINRXERRORS CURR15MINRXSMALLFRAGMENTS CURR15MINRXLARGEFRAGMENTS
CURR15MINRXBADFRAGMENTS CURR15MINRXLOSTFRAGMENTS CURR15MINRXLOSTSTARTS
CURR15MINRXLOSTENDS CURR15MINRXOVERFLOWS CURR1DAYRXERRORS
CURR1DAYRXSMALLFRAGMENTS CURR1DAYRXLARGEFRAGMENTS CURR1DAYRXBADFRAGMENTS
CURR1DAYRXLOSTFRAGMENTS CURR1DAYRXLOSTSTARTS CURR1DAYRXLOSTENDS
CURR1DAYRXOVERFLOWS 7340034 0 2 1 VDSL2BONDING-0/2/1
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
------------

Related Command
There is no related command.

14.6.4 Querying the Details of a VDSL2 Bonding Group (LST-


VDSL2BONDINGDETAILINFO)

Usage Note
This command is used to query the details of a VDSL2 bonding group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 867


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-VDSL2BONDINGDETAILINFO::(DID=Device-ID|DEV=Device-name),[FN=frame-num,SN=slotnum,PN=port-
num]:CTAG::[SHOWOPTION=TOTALNUMBER];

Supporting Device
Device Type No. Device Type

249 MA5600T

37 MA5662

94 MA5603U

95 MA5603T

2331 MA5608T

2340 MA5611S

100 MA5616

2350 MA5811S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 868


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 869


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET TOTALNUMBE Specifies -


N STRING R whether the
title of the
returned
result
contains the
total number
of bonding
groups. If this
parameter is
specified, the
returned
result
contains the
total number
of bonding
groups. By
default, this
attribute is
not displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="VDSL2 Bonding Group Information of the Device " + device-name
or "VDSL2 Bonding Group Information of the Device " + device-name + ", total number of "+ DID + ":" +
number
name of attributes: DID FN SN PN STATUS LASTUPTIME LASTDOWNTIME REINITS

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

STATUS OCTET STRING ● Activated Indicates the


● Activating running status of
the bonding
● Deactivated group.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 870


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LASTUPTIME OCTET STRING - Indicates the time


when the VDSL2
port is online.
The format is YY-
MM-DD
hh:mm:ss.
The time is a local
time and in DST
format.

LASTDOWNTIME OCTET STRING - Indicates the time


when the VDSL2
port is
disconnected.
The format is YY-
MM-DD
hh:mm:ss.
The time is a local
time and in DST
format.

REINITS INTEGER 0-4294967295 Indicates the


retraining times
of a bonding
group.

Error Code
ID Description Solution

2689007617 The instance does not exist, Verify that the command is
or the feature is not correct according to the
supported or not following requirements:
configured. ● Check whether the
entered port is a VDSL2
port.
● Check whether the
entered port exists.

Example
To query the bonding group of port 0/2/13 on the device named 10.144.195.20,
run the following command:
LST-
VDSL2BONDINGDETAILINFO::DEV=10.144.195.20,FN=0,SN=2,PN=13:CTAG::SHO
WOPTION=TOTALNUMBER;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 871


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The result is as follows:


7340032 2011-10-20 17:27:09
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

VDSL2 Bonding Group Information of the Device 10.144.195.20, total number of 7340032/0/2/13: 1
---------------------------------------------------------------
DID FN SN PN STATUS LASTUPTIME LASTDOWNTIME REINITS
7340032 0 2 13 Deactivated -- -- 0
---------------------------------------------------------------

Related Command
● LST-VDSLPORTPERF
● LST-VDSLPORTALARM

14.7 Querying Video Resources


This topic provides the commands and examples for querying video resources,
including the information about NTV programs, the NTV users, and the NTV rights
profiles.

14.7.1 Querying the List of Virtual Upstream Ports in an IGMP


VLAN (LST-IGMPUPLINKPORT)

Usage Note
This command is available only when the multicast mode of a device is MVLAN
mode.

Command Format
LST-IGMPUPLINKPORT::(DID=Device-ID|DEV=Device-name)[,IGMPVLAN=igmp-vlan-id]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

2348 MA5683T

37 MA5662

61 MA5626E

62 MA5620E

64 MA5651

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 872


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

65 MA5620G

66 MA5626G

70 MA5610

92 MA5652G
The MA5652G V800R307C00 and later
versions

95 MA5603T

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2331 MA5608T

249 MA5600T

253 UA5000IPMB

2312 MA5628

2321 MA5669

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2326 MA5623A V800R311C01 and later


versions

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 873


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 874


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

IGMPVLAN INTEGER 1-4095 (Optional) N/A


Indicates the
IGMP VLAN
ID.

You can enter the query criteria, such as the device ID, device name, and IGMP VLAN ID, to
query the corresponding information. The device ID or the device name must be set. The
IGMP VLAN ID is optional. If you do not set the parameter, the list of the virtual upstream
ports in all IGMP VLANs is displayed.

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.
title="Visual Uplink Port information of the device "+device-name
DID FN SN PN IGMPVLAN

Output Parameter
Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

IGMPVLAN INTEGER 1-4095 Indicates the


IGMP VLAN ID.

Error Code
None.

Example
To query all virtual upstream ports of the device named 10.78.217.232 for the
multicast VLAN 1. Run the following command:
LST-IGMPUPLINKPORT::DEV=10.78.217.232,IGMPVLAN=1:CTAG::;
The result is as follows:
7340100 2010-03-16 22:57:33
M CTAG COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 875


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Visual Uplink Port information of the device 10.78.217.232
------------------------------
DID FN SN PN IGMPVLAN
7340100 0 17 0 1
------------------------------
;

Related Command
There is no related command.

14.7.2 Querying the Information About Multicast Programs


(LST-NTVPROGRAM)

Usage Note
None.

Command Format
LST-NTVPROGRAM::(DID=Device-ID|DEV=Device-name):CTAG::[IGMPVLAN=multi-vlan]
[,SHOWOPTION=ProgramUpportVlan PREVIEWPROFID PREJOIN HOSTIP PRIORITY BANDWIDTH GRADE
HOST PROGRAMUPPORT UNSOLICITED LOG];

Supporting Device
Device Type No. Device Type

34 MA5680T

2348 MA5683T

37 MA5662

44 MA5600V3

61 MA5626E

62 MA5620E

64 MA5651

65 MA5620G

66 MA5626G

70 MA5610

57 MA5606T

92 MA5652G
The MA5652G V800R307C00 and later
versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 876


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

94 MA5603U

95 MA5603T

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

249 MA5600T

253 UA5000(IPMB)

2321 MA5669

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2320 MA5612A

2331 MA5608T

2326 MA5623A V800R311C01 and later


versions

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 877


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

IGMPVLAN INTEGER 1-4095 Indicates the -


multicast
VLAN ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 878


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● ProgramUp (Optional) -


N STRING portVlan Specifies the
● PREVIEWP attributes
ROFID that can be
displayed in
● PREJOIN the returned
● HOSTIP result. If you
● PRIORITY set this
parameter,
● BANDWID the
TH corresponding
● GRADE attributes are
● HOST displayed. By
default, the
● PROGRAM
attributes are
UPPORT
not displayed.
● UNSOLICIT
ED
● LOG

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="NTV program attributes of the device "+device-name
name of attributes:ProgramIndex ProgramIP ProgramName ProgramSourceIP ProgramUpportVlan
PREVIEWPROFID PREJOIN HOSTIP PRIORITY BANDWIDTH GRADE HOST PROGRAMUPPORT UNSOLICITED
LOG

Output Parameter
Parameter Type Range Description

ProgramIndex INTEGER 1-255 Indicates the


index of the
program.

ProgramIP OCTET STRING SIZE (16) Indicates the IP


address of the
program.

ProgramName OCTET STRING SIZE (16) Indicates the


name of the
program.

ProgramSourceIP OCTET STRING SIZE (16) Indicates the


source IP address
of the program.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 879


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ProgramUpportVl INTEGER 1-4095 Indicates the


an multicast VLAN ID
bound to the
program
template.

PREVIEWPROFID OCTET STRING SIZE (32) Indicates the


preview template
name.

PREJOIN INTEGER 0-1 Specifies whether


to enable the
prejoin function.
The prejoin
function transmits
multicast service
streams to the
upstream port
before receiving
users' request to
join programs,
reducing the wait
time for users to
order programs.
The meanings of
the options are as
follows:
0: disabled
1: enabled

HOSTIP IPADDRESS - Indicates the host


IP address.

PRIORITY INTEGER 0-7 Indicates the


program priority.

BANDWIDTH INTEGER 0-65534 Indicates the


program
bandwidth.
Unit: kbit/s

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 880


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

GRADE INTEGER ● 0 Indicates the


● 1 program level by
definition.
● 2
The meanings of
● 255 the options are as
follows:
● 0: High-
definition TV
programs
● 1: Standard-
definition TV
programs
● 2: Streaming-
video programs
● 255: Programs
are not divided
into levels by
definition.

HOST INTEGER 1-2 Indicates the host


attribute. It is
used to enable or
disable the host
function of an NE.
Specifically, this
parameter
determines
whether the NE
sends IGMP
packets with the
IP address of a
certain program
to the multicast
router.
The meanings of
the options are as
follows:
● 1: enabled
● 2: disabled

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 881


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PROGRAMUPPOR OCTET STRING SIZE (32) Indicates the


T upstream port of
a multicast
program. This
parameter is
available when
the device
multicast mode is
not M-VLAN and
the upstream port
mode is program.
The format of this
parameter is
similar to 0/2/0,
indicating port 0
in slot 2 of
subrack 0.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 882


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

UNSOLICITED INTEGER 1-2 Specifies whether


the NE reports
packets in an
unsolicited
manner. Usually,
the NE reports
packets after the
upper layer device
queries data. If
this function is
enabled, however,
the NE reports
packets in an
unsolicited
manner. In
addition, the
delay in switching
channels is
decreased for
multicast users.
Options are as
follows:
● 1: The NE
reports packets
in an
unsolicited
manner.
● 2: The NE does
not report
packets in an
unsolicited
manner.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 883


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LOG INTEGER 1-2 Specifies whether


program logs are
recorded. The logs
of a program are
recorded only
after this function
is enabled. Users
who order this
program are
charged according
to the logs of this
program.
Options are as
follows:
● 1: Program
logs are
recorded.
● 2: Program
logs are not
recorded.

Error Code
ID Description Solution

2686058531 The device does not exist. Verify that the entered device
name is correct.

2686058552 The resource does not Verify that the entered device
exist. name is correct. If the device
name is correct, it indicates that
NTV programs do not exist on
the device.

Example
Example 1: To query the information about multicast programs on 10.78.217.111,
run the following command:
LST-NTVPROGRAM::DEV=10.78.217.111:1::SHOWOPTION=ProgramUpportVlan
PREVIEWPROFID PREJOIN;
The result is as follows:
7340034 2010-11-20 10:06:23
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=5

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 884


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktotal=5
NTV program attributes of the device 10.78.217.111
-----------------------------------------------------------------------------------------------------
ProgramIndex ProgramIP ProgramName ProgramSourceIP ProgramUpportVlan
PREVIEWPROFID PREJOIN
4 235.2.2.2 asdf 32.32.42.232 2 1 0
5 234.2.22.22 asdfasdf 22.12.21.1 1 1 0
2 224.2.2.2 qwe0 121.212.212.122 1 1 0
3 234.10.10.10 test -- 13 3 0
1 224.1.1.3 test2 10.1.1.2 13 1 1
-----------------------------------------------------------------------------------------------------
;

Example 2: To query the information about multicast programs on 10.144.195.87,


run the following command:

LST-NTVPROGRAM::DEV=10.144.195.87:1::SHOWOPTION=ProgramUpportVlan
PREVIEWPROFID PREJOIN PROGRAMUPPORT UNSOLICITED LOG;

The result is as follows:


7340032 2013-01-14 09:56:57
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=12
blktotal=12
NTV program attributes of the device 10.144.195.87
------------------------------------------------------------------------------------------------------------------------------
------------------
ProgramIndex ProgramIP ProgramName ProgramSourceIP ProgramUpportVlan
PREVIEWPROFID PREJOIN PROGRAMUPPORT UNSOLICITED LOG
4 239.2.2.94 1 -- 11 -- 0 0/2/0 2 1
3 224.1.1.1 <(()))_____ -- 11 -- 0 0/2/0 2 1
6 239.255.255.255 aaaaaaaaaaaaaaa2 -- 11 -- 0 0/2/0 2 1
5 224.3.3.3 aaaaaaaaaaaaaaa3 -- 11 -- 0 0/2/0 2 1
1 224.1.1.1 abc -- 123 -- 0 0/2/0 2 1
7 239.2.2.5 cafdsds -- 11 -- 0 0/2/0 2 1
8 239.2.2.3 dv -- 11 -- 0 0/2/0 2 1
9 224.2.2.56 test -- 11 -- 0 0/2/0 2 1
10 224.1.1.2 test11 -- 11 -- 0 0/2/0 2 1
11 224.1.1.3 test12 -- 11 -- 0 0/2/0 2 1
12 224.12.12.12 test_1 -- 11 -- 0 0/2/0 2 1
2 224.2.2.1 testforBT -- 1 -- 1 0/2/0 1 1
------------------------------------------------------------------------------------------------------------------------------
------------------
;

Related Command
None.

14.7.3 Querying the Detail Information of a Multicast User


(LST-NTVUSRDETAIL)

Usage Note
The multicast user to be queried must exist.

Command Format
LST-NTVUSRDETAIL::(DID=Device-ID|DEV=Device-name),(FN=frame-num,SN=slot-num,PN=port-
num[(,GEMPORTID=port-id)|(,ONTID=ont-id)|(,ONTID=ont-id,GEMPORTID=port-id)|(,VPI=vpi,VCI=vci)]

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 885


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

[,FLOWTYPE=flwtype,FLOWPARA=flowpara[,FLOWPARA2=flowpara2]])|(SPNAME=serviceport-name|
SPALIAS=serviceport-alias|SRVPORTID=serviceport-ID|ALIAS=igmpuser-alias|NAME=igmpuser-name):CTAG::;

Supporting Device
Device Type No. Device Type

94 MA5603U

249 MA5600T

95 MA5603T

37 MA5662

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2326 MA5623A V800R311C01 and later


versions

2331 MA5608T

34 MA5680T

2348 MA5683T

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 886


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack ID. It
is used for
location.

SN INTEGER 0-35 Indicates the -


slot ID. It is
used for
location.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 887


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PN INTEGER 0-63 Indicates the -


port ID. It is
used for
location.

GEMPORTID INTEGER 0-3999 Indicates the -


GEM port ID.
This
parameter is
set to locate
the port only
for the GPON
devices.
● Discrete
mode: In
the case of
the ONTID
and
GEMPORT
ID
parameters
, only one
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 128
to 3999.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 0 to
1023.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 888


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI This
port is of 10G
parameter is
GPON or 10G
EPON, the set to locate
value range is the ONT ID
0-255; if the only for the
UNI port is of GPON or
1G GPON or EPON devices.
1G EPON, the
value range is ● Discrete
0-127. mode: In
the case of
the ONTID
and
GEMPORT
ID
parameters
, only one
parameter
can be set.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 889


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

VPI OCTET ● 0-4095 Indicates the -


STRING ● auto virtual path
identifier. It is
used for
location.
Restriction:
The VPI and
VCI must be
set.
● If you set
only the
VPI and
VCI, a
single-
service
multicast
user is
located.
● If you do
not set the
VPI or VCI,
the system
considers
that there
is no VPI
or VCI by
default.
● If you set
the VPI
and VCI to
auto, an
auto-
sensing
multicast
user is
located.
● If you set
the VPI
and VCI to
the
numbers
that range
from 0 to
4095, the
system
considers
that the
VPI and
VCI exist.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 890


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

● In the case
of the
MA5603U,
this
parameter
ranges
from 0 to
255.

VCI OCTET ● 32-65535 Indicates the -


STRING ● auto virtual
channel
identifier. It is
used for
location.
● If you set
only the
VPI and
VCI, a
single-
service
multicast
user is
located.
● In the case
of the
MA5603U,
this
parameter
ranges
from 32 to
255.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 891


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWTYPE INTEGER 1-4 Indicates the -


type of the
multi-service
flow that is
bound to a
multicast
user. It is used
for location.
This
parameter is
mandatory if
the service
type of the
service virtual
port is multi-
service.
NOTE
For the
UA5000
(IPMB), only
the UA5000
V100R019C01
and later
versions
support this
parameter.
Options are
as follows:
● 1: user
VLAN
● 2:
encapsulati
on
● 3: user
VLAN
+ 802.1p
priority
● 4: user
VLAN +
encapsulati
on
Relationship
to other
parameters:
● When
FLOWTYP
E is set to
1 or 2,
FLOWPAR

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 892


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

A must be
set.
● When
FLOWTYP
E is set to
3 and the
user-side
VLAN ID is
not 0,
FLOWPAR
A and
FLOWPAR
A2
parameters
must be
set.
● When
FLOWTYP
E is set to
4,
FLOWPAR
A and
FLOWPAR
A2 must
be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 893


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWPARA INTEGER or ● When Indicates the -


OCTET FLOWTYP multi-service
STRING E is set to parameter. It
1, the is used for
values are location.
1-4095, NOTE
untagged, For the
or priority- UA5000
tagged. (IPMB), only
the UA5000
NOTE V100R019C01
For the and later
UA5000 versions
(IPMB), support this
the value parameter.
ranges
from 1 to ● When
4095. FLOWTYP
● When E is set to
FLOWTYP 1, this
E is set to parameter
2, the indicates
value user VLAN.
ranges ● When
from 1 to FLOWTYP
2, where 1 E is set to
indicates 2, this
IPoE and 2 parameter
indicates indicates
PPPoE. encapsulati
● When on type.
FLOWTYP ● When
E is set to FLOWTYP
3, the E is set to
value 3, this
ranges parameter
from 0 to indicates
7. 802.1p
● When priority.
FLOWTYP When
E is set to FLOWTYP
4, the E is set to
value 3 and the
ranges user-side
from 1 to VLAN ID is
2, where 1 not 0,
indicates FLOWPAR
IPoE and 2 A and
indicates FLOWPAR
PPPoE. A2
parameters

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 894


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

must be
set.
● When
FLOWTYP
E is set to
4, this
parameter
indicates
encapsulati
on type.
This
parameter
and
parameter
FLOWPAR
A2 must
be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 895


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWPARA2 INTEGER or ● When Indicates the -


OCTET FLOWTYP multi-service
STRING E is set to parameter 2.
3, the It is used for
value location.
ranges NOTE
from 0 to For the
4095. UA5000
(IPMB), only
● When the UA5000
FLOWTYP V100R019C01
E is set to and later
4, the versions
values are support this
parameter.
1-4095,
untagged, ● When the
or priority- FLOWTYP
tagged. E is set to
NOTE 3, this
For the parameter
UA5000 indicates
(IPMB), user VLAN.
the value
ranges – When
from 1 to FLOWT
4095. YPE is
set to 3
and the
user-
side
VLAN
ID is not
0,
FLOWP
ARA
and
FLOWP
ARA2
paramet
ers
must be
set.
– When
the
user-
side
VLAN
ID is 0,
the
FLOWP
ARA2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 896


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

paramet
er is
optional
and can
be set
to 0.
● When
FLOWTYP
E is set to
4, this
parameter
indicates
user VLAN.
This
parameter
and
parameter
FLOWPAR
A must be
set.

SPNAME OCTET SIZE (253) Indicates the -


STRING service port
name.

SPALIAS OCTET SIZE (64) Indicates the -


STRING service port
alias.

SRVPORTID INTEGER 1-999999 Indicates the -


NOTE service port
The ID.
parameter
value is larger
than that
displayed on
the CLI by 1.

NAME OCTET SIZE (96) Indicates the -


STRING multicast
username.

ALIAS OCTET SIZE (64) Indicates the -


STRING multicast user
alias.

Response Format
It complies with the format of the query command provided in 9.3 Response
Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 897


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title = "NTV User Detail Information of the device "+device-name


name of attributes: DID IGMPPACKETPOLICY QCKLEV

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

IGMPPACKETPOLI OCTET STRING ● discard Indicates the


CY ● transparent mode of
processing the
● normal multicast packets.
The meanings of
the options are as
follows:
● discard:
Indicates that
the multicast
packets are
discarded.
● transparent:
Indicates that
the multicast
packets are
transmitted
transparently.
● normal:
Indicates that
the multicast
packets are not
processed.

QCKLEV OCTET STRING ● IMMEDIATE Specifies whether


● MAC-BASED to enable the fast
leave function.
● OFF
The MA5600
V800R005 and
later versions
support this
parameter.
The value MAC-
BASED is
applicable to the
MA5600
V800R005C01 and
later versions.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 898


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1613103239 The user does not exist. This multicast user to be


queried does not exist.
Ensure that the entered
information for locating
the multicast user is
correct.

Example
To query the detail information of the multicast user of port 0/5/21 on the device
named 10.71.56.158, run the following command:

LST-
NTVUSRDETAIL::DEV=10.71.56.158,FN=0,SN=5,PN=21,VPI=0,VCI=200,FLOWTYP
E=1,FLOWPARA=1:57265020::;

The result is as follows:


7340033 2009-07-25 15:00:58
M 57265020 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
NTV User Detail Information of the device 10.71.56.158
----------------------------------
DID IGMPPACKETPOLICY QCKLEV
7340033 normal MAC-BASED
----------------------------------

Related Command
LST-NTVPORTBASIC

14.7.4 Querying the List of Multicast Users (LST-


NTVPORTBASIC)

Usage Note
There is no usage note.

Command Format
LST-NTVPORTBASIC::(DID=Device-ID|DEV=Device-name)[,FN=frame-num[,SN=slot-num[,PN=port-
num[,GEMPORTID=port-id|ONTID=ont-id|(ONTID=ont-id,GEMPORTID=port-id)]]]]|[SPNAME=serviceport-
name|SPALIAS=serviceport-alias|SRVPORTID=serviceport-ID|ALIAS=igmpuser-alias|NAME=igmpuser-name]
[,DBQRYFLAG=db-query-flag]:CTAG::[SHOWOPTION=SRVPORTID IGMPVLAN VPI VCI UV UE UP RCVGLBLV
MAXBANDWIDTH VIDEOVPI VIDEOVCI VIDEOUV VIDEOUE VIDEOUP ENABLELOG GEMPORTID];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 899


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

253 UA5000 (IPMB)

249 MA5600T

34 MA5680T

2348 MA5683T

62 MA5620E

65 MA5620G

61 MA5626E

66 MA5626G

64 MA5651

70 MA5610

92 MA5652G

94 MA5603U

95 MA5603T

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2321 MA5669

2320 MA5612A

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2312 MA5628

2326 MA5623A V800R311C01 and later


versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 900


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2331 MA5608T

2319 MA5621

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 901


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

PN INTEGER 0-63 (Optional) -


Indicates the
port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 902


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

GEMPORTID INTEGER 0-3999 (Optional) -


Indicates the
GEM port ID.
This
parameter is
set only for
the GPON
devices.
● Discrete
mode: For
the ONTID
and
GEMPORT
ID
parameters
, only one
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 128
to 3999.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 0 to
1023.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 903


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 This -


NOTE parameter is
If the UNI set to locate
port is of 10G the ONT ID
GPON or 10G only for the
EPON, the
GPON or
value range is
0-255; if the EPON devices.
UNI port is of ● Discrete
1G GPON or mode: For
1G EPON, the
the ONTID
value range is
0-127. and
GEMPORT
ID
parameters
, only one
parameter
can be set.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.

SPNAME OCTET SIZE (253) Indicates the -


STRING service port
name.

SPALIAS OCTET SIZE (64) Indicates the -


STRING service port
alias.

SRVPORTID INTEGER 1-999999 Indicates the -


NOTE service port
The ID.
parameter
value is larger
than that
displayed on
the CLI by 1.

NAME OCTET SIZE (96) Indicates the -


STRING multicast
username.

ALIAS OCTET SIZE (64) Indicates the -


STRING multicast user
alias.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 904


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DBQRYFLAG OCTET ● Enable (Optional) Disable


STRING ● Disable Specifies
whether the
status of the
multicast user
is obtained by
querying the
database.
The meanings
of the options
are as follows:
● Enable:
Query the
database.
● Disable:
Obtain
data from
the device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 905


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SRVPORTI (Optional) -


N STRING D Specifies the
● IGMPVLAN attributes
that can be
● VPI displayed. If
● VCI you set this
● UV parameter,
the
● UE corresponding
● UP attributes are
● RCVGLBLV displayed. By
default, the
● MAXBAND
attributes are
WIDTH
not displayed.
● VIDEOVPI
Only the
● VIDEOVCI MA5600
● VIDEOUV series and the
UA5000
● VIDEOUE
(IPMB)
● VIDEOUP support this
● ENABLELO parameter.
G The MA5600
● GEMPORTI V800R005
D begins to
support the
RCVGLBLV
and
MAXBANDWI
DTH
attributes.
The MA5600
V300R003C05
support the
RCVGLBLV
and
MAXBANDWI
DTH
attributes in
the mvlan
multicast
VLAN mode.

You can enter the query criteria, such as the device ID, device name, subrack ID, slot ID, and
port ID, to query the corresponding information. The device ID or the device name must be
set. Other parameters are optional. If you do not set any of the parameters, the list of all
the users is displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 906


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="NTV port attributes of the device "+device-name
name of attributes:DID FN SN PN PSTAT ALIAS AUTH MAXGRP QCKLEV QCKLEVTM SRVPORTID
IGMPVLAN VPI VCI UV UE UP RCVGLBLV MAXBANDWIDTH VIDEOVPI VIDEOVCI VIDEOUV VIDEOUE
VIDEOUP ENABLELOG GEMPORTID

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

PSTAT OCTET STRING ● ONLINE Indicates the


● OFFLINE status of the
multicast user.
● BLOCK

ALIAS OCTET STRING SIZE (64) Indicates the alias


of the multicast
user.

AUTH OCTET STRING ● ON Specifies whether


● OFF to enable the
authentication.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 907


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAXGRP INTEGER 0-255 Indicates the


maximum
number of
multicast
programs that are
available for a
port at the same
time.
● For the
MA5600
V800R005C22B
000, MA5600
V800R005C03B
000, and
MA5600
V800R005C33B
000, this
parameter
ranges from 1
to 16.
● For the
MA5600
V300R003C05
in the mvlan
multicast VLAN
mode, this
parameter
ranges from 1
to 16.
● For the
MA5600
V800R005C03B
080 and later
versions, this
parameter
ranges from 1
to 32.
● For the
MA5300, this
parameter
ranges from 0
to 255.
● For the
MA5800, this
parameter
ranges from 1
to 64.
● For other
devices, this

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 908


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

parameter
ranges from 1
to 8.

QCKLEV OCTET STRING ● Immediate Specifies whether


● Mac-based to enable the fast
leave function.
● OFF
This parameter is
applicable to the
following devices:
● The MA5600
V003R003 and
later versions
in the mvlan
multicast VLAN
mode
● MA5600
V800R005 and
later versions
● UA5000IPMBV
100R015 and
later versions
The value Mac-
based is
applicable to the
following devices:
● MA5600
V300R003C05
and later
versions
● MA5600
V800R005C01
and later
versions
● UA5000IPMBV
100R015C02
and later
versions

QCKLEVTM INTEGER 0-2000 Indicates the fast


leave time. For
the MA5600
V800R005 and
later versions, this
parameter is
deleted and "--" is
displayed.

SRVPORTID INTEGER 1-999999 Service Port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 909


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IGMPVLAN OCTET STRING 1-4095 Indicates the


multicast VLAN
ID.
If you add
multiple VLANs
for a user, enter
this parameter in
the format of
IGMPVLAN1#IGM
PVLAN2#IGMPVL
AN3...#IGMPVLAN
n, for example,
20#21#22.

VPI OCTET STRING ● 0-4095 This parameter is


● auto displayed when
the device is the
MA5600T,
MA5603T,
MA5606T,
MA5680T, or
UA5000 (IPMB).
For the MA5603U,
this parameter
ranges from 0 to
255.

VCI OCTET STRING ● 32-65535 This parameter is


● auto displayed when
the device is the
MA5600T,
MA5603T,
MA5606T,
MA5680T, or
UA5000 (IPMB).
For the MA5603U,
this parameter
ranges from 32 to
255.

UV OCTET STRING ● 0-4095 Indicates the user-


● untagged side VLAN ID.
● priority-tagged The MA5605,
MA5100V2, and
MA5300V1 do not
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 910


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

UE OCTET STRING ● IPv4oE Indicates the user-


● IPoE side encapsulation
type. The
● PPPoE meanings of the
● IPv6oE options are as
follows:
● IPv4oE:
Indicates that
IPv4 packets
are
encapsulated
directly on the
Ethernet.
● IPoE: Indicates
the Internet
Protocol over
Ethernet (IPoE)
encapsulation
type.
● PPPoE:
Indicates the
Point-to-Point
Protocol over
Ethernet
(PPPoE)
encapsulation
type.
● IPv6oE:
Indicates that
IPv6 packets
are
encapsulated
directly on the
Ethernet.
The MA5605,
MA5100V2, and
MA5300V1 do not
support this
parameter.

UP OCTET STRING SIZE (32) Indicates the


802.1p priority
list.
The MA5605,
MA5100V2, and
MA5300V1 do not
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 911


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RCVGLBLV OCTET STRING ● ON (New) Specifies


● OFF whether to enable
the function of
receiving the
global leave
message from the
user.
The MA5600
V800R005 and
later versions
support this
parameter.
The MA5600
V300R003C05 in
the mvlan
multicast VLAN
mode also
supports this
parameter.

MAXBANDWIDTH INTEGER -1 to (New) Indicates


+4294967294 the maximum
multicast
bandwidth for the
user.
Unit: kbit/s.
Range:
0-4294967294.
The number -1
indicates that the
bandwidth is not
restricted.
The MA5600
V800R005 and
later versions
support this
parameter.
The MA5600
V300R003C05 in
the mvlan
multicast VLAN
mode also
supports this
parameter.
When the value is
-1, means the
max bandwith is
unrestricted.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 912


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VIDEOVPI OCTET STRING ● 0-4095 Indicates the VPI


● auto of the video
service.
NOTE
The UA5000
(IPMB) does not
support this
parameter.

VIDEOVCI OCTET STRING ● 32-65535 Indicates the VCI


● auto of the video
service.
NOTE
The UA5000
(IPMB) does not
support this
parameter.

VIDEOUV OCTET STRING ● 0-4095 Indicates the user-


● untagged side VLAN ID of
the video service.
● priority-tagged
NOTE
The UA5000
(IPMB) does not
support this
parameter.

VIDEOUE OCTET STRING ● IPv4oE Indicates the user-


● IPoE side encapsulation
type of the video
● PPPoE service.
● IPv6oE The meanings of
the options are as
follows:
● IPoE: Indicates
the IPoE
encapsulation
type.
● PPPoE:
Indicates the
PPPoE
encapsulation
type.
NOTE
The UA5000
(IPMB) does not
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 913


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VIDEOUP OCTET STRING SIZE (32) Indicates the


multi-service
802.1p priority of
the video service.
NOTE
The UA5000
(IPMB) does not
support this
parameter.

ENABLELOG OCTET STRING ● ON Specifies whether


● OFF to enable the
function of
reporting
multicast user
logs.
After ENABLELOG
is enabled, user
logs can be
recorded and will
be reported to the
multicast server.

GEMPORTID INTEGER 0-3999 Indicates the GEM


port ID.
● Discrete mode:
The value of
the
GEMPORTID
parameter
ranges from
128 to 3999.
● Profile mode:
The value of
the
GEMPORTID
parameter
ranges from 0
to 1023.

Error Code
ID Description Solution

2686058552 The resource does not exist. The required multicast user
does not exist. Ensure that
the entered information for
querying the multicast user is
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 914


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
● Discrete mode:
To query the list of all the users of the device named MA5300_10.71.60.39,
run the following command:
LST-NTVPORTBASIC::DEV=MA5300_10.71.60.39:4::;
The result is as follows:
7352322 2005-06-09 11:12:25
M 4 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
NTV port attributes of the device MA5300_10.71.60.39
----------------------------------------------------------------------------------------------------------------
DID FN SN PN PSTAT ALIAS AUTH MAXGRP QCKLEV
7352322 0 4 12 2 test_user_0-4-12 ON 2 OFF
----------------------------------------------------------------------------------------------------------------
;

● Profile mode:
To query the list of the users (ONTID: 3; GEMPORTID: 1) of port 0/2/0 on the
device named 10.71.211.98, run the following command:
LST-
NTVPORTBASIC::DEV=10.71.211.98,FN=0,SN=2,PN=0,ONTID=3,GEMPORTI
D=1:CTAG::;
The result is as follows:
7340033 2009-01-05 12:05:37
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
NTV port attributes of the device 10.71.211.98
--------------------------------------------------------------------------------
DID FN SN PN PSTAT ALIAS AUTH MAXGRP QCKLEV QCKLEVTM
7340033 0 2 0 OFFLINE IGMPUser_0_2_0_3_1/single OFF 8 MAC-BASED --
--------------------------------------------------------------------------------
;

Related Command
There is no related command.

14.7.5 Querying the Rights Profile of a Multicast User (LST-


NTVPORTRP)
Usage Note
None.

Command Format
LST-NTVPORTRP::(DID=Device-ID|DEV=Device-name),(FN=frame-num,SN=slot-num,PN=port-
num[(,GEMPORTID=port-id)|(,ONTID=ont-id)|(,ONTID=ont-id,GEMPORTID=port-id)|(,VPI=vpi,VCI=vci)]

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 915


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

[,FLOWTYPE=flwtype,FLOWPARA=flowpara[,FLOWPARA2=flowpara2]])|(SPNAME=serviceport-name|
SPALIAS=serviceport-alias|SRVPORTID=serviceport-ID|ALIAS=igmpuser-alias|NAME=igmpuser-name):CTAG::
[SHOWOPTION=STARTTIME ENDTIME];

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

253 UA5000(IPMB)

249 MA5600T

95 MA5603T

34 MA5680T

2348 MA5683T

62 MA5620E

65 MA5620G

61 MA5626E

66 MA5626G

64 MA5651

70 MA5610

92 MA5652G

100 MA5616

94 MA5603U

96 MA5620

97 MA5626

103 MA5635

104 MA5612

2321 MA5669

2320 MA5612A

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2312 MA5628

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 916


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2326 MA5623A V800R311C01 and later


versions

2331 MA5608T

2319 MA5621

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 917


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack ID. It
is used for
location.

SN INTEGER 0-35 Indicates the -


slot ID. It is
used for
location.

PN INTEGER 0-63 Indicates the -


port ID. It is
used for
location.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 918


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

GEMPORTID INTEGER 0-3999 Indicates the -


GEM port ID.
This
parameter is
set to locate
the port only
for the GPON
devices.
● Discrete
mode: In
the case of
the ONTID
and
GEMPORT
ID
parameters
, only one
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 128
to 3999.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 0 to
1023.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 919


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI ● Discrete
port is of 10G
mode: In
GPON or 10G
EPON, the the case of
value range is the ONTID
0-255; if the and
UNI port is of GEMPORT
1G GPON or ID
1G EPON, the
parameters
value range is
0-127. , only one
parameter
can be set.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 920


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

VPI OCTET ● 0-4095 Indicates the -


STRING ● auto virtual path
identifier. It is
used for
location.
Restriction:
The VPI and
VCI must be
set.
● If you set
only the
VPI and
VCI, a
single-
service
multicast
user is
located.
● If you do
not set the
VPI or VCI,
the system
considers
that there
is no VPI
or VCI by
default.
● If you set
the VPI
and VCI to
auto, an
auto-
sensing
multicast
user is
located.
● If you set
the VPI
and VCI to
the
numbers
that range
from 0 to
4095, the
system
considers
that the
VPI and
VCI exist.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 921


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

● In the case
of the
MA5603U,
this
parameter
ranges
from 0 to
255.

VCI OCTET ● 32-65535 Indicates the -


STRING ● auto virtual
channel
identifier. It is
used for
location.
If you set only
the VPI and
VCI, a single-
service
multicast user
is located.
In the case of
the
MA5603U,
this
parameter
ranges from
32 to 255.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 922


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWTYPE INTEGER 1-4 Indicates the -


type of the
multi-service
flow that is
bound to a
multicast
user. It is used
for location.
This
parameter is
mandatory if
the service
type of the
service virtual
port is multi-
service.
NOTE
For the
UA5000
(IPMB), only
the UA5000
V100R019C01
and later
versions
support this
parameter.
Options are
as follows:
● 1: user
VLAN
● 2:
encapsulati
on
● 3: user
VLAN
+ 802.1p
priority
● 4: user
VLAN +
encapsulati
on
Relationship
to other
parameters:
● When
FLOWTYP
E is set to
1 or 2,
FLOWPAR

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 923


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

A must be
set.
● When
FLOWTYP
E is set to
3 and the
user-side
VLAN ID is
not 0,
FLOWPAR
A and
FLOWPAR
A2
parameters
must be
set.
● When
FLOWTYP
E is set to
4,
FLOWPAR
A and
FLOWPAR
A2 must
be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 924


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWPARA INTEGER or ● When Indicates the -


OCTET FLOWTYP multi-service
STRING E is set to parameter. It
1, the is used for
values are location.
1-4095, NOTE
untagged, For the
or priority- UA5000
tagged. (IPMB), only
the UA5000
NOTE V100R019C01
For the and later
UA5000 versions
(IPMB), support this
the value parameter.
ranges
from 1 to ● When
4095. FLOWTYP
● When E is set to
FLOWTYP 1, this
E is set to parameter
2, the indicates
value user VLAN.
ranges ● When
from 1 to FLOWTYP
2, where 1 E is set to
indicates 2, this
IPoE and 2 parameter
indicates indicates
PPPoE. encapsulati
● When on type.
FLOWTYP ● When
E is set to FLOWTYP
3, the E is set to
value 3, this
ranges parameter
from 0 to indicates
7. 802.1p
● When priority.
FLOWTYP When
E is set to FLOWTYP
4, the E is set to
value 3 and the
ranges user-side
from 1 to VLAN ID is
2, where 1 not 0,
indicates FLOWPAR
IPoE and 2 A and
indicates FLOWPAR
PPPoE. A2
parameters

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 925


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

must be
set.
● When
FLOWTYP
E is set to
4, this
parameter
indicates
encapsulati
on type.
This
parameter
and
parameter
FLOWPAR
A2 must
be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 926


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWPARA2 INTEGER or ● When Indicates the -


OCTET FLOWTYP multi-service
STRING E is set to parameter 2.
3, the It is used for
value location.
ranges NOTE
from 0 to For the
4095. UA5000
(IPMB), only
● When the UA5000
FLOWTYP V100R019C01
E is set to and later
4, the versions
values are support this
parameter.
1-4095,
untagged, ● When the
or priority- FLOWTYP
tagged. E is set to
NOTE 3, this
For the parameter
UA5000 indicates
(IPMB), user VLAN.
the value
ranges – When
from 1 to FLOWT
4095. YPE is
set to 3
and the
user-
side
VLAN
ID is not
0,
FLOWP
ARA
and
FLOWP
ARA2
paramet
ers
must be
set.
– When
the
user-
side
VLAN
ID is 0,
the
FLOWP
ARA2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 927


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

paramet
er is
optional
and can
be set
to 0.
● When
FLOWTYP
E is set to
4, this
parameter
indicates
user VLAN.
This
parameter
and
parameter
FLOWPAR
A must be
set.

SPNAME OCTET SIZE (253) Indicates the -


STRING service port
name.

SPALIAS OCTET SIZE (64) Indicates the -


STRING service port
alias.

SRVPORTID INTEGER 1-999999 Indicates the -


NOTE service port
The ID.
parameter
value is larger
than that
displayed on
the CLI by 1.

NAME OCTET SIZE (96) Indicates the -


STRING multicast
username.

ALIAS OCTET SIZE (64) Indicates the -


STRING multicast user
alias.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 928


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● STARTTIME Specifies -


N STRING ● ENDTIME whether the
column of a
selected
attribute is
displayed in
the returned
results. The
returned
results display
the attribute
column for a
selected
attribute but
do not display
the attribute
column by
default. This
parameter is
optional.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= "NTV port attributes of the device"+ device-name +" frame number: "+ frame-number + " slot ID: " +
slot-number + "port ID:" + port-number
name of attributes: RPNAME

Output Parameter
Parameter Type Range Description

RPNAME OCTET STRING SIZE (32) Indicates the


name of the
rights profile of
the NTV user.

STARTTIME OCTET STRING SIZE (32) Indicates the start


time for an
ordered program.
NOTE
This parameter is
supported by the
MA5600T,
MA5603T,
MA5680T, and
MA5608T.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 929


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ENDTIME OCTET STRING SIZE (32) Indicates the end


time of an
ordered program.
NOTE
This parameter is
supported by the
MA5600T,
MA5603T,
MA5680T, and
MA5608T.

Error Code
ID Description Solution

2686058 The device does not exist. Verify that the entered device
531 name is correct.

2686058 Invalid parameter or value of Verify that the command is


498 parameter is wrong. correct according to the
following requirements:
● The parameter values do not
exceed the ranges of the
parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

2686058 The resource does not exist. The profile to be queried does
552 not exist.

Example
● Discrete mode:
To query the rights profiles of the multicast user (DEV: MA5600_10.71.60.39;
FN: 0; SN: 4; PN: 12; VPI: 0; VCI: 36; FLOWTYPE: 1; FLOWPARA: 128), run the
following command:
LST-
NTVPORTRP::DEV=MA5600_10.71.60.39,FN=0,SN=4,PN=12,VPI=0,VCI=36,FL
OWTYPE=1,FLOWPARA=128:5::;

If the specified multicast user does not exist, the profile of this user cannot be
displayed.
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 930


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7352322 2005-06-09 11:30:14


M 5 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=3
blktotal=3
NTV port attributes of the device MA5300_10.71.60.39 Frame number:0 slot ID:4 port ID:12
-----------
RPNAME
cctv3
cctv4
cctv5
-----------
;

● Profile mode:
To query the rights profiles of the multicast user (DEV: 10.71.211.98; FN: 0;
SN: 2; PN: 0; ONTID: 3; GEMPORTID: 1), run the following command:
LST-
NTVPORTRP::DEV=10.71.211.98,FN=0,SN=2,PN=0,ONTID=3,GEMPORTID=1:
5::;
The result is as follows:
7340033 2009-01-05 14:32:11
M 5 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
NTV port attributes of the device 10.71.211.98 Frame number:0 slot ID:2 port ID:0 ONTID:3
GemPortIndex:1
-----------
RPNAME
test
-----------
;

Related Command
LST-NTVRP

14.7.6 Querying Rights Profiles (LST-NTVRP)

Usage Note
None.

Command Format
LST-NTVRP::(DID=Device-ID|DEV=Device-name):CTAG::;

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 931


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

94 MA5603U

95 MA5603T

253 UA5000(IPMB)

249 MA5600T

34 MA5680T

2348 MA5683T

100 MA5616

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

2331 MA5608T

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

2350 MA5811S

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 932


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= "NTV right profiles of the device"+ device-name
name of attributes: RPNAME

Output Parameter
Parameter Type Range Description

RPNAME OCTET STRING SIZE (32) Indicates the


name of the
rights profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 933


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058 The device does not exist. Verify that the entered device
531 name is correct.

Example
To query the rights profiles of MA5300_10.71.60.39, run the following command:

LST-NTVRP::DEV=MA5300_10.71.60.39:5::;

The result is as follows:


7352322 2005-06-09 11:30:14
M 5 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=3
blktotal=3
NTV right profiles of the device MA5300_10.71.60.39
-----------
RPNAME
cctv3
cctv4
cctv5
-----------
;

Related Command
LST-NTVPORTRP

14.7.7 Querying the Programs Specified in a Rights Profile


(LST-RPPROGRAM)

Usage Note
None.

Command Format
LST-RPPROGRAM::(DT=device-type):CTAG::RPNAME=Right-profile-name[,SCOPEPROFID=Scope-Profile-
Name][,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 934


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

92 MA5652G

94 MA5603U

95 MA5603T

253 UA5000(IPMB)

249 MA5600T

2331 MA5608T

100 MA5616

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

34 MA5680T

2348 MA5683T

2326 MA5623A V800R311C01 and later


versions

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 935


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

RPNAME OCTET SIZE (32) Indicates the -


STRING name of the
rights profile.

DT INTEGER See Indicates the -


Supporting device type.
Device.
NOTE
To view the
MDU type
that supports
decoupling,
see the value
of the typeid
parameter in
the oss\server
\nemgr
\nemgr_acces
s\dcp\pnp
\product
\device type
\device
type.xml file.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 936


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title= "NTV right profiles detail"
name of attributes: RPNAME ProgramIndex ProgramIP ProgramName ProgramSourceIP SCOPEPROFID

Output Parameter
Parameter Type Range Description

RPNAME OCTET STRING SIZE (32) Indicates the


name of the
rights profile.

ProgramIndex INTEGER 1-255 Indicates the


index of the
program.

ProgramIP OCTET STRING SIZE (16) Indicates the IP


address of the
program.

ProgramName OCTET STRING SIZE (16) Indicates the


name of the
program.

ProgramSourceIP OCTET STRING SIZE (16) Indicates the


source IP address
of the program.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 937


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

2686058 Invalid parameter or value of Verify that the command is


498 parameter is wrong. correct according to the
following requirements: The
● parameter values do not
exceed the ranges of the
parameters specified by the
command. The
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

1026294 The profile does not exist. Verify that the entered name of
27 the rights profile is correct.

2686058 The resource does not exist. Verify that the entered name of
552 the rights profile is correct.

Example
To query the programs specified in the rights profile profile1 on the MA5600T, run
the following command:
LST-RPPROGRAM::DT=249:5::RPNAME=profile1;
The result is as follows:
0 2010-11-20 10:16:59
M 5 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=3
blktotal=3
NTV right profiles detail
------------------------------------------------------------------
RPNAME ProgramIndex ProgramIP ProgramName ProgramSourceIP
profile1 0 224.0.1.33 ntv31 10.70.41.218
profile1 1 224.0.1.64 ntv62 10.70.41.218
profile1 2 224.0.1.95 ntv93 10.70.41.218
------------------------------------------------------------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 938


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None.

14.7.8 Querying the Multicast VLAN Information of a Device


(RTRV-IGMPVLAN)
Usage Note
This command is available only when the multicast mode of a device is MVLAN
mode.

Command Format
RTRV-IGMPVLAN::(DID=Device-ID|DEV=Device-name):CTAG::[IGMPVLAN=igmp-vlan-id];

Supporting Device
Device Type No. Device Type

34 MA5680T

2348 MA5683T

37 MA5662

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 939


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

IGMPVLAN INTEGER 1-4095 Indicates the -


For the range multicast
of this VLAN ID.
parameter in
the case of
different
devices, see B.
10
Parameters
Related To
the Range of
VLAN IDs for
Different
Devices.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 940


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title= "Multicast Vlan Information of the device" + device-name


DID IGMPVLAN

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

IGMPVLAN INTEGER 1-4095 Indicates the


For the range of IGMP VLAN ID.
this parameter in
the case of
different devices,
see B.10
Parameters
Related To the
Range of VLAN
IDs for Different
Devices.

Error Code
ID Description Solution

1613103236 The Multicast VLAN does Verify that the entered


not exist IGMP VLAN ID is correct.

2686058531 The device does not exist Verify that the entered
device name or device ID
is correct.

Example
To query the multicast VLAN information of the device named 10.71.211.105, run
the following command:
RTRV-IGMPVLAN::DEV=10.71.211.105:-1481744349::;
The result is as follows:
7340032 2009-07-03 10:46:38
M -1481744349 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2
Multicast Vlan Information of the device 10.71.211.105
------------------
DIDIGMPVLAN
73400321
734003220
------------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 941


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
RTRV-IGMPVLANDETAIL

14.7.9 Querying the Multicast VLAN of a Multicast User (LST-


NTVUSRIGMPVLAN)

Usage Note
None.

Command Format
LST-NTVUSRIGMPVLAN::(DID=Device-ID|DEV=Device-name),(FN=frame-num,SN=slot-num,PN=port-
num[(,GEMPORTID=port-id)|(,ONTID=ont-id)|(,ONTID=ont-id,GEMPORTID=port-id)|(,VPI=vpi,VCI=vci)]
[,FLOWTYPE=flwtype,FLOWPARA=flowpara[,FLOWPARA2=flowpara2]])|(SPNAME=serviceport-name|
SRVPORTID=serviceport-ID):CTAG::;

Supporting Device
Device Type No. Device Type

37 MA5662

44 MA5600V3

57 MA5606T

249 MA5600T

95 MA5603T

34 MA5680T

2348 MA5683T

62 MA5620E

65 MA5620G

61 MA5626E

66 MA5626G

64 MA5651

70 MA5610

92 MA5652G

100 MA5616

94 MA5603U

96 MA5620

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 942


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

97 MA5626

103 MA5635

104 MA5612

2321 MA5669

2320 MA5612A

2313 MA5652

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2312 MA5628

2326 MA5623A V800R311C01 and later


versions

2319 MA5621

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2331 MA5608T

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

2343 MA5694S

2350 MA5811S

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 943


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the device name -


STRING 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 A.8 How to
Locate a Device
According to the IP
Address.

FN INTEGER 0-255 Indicates the subrack ID. It -


is used for location.

SN INTEGER 0-35 Indicates the slot ID. It is -


used for location.

PN INTEGER 0-63 Indicates the port ID. It is -


used for location.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 944


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

GEMPORTI INTEGER 0-3999 Indicates the GEM port ID. -


D This parameter is set to
locate the port only for
the GPON devices.
● Discrete mode: In the
case of the ONTID and
GEMPORTID
parameters, only one
parameter can be set.
The value of the
GEMPORTID
parameter ranges from
128 to 3999.
● Profile mode: Both the
ONTID parameter and
the GEMPORTID
parameter can be set.
The value of the
GEMPORTID
parameter ranges from
0 to 1023.

ONTID INTEGER 0-255 Indicates the ONT ID. -


NOTE This parameter is set to
If the UNI locate the ONT ID only
port is of 10G
for the GPON or EPON
GPON or 10G
EPON, the devices.
value range is ● Discrete mode: In the
0-255; if the case of the ONTID and
UNI port is of
GEMPORTID
1G GPON or
1G EPON, the parameters, only one
value range is parameter can be set.
0-127. ● Profile mode: Both the
ONTID parameter and
the GEMPORTID
parameter can be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 945


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

VPI OCTET ● 0-4095 Indicates the virtual path -


STRING ● auto identifier. It is used for
location.
Restriction: The VPI and
VCI must be set.
● If you do not set the
VPI or VCI, the system
considers that there is
no VPI or VCI by
default.
● If you set the VPI and
VCI to auto, an auto-
sensing multicast user
is located.
● If you set the VPI and
VCI to the numbers
that range from 0 to
4095, the system
considers that the VPI
and VCI exist.
If you set only the VPI and
VCI, a single-service
multicast user is located.

VCI OCTET ● 32-65535 Indicates the virtual -


STRING ● auto channel identifier. It is
used for location.
If you set only the VPI and
VCI, a single-service
multicast user is located.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 946


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWTYPE INTEGER 1-4 Indicates the type of the -


multi-service flow that is
bound to a multicast user.
It is used for location. This
parameter is mandatory if
the service type of the
service virtual port is
multi-service.
NOTE
For the UA5000 (IPMB),
only the UA5000
V100R019C01 and later
versions support this
parameter.
Options are as follows:
● 1: user VLAN
● 2: encapsulation
● 3: user VLAN + 802.1p
priority
● 4: user VLAN +
encapsulation
Relationship to other
parameters:
● When FLOWTYPE is
set to 1 or 2,
FLOWPARA must be
set.
● When FLOWTYPE is
set to 3 and the user-
side VLAN ID is not 0,
FLOWPARA and
FLOWPARA2
parameters must be
set.
● When FLOWTYPE is
set to 4, FLOWPARA
and FLOWPARA2 must
be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 947


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWPAR INTEGER ● When Indicates the multi-service -


A or OCTET FLOWTYP parameter. It is used for
STRING E is set to location.
1, the NOTE
values are For the UA5000 (IPMB),
1-4095, only the UA5000
untagged, V100R019C01 and later
versions support this
or priority-
parameter.
tagged.
● When FLOWTYPE is
NOTE
For the set to 1, this parameter
UA5000 indicates user VLAN.
(IPMB), ● When FLOWTYPE is
the value
ranges
set to 2, this parameter
from 1 to indicates encapsulation
4095. type.
● When ● When FLOWTYPE is
FLOWTYP set to 3, this parameter
E is set to indicates 802.1p
2, the priority. When
value FLOWTYPE is set to 3
ranges and the user-side VLAN
from 1 to ID is not 0, FLOWPARA
2, where 1 and FLOWPARA2
indicates parameters must be
IPoE and 2 set.
indicates ● When FLOWTYPE is
PPPoE. set to 4, this parameter
● When indicates encapsulation
FLOWTYP type. This parameter
E is set to and parameter
3, the FLOWPARA2 must be
value set.
ranges
from 0 to
7.
● When
FLOWTYP
E is set to
4, the
value
ranges
from 1 to
2, where 1
indicates
IPoE and 2
indicates
PPPoE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 948


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FLOWPAR INTEGER ● When Indicates the multi-service -


A2 or OCTET FLOWTYP parameter 2. It is used for
STRING E is set to location.
3, the NOTE
value For the UA5000 (IPMB),
ranges only the UA5000
from 0 to V100R019C01 and later
versions support this
4095.
parameter.
● When
● When the FLOWTYPE
FLOWTYP
is set to 3, this
E is set to
parameter indicates
4, the
user VLAN.
values are
1-4095, – When FLOWTYPE is
untagged, set to 3 and the
or priority- user-side VLAN ID is
tagged. not 0, FLOWPARA
and FLOWPARA2
NOTE
For the parameters must be
UA5000 set.
(IPMB), – When the user-side
the value
ranges
VLAN ID is 0, the
from 1 to FLOWPARA2
4095. parameter is
optional and can be
set to 0.
● When FLOWTYPE is
set to 4, this parameter
indicates user VLAN.
This parameter and
parameter FLOWPARA
must be set.

SPNAME OCTET SIZE (253) Indicates the service port -


STRING name.

SRVPORTI INTEGER 1-999999 Indicates the service port -


D NOTE ID.
The
parameter
value is
larger than
that
displayed on
the CLI by 1.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 949


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title= "NTV User attributes of the device"+ device-name +" frame number: "+ frame-number + " slot ID: " +
slot-number + "port ID:" + port-number
name of attributes: IGMPVLAN

Output Parameter
Parameter Type Range Description

IGMPVLAN INTEGER 1-4095 Indicates the


multicast VLAN of
the NTV user.

Error Code
ID Description Solution

2686058531 The device does not Verify that the entered device name
exist. is correct.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory parameter requirements:
is blank, or the ● The parameter values do not
parameter value is exceed the ranges of the
wrong. parameters specified by the
command.
● The entered parameter names are
correct.
● The parameters are entered in
the correct order.

2686058552 The resource does not Verify that the queried multicast
exist. VLAN exists.

Example
To query the multicast VLANs of the multicast user of port 0/1/5 on the device
named 10.78.217.55, run the following command:
LST-
NTVUSRIGMPVLAN::DEV=10.78.217.55,FN=0,SN=1,PN=5,FLOWTYPE=1,FLOWPA
RA=887:CTAG::;
The result is as follows:
7340127 2010-12-25 15:35:26
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4
NTV User attributes of the device 10.78.217.55 Frame number:0 slot ID:1 port ID:5
-------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 950


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

IGMPVLAN
4000
878
883
896
-------------
;

Related Command
None.

14.7.10 Querying the Details of a Multicast VLAN (RTRV-


IGMPVLANDETAIL)
Usage Note
This command is available only when the multicast mode of a device is MVLAN
mode.

Command Format
RTRV-IGMPVLANDETAIL::(DID=Device-ID|DEV=Device-name):CTAG::IGMPVLAN=igmp-vlan-id;

Supporting Device
Device Type No. Device Type

34 MA5680T

2348 MA5683T

37 MA5662

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2313 MA5652
NOTE
The MA5652 V800R309C00 and later
versions support this command.

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 951


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

IGMPVLAN INTEGER 1-4095 Indicates the -


For the range multicast
of this VLAN ID.
parameter in
the case of
different
devices, see B.
10
Parameters
Related To
the Range of
VLAN IDs for
Different
Devices.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 952


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title= "The Details of a Multicast Vlan of the device"+device-name


DID IGMPVLAN ALIAS MODE VERSION ENABLELOG UPLINKFN UPLINKSN UPLINKPN REPORTPROXY
LEAVEPROXY REPORTINTERVAL PRI SENDGLBLV MATCHMODE SGROUPIP EGROUPIP

Output Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

IGMPVLAN INTEGER 1-4095 Indicates the -


multicast
VLAN ID.

ALIAS OCTET SIZE (32) Indicates the -


STRING alias of the
multicast
VLAN.

MODE OCTET ● PROXY Indicates the -


STRING ● SNOOPIN IGMP mode.
G
● OFF

VERSION OCTET ● V2 Indicates the -


STRING ● V3 IGMP version.

ENABLELOG OCTET ● ON Specifies -


STRING ● OFF whether to
enable
multicast log
recording.

UPLINKFN INTEGER 0-255 Indicates the -


subrack ID of
the default
upstream
port. This
upstream port
is the default
port in the
multicast
VLAN through
which
multicast
packets are
transmitted
and received.
The subrack
ID, slot ID,
and port ID
must all be
set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 953


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

UPLINKSN INTEGER 0-35 Indicates the -


slot ID of the
default
upstream
port.
The subrack
ID, slot ID,
and port ID
must all be
set.

UPLINKPN INTEGER 0-63 Indicates the -


port ID of the
default
upstream
port.
The subrack
ID, slot ID,
and port ID
must all be
set.

REPORTPROX OCTET ● ON Specifies -


Y STRING ● OFF whether to
enable the
Report packet
proxy.

LEAVEPROXY OCTET ● ON Specifies -


STRING ● OFF whether to
enable the
Leave packet
proxy.

REPORTINTER INTEGER 10-5000 Indicates the -


VAL interval of
unsolicited
reporting.
Unit: s.

PRI INTEGER 0-7 Indicates the -


priority of the
IGMP packet.

SENDGLBLV OCTET ● ON Specifies -


STRING ● OFF whether to
send the
global leave
packet.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 954


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

MATCHMODE OCTET ● ON Indicates the -


STRING ● OFF program
match mode.

SGROUPIP OCTET SIZE (32) Indicates the -


STRING start IP
address of the
dynamic
program
generation
group.
The start IP
address and
the end IP
address must
be set.

EGROUPIP OCTET SIZE (32) Indicates the -


STRING end IP
address of the
dynamic
program
generation
group.
The start IP
address and
the end IP
address must
be set.

Error Code
ID Description Solution

1613103236 The Multicast VLAN does Verify that the entered


not exist IGMP VLAN ID is correct.

2686058531 The device does not exist Verify that the entered
device name or device ID
is correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 955


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the entered


parameter or mandatory command is correct
parameter is blank, or according to the
the parameter value is following requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The parameter names
are correct.
● The parameters are
entered in the correct
order.

Example
To query the details of the IGMP VLAN on the device named 10.71.211.105, run
the following command:

RTRV-IGMPVLANDETAIL::DEV=10.71.211.105:1579528954::IGMPVLAN=1;

The result is as follows:


7340032 2009-07-03 10:46:39
M 1579528954 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
The Details of a Multicast Vlan of the device 10.71.211.105
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------
DID IGMPVLAN ALIAS MODE VERSION ENABLELOG UPLINKFN UPLINKSN UPLINKPN
REPORTPROXY LEAVEPROXY REPORTINTERVAL PRI SENDGLBLV MATCHMODE SGROUPIP
EGROUPIP
7340032 1 For_TEST_CH SNOOPING V3 ON 0 10 0 ON ON 10 0 ON ON
224.1.1.1 224.254.254.254
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------
;

Related Command
RTRV-IGMPVLAN

14.7.11 Querying the Details of a Multicast VLAN (LST-


IGMPVLANDETAIL)
Usage Note
There is no usage note.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 956


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-IGMPVLANDETAIL::(DID=Device-ID|DEV=Device-name),VLANID=vlan-id:CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

34 MA5680T

2348 MA5683T

2331 MA5608T

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2335 MA5694

2333 MA5698

2340 MA5611S

37 MA5662

2343 MA5694S

62 MA5620E

65 MA5620G

61 MA5626E

66 MA5626G

64 MA5651

70 MA5610

92 MA5652G

100 MA5616

96 MA5620

97 MA5626

103 MA5635

104 MA5612

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 957


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2321 MA5669

2320 MA5612A

2313 MA5652

2323 MA5622A

2324 MA5623

2312 MA5628

2326 MA5623A

2319 MA5621

2322 MA5621A

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

2350 MA5811S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 958


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

VLANID INTEGER 1-4095 Indicates the N/A


multicast
VLAN ID.

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.
title= "The Details of a Multicast Vlan of the device"+ device-name
DID VLANID NAME ALIAS MODE VERSION ENABLELOG UPLINKFN UPLINKSN
UPLINKPN REPORTPROXY LEAVEPROXY REPORTINTERVAL PRI SENDGLBLV MATCHMODE
SGROUPIP EGROUPIP INNERVLANID VIDEOMODE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

VLANID INTEGER 1-4095 Indicates the


multicast VLAN
ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 959


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NAME OCTET STRING SIZE (32) Indicates the


name for the
multicast VLAN.

ALIAS OCTET STRING SIZE (32) Indicates the alias


of the multicast
VLAN.

MODE OCTET STRING ● PROXY Indicates the


● SNOOPING IGMP mode.
● OFF

VERSION OCTET STRING ● V2 Indicates the


● V3 IGMP version.

ENABLELOG OCTET STRING ● ON Specifies whether


● OFF to enable
multicast log
recording.

UPLINKFN INTEGER 0-255 Indicates the


subrack ID of
upstream port.
This upstream
port is the default
port in the
multicast VLAN
through which
multicast packets
are transmitted
and received.

UPLINKSN INTEGER 0-35 Indicates the slot


ID of upstream
port.

UPLINKPN INTEGER 0-63 Indicates the port


ID of upstream
port.

REPORTPROXY OCTET STRING ● ON Specifies whether


● OFF to enable the
report packet
proxy.

LEAVEPROXY OCTET STRING ● ON Specifies whether


● OFF to enable the
leave packet
proxy.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 960


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

REPORTINTERVAL INTEGER 10-5000 Indicates the


interval of
unsolicited
reporting.
Unit: s.

PRI INTEGER 0-7 Indicates the


priority of the
IGMP packet.

SENDGLBLV OCTET STRING ● ON Specifies whether


● OFF to send global
leave packet.

MATCHMODE OCTET STRING ● ON Indicates the


● OFF program match
mode.

SGROUPIP OCTET STRING SIZE (32) Indicates the start


IP address of the
dynamic program
generation group.

EGROUPIP OCTET STRING SIZE (32) Indicates the end


IP address of the
dynamic program
generation group.

INNERVLANID INTEGER 1-4095 Indicates the ID of


NOTE the inner VLAN in
Ranges of this the upstream
parameter vary direction. This
with devices. For parameter is
details, see the
returned only for
appendix B.10
Parameters stacking VLAN or
Related To the QinQ VLAN.
Range of VLAN MA5600
IDs for Different
V800R007C01 and
Devices.
later versions of
the MA5680T,
MA5600T, and
MA5603T support
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 961


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VIDEOMODE OCTET STRING ● MULTICAST Indicates the


● UNICAST video mode.
Options are as
follows:
● MULTICAST:
multicast
mode, a point-
to-multipoint
communication
mode
● UNICAST:
unicast mode,
a point-to-
point
communication
mode.
MA5600
V800R007C01 and
later versions of
the MA5680T,
MA5600T, and
MA5603T support
this parameter.

Error Code
ID Description Solution

2686058531 The device does not exist. ● Ensure that the device is
successfully added to the NCE.
● By default, the device is located
according to 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 A.8 How to Locate a
Device According to the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 962


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or mandatory according to the following
parameter is blank, or requirements:
the parameter value is ● The parameter values do not
wrong. exceed the parameter ranges
specified by the command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

1613103236 The multicast VLAN does Ensure that the entered VLAN ID
not exist. is correct.

1612645130 The resource does not Ensure that the entered VLAN ID
exist. is correct.

Example
To query details of the multicast VLAN 100 on the device named 10.144.79.212,
run the following command:
LST-IGMPVLANDETAIL::DEV=10.144.79.212,VLANID=100:CTAG::;
The result is as follows:
7340041 2011-02-21 20:15:45
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
The Details of a Multicast Vlan of the device 10.144.79.212
------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------
DID VLANID NAME ALIAS MODE VERSION ENABLELOG UPLINKFN UPLINKSN
UPLINKPN REPORTPROXY LEAVEPROXY REPORTINTERVAL PRI SENDGLBLV MATCHMODE
SGROUPIP EGROUPIP INNERVLANID VIDEOMODE
7340041 100 IGMPVlan_100 igmpvlan-alias OFF V3 ON -- -- -- ON ON 10 6
ON ON -- -- 100 MULTICAST
------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------
;

Related Command
There is no related command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 963


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.7.12 Querying the Multicast Subtend Port (LST-


NTVCASCADE)

Usage Note
There is no usage note.

Command Format
LST-NTVCASCADE::(DID=Device-ID|DEV=Device-name)[,FN=frame-num][,SN=slot-num][,PN=port-num]
[,ONTID=ont-id][,GEMPORTID=port-id]:CTAG::;

Supporting Device
Device Type No. Device Type

57 MA5606T

37 MA5662

34 MA5680T

2348 MA5683T

249 MA5600T

95 MA5603T

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2313 MA5652 V800R309C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

2331 MA5608T

2343 MA5694S

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 964


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

PN INTEGER 0-63 (Optional) -


Indicates the
port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 965


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 This -


NOTE parameter is
If the UNI set to locate
port is of 10G the ONT ID
GPON or 10G only for the
EPON, the
GPON or
value range is
0-255; if the EPON devices.
UNI port is of ● Discrete
1G GPON or mode: For
1G EPON, the
the ONTID
value range is
0-127. and
GEMPORT
ID
parameters
, only one
parameter
can be set.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 966


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

GEMPORTID INTEGER 0-3999 (Optional) -


Indicates the
GEM port ID.
This
parameter is
set only for
the GPON
devices.
● Discrete
mode: For
the ONTID
and
GEMPORT
ID
parameters
, only one
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 128
to 3999.
● Profile
mode:
Both the
ONTID
parameter
and the
GEMPORT
ID
parameter
can be set.
The value
of the
GEMPORT
ID
parameter
ranges
from 0 to
1023.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 967


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="The NTV Cascade Port Attributes List of the device "+device-name


name of attributes: DID FN SN PN ONTID GEMPORTID ALIAS MISMATCH QCKLEV STATIC
CONCERNMVLAN

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

GEMPORTID INTEGER 0-3999 Indicates the GEM


port ID.

ALIAS OCTET STRING SIZE (64) Indicates the alias


of the multicast
subtend port.

MISMATCH OCTET STRING ● TRANSPARENT Indicates the


● DISCARD packet processing
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 968


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

QCKLEV OCTET STRING ● ON Specifies whether


● OFF to enable the fast
leave function of
the multicast
subtend port.
If this function is
enabled, when
the subtend port
receives a Leave
packet, the
program
corresponding to
this packet
becomes
unavailable
immediately.

STATIC OCTET STRING ● ON Specifies whether


● OFF to enable the
static addition
function of the
multicast subtend
port.
If this function is
enabled,
programs can be
added statically
on this multicast
subtend port.

CONCERNMVLAN OCTET STRING ● ON Specifies whether


● OFF to pay attention
to the multicast
VLAN in the
multicast packet.

Error Code
ID Description Solution

2686058552 The resource does not exist. The required multicast ports
do not exist. Ensure that the
entered information for
querying the multicast user is
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 969


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
On port 0/6/0 of the device named MA5600T_10.78.217.216, run the following
command to query the cascading port information of a multicast user whose ONT
ID is 3 and GEM port ID is 2:

LST-
NTVCASCADE::DEV=MA5600T_10.78.217.216,FN=0,SN=6,PN=0,ONTID=3,GEMP
ORTID=2:15::;

The result is as follows:


7340061 2012-08-13 22:05:02
M 15 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

The NTV Cascade Port Attributes List of the device MA5600T_10.78.217.216


-------------------------------------------------------------------------------------
DID FN SN PN ONTID GEMPORTID ALIAS MISMATCH QCKLEV STATIC
CONCERNMVLAN
7340061 0 6 0 3 2 tester TRANSPARENT OFF OFF --
-------------------------------------------------------------------------------------

Related Command
There is no related command.

14.8 Querying GPON Resources


This command is used to query GPON resources, including the GPON ports, ONTs,
and GEM ports.

14.8.1 Querying the List of GPON Ports (LST-GPONPORT)

Usage Note
None

Command Format
LST-GPONPORT::(DID=Device-ID|DEV=Device-name)[,FN=Frame-id[,SN=Slot-id[,PN=Port-id]]]:CTAG::
[SHOWOPTION=PORTMODE PONSTAT];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 970


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 971


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

PN INTEGER 0-63 (Optional) -


Indicates the
port ID.

SHOWOPTIO OCTET PORTMODE Specifies the -


N STRING PONSTAT attributes
that can be
displayed in
the returned
result. If you
set this
parameter,
the
corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 972


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● Enter either the device ID or the device name.


● Enter the subrack ID, slot ID, and port ID in order. For example, you can enter the slot ID
only after you enter the subrack ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gponport information of the device "+device-name
name of attributes:DID FN SN PN NAME ALIAS NEAREST FARTHEST DNFEC
AUTOFINDONT PORTMODE PONSTAT

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

NAME OCTET STRING SIZE (32) Indicates the


name of the port.

ALIAS OCTET STRING SIZE (80) Indicates the alias


NOTE of the port.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
MxU is 64 digit.
● For
V800R018C10
and later
version the
maximum
length of this
parameter of
OLT is 80 digit.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 973


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NEAREST INTEGER 0-40 Indicates the


NOTE minimum
For 10G GPON distance.
ports, the value of
this parameter
ranges from 0 to
60.

FARTHEST INTEGER 0-60 Indicates the


NOTE maximum
For 10G GPON distance.
ports, the value of
this parameter
ranges from 0 to
100.

DNFEC OCTET STRING ● ENABLE Specifies whether


● DISABLE to enable the
downstream FEC
function.

AUTOFINDONT OCTET STRING ● ENABLE Specifies whether


● DISABLE to enable the
function of
automatically
discovering the
ONU.

PORTMODE OCTET STRING ● UNUSABLE GPON Port Mode.


● GPON
● XGPON
● XGSPON
● XGCOMBOAUT
O
● XGCOMBOWD
M
● XGSCOMBOAU
TO
● XGSCOMBOW
DM

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 974


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PONSTAT OCTET STRING ● Active_Online GPON Port Status


● Activated_Offli
ne_with_ONU
● Deactivate
● Energy_Laser_S
witch_On
● Energy_Laser_S
witch_Off
● Activated_Offli
ne_without_O
NU
● Unknown

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the list of GPON ports connected to port 0/5/1 on the device named
10.78.217.111, run the following command:
LST-GPONPORT::DEV=10.78.217.111,FN=0,SN=5,PN=1:6::;
The result is as follows:
7340034 2010-11-20 12:35:13
M 6 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gponport information of the device 10.78.217.111


------------------------------------------------------------------------
DID FN SN PN NAME ALIAS NEAREST FARTHEST DNFEC AUTOFINDONT
7340034 0 5 1 Frame0/Slot5/Port1 -- 0 20 DISABLE DISABLE
------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 975


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
● LST-ONT
● LST-GPONPORTDETAIL

14.8.2 Querying the Details of a GPON Port (LST-


GPONPORTDETAIL)

Usage Note

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

Command Format
LST-GPONPORTDETAIL::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num:CTAG::[SHOWOPTION=OPTMODSTATUS LSTUPTIME LSTDOWNTIME LSTDOWNCAUSE
SIGNALDETECT];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T V800R010C00 and later


versions

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 976


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 977


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● OPTMODS (Optional) -


N STRING TATUS Specifies the
● LSTUPTIM attributes
E that can be
displayed in
● LSTDOWN the returned
TIME result. If you
● LSTDOWN set this
CAUSE parameter,
● SIGNALDE the
TECT corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

● Enter either the device ID or the device name.


● Enter the subrack ID, slot ID, and port ID in order. For example, you can enter the slot ID
only after you enter the subrack ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon port detail information of the device "+device-name
name of attributes: DID FN SN PN PSTAT NAME ALIAS NEAREST FARTHEST DNFEC
AUTOFINDONT ONTPWDRENEW ONTPWDRENEWINTER IGMPALLOCBW MINBW LEFTBW
USABLEBW IGMPUSEDBW LOOPBACK ILLEGALONT OPTMODSTATUS LSTUPTIME
LSTDOWNTIME LSTDOWNCAUSE SIGNALDETECT

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 978


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PSTAT OCTET STRING ● Active Indicates the


● Activating current port
status.
● Deactive

NAME OCTET STRING SIZE (255) Indicates the port


name.

ALIAS OCTET STRING SIZE (80) Indicates the port


NOTE alias.
For V800R018C10
and later version
the maximum
length of this
parameter of OLT
is 80 digit.

NEAREST INTEGER 0-40 Indicates the


NOTE minimum
For 10G GPON distance.
ports, the value of
Unit: km.
this parameter
ranges from 0 to
60.

FARTHEST INTEGER 0-60 Indicates the


NOTE maximum
For 10G GPON distance.
ports, the value of
Unit: km.
this parameter
ranges from 0 to
100.

DNFEC OCTET STRING ● OPEN Specifies whether


● CLOSE to enable the
downstream FEC
function.

AUTOFINDONT OCTET STRING ● OPEN Specifies whether


● CLOSE to enable the
function of
automatically
discovering the
ONU.

ONTPWDRENEW OCTET STRING ● OPEN Specifies whether


● CLOSE to update the key
of the ONU.

ONTPWDRENEWI INTEGER 5-1440 Indicates the


NTER update period of
the key of the
ONU.
Unit: minutes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 979


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IGMPALLOCBW INTEGER 512-2608857 Indicates the


bandwidth that is
allocated for the
multicast service.
If the bandwidth
unlimited, the
value is "--".
Unit: kbit/s.

MINBW INTEGER 384-1024 Indicates the


minimum
bandwidth of the
T-CONT.
Unit: kbit/s.

LEFTBW INTEGER 0-2608857 Indicates the


remaining
bandwidth of the
port.
Unit: kbit/s.

USABLEBW INTEGER 0-2608857 Indicates the


available
remaining
bandwidth of the
port.
Unit: kbit/s.

IGMPUSEDBW INTEGER 0-2608857 Indicates the


bandwidth that is
used by the
multicast service.
Unit: kbit/s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 980


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LOOPBACK OCTET STRING ● NOLOOP Specifies the


● 128-3999 loopback for the
GEM port of the
PON port. If this
parameter is set
to a value that
ranges from 128
to 3999, it
indicates that the
loopback is set for
the GEM port
whose ID is the
same as the
preset value. Only
one loopback can
be set for each
PON port.

ILLEGALONT OCTET STRING ● EXISTENT Specifies whether


● INEXISTENT a malicious ONT
exists. The
malicious ONT
does not transmit
optical signals
according to the
allocated
timestamp.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 981


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTMODSTATUS OCTET STRING ● ONLINE Indicates the


● OFFLINE GPON port optical
module status.
Options are as
follows:
● ONLINE
● OFFLINE
The following
versions of NEs in
profile mode
support this
parameter:
● MA5680T,
MA5603T, and
MA5600T
V800R008C00
and later
versions
● MA5603U
V800R010C00
and later
versions
● MA5608T
V800R012C00
and later
versions
● MA5800-X17
and MA5800-
X7
● MA5800-X15
and MA5800-
X2
● EA5800-X17
and EA5800-X7
● EA5800-X15
and EA5800-X2
● MA5801

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 982


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LSTUPTIME OCTET STRING Format: YYYY- Indicates the last


MM-DD hh:mm:ss up time of the
port. This time is
a UTC time.
The following
versions of NEs in
profile mode
support this
parameter:
● MA5680T,
MA5603T, and
MA5600T
V800R008C00
and later
versions
● MA5603U
V800R010C00
and later
versions
● MA5608T
V800R012C00
and later
versions
● MA5800-X17
and MA5800-
X7
● MA5800-X15
and MA5800-
X2
● EA5800-X17
and EA5800-X7
● EA5800-X15
and EA5800-X2
● MA5801

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 983


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LSTDOWNTIME OCTET STRING Format: YYYY- Indicates the last


MM-DD hh:mm:ss down time of the
port. This time is
a UTC time.
The following
versions of NEs in
profile mode
support this
parameter:
● MA5680T,
MA5603T, and
MA5600T
V800R008C00
and later
versions
● MA5603U
V800R010C00
and later
versions
● MA5608T
V800R012C00
and later
versions
● MA5800-X17
and MA5800-
X7
● MA5800-X15
and MA5800-
X2
● EA5800-X17
and EA5800-X7
● EA5800-X15
and EA5800-X2
● MA5801

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 984


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LSTDOWNCAUSE OCTET STRING ● LOS Indicates the last


● OpticModuleA down cause of the
bsence port.
● OpticModuleFa Options are as
ult follows:
● OpticPortClose ● LOS: Signal
d loss occurs.
● OpticModuleA
bsence: The
optical module
is not installed.
● OpticModuleFa
ult: The optical
module is
faulty.
● OpticPortClose
d: The port is
disabled.
The following
versions of NEs in
profile mode
support this
parameter:
● MA5680T,
MA5603T, and
MA5600T
V800R008C00
and later
versions
● MA5603U
V800R010C00
and later
versions
● MA5608T
V800R012C00
and later
versions
● MA5800-X17
and MA5800-
X7
● MA5800-X15
and MA5800-
X2
● EA5800-X17
and EA5800-X7
● EA5800-X15
and EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 985


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● MA5801

SIGNALDETECT OCTET STRING ● Normal Indicates the


● Failed signal detect info
of the port.
● No Support
Options are as
follows:
● Normal: Signal
detect is
normal.
● Failed: Failed in
signal
detecting.
● No Support:
Does not
support signal
detect.
The following
versions of NEs in
profile mode
support this
parameter:
● MA5680T,
MA5603T, and
MA5600T
V800R008C01
and later
versions
● MA5603U
V800R010C00
and later
versions
● MA5608T
V800R012C00
and later
versions
● MA5800-X17
and MA5800-
X7
● MA5800-X15
and MA5800-
X2
● EA5800-X17
and EA5800-X7
● EA5800-X15
and EA5800-X2
● MA5801

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 986


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
Example 1: To query the details of port 0/5/1 on the device named 10.78.217.111,
run the following command:
LST-GPONPORTDETAIL::DEV=10.78.217.111,FN=0,SN=5,PN=1:6::;
The result is as follows:
7340032 2010-11-20 12:55:10
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gpon port detail information of the device 10.78.217.111


------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------
DID FN SN PN PSTAT NAME ALIAS NEAREST FARTHEST DNFEC AUTOFINDONT
ONTPWDRENEW ONTPWDRENEWINTER IGMPALLOCBW MINBW LEFTBW USABLEBW
IGMPUSEDBW LOOPBACK ILLEGALONT
7340034 0 5 1 Activating Frame0/Slot5/Port1 -- 0 20 CLOSE CLOSE CLOSE --
716800 -- 1238784 -- 0 -- --
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------

Example 2: To query the details of port 0/2/1 on the device named 10.144.79.105,
run the following command:
LST-
GPONPORTDETAIL::DEV=10.144.79.105,FN=0,SN=2,PN=1:CTAG::SHOWOPTION
=OPTMODSTATUS LSTUPTIME LSTDOWNTIME LSTDOWNCAUSE;
The result is as follows:
7340037 2014-01-17 14:44:13
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gpon port detail information of the device 10.144.79.105


------------------------------------------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 987


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

--------------------------------------------------------
DID FN SN PN PSTAT NAME ALIAS NEAREST FARTHEST DNFEC AUTOFINDONT
ONTPWDRENEW ONTPWDRENEWINTER IGMPALLOCBW MINBW LEFTBW USABLEBW
IGMPUSEDBW LOOPBACK ILLEGALONT OPTMODSTATUS LSTUPTIME LSTDOWNTIME
LSTDOWNCAUSE
7340037 0 2 1 Active Frame:0/Slot:2/Port:1 -- 0 20 CLOSE OPEN CLOSE --
716800 -- 1207296 1232918 0 -- INEXISTENT ONLINE 2014-01-13 15:31:52 2014-01-13
15:30:26 LOS
------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------

Related Command
LST-GPONPORT

14.8.3 Querying the Information About an Upstream GPON


Port (LST-GPONNNIPORT)

Usage Note
None.

Command Format
LST-GPONNNIPORT::(DID=Device-ID|DEV=Device-name):CTAG::[SHOWOPTION=PSTAT];

Supporting Device
Device Type No. Device Type

37 MA5662

57 MA5606T

65 MA5620G

66 MA5626G

70 MA5610

100 MA5616

96 MA5620

92 MA5652G

97 MA5626

103 MA5635

104 MA5612

2312 MA5628

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 988


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2317 MA5631
NOTE
The MA5631 V800R308C02 and later
versions support this command.

2319 MA5621

2321 MA5669

2320 MA5612A

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2318 MA5632
NOTE
The MA5632 V800R310 and later versions
support this command.

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2343 MA5694S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 989


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

SHOWOPTIO OCTET PSTAT Specifies the N/A


N STRING optional
attributes
that can be
displayed.
● If you do
not set this
parameter,
the
optional
attributes
are not
displayed.
● If you set
this
parameter,
the
optional
attributes
are
displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 990


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Enter either the device ID or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon NNI information of the device "+device-name name of attributes: DID FN SN PN PSTAT

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

PSTAT OCTET STRING ● NORMAL Indicates the port


● FAULT status.
● UNKNOWN

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
the parameter value is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● The parameters are
entered in the correct
order.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 991


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the information about the upstream port on the device named
10.71.227.24, run the following command:

LST-GPONNNIPORT::DEV=10.71.227.24:1::;

The result is as follows:


7340069 2010-11-20 13:24:36 M 1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
Gpon NNI information of the device 10.71.227.24 -------------------- DID FN SN PN 7340069 0 0
1 -------------------- ;

Related Command
None

14.8.4 Querying the List of ONUs (LST-ONT)

Usage Note

If the SHOWOPTION parameter contains the following options LSTUPTIME,


LSTDOWNTIME, DEV, NEXTHOP, VAPROF, MACLEARN, DEVCURRENTTIME,
VASPROFILESET, and HARDWAREVERSION (issued to an NE for querying), a performance
issue may occur when you query the NE and the query may time out. If there are more
than 2000 ONUs connected to an NE, only information accurate to the port level or of a
single ONU can be queried.

Command Format
LST-ONT::[NAME=onu-name|ONTSN=ont-serianu|PWD=ont-password|LOID=loid][[,]((DID=Device-ID|
DEV=Device-name)[,FN=Frame-id[,SN=Slot-id[,PN=Port-id[,ONTID=ont-id]]]][,(ONTSN=ont-serianum)|
(RUNSTAT=run stat)])|(ONUDID=Mdu-Device-id|ONUDEV=Mdu-Device-name)]:CTAG::[RTNTYPE=return-
type][,SHOWOPTION=SERIALNUM PWD LOID CHECKCODE ALMPROF DEV VLAN PRI IP MASK GATE
ROUTEIP ROUTEMASK NEXTHOP SNMPPROF OPTALMPROF VAPROF MACLEARN SRVLEVELPROF
LSTUPTIME LSTDOWNTIME DEVCURRENTTIME VASPROFILESET OPERSTATE DEVNAME DEVIP
BINDWIDTHTYPE PSPROFILE ADDTIME ESN ONTMAC];

Supporting Device
Device Type No. Device Type

34 MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 992


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

NAME OCTET SIZE (255) Indicates the N/A


STRING ONU name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 993


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET ● When the SIZE (36) N/A


STRING configurati NOTE
on item ● For the
GPON_PW OLTs
D_FORMA earlier
T_IN_DB is than
set to 0, V800R011
the C00, the
maximum
following length of
characters password
are for ONTs
allowed: connected
English: 26 to the
case OLTs is 10
characters.
insensitive
letters ● To ensure
system
Digits: 0-9 security,
password
Special
must be
characters: complex
!@#$ enough.
%^&*()- Remember
and space to change
passwords
● When the regularly.
configurati
on item
GPON_PW
D_FORMA
T_IN_DB is
set to 1,
the
following
hexadecim
al
characters
are
allowed:
0-9, A-F,
and a-f
NOTE
For the OLTs
earlier than
V800R011C00,
the maximum
length of
password for
ONTs
connected to
the OLTs is 10
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 994


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LOID OCTET SIZE (24) Indicates the N/A


STRING logical
authenticatio
n code of the
ONT.

DID INTEGER - Indicates the N/A


OLT ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID of
the OLT.

SN INTEGER 0-35 Indicates the N/A


slot ID of the
OLT.

PN INTEGER 0-63 Indicates the N/A


port ID of the
OLT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 995


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI NOTE
port is of 10G For GPBD
GPON, the boards, the
value range is value ranges
0-255; if the from 0 to 127.
UNI port is of For GPBC
1G GPON, the boards, the
value range is value ranges
0-127. from 0 to 63.

ONTSN OCTET SIZE (16) Indicates the N/A


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXXX
X or 16-byte
character
string
XXXXXXXXXXX
XXXXX.

RUNSTAT OCTET UP Indicate the N/A


STRING DOWN running
information
about the
ONT.

ONUDID INTEGER - Indicates the N/A


MDU ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 996


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONUDEV OCTET SIZE (128) Indicates the N/A


STRING device name
of the MDU.
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 A.8
How to
Locate a
Device
According to
the IP
Address.

RTNTYPE INTEGER ● 0 Optional


● 1 parameter,
whether to
support fuzzy
name search.
(0 not
support;1
support)

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 997


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SERIALNU Specifies the N/A


N STRING M attributes
● PWD that can be
displayed in
● LOID the returned
● CHECKCO result. If you
DE enter
● ALMPROF SERIALNUM
or PWD, the
● DEV value of
● VLAN SERIALNUM
● PRI or PWD is
displayed in
● IP the returned
● MASK result.
● GATE NOTE
You cannot
● ROUTEIP enter NAME
● ROUTEMA as location
SK information
for the
● NEXTHOP LSTUPTIME,
LSTDOWNTI
● SNMPPRO
ME, and
F DEVCURRENT
● OPTALMPR TIME
OF parameters.

● VAPROF
● MACLEAR
N
● SRVLEVELP
ROF
● LSTUPTIM
E
● LSTDOWN
TIME
● DEVCURRE
NTTIME
● VASPROFIL
ESET
● HARDWAR
EVERSION
● OPERSTAT
E
● DEVNAM
● DEVIP
● BINDWIDT
HTYPE

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 998


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

● PSPROFILE
● ADDTIME
● ESN
● ONTMAC

● You can set one of the following items to locate an ONU:


● ONU name (NAME)
● Device ID or name of the OLT + (optional) subrack ID/slot ID/port ID or ONT ID
● Device ID or name of the MDU
● Enter the subrack ID, slot ID, port ID, and ONT ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Ont information of the device "+device-name
name of attributes: DID FN SN PN ONTID NAME ALIAS CAPABPROF VENDORID
EQUIPMENTID MAINSOFTVERSION AUTH AUTHTIMEOUT LINEPROF SRVPROF SERIALNUM
PWD LOID CHECKCODE ALMPROF DEV VLAN PRI IP MASK GATE ROUTEIP ROUTEMASK NEXTHOP
SNMPPROF OPTALMPROF VAPROF MACLEARN SRVLEVELPROF LSTUPTIME LSTDOWNTIME
DEVCURRENTTIME VASPROFILESET BINDWIDTHTYPE OPERSTATE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID of the
OLT.

FN INTEGER 0-255 Indicates the


subrack ID of the
OLT.

SN INTEGER 0-35 Indicates the slot


ID of the OLT.

PN INTEGER 0-63 Indicates the port


ID of the OLT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 999


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

NAME OCTET STRING SIZE (255) Indicates the


name of the ONU.

ALIAS OCTET STRING SIZE (128) Indicates the alias


NOTE of the ONU.
For the MA5600 NOTE
V800R005C03, The following
MA5600 characters are
V800R005C23, and supported:
MA5600
● English letters:
V800R005C33, the
A-Z and a-z.
alias consists of up
to 32 characters. ● Numbers: 0-9.
● Symbols: ( ) _ -
+ . / \ | and
space.

CAPABPROF OCTET STRING SIZE (64) Indicates the


name of the
capability set
profile.
The parameter is
available only
when the ONU is
in the discrete
mode.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONT


type.

MAINSOFTVERSI OCTET STRING SIZE (14) Indicates the


ON software version.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1000


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AUTH OCTET STRING ● SN Indicates the


● SN_PASSWOR authentication
D mode.
● ALWAYS_ON
● ONCE_ON
● LOID
● LOID_ONCEON
● LOID_CHECKC
ODE
● LOID_CHECKC
ODE_ONCEON

AUTHTIMEOUT INTEGER 1-168 Indicates the


Disable timeout period of
the
authentication.
This parameter is
valid only when
the AUTH
parameter is set
to ONCE_ON.
If you do not set
this parameter,
the value is
returned as
Disable in the
output
information.
Unit: h.

LINEPROF OCTET STRING SIZE (32) Indicates the


name of the line
profile.
The parameter is
available only
when the ONU is
in the profile
mode.

SRVPROF OCTET STRING SIZE (32) Indicates the


name of the
service profile.
The parameter is
available only
when the ONU is
in the profile
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1001


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number.
Format: 12-byte
character string
XXXXXXXXXXXX or
16-byte character
string
XXXXXXXXXXXXXX
XX. For details
about how to
modify the format
of the returned
SN, see A.13 How
to Modify the
Format of the
Returned SN.

LOID OCTET STRING SIZE (24) Indicates the


logical
authentication
code of the ONT.

CHECKCODE OCTET STRING SIZE (12) Indicates the


logical verification
code of the ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1002


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PWD OCTET STRING ● When the Indicates the


configuration password.
item
GPON_PWD_F
ORMAT_IN_D
B is set to 0,
the following
characters are
allowed:
English: 26
case insensitive
letters
Digits: 0-9
Special
characters: !@#
$%^&*()- and
space
● When the
configuration
item
GPON_PWD_F
ORMAT_IN_D
B is set to 1,
the following
hexadecimal
characters are
allowed:
0-9, A-F, and a-
f
NOTE
● For the OLTs
earlier than
V800R011C00,
the maximum
length of
password for
ONTs
connected to
the OLTs is 10
characters.
● To ensure
system security,
password must
be complex
enough.
Remember to
change
passwords
regularly.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1003


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALMPROF OCTET STRING SIZE (32) Indicates the


alarm profile
name.

DEV OCTET STRING SIZE (192) Indicates the


default OLT 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 A.8
How to Locate a
Device According
to the IP
Address.

VLAN INTEGER 1-4095 Indicates the


management
VLAN of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=V
LAN is entered,
this parameter is
displayed as --.

PRI INTEGER 0-7 Indicates the


priority of the
ONU. When the
location
information
contains NAME
and
SHOWOPTION=P
RI is entered, this
parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1004


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IP IPADDRESS N/A Indicates the IP


address of the
ONU. When the
location
information
contains NAME
and
SHOWOPTION=I
P is entered, this
parameter is
displayed as --.

MASK IPADDRESS N/A Indicates the IP


mask of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=
MASK is entered,
this parameter is
displayed as --.

GATE IPADDRESS N/A Indicates the


default gateway
of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=G
ATE is entered,
this parameter is
displayed as --.

ROUTEIP OCTET STRING SIZE (255) Indicates the


destination IP
address of the
ONU. When the
location
information
contains NAME
and
SHOWOPTION=R
OUTEIP is
entered, this
parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1005


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ROUTEMASK OCTET STRING SIZE (255) Indicates the


destination mask
of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=R
OUTEMASK is
entered, this
parameter is
displayed as --.

NEXTHOP OCTET STRING SIZE (255) Indicates the next


hop IP address of
the ONU. When
the location
information
contains NAME
and
SHOWOPTION=
NEXTHOP is
entered, this
parameter is
displayed as --.

SNMPPROF OCTET STRING SIZE (32) Indicates the


SNMP profile
name of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=S
NMPPROF is
entered, this
parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1006


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTALMPROF OCTET STRING SIZE (32) Indicates the ONU


optical power
alarm profile
bound to ONUs.
The ONU optical
power alarm
profile is used to
manage optical
module alarm
thresholds in a
centralized
manner.
When the location
information
contains NAME
and
SHOWOPTION=
OPTALMPROF is
entered, this
parameter is
displayed as --.

VAPROF OCTET STRING SIZE (32) Indicates the


name of a global
ONT VAS profile
or a general ONT
VAS profile. When
the location
information
contains NAME
and
SHOWOPTION=V
APROF is entered,
this parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1007


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MACLEARN OCTET STRING ● ENABLE Specifies whether


● DISABLE to enable the
MAC address
learning function
for ONUs. When
the location
information
contains NAME
and
SHOWOPTION=
MACLEARN is
entered, this
parameter is
displayed as --.
NOTE
Only the OLT
devices in discrete
mode support this
parameter.

SRVLEVELPROF OCTET STRING SIZE (32) Indicates the


name of a service
level profile.
When the location
information
contains NAME
and
SHOWOPTION=S
RVLEVELPROF is
entered, this
parameter is
displayed as --.
NOTE
MA5600
V800R008C05 and
later versions
(excluding
MA5600
V800R009) support
this parameter.

LSTUPTIME INTEGER Format: YYYY- Indicates the last


MM-DD time when the
HH:MM:SS ONT was online.
The time is in UTC
format.
NOTE
You cannot enter
NAME as location
information for
this parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1008


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LSTDOWNTIME INTEGER Format: YYYY- Indicates the last


MM-DD time when the
HH:MM:SS ONT was offline.
The time is in UTC
format.
NOTE
You cannot enter
NAME as location
information for
this parameter.

DEVCURRENTTIM INTEGER Format: YYYY- Indicates the


E MM-DD current device
HH:MM:SS time. The time is
in UTC format.
NOTE
You cannot enter
NAME as location
information for
this parameter.

VASPROFILESET OCTET STRING SIZE (32) Indicates the


profile set where
the general ONT
VAS profile
resides.

HARDWAREVERSI OCTET STRING SIZE (32) Indicates the ONU


ON hardware version.

OPERSTATE OCTET STRING ● ACTIVATE Indicates the


● DEACTIVATE operating status
of the ONU.
NOTE
You cannot enter
NAME as location
information for
this parameter.

DEVNAME OCTET STRING SIZE (32) This object


indicates the OLT
name.

DEVIP OCTET STRING SIZE (32) This object


indicates the OLT
IP address.

BINDWIDTHTYPE OCTET STRING ● 2.5G-1.25G Indicates the


● 10G-2.5G upstream and
downstream rate
● 10G-10G types of an ONT.
● AUTO Unit: bit/s

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1009


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PSPROFILE OCTET STRING SIZE (32) Indicates the


power shedding
profile name.
NOTE
MA5600
V800R011C00 and
later versions
support this
parameter.

ADDTIME OCTET STRING SIZE (32) Indicates the add


ONT time. The
time is Shaped
UTC display.

ESN OCTET STRING SIZE (32) This object


indicates the ONT
Equipment Sn.

ONTMAC OCTET STRING SIZE (32) This object


indicates the ONT
MAC address.

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

2689012370 The ONT is not online. Reissue the command


after the ONT goes
online.

Example
To query the list of ONTs on the device named 10.78.217.111, run the following
command:
LST-ONT::DEV=10.78.217.111:6::;
The returned result is as follows:
7340034 2010-11-20 13:55:45
M 6 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1010


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blkcount=2
blktotal=100

Ont information of the device 10.78.217.111


------------------------------------------------------------------------------------------------------------------------------
---------------
DID FN SN PN ONTID NAME ALIAS CAPABPROF VENDORID EQUIPMENTID
MAINSOFTVERSION AUTH AUTHTIMEOUT LINEPROF SRVPROF
7340034 0 16 1 113 10.78.217.111/Frame0/Slot16/Port1/OnuID113 -- -- -- -- -- SN
Disable HG863_Line_Profile_1 HG850a_srv
7340034 0 16 1 114 10.78.217.111/Frame0/Slot16/Port1/OnuID114 -- -- -- -- -- SN
Disable HG863_Line_Profile_1 HG850a_srv
------------------------------------------------------------------------------------------------------------------------------
---------------

Related Command
● LST-GEMPORT
● LST-ONTDETAIL

14.8.5 Querying the Details of an ONT (LST-ONTDETAIL)

Usage Note

NOTICE

Do not run this command to bulk query inventories of a large number of ONTs.
Otherwise, the query efficiency is low.

Command Format
LST-ONTDETAIL::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-id|
ONTSN=ont-SN)|,PWD=Password|,LOID=Loid|,NAME=ont-name,))|ALIAS=ont-alias:CTAG::
[SHOWOPTION=SRVLEVELPROF PSPROFILE DOWNBW UPCOSPOLICY DOWNCOSPOLICY ISOLATIONSTAT
ACTURALSERIALNUM MAC];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1011


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1012


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.
NOTE
In the case of
the GPBD
board, the
value ranges
from 0 to 127.
In the case of
the GPBC
board, the
value ranges
from 0 to 63.

ONTSN OCTET SIZE (16) Indicates the N/A


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXX
XX or 16-byte
character
string
XXXXXXXXXX
XXXXXX.
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1013


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET SIZE (36) Indicates the N/A


STRING NOTE ONT
● For the
password.
OLTs When
earlier locating an
than
ONT based
V800R011
C00, the on the
maximum DEV/DID and
length of PWD
password parameters,
for ONTs you do not
connected
need to enter
to the
OLTs is 10 the subrack
characters. ID, slot ID,
● To ensure
port ID, ONT
system SN, or ONT
security, ID.
password
The values of
must be
complex the PWD
enough. parameter
Remember may be
to change duplicate,
passwords which may
regularly.
affect current
services. You
can check
whether the
ONT
authenticatio
n password is
duplicate by
setting the
configuration
item
xPON_CHECK
_PASSWORD_
REPEAT_SWI
TCH. For
details about
the meaning
and setting
method of
the
configuration
item, see
Table 8-1.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1014


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default


NOTE
In the
command
format, the
PWD in front
of the CTAG
indicates the
location
information
(current ONT
password)
and the PWD
following the
CTAG
indicates the
ONT
password
after
modification.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONT.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING NOTE alias. It is
In the case of used to locate
the MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1015


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SRVLEVELP Specifies the -


N STRING ROF optional
● PSPROFILE attributes
that can be
● DOWNBW displayed in
● UPCOSPOL the returned
ICY result. If you
● DOWNCOS do not set
POLICY this
parameter,
● ISOLATION the optional
STAT attributes are
● ACTURALS not returned.
ERIALNUM If you set this
● MAC parameter,
the optional
attributes are
returned.
Separate
multiple
optional
attributes
with spaces.

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT information of the device "+device-name name of attributes: DID FN SN PN ONTID
ONTSTAT NAME ALIAS CAPABPROF LINEPROF SERVPROF ALMPROF VAPROF AUTH
AUTHTIMEOUT SERIALNUM PWD MFORWARDMODE UV TRANSPARENT MACLEARN
IGMPVLANTAGMODE IGMPVLAN IGMPSNOOPING DBATYPE CFGSTAT MATCHSTAT DISCSTAT
VENDORID ONTVER PRODUCTID EQUIPMENTID MAINSOFTVERSION STANDBYSOFTVER
BATTERYSTAT CURMACCOUNT ONTRANG LOOPINNER LOOPOUTER SRVLEVELPROF PSPROFILE
DOWNBW UPCOSPOLICY DOWNCOSPOLICY ISOLATIONSTAT ACTURALSERIALNUM MAC

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1016


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID. This
If the UNI port is parameter, the
of 10G GPON, the device name or
value range is ID, and the
0-255; if the UNI
subrack, slot, and
port is of 1G
GPON, the value port IDs are used
range is 0-127. together to locate
the ONT.

ONTSTAT OCTET STRING ● Active Indicates the ONT


● Activating status.
● Deactive

NAME OCTET STRING SIZE (255) Indicates the


name.

ALIAS OCTET STRING SIZE (128) Indicates the alias.


NOTE
In the case of the
MA5600
V800R005C03,
MA5600
V800R005C23, and
MA5600
V800R005C33, the
alias consists of up
to 32 characters.

CAPABPROF OCTET STRING SIZE (64) Indicates the


name of the
capability set
profile.
This parameter is
available only in
the discrete mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1017


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LINEPROF OCTET STRING SIZE (32) Indicates the


name of the line
profile.
This parameter is
available only in
the profile mode.

SERVPROF OCTET STRING SIZE (32) Indicates the


name of the
service profile.
This parameter is
available only in
the profile mode.

ALMPROF OCTET STRING SIZE (32) Indicates the


name of the
alarm profile.

VAPROF OCTET STRING SIZE (32) Indicates the


name of a global
ONT VAS profile
or a general ONT
VAS profile.

AUTH OCTET STRING ● SN Indicates the


● SN_PASSWOR authentication
D mode.
● ONCE_ON
● ALWAYS_ON
● LOID
● LOID_ONCEON
● LOID_CHECKC
ODE
● LOID_CHECKC
ODE_ONCEON

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1018


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AUTHTIMEOUT INTEGER 1-168 Indicates the


Disable timeout period of
the
authentication.
This parameter is
valid only when
the authentication
mode is set to
ONCE_ON.
If you do not set
this parameter,
the value is
returned as
Disable in the
output
information.
Unit: h.

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number.
Format: 12-byte
character string
XXXXXXXXXXXX or
16-byte character
string
XXXXXXXXXXXXXX
XX. For details
about how to
modify the format
of the returned
SN, see A.13 How
to Modify the
Format of the
Returned SN.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1019


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PWD OCTET STRING SIZE (36) Indicates the


NOTE password.
● For the OLTs
earlier than
V800R011C00,
the maximum
length of
password for
ONTs
connected to
the OLTs is 10
characters.
● To ensure
system security,
password must
be complex
enough.
Remember to
change
passwords
regularly.

MFORWARDMOD OCTET STRING ● untag Indicates the


E ● translation multicast
forwarding mode
● transparent of the ONT.
● unconcern

UV INTEGER 1-4095 Indicates the user-


side VLAN ID.

TRANSPARENT OCTET STRING ● OPEN Specifies whether


● CLOSE to enable
transparent
transmission.

MACLEARN OCTET STRING ● OPEN Specifies whether


● CLOSE to enable the
function of
learning MAC
addresses for the
ONT.
NOTE
Only the OLT
devices in discrete
mode support this
parameter.

IGMPVLANTAGM OCTET STRING ● translation Indicates the


ODE ● transparent VLAN
transforming
mode of the
upstream IGMP
packet.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1020


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IGMPVLAN INTEGER 1-4095 Indicates the


IGMP VLAN.

IGMPSNOOPING OCTET STRING ● OPEN Specifies whether


● CLOSE to enable
multicast
snooping of the
ONT.

DBATYPE OCTET STRING ● SR Indicates the


● NSR dynamic
bandwidth
allocation (DBA)
mode.
The capability of
the ONT
determines
whether the ONT
reports the
information to
allocate the
bandwidth
dynamically.

CFGSTAT OCTET STRING ● INITIAL Indicates the


● NORMAL configuration
status of the ONT.
● CONFIG After an ONT is
● FAILED online, this
parameter
specifies whether
the configuration
of the ONT is
restored and
whether the
restoration is
complete.

MATCHSTAT OCTET STRING ● INITIAL Indicates the


● MISMATCH matching status.
It is used to
● MATCH specify whether
the ONT
capability
matches the
capability set
profile bound to
the ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1021


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DISCSTAT OCTET STRING ● ON Specifies whether


● OFF to enable the re-
discovery
function.
If the re-discovery
function is
enabled, an
automatically
discovered ONT
can be in the
automatic
discovery state
again after the
ONT is canceled
or the registration
information is
deleted.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

ONTVER OCTET STRING SIZE (40) Indicates the ONT


version.

PRODUCTID INTEGER 0-65535 Indicates the


product code.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONU


type.

MAINSOFTVERSI OCTET STRING SIZE (14) Indicates the


ON software version.

STANDBYSOFTVE OCTET STRING SIZE (14) Indicates the


R version of the
standby software.

BATTERYSTAT OCTET STRING ● NOTSUPPORT Indicates the


● CHARGE status of power
supply of the
● DISCHARGE ONT.
● HOLDING
● POWERON

CURMACCOUNT INTEGER 0-65535 Indicates the


number of MAC
addresses that the
ONT currently
learns.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1022


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTRANG INTEGER 0-65535 Indicates the


ranging distance
of the ONT.
Unit: m.

LOOPINNER OCTET STRING ● OPEN Specifies whether


● CLOSE to perform the
local loopback on
the E1 service.

LOOPOUTER OCTET STRING ● OPEN Specifies whether


● CLOSE to perform the
remote loopback
on the E1 service.

SRVLEVELPROF OCTET STRING SIZE (32) Indicates the


name of a service
level profile.
When the location
information
contains NAME
and
SHOWOPTION=S
RVLEVELPROF is
entered, this
parameter is
displayed as --.
NOTE
MA5600
V800R008C05 and
later versions
(excluding
MA5600
V800R009) support
this parameter.

PSPROFILE OCTET STRING SIZE (32) Indicates the


power shedding
profile name.
NOTE
MA5600
V800R011C00 and
later versions
support this
parameter.

UPCOSPOLICY OCTET STRING SIZE (32) Indicates the


name of the
global upstream
priority queue
mapping profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1023


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DOWNCOSPOLIC OCTET STRING SIZE (32) Indicates the


Y name of the
global
downstream
priority queue
mapping profile.

DOWNBW OCTET STRING SIZE (32) Indicates the


name of the MEF
IP traffic profile
used for rate
limits of
downstream
traffic.
NOTE
MA5600
V800R008C05 and
later versions
support this
parameter. GPON
boards except the
H801GPBC board
support this
parameter.

ISOLATIONSTAT OCTET STRING ● NORMAL Indicates the ONT


● ISOLATED isolation status.
NOTE
The MA5680T,
MA5603U,
MA5603T,
MA5608T,
MA5600T,
MA5800-X17 and
MA5800-X7 only
support this
parameter in
profile mode.

ACTURALSERIALN OCTET STRING SIZE (32) (Optional)


UM Indicates the
actual ONT SN.

MAC OCTET STRING SIZE (17) Indicates the


bridge MAC
Address of ONU.
The address
format is XX-XX-
XX-XX-XX-XX.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1024


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the details of ONT 1 connected to port 0/6/3 on the device named
MA5680T, run the following command:
LST-ONTDETAIL::DEV=MA5680T,FN=0,SN=6,PN=3,ONTID=1:1::;
The result is as follows:
7340033 2009-05-11 21:00:30 M 1 COMPLD EN=0 ENDESC=Succeeded. blktag=1 blkcount=1 blktotal=1
---------------------------------------------------------------------------------------------------- ONT information of
the device MA5680T DID FN SN PN ONTID ONTSTAT NAME ALIAS CAPABPROF
LINEPROF SERVPROF ALMPROF VAPROF AUTH AUTHTIMEOUT SERIALNUM PWD
MFORWARDMODE UV TRANSPARENT MACLEARN IGMPVLANTAGMODE IGMPVLAN
IGMPSNOOPING DBATYPE CFGSTAT MATCHSTAT DISCSTAT VENDORID ONTVER
PRODUCTID EQUIPMENTID MAINSOFTVERSION STANDBYSOFTVER BATTERYSTAT
CURMACCOUNT ONTRANG LOOPINNER LOOPOUTER 7340033 0 6 3 0 Activating
ONT 810e aa -- -- -- -- SN -- 3230313100060200 -- untag -1 CLOSE OPEN
translation -- OPEN -- INITIAL INITIAL -- -- -- -- -- -- -- -- -- -- OPEN
OPEN ---------------------------------------------------------------------------------------------------- ;

Related Command
LST-ONT

14.8.6 Querying the IP Address of a GPON ONT (LST-


ONTIPINFO)
Usage Note
This command is used to query the IP address obtained by an ONT.

Command Format
LST-ONTIPINFO::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|,NAME=ont-name))|ALIAS=ont-alias:CTAG::;

Supporting Device
Device Type No. Device Type

95 MA5603T V800R006 and later versions

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1025


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

249 MA5600T V800R005 and later versions

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1026


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.
NOTE
In the case of
the GPBD
board, the
value ranges
from 0 to 127.
In the case of
the GPBC
board, the
value ranges
from 0 to 63.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING alias. It is
used to locate
the ONT.
NOTE
A unique
record may
fail to be
located by
alias. If a
unique record
is located, the
IP address is
queried. If a
unique record
is not located,
an error
message is
displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1027


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon ont IP information of the device "+device-name
name of attributes:DID FN SN PN ONTID NAME IPINDEX IPCFGTYPE IPADDRESS
IPSUBNETMASK IPGATEWAY

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

NAME OCTET STRING SIZE (255) Indicates the


name.

IPINDEX INTEGER 0-1 Indicates the IP


index.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1028


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IPCFGTYPE OCTET STRING ● DHCP Indicates the


● STATIC mode for
obtaining an IP
● UNCONFIGUR address.
ATION
Options are as
● CONFIGURATI follows:
ON FILE
● DHCP: DHCP
● STATIC: static
● UNCONFIGUR
ATION:
unconfigured
● CONFIGURATI
ON FILE:
configuration
file

IPADDRESS OCTET STRING SIZE (32) Indicates the IP


address. If the IP
address is 0.0.0.0,
two hyphens (--)
are displayed.

IPSUBNETMASK OCTET STRING SIZE (32) Indicates the


subnet mask of
an IP address. If
the subnet mask
is 0.0.0.0, two
hyphens (--) are
displayed.

IPGATEWAY OCTET STRING SIZE (32) Indicates the IP


gateway. If the
gateway is 0.0.0.0,
two hyphens (--)
are displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1029


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058531 The device does not ● Ensure that the device


exist. is successfully added
to the NCE.
● By default, the device
is located according
to 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 A.8 How to
Locate a Device
According to the IP
Address.

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

1615331094 Multiple records are A unique record failed to


found according to the be located by alias.
location information. Ensure that the ONT
alias is unique.
Alternatively, locate an
ONT by other
information, for
example, device name
(or device ID)+subrack
ID+slot ID+port ID+ONT
ID, or device name (or
device ID)+ONT name.

Example
To query the IP address of ONT 32 connected to port 0/18/0 on the device named
10.71.215.61, run the following command:

LST-ONTIPINFO::DEV=10.71.215.61,FN=0,SN=18,PN=0,ONTID=32:1::;

The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1030


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340040 2011-12-22 11:39:15


M 1 COMPLD
EN=0 ENDESC=Succeeded.

blktag=1
blkcount=1
blktotal=1
Gpon ont IP information of the device 10.71.215.61
-----------------------------------------------------------------------------------------
DID FN SN PN ONTID NAME IPINDEX IPCFGTYPE IPADDRESS IPSUBNETMASK
IPGATEWAY
7340040 0 18 0 32 10.71.215.61/Frame0/Slot18/Port0/OnuID32 0 STATIC 192.168.1.32
255.255.255.0 --
-----------------------------------------------------------------------------------------
;

Related Command
None

14.8.7 Querying the Information About Auto-Discovered


GPON ONUs (LST-GPONONTAUTOFIND)
Usage Note
The ONU must be connected to the OLT and be powered on.

Command Format
LST-GPONONTAUTOFIND::((DID=Device-ID|DEV=Device-name)[,FN=Frame-id][,SN=Slot-id][,PN=Port-id])|
(ONTSN=ONT-serialnum):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1031


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTSN OCTET SIZE (16) Indicates the N/A


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXX
XX or 16-byte
character
string
XXXXXXXXXX
XXXXXX.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1032


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Auto find gpon ont information"name of attributes: DEV DID FN SN PN ONTID SERIALNUM PWD
EQUIPMENTID VENDORID MAINSOFTVERSIO

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER -- Indicates the ONU


ID.
NOTE
Currently, this
parameter is
meaningless.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1033


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SERIALNUM OCTET STRING SIZE (16) Indicates the


sequence number.
It is in the format
"XXXXXXXXXXXXX
XXX", where X is a
hexadecimal
number (0-9 or A-
F).
Indicates the
serial number.
Format: 12-byte
character string
XXXXXXXXXXXX or
16-byte character
string
XXXXXXXXXXXXXX
XX. For details
about how to
modify the format
of the returned
SN, see A.13 How
to Modify the
Format of the
Returned SN.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1034


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PWD OCTET STRING ● When the Indicates the ONU


configuration password.
item
GPON_PWD_F
ORMAT_IN_D
B is set to 0,
the following
characters are
allowed:
English: 26
case insensitive
letters
Digits: 0-9
Special
characters: !@#
$%^&*()- and
space
● When the
configuration
item
GPON_PWD_F
ORMAT_IN_D
B is set to 1,
the following
hexadecimal
characters are
allowed:
0-9, A-F, and a-
f
NOTE
● For the OLTs
earlier than
V800R011C00,
the maximum
length of
password for
ONTs
connected to
the OLTs is 10
characters.
● To ensure
system security,
password must
be complex
enough.
Remember to
change
passwords
regularly.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1035


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VENDORID INTEGER - Indicates the


vendor ID.
NOTE
● When
GPON_VENDO
RID_AUTOFIN
D_SWITH is set
to 0, the type
of VENDORID
is an integer,
for example,
2011. When
GPON_VENDO
RID_AUTOFIN
D_SWITH is set
to 1, the type
of VENDORID
is a string, for
example,
HWTC. The
default value is
0.
● For details
about how to
modify the
configuration
item, see A.17
Querying and
Modifying NCE
Configuration
Items.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the type


of the ONU.
NOTE
The configuration
item
xPONCOMMON_T
HIRDONT_EQUIP
MENT_FORMAT
determines the
format of terminal
types returned for
CIGG vendors'
ONUs. For details
about the meaning
and setting
method of the
configuration item,
see Table 8-1.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1036


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAINSOFTVERSI OCTET STRING SIZE (14) Indicates the ONU


ON software version.
This parameter is
applicable to the
following devices:
● MA5600T:
MA5600
V800R006 and
later versions
● MA5606T:
MA5600
V800R006 and
later versions
● MA5603T:
MA5600
V800R006 and
later versions

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
Example 1: To query the information about the auto-discovered ONU of port 0/8/2
on the device named 10.78.217.216, run the following command:
LST-GPONONTAUTOFIND::DEV=10.78.217.216,FN=0,SN=8,PN=2:0::;
The result is as follows:
-1 2010-11-01 16:43:44
M 0 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Auto find gpon ont information


-----------------------------------------------------------------------------------------
DEV DID FN SN PN ONTID SERIALNUM PWD EQUIPMENTID VENDORID MAINSOFTVERSION
10.78.217.216 7340148 0 8 2 -- 3230313100363702 -- -- --
-----------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1037


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example 2: To query the information about the auto-discovered ONU (ONTSN:


4857544371E87C03), run the following command:

LST-GPONONTAUTOFIND::ONTSN=4857544371E87C03:0::;

The result is as follows:


7340037 2013-05-25 19:06:46
M 0 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Auto find gpon ont information


----------------------------------------------------------------------------------------
DEV DID FN SN PN ONTID SERIALNUM PWD EQUIPMENTID VENDORID MAINSOFTVERSION
10.144.195.36 7340037 0 5 1 -- 4857544371E87C03 floor25612 SmartAX MA5612 2011 V8R310 C00
----------------------------------------------------------------------------------------

Related Command
● LST-ONT
● ADD-ONT

14.8.8 Querying the Running Status of an ONT (LST-


ONTRUNINFO)
Usage Note
There is no usage note.

Command Format
LST-ONTRUNINFO::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id)|(,FN=Frame-id,SN=Slot-
id,PN=Port-id)|(,FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-id)|,NAME=ont-name))|ALIAS=ont-
alias:CTAG::[SHOWOPTION=ALARMSTATE RUNTIME ONTOFFLINEREASON];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1038


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1039


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.

NAME OCTET SIZE (255) Indicates the N/A


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the N/A


STRING NOTE alias. It is
For the used to locate
MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1040


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ALARMSTATE (Optional) N/A


N STRING RUNTIME Specifies the
attributes
ONTOFFLINE that can be
REASON displayed in
the returned
result. If you
set this
parameter,
the
corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

Set the parameters specified in one of the following items:


● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
Only one record is displayed after the query.
● Device name, subrack ID, slot ID, port ID
● Device ID, subrack ID, slot ID, port ID
● Device name, subrack ID, slot ID
● Device ID, subrack ID, slot ID
A list of records are displayed after the query.
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT run info of the device "+device-name
name of attributes: DID FN SN PN ONTID NAME ALIAS RUNSTAT ADMINSTAT
BATTERYSTAT LSTUPTIME LSTDOWNTIME LSTDOWNCAUSE ALARMSTATE RUNTIME

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1041


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID. This
If the UNI port is parameter, the
of 10G GPON, the device name or
value range is ID, and the
0-255; if the UNI
subrack, slot, and
port is of 1G
GPON, the value port IDs are used
range is 0-127. together to locate
the ONT.
NOTE
For GPBD boards,
the value ranges
from 0 to 127; for
GPBC boards, the
value ranges from
0 to 63.

NAME OCTET STRING SIZE (255) Indicates the


name.

ALIAS OCTET STRING SIZE (128) Indicates the alias.


NOTE
For the MA5600
V800R005C03,
MA5600
V800R005C23, and
MA5600
V800R005C33, the
alias consists of up
to 32 characters.

RUNSTAT OCTET STRING ● Up Indicate the


● Down running
information about
the ONT.

ADMINSTAT OCTET STRING ● Up Indicates the


● Down activation status
of the ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1042


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

BATTERYSTAT OCTET STRING ● NOTSUPPORT Indicates the


● CHARGE status of power
supply of the
● DISCHARGE ONT.
● HOLDING
● POWERON

LSTUPTIME INTEGER Format: YYYY- Indicates the last


MM-DD time when the
HH:MM:SS ONT was online.
The time is in UTC
format.

LSTDOWNTIME INTEGER Format: YYYY- Indicates the last


MM-DD time when the
HH:MM:SS ONT was offline.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1043


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LSTDOWNCAUSE OCTET STRING ● ONUDEL Indicates reason


● ONTDISCONN why the ONT was
ECT offline last time.
● LOSI Options are as
follows:
● LOFI
● ONUDEL: The
● SFI ONT is deleted.
● LOAI ● ONTDISCONN
● LOAMI ECT: The ONT
● DACT Failure is
disconnected.
● DACT
● LOSI: A branch
● Reset fiber is
● Re-Regester disconnected
● Popup Failure or the OLT fails
to detect
● Author Failure
optical signals
● Dying-gasp from an EPON
● OFF-Line ONT.
Failure ● LOFI: ONT
● Deactive frames are lost.
Because of ● SFI: Bit error
Ring rates of the
● Trunoff Optic ONT exceed
the preset
● Cmd Reboot
threshold.
● Forced Reset
● LOAI: PLOAM
● Software Reset acknowledgme
● ONT Operator nt messages
Password are lost for the
Check Failure ONT.
● Operator ● LOAMI: PLOAM
Check Failure messages are
lost for the
● The ONT is
ONT.
self-detected
as a rogue ● DACT Failure:
ONT The ONT
deactivation
fails.
● DACT: The
ONT is
deactivated.
● Reset: The
ONT is reset.
● Re-Regester:
The ONT
registers again.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1044


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● Popup Failure:
The ONT fails
to respond to
the popup
messages from
the OLT.
● Author Failure:
The ONT
authentication
fails.
● Dying-gasp:
The Dying-
gasp alarm is
reported when
the ONT
undergoes a
power failure.
● OFF-Line
Failure: The
ONT fails to
get offline.
● Deactive
Because of
Ring: The ONT
goes offline
because of the
ring.
● Trunoff Optic:
The ONT
optical module
is shut down.
● Cmd Reboot:
The ONT is
reset by ONT
command.
● Forced Reset:
The ONT is
reset by ONT
reset button.
● Software Reset:
The ONT is
reset by ONT
software.
● ONT Operator
Password
Check Failure:
The ONT is

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1045


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

deactived due
to broadcast
attack.
● Operator
Check Failure:
Fail to check
operator.
● The ONT is
self-detected
as a rogue
ONT: A rogue
ONT is
detected by
itself.

ALARMSTATE OCTET STRING SD/SF/DOW/LOS/ Indicates the


RDI alarm type of the
ONT.
NOTE
If SD, SF, DOW,
LOS, or RDI is
displayed, it
indicates that the
ONT generates an
SD or SF or a
DOW, LOS, or RDI
alarm. If SD, SF,
DOW, or LOS is
displayed, the ONT
generates an SD or
SF or a DOW or
LOS alarm.

RUNTIME INTEGER 0-4294967296 Indicates the


online duration of
the ONT.
Unit: s.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1046


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTOFFLINEREAS OCTET STRING ● No third-party Indicates the


ON ONU reason why the
interoperability ONT goes offline
authorization
● ONT
interoperability
mode
mismatch
● ONT based
information
error
● ONT
interoperability
file mismatch
● ONT is not
compatible
with OLT
● Actual ONT
optical power
is lower than
which online
● ONT is not in
the white list

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the running status of ONT 10 connected to port 0/14/3 on the device
named 10.167.223.48, run the following command:
LST-ONTRUNINFO::DEV=10.167.223.48,FN=0,SN=14,PN=3,ONTID=10:1::;
The result is as follows:
7340034 2010-11-20 14:19:16
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1047


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blkcount=1
blktotal=1

ONT run info of the device 10.167.223.48


-----------------------------------------------------------------------------------------------------------------
DID FN SN PN ONTID NAME ALIAS RUNSTAT ADMINSTAT BATTERYSTAT LSTUPTIME
LSTDOWNTIME LSTDOWNCAUSE
7340085 0 14 3 10 MA5600T/Frame0/Slot14/Port3/OnuID10 -- Down Up -- -- -- --
-----------------------------------------------------------------------------------------------------------------

Related Command
None

14.8.9 Querying the List of ONT Ports (LST-ONTPORT)

Usage Note
If the value of the configuration item BMS_LSTONTPORT_SHOW_NNI is set to 1,
the command output contains information about the NNI ports. For details about
the meaning and setting method of the configuration item, see Table 8-1.

Command Format
LST-ONTPORT::((DID=Device-ID|DEV=Device-name,)((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-id)|
NAME=ont-name))|ALIAS=ont-alias[,ONTPORTTYPE=ont-port-type,ONTPORTID=ont-port-id][,PWD=ont-
password]:CTAG::[SHOWOPTION=VLANDEFAULT ONTPORTASTAT TXPOWER ONTPORTSUBTYPE];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1048


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2357/2355/2356 MA5800-X17-VAN/MA5800-X7-VAN/
MA5800-X15-VAN

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1049


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING NOTE alias. It is
In the case of used to locate
the MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1050


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTPORTTYP OCTET ● E1 Indicates the -


E STRING ● FE type of the
user port.
● GE
NOTE
● MOCA
● MOCA
● CATV indicates
the
● IPHOST Ethernet
● ETH port that
complies
● VDSL2 with the
North
American
standard.
● CATV
indicates
the
interface
of the
cable
television.

ONTPORTID INTEGER 0-63 Indicates the -


ID of the user
port.

PWD OCTET SIZE (36) Indicates the -


STRING NOTE ONT
● For the
password.
OLTs If you locate
earlier the ONT
than
according to
V800R011
C00, the the DEV/DID
maximum and PWD
length of parameters,
password you do not
for ONTs need to enter
connected
the subrack
to the
OLTs is 10 number, slot
characters. ID, port ID, or
● To ensure
ONT ID.
system
security,
password
must be
complex
enough.
Remember
to change
passwords
regularly.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1051


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET (Optional) -


N STRING ● VLANDEFA Indicates the
ULT option of
● ONTPORT output,
ASTAT include the
● TXPOWER attribute of
the return
● ONTPORTS result.
UBTYPE

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon ont port information of the device "+device-name
name of attributes: DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ONTPSTAT
VLANDEFAULT ONTPORTASTAT TXPOWER ONTPORTSUBTYPE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1052


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the In the case of the
value range is GPBD board, the
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

ONTPORTTYPE OCTET STRING ● E1 Indicates the type


● FE of the user port.
NOTE
● GE
● MOCA
● MOCA indicates the
● CATV Ethernet port
that complies
● IPHOST with the North
● ETH American
standard.
● T1
● CATV indicates
● CATVANI the interface of
the cable
● POTS television.
● VDSL2
● NNI

ONTPORTID INTEGER 0-63 Indicates the ID of


the user port.

ONTPSTAT OCTET STRING ● Active Indicates the


● Deactive current running
status of the ONT
● Activating port.
NOTE
This parameter is
not supported
when
ONTPORTTYPE is
POTS.

VLANDEFAULT INTEGER 1-4095 Indicates the


default VLAN ID.

ONTPORTASTAT OCTET STRING OPEN Indicates the


CLOSE status of the ONT
port.
NOTE
This parameter is
not supported
when
ONTPORTTYPE is
POTS.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1053


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TXPOWER INTEGER 0-2147483647 Indicates the ONT


port output
power.
Only CATV ports
support output
power queries.
Unit: 0.001 dBmV.

ONTPORTSUBTYP OCTET STRING ● E1 Indicates the


E ● FE subtype of the
ONT port.
● GE
● VDSL2
● WIFI
● MOCA
● ETH
● CATV
● IPHOST
● CATVANI

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the list of ports of ONT 10 connected to port 0/14/3 on the device
named 10.167.223.48, run the following command:
LST-ONTPORT::DEV=10.167.223.48,FN=0,SN=14,PN=3,ONTID=10:1::;
The result is as follows:
7340085 2010-11-20 14:35:19
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=7
blktotal=7

Gpon ont port information of the device 10.167.223.48

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1054


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

-----------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ONTPSTAT
7340085 0 14 3 10 E1 1 --
7340085 0 14 3 10 E1 2 --
7340085 0 14 3 10 IPHOST 1 --
7340085 0 14 3 10 ETH 1 Activating
7340085 0 14 3 10 ETH 2 Activating
7340085 0 14 3 10 ETH 3 Activating
7340085 0 14 3 10 ETH 4 Activating
-----------------------------------------------------------------

Related Command
LST-ONTPORTDETAIL

14.8.10 Querying the Details of an ONT Port (LST-


ONTPORTDETAIL)

Usage Note

NOTICE

Do not run this command to bulk query inventories of a large number of ports.
Otherwise, the query efficiency is low.

Command Format
LST-ONTPORTDETAIL::((DID=Device-ID|DEV=Device-name,)((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|NAME=ont-name))|ALIAS=ont-alias,ONTPORTTYPE=ont-port-type,ONTPORTID=ont-port-
id:CTAG::[SHOWOPTION=UPSTREAMPROFILENAME DOWNSTREAMPROFILENAME];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1055


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1056


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING NOTE alias. It is
In the case of used to locate
the MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1057


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTPORTTYP OCTET ● E1 Indicates the -


E STRING ● FE type of the
user port.
● GE
NOTE
● MOCA
● MOCA
● CATV indicates
the
● IPHOST Ethernet
● ETH port that
complies
● VDSL2 with the
North
American
standard.
● CATV
indicates
the
interface
of the
cable
television.

ONTPORTID INTEGER 0-63 Indicates the -


ID of the user
port.

SHOWOPTIO OCTET ● UPSTREAM (Optional) -


N STRING PROFILEN Specifies the
AME attributes
● DOWNSTR that can be
EAMPROFI displayed in
LENAME the returned
result. If you
set this
parameter,
the
corresponding
attributes are
returned. By
default, the
attributes are
not displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1058


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, ONT ID, ONT port type, and ONT port ID
● Device ID, subrack ID, slot ID, port ID, ONT ID, ONT port type, and ONT port ID
● Device name, ONT name, ONT port type, and ONT port ID
● Device ID, ONT name, ONT port type, and ONT port ID
● ONT alias, ONT port type, and ONT port ID
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon ont port detail information of the device "+device-name
name of attributes: DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ACTUALPT
ONTPSTAT VLANDEFAULT PRIORITY CODEMODE NEGOTIATE DUPLEX SPEED FLOWCTRL
LOOPBACK COPYPRIORITYPOLICY QINQ ADMINSTAT UPSTREAMPROFILENAME
DOWNSTREAMPROFILENAME

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the In the case of the
value range is GPBD board, the
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1059


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTPORTTYPE OCTET STRING ● E1 Indicates the type


● FE of the user port.
NOTE
● GE
● MOCA
● MOCA indicates the
● CATV Ethernet port
that complies
● IPHOST with the North
● ETH American
standard.
● VDSL2
● CATV indicates
the interface of
the cable
television.

ONTPORTID INTEGER 0-63 Indicates the ID of


the user port.

ACTUALPT OCTET STRING ● FE Indicates the


● GE actual type of the
user port.
● ETH
● VDSL2

ONTPSTAT OCTET STRING ● Active Indicates the


● Deactive current running
status of the ONT
● Activating port.

VLANDEFAULT INTEGER 0-4095 Indicates the


default VLAN ID.

PRIORITY INTEGER 0-7 Indicates the


priority.

CODEMODE OCTET STRING ● AMI Indicates the line


● HDB3 code format of
the E1 port.

NEGOTIATE OCTET STRING ● OPEN Specifies whether


● CLOSE to enable the
auto-negotiation.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1060


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DUPLEX OCTET STRING ● HALF Indicates the


● FULL duplex mode of
the Ethernet port.
● AUTO The meanings of
● AUTO-HALF the options are as
● AUTO-FULL follows:
● -- ● HALF: Indicates
the half-duplex
mode. In this
mode, data
can be either
transmitted or
received on the
network at a
time.
● FULL: Indicates
the full-duplex
mode. In this
mode, data
can be
transmitted or
received on the
network
simultaneously.
● AUTO:
Indicates the
auto
negotiation
mode.
● AUTO-HALF:
Indicates the
auto
negotiation
half-duplex
mode.
● AUTO-FULL:
Indicates the
auto
negotiation
full-duplex
mode.
● --: invalid value

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1061


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SPEED OCTET STRING ● 10 Indicates the rate


● 100 of the ONT port.
● 1000 Unit: Mbit/s.
● 2500
● 10000
● AUTO
● AUTO-10
● AUTO-100
● AUTO-1000
● AUTO-2500
● AUTO-10000
● --

FLOWCTRL OCTET STRING ● OPEN Specifies whether


● CLOSE to enable flow
control of the
ONT port.

LOOPBACK OCTET STRING ● NOLOOP Indicates the


● REMOTEINNER loopback mode of
the ONT port.
● REMOTEOUTE Only the Ethernet
R port and E1 port
support this
parameter.
In the case of an
Ethernet port, this
parameter can be
set to NOLOOP
or
REMOTEINNER.
In the case of the
E1 port, this
parameter can be
set to NOLOOP
or
REMOTEOUTER.

COPYPRIORITYPO OCTET STRING ● ASSIGNED Indicates the


LICY ● COPYCOS priority copy
policy.
● UNCONCERN

QINQ OCTET STRING ● DISABLE Specifies whether


● ENABLE to enable the
transparent
● UNCONCERN transmission of
the QinQ VLAN.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1062


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ADMINSTAT OCTET STRING ● Up Indicates the


● Down management
status. Only the
FE, GE, CATV and
Ethernet ports
support this
parameter.

UPSTREAMPROFI OCTET STRING SIZE (64) Indicates the


LENAME name of an
upstream
committed access
rate (CAR) profile.

DOWNSTREAMPR OCTET STRING SIZE (64) Indicates the


OFILENAME name of a
downstream CAR
profile.

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query details about port 1 of ONT 10 connected to port 0/14/3 on the device
named 10.167.223.48, run the following command:
LST-
ONTPORTDETAIL::DEV=10.167.223.48,FN=0,SN=14,PN=3,ONTID=10,ONTPORTT
YPE=ETH,ONTPORTID=1:1::;
The result is as follows:
7340033 2009-05-11 21:54:16
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gpon ont port detail information of the device 10.167.223.48


------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ACTUALPT ONTPSTAT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1063


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

VLANDEFAULT PRIORITY CODEMODE NEGOTIATE DUPLEX SPEED FLOWCTRL LOOPBACK


COPYPRIORITYPOLICY QINQ ADMINSTAT
7340085 0 14 3 10 ETH 1 -- Activating 1 0 -- 0 0 0 CLOSE -- -- -- Up
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------

Related Command
LST-ONTPORT

14.8.11 Querying the Ethernet Port Details of a GPON ONT


(LST-GPONONTETHPORTDETAIL)

Usage Note
This command is used to query the Ethernet port details of a GPON ONT. Ensure
that the OLT is online before running this command.

Command Format
LST-GPONONTETHPORTDETAIL::(DID=Device-ID|DEV=Device-name),FN=frame-id,SN=slot-id,PN=port-
id,ONTID=ont-id,ONTPORTID=ont-port-id:CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

57 MA5606T

34 MA5680T

94 MA5603U

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1064


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT index.
If the UNI The ONTID,
port is of 10G DEV (or DID),
GPON, the FN, SN, and
value range is
PN
0-255; if the
UNI port is of parameters
1G GPON, the identify an
value range is ONT.
0-127.

ONTPORTID INTEGER 0-63 Indicates the -


ID of an ONT
user-side port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1065


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ont eth port information of the Device DevName"
name of attributes: DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ONTPORTSTATUS RXPKTS
TXPKTS

Output Parameter
Parameter Type Range Parameter

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPORTTYPE INTEGER 47 Indicates the ONT


port type.
If the value is 47,
the port is an
Ethernet port.

ONTPORTID INTEGER 0-63 Indicates the ID of


an ONT user-side
port.

ONTPORTSTATUS OCTET STRING ● ACTIVATE Indicates the


● DEACTIVATE status of the ONT
port.

RXPKTS INTEGER 0-4294967296 Indicates the


number of
received packets.
Unit: packet.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1066


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Parameter

TXPKTS INTEGER 0-4294967296 Indicates the


number of
transmitted
packets.
Unit: packet.

Error Code
ID Description Solution

1610612751 Parameter Enter all mandatory parameters that are


is included in the command.
incomplete.

Example
To query the details about ONT 6 whose port ID is 1 and is connected to port
0/8/0 on the device named 10.78.217.216, run the following command:
LST-
GPONONTETHPORTDETAIL::DEV=10.78.217.216,FN=0,SN=8,PN=0,ONTID=6,ON
TPORTID=1:333::;
The result is as follows:
7340046 2010-11-04 17:42:32
M 333 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ont eth port information 10.78.217.216


----------------------------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ONTPORTSTATUS RXPKTS TXPKTS
7340046 0 8 0 6 47 1 ACTIVATE -- --
----------------------------------------------------------------------------------

The valid fields of each Ethernet port vary with the types of devices and ports. The invalid
fields are displayed as --.

Related Command
LST-ETHPORT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1067


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.12 Querying the Status of an ONU POTS User (LST-


ONTPOTSSTATE)
Usage Note
None

Command Format
LST-ONTPOTSSTATE::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|,NAME=ont-name|,PWD=ont-password))|ALIAS=ont-alias:CTAG::;

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/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1068


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1069


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1070


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET ● When the Indicates the -


STRING configurati ONT
on item password.
GPON_PW If you locate
D_FORMA the ONT
T_IN_DB is according to
set to 0, the DEV/DID
the and PWD
following parameters,
characters you do not
are need to enter
allowed: the subrack
English: 26 number, slot
case ID, port ID, or
insensitive ONT ID.
letters
Digits: 0-9
Special
characters:
!@#$
%^&*()-
and space
● When the
configurati
on item
GPON_PW
D_FORMA
T_IN_DB is
set to 1,
the
following
hexadecim
al
characters
are
allowed:
0-9, A-F,
and a-f

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1071


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default


NOTE
● For the
OLTs
earlier
than
V800R011
C00, the
maximum
length of
password
for ONTs
connected
to the
OLTs is 10
characters.

ALIAS OCTET SIZE (128) Indicates the -


STRING NOTE alias. It is
In the case of used to locate
the MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="List ont pots state "+device-name
name of attributes:NAME DID DEV FN SN PN ONTID POTSINDEX ADMINSTAT
CONNECTIONSTAT SERVICESTAT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1072


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

NAME OCTET STRING SIZE (255) Indicates the


name.

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 A.8
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.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

POTSINDEX INTEGER 1-2 Indicates the


POTS user index.

ADMINSTAT OCTET STRING ● CONNECT Indicates the


● LOCKD management
status of the
POTS user.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1073


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CONNECTIONSTA OCTET STRING ● REGISTERING Indicates the


T ● IDLE connection status
of the POTS user.
● DIALING
NOTE
● RINGING For compatibility
● PLAYING- concern, retain the
original spelling
RINGBACK- and set
TONE UseRightParaNam
● BEING- eForPotsState to 1
to change FAILED-
CONNECTED
REGISTRATTION
● CONNECTED to FAILED-
REGISTRATION.
● RELEASING For details about
CONNECTION how to modify the
● FAILED- UseRightParaNam
REGISTRATTIO eForPotsState
configuration item,
N see the Table 8-2.
● DEACTIVED
● FAULT

SERVICESTAT OCTET STRING ● LOCAL- Indicates the


BLOCKED service status of
● REMOTE- the POTS user.
BLOCKED
● REMOTE-
FAULT
● NORMAL

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the status of the POTS users of ONT 0 connected to port 0/11/0 on the
device named 10.71.214.171, run the following command:
LST-ONTPOTSSTATE::DEV=10.71.214.171,FN=0,SN=11,PN=0,ONTID=0:1::;
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1074


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340080 2011-12-29 14:17:18


M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

List ont pots state 10.71.214.171

-----------------------------------------------------------------------------------------
NAME DID DEV FN SN PN ONTID POTSINDEX ADMINSTAT CONNECTIONSTAT
SERVICESTAT
MA5680T/Frame 0/Slot 11/Port 0/OnuID0 7340080 10.71.214.171 0 11 0 0 1 CONNECT
IDLE NORMAL
-----------------------------------------------------------------------------------------
;

Related Command
None

14.8.13 Querying the MAC Addresses Learned by the User Port


of an FTTH ONU (LST-GPONONTPORTMAC)

Usage Note
● The OLT must be online.
● ONU ports function properly.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the GPON board and the GPON port.
● The ONU information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● The ONU UNI port must be connected to a home gateway that works in the
normal state and that is connected to a network device such as a PC.

Command Format
LST-GPONONTPORTMAC::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id,ONTPORTTYPE=ont-port-type,ONTPORTID=ont-port-id,VLANID=vlan-id:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1075


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - (Optional) -


Indicates the
device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1076


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PN INTEGER 0-63 Indicates the -


port ID.

ONTID INTEGER 0-255 Indicates the -


NOTE ONU ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

ONTPORTTYP OCTET ● FE Indicates the -


E STRING ● GE type of user
port on the
● ETH ONU.
● VDSL2
● WLAN

ONTPORTID INTEGER 0-31 Indicates the -


ID of the user
port of the
ONU. The
range of the
user ports is
restricted by
the capability
set profile.

VLANID INTEGER 0-4094 Indicates the -


VLAN ID.
When this
parameter is
set to 0, the
default VLAN
is used for
queries and
the value 1 is
returned.

Enter either the device ID or the device name. Other parameters are mandatory.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1077


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="Ont information of the device"+device-name


name of attributes: DID FN SN PN ONTID ONTPORTTYPE ONTPORTID VLANID MAC

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPORTTYPE OCTET STRING ● FE Indicates the type


● GE of user port on
the ONU.
● ETH
● VDSL2
● WLAN

ONTPORTID INTEGER 1-32 Indicates the user


port ID of the
ONU. The number
of the user ports
is defined in the
ONT capability
profile.

VLANID INTEGER 1-4094 Indicates the


VLAN ID.

MAC OCTET STRING SIZE (17) Indicates the MAC


address addresses
learned by the
user port of the
FTTH ONU.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1078


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the


device is offline. Verify that the
following faults do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device
because of network faults.

2686058531 The device does not ● Verify that the device is


exist. successfully added to the NCE.
● By default, the device is
located according to 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 A.8 How to Locate a
Device According to the IP
Address.

2686058554 Command does not Verify that the command supports


support this device the entered device name or IP
type. address.

2686058498 Missing, invalid Verify that the command is


parameter or correct according to the following
mandatory parameter requirements:
is blank, or the ● The parameter values do not
parameter value is exceed the ranges of the
wrong. parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

Example
To query the MAC addresses learned by FE port 1 on ONT 1 connected to port
0/15/0 on the device named 10.71.211.96, run the following command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1079


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

LST-
GPONONTPORTMAC::DEV=10.71.211.96,FN=0,SN=15,PN=0,ONTID=1,ONTPORT
TYPE=FE,ONTPORTID=1,VLANID=3999:CTAG::;

The first five MAC addresses learned by the port are displayed each time the query
operation is complete. The invalid fields are displayed as --.

The result is as follows:


7340033 2009-03-06 13:51:38
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=5
blktotal=5

Ont information of the device 10.71.211.96


----------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID VLANID MAC
7340033 0 15 0 1 FE 1 3999 00-74-04-FF-5F-53
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
----------------------------------------------------------------
;

Related Command
LST-SERVICEPORT

14.8.14 Querying the Details of GPON Optical Modules (LST-


GPONSFP)
Usage Note
This command is used to query the information about optical modules on a
specified device. Before running this command, ensure that the device is online
and has been configured with a GPON optical module on the specified slot.
If this command is run for xGPON COMBO boards, the command output will
contain two records.
This command supports the XGPON optics module information of H901CGID
board.

Command Format
LST-GPONSFP::(DID=Device-ID|DEV=Device-name)[,FN=frame-num][,SN=slot-num][,PN=port-num]:CTAG::
[SHOWOPTION=IDENTIFIER CONNECTOR];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1080


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

34 MA5680T
MA5600 V800R008C00 and later
versions

95 MA5603T
MA5600 V800R008C00 and later
versions

2331 MA5608T

249 MA5600T
MA5600 V800R008C00 and later
versions

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING device name.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1081


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● IDENTIFIER (Optional) -


N STRING ● CONNECT Specifies the
OR attributes
that can be
displayed in
the returned
result. If you
set this
parameter,
the
corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="GPON SFP information of the device "+device-name
name of attributes: DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5
VENDORNAME VENDOROUI VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
IDENTIFIER CONNECTOR

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

LENGTH9MICRON INTEGER 0-2147483647 Indicates the


transmission
distance of
9/125μm fiber.
Unit: 100 m.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1082


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LENGTH50MICRO INTEGER 0-2147483647 Indicates the


N transmission
distance of
50/125μm fiber.
Unit: m.

LENGTH62MICRO INTEGER 0-2147483647 Indicates the


N5 transmission
distance of
62.5/125μm fiber.
Unit: m.

VENDORNAME OCTET STRING 0-17 Indicates the


vendor name.

VENDOROUI OCTET STRING 0-9 Indicates the OUI


ID of the vendor.

VENDORPN OCTET STRING 0-17 Indicates the


product ID of the
vendor.

VENDORSN OCTET STRING 0-17 Indicates the


serial number of
the vendor.

VENDORREV OCTET STRING 0-5 Indicates the


version.

WAVELENGTH INTEGER 0-2147483647 Indicates the


optical
wavelength.
Unit: nm.

TYPE OCTET STRING ● Unknown Indicates the type


● GPON of the optical
module.
● EPON
NOTE
● 10G GPON 10G GPON
● 10G EPON represents the XG-
GPON type which
● WDM PON is defined in the
TIU-T standard.
● hybrid PON
● XGPON+GPON
● PRX30-E
● XGSPON
+GPON
● TWDMPON
● XGS-PON

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1083


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SUBTYPE OCTET STRING ● Unknown Indicates the


● CLASS B+ subtype of the
optical module.
● CLASS C+
● CLASS B
● PX20
● PX20+
● PR30
● PR20
● PRX30
● PRX20
● CLASS C++
● PX20++
● PRX40
● PR40
● N2A
● N2B
● N1
● E1
● E2a
● E2b
● D1
● CLASS D
● N2
● E2

IDENTIFIER OCTET STRING ● Unknown Indicates the


● GBIC optical module ID.
Only NEs that
● SolderedToMot work in profile
herboard mode support this
● SFP parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1084


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CONNECTOR OCTET STRING ● Unknown Indicates the


● SC optical module
connector type.
● CopperConnect Only NEs that
or1 work in profile
● CopperConnect mode support this
or2 parameter.
● BNC/TNC
● CoaxialHeaders
● FiberJack
● LC
● MT-RJ
● MU
● SG
● OpticalPigtail
● HSSDC II
● CopperPigtail
● MpoParallelOp
tic
● RJ45

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
Example 1: To query information about optical modules on the board in slot 4 of
subrack 0 on the device named 10.78.217.110, run the following command:
LST-GPONSFP::DEV=10.78.217.110,FN=0,SN=4:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1085


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The result is as follows:


7340032 2011-04-20 13:58:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=8
blktotal=8

GPON SFP information of the device 10.78.217.110


------------------------------------------------------------------------------------------------------------------------------
-----------------------
DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5 VENDORNAME VENDOROUI
VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
7340032 0 4 0 100 0 0 OCP TRP-G1L1BCHWS 3428392 0000 1310 -- --
7340032 0 4 1 0 0 0 -- 0 -- --
7340032 0 4 2 0 0 0 -- 0 -- --
7340032 0 4 4 200 0 0 NEOPHOTONICS PTB38J0-6538E-SC A1009096926 1.0 1490 --
--
------------------------------------------------------------------------------------------------------------------------------
-----------------------

Example 2: To query information about optical modules of port 0/2/3 on the


device named 10.144.79.105, run the following command:

LST-
GPONSFP::DEV=10.144.79.105,FN=0,SN=2,PN=3:CTAG::SHOWOPTION=IDENTIFI
ER CONNECTOR;

The result is as follows:


7340037 2014-01-17 14:53:00
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

GPON SFP information of the device 10.144.79.105


------------------------------------------------------------------------------------------------------------------------------
-----------------------
DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5 VENDORNAME
VENDOROUI VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
IDENTIFIER CONNECTOR
7340037 0 2 3 200 0 0 SOURCEPHOTONICS 00-06-b5 SPS4348HHPCDE
B3Q2016487 4 1490 GPON CLASS B+ SFP SC
------------------------------------------------------------------------------------------------------------------------------
-----------------------

Example 3: To query information about optical modules of port 0/16/0 on the


device named 10.71.51.71, run the following command:

LST-
GPONSFP::DEV=10.71.51.71,FN=0,SN=16,PN=0:CTAG::SHOWOPTION=IDENTIFIE
R CONNECTOR;

The result is as follows:


7340035 2016-07-21 16:48:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1086


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktotal=2

GPON SFP information of the device 10.71.51.71


------------------------------------------------------------------------------------------------------------------------------
-----------------------
DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5 VENDORNAME
VENDOROUI VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
IDENTIFIER CONNECTOR
7340035 0 16 0 200 0 0 Hisense Unspecified LTE3680M-BC+ E4924005538
1.0 1490 GPON CLASS B+ SFP SC
7340035 0 16 0 200 0 0 MITSUBISHI ELEC 00-26-92 XT-10000GLA1CA01
83021310UV000026 0.2 1577 10GGPON N1 SFP SC
------------------------------------------------------------------------------------------------------------------------------
-----------------------

Related Command
LST-SFP

14.8.15 Querying the Parameters of the Optical Module of an


ONT (LST-ONTDDMDETAIL)

Usage Note

None.

Command Format
LST-ONTDDMDETAIL::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|,NAME=ont-name|PWD=ont-password))|ALIAS=ont-alias:CTAG::
[SHOWOPTION=OPTICSRXPOWERbyOLT OPTICSCATVRXPOWER TYPE SUBTYPE
TxPowerHighAlarmThreshold TxPowerLowAlarmThreshold RxPowerHighAlarmThreshold
RxPowerLowAlarmThreshold CurrTxBiasHighAlarmThreshold CurrTxBiasLowAlarmThreshold
VoltageHighAlarmThreshold VoltageLowAlarmThreshold TemperatureHighAlarmThreshold
TemperatureLowAlarmThreshold];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1087


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1088


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.
In the case of
the GPBD
board, the
value ranges
from 0 to 127.
In the case of
the GPBC
board, the
value ranges
from 0 to 63.

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

PWD OCTET SIZE (36) Indicates the -


STRING NOTE ONT
For the OLTs password.
earlier than
If you locate
V800R011C00,
the maximum the ONT
length of according to
password for the DEV/DID
ONTs and PWD
connected to parameters,
the OLTs is 10
you do not
characters.
need to enter
the subrack
number, slot
ID, port ID, or
ONT ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1089


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ALIAS OCTET SIZE (128) Indicates the -


STRING NOTE alias. It is
In the case of used to locate
the MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1090


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● OPTICSRXP (Optional) -


N STRING OWERbyO Specifies the
LT attributes
● OPTICSCAT that can be
VRXPOWE displayed in
R the returned
result. If you
● TYPE set this
● SUBTYPE parameter,
● TxPowerHi the
ghAlarmTh corresponding
reshold attributes are
displayed. By
● TxPowerLo default, the
wAlarmThr attributes are
eshold not displayed.
● RxPowerHi
ghAlarmTh
reshold
● RxPowerLo
wAlarmThr
eshold
● CurrTxBias
HighAlarm
Threshold
● CurrTxBias
LowAlarm
Threshold
● VoltageHig
hAlarmThr
eshold
● VoltageLo
wAlarmThr
eshold
● Temperatu
reHighAlar
mThreshol
d
● Temperatu
reLowAlar
mThreshol
d

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1091


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
Only one record is displayed after the query.
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT DDM detail of the device "+device-name
name of attributes: DID FN SN PN ONTID NAME ALIAS OPTICSRXPOWER
OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTXTEMP OPTICSTXVOL ONTRANGING
OPTICSRXPOWERbyOLT
OPTICSCATVRXPOWER TYPE SUBTYPE TxPowerHighAlarmThreshold TxPowerLowAlarmThreshold
RxPowerHighAlarmThreshold RxPowerLowAlarmThreshold CurrTxBiasHighAlarmThreshold
CurrTxBiasLowAlarmThreshold VoltageHighAlarmThreshold VoltageLowAlarmThreshold
TemperatureHighAlarmThreshold TemperatureLowAlarmThreshold

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID. In the case of
If the UNI port is the GPBD board,
of 10G GPON, the the value ranges
value range is from 0 to 127. In
0-255; if the UNI
the case of the
port is of 1G
GPON, the value GPBC board, the
range is 0-127. value ranges from
0 to 63.

NAME OCTET STRING SIZE (255) Indicates the ONT


name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1092


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALIAS OCTET STRING SIZE (128) Indicates the ONT


NOTE alias.
In the case of the
MA5600
V800R005C03,
MA5600
V800R005C23, and
MA5600
V800R005C33, the
alias consists of up
to 32 characters.

OPTICSRXPOWER FLOAT -10000 to +10000 Indicates the


receive optical
power.
Unit: 0.01dBm.

OPTICSTXPOWER FLOAT -10000 to +10000 Indicates the


transmit optical
power.
Unit: 0.01dBm.

OPTICSTXBIASCU INTEGER 0-10000 Indicates the bias


RR current.
Unit: mA.

OPTICSTXTEMP FLOAT -100 to +300 Indicates the


temperature of
the optical
module.
Unit: °C.

OPTICSTXVOL INTEGER 0-10000 Indicates the


voltage of the
optical module.
Unit: mV.

ONTRANGING DOUBLE 0-2147483647 Indicates the


ranging distance
of the ONT.
Unit: m.

OPTICSRXPOWER FLOAT -10000 to +10000 Indicates the ONT


byOLT optical power
received by the
OLT.
Unit: 0.01dBm.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1093


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTICSCATVRXPO INTEGER 0-2147483647 Indicates the


WER CATV receive
optical power.
Unit: 0.01dBm.

TYPE OCTET STRING ● GPON Indicates the


● EPON optical module
type.
● 10G EPON
● 10G GPON
● WDMPON
● hybirdPON
● GPON/EPON
● UNKNOWN
● XGS-PON

SUBTYPE OCTET STRING ● CLASS B+ Indicates the


● PRX20 optical module
subtype.
● PRX40
● PR40
● GPON CLASS B
+/EPON PX20+
● GPON CLASS
B/EPON PX20
● UNKNOWN
● CLASS C+
● CLASS B
● N2A
● N2B
● N1
● E1
● E2a
● E2b
● N1/N2A/E1/E2
a
● CLASS C++
● PX20
● PX20+
● PX20++
● PR30
● PR20
● PRX30

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1094


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TxPowerHighAlar FLOAT -10000 to 10000 Indicates the


mThreshold upper alarm
threshold of the
transmit optical
power.
Unit: 0.01dBm

TxPowerLowAlar FLOAT -10000 to 10000 Indicates the


mThreshold lower alarm
threshold of the
transmit optical
power.
Unit: 0.01dBm

RxPowerHighAlar FLOAT -10000 to 10000 Indicates the


mThreshold upper alarm
threshold of the
receive optical
power.
Unit: 0.01dBm

RxPowerLowAlar FLOAT -10000 to 10000 Indicates the


mThreshold lower alarm
threshold of the
receive optical
power.
Unit: 0.01dBm

CurrTxBiasHighA- INTEGER 0-10000 Indicates the


larmThreshold upper alarm
threshold of the
bias current.
Unit: mA

CurrTxBiasLowAla INTEGER 0 to 10000 Indicates the


rmThreshold lower alarm
threshold of the
bias current.
Unit: mA

VoltageHighAlarm INTEGER 0-10000 Indicates the


Threshold upper alarm
threshold of the
supply voltage.
Unit: mV

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1095


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VoltageLowAlarm INTEGER 0-10000 Indicates the


Threshold lower alarm
threshold of the
supply voltage.
Unit: mV

TemperatureHigh- FLOAT -100 to 300 Indicates the


AlarmThreshold upper alarm
threshold of the
temperature.
Unit:

TemperatureLowA FLOAT -100 to 300 Indicates the


larmThreshold lower alarm
threshold of the
temperature.
Unit: °C

Error Code
ID Description Solution

1610612764 Device Timeout The cause is usually that the device is


offline. Verify that the following
faults do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device
because of network faults.

2686058531 The device does not ● Verify that the device is


exist. successfully added to the NCE.
● By default, the device is located
according to 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 A.8 How to Locate a
Device According to the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1096


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058554 Command does not Verify that the command supports


support this device the entered device name or IP
type. address.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
Example 1: To query the parameters of the optical module of ONT 2 connected to
port 0/17/2 on the device named 10.78.217.114, run the following command:
LST-ONTDDMDETAIL::DEV=10.78.217.114,FN=0,SN=17,PN=2,ONTID=2:CTAG::;
The result is as follows:
7340107 2010-11-20 16:30:48
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ONT DDM detail of the device 10.78.217.114


------------------------------------------------------------------------------------------------------------------------------
-
DID FN SN PN ONTID NAME ALIAS OPTICSRXPOWER OPTICSTXPOWER
OPTICSTXBIASCURR OPTICSTXTEMP OPTICSTXVOL ONTRANGING
7340107 0 17 2 2 10.78.217.114/Frame0/Slot17/Port2/OnuID2 -- 10000 0 0 0 0 188
------------------------------------------------------------------------------------------------------------------------------
-

Example 2: To query the parameters of the optical module of ONT 4 connected to


port 0/2/1 on the device named 10.144.79.105, run the following command:
LST-
ONTDDMDETAIL::DEV=10.144.79.105,FN=0,SN=2,PN=1,ONTID=4:CTAG::SHOW
OPTION=OPTICSRXPOWERbyOLT;
The result is as follows:
7340037 2014-01-17 14:55:46
M CTAG COMPLD
EN=0 ENDESC=Succeeded.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1097


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktag=1
blkcount=1
blktotal=1

ONT DDM detail of the device 10.144.79.105


------------------------------------------------------------------------------------------------------------------------------
-
DID FN SN PN ONTID NAME ALIAS OPTICSRXPOWER OPTICSTXPOWER
OPTICSTXBIASCURR OPTICSTXTEMP OPTICSTXVOL ONTRANGING OPTICSRXPOWERbyOLT
7340037 0 2 1 4 10.144.78.115 -- -1388 249 9 49 3270 21 -1496
------------------------------------------------------------------------------------------------------------------------------
-

Related Command
None.

14.8.16 Querying the Optical Module Information of an MDU


NNI Port (LST-ONUNNIDDMDETAIL)
Usage Note
● The OLT and MDU must be online.
● The OLT of a specific version must support the GPON service.
● The optical module functions properly.

Command Format
LST-ONUNNIDDMDETAIL::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slotid,PN=Port-id:CTAG::;

Supporting Device
Device Type No. Type

57 MA5606T

70 MA5610

100 MA5616

92 MA5652G
The MA5652G V800R307C00 and later
versions

96 MA5620

65 MA5620G

97 MA5626

66 MA5626G

104 MA5612

2321 MA5669

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1098


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Type

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-512 Indicates the N/A


subrack
number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1099


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SN INTEGER 0-35 Indicates the N/A


slot number.

PN INTEGER 0-63 Indicates the N/A


port number.

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Onu Optic Power info of device "+device-name
name of attributes: DID FN SN PN OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTXTEMP
OPTICSTXVOL ONTRANGING

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-512 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


number.

PN INTEGER 0-63 Indicates the port


number.

OPTICSRXPOWER FLOAT -100 to 100 Indicates the


receive power of
the optical
module.
Unit: dBm

OPTICSTXPOWER FLOAT -100 to 100 Indicates the


transmit power of
the optical
module.
Unit: dBm

OPTICSTXBIASCU FLOAT 0-10000 Indicates the bias


RR current of the
optical module.
Unit: mA

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1100


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTICSTXTEMP FLOAT -100 to 300 Indicates the


temperature of
the optical
module.
Unit: °C

OPTICSTXVOL INTEGER 0-10000 Indicates the


power supply
voltage of the
optical module.
Unit: mV

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1101


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query information about the MDU optical module (ONTID=0) at port 0/0/1 on
the device named 10.78.217.216, run the following command:

LST-ONUNNIDDMDETAIL::DEV=10.78.217.216,FN=0,SN=0,PN=1:CTAG::;

The result is as follows:


7340033 2010-11-09 18:38:24
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

MXU Power info of device 10.78.217.216


-------------------------------------------------------------------------
DID FN SN PN OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTXTEMP OPTICSTXVOL
7340033 0 0 1 -15.07 2.99 10.54 30.6 3370
-------------------------------------------------------------------------
;

Related Command
LST-EPONONTDDMDETAIL

14.8.17 Querying the Ethernet Transmission Feature of an


Upstream Port of an ONT (LST-ONTETHPORTPERF)

Usage Note
None

Command Format
LST-ONTETHPORTPERF::((DID=Device-ID|DEV=Device-name,)((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|NAME=ont-name))|ALIAS=ont-alias[,ONTPORTTYPE=ont-port-type,ONTPORTID=ont-port-
id]:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1102


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

57 MA5606T

94 MA5603U

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1103


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1104


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING NOTE alias. It is
In the case of used to locate
the MA5600 the ONT.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

ONTPORTTYP OCTET ● FE Indicates the -


E STRING ● GE type of the
user port.
● ETH

ONTPORTID INTEGER 0-63 Indicates the -


ID of the user
port.

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, ONT ID, ONT port type, and ONT port ID
● Device ID, subrack ID, slot ID, port ID, ONT ID, ONT port type, and ONT port ID
● Device name, ONT name, ONT port type, and ONT port ID
● Device ID, ONT name, ONT port type, and ONT port ID
● ONT alias, ONT port type, and ONT port ID
In the preceding items, the ONT port type and the ONT port ID are optional.
Only one record is displayed after the query.
If the value of a parameter is displayed as --, the symbol indicates an invalid value. Note:
The ONTPORTTYPE and ONTPORTID parameters are optional in this command. If you set
the ONTPORTTYPE and ONTPORTID parameters, you can query the Ethernet transmission
feature of the UNI port. If you do not set these two parameters, you can query the Ethernet
transmission feature of the ONT NNI port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1105


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is In the case of the
of 10G GPON, the
GPBD board, the
value range is
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

NAME OCTET STRING SIZE (255) Indicates the ONT


name.

ALIAS OCTET STRING SIZE (128) Indicates the ONT


NOTE alias.
In the case of the
MA5600
V800R005C03,
MA5600
V800R005C23, and
MA5600
V800R005C33, the
alias consists of up
to 32 characters.

TransmittedFrame DOUBLE 0-1844674407370 Indicates the


s 9551615 number of
transmitted
frames.

ReceivedFrames DOUBLE 0-1844674407370 Indicates the


9551615 number of
received frames.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1106


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TransmittedOctets DOUBLE 0-1844674407370 Indicates the


9551615 number of
transmitted bytes.

ReceivedOctets DOUBLE 0-1844674407370 Indicates the


9551615 number of
received bytes.

DiscardedTxFrame DOUBLE 0-1844674407370 Indicates the


s 9551615 number of
discarded frames
after the frames
are transmitted.
Only the ONT
NNI port supports
this parameter.

DiscardedRxFrame DOUBLE 0-1844674407370 Indicates the


s 9551615 number of
discarded frames
after the frames
are received. Only
the ONT NNI port
supports this
parameter.

CountsTxScapeErr DOUBLE 0-1844674407370 Indicates the


9551615 number of
upstream frames
with delimitation
failures of the
ONT. Only the
ONT NNI port
supports this
parameter.

CountsTxBipErr DOUBLE 0-1844674407370 Indicates the


9551615 number of
upstream bit
interleaved parity
(BIP) error frames
of the ONT. Only
the ONT NNI port
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1107


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CountsRxBipErr DOUBLE 0-1844674407370 Indicates the


9551615 number of
downstream BIP
error frames of
the ONT. Only the
ONT NNI port
supports this
parameter.

CountsTxFECDeco DOUBLE 0-1844674407370 Indicates the


dedCorrect 9551615 number of
corrected blocks
in case of
upstream forward
error correction
(FEC) decoding.
Only the ONT
NNI port supports
this parameter.

CountsTxFECDeco DOUBLE 0-1844674407370 Indicates the


dedUnCorrect 9551615 number of
uncorrected
blocks in case of
FEC decoding.
Only the ONT
NNI port supports
this parameter.

CountsTxHECErr DOUBLE 0-1844674407370 Indicates the


9551615 number of
upstream header
error control
(HEC) check
errors. Only the
ONT NNI port
supports this
parameter.

OversizedFrames DOUBLE 0-1844674407370 Indicates the


9551615 number of
oversized frames
received. Only the
Ethernet port
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1108


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ShortFrames DOUBLE 0-1844674407370 Indicates the


9551615 number of
undersized frames
received. Only the
Ethernet port
supports this
parameter.

Jabbers DOUBLE 0-1844674407370 Indicates the


9551615 number of error
Jabber frames
received. Only the
Ethernet port
supports this
parameter.

FragmentsLesstha DOUBLE 0-1844674407370 Indicates the


n64Bytes 9551615 number of 64-
byte frames
received. Only the
Ethernet port
supports this
parameter.

FCS DOUBLE 0-1844674407370 Indicates the


9551615 number of FCS
frame check
errors received.
Only the Ethernet
port supports this
parameter.

ExcessiveCollisions DOUBLE 0-1844674407370 Indicates the


9551615 number of frames
that fail to be
transmitted due
to excessive
collisions. Only
the Ethernet port
supports this
parameter.

OverflowRx DOUBLE 0-1844674407370 Indicates the


9551615 times of overflows
of the receive
buffer. Only the
Ethernet port
supports this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1109


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OverflowTx DOUBLE 0-1844674407370 Indicates the


9551615 times of overflows
of the transmit
buffer. Only the
Ethernet port
supports this
parameter.

DeferredFrames DOUBLE 0-1844674407370 Indicates the


9551615 number of
transmission-
delayed frames.
Only the Ethernet
port supports this
parameter.

TxMaxRate INTEGER 0-65535 Indicates the


maximum TX rate.
This parameter is
only applicable to
ETH ports.

RxMaxRate INTEGER 0-65535 Indicates the


maximum RX rate.
This parameter is
only applicable to
ETH ports.

Error Code
ID Description Solution

1610612764 Device The cause is usually that the device is offline.


timeout. Verify that the following faults do not occur:
● The physical connection is disconnected.
● The SNMP read and write community names
are set incorrectly.
● NCE cannot ping the device because of
network faults.

2686058531 The device ● Verify that the device is successfully added to


does not the NCE.
exist. ● By default, the device is located according to
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 A.8 How to Locate
a Device According to the IP Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1110


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058554 Command Verify that the command supports the entered


does not device name or IP address.
support this
device type.

2686058498 Missing, Verify that the command is correct according to


invalid the following requirements:
parameter ● The parameter values do not exceed the
or ranges of the parameters specified by the
mandatory command.
parameter is
blank, or ● The entered parameter names are correct.
the ● The parameters are entered in the correct
parameter order.
value is
wrong.

Example
To query the transmission feature statistics of ONT 3 connected to port 0/13/0 on
the device named MA5600T_SFP, run the following command:
LST-
ONTETHPORTPERF::DEV=MA5600T_SFP,FN=0,SN=13,PN=0,ONTID=3:CTAG::;
The result is as follows:
7340032 2016-11-30 16:53:45
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gpon ont perf information of the device


------------------------------------------------------------------------------------------------------------------------------
--------------------------
DID FN SN PN ONTID NAME ALIAS TransmittedFrames ReceivedFrames
TransmittedOctets ReceivedOctets DiscardedTxFrames DiscardedRxFrames CountsTxScapeErr
CountsTxBipErr CountsRxBipErr CountsTxFECDecodedCorrect CountsTxFECDecodedUnCorrect
CountsTxHECErr OversizedFrames ShortFrames Jabbers FragmentsLessthan64Bytes FCS
ExcessiveCollisions OverflowRx OverflowTx DeferredFrames TxMaxRate RxMaxRate
7340032 0 13 0 3 10.71.211.96/Frame0/Slot13/Port0/OnuID3 0 0 0 0 0 0
32237 1105 0 0 0 0 -- -- -- -- -- -- -- -- -- -- --
-----------------------------------------------------------------------------------

Related Command
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1111


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.18 Querying the List of DBA Profiles Bound to an ONT


(LST-ONTDBAPROF)
Usage Note
The ONT to be queried must exist and be bound to a DBA profile.

Command Format
LST-ONTDBAPROF::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(PWD=ont-password)):CTAG::[SHOWOPTION=TCONTTYPE ASSUREDBANDWIDTH FIXEDBANDWIDTH
MAXBANDWIDTH BANDWIDTHCOMPENSATION];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1112


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI NOTE
port is of 10G In the case of
GPON, the the GPBD
value range is board, the
0-255; if the value ranges
UNI port is of from 0 to 127.
1G GPON, the In the case of
value range is the GPBC
0-127. board, the
value ranges
from 0 to 63.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1113


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET ● When the Indicates the -


STRING configurati ONT
on item password.
GPON_PW If you locate
D_FORMA the ONT
T_IN_DB is according to
set to 0, the DEV/DID
the and PWD
following parameters,
characters you do not
are need to enter
allowed: the subrack
English: 26 ID, slot ID,
case port ID, and
insensitive ONT ID.
letters
Digits: 0-9
Special
characters:
!@#$
%^&*()-
and space
● When the
configurati
on item
GPON_PW
D_FORMA
T_IN_DB is
set to 1,
the
following
hexadecim
al
characters
are
allowed:
0-9, A-F,
and a-f
NOTE
For the OLTs
earlier than
V800R011C00,
the maximum
length of
password for
ONTs
connected to
the OLTs is 10
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1114


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET TCONTTYPE Specifies the -


N STRING ASSUREDBAN attributes
DWIDTH that can be
displayed in
FIXEDBANDW the returned
IDTH result. If you
MAXBANDWI set this
DTH parameter,
BANDWIDTH the
COMPENSATI corresponding
ON attributes are
displayed. By
default, the
attributes are
not displayed.

● Enter either the device ID or the device name.


● Enter either the subrack ID, slot ID, port ID, and ONT ID or the ONT password.
● Enter the subrack ID, slot ID, port ID, and ONT ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Tcont profile referred by the device "+device-name
name of attributes:DID FN SN PN ONTID TCONTID ALLOCID DBAPROF TCONTTYPE
ASSUREDBANDWIDTH FIXEDBANDWIDTH MAXBANDWIDTH BANDWIDTHCOMPENSATION

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1115


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the In the case of the
value range is GPBD board, the
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

TCONTID INTEGER 0-127 Indicates the T-


CONT ID.

ALLOCID INTEGER 0-4095 Indicates the Alloc


ID of a GPON
connection. The
OLT uses the Alloc
IDs to identify all
the ONUs (ONTs)
that are
connected to it.
Each T-CONT of
the ONUs has a
globally unique
Alloc ID.

DBAPROF OCTET STRING SIZE (32) Indicates the


name of the DBA
profile.

ASSUREDBANDWI INTEGER 128-10000000 Indicates the


DTH assured
bandwidth.
Unit: kbit/s.

FIXEDBANDWIDT INTEGER 128-10000000 Indicates the fixed


H bandwidth.
Unit: kbit/s.

MAXBANDWIDTH INTEGER 128-10000000 Indicates the


maximum
bandwidth.
Unit: kbit/s.

BANDWIDTHCOM OCTET STRING ● YES Indicates the


PENSATION ● NO bandwidth
compensation.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1116


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the list of DBA profiles bound to ONT 10 connected to port 0/5/0 on the
device named 10.71.227.2, run the following command:
LST-ONTDBAPROF::DEV=10.71.227.2,FN=0,SN=5,PN=0,ONTID=10:CTAG::;
The result is as follows:
7340073 2010-11-20 16:22:16
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Tcont profile referred by the device:10.71.227.2, FN=0, SN=5, PN=0, ONTID=10


------------------------------------------------------
DID FN SN PN ONTID TCONTID ALLOCID DBAPROF
7340073 0 5 0 10 0 10 dba-profile_1
------------------------------------------------------

Related Command
LST-ONT

14.8.19 Querying the List of GEM Ports (LST-GEMPORT)


Usage Note
This command is available only for the device in the discrete mode.

Command Format
LST-GEMPORT::(DID=Device-ID|DEV=Device-name)[,FN=Frame-id[,SN=Slot-id[,PN=Port-id[,ONTID=ont-id]
[,GEMPORTID=port-id]]]]:CTAG::[SHOWOPTION=ONTID TCONTID PITP OPTION82SW DHCPV6OPTION];

Supporting Device
Device Type No. Device Type

34 MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1117


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T V800R010C00 and later


versions

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1118


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

PN INTEGER 0-63 (Optional) -


Indicates the
port ID.

ONTID INTEGER 0-255 (Optional) -


NOTE Indicates the
If the UNI ONT ID.
port is of 10G NOTE
GPON, the For GPBD
value range is boards, the
0-255; if the value ranges
UNI port is of from 0 to 127.
1G GPON, the In the case of
value range is the GPBC
0-127. board, the
value ranges
from 0 to 63.

GEMPORTID INTEGER 128-3999 (Optional) -


Indicates the
GEM port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1119


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● ONTID (Optional) -


N STRING ● TCONTID Specifies the
attributes
● PITP that can be
● OPTION82 displayed in
SW the returned
● DHCPV6O result. If you
PTION set this
parameter,
the
corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

● Enter either the device ID or the device name.


● Enter the subrack ID, slot ID, and port ID in order. For example, you can enter the slot ID
only after you enter the subrack ID.
● Enter the ONT ID or the GEM port ID must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gemport information of the device "+device-name
name of attributes:DID FN SN PN GEMPORTID NAME ALIAS DNENCRYPT SERVICETYPE
BINDONT DBAPROF TCONTPQ CASCASE ONTID TCONTID PITP OPTION82SW DHCPV6OPTION

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

GEMPORTID INTEGER 128-3999 Indicates the GEM


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1120


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NAME OCTET STRING SIZE (1-255) Indicates the


name.

ALIAS OCTET STRING SIZE (1-128) Indicates the alias.


NOTE
For the MA5600
V800R005C03,
MA5600
V800R005C23, and
MA5600
V800R005C33, the
alias consists of up
to 32 characters.

BINDONT OCTET STRING SIZE (1-32) Indicates the ONT


that is bound.

TCONTPQ INTEGER 0-127 Indicates the PQ


of the ONT T-
CONT.

AVERBAND INTEGER 64-1048576 Indicates the


average
bandwidth.

MAXBAND INTEGER 64-1048576 Indicates the


maximum
bandwidth.

DNENCRYPT OCTET STRING ● ENABLE Specifies whether


● DISABLE to enable the
downstream
encryption.

SERVICETYPE OCTET STRING ● TDM Indicates the


● ETH service type.

CASCADE OCTET STRING ● ON Specifies whether


● OFF to enable the
subtending.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

DBAPROF OCTET STRING SIZE (1-32) Indicates the


name of the DBA
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1121


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TCONTID INTEGER 0-127 Indicates the


TCONT ID.

PITP OCTET STRING ● ENABLE Specifies whether


● DISABLE the PITP function
of a device is
enabled. If the
device needs to
provide the BRAS
with the physical
port information
of the access
subscriber, enable
the PITP function.
After the PITP
function is
enabled on the
port and globally,
the device works
with the RADIUS
or the BRAS to
authenticate the
binding between
the subscriber
account and the
access port. In this
manner, the
subscriber
account can be
protected against
theft and
roaming.
This parameter is
supported for
querying a single
GEM port. In
other scenarios, --
is returned.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1122


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTION82SW OCTET STRING ● ENABLE Specifies whether


● DISABLE the DHCP option
82 function of a
device is enabled.
After the DHCP
option 82
function is
enabled, the
device adds the
option 82 field to
DHCP packets to
ensure the
security of the
DHCP function.
This parameter is
supported for
querying a single
GEM port. In
other scenarios, --
is returned.

DHCPV6OPTION OCTET STRING ● ENABLE The DHCPv6


● DISABLE server can
allocate IP
addresses to
authorized users
based on the
DHCPv6 option.
This prevents
unauthorized
users from
applying for IP
addresses from
the server and
eliminates IP
address
exhaustion
spoofing to the
DHCPv6 server.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1123


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command. Alternatively,
check whether the device
to which the command is
issued supports this
command. The device in
the profile mode does
not support this
command.

Example
To query the list of GEM ports of slot 5 in shelf 0 on the device named
10.71.227.2, run the following command:
LST-GEMPORT::DEV=10.71.227.2,FN=0,SN=5,PN=0:CTAG::;
The result is as follows:
7340073 2010-11-20 16:23:01
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=17
blktotal=17

Gemport information of the device 10.71.227.2


------------------------------------------------------------------------------------------------------------------------------
-----
DID FN SN PN GEMPORTID NAME ALIAS BINDONT DBAPROF TCONTPQ AVERBAND
MAXBAND DNENCRYPT SERVICETYPE CASCADE
7340073 0 5 0 128 10.71.227.2/Frame0/Slot5/Port0/GemPortID128 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID0 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 129 10.71.227.2/Frame0/Slot5/Port0/GemPortID129 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID2 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 130 10.71.227.2/Frame0/Slot5/Port0/GemPortID130 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID3 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 131 10.71.227.2/Frame0/Slot5/Port0/GemPortID131 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID4 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 134 10.71.227.2/Frame0/Slot5/Port0/GemPortID134 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID6 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 135 10.71.227.2/Frame0/Slot5/Port0/GemPortID135 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID7 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 136 10.71.227.2/Frame0/Slot5/Port0/GemPortID136 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID8 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 137 10.71.227.2/Frame0/Slot5/Port0/GemPortID137 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID9 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 138 10.71.227.2/Frame0/Slot5/Port0/GemPortID138 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID10 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 139 10.71.227.2/Frame0/Slot5/Port0/GemPortID139 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID11 -1 -- -- DISABLE ETH OFF
7340073 0 5 0 152 10.71.227.2/Frame0/Slot5/Port0/GemPortID152 -- 10.71.227.2/Frame0/
Slot5/Port0/OnuID1 -1 -- -- DISABLE ETH OFF

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1124


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340073 0 5 0 1601 10.71.227.2/Frame0/Slot5/Port0/GemPortID1601 -- -1 -- --


DISABLE ETH OFF
7340073 0 5 0 1602 10.71.227.2/Frame0/Slot5/Port0/GemPortID1602 -- -1 -- --
DISABLE ETH OFF
7340073 0 5 0 1603 10.71.227.2/Frame0/Slot5/Port0/GemPortID1603 -- -1 -- --
DISABLE ETH OFF
7340073 0 5 0 1604 10.71.227.2/Frame0/Slot5/Port0/GemPortID1604 -- -1 -- --
DISABLE ETH OFF
7340073 0 5 0 1605 10.71.227.2/Frame0/Slot5/Port0/GemPortID1605 -- -1 -- --
DISABLE ETH OFF
7340073 0 5 0 1606 10.71.227.2/Frame0/Slot5/Port0/GemPortID1606 -- -1 -- --
DISABLE ETH OFF
------------------------------------------------------------------------------------------------------------------------------
-----

Related Command
LST-GEMCONNECTION

14.8.20 Querying the List of GEM Connections (LST-


GEMCONNECTION)

Usage Note
None

Command Format
LST-GEMCONNECTION::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Port-id,
(ONTID=ont-id|GEMPORTID=port-id)[,VLANID=vlan-id]:CTAG::[SHOWOPTION=TRAFFICPROF TCONTID
DBAPROFILE];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1125


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1126


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 (Optional) -


NOTE Indicates the
If the UNI ONT ID.
port is of 10G NOTE
GPON, the In the case of
value range is the GPBD
0-255; if the board, the
UNI port is of value ranges
1G GPON, the from 0 to 127.
value range is In the case of
0-127. the GPBC
board, the
value ranges
from 0 to 63.

GEMPORTID INTEGER 128-3999 (Optional) -


Indicates the
GEM port ID.

VLANID INTEGER 1-4095 (Optional) -


Indicates the
VLAN ID.
In profile
mode, the
MA5600V800
R007C00B150
and later
versions
support this
parameter.

SHOWOPTIO OCTET ● TRAFFICPR (Optional) -


N STRING OF Indicates the
● TCONTID traffic profile.
The
● DBAPROFI TRAFFICPRO
LE F parameter
is contained
in the output
parameters
only after you
enter
SHOWOPTIO
N=TRAFFICP
ROF.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1127


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● Enter either the device ID or the device name.


● Enter the subrack ID, slot ID, and port ID in order. For example, you can enter the slot ID
only after you enter the subrack ID.
● Enter either the ONT ID or the GEM port ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="GEM Connection information of the device "+device-name
name of attributes:DID FN SN PN ONTID GEMPORTID VLANID PRIORITY ONTPORTTYPE
ONTPORTID AVERBAND MAXBAND TRAFFICPROF TCONTID DBAPROFILE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the In the case of the
value range is GPBD board, the
0-255; if the UNI value ranges from
port is of 1G 0 to 127. In the
GPON, the value case of the GPBC
range is 0-127. board, the value
ranges from 0 to
63.

GEMPORTID INTEGER 128-3999 Indicates the GEM


port ID.

VLANID INTEGER 0-4095 Indicates the user


VLAN ID.

PRIORITY INTEGER 0-7 Indicates the


priority.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1128


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTPORTTYPE OCTET STRING ● E1 Indicates the type


● FE of the user port of
the ONT.
● GE
● MOCA
● CATV
● CESOP
● IPHOST
● ETH
● VDSL2
● ETHBUNDLE

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1129


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTPORTID INTEGER 0-63 Indicates the ID of


the user port of
the ONT. The
range of the user
ports is restricted
by the capability
set profile.
● In the case of
the MA5600T
whose version
is earlier than
V800R005C32B
138, the value
of this
parameter
ranges from 0
to 40.
● In the case of
the MA5600T
whose version
is from
V800R005C32B
138 to
V800R005C32B
999 or is later
than
V800R005C33,
the value of
this parameter
ranges from 1
to 63.
● In the case of
the MA5603T,
the value of
this parameter
ranges from 1
to 63.

AVERBAND INTEGER 64-1048576 Indicates the


average
bandwidth.

MAXBAND INTEGER 64-1048576 Indicates the


maximum
bandwidth.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1130


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TRAFFICPROF OCTET STRING SIZE (64) Indicates the


name of the
traffic profile. If
you enter
SHOWOPTION=T
RAFFICPROF, this
parameter is
displayed.

TCONTID INTEGER 0-127 Indicates the T-


CONT ID. If you
enter
SHOWOPTION=T
CONTID, this
parameter is
displayed.
In profile mode,
the
MA5600V800R007
C00B150 and
later versions
support this
parameter.

DBAPROFILE OCTET STRING SIZE (32) Indicates the


name of the DBA
profile. If you
enter
SHOWOPTION=D
BAPROF, this
parameter is
displayed.
In profile mode,
the
MA5600V800R007
C00B150 and
later versions
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1131


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the list of GEM connections of ONT 5 connected to port 0/14/3 on the
device named 10.167.223.48, run the following command:
LST-GEMCONNECTION::DEV=10.167.223.48,FN=0,SN=14,PN=3,ONTID=5:CTAG::;
The result is as follows:
7340085 2010-11-20 16:02:47
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=5
blktotal=5

GEM Connection information of the device 10.167.223.48


---------------------------------------------------------------------------------------------------------
DID FN SN PN ONTID GEMPORTID VLANID PRIORITY ONTPORTTYPE ONTPORTID
AVERBAND MAXBAND
7340085 0 14 3 5 0 11 -- -- -- -- --
7340085 0 14 3 5 1 14 -- -- -- -- --
7340085 0 14 3 5 2 15 -- -- -- -- --
7340085 0 14 3 5 3 16 -- -- -- -- --
7340085 0 14 3 5 4 12 -- -- -- -- --
---------------------------------------------------------------------------------------------------------

Related Command
LST-GEMPORT

14.8.21 Querying the Real-Time Performance Data of Ethernet


Traffic on a GPON UNI Port (LST-GPONPORTPERF)
Usage Note
● The OLT must be online.
● The OLT is in profile mode and supports GPON services.

Command Format
LST-GPONPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Port-id:CTAG::
[SHOWOPTION=TXMAXRATE RXMAXRATE OUTMULTPKTS INMULTPKTS OUTBROADPKTS INBROADPKTS
TxRate RxRate];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1132


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Type

249 MA5600T

34 MA5680T

2331 MA5608T

95 MA5603T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1133


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot number.

PN INTEGER 0-63 Indicates the N/A


port number.

SHOWOPTIO OCTET ● TXMAXRAT Optional) -


N STRING E Specifies the
● RXMAXRAT attributes
E that can be
displayed in
● OUTMULT the returned
PKTS result. If you
● INMULTPK set this
TS parameter,
● OUTBROA the
DPKTS corresponding
attributes are
● INBROADP displayed. By
KTS default, the
● TxRate attributes are
● RxRate not displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1134


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="GPON port perf information of the device" +device-name
name of attributes: DID FN SN PN INOCTES INUCASTPKTS INDISCARDS INERRORS OUTOCTES
OUTUCASTPKTS OUTDISCARDS OUTERRORS RxDiscardsPktsOccupancy RxErrorsPktsOccupancy
TxDiscardsPktsOccupancy TxErrorsPktsOccupancy TXMAXRATE RXMAXRATE OUTMULTPKTS
INMULTPKTS OUTBROADPKTS INBROADPKTS TxRate RxRate

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


number.

PN INTEGER 0-63 Indicates the port


number.

INOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
received.

INUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets received.

INDISCARDS INTEGER 0-1844674407370 Indicates the total


9551615 number of
dropped packets
received.

INERRORS INTEGER 0 Indicates the total


number of error
packets received.

OUTOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
transmitted.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1135


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OUTUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets
transmitted.

OUTDISCARDS INTEGER 0 Indicates the total


number of
dropped packets
transmitted.

OUTERRORS INTEGER 0 Indicates the total


number of error
packets
transmitted.

RxDiscardsPktsOc- INTEGER 0-8589934590 Indicates the


cupancy discarded of
received packets.
Only the Ethernet
port supports this
parameter.

RxErrorsPktsOccu- INTEGER 0-8589934590 Indicates the


pancy errors of received
packets. Only the
Ethernet port
supports this
parameter.

TxDiscardsPktsOc- INTEGER 0-8589934590 Indicates the


cupancy discarded of
transmitted
packets. Only the
Ethernet port
supports this
parameter.

TxErrorsPktsOccu- INTEGER 0-8589934590 Indicates the


pancy errors of
transmitted
packets. Only the
Ethernet port
supports this
parameter.

TXMAXRATE INTEGER 0-65535 Indicates the


Maximum Rate of
transmitted bytes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1136


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RXMAXRATE INTEGER 0-65535 Indicates the


maximum RX rate.
This parameter is
only applicable to
ETH ports.

OUTMULTPKTS INTEGER 0-1844674407370 Indicates the


9551615 multicast of
transmitted
packets.

INMULTPKTS INTEGER 0-1844674407370 Indicates the


9551615 multicast of
received packets.

OUTBROADPKTS INTEGER 0-1844674407370 Indicates the


9551615 broadcast of
transmitted
packets.

INBROADPKTS INTEGER 0-1844674407370 Indicates the


9551615 broadcast of
received packets.

TxRate INTEGER 0-1844674407370 Indicates the rate


9551615 of transmitted.

RxRate INTEGER 0-1844674407370 Indicates the rate


9551615 of received.

Error Code
ID Description Solution

1610612764 Device timeout.. The cause is usually that


the device is offline.
Ensure that the following
faults do not occur:
● The physical
connection is
disconnected.
● The SNMP read and
write community
names are set
incorrectly.
● The NCE cannot ping
the device because of
network faults.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1137


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058531 The device does not ● Ensure that the device


exist. is successfully added
to the NCE.
● By default, the device
is located according
to 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 How to Locate a
Device According to
the IP Address.

2686058554 Command does not Ensure that the


support this device type. command supports the
entered device name or
IP address.

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
Value of parameter is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● The parameters are
entered in the correct
order.

Example
To query the performance data of port 0/6/0 on the device named 10.167.223.118,
run the following command:
LST-GPONPORTPERF::DEV=10.167.223.118,FN=0,SN=6,PN=0:CTAG::;
The result is as follows:
7340223 2011-08-16 14:47:14
M CTAG COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1138


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESCSucceeded.
blktag=1
blkcount=1
blktotal=1

GPON port perf information of the device 10.167.223.118


----------------------------------------------------------------------------------------------------------------
DIDFN PN SN INOCTES INUCASTPKTS INDISCARDS INERRORS OUTOCTES
OUTUCASTPKTS OUTDISCARDS OUTERRORS RxDiscardsPktsOccupancy RxErrorsPktsOccupancy
TxDiscardsPktsOccupancy TxErrorsPktsOccupancy
7348735 0 6 0 0 0 0 0 0 0 0 0 -- -- 0 --
----------------------------------------------------------------------------------------------------------------
;

Related Command
None

14.8.22 Querying the Real-Time Performance Data of a GPON


ONT Ethernet Port (LST-GPONONTETHPORTPERF)

Usage Note
● The OLT and ONT must be online.
● The OLT is in profile mode and supports GPON services.

Command Format
LST-GPONONTETHPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id,ONTPORTID=ont-portid:CTAG::;

Supporting Device
Device Type No. Type

249 MA5600T

34 MA5680T

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1139


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1140


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTPORTID INTEGER 0-31 Indicates the N/A


ONT Ethernet
port ID.

Enter either the device ID or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Eth Port of ONT Performance info of device " +device-name
name of attributes: DID FN SN PN ONTID ONTPORTID INOCTES INUCASTPKTS INDISCARDS INERRORS
OUTOCTES OUTUCASTPKTS OUTDISCARDS OUTERRORS TxRate RxRate

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPORTID INTEGER 0-31 Indicates the ONT


Ethernet port ID.

INOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
received.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1141


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

INUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets received.

INDISCARDS INTEGER 0-1844674407370 Indicates the total


9551615 number of
dropped packets
received.

INERRORS INTEGER 0-1844674407370 Indicates the total


9551615 number of error
packets received.

OUTOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
transmitted.

OUTUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets
transmitted.

OUTDISCARDS INTEGER 0 Indicates the total


number of
dropped packets
transmitted.

OUTERRORS INTEGER 0-1844674407370 Indicates the total


9551615 number of error
packets
transmitted.

TxRate INTEGER 0-1844674407370 Indicates the rate


9551615 of bytes
transmitted.

RxRate INTEGER 0-1844674407370 Indicates the rate


9551615 of bytes received.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1142


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query the performance data of Ethernet port 1 on ONT 0 connected to port
0/6/0 on the device named 10.167.223.118, run the following command:
LST-
GPONONTETHPORTPERF::DEV=10.167.223.118,FN=0,SN=6,PN=0,ONTID=0,ONT
PORTID=1:CTAG::;
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1143


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340223 2011-08-16 14:47:05


M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Eth Port of ONT Performance info of device 10.167.223.118


------------------------------------------------------------------------------------------------------------------------------
----
DID FN SN PN ONTID ONTPORTID INOCTES INUCASTPKTS INDISCARDS INERRORS OUTOCTES
OUTUCASTPKTS OUTDISCARDS OUTERRORS TxRate RxRate
7340223 0 6 0 0 1 36774 0 0 0 116144 0 0 0 0 0
------------------------------------------------------------------------------------------------------------------------------
----
;

Related Command
None

14.8.23 Querying the ONT WAN Port Information (LST-


ONTWAN)

Usage Note
This command is used to query the ONT WAN port information. Query at levels
other than ONT (NE, board, or port level) supports GPON query only, and all the
query results are obtained from the database. Information that is not contained in
the database is displayed as --. For third-party ONTs (non-Huawei ONTs), only
basic information is displayed. Other information is displayed as --.

Command Format
LST-ONTWAN::(DID=Device-ID|DEV=Device-name),((((FN=frame-id,SN=slot-id,PN=port-id,ONTID=ont-id)|
(ONTKEY=ontkey))[,WANIPADDR=WANIP])|([,FN=Frame-id][,SN=Slot-id][,PN=Port-id])):CTAG::
[SHOWOPTION=WANID WANNAME WANIPADDR WANSUBMASK WANVLAN WANGW ADDTYPE
DNSENABLE DNSSVR PPPOEUSER WANMAC];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T V800R007C01 and later


versions

2331 MA5608T

249 MA5600T V800R007C01 and later


versions

2348 MA5683T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1144


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


OLT ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID of
the OLT.

SN INTEGER 0-35 Indicates the N/A


slot ID of the
OLT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1145


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PN INTEGER 0-63 Indicates the N/A


port ID of the
OLT.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI NOTE
port is of 10G For GPBD
GPON, the boards, the
value range is value ranges
0-255; if the from 0 to 127.
UNI port is of For GPBC
1G GPON, the boards, the
value range is value ranges
0-127. from 0 to 63.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1146


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET ● The range Indicates the N/A


STRING of the ONT key. An
value is ONT is
SIZE (36) located
when the according to
GPON_PW the device
D_FORMA and the ONT
T_IN_DB is key.
set to 0. This
● the range parameter
of the can contain
value is the following
SIZE (72) characters:
when the ● English
GPON_PW letters: a
D_FORMA to z and A
T_IN_DB is to Z
set to 1.
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If you set this
parameter,
you do not
need to set
the FN, SN,
PN, and
ONTID
parameters.

WANIPADDR IPADDRESS - Indicates the -


static IP
address of the
WAN port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1147


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● WANID Specifies the -


N STRING ● WANNAM attributes
E that can be
displayed in
● WANIPAD the returned
DR result.
● WANSUBM If the values
ASK of
● WANVLAN SHOWOPTIO
● WANGW N include
PPPOEUSER,
● ADDTYPE WANID, and
● DNSENABL WANNAME,
E only these
● DNSSVR three
parameters
● PPPOEUSE
are queried. If
R
the values of
● WANMAC SHOWOPTIO
N do not
include
PPPOEUSER,
relevant
parameters
are queried
based on the
value entered
for
SHOWOPTIO
N.
NOTE
This
parameter is
mandatory
when
WANIPADDR
is not set.

Set the parameters specified in one of the following items:


● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT key
● Device ID and ONT key

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1148


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

● Query at ONT level:


title="ONT POTS attributes of the device "+device-name
name of attributes: DID FN SN PN ONTID WANID WANNAME WANIPADDR
WANSUBMASK WANVLAN WANGW ADDTYPE DNSENABLE DNSSVR PPPOEUSER WANMAC

● Query at levels other than ONT (NE, board, or port level):


title="ONT WAN attributes of the device"
name of attributes: DID FN SN PN ONTID WANID WANNAME WANIPADDR
WANSUBMASK WANVLAN WANGW ADDTYPE DNSENABLE DNSSVR PPPOEUSER WANMAC
VENDORID EQUIPMENTID SERIALNUM

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID of the
OLT.

FN INTEGER 0-255 Indicates the


subrack ID of the
OLT.

SN INTEGER 0-35 Indicates the slot


ID of the OLT.

PN INTEGER 0-63 Indicates the port


ID of the OLT.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is NOTE
of 10G GPON, the For GPBD boards,
value range is the value ranges
0-255; if the UNI from 0 to 127. For
port is of 1G GPBC boards, the
GPON, the value value ranges from
range is 0-127. 0 to 63.

WANID INTEGER 1-4 Indicates the ID of


the WAN port.

WANNAME OCTET STRING SIZE (256) Indicates the


name of the WAN
port.

WANIPADDR IPADDRESS - Indicates the IP


address of the
WAN port.

WANSUBMASK IPADDRESS - Indicates the


subnet mask of
the WAN port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1149


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

WANVLAN INTEGER 1-4095 Indicates the


VLAN ID of the
WAN port.

WANGW IPADDRESS - Indicates the


gateway of the
WAN port.

ADDTYPE OCTET STRING Static Indicates the


DHCP address type of
the WAN port.

DNSENABLE OCTET STRING Enable Specifies whether


Disable the DNS server is
enabled.

DNSSVR OCTET STRING SIZE (64) Indicates the


name of the DNS
server.
DNS server names
are separated by
underscores (_).

PPPOEUSER OCTET STRING SIZE (32) Indicates the


PPPoE username.

WANMAC OCTET STRING SIZE (17) Indicates the MAC


Address of the
WAN port. The
address format is
XX-XX-XX-XX-XX-
XX.

VENDORID OCTET STRING SIZE (40) Indicates the


vendor ID, which
is displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONT


type, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1150


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number,
which is displayed
only when ONT
WAN port
information is
queried at non-
ONT levels.

Error Code
ID Description Solution

2686058552 The resource does not Check whether the input


exist. command is correct as
follows: The
● ONT corresponding to
the location
information such as
FN, SN, PN, and
ONTID in the input
parameter exist.
● An IP address is
configured for the
ONT WAN port. If the
● WANIPADDR
parameter is specified
in the command,
ensure that the IP
address is configured
on the ONT WAN
port.

Example
● To query the information about the WAN port of ONT 20 connected to port
0/16/4 on the device named 10.78.217.111, run the following command:
LST-
ONTWAN::DEV=10.78.217.111,FN=0,SN=16,PN=4,ONTID=20,WANIPADDR=
10.10.10.1:{$CTAG}::SHOWOPTION=WANID WANNAME WANIPADDR
WANSUBMASK WANVLAN WANGW;
The returned result is as follows:
7340074 2011-06-16 09:55:38
M {$CTAG} COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1151


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktotal=1

ONT POTS attributes of the device 10.78.217.111


--------------------------------------------------------------------
DID FN SN PN ONTID WANID WANNAME WANIPADDR WANSUBMASK
WANVLAN WANGW
7340074 0 16 4 20 1 wan1 10.10.10.1 -- 665 10.10.10.10
--------------------------------------------------------------------
;
● To query the information about the WAN port on the device named
10.71.59.65:
– run the following command:
LST-ONTWAN::DEV=10.71.59.65:6::;
– The returned result is as follows:

0 2016-12-24 19:23:31
M COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=65
blktotal=65

ONT WAN attributes of the device


----------------------------------------------------------------------------------------------------------------
---------------
DID FN SN PN ONTID WANID WANNAME WANIPADDR WANSUBMASK
WANVLAN WANGW PPPOEUSER VENDORID EQUIPMENTID SERIALNUM
7342239 0 2 0 0 -- -- -- -- -- -- -- -1 -- FFFFFFFF02005E2B
7342239 0 2 0 1 -- -- -- -- -- -- -- -1 -- FFFFFFFF02008DB6
7342239 0 2 0 2 -- -- -- -- -- -- -- -1 -- FFFFFFFF0200D655
7342239 0 2 0 3 -- -- -- -- -- -- -- -1 -- FFFFFFFF0200B91C
7342239 0 13 0 0 -- -- -- -- -- -- -- -1 -- FFFFFFFF130089A0
7342239 0 13 0 1 -- -- -- -- -- -- -- 1515472199 F660V3
5A544547C03989ED
7342239 0 13 0 2 -- -- -- -- -- -- -- 1515472199 F660V3
5A544547C0803A60
7342239 0 13 0 3 -- -- -- -- -- -- -- 1515472199 F609V5.2
5A544547C6710441
7342239 0 13 0 4 -- -- -- -- -- -- -- 1515472199 F609V5.2
5A544547C0D43935
7342239 0 13 1 11 -- -- -- -- -- -- -- 1515472199 F660V3
5A544547C05E7EFE
7342239 0 13 1 24 -- -- -- -- -- -- -- 2011 HG8245A
48575443E909743B
----------------------------------------------------------------------------------------------------------------
---------------

Related Command
None

14.8.24 Querying the ONT WAN Port Information (LST-ONT-


WANINFO)
Usage Note
This command is used to query the ONT WAN port information. Query at levels
other than ONT (NE, board, or port level) supports GPON query only, and all the

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1152


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

query results are obtained from the database. Information that is not contained in
the database is displayed as --. For third-party ONTs (non-Huawei ONTs), only
basic information is displayed. Other information is displayed as --.

Command Format
LST-ONT-WANINFO::[NAME=onu-name|ONTSN=ont-serianu|PWD=ont-password|LOID=loid] |((DID=Device-
ID|DEV=Device-name),FN=frame-id,SN=slot-id,PN=port-id[,ONTID=ont-id]):CTAG::
[SHOWOPTION=IPV6SWITCH IPV6ADDR IPV6ADDSTATUS IPV6ADDTYPE IPV6CONNSTATUS IPV6MVLAN
IPV6PRIMARYDNS IPV6SECONDDNS];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

95 MA5603T V800R007C01 and later


versions

2331 MA5608T

249 MA5600T V800R007C01 and later


versions

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2371/2372/2398/2399 MA5801-GP08/MA5801-CG04/
EA5801-GP08/EA5801-CG04/MA5801-
FL16/MA5801S-FL16

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

2389/2390/2391 MA5800C-X16/MA5800C-X6/
MA5800C-X14

Input Parameter
Parameter Type Range Description Default

NAME OCTET SIZE (1-255) ONU name -


STRING

ONTSN OCTET SIZE (16) ONT sn -


STRING

PWD OCTET SIZE (72) ONU -


STRING password

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1153


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LOID OCTET SIZE (24) ONU loid -


STRING

DID INTEGER - Indicates the -


OLT ID.

DEV OCTET SIZE (192) Indicates the -


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack ID of
the OLT.

SN INTEGER 0-35 Indicates the -


slot ID of the
OLT.

PN INTEGER 0-63 Indicates the -


ONTID INTEGER 0-255 port ID of the -
OLT.
Indicates the
ONT ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1154


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID of the
OLT.

DEVNAME OCTET STRING - device name.

DEVIP OCTET STRING - device ip.

FN INTEGER 0-255 Indicates the


subrack ID of the
OLT.

SN INTEGER 0-35 Indicates the slot


ID of the OLT.

PN INTEGER 0-63 Indicates the port


ID of the OLT.

ONTID INTEGER 0-255 Indicates the ONT


ID.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONT


type.

MAINSOFTVERSI OCTET STRING SIZE (14) Indicates the


ON software version.

AUTH OCTET STRING ● SN Indicates the


● SN_PASSWOR authentication
D mode.
● ALWAYS_ON
● ONCE_ON
● LOID
● LOID_ONCEON
● LOID_CHECKC
ODE
● LOID_CHECKC
ODE_ONCEON

ONTSN OCTET STRING SIZE (16) Indicates the


serial number.

PWD OCTET STRING SIZE (72) Indicates the


password.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1155


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LOID OCTET STRING SIZE (24) Indicates the


logical
authentication
code of the ONT.

CHECKCODE OCTET STRING SIZE (12) Indicates the


logical verification
code.

WANID INTEGER 1-4 Indicates the ID of


the WAN port.

WANNAME OCTET STRING SIZE (256) Indicates the


name of the WAN
port.

SRVTYPE OCTET STRING ● INTERNET Indicates the


● TR069 service type of the
WAN port.
● VOIP
● TR069_INTERN
ET
● TR069_VOIP
● TR069_VOIP_I
NTERNET
● VOIP_INTERNE
T
● IPTV
● Other
● TR069_IPTV
● TR069_VOIP_IP
TV
● VOIP_IPTV
● MAINTENANC
E
● IPTV_INTERNE
T
● VOIP_IPTV_INT
ERNET
● TR069_IPTV_IN
TERNET
● TR069_VOIP_IP
TV_INTERNET

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1156


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CONNTYPE OCTET STRING ● Unconfigured Indicates the


● IP_Routed Connect type of
the WAN port.
● IP_Bridged
● PPPoE_Bridged

CONNSTATUS OCTET STRING ● Unconfigured Indicates the


● Connecting Connect Status of
the WAN port.
● Connected
● Pending
● Disconneting
● Disconnected

ADDTYPE OCTET STRING ● INVAILD Indicates the


● DHCP address type.
● Static
● PPPoE

WANIPADDR IPADDRESS - Indicates the IP


address of the
WAN port.

WANSUBMASK IPADDRESS - Indicates the


subnet mask of
the WAN port.

WANGW IPADDRESS - Indicates the


gateway of the
WAN port.

WANVLAN INTEGER 1-4095 Indicates the


VLAN ID of the
WAN port.

WANPRIORITY INTEGER 0-7 Indicates the


priority of the
WAN port.

Option60 OCTET STRING ● ENABLE Option60.


● DISABLE

WANSWITCH OCTET STRING ● ENABLE Enable or disable


● DISABLE of the WAN port.

WANMAC OCTET STRING - Indicates the MAC


Address of the
WAN port. The
address format is
XX-XX-XX-XX-XX-
XX.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1157


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NATSWITCH OCTET STRING ● ENABLE NAT switch of the


● DISABLE WAN port.

IPV4SWITCH OCTET STRING ● ENABLE Enable or disable


● DISABLE of the IPv4.

IPV6SWITCH OCTET STRING ● ENABLE Enable or disable


● DISABLE of the IPv6.

IPV6ADDR IPADDRESS - IPv6 Address.

IPV6ADDSTATUS OCTET STRING ● INVALID Obtaining the


● Preferred IPv6 status.
● NoPrefix
● Unknown

IPV6ADDTYPE OCTET STRING ● INVALID Obtaining the


● AutoConfigure IPv6 Address.
● DHCPv6
● Static
● None

IPV6CONNSTATU OCTET STRING ● Unknown IPV6 connect


S ● Connecting status.
● Connected
● Pending
● Disconneting
● Disconnected
● Invalid

WANMVLAN INTEGER 1-4095 Multicast VLAN ID


of the WAN port.

IPV6MVLAN INTEGER 1-4095 IPv6 Multicast


VLAN ID of the
WAN port.

PRIMARYDNS OCTET STRING - primary DNS.

SECONDDNS OCTET STRING - second DNS.

IPV6PRIMARYDNS OCTET STRING - IPv6 primary DNS.

IPV6SECONDDNS OCTET STRING - IPv6 second DNS.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1158


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not Check whether the input


exist. command is correct as
follows:
● The ONT
corresponding to the
location information
such as FN, SN, PN,
and ONTID in the
input parameter exist.
● An IP address is
configured for the
ONT WAN port.
● If the WANIPADDR
parameter is specified
in the command,
ensure that the IP
address is configured
on the ONT WAN
port.

Example
● To query the information about the WAN port of ONT 3 connected to port
0/14/0 on the device named 6.3.26.111, run the following command:
– LST-ONT-
WANINFO::DEV=6.3.26.111,FN=0,SN=14,PN=0,ONTID=3:CTAG::SHOWOPT
ION=IPV6SWITCH IPV6ADDR IPV6ADDSTATUS IPV6ADDTYPE
IPV6CONNSTATUS IPV6MVLAN IPV6PRIMARYDNS IPV6SECONDDNS;
The returned result is as follows:
7341755 2019-09-25 10:20:08
M {$CTAG} COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ONT WAN info of the device 6.3.26.111


--------------------------------------------------------------------
DID DEVNAME DEVIP FN SN PN ONTID VENDORID EQUIPMENTID
MAINSOFTVERSION AUTH ONTSN PWD LOID CHECKCODE WANID WANNAME
SRVTYPE CONNTYPE CONNSTATUS ADDTYPE WANIPADDR WANSUBMASK WANGW
WANVLAN WANPRIORITY Option60 WANSWITCH WANMAC NATSWITCH IPV4SWITCH
IPV6SWITCH IPV6ADDR IPV6ADDSTATUS IPV6ADDTYPE IPV6CONNSTATUS WANMVLAN
IPV6MVLAN PRIMARYDNS SECONDDNS IPV6PRIMARYDNS IPV6SECONDDNS
7341755 6.3.26.111 6.3.26.111 0 14 0 3 HWTC HG8245H V3R013C00S106 SN
48575443A8E8B291 -- -- -- 1 huawei VOIP IP_Routed Disconnected DHCP
0.0.0.0 0.0.0.0 0.0.0.0 1 0 DISABLE ENABLE 04-25-C5-A8-E8-B3 -- ENABLE
DISABLE 0000:0000:0000:0000:0000:0000:0000:0000 INVALID INVALID -- -- -- -- --
-- --
--------------------------------------------------------------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1159


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.25 Querying ONT SIP User Accounts (LST-ONTSIPINFO)

Usage Note
This command is used to query the registration username, password, and
registration username of the SIP user ports. Query at levels other than ONT (NE,
board, or port level) supports GPON query only, and all the query results are
obtained from the database. Information that is not contained in the database is
displayed as --. For third-party ONTs (non-Huawei ONTs), only basic information
is displayed. Other information is displayed as --.

Command Format
LST-ONTSIPINFO::(DID=Device-ID|DEV=Device-name),((((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ont-key))[,SIPUSERNAME=Sip-userName])|([,FN=Frame-id][,SN=Slot-id][,PN=Port-id])):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T V800R008C00 and later


versions

249 MA5600T V800R008C00 and later


versions

2331 MA5608T

95 MA5603T V800R008C00 and later


versions

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1160


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
GPON or 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G GPON or
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1161


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET ● The range Indicates the N/A


STRING of the EPON ONT
value is key or the
SIZE (36) GPON ONT
when the authenticatio
GPON_PW n password.
D_FORMA An ONT is
T_IN_DB is located
set to 0. according to
● the range the device
of the and the ONT
value is key. If you set
SIZE (72) this
when the parameter,
GPON_PW you do not
D_FORMA need to set
T_IN_DB is the FN, SN,
set to 1. PN, and
ONTID
parameters.
NOTE
For the EPON
ONT key:
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1162


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SIPUSERNAM OCTET SIZE (64) Indicates the N/A


E STRING registration
username of
a SIP user
port. This
value is a
phone
number.
NOTE
You may use
personal
information of
users when
configuring
the relevant
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.

Set the parameters specified in one of the following items:


● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT key
● Device ID and ONT key

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
● Query at ONT level
title="ONT SIP INFO: " + SIPUSERNAME
name of attributes: SIPUSERNAME SIPUSERPWD SIPNAME

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1163


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● Query at levels other than ONT (NE, board, or port level):


title="ONT POTS attributes of the device " + DID FN SN PN ONTID SIPUSERNAME
SIPUSERPWD SIPNAME VENDORID EQUIPMENTID SERIALNUM

Output Parameter
Parameter Type Range Description

SIPUSERNAME OCTET STRING SIZE (64) Indicates the


registration
username of a SIP
user port. This
value is a phone
number.

SIPUSERPWD OCTET STRING SIZE (64) Indicates the


password of a SIP
user port.

SIPNAME OCTET STRING SIZE (64) Indicates the


authentication
username of a SIP
user port.

DID INTEGER - Indicates the OLT


ID, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

FN INTEGER 0-255 Indicates the OLT


subrack ID, which
is displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

SN INTEGER 0-35 Indicates the OLT


slot ID, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

PN INTEGER 0-63 Indicates the OLT


port ID, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1164


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID, which is
If the UNI port is displayed only
of 10G GPON or when ONT WAN
10G EPON, the port information
value range is
is queried at non-
0-255; if the UNI
port is of 1G ONT levels.
GPON or 1G
EPON, the value
range is 0-127.

VENDORID OCTET STRING SIZE (40) Indicates the


vendor ID, which
is displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONT


type, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number,
which is displayed
only when ONT
WAN port
information is
queried at non-
ONT levels.

Error Code
ID Description Solution

2686058552 The resource does not The terminal does not


exist. exist. Verify that the
input parameters, such
as the device ID (or
device name), subrack
ID, slot ID, port ID, ONT
ID, and ONT key are
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1165


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
● Example 1: To query the ONT SIP user account on the device named
10.71.32.13, run the following command:
LST-
ONTSIPINFO::DEV=10.71.32.13,FN=0,SN=15,PN=0,ONTID=34,SIPUSERNAM
E=87654321:6::;
The returned result is as follows:
7340034 2010-11-20 13:55:45
M 6 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
ONT SIP INFO: 87654321
-------------------------------------------
SIPUSERNAME SIPUSERPWD SIPNAME
87654321 123456 AAA
-------------------------------------------
;

● Example 2: To query the ONT SIP user account on the device named
10.71.59.65, run the following command:
LST-ONTSIPINFO::DEV=10.71.59.65,FN=0,SN=2,PN=0:6::;
The returned result is as follows:
7342239 2017-02-26 11:23:30
M COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4

ONT POTS attributes of the device


-----------------------------------------------------------------------------------------------
DID FN SN PN ONTID SIPUSERNAME SIPUSERPWD SIPNAME VENDORID
EQUIPMENTID SERIALNUM
7342239 0 2 0 0 -- ****** -- -1 -- FFFFFFFF02005E2B
7342239 0 2 0 1 -- ****** -- -1 -- FFFFFFFF02008DB6
7342239 0 2 0 2 -- ****** -- -1 -- FFFFFFFF0200D655
7342239 0 2 0 3 -- ****** -- -1 -- FFFFFFFF0200B91C
-----------------------------------------------------------------------------------------------

Related Command
None

14.8.26 Querying GPON Line Profile Names (LST-


GPONLINEPROFILE)

Usage Note
This command is used to query names of NE-side GPON line profiles. To ensure
accurate query results, synchronize NE-side GPON line profiles to the NCE before
running this command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1166


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-GPONLINEPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=line-profile-name];

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

34 MA5680T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1167


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
GPON line
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="GPON LineProfile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1168


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a GPON
line profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
To query the GPON line profile whose name contains characters "aa" on the
device named 10.78.217.216, run the following command:
LST-GPONLINEPROFILE:::CTAG::DEV=10.78.217.216,PROFID=aa;
The result is as follows:
0 2010-11-17 11:28:51
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

GPON LineProfile of the Device


----------------
DID PROFID
7340032 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1169


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.27 Querying GPON Service Profile Names (LST-


GPONSRVPROFILE)
Usage Note
This command is used to query names of NE-side GPON service profiles. To ensure
accurate query results, synchronize NE-side GPON service profiles to the NCE
before running this command.

Command Format
LST-GPONSRVPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=service-profile-name];

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1170


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

PROFID OCTET SIZE (32) Indicates the -


STRING name of a
GPON service
profile.
You can
search for
profiles by
profile name
or some
characters in
the profile
name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="GPON ServiceProfile of the Device"
name of attributes: DID PROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1171


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

PROFID OCTET STRING SIZE (32) Indicates the


name of a GPON
service profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
To query the GPON service profile whose name contains characters "aa" on the
device named 10.78.217.216, run the following command:
LST-GPONSRVPROFILE:::CTAG::DEV=10.78.217.216,PROFID=aa;
The result is as follows:
0 2010-11-17 11:29:31
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

GPON ServiceProfile of the Device


----------------
DID PROFID
7340032 aa
----------------
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1172


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.28 Query the DHCP IP Configuration of an ONT (LST-


ONTIPCONFIG)
Usage Note
This command is only applicable to devices in the profile mode.

Command Format
LST-ONTIPCONFIG::(DID=Device-id|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Portid,ONTID=ont-
id:CTAG::[SHOWOPTION=IPINDEX IPADDRESS MASK GATEWAY PRIDNS SLAVEDNS VLANID PRIORITY
DSCPPRI];

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1173


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1174


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● IPINDEX Controls the -


N STRING ● IPADDRESS attributes to
be returned.
● MASK This
● GATEWAY parameter is
● PRIDNS optional. If
you set this
● SLAVEDNS parameter,
● VLANID the attributes
● PRIORITY specified will
be returned.
● DSCPPRI
For example,
if you set
SHOWOPTIO
N to
IPINDEX, IP
indexes will
be returned in
the response
message. If
you do not
set this
parameter,
the attributes
controlled by
this
parameter
will not be
returned.

● Enter either the device ID or the device name.


● Enter the subrack ID, slot ID, and port ID in order. For example, you can enter the slot ID
only after you enter the subrack ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT ipconfig information of the device"+device-name
DID FN SN PN ONTID IPCONFIGMODE IPINDEX IPADDRESS MASK GATEWAY
PRIDNS SLAVEDNS VLANID PRIORITY DSCPPRI

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1175


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

IPCONFIGMODE OCTET STRING DHCP Indicates the


STATIC mode in which an
ONT obtains IP
NONE addresses.
CFGFILE

IPINDEX INTEGER 0 Indicates the IP


1 index.

IPADDRESS OCTET STRING SIZE (0-255) Indicates the


static IP address.

MASK OCTET STRING SIZE (0-255) Indicates the


mask for the
static IP address.

GATEWAY OCTET STRING SIZE (0-255) Indicates the


gateway IP
address used for
ONT
management.

PRIDNS OCTET STRING SIZE (0-255) Indicates the IP


address of the
primary DNS
server.

SLAVEDNS OCTET STRING SIZE (0-255) Indicates the IP


address of the
secondary DNS
server.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1176


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

VLANID INTEGER 0-4095 Indicates the ID of


the ONT
management
VLAN.

PRIORITY INTEGER 0-7 Indicates the


254 priority of the
ONT
management
VLAN.
If
IPCONFIGMODE
is set to DHCP,
the value of this
parameter will be
254.

DSCPPRI INTEGER 0-7 Indicates the


default DSCP
priority of the
ONT
management
VLAN.

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

1610612764 Device timeout. Verify that the device


runs in the normal state.

2686058531 The device does not Verify that the device to


exist. which the command is
issued exists.

Example
To query the IPCONFIGMODE, IPINDEX, IPADDRESS, MASK, GATEWAY, PRIDNS,
SLAVEDNS, VLANID, PRIORITY, and DSCPPRI of ONT 0 connected to port 0/14/0
on the device named 10,144,195,226, run the following commands:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1177


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● LST-
ONTIPCONFIG::DEV=10.144.195.226,FN=0,SN=14,PN=0,ONTID=0:CTAG::SH
OWOPTION=IPINDEX IPADDRESS MASK GATEWAY PRIDNS SLAVEDNS
VLANID PRIORITY DSCPPRI;
● The result is as follows:
7340131 2011-05-23 15:07:37
M CTAG COMPLD
EN=0 ENDESC=Success.
blktag=1
blkcount=1
blktotal=1

ONT ipconfig information of the device 10.144.195.226


-----------------------------------------------------------------------------------------------------------------------
--
DID FN SN PN ONTID IPCONFIGMODE IPINDEX IPADDRESS MASK GATEWAY
PRIDNS SLAVEDNS VLANID PRIORITY DSCPPRI
7340122 0 14 0 0 STATIC 1 10.144.195.176 255.255.254.0 10.144.194.1 0.0.0.0
0.0.0.0 9 5 --
-----------------------------------------------------------------------------------------------------------------------
--
;

Related Command
None

14.8.29 Querying the VoIP Address of an ONT (LST-


ONTVAGVOIP)

Usage Note
This command is used to query the VoIP address of an ONT and the proxy IP
address of an IMS. Query at levels other than ONT (NE, board, or port level)
supports GPON query only, and all the query results are obtained from the
database. Information that is not contained in the database is displayed as --. For
third-party ONTs (non-Huawei ONTs), only basic information is displayed. Other
information is displayed as --.

Command Format
LST-ONTVAGVOIP::(DID=Device-id|DEV=Device-name),((((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ont-key))[,VAGNAME=vag-name])|([,FN=Frame-id][,SN=Slot-id][,PN=Port-id])):CTAG::
[SHOWOPTION=VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT SECPROXYIP
SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB INITJB INITFIXJB DTMF SGVLANID MGVLANID];

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

57 MA5606T

94 MA5603U

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1178


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1179


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
GPON or 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G GPON or
1G EPON, the
value range is
0-127.

ONTKEY OCTET ● The range Indicates the N/A


STRING of the EPON ONT
value is key.
SIZE (36)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 0.
● the range
of the
value is
SIZE (72)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 1.

VAGNAME OCTET SIZE (32) Indicates the N/A


STRING VAG name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1180


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET VAGID (Optional) N/A


N STRING VAGNAME Specifies the
attributes
SGIP that can be
MGIP displayed in
HOMEDOMAI the response.
N If you set this
parameter,
PROXYIP the
PROXYPORT corresponding
SECPROXYIP attributes are
displayed. By
SECPROXYPO
default, the
RT
attributes are
GWNAME not displayed.
LPORT
REGISPRD
MAXJB
MINJB
INITJB
INITFIXJB
DTMF
SGVLANID
MGVLANID

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT VAG attributes of the device "+device-name
DID FN SN PN ONTID VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT SECPROXYIP
SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB INITJB INITFIXJB DTMF SGVLANID MGVLANID

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the device ID.

FN INTEGER 0-255 Indicates the subrack ID.

SN INTEGER 0-35 Indicates the slot ID.

PN INTEGER 0-63 Indicates the port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1181


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT ID.


NOTE
If the UNI
port is of
10G GPON
or 10G
EPON, the
value range
is 0-255; if
the UNI port
is of 1G
GPON or 1G
EPON, the
value range
is 0-127.

VAGID INTEGER 0-16777215 Indicates VAG ID.

VAGNAME OCTET SIZE (32) Indicates the VAG name.


STRING

SGIP IPADDRESS - Indicates the IP address of the


WAN port associated with the
signaling gateway.

MGIP IPADDRESS - Indicates the IP address of the


WAN port associated with the
media gateway.

HOMEDOMAIN OCTET SIZE (32) Indicates the name of the home


STRING domain.

PROXYIP IPADDRESS - Indicates the IP address of the


proxy server.

PROXYPORT INTEGER 0-65535 Indicates the port ID of the


proxy server.

SECPROXYIP IPADDRESS - Indicates the IP address of the


secondary proxy server.

SECPROXYPOR INTEGER 0-65535 Indicates the port ID of the


T secondary proxy server.

GWNAME OCTET SIZE (32) Indicates the VAG name.


STRING

LPORT INTEGER 0-65535 Indicates the local port ID.

REGISPRD INTEGER 1-65534 Indicates the registered lifecycle.


Unit: second.

MAXJB INTEGER 1-200 Indicates the largest dynamic JB


value.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1182


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MINJB INTEGER 1-200 Indicates the smallest dynamic


JB value.

INITJB INTEGER 1-200 Indicates the initial dynamic JB


value.

INITFIXJB INTEGER 1-200 Indicates the initial fixed JB


value.

DTMF INTEGER InBand Indicates the DTMF transmission


RFC2833 mode.

SGVLANID INTEGER 1-4095 Indicates the VLAN ID of the


WAN port associated with the
signaling gateway.

MGVLANID INTEGER 1-4095 Indicates the VLAN ID of the


WAN port associated with the
media gateway.

Error Code
None

Example
● Example 1: To query the VoIP address of ONT 20 of port 0/16/4 on the device
named 10.78.217.111, run the following command:
LST-
ONTVAGVOIP::DEV=10.78.217.111,FN=0,SN=16,PN=4,ONTID=20:CTAG::SH
OWOPTION=VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP
PROXYPORT SECPROXYIP SECPROXYPORT LPORT SGVLANID MGVLANID;
The result is as follows:
7340074 2011-06-15 00:31:21
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ONT VAG attributes of the device 10.78.217.111


-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------------
DID FN SN PN ONTID VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT
SECPROXYIP SECPROXYPORT LPORT SGVLANID MGVLANID
7340074 0 16 4 20 1 vagf1 10.10.10.10 10.10.10.10 11.11.11.11 23.23.23.23 5060
22.22.22.22 5060 5060 201 201
-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------------

● Example 2: To query the VoIP address of port 0/2/0 on the device named
10.71.59.65, run the following command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1183


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

LST-
ONTVAGVOIP::DEV=10.71.59.65,FN=0,SN=2,PN=0:6::SHOWOPTION=VAGID
VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT SECPROXYIP
SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB INITJB
INITFIXJB DTMF SGVLANID MGVLANID;
The result is as follows:
1 2016-12-26 11:35:31
M COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4

ONT VAG attributes of the device


-----------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------
DID FN SN PN ONTID VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP
PROXYPORT SECPROXYIP SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB
INITJB INITFIXJB DTMF SGVLANID MGVLANID
7342239 0 2 0 0 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
7342239 0 2 0 1 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
7342239 0 2 0 2 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
7342239 0 2 0 3 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
-----------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------
;

Related Command
None

14.8.30 Querying the ONT PSTN User Information (LST-


ONTVOIPPSTNUSER)

Usage Note
None

Command Format
LST-ONTVOIPPSTNUSER::(DID=devid|DEV=devname),((FN=frame-id,SN=slot-id,PN=port-id,ONTID=ont-id)|
(ONTKEY=ontkey))[,ONTPORTID=ontportid]:CTAG::[OFFQRYFLAG=Enable|Disable][,SHOWOPTION=VAGID
VAGNAME DIALMODE RPOLARITY DCTIME USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD
HOTLINE USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1 CODECSENABLE1 CODECS2
PKTPERIOD2 PRIORITY2 CODECSENABLE2 CODECS3 PKTPERIOD3 PRIORITY3 CODECSENABLE3 CODECS4
PKTPERIOD4 PRIORITY4 CODECSENABLE4 FIXJTBF DGTSNDMODE ALIAS HOTLINENUMBER
HOTLINETIMER CALLWAITINGENABLE CALLTRANSFERENABLE MWIENABLE THREEWAYENABLE
CALLHOLDENABLE DATASOURCE];

Supporting Device
Device Type No. Device Type

34 MA5680T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1184


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

57 MA5606T

94 MA5603U

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1185


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FN INTEGER 0-255 Indicates the -


subrack ID.

SN INTEGER 0-35 Indicates the -


slot ID.

PN INTEGER 0-63 Indicates the -


port ID.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON or 10G name or ID,
EPON, the
and the
value range is
0-255; if the subrack, slot,
UNI port is of and port IDs
1G GPON or are used
1G EPON, the together to
value range is locate the
0-127.
ONT.

ONTKEY INTEGER ● The range Indicates the -


of the EPON ONU
value is key.
SIZE (36)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 0.
● the range
of the
value is
SIZE (72)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 1.

ONTPORTID INTEGER 1-16 Indicates the -


user port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1186


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

OFFQRYFLAG OCTET Enable Specifies Disable


STRING Disable whether to
enable the
offline query
functions.
This
parameter is
optional.
The options
are as follows:
● Enable:
indicates
that the
NCE can
query
informatio
n about
offline
ONTs.
● Disable:
indicates
that the
NCE
cannot
query
informatio
n about
offline
ONTs.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1187


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET VAGID Specifies the -


N STRING VAGNAME optional
attributes
DIALMODE that can be
RPOLARITY displayed in
DCTIME the returned
result. If you
USERPRIORIT do not set
Y this
DIGITMAP parameter,
DIRECTORYN the optional
O attributes are
not returned.
USERNM If you set this
USERPWD parameter,
HOTLINE the optional
attributes are
USERENABLE returned.
SENDGAIN Separate
RCVGAIN multiple
optional
CODECS1
attributes
PKTPERIOD1 with spaces.
PRIORITY1
CODECSENAB
LE1
CODECS2
PKTPERIOD2
PRIORITY2
CODECSENAB
LE2
CODECS3
PKTPERIOD3
PRIORITY3
CODECSENAB
LE3
CODECS4
PKTPERIOD4
PRIORITY4
CODECSENAB
LE4
FIXJTBF
DGTSNDMOD
E
ALIAS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1188


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

HOTLINENU
MBER
HOTLINETIME
R
CALLWAITING
ENABLE
CALLTRANSFE
RENABLE
MWIENABLE
THREEWAYEN
ABLE
CALLHOLDEN
ABLE
DATASOURCE

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=" ONT POTS attributes of the device "+device-name
name of attributes:
DID FN SN PN ONTID ONTPORTID VAGID VAGNAME DIALMODE RPOLARITY
DCTIME USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD HOTLINE
USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1 CODECSENABLE1
CODECS2 PKTPERIOD2 PRIORITY2 CODECSENABLE2 CODECS3 PKTPERIOD3 PRIORITY3
CODECSENABLE3 CODECS4 PKTPERIOD4 PRIORITY4 CODECSENABLE4 FIXJTBF
DGTSNDMODE ALIAS HOTLINENUMBER HOTLINETIMER CALLWAITINGENABLE
CALLTRANSFERENABLE MWIENABLE THREEWAYENABLE CALLHOLDENABLE DATASOURCE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1189


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

ONTPORTID INTEGER 1-2 Indicates the user


port ID.

VAGID INTEGER 1-64 Indicates the VAG


port ID.

VAGNAME OCTET STRING SIZE (64) Indicates the VAG


name.

DIALMODE OCTET STRING SIZE (32) Indicates the


dialup mode.

RPOLARITY INTEGER 0-1 Specifies whether


to reverse the
polarity after the
called party picks
up the phone.
The options are as
follows:
● 0: not reverse
● 1: reverse

DCTIME INTEGER 0-1000 Indicates the


terminal power-
off period.
Unit: ms.

USERPRIORITY INTEGER 0-1 Specifies whether


to enable user
priorities.
The options are as
follows:
● 0: disable
● 1: enable

DIGITMAP OCTET STRING SIZE (32) Indicates the


digitmap profile
name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1190


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DIRECTORYNO OCTET STRING SIZE (64) Indicates the user


telephone
number.

USERNM OCTET STRING SIZE (64) Indicates the


authentication
username.

USERPWD OCTET STRING SIZE (64) Indicates the


authentication
password.

HOTLINE INTEGER 0-1 Specifies whether


to enable hotlines.

USERENABLE OCTET STRING SIZE (32) Specifies whether


to enable POTS
users.

SENDGAIN OCTET STRING SIZE (32) Indicates the port


transmit gain.
Unit: db.

RCVGAIN OCTET STRING SIZE (32) Indicates the port


receive gain.
Unit: db.

CODECS1 OCTET STRING G.711MuLaw Indicates the first


G.711ALaw codec.
G.729
G.722

PKTPERIOD1 INTEGER 10 Indicates the first


20 packetization
duration.
30
Unit: ms.

PRIORITY1 INTEGER 1-100 Indicates priority


1.

CODECSENABLE1 OCTET STRING Enable Specifies whether


Disable to enable the first
codec.

CODECS2 OCTET STRING G.711MuLaw Indicates the


G.711ALaw second codec.
G.729
G.722

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1191


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PKTPERIOD2 INTEGER 10 Indicates the


20 second
packetization
30 duration.
Unit: ms.

PRIORITY2 INTEGER 1-100 Indicates priority


2.

CODECSENABLE2 OCTET STRING Enable Specifies whether


Disable to enable the
second codec.

CODECS3 OCTET STRING G.711MuLaw Indicates the third


G.711ALaw codec.
G.729
G.722

PKTPERIOD3 INTEGER 10 Indicates the third


20 packetization
duration.
30
Unit: ms.

PRIORITY3 INTEGER 1-100 Indicates priority


3.

CODECSENABLE3 OCTET STRING Enable Specifies whether


Disable to enable the
third codec.

CODECS4 OCTET STRING G.711MuLaw Indicates the


G.711ALaw fourth codec.
G.729
G.722

PKTPERIOD4 INTEGER 10 Indicates the


20 fourth
packetization
30 duration.
Unit: ms.

PRIORITY4 INTEGER 1-100 Indicates priority


4.

CODECSENABLE4 OCTET STRING Enable Specifies whether


Disable to enable the
fourth codec.

FIXJTBF OCTET STRING Enable Specifies whether


Disable to enable the JB
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1192


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DGTSNDMODE OCTET STRING En-Bloc Indicates the


OverlapMultipleIn mode of sending
vites the called
number.
OverlapInDialogu
e The options are as
follows:
● En-Bloc: sends
the called
number in full
digitmap
mode.
● OverlapMultipl
eInvites: sends
the called
number in
overlap mode
with multiple
INVITE
messages.
● OverlapInDialo
gue: sends the
called number
in overlap
mode in a
session.

ALIAS OCTET STRING SIZE (32) Indicates the ONT


POTS user alias.

HOTLINENUMBER OCTET STRING SIZE (32) Indicates the


hotline number.

HOTLINETIMER INTEGER 0-255 Indicates the


hotline delay.
Unit: s.

CALLWAITINGENA OCTET STRING Enable Specifies whether


BLE Disable to enable call
waiting.

CALLTRANSFEREN OCTET STRING Enable Specifies whether


ABLE Disable to enable call
transfer.

MWIENABLE OCTET STRING Enable Specifies whether


Disable to enable
message signal
lamp.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1193


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

THREEWAYENABL OCTET STRING Enable Specifies whether


E Disable to enable three
way call.

CALLHOLDENABL OCTET STRING Enable Specifies whether


E Disable to enable call
hold.

DATASOURCE OCTET STRING ONT Indicates the data


EMS source.
The options are as
follows:
● ONT: indicates
that data is
obtained from
ONTs.
● EMS: indicates
that data is
obtained from
the NCE.

Error Code
None

Example
To query the PSTN user information on the ONT POTS port 20 of port 0/16/4 on
the device named 10.78.217.111, run the following command:
LST-
ONTVOIPPSTNUSER::DEV=10.78.217.111,FN=0,SN=16,PN=4,ONTID=20:CTAG::S
HOWOPTION=VAGID VAGNAME DIALMODE RPOLARITY DCTIME
USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD HOTLINE
USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1
CODECSENABLE1 CODECS2 PKTPERIOD2 PRIORITY2 CODECSENABLE2
CODECS3 PKTPERIOD3 PRIORITY3 CODECSENABLE3 CODECS4 PKTPERIOD4
PRIORITY4 CODECSENABLE4 FIXJTBF DGTSNDMODE ALIAS HOTLINENUMBER
HOTLINETIMER;
The result is as follows:
7340074 2011-06-15 18:18:09
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2
ONT POTS attributes of the device 10.78.217.111
----------------------------------------------------------------
DID FN SN PN ONTID ONTPORTID VAGID VAGNAME DIALMODE RPOLARITY
DCTIME USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD HOTLINE
USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1 CODECSENABLE1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1194


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

CODECS2 PKTPERIOD2 PRIORITY2 CODECSENABLE2 CODECS3 PKTPERIOD3 PRIORITY3


CODECSENABLE3 CODECS4 PKTPERIOD4 PRIORITY4 CODECSENABLE4 FIXJTBF
DGTSNDMODE ALIAS HOTLINENUMBER HOTLINETIMER
7340074 0 16 4 20 1 1 First -- -- Disable Enabled 0db -3.5db G.
711MuLaw 20 1 Enable G.711ALaw 20 2 Enable G.729 20 3 Enable G.722 20
4 Enable
7340074 0 16 4 20 2 1 First -- -- Disable Enabled 0db -3.5db G.
711MuLaw 20 1 Enable G.711ALaw 20 2 Enable G.729 20 3 Enable G.722 20
4 Enable Disable OverlapMultipleInvites 111 123456 20
-------------------------------------------------------------------------------
;

Related Command
None

14.8.31 Querying the VLAN Switching Pair for an Ethernet


Port on a GPON ONT (LST-ONTETHVLANSWTICHPAIR)

Usage Note
The MA5600 V800R008C01SPC100-based V800R008C01SPH313 and later versions
in profile mode support this command.

Command Format
LST-ONTETHVLANSWTICHPAIR::(DID=Device-id|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id[,ONTPORTTYPE=port-type],ONTPORTID=port-id:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1195


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1196


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTPORTTYP OCTET ● MOCA Indicates the N/A


E STRING ● IPHOST ONT port
type.
● ETH
● VDSL2

ONTPORTID INTEGER 0-63 Indicates the N/A


ID of the port
on the ONT.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ont eth port vlan information "+device-name
name of attributes: DID FN SN PN ONTID ONTPORTTYPE ONTPORTID VLANCFGTYPE
CVLAN CPRI CENCAP SVLAN SPRI SPRIPOLICY

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPORTTYPE OCTET STRING ● MOCA Indicates the ONT


● IPHOST port type.
● ETH
● VDSL2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1197


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTPORTID INTEGER 0-63 Indicates the ID of


the port on the
ONT.
NOTE
If the
ONTPORTTYPE
parameter is not
specified, this
parameter is
considered the
Ethernet port ID by
default.

VLANCFGTYPE OCTET STRING ● TRANSLATION Indicates the type


● QINQ of the VLAN
switching pair.
● TRANSPARENT

CVLAN INTEGER ● 0-4095 Indicates the


● 65533 VLAN ID (user-
side VLAN ID)
● 65534 before the VLAN
is switched.
NOTE
● If VLAN is
UNTAGGED,
the value of
this parameter
i. If5533.
● If
VLANCFGTYPE
is
TRANSPARENT
, the value of
this parameter
is 65534.

CPRI INTEGER 0-7 Indicates the


priority (user-side
priority) before
the VLAN is
switched.

CENCAP OCTET STRING ● IPOE Indicates the user-


● PPPOE side service
encapsulation
type.

SVLAN INTEGER 0-4095 Indicates the


VLAN ID after the
VLAN is switched.

SPRI INTEGER 0-7 Indicates the


priority after the
VLAN is switched.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1198


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SPRIPOLICY OCTET STRING ● SPECIFY Indicates the


● USERCOS service-side
priority policy.
● DSCPMAPPING

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the VLAN switching pair of ONT 1 whose port ID is 1 and is connected to
port 0/7/0 on the device named 10.71.59.58, run the following command:
LST-
ONTETHVLANSWTICHPAIR::DEV=10.71.59.58,FN=0,SN=7,PN=0,ONTID=1,ONTP
ORTID=1:CTAG::;
The result is as follows:
7340085 2010-11-20 14:35:19
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=7
blktotal=7

ont eth port vlan information 10.71.59.58


-----------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID VLANCFGTYPE CVLAN CPRI
CENCAP SVLAN SPRI SPRIPOLICY
7340087 0 7 0 1 ETH 1 TRANSLATION 1 0 IPOE 1 0 DSCPMAPPING
7340087 0 7 0 1 ETH 1 TRANSLATION 1 1 IPOE 1 -- --
7340087 0 7 0 1 ETH 1 TRANSLATION 10 1 -- 10 0 SPECIFY
-----------------------------------------------------------------
;

Related Command
There is no related command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1199


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.32 Querying the Traffic Shaping Information of an ONT


Queue (LST-ONTQUEUESHAPING)
Usage Note
This command is used to query the traffic shaping information of ONTs or an ONT
queue.

Command Format
LST-ONTQUEUESHAPING::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|,NAME=ont-name))|ALIAS=ont-alias[,QUEUEID=queue-id]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T V800R010C00 and later


versions

94 MA5603U V800R010C00 and later


versions

95 MA5603T V800R010C00 and later


versions

2331 MA5608T V800R010C00 and later


versions

249 MA5600T V800R010C00 and later


versions

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1200


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON, the name or ID,
value range is
and the
0-255; if the
UNI port is of subrack, slot,
1G GPON, the and port IDs
value range is are used
0-127. together to
locate the
ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1201


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

NAME OCTET SIZE (255) Indicates the -


STRING name. This
parameter
and the
device name
or ID are used
to locate the
ONT.

ALIAS OCTET SIZE (128) Indicates the -


STRING alias. It is
used to locate
the ONT.

QUEUEID INTEGER 0-7 Indicates the -


queue ID of
traffic
shaping.
NOTE
MA5600
V800R011C00
and later
versions
support this
parameter.
GPON boards
except the
H801GPBC
and
H802GPBD
boards
support this
parameter.

You must set the parameters specified in one of the following items:
● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
If the value of a parameter is displayed as --, the symbol indicates an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Queue Shaping information of the device "+device-name
name of attributes:DID FN SN PN ONTID QUEUEID DOWNQUEUESHAPING

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1202


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID. This
If the UNI port is parameter, the
of 10G GPON, the device name or
value range is ID, and the
0-255; if the UNI
subrack, slot, and
port is of 1G
GPON, the value port IDs are used
range is 0-127. together to locate
the ONT.

QUEUEID INTEGER 0-7 Indicates the


queue ID of traffic
shaping.
NOTE
MA5600
V800R011C00 and
later versions
support this
parameter. GPON
boards except the
H801GPBC and
H802GPBD boards
support this
parameter.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1203


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DOWNQUEUESH OCTET STRING SIZE (32) Indicates the


APING name of the MEF
IP traffic profile
used for
downstream
traffic shaping.
NOTE
MA5600
V800R011C00 and
later versions
support this
parameter. GPON
boards except the
H801GPBC and
H802GPBD boards
support this
parameter.

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query traffic shaping information of ONT 1 whose queue ID is 0 and is
connected to port 0/6/3 on the device named MA5680T, run the following
command:
LST-
ONTQUEUESHAPING::DEV=MA5680T,FN=0,SN=6,PN=3,ONTID=1,QUEUEID=0:1::
;
The result is as follows:
7340126 2013-04-05 21:29:22
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Queue Shaping information of the device MA5680T


------------------------------------------------------
DID FN SN PN ONTID QUEUEID DOWNQUEUESHAPING
7340126 0 6 3 1 0 ip-traffic-table_2
------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1204


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.33 Querying the GPON Optical Module Information (LST-


GPONDDMINFO)

Usage Note
This command applies only to OLTs that work in profile mode.

Command Format
LST-GPONDDMINFO::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-num:CTAG::
[SHOWOPTION=10GPONOPTICSTXPOWER 10GPONOPTICSTXBIASCURR];

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1205


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

SHOWOPTIO OCTET ● 10GPONO (Optional) -


N STRING PTICSTXPO Specifies the
WER attributes
● 10GPONO that can be
PTICSTXBI displayed in
ASCURR the returned
result. If you
set this
parameter,
the
corresponding
attributes are
returned. By
default, the
attributes are
not displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1206


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Enter either the device ID or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon DDM information of the device "+device-name
name of attributes: DID FN SN PN OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR
OPTICSTEMP OPTICSVOL 10GPONOPTICSTXPOWER 10GPONOPTICSTXBIASCURR

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

OPTICSRXPOWER INTEGER -10000 to +10000 Indicates the


receive power of
the optical
module.
Unit: 0.01dBm.

OPTICSTXPOWER INTEGER -10000 to +10000 Indicates the


transmit power of
the optical
module.
Unit: 0.01dBm.

OPTICSTXBIASCU INTEGER 0-10000 Indicates the bias


RR current of the
optical module.
Unit: mA.

OPTICSTEMP INTEGER -100 to +300 Indicates the


temperature of
the optical
module.
Unit: °C.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1207


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTICSVOL INTEGER 0-10000 Indicates the


power supply
voltage of the
optical module.
Unit: 0.01 V.

10GPONOPTICST INTEGER -10000 to +10000 Indicates the 10G


XPOWER PON transmit
optical power.
Only the GPON
COMBO board
and H901CGID
board supports
this parameter.
Unit: 0.01dBm.

10GPONOPTICST INTEGER 0-10000 Indicates the 10G


XBIASCURR PON bias current.
Only the GPON
COMBO board
and H901CGID
board supports
this parameter.
Unit: mA.

Error Code
ID Description Solution

2686058531 The device does not ● Ensure that the device


exist. is successfully added
to the NCE.
● By default, the device
is located according
to 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 A.8 How to
Locate a Device
According to the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1208


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
the parameter value is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● The parameters are
entered in the correct
order.

2689007617 The instance does not Verify that the command


exist, or the feature is is correct according to
not supported or not the following
configured. requirements:
● Verify that the port
entered is a GPON
port.
● Verify that the port
entered exists.

Example
To query optical module information of port 0/2/3 on the device named
10.144.79.105, run the following command:

LST-GPONDDMINFO::DEV=10.144.79.105,FN=0,SN=2,PN=3:CTAG::;

The result is as follows:


7340037 2014-01-17 14:57:01
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Gpon DDM information of the device 10.144.79.105


-------------------------------------------------------------------------------------------
DID FN SN PN OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTEMP
OPTICSVOL
7340037 0 2 3 -- 388 43 43 316
-------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1209


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.34 Querying the Transmission Feature of a GPON NNI


Port (LST-GPONNNIPERF)

Usage Note
None

Command Format
LST-GPONNNIPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Port-id:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T V800R013C00 and later


versions

95 MA5603T V800R013C00 and later


versions

2331 MA5608T V800R013C00 and later


versions

249 MA5600T V800R013C00 and later


versions

96 MA5620 V800R308C00 and later


versions

97 MA5626 V800R308C00 and later


versions

100 MA5616 V800R308C00 and later


versions

2330 MA5633

2336 MA5821

2364 EA5821

2337 MA5822

2339 MA5818

2348 MA5683T

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1210


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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 SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-512 Indicates the -


subrack ID.

SN INTEGER 0-35 Indicates the -


slot ID.

PN INTEGER 0-63 Indicates the -


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1211


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Enter either the device ID or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Gpon NNI perf information of the device "+device-name
name of attributes: DID DEV FN SN PN TransmittedFrames ReceivedFrames TransmittedOctets
ReceivedOctets

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

FN INTEGER 0-512 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

TransmittedFrame DOUBLE 0-1844674407370 Indicates the


s 9551615 number of
transmitted
packets.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1212


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ReceivedFrames DOUBLE 0-1844674407370 Indicates the


9551615 number of
received packets.

TransmittedOctets DOUBLE 0-1844674407370 Indicates the


9551615 number of
transmitted bytes.

ReceivedOctets DOUBLE 0-1844674407370 Indicates the


9551615 number of
received bytes.

Error Code
ID Description Solution

2686058531 The device does not ● Ensure that the device


exist. is successfully added
to the NCE.
● By default, the device
is located according
to 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 A.8 How to
Locate a Device
According to the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1213


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
the parameter value is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● The parameters are
entered in the correct
order.

2689007617 The instance does not Verify that the command


exist, or the feature is is correct according to
not supported or not the following
configured. requirements:
● Verify that the port
entered is a GPON
NNI port.
● Verify that the port
entered exists.

Example
To query the transmission feature of port 0/0/1 on the device named
10.144.78.115, run the following command:
LST-GPONNNIPERF::DEV=10.144.78.115,FN=0,SN=0,PN=1:CTAG::;
The result is as follows:
7340040 2014-01-12 15:46:03
M CTAG COMPLD
EN=0 ENDESCSucceeded.
blktag=1
blkcount=1
blktotal=1

Gpon NNI perf information of the device 10.144.78.115


-------------------------------------------------------------------------------------------
DID DEV FN SN PN TransmittedFrames ReceivedFrames TransmittedOctets ReceivedOctets
7340040 10.144.78.115 0 0 1 18920261 5249606 25365034202 1011207636
-------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1214


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.35 Querying the First Idle GEM Port ID of GPON Ports


(LST-FRSTIDLGEM)

Usage Note
This function applies only to OLTs that work in discrete mode.

Command Format
LST-FRSTIDLGEM::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-num:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T V800R013C00 and later


versions

94 MA5603U V800R013C00 and later


versions

95 MA5603T V800R013C00 and later


versions

2331 MA5608T V800R013C00 and later


versions

249 MA5600T V800R013C00 and later


versions

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1215


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

You must set one of DID and DEV.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="The first idle gemport ID information of the device "+device-name
name of attributes: DID DEV FN SN PN FIRSTIDLEGEM

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1216


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

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 A.8
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.

FIRSTIDLEGEM INTEGER 128-3999 Indicates the GEM


port ID.

Error Code
None.

Example
To query the first idle GEM port ID of port 0/0/1 on NE 10.144.78.118, run the
following command:
LST-FRSTIDLGEM::DEV=10.144.78.118,FN=0,SN=0,PN=1:CTAG::;
The result is as follows:
7340040 2014-01-12 14:36:24
M CTAG COMPLD
EN=0 ENDESC=Succeeded.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1217


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktag=1
blkcount=1
blktotal=1

The first idle gemport ID information of the device 10.144.78.118


-------------------------------------------------------------------------------------------
DID DEV FN SN PN FIRSTIDLEGEM
7340040 10.144.78.118 0 0 1 130
-------------------------------------------------------------------------------------------

Related Command
There is no related command.

14.8.36 Exporting POTS Service Provisioning Statistical Files


(DMP-POTSPERF)

Usage Note
This command is used to export the number of provisioned POTS services for the
network-wide MA5600T, MA5603T, and MA5608T or ONTs under a specified OLT.
Users with phone numbers configured have been provisioned with POTS services.

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-POTSPERF:::CTAG::([DT=device-type][,DEV=Device-name]);

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

2331 MA5608T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1218


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Enter either the device type or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Path information of the device-type "+device-type
name of attributes: PATH

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1219


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

PATH OCTET STRING SIZE (255) Indicates the file


path. The file path
is /opt/backup/
ftpboot/
hfs_public/var/
access/dumpperf.
The file name is
similar to
POTS_MA5600T_
2014-01-21_23-1
4-09_n_m.csv,
where n indicates
the sequence
number of a file
and m indicates
the total number
of files. If the
Service node is
deployed in a
cluster, the
exported file is
stored on the
Common Service
node. If the
Service node is
deployed in
single-instance
mode, the
exported file is
stored on the
NMS node.
NOTE
If a CSV file is over
large, it will be
divided into
multiple smaller
ones. If only one
file exists, n or m is
not displayed, for
example,
POTS_MA5600T_2
014-01-21_23-14-
09.csv.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1220


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1615003650 Incorrect parameter Set DT to a supported


input. value.

Example
To export POTS service provisioning statistical files for the MA5600T, run the
following command:

● DMP-POTSPERF:::1::DT=249;
● The result is as follows:
-1 2014-03-12 14:49:07
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of the device-type MA5600T


---------
PATH
server : hfs_public/var/access/dumpperf/POTS_MA5600T_2014-03-12_14-49-07.csv
---------
;

Related Command
None

14.8.37 Exporting GPON ONT Online Status Statistical Files


(DMP-ONTPERF)

Usage Note
This command is used to export the online status information for the network-
wide MA5600T, MA5603T, and MA5608T or ONTs under a specified OLT.

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-ONTPERF:::CTAG::([DT=device-type][,DEV=Device-name]);

Supporting Device
Device Type No. Device Type

95 MA5603T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1221


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2331 MA5608T

249 MA5600T

Input Parameter
Parameter Type Range Description Default

DT INTEGER See Indicates the -


Supporting device type.
Device.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Enter either the device type or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Path information of the device-type "+device-type
name of attributes: PATH

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1222


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

PATH OCTET STRING SIZE (255) Indicates the file


path. The file path
is /opt/backup/
ftpboot/
hfs_public/var/
access/dumpperf.
The file name is
similar to
ONT_MA5600T_2
014-01-21_23-14-
09_n_m.csv,
where n indicates
the sequence
number of a file
and m indicates
the total number
of files. If the
Service node is
deployed in a
cluster, the
exported file is
stored on the
Common Service
node. If the
Service node is
deployed in
single-instance
mode, the
exported file is
stored on the
NMS node.
NOTE
a CSV file is over
large, it will be
divided into
multiple smaller
ones. If only one
file exists, n or m is
not displayed, for
example,
POTS_MA5600T_2
014-01-21_23-14-
09.csv.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1223


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1615003650 Incorrect parameter Set DT to a supported


input. value.

Example
To export GPON ONT online status statistical files for the MA5600T, run the
following command:
● DMP-ONTPERF:::1::DT=249;
● The result is as follows:
-1 2014-03-12 19:10:31
M 1 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of the device-type MA5600T


---------
PATH
server : hfs_public/var/access/dumpperf/ONT_MA5600T_2014-03-12_19-10-31.csv
---------
;

Related Command
None

14.8.38 Querying GPON MDU Replacement Tasks (LST-


ONTRM)
Usage Note
This command is used to query replacement tasks based on OLTs, OLT PON
boards, OLT PON ports, and MDUs.

Command Format
LST-ONTRM::[((DID=Device-ID|DEV=Device-name)[,][FN=Frame-id[,SN=Slot-id[,PN=Port-id[,ONTID=ont-id|
ONTSN=ont-SN]]]]|[PWD=password])|(ONUDID=Mdu-Device-id|ONUDEV=Mdu-Device-name)]:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1224


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The MDU can be located in the following methods:


● By OLT: DID/DEV
● By OLT PON board: DID/DEV+FN+SN
● By OLT PON port: DID/DEV+FN+SN+PN
● By MDU:
● DID/DEV+FN+SN+PN+ONTID
● DID/DEV+FN+SN+PN+ONTSN
● DID/DEV+PWD
● ONUDID
● ONUDEV

Supporting Device
Device Type No. Device Type

37 MA5662

34 MA5680T

57 MA5606T

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

2313 MA5652

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1225


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2317 MA5631

2318 MA5632

2319 MA5621

2320 MA5612A

2321 MA5669

2331 MA5608T

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2323 MA5622A V800R311C00 and later


versions

2324 MA5623 V800R311C00 and later


versions

2326 MA5623A V800R311C01 and later


versions

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

2337 MA5822

2338 MA5898

2339 MA5818

2340 MA5611S

2348 MA5683T

2351 MA5878

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1226


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 OLT device ID.

DEV OCTET SIZE (192) Indicates the -


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


OLT subrack
ID.

SN INTEGER 0-35 Indicates the -


OLT slot ID.

PN INTEGER 0-63 Indicates the -


OLT port ID.

ONTID INTEGER 0-127 Indicates the -


MDU ID.
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1227


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTSN OCTET SIZE (16) Indicates the -


STRING MDU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1228


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET ● When the Indicates the -


STRING configurati MDU
on item password.
GPON_PW
D_FORMA
T_IN_DB is
set to 0,
the
following
characters
are
allowed:
English: 26
case
insensitive
letters
Digits: 0-9
Special
characters:
!@#$
%^&*()-
and space
● When the
configurati
on item
GPON_PW
D_FORMA
T_IN_DB is
set to 1,
the
following
hexadecim
al
characters
are
allowed:
0-9, A-F,
and a-f
NOTE
For the OLTs
earlier than
V800R011C00,
the maximum
length of
password for
ONTs
connected to
the OLTs is 10
characters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1229


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONT.

ONUDID INTEGER 7340032-825 Indicates the -


3439 MDU device
ID.

ONUDEV OCTET SIZE (192) Indicates the -


STRING default MDU
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 A.8
How to
Locate a
Device
According to
the IP
Address.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONU Replace Mission information "
name of attributes:
ONUNAME ONUIP DCUPDATE NEEDPOLL STATUS STARTTIME FINISHTIME RESULT
FAILREASON

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1230


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

ONUNAME OCTET STRING SIZE (192) Indicates the ONU


device name.

ONUIP IPADDRESS - Indicates the ONU


device IP address.

DCUPDATE OCTET STRING ● TRUE Specifies whether


● FALSE to automatically
load the software
and data.

NEEDPOLL OCTET STRING ● TRUE Specifies whether


● FALSE to automatically
synchronize NE
data.

STATUS OCTET STRING ● Finished Indicates the


● Waiting for replacement
device replace status.
● Device
replaced
● Waiting for
upgrading
software and
loading data
● Upgrade
software and
load data
finished
● Waiting for
synchronize

STARTTIME OCTET STRING Format: YYYY- Indicates the start


MM-DD time of
HH:MM:SS replacement. The
time is in UTC
format.

FINISHTIME OCTET STRING Format: YYYY- Indicates the end


MM-DD time of
HH:MM:SS replacement. The
time is in UTC
format.

RESULT OCTET STRING ● Succeed Indicates the


● Failed replacement
results.
● Canceled

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1231


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FAILREASON OCTET STRING SIZE (1024) Indicates the


cause for a
replacement
failure.

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the list of MDU replacement tasks on the device named 10.144.252.48,
run the following command:
LST-ONTRM::DEV=10.144.252.48:CTAG::;
The result is as follows:
0 2014-07-25 10:09:47
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2

ONU Replace Mission information


------------------------------------------------------------------------------------------------------------------------------
---------------
ONUNAME ONUIP DCUPDATE NEEDPOLL STATUS STARTTIME FINISHTIME RESULT
FAILREASON
MA5628 10.144.195.203 TRUE TRUE Waiting for device replace 2014-07-25 08:42:35 -- -- --
10.144.252.48/Frame0/Slot3/Port2/OnuID4 10.144.195.175 TRUE TRUE Finished 2014-07-25
08:45:36 2014-07-25 08:46:49 Succeed --
------------------------------------------------------------------------------------------------------------------------------
---------------

Related Command
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1232


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.39 Querying Call Record of an ONT Pots (LST-


ONTPOTSCALLRECORD)
Usage Note
OLT and ONT device is online.

Command Format
LST-ONTPOTSCALLRECORD::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id,ONTPORTID=ont-portid:CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1233


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 ONT ID. -


0-255
NOTE
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

ONTPORTID INTEGER 1-32 ONT POTS ID. -

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1234


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=ont pots call record information " + device-name
name of attributes:DID FN SN PN ONTID ONTPOTSID RECORDINDEX STARTTIME
DURATION CALLTYPE CALLCODEC CALLERNUMBER CALLEENUMBER PACKETSSENT
PACKETSRECEIVED PACKETSLOST ROUNDTRIPDELAY RCVINTERARRIVJITTER MOSLQ

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 ONT ID.


0-255
NOTE
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPOTSID INTEGER 0-32 ONT POTS ID.

RECORDINDEX INTEGER 1-20 Indicates the


index of the call
record.

STARTTIME OCTET STRING SIZE (19) Indicates the start


time of the call,
YYYY-MM-DD
HH:MM:SS.

DURATION INTEGER - Indicates the


duration of the
call (unit: second).

CALLTYPE OCTET STRING OUTGOINGCALL Indicates the type


INCOMINGCALL of the call.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1235


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CALLCODEC OCTET STRING G.711U Indicates the


Reserved codec used in the
call.
G.726
GSM
G.723
DVI4-8K
DVI4-16K
LPC
G.711A
G.722
L16-2channels
L16-1channels
QCELP
CN
MPA
G.728
DVI4-11K
DVI4-22K
G.729
T.38

CALLERNUMBER OCTET STRING - Indicates the


calling number.

CALLEENUMBER OCTET STRING - Indicates the


called number.

PACKETSSENT INTEGER - Indicates the


number of
packets sent
during the call.

PACKETSRECEIVE INTEGER - Indicates the


D number of
packets received
during the call.

PACKETSLOST INTEGER - Indicates the


number of
packets discarded
during the call.

ROUNDTRIPDELA INTEGER - Indicates the loop


Y delay of the call
(unit: ms).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1236


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RCVINTERARRIVJI INTEGER - Indicates the jitter


TTER of the call in the
Rx direction (unit:
ms).

MOSLQ FLOAT - Indicates the


average MOS
value of the call.

Error Code
ID Description Solution

2686058552 The resource There no call record on ONT Pots.


does not exist.

Example
To query call record of the 4th pots of the 6th ont on PON port 0/5/4 on NE
10.144.195.165, run the following command:
LST-
ONTPOTSCALLRECORD::DEV=10.144.195.165,FN=0,SN=5,PN=4,ONTID=6,ONTP
ORTID=4:CTAG::;
The result is as follows:
7340223 2015-10-13 14:47:05
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ont pots call record information 10.144.195.165


------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
DID FN SN PN ONTID ONTPOTSID RECORDINDEX STARTTIME DURATION CALLTYPE
CALLCODEC CALLERNUMBER CALLEENUMBER PACKETSSENT PACKETSRECEIVED PACKETSLOST
ROUNDTRIPDELAY RCVINTERARRIVJITTER MOSLQ
7340185 0 5 4 6 4 1 2015-10-10 09:04:41 231 OUTGOINGCALL G.711A
****************** ****************** 22352 22351 0 0 0 4.4
7340185 0 5 4 6 4 2 2015-10-10 09:01:32 184 OUTGOINGCALL G.711A
****************** ****************** 17662 17666 0 0 0 4.4
7340185 0 5 4 6 4 3 2015-10-10 09:00:42 45 OUTGOINGCALL G.711A
****************** ****************** 3782 3785 0 0 0 4.4
7340185 0 5 4 6 4 4 2015-10-10 08:53:27 429 OUTGOINGCALL G.711A
****************** ****************** 42105 42106 0 0 0 4.4
7340185 0 5 4 6 4 5 2015-10-10 08:51:43 100 OUTGOINGCALL G.711A
****************** ****************** 9253 9255 0 0 0 4.4
7340185 0 5 4 6 4 6 2015-10-10 08:27:53 1412 OUTGOINGCALL G.711A
****************** ****************** 140466 140467 0 0 0 4.4
7340185 0 5 4 6 4 7 2015-10-10 08:23:57 231 OUTGOINGCALL G.711A
****************** ****************** 22346 22347 0 0 0 4.4
7340185 0 5 4 6 4 8 2015-10-10 08:20:21 211 OUTGOINGCALL G.711A
****************** ****************** 20357 20360 0 0 0 4.4

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1237


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340185 0 5 4 6 4 9 2015-10-10 08:19:23 54 OUTGOINGCALL G.711A


****************** ****************** 4710 4713 0 0 0 4.4
7340185 0 5 4 6 4 10 2015-10-10 08:19:21 1 OUTGOINGCALL G.711A
****************** ****************** 0 0 0 0 0 0
7340185 0 5 4 6 4 11 2015-10-10 08:12:08 429 OUTGOINGCALL G.711A
****************** ****************** 42076 42078 0 0 0 4.4
7340185 0 5 4 6 4 12 2015-10-10 08:12:05 0 OUTGOINGCALL G.711A
****************** ****************** 0 0 0 0 0 0
7340185 0 5 4 6 4 13 2015-10-10 08:10:23 100 OUTGOINGCALL G.711A
****************** ****************** 9252 18506 0 0 0 4.4
7340185 0 5 4 6 4 14 2015-10-10 07:46:05 1440 OUTGOINGCALL G.711A
****************** ****************** 143310 143310 0 0 0 4.4
7340185 0 5 4 6 4 15 2015-10-10 07:41:59 241 OUTGOINGCALL G.711A
****************** ****************** 23263 23263 0 0 0 4.4
7340185 0 5 4 6 4 16 2015-10-10 07:38:22 212 OUTGOINGCALL G.711A
****************** ****************** 20413 20416 0 0 0 4.4
7340185 0 5 4 6 4 17 2015-10-10 07:37:24 54 OUTGOINGCALL G.711A
****************** ****************** 4624 4626 0 0 0 4.4
7340185 0 5 4 6 4 18 2015-10-10 07:30:10 428 OUTGOINGCALL G.711A
****************** ****************** 42090 42091 0 0 0 4.4
7340185 0 5 4 6 4 19 2015-10-10 07:28:26 100 OUTGOINGCALL G.711A
****************** ****************** 9253 9255 0 0 0 4.4
7340185 0 5 4 6 4 20 2015-10-10 07:04:38 1408 OUTGOINGCALL G.711A
****************** ****************** 140030 140028 0 0 0 4.4
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
;

Related Command
There is no related command.

14.8.40 Querying Details About a Global GPON Line Profile


(LST-GLOBALGPONLINEPROFILEDETAIL)

Usage Note
This command is used to query the global GPON line profile Details.

Command Format
LST-GLOBALGPONLINEPROFILEDETAIL:::CTAG::(PROFILENAME=profile-name)
[,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1238


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

PROFILENAM OCTET SIZE (32) Indicates the -


E STRING name of the
global GPON
line profile.

SHOWOPTIO OCTET SCOPEPROFI (Optional) -


N STRING D Indicates the
device scope
profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes:PROFILENAME MAPMODE QOSMODE TCONT GEMPOR GEMMAP

Output Parameter
Parameter Type Range Description

PROFILENAME OCTET STRING SIZE (32) Indicates the


name of the
global GPON line
profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1239


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAPMODE OCTET STRING ● VLAN mapping-mode.


● 802.1p
● VLAN_802.1p
● PORT
● PORT_VLAN
● PORT_802.1p
● PORT_VLAN_8
02.1p
● E1T1
● IPOTS
● VLAN_IPOTS

QOSMODE OCTET STRING ● GEM-CAR qos-mode


● PRIORITY-
QUEUE
● FLOW-CAR

TCONT OCTET STRING (0-127)~SIZE the format


(32)~(0-127)~SIZ "tcontID~DBA
E (32)… profile name" as a
group and could
be repeat one
more

GEMPORT OCTET STRING (0-127)~(0-1023 the format


)~SIZE "TCONTID~GEMI
(32)~(0-127)~(0- D~CAR profile
1023)~SIZE (32)… name" as a group
and could be
repeat one more

GEMMAP OCTET STRING (0-127)~(0-1023 the format


)~(0-7)~(0-4095) "TCONTID~GEMI
… D~GEMMAPID~VL
AN" as a group
and could be
repeat one more

Error Code
ID Description Solution

2686058552 The resource does The required global GPON line profile
not exist. does not exist. In this case, verify that
the entered global GPON line profile is
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1240


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is ● The parameter values do not exceed
blank, or the the ranges of the parameters
parameter value is specified by the command.
wrong.
● The parameter names are correct.
● The parameters are entered in the
correct order.

Example
To query details about a global GPON line profile whose name is Test.

● run the following command:


LST-GLOBALGPONLINEPROFILEDETAIL:::CTAG::PROFILENAME=Test;
● The result is as follows:
0 2016-03-10 20:26:33
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Profile information
-----------------------------------------------------------
PROFILENAME MAPMODE QOSMODE TCONT GEMPOR GEMMAP
Test VLAN GEM-CAR dba71~5~dba301 5~4~gemcar301~4~5~gemcar301
4~5~4~401~4~5~5~400
-----------------------------------------------------------

Related Command
None

14.8.41 Querying a Global GPON Line Profile Name List (LST-


GLOBALGPONLINEPROFILENAME)

Usage Note
This command is used to query names of Global GPON Line Profiles.

Command Format
LST-GLOBALGPONLINEPROFILENAME:::CTAG::PROFILENAME=profile-name[,SCOPEPROFID=device-profile-
name];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1241


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

PROFILENAM OCTET SIZE (32) Indicates the -


E STRING name of the
global GPON
line profile.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes: PROFILENAME SCOPEPROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1242


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

PROFILENAME OCTET STRING SIZE (32) Indicates the


name of the
global GPON line
profile.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

2686058552 The resource does The required global GPON line profile
not exist. does not exist. In this case, verify that
the entered global GPON line profile is
correct.

2686058498 Missing, invalid Verify that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is ● The parameter values do not exceed
blank, or the the ranges of the parameters
parameter value is specified by the command.
wrong.
● The parameter names are correct.
● The parameters are entered in the
correct order.

Example
To query a global GPON line profile list whose name is Test.
● run the following command:
LST-GLOBALGPONLINEPROFILENAME:::CTAG::PROFILENAME=Test1;
● The result is as follows:
0 2016-03-10 16:27:13
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Profile information
-----------------------------
PROFILENAME SCOPEPROFID
Test1 Default
-----------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1243


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None

14.8.42 Querying Details About a Global GPON Service Profile


(LST-GLOBALGPONSRVPROFILEDETAIL)

Usage Note
This command is used to query details about a global GPON service profile. To
ensure the query accuracy, a global GPON service profile must have been created
before this command is run.

Command Format
LST-GLOBALGPONSRVPROFILEDETAIL:::CTAG::PROFILENAME=profile-
name[,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

PROFILENAM OCTET SIZE (32) Indicates the -


E STRING GPON service
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1244


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SCOPEPRO Specifies -


N STRING FID whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes: PROFILENAME MULTICASTFORWARDTAG MFTRANSLATIONVLAN POTSNUM
ETHNUM CATVNUM TDMNUM VDSL2NUM WIFINUM ETHVLAN IPHOSTVLAN SCOPEPROFID

Output Parameter
Parameter Type Range Description

PROFILENAME OCTET STRING SIZE (32) Indicates the


GPON service
profile name.

MULTICASTFORW OCTET STRING ● TAG- Indicates the


ARDTAG TRANSPARENT multicast
● TAG- forwarding mode.
TRANSLATION
● UNTAG
● UNCONCER

MFTRANSLATION OCTET STRING ● 1-4095 Indicates the


VLAN ● IGMP-USER- multicast
VLAN forwarding VLAN.

POTSNUM INTEGER 0-32 Indicates the


number of POTS
ports.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1245


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ETHNUM INTEGER 0-24 Indicates the


number of
Ethernet ports.

CATVNUM INTEGER 0-8 Indicates the


number of CATV
ports.

TDMNUM INTEGER 0-8 Indicates the


number of TDM
ports.

VDSL2NUM INTEGER 0-8 Indicates the


number of VDSL2
ports.

WIFINUM INTEGER 0-4 Indicates the


number of WI-FI
ports.

ETHVLAN OCTET STRING (1-4094)~(1-4094 Indicates the


)~(1-4094)~(1-40 default VLAN for
94)… the Ethernet port.
● Multiple
default VLANs
can be set. A
maximum of
300 values are
supported.
Separate
different port
VLAN IDs by
symbol (~).
The value of a
single VLAN ID
ranges from 1
to the
maximum
VLAN ID.

IPHOSTVLAN INTEGER 0-4095 Indicates the


default VLAN for
the IPhost port.

SCOPEPROFID OCTET STRING SIZE (32) Device scope


profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1246


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

102690873 The resource does Check whether the profile to be


not exist. queried exists.

Example
To query a GPON service profile whose name is AA, run the following command:
● LST-
GLOBALGPONSRVPROFILEDETAIL:::CTAG::PROFILENAME=AA,SHOWOPTIO
N=SCOPEPROFID;
● The result is as follows:
0 2016-03-10 15:54:28
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Profile information
-----------------------------------------------------------------------------------------------------------------------
----
PROFILENAME MULTICASTFORWARDTAG MFTRANSLATIONVLAN POTSNUM ETHNUM
CATVNUM TDMNUM VDSL2NUM WIFINUM ETHVLAN IPHOSTVLAN SCOPEPROFID
AA UNCONCER -- 0 0 0 0 0 0 -- -- Default
-----------------------------------------------------------------------------------------------------------------------
----

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1247


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.43 Querying a Global GPON Service Profile Name List


(LST-GLOBALGPONSRVPROFILENAME)

Usage Note
This command is used to query a global GPON service profile name list. To ensure
the query accuracy, a global GPON service profile must have been created before
this command is run.

Command Format
LST-GLOBALGPONSRVPROFILENAME:::CTAG::PROFILENAME=profile-name[,SCOPEPROFID=device-profile-
name];

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

PROFILENAM OCTET SIZE (32) Indicates the -


E STRING GPON service
profile name.

SCOPEPROFI OCTET SIZE (32) Indicates the -


D STRING device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1248


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes: PROFILENAME SCOPEPROFID

Output Parameter
Parameter Type Range Description

PROFILENAME OCTET STRING SIZE (32) Indicates the


GPON service
profile name.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

26860584 Missing, invalid Verify that the command is correct


98 parameter or according to the following requirements:
mandatory parameter ● The parameter values do not exceed
is blank, or the the ranges of the parameters specified
parameter value is by the command.
wrong.
● The parameter names are correct.
● The parameters are entered in the
correct order.

10269087 The resource does not Check whether the profile to be queried
3 exist. exists.

Example
To query a profile name list whose GPON service profile name is AA, run the
following command:
● LST-
GLOBALGPONSRVPROFILENAME:::CTAG::PROFILENAME=AA,SCOPEPROFID
=Default;
● The result is as follows:
0 2016-03-10 15:42:08
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1249


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Profile information
-----------------------------
PROFILENAME SCOPEPROFID
AA Default
-----------------------------

Related Command
None.

14.8.44 Querying Details About a Global GPON DBA Profile


(LST-GLOBALDBAPROFILEDETAIL)
Usage Note
This command is used to query details about a global GPON DBA profile.

Command Format
LST-GLOBALDBAPROFILEDETAIL:::CTAG::PROFILENAME=dba-profile-name[,SHOWOPTION=SCOPEPROFID];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1250


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

PROFILENAM OCTET SIZE (32) Indicates the -


E STRING GPON DBA
profile name.

SHOWOPTIO OCTET ● SCOPEPRO (Optional) -


N STRING FID Specifies
whether to
return the
optional
attribute. If
this
parameter is
set, the
optional
attribute will
be returned.
Otherwise,
the optional
attribute will
not be
returned.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information "
name of attributes:PROFILENAME TCONTTYPE ASSUREDBANDWIDTH FIXEDBANDWIDTH
MAXIMUMBANDWIDTH BANDWIDTHCOMPENSATION ADDITIONALBANDWITDTH
EFFORTPRIORITY EFFORTWEIGHT FIXEDDELAY SCOPEPROFID

Output Parameter
Parameter Type Range Description

PROFILENAME OCTET STRING SIZE (32) Indicates the


GPON DBA profile
name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1251


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TCONTTYPE OCTET STRING ● Fixed DBA type:


● Assured ● Fixed
● AssuredandMa bandwidth;
x ● Assured
● Max bandwidth;
● Mixed ● Assured
bandwidth/Ma
x bandwidth;
● Max
bandwidth;
● Mixed model.

ASSUREDBANDWI INTEGER 128-10000000 Indicates the


DTH assured
bandwidth.

FIXEDBANDWIDT INTEGER 128-10000000 Indicates the fixed


H bandwidth.

MAXIMUMBAND INTEGER 128-10000000 Indicates the max


WIDTH bandwidth.

BANDWIDTHCOM OCTET STRING ● YES Bandwidth


PENSATION ● NO compensation.

ADDITIONALBAN OCTET STRING ● Non-assure Additional


DWITDTH ● Best-effort bandwidth.

EFFORTPRIORITY INTEGER 0-3 Best-effort


priority.

EFFORTWEIGHT INTEGER 1-10000 Best-effort


weight.

FIXEDDELAY OCTET STRING ● YES Fixed delay.


● NO

SCOPEPROFID OCTET STRING SIZE (32) Device scope


profile.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1252


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

102690820 The DBA profile Check whether the profile to be


does not exist. queried exists.

Example
To create a GPON DBA profile whose name is TEST, run the following command:
● LST-
GLOBALDBAPROFILEDETAIL:::CTAG::PROFILENAME=TEST,SHOWOPTION=S
COPEPROFID;
● The result is as follows:
0 2016-03-14 15:00:54
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Profile information
-----------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------
PROFILENAME TCONTTYPE ASSUREDBANDWIDTH FIXEDBANDWIDTH
MAXIMUMBANDWIDTH BANDWIDTHCOMPENSATION ADDITIONALBANDWITDTH
EFFORTPRIORITY EFFORTWEIGHT FIXEDDELAY SCOPEPROFID
TEST Mixed 128 128 256 YES Best-effort 0 134 NO Default
-----------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1253


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.45 Querying a Global GPON DBA Profile Name List (LST-


GLOBALDBAPROFILENAME)

Usage Note
This command is used to query a global GPON DBA profile name list.

Command Format
LST-GLOBALDBAPROFILENAME:::CTAG::PROFILENAME=profile-name[,SCOPEPROFID=device-profile-name];

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

94 MA5603U

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2371/2372 EA5801-GP08/EA5801-CG04

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

PROFILENAM OCTET SIZE (32) Indicates the -


E STRING GPON DBA
profile name.

SCOPEPROFI OCTET SIZE (32) (Optional) -


D STRING Indicates the
device scope
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1254


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes:PROFILENAME SCOPEPROFID

Output Parameter
Parameter Type Range Description

PROFILENAME OCTET STRING SIZE (32) Indicates the


GPON service
profile name.

SCOPEPROFID OCTET STRING SIZE (32) Indicates the


device scope
profile name.

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

102690820 The DBA profile Check whether the profile to be


does not exist. queried exists.

Example
To create a GPON DBA profile whose name is TEST, run the following command:
● LST-
GLOBALDBAPROFILENAME:::CTAG::PROFILENAME=TEST,SCOPEPROFID=De
fault;
● The result is as follows:
0 2016-03-11 15:30:58
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1255


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blktotal=1

Profile information
-----------------------------
PROFILENAME SCOPEPROFID
TEST Default
-----------------------------

Related Command
None.

14.8.46 Querying the ONT WLAN Information (LST-


ONTUSERWLAN)
Usage Note
This command is used to query an ONT WLAN.

Command Format
LST-ONTUSERWLAN::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-MAC)|(NAME=ont-
name)):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1256


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1257


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTSN OCTET SIZE (16) Indicates the -


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXX
XX or 16-byte
character
string
XXXXXXXXXX
XXXXXX.

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1258


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry ONT Wi-Fi Configuration of the device"+device-name
name of attributes:DID FN SN PN ONTID SSIDINDEX STATE SSIDNAME DEVNUM
FREQUENCY VISIBLE BROADCAST WMM TRANPOWER DOMAIN CHANNEL
CHANNELWIDTH MODE AUTHMODE ENCRYMODE

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1259


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

STATE OCTET STRING ● Active Indicates the


● Deactive activation status
of an AP.

SSIDNAME OCTET STRING SIZE (32) Indicates the SSID


name.

DEVNUM INTEGER 1-128 Indicates the


number of Wi-Fi
devices connected
to the WLAN.

FREQUENCY OCTET STRING ● 2.4GHz Indicates the


● 5GHz frequency used by
the ONT to
provide Wi-Fi
access.

VISIBLE OCTET STRING ● Enable Specifies whether


● Disable SSIDs are visible
on web pages.

BROADCAST OCTET STRING ● Enable Specifies whether


● Disable to enable SSID
broadcasting.
NOTE
● enable
indicates that
SSID
broadcasting is
enabled. ONTs
will periodically
broadcast their
SSIDs, that is,
the WLAN
names. Any Wi-
Fi devices can
find the
WLANs.
● disable
indicates that
SSID
broadcasting is
disabled. ONTs
do not
broadcast their
SSIDs. Wi-Fi
devices cannot
find the
WLANs, and
can only apply
for SSIDs.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1260


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

WMM OCTET STRING ● Enable Specifies whether


● Disable to enable
multimedia.

TRANPOWER OCTET STRING ● 20% Indicates the


● 40% transmit power of
Wi-Fi signals.
● 60% Larger value
● 80% indicates better
● 100% signal coverage.

DOMAIN OCTET STRING SIZE (2) Indicates the


country code of
the wireless
network.B.16
Country and
Region
Abbreviations

CHANNEL OCTET STRING The options for Indicates the


the 2.4 GHz channel of a
frequency are as WLAN.
follows:
● Automatic
● 1-13
The options for
the 5 GHz
frequency are as
follows:
● Automatic
● 36-173

CHANNELWIDTH OCTET STRING The options for Indicates the


the 2.4 GHz wireless
frequency are as bandwidth.
follows:
● Auto 20/40
● 20MHz
● 40MHz
The options for
the 5 GHz
frequency are as
follows:
● Auto 20/40
● 20MHz
● 40MHz
● Auto 20/40/80

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1261


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MODE OCTET STRING The options for Indicates the


the 2.4 GHz supported
frequency are as wireless network
follows: mode.
● 802.11b
● 802.11g
● 802.11n
● 802.11b/g
● 802.11b/g/n
The options for
the 5 GHz
frequency are as
follows:
● 802.11a
● 802.11a/n
● 802.11a/n/ac
● 802.11b
● 802.11g
● 802.11n
● 802.11b/g
● 802.11b/g/n

AUTHMODE OCTET STRING ● Open Indicates the


● Shared authentication
mode for a Wi-Fi
● WPA Pre- device to access a
Shared Key WLAN.
● WPA2 Pre-
Shared Key
● WPA/WPA2
Pre-Shared Key
● WPA Enterprise
● WPA2
Enterprise
● WPA/WPA2
Enterprise

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1262


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ENCRYMODE OCTET STRING ● None Indicates the


● WEP encryption mode
for a Wi-Fi device
● AES to access a WLAN.
● TKIP The encryption
● TKIP&AES mode and
encryption
Relationship with parameters vary
other parameters: according to the
● If AUTHMODE authentication
is set to Open, mode.
ENCRYMODE
can be set to
None or WEP.
If
● AUTHMODE is
set to Shared,
ENCRYMODE
is WEP. If
● AUTHMODE is
set to WPA
Pre-Shared
Key, WPA2
Pre-Shared
Key, WPA/
WPA2 Pre-
Shared Key,
WPA
Enterprise,
WPA2
Enterprise, or
WPA/WPA2
Enterprise,
ENCRYMODE
can be set to
AES, TKIP, or
TKIP&AES.

Example
To Query the ONT WLAN information under port 0/15/0 on the device named
10.71.214.65, run the following command:
LST-ONTUSERWLAN::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=2:CTAG::;
The result is as follows:
7340038 2017-01-23 16:58:51
M CTAG COMPLD
EN=0 ENDESC=Succeed.
blktag=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1263


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blkcount=6
blktotal=6

Qry ONT Wi-Fi Configuration of the device 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------
DID FN SN PN ONTID SSIDINDEX STATE SSIDNAME DEVNUM FREQUENCY VISIBLE
BROADCAST WMM TRANPOWER DOMAIN CHANNEL CHANNELWIDTH MODE
AUTHMODE ENCRYMODE
7340038 0 15 0 2 1 Active STC1-2.4G 25 2.4GHz Enable Enable Enable 80%
CN Automatic 20MHz 802.11b/g/n WPA2 Pre-Shared Key AES
7340038 0 15 0 2 2 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
7340038 0 15 0 2 3 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
7340038 0 15 0 2 4 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
7340038 0 15 0 2 5 Active STC1-5G 25 5GHz Enable Enable Enable 80% CN
Automatic 20MHz 802.11a/n/ac WPA2 Pre-Shared Key AES
7340038 0 15 0 2 6 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------

Related Command
15.7.50 Configuring the ONT WLAN (CFG-ONTUSERWLAN)

14.8.47 Querying Wi-Fi Statistics (LST-ONTAPWIFISTATISTICS)

Usage Note
This command is used to query Wi-Fi statistics of an ONT.

Command Format
LST-ONTAPWIFISTATISTICS::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-
MAC)|(NAME=ont-name)),(SSIDINDEX=SsidIndex[,EAPID=EapID]):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1264


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1265


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1266


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) (Optional) -


STRING Indicates the
ONU alias.

SSIDINDEX INTEGER 1-8 Indicates the -


SSID index,
which is
mandatory.
NOTE
If EAPID is
left blank, the
Wi-Fi statistics
of a built-in
AP is queried.

EAPID INTEGER 1-8 Indicates the -


ID of an
external AP.
NOTE
This
parameter
must be
provisioned if
the Wi-Fi
statistics of an
external AP
needs to be
queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1267


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry the WIFI statistics of the device"+device-name
name of attributes: DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME
CONNECTDEVICES RECEIVEBYTES RECEIVEPKGS RECEIVEERRORPKGS TRANSBYTES TRANSPKGS
TRANSERRORPKGS TRANSDROPPKGS

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

SSIDNAME OCTET STRING SIZE (32) Indicates the SSID


name.

CONNECTDEVICE INTEGER 0-128 Indicates the


S number of
connected Wi-Fi
devices.

RECEIVEBYTES OCTET STRING SIZE (32) Indicates the total


number of
received bytes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1268


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RECEIVEPKGS OCTET STRING SIZE (32) Indicates the total


number of
received
packages.

RECEIVEERRORPK OCTET STRING SIZE (32) Indicates the


GS number of
received error
packages.

RECEIVEDROPPKG OCTET STRING SIZE (32) Indicates the


S number of
dropped packages
during package
receiving.

TRANSBYTES OCTET STRING SIZE (32) Indicates the total


number of
transmitted bytes.

TRANSPKGS OCTET STRING SIZE (32) Indicates the total


number of
transmit
packages.

TRANSERRORPKG OCTET STRING SIZE (32) Indicates the


S number of
transmitted error
packages.

TRANSDROPPKGS OCTET STRING SIZE (32) Indicates the


number of
dropped packages
during package
transmission.

Example
To query Wi-Fi statistics under port 0/15/0 on the device named 10.71.214.65, run
the following command:
LST-
ONTAPWIFISTATISTICS::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=1,SSIDIN
DEX=1:CTAG::;
The result is as follows:
7340033 2016-12-20 10:31:37
M CTAG COMPLD
EN=0 ENDESC=Succeed
blktag=1
blkcount=1
blktotal=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1269


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Qry the WIFI statistics of the device 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------
DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME CONNECTDEVICES RECEIVEBYTES
RECEIVEPKGS RECEIVEERRORPKGS RECEIVEDROPPKGS TRANSBYTES TRANSPKGS
TRANSERRORPKGS TRANSDROPPKGS
7340033 0 15 0 1 1 -- WirelessNet_8125-2.4GRRRRRRRRRRT 0 1511634 8036 0 0
51167389 290677 7 1065881
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------

Related Command
None.

14.8.48 Querying the Wi-Fi Device Information (LST-


ONTWIFIDEVICE)
Usage Note
This command is used to query the Wi-Fi device information of an ONT.

Command Format
LST-ONTWIFIDEVICE::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-MAC)|(NAME=ont-
name)),(SSIDINDEX=SsidIndex)[,EAPID=EapID]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1270


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


ONT ID.
ONTMAC and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1271


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If this
parameter is
set, you do
not need to
set the FN,
SN, PN,
ONTMAC,
and ONTID
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1272


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.
ONTMAC and
ONTID are
alternative
parameters.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1273


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.
NOTE
In the
command
format, the
PWD in front
of the CTAG
indicates the
location
information
(current ONU
password)
and the PWD
following the
CTAG
indicates the
ONU
password
after
replacement.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) (Optional) -


STRING Indicates the
ONU alias.

SSIDINDEX INTEGER 1-8 Indicates the -


SSID index.
NOTE
If EAPID is
left blank, the
Wi-Fi device
information of
a built-in AP
is queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1274


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

EAPID INTEGER 1-8 Indicates the -


ID of an
external AP.
NOTE
This
parameter
must be
provisioned if
the Wi-Fi
device
information of
an external
AP needs to
be queried.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry ONT Wi-Fi Configuration the device"+device-name
name of attributes: DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME MACADDR
ONLINEDURATION RECEIVERATE TRANSRATE SIGNAL NOISE SNR SIGNALQUALITY

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1275


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

SSIDNAME OCTET STRING SIZE (32) Indicates the SSID


name.

ONLINEDURATIO OCTET STRING SIZE (32) Indicates the


N online duration of
an external AP.
Unit: s

RECEIVERATE OCTET STRING SIZE (32) Indicates the


receive rate of a
Wi-Fi device.
Unit: Mbps

TRANSRATE OCTET STRING SIZE (32) Indicates the


transmit rate of a
Wi-Fi device.
Unit: Mbps

SIGNAL OCTET STRING SIZE (32) Indicates the


signal strength of
a Wi-Fi device.
Unit: dBm

NOISE OCTET STRING SIZE (32) Indicates the


noise that a Wi-Fi
device suffers.
Unit: dBm

SNR OCTET STRING SIZE (32) Indicates the SNR


of a Wi-Fi device.
Unit: dB

SIGNALQUALITY OCTET STRING SIZE (32) Indicates the


signal quality of a
Wi-Fi device.
Unit: dBm

Example
To query the Wi-Fi device information under port 0/15/0 on the device named
10.71.214.65, run the following command:
LST-
ONTWIFIDEVICE::DEV=PCCW_wudong,FN=0,SN=15,PN=0,ONTID=1,SSIDINDEX
=1,EAPID=4:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1276


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The result is as follows:


7340032 2016-12-20 17:49:50
M CTAG COMPLD
EN=0 ENDESC=Succeed.
blktag=1
blkcount=1
blktotal=1

Qry the Wi-Fi Device Info of ont user PCCW_wudong


------------------------------------------------------------------------------------------------------------------------------
-------------
DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME MACADDR ONLINEDURATION RECEIVERATE
TRANSRATE SIGNAL NOISE SNR SIGNALQUALITY
7340032 0 15 0 1 1 4 WirelessNet_8125-2.4GRRRRRRRRRRT 24:f0:94:c5:1d:2e 6640 24 - -47 - - 53
------------------------------------------------------------------------------------------------------------------------------
-------------

Related Command
None.

14.8.49 Querying the Online External AP Information (LST-


ONTEXTERNALAP)
Usage Note
This command is used to query the online external AP information of an ONT.

Command Format
LST-ONTEXTERNALAP::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-
MAC)|(NAME=ont-name)):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1277


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1278


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1279


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry the External AP of the device"+device-name
name of attributes: DID FN SN PN ONTID EAPID EAPTYPE SERIALNUM HARDVERSION
SOFTVERSION ONLINEDURATION FREQUENCYTYPE CHANNEL TRANPOWER

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

EAPTYPE OCTET STRING SIZE (32) Indicates the type


of an external AP.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1280


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
an external AP.

HARDVERSION OCTET STRING SIZE (32) Indicates the


hardware version
of an external AP.

SOFTVERSION OCTET STRING SIZE (32) Indicates the


software version
an external AP.

ONLINEDURATIO OCTET STRING SIZE (32) Indicates the


N online duration of
an external AP.

FREQUENCYTYPE OCTET STRING ● 2.4G Indicates the


● 5G frequency of a
WLAN.
● 2.4G,5G

CHANNEL OCTET STRING The options for Indicates the


the 2.4 GHz working channel
frequency are as of an external AP.
follows:
● 1-13
The options for
the 5 GHz
frequency are as
follows:
● 36-173

TRANPOWER OCTET STRING ● 20% Indicates the


● 40% current transmit
power level of an
● 60% external AP.
● 80%
● 100%

Example
To query the external AP information under port 0/15/0 on the device named
10.71.214.65, run the following command:

LST-ONTEXTERNALAP::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=1:CTAG::;

The result is as follows:


7340033 2016-12-20 09:30:25
M CTAG COMPLD
EN=0 ENDESC=Succeed
blktag=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1281


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blkcount=2
blktotal=2

Qry the External AP of the device 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
-----
DID FN SN PN ONTID EAPID EAPTYPE SERIALNUM HARDVERSION SOFTVERSION
ONLINEDURATION FREQUENCYTYPE CHANNEL TRANPOWER
7340033 0 15 0 1 2 HN200 HWTCf0690096 00a80101 R1.0.01.021 22:32:50 2.4G
6 100
7340033 0 15 0 1 4 Honor W6E7S16111007258 VER.A V100R001C01B030 24:8:17
2.4G,5G -- --
------------------------------------------------------------------------------------------------------------------------------
-----

Related Command
None.

14.8.50 Querying the AP Neighbor Information (LST-


ONTAPNEIGHBOR)

Usage Note
This command is used to query the AP neighbor information of an ONT.

Command Format
LST-ONTAPNEIGHBOR::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-
MAC)|(NAME=ont-name)),((EAPID=EapID)|(SSIDINDEX=SsidIndex)):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1282


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1283


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTSN OCTET SIZE (16) Indicates the -


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXX
XX or 16-byte
character
string
XXXXXXXXXX
XXXXXX.

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1284


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) (Optional) -


STRING Indicates the
ONU alias.

SSIDINDEX INTEGER 1-8 Indicates the -


SSID index.
NOTE
If this
parameter is
set, the Wi-Fi
statistics of a
built-in AP is
queried.

EAPID INTEGER 1-8 Indicates the -


ID of an
external AP.
NOTE
If this
parameter is
set, the Wi-Fi
statistics of an
external AP is
queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1285


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter either the parameter EAPID or the parameter SSIDINDEX.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry ONT Wi-Fi Configuration the device"+device-name
name of attributes: DID FN SN PN ONTID SSIDINDEX EAPID NEIGHBORSSIDNAME MAC
TYPE FREQUENCY CHANNEL SIGNAL NOISE BEACON DTIM AUTHMODE STANDARD
MAXBITRATE

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

NEIGHBORSSIDN OCTET STRING SIZE (32) Indicates the SSID


AME of a neighbor
WLAN. The SSID
uniquely identifies
a WLAN.

MAC OCTET STRING SIZE (32) Indicates the MAC


address of a
neighbor device.

TYPE OCTET STRING SIZE (32) Indicates the type


of a neighbor
device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1286


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FREQUENCY OCTET STRING SIZE (32) Indicates the work


frequency of a
neighbor device.

CHANNEL OCTET STRING SIZE (32) Indicates the


working channel
of a neighbor
device.

SIGNAL INTEGER -128 to +128 Indicates the


signal strength of
a neighbor device.
Unit: dBm

NOISE INTEGER -128 to +128 Indicates the


noise of a
neighbor device.
Unit: dBm

BEACON INTEGER 0-1000 Indicates the


interval at which
beacon is sent.
Beacon is used for
communicating
with AP devices or
network control
devices, indicating
that the device
itself exists.
Unit: ms

DTIM INTEGER 0-64 Indicates the


interval at which
Delivery Traffic
Indication Map
(DTIM) is sent.

AUTHMODE OCTET STRING SIZE (32) Indicates the


authentication
mode for a Wi-Fi
device to access a
WLAN.

STANDARD OCTET STRING SIZE (32) Indicates the


802.11 work
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1287


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAXBITRATE INTEGER 0-1000 Indicates the


maximum rate of
the neighbor
device of a Wi-Fi
device.
Unit: Mbit/s

Example
To query the AP neighbor information under port 0/15/0 on the device named
10.71.214.65, run the following command:
LST-
ONTAPNEIGHBOR::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=1,EAPID=1:CTA
G::;
The result is as follows:
7340033 2016-12-20 17:18:53
M CTAG COMPLD
EN=0 ENDESC=Succeed
blktag=1
blkcount=32
blktotal=32

Qry the Neighbor Information of ont user 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
-----------------------------
DID FN SN PN ONTID SSIDINDEX EAPID NEIGHBORSSIDNAME MAC TYPE
FREQUENCY CHANNEL SIGNAL NOISE BEACON DTIM AUTHMODE STANDARD
MAXBITRATE
7340033 0 15 0 1 -- 1 HUAWEI-2.4G-1035 3c:47:11:4a:39:40 AP -- 1 -8 -- 100
0 WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 HUAWEI-D695 78:f5:57:27:09:70 AP -- 1 -4 -- 100 1
WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 WirelessNet_8125-2.4GRRRRRRRRRRT 4c:f2:bf:fa:18:a0 AP --
1 -4 -- 100 0 WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 r17c10-yu d4:61:2e:b9:d2:c0 AP -- 1 -16 -- 100 1
WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 HUAWEI-p59G d4:94:e8:01:bc:20 AP -- 2 -4 -- 100 1
WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
------------------------------------------------------------------------------------------------------------------------------
-----------------------------

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1288


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.8.51 Querying the number of connected ONT users (LST-


ONTUSER)
Usage Note
This command is used to query the number of connected ont users information of
an ONT.

Command Format
LST-ONTUSER::(DID=Device-ID|DEV=Device-name)[,(FN=Frame-id,SN=Slot-id,PN=Port-id)],(ONTID=ont-id)|
(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-MAC)|(NAME=ont-
name)|(ALIAS=Alias):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1289


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


ONT ID.
ONTMAC and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1290


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If this
parameter is
set, you do
not need to
set the FN,
SN, PN,
ONTMAC,
and ONTID
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1291


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.
ONTMAC and
ONTID are
alternative
parameters.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1292


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.
NOTE
In the
command
format, the
PWD in front
of the CTAG
indicates the
location
information
(current ONU
password)
and the PWD
following the
CTAG
indicates the
ONU
password
after
replacement.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU name.

ALIAS OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT:
● (1) subrack ID, slot ID, port ID,(1)ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5)
PWD(6) LOID(7)NAME (8)ALIAS.
● (2) (1)ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID(7)NAME
(8)ALIAS.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Querying the number of connected ont users on the device"+device-name
name of attributes: DID FN SN PN ONTID ACCESSTYPE MACADDR DEVSTATUS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1293


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

ACCESSTYPE OCTET STRING SIZE (32) Interface type.

MACADDR OCTET STRING SIZE (32) Indicates the MAC


address of the
device.

DEVSTATUS OCTET STRING SIZE (32) Indicates the


status of the
device.

Example
To query the Wi-Fi device information under port 0/6/6 on the device named
10.176.99.12, run the following command:
LST-ONTUSER::DEV=10.176.99.12,FN=0,SN=6,PN=6,ONTID=0:CTAG::;
The result is as follows:
7340066 2017-10-31 17:39:57
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=25
blktotal=25

Qry the Connected Numbers of ont user 10.176.99.12


-----------------------------------------------------------
DID FN SN PN ONTID ACCESSTYPE MACADDR DEVSTATUS
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:3c offline
7340066 0 6 6 0 802.11 d0:ff:98:2c:ec:f0 online
7340066 0 6 6 0 802.11 04:4f:4c:22:75:e5 offline
7340066 0 6 6 0 802.11 d0:ff:98:2c:ec:ba online
7340066 0 6 6 0 802.11 04:4f:4c:22:76:06 offline
7340066 0 6 6 0 802.11 0c:8f:ff:69:7c:40 offline
7340066 0 6 6 0 802.11 70:8a:09:da:1d:b7 offline
7340066 0 6 6 0 802.11 c8:94:bb:e3:6c:cc offline
7340066 0 6 6 0 802.11 54:b1:21:90:09:9c offline
7340066 0 6 6 0 802.11 1c:15:1f:7e:be:d1 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:c3 offline
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:75 offline

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1294


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340066 0 6 6 0 802.11 0c:8f:ff:69:7b:c1 offline


7340066 0 6 6 0 802.11 c8:94:bb:c7:c9:37 online
7340066 0 6 6 0 802.11 0c:8f:ff:d3:d4:92 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:74 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:b7 offline
7340066 0 6 6 0 Ethernet 00:1b:21:d1:6a:25 online
7340066 0 6 6 0 802.11 2c:59:8a:5d:29:e8 online
7340066 0 6 6 0 802.11 0c:8f:ff:89:5a:b4 offline
7340066 0 6 6 0 802.11 0c:8f:ff:d3:d3:ec offline
7340066 0 6 6 0 802.11 3c:a9:f4:cc:ce:e4 offline
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:27 offline
7340066 0 6 6 0 802.11 c8:94:bb:c7:c9:3b offline
7340066 0 6 6 0 802.11 70:8a:09:d3:7d:6c offline
-----------------------------------------------------------

Related Command
None.

14.8.52 Querying the Queue Packet Loss Statistics of GPON


TCONT (LST-GPONONTPRIORITYQUEUE)

Usage Note
This command is used to query the queue packet loss statistics of GPON TCONT.

Command Format
LST-GPONONTPRIORITYQUEUE::(((DID=Device-ID|DEV=Device-name)
((,FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-id|ONTSN=ont-
SN)|,PWD=Password|,LOID=Loid|,NAME=ont-name,))|ALIAS=ont-alias)
(TCONTID=255|tcontid):CTAG::;

Supporting Device
Device Type No. Device Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2390 / 2391 / 2389 MA5800C-X6 / MA5800C-X14 /


MA5800C-X16

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1295


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


ONT ID.
ONTMAC and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1296


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If this
parameter is
set, you do
not need to
set the FN,
SN, PN,
ONTMAC,
and ONTID
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1297


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.
ONTMAC and
ONTID are
alternative
parameters.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1298


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.
NOTE
In the
command
format, the
PWD in front
of the CTAG
indicates the
location
information
(current ONU
password)
and the PWD
following the
CTAG
indicates the
ONU
password
after
replacement.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU name.

ALIAS OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT:
● (1) subrack ID, slot ID, port ID,(1)ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5)
PWD(6) LOID(7)NAME (8)ALIAS.
● (2) (1)ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID(7)NAME
(8)ALIAS.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Querying the number of connected ont users on the device"+device-name
name of attributes: DID FN SN PN ONTID ACCESSTYPE MACADDR DEVSTATUS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1299


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

ACCESSTYPE OCTET STRING SIZE (32) Interface type.

MACADDR OCTET STRING SIZE (32) Indicates the MAC


address of the
device.

DEVSTATUS OCTET STRING SIZE (32) Indicates the


status of the
device.

Example
To query the Wi-Fi device information under port 0/6/6 on the device named
10.176.99.12, run the following command:
LST-ONTUSER::DEV=10.176.99.12,FN=0,SN=6,PN=6,ONTID=0:CTAG::;
The result is as follows:
7340066 2017-10-31 17:39:57
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=25
blktotal=25

Qry the Connected Numbers of ont user 10.176.99.12


-----------------------------------------------------------
DID FN SN PN ONTID ACCESSTYPE MACADDR DEVSTATUS
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:3c offline
7340066 0 6 6 0 802.11 d0:ff:98:2c:ec:f0 online
7340066 0 6 6 0 802.11 04:4f:4c:22:75:e5 offline
7340066 0 6 6 0 802.11 d0:ff:98:2c:ec:ba online
7340066 0 6 6 0 802.11 04:4f:4c:22:76:06 offline
7340066 0 6 6 0 802.11 0c:8f:ff:69:7c:40 offline
7340066 0 6 6 0 802.11 70:8a:09:da:1d:b7 offline
7340066 0 6 6 0 802.11 c8:94:bb:e3:6c:cc offline
7340066 0 6 6 0 802.11 54:b1:21:90:09:9c offline
7340066 0 6 6 0 802.11 1c:15:1f:7e:be:d1 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:c3 offline
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:75 offline

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1300


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340066 0 6 6 0 802.11 0c:8f:ff:69:7b:c1 offline


7340066 0 6 6 0 802.11 c8:94:bb:c7:c9:37 online
7340066 0 6 6 0 802.11 0c:8f:ff:d3:d4:92 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:74 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:b7 offline
7340066 0 6 6 0 Ethernet 00:1b:21:d1:6a:25 online
7340066 0 6 6 0 802.11 2c:59:8a:5d:29:e8 online
7340066 0 6 6 0 802.11 0c:8f:ff:89:5a:b4 offline
7340066 0 6 6 0 802.11 0c:8f:ff:d3:d3:ec offline
7340066 0 6 6 0 802.11 3c:a9:f4:cc:ce:e4 offline
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:27 offline
7340066 0 6 6 0 802.11 c8:94:bb:c7:c9:3b offline
7340066 0 6 6 0 802.11 70:8a:09:d3:7d:6c offline
-----------------------------------------------------------

Related Command
None.

14.8.53 Querying VAS Profile (LST-VASPROFILE)


Usage Note
This command is used to query vas profile.

Command Format
LST-VASPROFILE::[PROFID=vas-profile-name]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Input Parameter
Parameter Type Range Description Default

PROFID OCTET SIZE (192) Indicates the N/A


STRING vas profile
name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1301


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
tle="global vas profile information "
name of attributes: PROFID PROFTYPE

Output Parameter
Parameter Type Range Description

PROFID OCTET STRING SIZE (64) Indicates the vas


profile name.

PROFTYPE OCTET STRING NORMAL Indicates the type


GENERAL of profile.

Error Code
ID Description Solution

2686058552 The resource does The vas profile does not exist. Verify
not exist. that the input parameters.

Example
eg: To query the vas profile information named test1111.

● run the following command:


LST-VASPROFILE::PROFID=test1111:CTAG::;
● The returned result is as follows:
0 2018-10-27 03:22:50
M CTAG COMPLD
EN=0 ENDESC=success.
blktag=1
blkcount=1
blktotal=1
Global vas profile information
---------------------
PROFID PROFTYPE
test1111 GENERAL
---------------------

Related Command
None.

14.8.54 Querying ONT Load Task (LST-ONTLOADTASK)

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1302


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Usage Note
This command is used to query the info of ONT Load Task.

Command Format
LST-ONTLOADTASK::(DID=Device-ID|DEV=Device-name),(FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id):CTAG::[FILETYPE=file-type][,TASKTYPE=TASKTYPE];

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER -- Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1303


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


ONT ID.
NOTE
If the UNI
port is of 10G
GPON or 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G GPON or
1G EPON, the
value range is
0-127.

FILETYPE OCTET ALL Indicate the N/A


STRING BIN type of file.
XML

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1304


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

TASKTYPE OCTET ALL Indicate the ALL


STRING CURRENT type of task.
HISTORICAL

Set the parameters specified in one of the following items:


● Device name, subrack ID, slot ID, port ID, and ONT ID.
● Device ID, subrack ID, slot ID, port ID, and ONT ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description..
title="ONT load task information "
name of attributes: DID FN SN PN ONTID TASKTYPE FILETYPE TASKSTATUS CREATETIME
STARTTIME FINISHTIME FAILEDNUM DEVNAME DEVIP

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

FN INTEGER 0-255 Indicates the


subrack ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1305


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

TASKTYPE OCTET STRING CURRENT Indicate the type


HISTORICAL of task.

FILETYPE OCTET STRING BIN File Type.


XML

TASKSTATUS OCTET STRING READY Task status.


LOADING
WAITBOOT
SUCCESS
FAILED
CANCELED
SCHEMEBOOT
SCHEMELOAD
AUTOFAILED

CREATETIME OCTET STRING - Create Task Time.

STARTTIME OCTET STRING - Task Start load


time.

FINISHTIME OCTET STRING - Task end load


Time.

FAILEDNUM INTEGER - Number of Task


failures.

DEVNAME OCTET STRING SIZE (192) Indicates the


name of the OLT.

DEVIP IPADDRESS N/A Indicates the IP


address of the
OLT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1306


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does The resource does not exist. Add an
not exist. ONT loading task.

Example
eg: To query ont load task on the device named10.185.215.104, FN/SM/
Slot=0/15/0,ONT ID = 0.

● run the following command:


LST-
ONTLOADTASK::DEV=10.185.215.104,FN=0,SN=15,PN=0,ONTID=0:CTAG::FI
LETYPE=XML;
● The returned result is as follows:
7340032 2018-10-27 03:27:49
M CTAG COMPLD
EN=0 ENDESC=success.
blktag=1
blkcount=2
blktotal=2
ONT load task information 10.185.215.104
------------------------------------------------------------------------------------------------------------------------------

DID DEV FNSNPNONTID TASKTYPE FILETYPE TASKSTATUS CREATETIME STARTTIME


FINISHTIME FAILEDNUM DEVNAME DEVIP 7
340032 10.185.215.104 0 15 0 0 CURRENT XML READY 2018-10-26 17:10:51 -- --
0 10.185.215.104 10.185.215.104 7
340032 10.185.215.104 0 15 0 0 HISTORICAL XML CANCELED 2018-10-26 16:14:34 --
2018-10-26 17:05:25 0 10.185.215.104 10.185.215.104 -
-----------------------------------------------------------------------------------------------------------------------------
;

Related Command
None.

14.9 Querying EPON Resources


This topic provides the commands and examples for querying the EPON ONTs.

14.9.1 Querying Information About an Upstream EPON ONU


Port (LST-EPONNNIPORT)

Usage Note
Ensure that the EPON ONU is online before you run this command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1307


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-EPONNNIPORT::(DID=Device-ID|DEV=Device-name):CTAG::;

Supporting Device
Device Type No. Device Type

44 MA5600V3

57 MA5606T

61 MA5626E

62 MA5620E

70 MA5610

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

2312 MA5628

2317 MA5631
NOTE
The MA5631 V800R308C02 and later
versions support this command.

2320 MA5612A

2321 MA5669

2322 MA5621A
NOTE
The MA5621A V800R311C00 and later
versions support this command.

2318 MA5632
NOTE
The MA5632 V800R310 and later versions
support this command.

2326 MA5623A V800R311C01 and later


versions

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1308


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2337 MA5822

2338 MA5898

2339 MA5818

2350 MA5811S

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

The device ID or the device name must be set.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1309


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.
title="EPON NNI information of the device "+device-name
name of attributes: DID FN SN PN

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Error Code
ID Description Solution

2686058552 The resource does not The resource does not


exist. exist. In this case, enter
the parameters to locate
an existing resource and
then issue the command.

2686058554 Command does not Enter a device listed in


support this device type. "Supporting Device".

1610612765 Device offline error. Check the network and


device status. Ensure
that you reissue the
command after the
device goes online.

Example
To query the information about the upstream port on the device named
MA5620E, run the following command:
LST-EPONNNIPORT::DEV=MA5620E:1::;
The result is as follows:
7340377 2009-05-12 08:49:31
M 1 COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1310


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Epon NNI information of the device MA5620E


--------------------
DID FN SN PN
7340377 0 0 0
--------------------
;

Related Command
There is no related command.

14.9.2 Querying the List of EPON ONTs (LST-EPONONT)

Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.

Command Format
LST-EPONONT::(DID=Device-ID|DEV=Device-name)([,FN=Frame-id[,SN=Slot-id[,PN=Port-id[,ONTID=ont-
id]]][,ONTMAC=ont-mac]])|([,ONTKEY=ont-key])|([,LOID=loid])):CTAG::[SHOWOPTION=option of result's
attributes];

Supporting Device
Device Type No. Type

34 MA5680T

57 MA5606T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1311


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 (Optional) -


Indicates the
subrack ID.

SN INTEGER 0-35 (Optional) -


Indicates the
slot ID.

PN INTEGER 0-63 (Optional) -


Indicates the
port ID.

ONTID INTEGER 0-255 (Optional) -


NOTE Indicates the
If the UNI ONT ID.
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1312


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (36) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If this
parameter is
set, you do
not need to
set the FN,
SN, PN,
ONTMAC,
and ONTID
parameters.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1313


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

SHOWOPTIO OCTET ● ONTDID Specifies the -


N STRING ● ONTIP optional
attributes
● REGISTERS that can be
TAT displayed in
● ONUTYPE the returned
● FTTXMOD result. If you
E do not set
this
● SPLITTERP parameter,
ORT the optional
● SRVLEVELP attributes are
ROF not returned.
● BINDWIDT If you set this
HTYPE parameter,
the optional
● ALMPROF
attributes are
● VLAN returned.
● PRI Separate
● MASK multiple
optional
● GATE
attributes
● SNMPPRO with spaces.
F
● OPTALMPR
OF
● VAPROF
● RX
● WARNPRO
F

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1314


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● You must enter either the device ID or the device name.


● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Ont information of the device "+device-name
name of attributes: DID FN SN PN ONTID NAME ALIAS CAPABPROF VENDORID
LINEPROF SRVPROF EQUIPMENTID MAINSOFTVERSION AUTH AUTHTIMEOUT MACADDRESS
ONTKEY LOID CHECKCODE ONTDID ONTIP HARDWAREVERSION REGISTERSTAT ONUTYPE
FTTXMODE SPLITTERPORT SRVLEVELPROF BINDWIDTHTYPE ALMPROF VLAN PRI MASK GATE
SNMPPROF OPTALMPROF VAPROF RX WARNPROF

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

NAME OCTET STRING SIZE (255) Indicates the ONT


name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1315


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALIAS OCTET STRING SIZE (64) Indicates the ONT


alias.
NOTE
The following
characters are
supported:
● English letters:
A-Z and a-z.
● Numbers: 0-9.
● Symbols: ( ) _ -
+ . / \ | and
space.

CAPABPROF OCTET STRING SIZE (32) Indicates the


name of the
capability set
profile.

LINEPROF OCTET STRING SIZE (32) Indicates the line


profile.

SRVPROF OCTET STRING SIZE (32) Indicates the


service profile.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.
NOTE
Return HWTC for
HUAWEI ONU.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONU


type.

MAINSOFTVERSI OCTET STRING SIZE (15) Indicates the


ON software version.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1316


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

AUTH OCTET STRING ● MACADDRESS Indicates the


● ALWAYS_ON authentication
mode.
● ONCE_ON
The meanings of
● LOID_ALWAYS_ the options are as
ON follows:
● LOID_ONCE_O ● MACADDRESS:
N Indicates that
● LOID_CHECKC the ONU is
ODE_ALWAYS_ authenticated
ON according to
● LOID_CHECKC the MAC
ODE_ONCE_O address.
N ● ALWAYS_ON:
Indicates that
the ONU is
authenticated
according to
the key. In this
authentication
mode, the OLT
determines
whether the
key reported
by the ONU is
the same as
the preset key.
If the key
reported by the
ONU is the
same as the
preset key, the
ONU passes
the
authentication
and goes
online
successfully.
After
authentication,
the ONU can
still go online
even if its MAC
address is
changed.
● ONCE_ON:
Indicates that
the ONU is
authenticated

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1317


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

according to
the key. In this
authentication
mode, the
ONU can get
online only
once and the
ONU cannot
be replaced
after it is
online. If the
timeout period
is set and the
ONU does not
get online
within the
timeout period,
the ONU can
never get
online.
● LOID_ALWAYS_
ON: Indicates
that the ONU
is
authenticated
according to
the LOID
(Logical ONT
ID). In this
authentication
mode, the OLT
determines
whether the
LOID reported
by the ONU is
the same as
the preset
LOID. If the
LOID reported
by the ONU is
the same as
the preset
LOID, the ONU
passes the
authentication
and goes
online
successfully.
After
authentication,

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1318


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

the ONU can


still go online
even if its MAC
address is
changed.
● LOID_ONCE_O
N: Indicates
that the ONU
is
authenticated
according to
the LOID. In
this
authentication
mode, the
ONU can get
online only
once and the
ONU cannot
be replaced
after it is
online. If the
timeout period
is set and the
ONU does not
get online
within the
timeout period,
the ONU can
never get
online.
● LOID_CHECKC
ODE_ALWAYS_
ON: Indicates
that the ONU
is
authenticated
according to
the LOID and
check code. A
random
character
string (check
code) and the
LOID are
authenticated
together. In
this
authentication

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1319


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

mode, the OLT


determines
whether the
LOID and
check code
reported by the
ONU is the
same as the
preset LOID
and check
code. If the
LOID and
check code
reported by the
ONU are the
same as the
preset LOID
and check
code, the ONU
passes the
authentication
and goes
online
successfully.
After
authentication,
the ONU can
still go online
even if its MAC
address is
changed.
● LOID_CHECKC
ODE_ONCE_O
N: Indicates
that the ONU
is
authenticated
according to
the LOID and
check code. A
random
character
string (check
code) and the
LOID are
authenticated
together. In
this
authentication
mode, the

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1320


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONU can get


online only
once and the
ONU cannot
be replaced
after it is
online. If the
timeout period
is set and the
ONU does not
get online
within the
timeout period,
the ONU can
never get
online.
NOTE
LOID_ALWAYS_O
N,
LOID_ONCE_ON,
LOID_CHECKCODE
_ALWAYS_ON and
LOID_CHECKCODE
_ONCE_ON are
supported by the
MA5680T MA5600
V800R008C00 and
later versions,
MA5600T MA5600
V800R008C00 and
later versions, and
MA5603T MA5600
V800R008C00 and
later versions.

AUTHTIMEOUT OCTET STRING 1-168 Indicates the


Disable timeout period of
the
authentication.
This parameter is
valid only when
the authentication
mode is set to
ONCE_ON.
If you do not set
this parameter,
the value is
returned as
Disable in the
output
information.
Unit: h.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1321


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTDID INTEGER - Indicates the


MDU ID.

ONTIP OCTET STRING SIZE (15) Indicates the IP


address of the
MDU.

MACADDRESS OCTET STRING SIZE (17) Indicates the MAC


address of the
MDU.
It is represented
as 12 hexadecimal
numbers.
Example:
51-53-35-35-22-4
4.

ONTKEY OCTET STRING SIZE (32) Indicates the


password of the
ONT.

LOID OCTET STRING SIZE (24) Indicates the


logical
authentication
code of the ONT.

CHECKCODE OCTET STRING SIZE (12) Indicates the


logical verification
code of the ONT.

HARDWAREVERSI OCTET STRING SIZE (32) Indicates the ONU


ON hardware version.

REGISTERSTAT OCTET STRING ● registered Indicates the


● unregistered authorization
status of an ONU.

ONUTYPE OCTET STRING ● MDU Indicates the ONU


● ONT type.

FTTXMODE OCTET STRING ● FTTB Indicates the FTTx


● FTTH mode.
● FTTC

SPLITTERPORT INTEGER 0-127 Indicates the port


ID of the splitter
that is connected
to an ONU.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1322


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

BINDWIDTHTYPE OCTET STRING ● 1G-1G Indicates the


● 10G-1G upstream and
downstream rate
● 10G-2G types of an ONT.
● 10G-10G Unit: bit/s
● AUTO

SRVLEVELPROF OCTET STRING SIZE (32) Indicates the


name of a service
level profile.
When the location
information
contains NAME
and
SHOWOPTION=S
RVLEVELPROF is
entered, this
parameter is
displayed as --.
NOTE
MA5600
V800R008C05 and
later versions
(excluding
MA5600
V800R009) support
this parameter.

ALMPROF OCTET STRING SIZE (32) Indicates the


alarm profile
name.

VLAN INTEGER 1-4095 Indicates the


management
VLAN of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=V
LAN is entered,
this parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1323


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PRI INTEGER 0-7 Indicates the


priority of the
ONU. When the
location
information
contains NAME
and
SHOWOPTION=P
RI is entered, this
parameter is
displayed as --.

MASK IPADDRESS - Indicates the IP


mask of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=
MASK is entered,
this parameter is
displayed as --.

GATE IPADDRESS - Indicates the


default gateway
of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=G
ATE is entered,
this parameter is
displayed as --.

SNMPPROF OCTET STRING SIZE (64) Indicates the


SNMP profile
name of the ONU.
When the location
information
contains NAME
and
SHOWOPTION=S
NMPPROF is
entered, this
parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1324


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTALMPROF OCTET STRING SIZE (32) Indicates the ONU


optical power
alarm profile
bound to ONUs.
The ONU optical
power alarm
profile is used to
manage optical
module alarm
thresholds in a
centralized
manner.
When the location
information
contains NAME
and
SHOWOPTION=
OPTALMPROF is
entered, this
parameter is
displayed as --.

VAPROF OCTET STRING SIZE (32) Indicates the


name of a global
ONT VAS profile
or a general ONT
VAS profile. When
the location
information
contains NAME
and
SHOWOPTION=V
APROF is entered,
this parameter is
displayed as --.

RX OCTET STRING SIZE (32) Indicates the MEF


IP traffic profile
with QoS
downstream rate
control.
When the location
information
contains NAME
and
SHOWOPTION=R
X is entered, this
parameter is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1325


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

WARNPROF OCTET STRING SIZE (32) Indicates the


name of the warn
profile.
When the location
information
contains NAME
and
SHOWOPTION=
WARNPROF is
entered, this
parameter is
displayed as --.

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Verify that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Verify that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058552 The resource does The information about the EPON ONT
not exist. is not available on the required device.
In this case, verify that the ONT
information is added to the device and
the information of the device is
synchronized to the NCE.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1326


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query the list of ONTs connected to the device named MA5800-X17, run the
following command:
LST-EPONONT::DEV=MA5800-X17:6::;
The result is as follows:
● Profile mode:
7340035 2016-10-26 19:41:01

M 6 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Ont information of the device MA5800-X17

----------------------------
DID FN SN PN ONTID NAME ALIAS CAPABPROF LINEPROF SRVPROF VENDORID EQUIPMENTID
MAINSOFTVERSION AUTH AUTHTIMEOUT MACADDRESS ONTKEY LOID CHECKCODE
HARDWAREVERSION

7340035 0 4 0 0 MA5800-X17/Frame0/Slot4/Port0/OnuID0 -- -- !@#$%^&*()_+{}|":<>/,,.;'[]\~`'' !@#$


%^&*()_+{}|":<>/,,.;'[]\~`'' HWTC ONT -- MACADDRESS Disable 00-10-10-28-00-EE -- -- -- --
----------------------------
;

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1327


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.9.3 Querying Information About Auto-discovered EPON


ONUs (LST-EPONONTAUTOFIND)
Usage Note
The ONU must be connected to the OLT and be powered on.

Command Format
LST-EPONONTAUTOFIND::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Port-id:CTAG::;

Supporting Device
Device Type No. Type

34 MA5680T

57 MA5606T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1328


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Auto find epon ont information "
name of attributes: DEV DID FN SN PN ONTID MACADDRESS ONTKEY LOID CHECKCODE
EQUIPMENTID VENDORID MAINSOFTVERSION

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1329


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

MACADDRESS OCTET STRING SIZE (17) Indicates the MAC


address.
It is represented
as 12 hexadecimal
numbers.
Example:
51-53-35-35-22-4
4.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1330


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTKEY OCTET STRING SIZE (32) Indicates the


password.

LOID OCTET STRING SIZE (24) Indicates the ONU


logical
authentication
code.

CHECKCODE OCTET STRING SIZE (12) Indicates the ONU


logical verification
code.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONU


terminal type.
NOTE
The configuration
item
xPONCOMMON_T
HIRDONT_EQUIP
MENT_FORMAT
determines the
format of terminal
types returned for
CIGG vendors'
ONUs. For details
about the meaning
and setting
method of the
configuration item,
see Table 8-1.

MAINSOFTVERSI OCTET STRING SIZE (15) Indicates the


ON software version.
This parameter is
applicable to the
following devices:
● MA5600T:
MA5600
V800R006 and
later versions
● MA5606T:
MA5600
V800R006 and
later versions
● MA5603T:
MA5600
V800R006 and
later versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1331


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

2686058552 The resource does not The resource does not


exist. exist. In this case, enter
the parameters to locate
an existing resource and
then issue the command.

Example
To query information about the auto-discovered ONU of port 0/15/0 on device
named MA5680_113, run the following command:
LST-EPONONTAUTOFIND::DEV=MA5680_113,FN=0,SN=15,PN=0:0::;
The result is as follows:
7340082 2010-11-01 16:23:55
M 0 COMPLD
EN=0 ENDESC=Succeeded
blktag=1
blkcount=6
blktotal=6

Auto find epon ont information


----------------------------------------------------------------------------------------------------
DEV DID FN SN PN ONTID MACADDRESS ONTKEY LOID CHECKCODE EQUIPMENTID
VENDORID MAINSOFTVERSION
MA5680_113 7340082 0 15 0 0 00-00-12-34-56-78 00000000000000000000000000000000
-- -- 5610 1213682755 V8R307 C01
MA5680_113 7340082 0 15 0 1 00-18-82-6D-06-51 MA5626E_64 -- -- 5626
1213682755 V8R307 C01
MA5680_113 7340082 0 15 0 2 00-18-82-8B-49-8F -- -- 5620 1213682755
MA5600V800R305
MA5680_113 7340082 0 15 0 3 00-25-9E-74-54-FE 5771SNHWTEST02 -- -- 5626
1213682755 V8R308 C00
MA5680_113 7340082 0 15 0 4 00-25-9E-7C-8C-5E 00-18-82-B9-C3-A9 -- -- 5620
1213682755 V8R308 C00
MA5680_113 7340082 0 15 0 5 00-73-07-5B-5E-FA 000000000000 -- -- 850e
842019121 V100R001C03B059
----------------------------------------------------------------------------------------------------

Related Command
● LST-EPONONT
● ADD-EPONONT

14.9.4 Querying the Running Status of an ONT (LST-


EPONONTRUNINFO)
Usage Note
There is no usage note.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1332


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-EPONONTRUNINFO::((DID=Device-ID|DEV=Device-name)((,FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|,NAME=ont-name))|ALIAS=ont-alias:CTAG::[SHOWOPTION=ONUACTUALBANDTYPE
ONUBANDTYPE];

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1333


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID. This
If the UNI parameter is
port is of 10G used together
EPON, the with the
value range is
device name
0-255; if the
UNI port is of or ID, subrack
1G EPON, the number, slot
value range is ID, and port
0-127. ID to locate
the ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1334


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

NAME OCTET SIZE (1-255) Indicates the N/A


STRING name. This
parameter is
used together
with the
device name
or ID to
locate the
ONT.

ALIAS OCTET SIZE (1-128) Indicates the N/A


STRING NOTE alias. It is
For the used to locate
MA5600 the ONTs.
V800R005C03,
MA5600
V800R005C23,
and MA5600
V800R005C33,
the alias
consists of up
to 32
characters.

SHOWOPTIO OCTET ● ONUACTU (Optional) -


N STRING ALBANDTY Specifies
PE whether the
● ONUBAND attributes are
TYPE displayed. If
you enter
SHOWOPTIO
N=ONUACTU
ALBANDTYPE
in the
command,
the
corresponding
attribute is
displayed in
the response
to the
command. By
default, the
attribute is
not displayed.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1335


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Set one of the following parameter combinations to locate an ONT:


● Device name, subrack number, slot ID, port ID, and ONT ID
● Device ID, subrack number, slot ID, port ID, and ONT ID
● Device name and ONT name
● Device ID and ONT name
● ONT alias
If the value of a parameter is displayed as --, it is an invalid value.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT run info of the device "+device-name
name of attributes: DID FN SN PN ONTID NAME ALIAS RUNSTAT ADMINSTAT
LSTUPTIME LSTDOWNTIME LSTDOWNCAUSE ONUACTUALBANDTYPE ONUBANDTYPE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID. This parameter
If the UNI port is is used together
of 10G EPON, the with the device
value range is name or ID,
0-255; if the UNI
subrack number,
port is of 1G
EPON, the value slot ID, and port
range is 0-127. ID to locate the
ONT.

NAME OCTET STRING SIZE (1-255) Indicates the


name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1336


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALIAS OCTET STRING SIZE (1-128) Indicates the alias.


NOTE
For the MA5600
V800R005C03,
MA5600
V800R005C23, and
MA5600
V800R005C33, the
alias consists of up
to 32 characters.

RUNSTAT OCTET STRING ● Up Indicate the


● Down running
information about
the ONT.

ADMINSTAT OCTET STRING ● Up Indicates the


● Down activation status
of the ONT.

BATTERYSTAT OCTET STRING ● NOTSUPPORT Indicates the


● CHARGE power supply
status of the ONT.
● DISCHARGE
● HOLDING
● POWERON

LSTUPTIME INTEGER Format: Indicates the last


YYYYMMDDHHM time when the
MSS ONT was online.
The time is in UTC
format.

LSTDOWNTIME INTEGER Format: Indicates the last


YYYYMMDDHHM time when the
MSS ONT was offline.
The time is in UTC
format.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1337


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

LSTDOWNCAUSE OCTET STRING ● ONUDEL Indicates reason


● ONTDISCONN why the ONT was
ECT offline last time.
● LOSI Options are as
follows:
● LOFI
● ONUDEL: The
● SFI ONT is deleted.
● LOAI ● ONTDISCONN
● LOAMI ECT: The ONT
● DACT Failure is
disconnected.
● DACT
● LOSI: A branch
● Reset fiber is
● Re-Regester disconnected
● Popup Failure or the OLT fails
to detect
● Author Failure
optical signals
● Dying-gasp from a GPON
● OFF-Line ONT.
Failure ● LOFI: ONT
● Deactive frames are lost.
Because of ● SFI: Bit error
Ring rates of the
ONT exceed
the preset
threshold.
● LOAI: PLOAM
acknowledgme
nt messages
are lost for the
ONT.
● LOAMI: PLOAM
messages are
lost for the
ONT.
● DACT Failure:
The ONT
deactivation
fails.
● DACT: The
ONT is
deactivated.
● Reset: The
ONT is reset.
● Re-Regester:
The ONT
registers again.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1338


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

● Popup Failure:
The ONT fails
to respond to
the popup
messages from
the OLT.
● Author Failure:
The ONT
authentication
fails.
● Dying-gasp:
The Dying-
gasp alarm is
reported when
the ONT
undergoes a
power failure.
● OFF-Line
Failure: The
ONT fails to
get offline.
● Deactive
Because of
Ring: The ONT
goes offline
because of the
ring.

ONUACTUALBAN OCTET STRING ● 1G-1G Indicates the


DTYPE ● 10G-1G actual bandwidth
type of the ONU.
● 10G-10G
Unit: bit/s
This parameter is
returned only
when
SHOWOPTION=O
NUACTUALBAND
TYPE is entered in
the command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1339


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONUBANDTYPE OCTET STRING ● 1G-1G Indicates the


● 10G-1G bandwidth type
configured for the
● 10G-10G ONU.
● AUTO Unit: bit/s
This parameter is
returned only
when
SHOWOPTION=O
NUBANDTYPE is
entered in the
command.

Error Code
ID Description Solution

2686058552 The resource does not The resource does not


exist. exist. In this case, enter
the parameters to locate
an existing resource and
then issue the command.

Example
To query running status of ONT 0 connected to port 0/16/1 on the device named
10.78.217.114, run the following command:
LST-
EPONONTRUNINFO::DEV=10.78.217.114,FN=0,SN=16,PN=1,ONTID=0:CTAG::;
The result is as follows:
7340037 2011-02-24 11:49:47
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ONT run info of the device 10.78.217.114


----------------------------------------------------------------------------------------------------
DID FN SN PN ONTID NAME ALIAS RUNSTAT ADMINSTAT LSTUPTIME LSTDOWNTIME LSTDOWNCAUSE
7340037 0 16 1 0 GG 654 Up Up 2011-02-23 13:00:10 2011-02-23 12:58:08 ONTDISCONNECT
----------------------------------------------------------------------------------------------------

Related Command
There is no related command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1340


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.9.5 Querying the Ethernet Port Details of an EPON ONT


(LST-EPONONTETHPORTDETAIL)
Usage Note
This command is used to query the Ethernet port details of an EPON ONT. Ensure
that the OLT is online before running this command.

Command Format
LST-EPONONTETHPORTDETAIL::(DID=Device-ID|DEV=Device-name),FN=frame-num,SN=slot-num,PN=port-
num,ONTID=ont-id,ONTPORTID=ont-port-id:CTAG::[SHOWOPTION=VLANDEFAULT];

Supporting Device
Device Type No. Device Type

249 MA5600T

57 MA5606T

34 MA5680T

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1341


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT index.
If the UNI The ONTID,
port is of 10G DEV (or DID),
EPON, the FN, SN, and
value range is
PN
0-255; if the
UNI port is of parameters
1G EPON, the identify an
value range is ONT.
0-127.

ONTPORTID INTEGER 0-63 Indicates the -


ID of an ONT
user-side port.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1342


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET VLANDEFAUL (Optional) -


N STRING T Specifies
whether the
attributes are
displayed. If
you enter
SHOWOPTIO
N=VLANDEF
AULT in the
command,
the
corresponding
attributes are
displayed in
the response
to the
command. By
default, the
attributes are
not displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ont eth port information of the Device DevName"
name of attributes: DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ONTPORTSTATUS RXPKTS
TXPKTS VLANDEFAULT

Output Parameter
Parameter Type Range Parameter

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1343


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Parameter

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

ONTPORTTYPE INTEGER 47 Indicates the ONT


port type.
If the value is 47,
the port is an
Ethernet port.

ONTPORTID INTEGER 0-63 Indicates the ID of


an ONT user-side
port.

ONTPORTSTATUS OCTET STRING ● ACTIVATE Indicates the


● DEACTIVATE status of an ONT
port.

RXPKTS INTEGER 0-4294967296 Indicates the


number of
received packets.
Unit: packet.

TXPKTS INTEGER 0-4294967296 Indicates the


number of
transmitted
packets.
Unit: packet.

VLANDEAULT INTEGER 0-4095 Indicates the


default VLAN ID.

Error Code
ID Description Solution

1610612751 Parameter Enter all mandatory parameters that are


is included in the command.
incomplete.

Example
To query the details of ONT Ethernet port 0/15/2 (ONTID = 1, ONTPORTID = 1)
on the device named 10.78.217.216, run the following command:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1344


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

LST-
EPONONTETHPORTDETAIL::DEV=10.78.217.216,FN=0,SN=15,PN=2,ONTID=1,O
NTPORTID=1:222::;

The result is as follows:


7340046 2010-11-04 17:33:29
M 222 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ont eth port information 10.78.217.216


----------------------------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID ONTPORTSTATUS RXPKTS TXPKTS
7340046 0 15 2 1 47 1 ACTIVATE -- --
----------------------------------------------------------------------------------

The valid fields of each Ethernet port vary with the types of devices and ports. The invalid
fields are displayed as --.

Related Command
LST-ETHPORT

14.9.6 Querying the MAC Addresses Learned by the User Port


of an FTTH ONU (LST-EPONONTPORTMAC)

Usage Note
● The OLT must be online.
● The version of the OLT must be later than the MA5600 V800R006C32B086.
● The OLT must already discover the EPON board and the EPON port.
● The ONT information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● For the ONT, the version of the HG850e must be later than
V100R001C05B012, the version of the HG813e must be later than
V100R001C01B027, the version of the MA5620E and the MA5626E must be
later than V8R305C01B123, and the version of the MA5610 must be later
than V8R306C01B031.
● The ONT information must be already added to the OLT correctly and
synchronized to the NCE successfully.
● The ONT UNI port must be connected to a home gateway that works in the
normal state and that is connected to a network device such as a PC.

Command Format
LST-EPONONTPORTMAC::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id,ONTPORTTYPE=ont-port-type,ONTPORTID=ont-port-id,VLANID=vlan-id:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1345


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

34 MA5680T

57 MA5606T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - (Optional) N/A


Indicates the
device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1346


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

ONTPORTTYP OCTET ● FE Indicates the N/A


E STRING ● GE type of user
port on the
● ETH ONT.
● WLAN

ONTPORTID INTEGER 0-31 Indicates the N/A


ID of the user
port of the
ONT. The
range of the
user ports is
restricted by
the capability
set profile.

VLANID INTEGER 1-4094 Indicates the N/A


VLAN ID.

The device ID or the device name must be set. Other parameters are mandatory.

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.
title="Ont information of the device"+device-name: DID FN SN PN ONTID ONTPORTTYPE
ONTPORTID VLANID MAC

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1347


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

ONTPORTTYPE OCTET STRING ● FE Indicates the type


● GE of user port on
the ONT.
● ETH
● WLAN

ONTPORTID INTEGER 1-32 Indicates the ID of


the user port of
the ONT. The
range of the user
ports is restricted
by the capability
set profile.

VLANID INTEGER 1-4094 Indicates the


VLAN ID.

MAC OCTET STRING SIZE (17) Indicates the MAC


address addresses
learned by the
user port of the
FTTH ONU.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1348


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the


device is offline. Ensure that the
following faults do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device
because of network faults.

2686058531 The device does not ● Ensure that the device is


exist. successfully added to the NCE.
● By default, the device is
located according to 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 A.8 How to Locate a
Device According to the IP
Address.

2686058554 Command does not Ensure that the command


support this device supports the entered device name
type. or IP address.

2686058498 Missing, invalid Verify that the command is


parameter or correct according to the following
mandatory parameter requirements:
is blank, or the ● The parameter values do not
parameter value is exceed the ranges of the
wrong. parameters specified by the
command.
● The entered parameter names
are correct.
● The parameters are entered in
the correct order.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1349


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

1615462437 The version does not Ensure that the following


match or conditions are met before
communication with upgrading OLTs and ONTs:
the device failed. ● The version of the OLT must be
later than the MA5600
V800R006C32B086.
● For the ONT, the version of the
HG850e must be later than
V100R001C05B012, the version
of the HG813e must be later
than V100R001C01B027, the
version of the MA5620E and
the MA5626E must be later
than V8R305C01B123, and the
version of the MA5610 must
be later than V8R306C01B031.

Example
To query the MAC addresses learned by FE port 1 on ONT 1 that is connected to
port 0/15/0 on the device with the IP address 10.71.211.96, run the following
command:
LST-
EPONONTPORTMAC::DEV=10.71.211.96,FN=0,SN=15,PN=0,ONTID=1,ONTPORT
TYPE=FE,ONTPORTID=1,VLANID=3999:CTAG::;

The first five MAC addresses learned by the port are displayed each time the query
operation is complete. The invalid fields are displayed as --.

The result is as follows:


7340033 2009-03-06 13:51:38
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=5
blktotal=5

Ont information of the device 10.71.211.96


----------------------------------------------------------------
DID FN SN PN ONTID ONTPORTTYPE ONTPORTID VLANID MAC
7340033 0 15 0 1 FE 1 3999 00-74-04-FF-5F-53
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
7340033 0 15 0 1 FE 1 3999 00-00-00-00-00-00
;

Related Command
LST-SERVICEPORT

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1350


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.9.7 Querying the EPON Information of an MDU Device


(LST-EPONBYONUDEV)

Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.
● The OLT must already discover the EPON board and the EPON port.
● The MDU information must be already added to the OLT correctly and
synchronized to the NCE successfully.

Command Format
LST-EPONBYONUDEV::(DID=Device-ID|DEV=Device-name):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

44 MA5600V3

57 MA5606T

61 MA5626E

62 MA5620E

70 MA5610

95 MA5603T

96 MA5620

97 MA5626

100 MA5616

103 MA5635

104 MA5612

249 MA5600T

253 UA5000 (IPMB)

2321 MA5669

2331 MA5608T

2320 MA5612A

2312 MA5628

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1351


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - (Optional) -


Indicates the
device ID.

DEV OCTET SIZE (192) (Optional) -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

You must enter either the device ID or the device name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Ont information of the device"+device-name: DID OLTDID OLTDEV FN SN PN ONTID MACADDR
ONTKEY VENDORID EQUIPMENTID MAINSOFTVER

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1352


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

OLTDID INTEGER - Indicates the


device ID of the
OLT.

OLTDEV OCTET STRING SIZE (1-64) Indicates the


device name of
the OLT.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

MACADDR OCTET STRING SIZE (1-17) Indicates the MAC


address of the
MDU.

ONTKEY OCTET STRING SIZE (1-32) Indicates the


authentication
password of the
ONT.

VENDORID OCTET STRING SIZE (1-32) Indicates the


vendor ID.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONU


type.

MAINSOFTVER OCTET STRING SIZE (15) Indicates the


software version.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1353


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device


is offline. Verify that the following
faults do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device
because of network faults.

2686058531 The device does not ● Verify that the device is


exist. successfully added to the NCE.
● By default, the device is located
according to 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 A.8 How
to Locate a Device According to
the IP Address.

2686058554 Command does not Verify that the command supports


support this device the entered device name or IP
type. address.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query the EPON information of the MDU device named 22, run the following
command:

LST-EPONBYONUDEV::DEV=22:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1354


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

In the query results, the invalid fields are displayed as --.

The result is as follows:


7340119 2009-03-06 13:56:30
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Ont information of the device 22


------------------------------------------------------------------------------------------------
DID OLTDID OLTDEV FN SN PN ONTID MACADDR ONTKEY VENDORID
EQUIPMENTID MAINSOFTVER
7340119 7340033 10.71.211.96 0 15 3 22 -- -- -- 5620 --
------------------------------------------------------------------------------------------------
;

Related Command
None.

14.9.8 Querying Optical Module Information About an EPON


ONT (LST-EPONONTDDMDETAIL)
Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.
● MA5600 V800R006C02, MA5680T V800R006C02, MA5603T V800R006C02 and
MA5600T V800R006C02 or their later versions support the function of
querying optical module information about an EPON ONU.
● The optical module functions properly.

Command Format
LST-EPONONTDDMDETAIL::(DID=Device-ID|DEV=Device-name)(,FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id):CTAG::[SHOWOPTION=TYPE SUBTYPE TxPowerHighAlarmThreshold
TxPowerLowAlarmThreshold RxPowerHighAlarmThreshold RxPowerLowAlarmThreshold
CurrTxBiasHighAlarmThreshold CurrTxBiasLowAlarmThreshold VoltageHighAlarmThreshold
VoltageLowAlarmThreshold TemperatureHighAlarmThreshold TemperatureLowAlarmThreshold];

Supporting Device
Device Type No. Type

34 MA5680T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1355


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2357/2355/2356 MA5800-X17-VAN/MA5800-X7-VAN/
MA5800-X15-VAN

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1356


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

SHOWOPTIO OCTET ● TYPE Specifies N/A


N STRING ● SUBTYPE whether the
return results
● TxPowerHi contain the
ghAlarmTh corresponding
reshold attributes.
● TxPowerLo This
wAlarmThr parameter is
eshold optional. If
● RxPowerHi this
ghAlarmTh parameter is
reshold set, the return
results
● RxPowerLo contain the
wAlarmThr corresponding
eshold attributes. By
● CurrTxBias default, the
HighAlarm return results
Threshold do not
● CurrTxBias contain
LowAlarm attributes.
Threshold
● VoltageHig
hAlarmThr
eshold
● VoltageLo
wAlarmThr
eshold
● Temperatu
reHighAlar
mThreshol
d
● Temperatu
reLowAlar
mThreshol
d

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1357


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Onu Optic Power info of device "+device-name
name of attributes: DID FN SN PN ONTID OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR
OPTICSTXTEMP OPTICSTXVOL ONTRANGING TYPE SUBTYPE TxPowerHighAlarmThreshold
TxPowerLowAlarmThreshold RxPowerHighAlarmThreshold RxPowerLowAlarmThreshold
CurrTxBiasHighAlarmThreshold CurrTxBiasLowAlarmThreshold VoltageHighAlarmThreshold
VoltageLowAlarmThreshold TemperatureHighAlarmThreshold TemperatureLowAlarmThreshold

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

OPTICSRXPOWER FLOAT -100 to 100 Indicates the


receive power of
the optical
module.
Unit: dBm

OPTICSTXPOWER FLOAT -100 to 100 Indicates the


transmit power of
the optical
module.
Unit: dBm

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1358


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTICSTXBIASCU INTEGER 0-10000 Indicates the bias


RR current of the
optical module.
Unit: mA

OPTICSTXTEMP FLOAT -100 to 300 Indicates the


temperature of
the optical
module.
Unit: °C

OPTICSTXVOL INTEGER 0-10000 Indicates the


power supply
voltage of the
optical module.
Unit: mV

ONTRANGING DOUBLE 0-2147483647 Indicates the


ranging distance
of the ONT.
Unit: m.

TYPE OCTET STRING ● GPON Indicates the


● EPON optical module
type.
● 10G EPON
● 10G GPON
● WDM PON
● hybrid PON
● GPON/EPON
● Unknown
● XGS-PON
● TWDM-PON

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1359


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SUBTYPE OCTET STRING ● CLASS B+ Indicates the


● CLASS C+ optical module
subtype.
● CLASS B
● CLASS C++
● N2a
● N2b
● N1
● E1
● E2a
● E2b
● N1/N2a/E1/E2
a
● PX20
● PX20+
● PX20++
● PR30
● PR20
● PRX30
● PRX20
● PRX40
● PR40
● PRX30-E
● GPON CLASS B
+/EPON PX20+
● GPON CLASS
B/EPON PX20
● Unknown

TxPowerHighAlar FLOAT -100 to 100 Indicates the


mThreshold upper alarm
threshold of the
transmit optical
power.
Unit: dBm

TxPowerLowAlar FLOAT -100 to 100 Indicates the


mThreshold lower alarm
threshold of the
transmit optical
power.
Unit: dBm

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1360


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RxPowerHighAlar FLOAT -100 to 100 Indicates the


mThreshold upper alarm
threshold of the
receive optical
power.
Unit: dBm

RxPowerLowAlar FLOAT -100 to 100 Indicates the


mThreshold lower alarm
threshold of the
receive optical
power.
Unit: dBm

CurrTxBiasHighA- INTEGER 0-10000 Indicates the


larmThreshold upper alarm
threshold of the
bias current.
Unit: mA

CurrTxBiasLowAla INTEGER 0-10000 Indicates the


rmThreshold lower alarm
threshold of the
bias current.
Unit: mA

VoltageHighAlarm INTEGER 0-10000 Indicates the


Threshold upper alarm
threshold of the
supply voltage.
Unit: mV

VoltageLowAlarm INTEGER 0-10000 Indicates the


Threshold lower alarm
threshold of the
supply voltage.
Unit: mV

TemperatureHigh- FLOAT -100 to 300 Indicates the


AlarmThreshold upper alarm
threshold of the
temperature.
Unit: °C

TemperatureLowA FLOAT -100 to 300 Indicates the


larmThreshold lower alarm
threshold of the
temperature.
Unit: °C

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1361


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query information about the ONT optical module (ONTID=0) at port 0/13/2 on
the device named 10.144.79.212, run the following command:
LST-
EPONONTDDMDETAIL::DEV=10.144.79.212,FN=0,SN=13,PN=2,ONTID=0:CTAG::;
The result is as follows:

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1362


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340139 2010-11-09 16:17:26


M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Onu Optic Power info of device 10.144.79.212


------------------------------------------------------------------------------------------------------
DID FN SN PN ONTID OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTXTEMP
OPTICSTXVOL ONTRANGING
7340139 0 13 2 0 2.49 -8.81 60 8 3314 345
------------------------------------------------------------------------------------------------------
;

Related Command
LST-EPONPORTDDMDETAIL

14.9.9 Querying the Optical Module Information of an MDU


NNI Port (LST-ONUNNIDDMDETAIL)
Usage Note
● The OLT and MDU must be online.
● The OLT of a specific version must support the EPON service.
● The optical module functions properly.

Command Format
LST-ONUNNIDDMDETAIL::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slotid,PN=Port-id:CTAG::;

Supporting Device
Device Type No. Type

57 MA5606T

61 MA5626E

70 MA5610

100 MA5616

96 MA5620

97 MA5626

104 MA5612

2321 MA5669

2333 MA5698

2335 MA5694

2336 MA5821

2364 EA5821

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1363


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Type

2337 MA5822

2338 MA5898

2339 MA5818

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-512 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot number.

PN INTEGER 0-63 Indicates the N/A


port number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1364


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Onu Optic Power info of device "+device-name
name of attributes: DID FN SN PN OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTXTEMP
OPTICSTXVOL ONTRANGING

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-512 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


number.

PN INTEGER 0-63 Indicates the port


number.

OPTICSRXPOWER FLOAT -100 to 100 Indicates the


receive power of
the optical
module.
Unit: dBm

OPTICSTXPOWER FLOAT -100 to 100 Indicates the


transmit power of
the optical
module.
Unit: dBm

OPTICSTXBIASCU FLOAT 0-10000 Indicates the bias


RR current of the
optical module.
Unit: mA

OPTICSTXTEMP FLOAT -100 to 300 Indicates the


temperature of
the optical
module.
Unit: °C

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1365


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPTICSTXVOL INTEGER 0-10000 Indicates the


power supply
voltage of the
optical module.
Unit: mV

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1366


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query information about the MDU optical module (ONTID=0) at port 0/0/1 on
the device named 10.78.217.216, run the following command:

LST-ONUNNIDDMDETAIL::DEV=10.78.217.216,FN=0,SN=0,PN=1:CTAG::;

The result is as follows:


7340033 2010-11-09 18:38:24
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

MXU Power info of device 10.78.217.216


-------------------------------------------------------------------------
DID FN SN PN OPTICSRXPOWER OPTICSTXPOWER OPTICSTXBIASCURR OPTICSTXTEMP OPTICSTXVOL
7340033 0 0 1 -15.07 2.99 10.54 30.6 3370
-------------------------------------------------------------------------
;

Related Command
LST-EPONONTDDMDETAIL

14.9.10 Querying Details on EPON Optical Modules (LST-


EPONSFP)

Usage Note
This command is used to query information about optical modules on a specified
device. Before running this command, ensure that the device is online and has
been configured with an EPON optical module on the specified slot.

Command Format
LST-EPONSFP::(DID=Device-ID|DEV=Device-name)[,FN=frame-num][,SN=slot-num][,PN=port-num]:CTAG::
[SHOWOPTION=IDENTIFIER CONNECTOR];

Supporting Device
Device Type No. Device Type

34 MA5680T
The MA5600 V800R008C00 and later
versions support this command.

95 MA5603T
The MA5600 V800R008C00 and later
versions support this command.

2331 MA5608T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1367


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

249 MA5600T
The MA5600 V800R008C00 and later
versions support this command.

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING device name.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

SHOWOPTIO OCTET ● IDENTIFIER (Optional) -


N STRING ● CONNECT Specifies the
OR attributes
that can be
displayed in
the returned
result. If you
set this
parameter,
the
corresponding
attributes are
displayed. By
default, the
attributes are
not displayed.

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1368


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

title="EPON SFP information of the device "+device-name


name of attributes: DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5
VENDORNAME VENDOROUI VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
IDENTIFIER CONNECTOR

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

LENGTH9MICRON INTEGER 0-2147483647 Indicates the


transmission
distance of
9/125μm fiber.
Unit: 100 m

LENGTH50MICRO INTEGER 0-2147483647 Indicates the


N transmission
distance of
50/125μm fiber.
Unit: m

LENGTH62MICRO INTEGER 0-2147483647 Indicates the


N5 transmission
distance of
62.5/125μm fiber.
Unit: m

VENDORNAME OCTET STRING 0-17 Indicates the


vendor name.

VENDOROUI OCTET STRING 0-9 Indicates the OUI


ID of the vendor.

VENDORPN OCTET STRING 0-17 Indicates the


product ID of the
vendor.

VENDORSN OCTET STRING 0-17 Indicates the


serial number of
the vendor.

VENDORREV OCTET STRING 0-5 Indicates the


version.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1369


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

WAVELENGTH INTEGER 0-2147483647 Indicates the


optical
wavelength.
Unit: nm

TYPE OCTET STRING ● Unknown Indicates the type


● GPON of the optical
module.
● EPON
● 10G GPON
● 10G EPON
● WDM PON
● hybird PON
● PRX30-E

SUBTYPE OCTET STRING ● Unknown Indicates the


● CLASS B+ subtype of the
optical module.
● CLASS C+
● CLASS B
● PX20
● PX20+
● PR30
● PR20
● PRX30
● PRX20
● CLASS C++
● PX20++
● PRX40
● PR40
● N2A
● N2B
● N1
● E1
● E2a
● E2b
● D1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1370


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IDENTIFIER OCTET STRING ● Unknown Indicates the


● GBIC optical module ID.
Only NEs that
● SolderedToMot work in profile
herboard mode support this
● SFP parameter.
● XFP

CONNECTOR OCTET STRING ● Unknown Indicates the


● SC optical module
connector type.
● CopperConnect Only NEs that
or1 work in profile
● CopperConnect mode support this
or2 parameter.
● BNC/TNC
● CoaxialHeaders
● FiberJack
● LC
● MT-RJ
● MU
● SG
● OpticalPigtail
● HSSDC II
● CopperPigtail
● MpoParallelOp
tic
● RJ45

Error Code
ID Description Solution

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1371


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
Example 1: To query information about optical modules on the board in slot 1 of
subrack 0 on the device named 10.144.194.154, run the following command:
LST-EPONSFP::DEV=10.144.194.154,FN=0,SN=1:CTAG::;
The result is as follows:
7340138 2015-10-27 10:50:15
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=8
blktotal=8

EPON SFP information of the device 10.144.194.154


------------------------------------------------------------------------------------------------------------------------------
---------------------------
DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5 VENDORNAME
VENDOROUI VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
7340138 0 1 0 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 1 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 2 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 3 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 4 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 5 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 6 -- -- -- -- -- -- -- -- -- -- --
7340138 0 1 7 -- -- -- -- -- -- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
---------------------------

Example 2: To query information about optical modules of port 0/1/3 on the


device named 10.144.194.154, run the following command:
LST-
EPONSFP::DEV=10.144.194.154,FN=0,SN=1,PN=3:CTAG::SHOWOPTION=IDENTI
FIER CONNECTOR;
The result is as follows:
7340138 2015-10-27 10:47:57
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

EPON SFP information of the device 10.144.194.154


------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------
DID FN SN PN LENGTH9MICRON LENGTH50MICRON LENGTH62MICRON5 VENDORNAME
VENDOROUI VENDORPN VENDORSN VENDORREV WAVELENGTH TYPE SUBTYPE
IDENTIFIER CONNECTOR
7340138 0 1 3 -- -- -- -- -- -- -- -- -- -- -- -- --
------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------

Related Command
LST-SFP

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1372


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.9.11 Querying Optical Module Information About an EPON


Port (LST-EPONPORTDDMDETAIL)
Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.
● MA5600 V800R006C02, MA5680T V800R006C02, MA5603T V800R006C02 and
MA5600T V800R006C02 or their later versions support the function of
querying optical module information about an EPON port.
● The optical module functions properly.

Command Format
LST-EPONPORTDDMDETAIL::(DID=Device-ID|DEV=Device-name)(,FN=Frame-id,SN=Slot-id,PN=Port-
id):CTAG::[SHOWOPTION=10GTxPower 10GTxPowerR 10GCurrTxBias 10GCurrTxBiasR];

Supporting Device
Device Type No. Type

34 MA5680T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1373


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1374


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● 10GTxPow (Optional) -


N STRING er Specifies
● 10GTxPow whether the
erR attributes are
displayed. If
● 10GCurrTx you enter
Bias SHOWOPTIO
● 10GCurrTx N=10GTxPow
BiasR er in the
command,
the
corresponding
attribute is
displayed in
the response
to the
command. By
default, the
attribute is
not displayed.

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Epon Port Optic Power info of device "+device-name
name of attributes: DID FN SN PN TxPower RxPower Temperature BiasCurrent Voltage 10GTxPower
10GTxPowerR 10GCurrTxBias 10GCurrTxBiasR

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1375


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TxPower FLOAT -100 to 100 Indicates the


transmit power of
the optical
module.
Unit: dBm

RxPower FLOAT -100 to 100 Indicates the


receive power of
the optical
module.
Unit: dBm

Temperature FLOAT -100 to 300 Indicates the


temperature of
the optical
module.
Unit: °C

BiasCurrent INTEGER 0-10000 Indicates the bias


current of the
optical module.
Unit: mA

Voltage INTEGER 0-10000 Indicates the


power supply
voltage of the
optical module.
Unit: mV

10GTxPower DOUBLE -40 to 10 Indicates the 10G


EPON transmit
optical power.
Unit: dBm
This parameter is
returned only
when
SHOWOPTION=1
0GTxPower is
entered in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1376


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

10GTxPowerR OCTET STRING ● Normal Specifies whether


● High the 10G EPON
transmit optical
● Low power is normal.
This parameter is
returned only
when
SHOWOPTION=1
0GTxPowerR is
entered in the
command.

10GCurrTxBias DOUBLE 0-262 Indicates the 10G


EPON bias
current.
Unit: mA
This parameter is
returned only
when
SHOWOPTION=1
0GCurrTxBias is
entered in the
command.

10GCurrTxBiasR OCTET STRING ● Normal Specifies whether


● High the 10G EPON
bias current is
● Low normal.
This parameter is
returned only
when
SHOWOPTION=1
0GCurrTxBiasR is
entered in the
command.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1377


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Verify that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query information about the optical module of port 0/15/0 on the device
named 10.78.217.113, run the following command:
LST-EPONPORTDDMDETAIL::DEV=10.78.217.113,FN=0,SN=15,PN=0:CTAG::;
The result is as follows:
7340130 2010-11-09 15:53:17
M CTAG COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1378


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Epon Port Optic Power info of device 10.78.217.113


-------------------------------------------------------------------------
DID FN SN PN TxPower RxPower Temperature BiasCurrent Voltage
7340130 0 15 0 4.52 -- 46 10 3320
-------------------------------------------------------------------------
;

Related Command
LST-EPONONTDDMDETAIL

14.9.12 Querying the EPON Port Details (LST-


EPONPORTDETAIL)

Usage Note
This command is used to query the EPON port details. Ensure that the OLT is
online before running this command.

Command Format
LST-EPONPORTDETAIL::(DID=Device-ID|DEV=Device-name),FN=frame-num,SN=slot-num,PN=port-
num:CTAG::[SHOWOPTION=option of result's attributes];

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1379


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the -


subrack
number.

SN INTEGER 0-35 Indicates the -


slot number.

PN INTEGER 0-63 Indicates the -


port number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1380


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET ● SPLITRATI Specifies the -


N STRING O optional
● UPWAVELE attributes
NGTH that can be
displayed.
● DOWNWA
VELENGTH ● If you do
not set this
● PROPERTY parameter,
● PROTECTT the
AG optional
● LSTDOWN attributes
CAUSE are not
displayed.
● If you set
this
parameter,
the
optional
attributes
are
displayed.
Separate
multiple
optional
attributes
with spaces.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Epon port detail information of the Device DevName"
name of attributes: DID FN SN PN PSTAT NAME ALIAS NEAREST FARTHES DNFEC AUTOFINDONT
SPLITRATIO UPWAVELENGTH DOWNWAVELENGTH PROPERTY PROTECTTAG LSTDOWNCAUSE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


number.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1381


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PN INTEGER 0-63 Indicates the port


number.

PSTAT OCTET STRING ● Active Indicates the port


● Activating status.
● Deactive

NAME OCTET STRING SIZE (255) Indicates the port


name.

ALIAS OCTET STRING SIZE (255) Indicates the port


alias.

NEAREST INTEGER 0-40 Indicates the


minimum
distance between
the OLT and the
ONU.
Unit: km

FARTHEST INTEGER 0-40 Indicates the


maximum
distance between
the OLT and the
ONU.
Unit: km

DNFEC OCTET STRING ● OPEN Enables and


● CLOSE disables low
delay.

AUTOFINDONT OCTET STRING ● OPEN Enables and


● CLOSE disables auto-
discovery of
ONUs.

SPLITRATIO OCTET STRING 1_128 Indicates the


maximum split
ratio.

UPWAVELENGTH OCTET STRING 1310 Indicates the


upstream
wavelength of the
EPON port.
Unit: nm

DOWNWAVELEN OCTET STRING 1490 Indicates the


GTH downstream
wavelength of the
EPON port.
Unit: nm

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1382


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PROPERTY OCTET STRING OLT Indicates the


source of the
EPON port, that
is, on the OLT or
on the ONU.

PROTECTTAG OCTET STRING NONE Indicates the


active/standby
status of the
EPON port.

LSTDOWNCAUSE OCTET STRING ● LOS Last Down Cause.


● OpticModuleA
bsence
● OpticModuleFa
ult
● OpticPortClose
d

Error Code
ID Description Solution

1610612751 Parameter Enter all mandatory parameters that are


is included in the command.
incomplete.

Example
To query the details about port 0/17/3 of 10.78.217.109, run the following
command:
LST-
EPONPORTDETAIL::DEV=10.78.217.109,FN=0,SN=17,PN=3:222::SHOWOPTION=
SPLITRATIO UPWAVELENGTH DOWNWAVELENGTH PROPERTY PROTECTTAG;
The result is as follows:
7340068 2010-12-23 16:26:38
M 222 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Epon port detail information of the device 10.78.217.109


------------------------------------------------------------------------------------------------------------------------------
-----------------
DID FN SN PN PSTAT NAME ALIAS NEAREST FARTHEST DNFEC AUTOFINDONT
SPLITRATIO UPWAVELENGTH DOWNWAVELENGTH PROPERTY PROTECTTAG
7340068 0 17 3 Activating -- -- -- 20 -- OPEN 1_128 1310 1490 OLT NONE
------------------------------------------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1383


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

-----------------

Related Command
None.

14.9.13 Querying Real-Time Performance Data of an EPON


Port (LST-EPONPONPORTPERF)
Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.

Command Format
LST-EPONPONPORTPERF::(DID=Device-ID|DEV=Device-name)(,FN=Frame-id,SN=Slot-id,PN=Port-id)
[,CHANNELTYPE=OpticalChannelType]:CTAG::;

Supporting Device
Device Type No. Type

34 MA5680T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1384


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

CHANNELTYP OCTET ● 1G Indicates the XEBD boards:


E STRING ● 10G EPON port 1G
channel type.
Options are
as follows:
● 1G: collects
1G port
channel
statistics.
● 10G:
collects
10G port
channel
statistics.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1385


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Epon Port Performance info of device "+device-name
name of attributes: DID FN SN PN RcvUnicastFrames RcvMulticastFrames RcvBoardcastFrames
SendUnicastFrames SendMulticastFrames SendBoardcastFrames Rcv64OctetFrames
Rcv65to127OctetFrames Rcv128to255OctetFrames Rcv256to511OctetFrames Rcv512to1023OctetFrames
Rcv1024to1518OctetFrames RcvCrcErrorFrames

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

RcvUnicastFrames INTEGER 0-1844674407370 Indicates the


9551615 received unicast
frames.

RcvMulticastFram INTEGER 0-1844674407370 Indicates the


es 9551615 received multicast
frames.

RcvBoardcastFram INTEGER 0-1844674407370 Indicates the


es 9551615 broadcast frames.

SendUnicastFram INTEGER 0-1844674407370 Indicates the


es 9551615 transmitted
unicast frames.

SendMulticastFra INTEGER 0-1844674407370 Indicates the


mes 9551615 transmitted
multicast frames.

SendBoardcastFra INTEGER 0-1844674407370 Indicates the


mes 9551615 transmitted
broadcast frames.

Rcv64OctetFrame INTEGER 0-1844674407370 Indicates the


s 9551615 received 64-byte
frames.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1386


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

Rcv65to127OctetF INTEGER 0-1844674407370 Indicates the


rames 9551615 received 65-byte
to 127-byte
frames.

Rcv128to255Octet INTEGER 0-1844674407370 Indicates the


Frames 9551615 received 128-byte
to 255-byte
frames.

Rcv256to511Octet INTEGER 0-1844674407370 Indicates the


Frames 9551615 received 256-byte
to 511-byte
frames.

Rcv512to1023Oct INTEGER 0-1844674407370 Indicates the


etFrames 9551615 received 512-byte
to 1023-byte
frames.

Rcv1024to1518Oc INTEGER 0-1844674407370 Indicates the


tetFrames 9551615 received 1024-
byte to 1518-byte
frames.

RcvCrcErrorFrame INTEGER 0-1844674407370 Indicates the


s 9551615 received CRC error
frames.

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1387


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query performance information about port 0/15/0 on device named
10.78.217.113, run the following command:

LST-EPONPONPORTPERF::DEV=10.78.217.113,FN=0,SN=15,PN=0:CTAG::;

The result is as follows:


7340130 2010-11-09 16:47:47
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Epon Port Performance info of device 10.78.217.113


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------
DID FN SN PN RcvUnicastFrames RcvMulticastFrames RcvBoardcastFrames SendUnicastFrames
SendMulticastFrames SendBoardcastFrames Rcv64OctetFrames Rcv65to127OctetFrames
Rcv128to255OctetFrames Rcv256to511OctetFrames Rcv512to1023OctetFrames Rcv1024to1518OctetFrames
RcvCrcErrorFrames
7340130 0 15 0 0 0 0 0 0 0 0 0 0 0 0 0 0
------------------------------------------------------------------------------------------------------------------------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1388


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------

Related Command
There is no related command.

14.9.14 Querying Real-Time Performance Data of Ethernet


Traffic on an EPON UNI Port (LST-EPONPORTPERF)
Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.

Command Format
LST-EPONPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-id,SN=Slot-id,PN=Port-id:CTAG::;

Supporting Device
Device Type No. Type

249 MA5600T

34 MA5680T

2331 MA5608T

95 MA5603T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1389


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot number.

PN INTEGER 0-63 Indicates the N/A


port number.

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="EPON Port Performance info of device " +device-name
name of attributes: DID FN SN PN INOCTES INUCASTPKTS INDISCARDS INERRORS OUTOCTES
OUTUCASTPKTS OUTDISCARDS OUTERRORS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1390


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


number.

PN INTEGER 0-63 Indicates the port


number.

INOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
received.

INUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets received.

INDISCARDS INTEGER 0-1844674407370 Indicates the total


9551615 number of
dropped packets
received.

INERRORS INTEGER 0 Indicates the total


number of error
packets received.

OUTOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
transmitted.

OUTUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets
transmitted.

OUTDISCARDS INTEGER 0 Indicates the total


number of
dropped packets
transmitted.

OUTERRORS INTEGER 0 Indicates the total


number of error
packets
transmitted.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1391


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query the performance data of port 0/12/0 of device 10.167.223.118, run the
following command:
LST-EPONPORTPERF::DEV=10.167.223.118,FN=0,SN=12,PN=0:CTAG::;
The result is as follows:
7340223 2011-08-16 14:46:50
M CTAG COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1392


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

EPON Port Performance info of device 10.167.223.118


----------------------------------------------------------------------------------------------------------------
DID FN SN PN INOCTES INUCASTPKTS INDISCARDS INERRORS OUTOCTES OUTUCASTPKTS OUTDISCARDS
OUTERRORS
7340082 0 12 0 19313628867 18438781 0 0 141119487430 1072364695 0 0
----------------------------------------------------------------------------------------------------------------
;

Related Command
None.

14.9.15 Querying Real-Time Performance Data on an EPON


ONT Ethernet Port (LST-EPONONTETHPORTPERF)
Usage Note
● The OLT and ONT must be online.
● The OLT of a specific version must support the EPON service.

Command Format
LST-EPONONTETHPORTPERF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id,ONTPORTID=ont-portid:CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1393


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack
number.

SN INTEGER 0-35 Indicates the N/A


slot number.

PN INTEGER 0-63 Indicates the N/A


port number.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1394


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTPORTID INTEGER 0-31 Indicates the N/A


ONT ETH port
number.

The device ID or the device name must be set.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Eth Port of ONT Performance info of device " +device-name
name of attributes: DID FN SN PN ONTID ONTPORTID INOCTES INUCASTPKTS INDISCARDS INERRORS
OUTOCTES OUTUCASTPKTS OUTDISCARDS OUTERRORS TxRate RxRate

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack number.

SN INTEGER 0-35 Indicates the slot


number.

PN INTEGER 0-63 Indicates the port


number.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

ONTPORTID INTEGER 0-31 Indicates the ONT


ETH port ID.

INOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
received.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1395


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

INUCASTPKTS INTEGER 0-1844674407370 Indicates the total


9551615 number of unicast
packets received.

INDISCARDS INTEGER 0-1844674407370 Indicates the total


9551615 number of
dropped packets
received.

INERRORS INTEGER 0 Indicates the total


number of error
packets received.

OUTOCTES INTEGER 0-1844674407370 Indicates the total


9551615 number of bytes
transmitted.

OUTUCASTPKTS INTEGER 0 Indicates the total


number of unicast
packets
transmitted.

OUTDISCARDS INTEGER 0 Indicates the total


number of
dropped packets
transmitted.

OUTERRORS INTEGER 0 Indicates the total


number of error
packets
transmitted.

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that the device is


offline. Ensure that the following faults
do not occur:
● The physical connection is
disconnected.
● The SNMP read and write
community names are set
incorrectly.
● NCE cannot ping the device because
of network faults.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1396


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058531 The device does not ● Ensure that the device is successfully
exist. added to the NCE.
● By default, the device is located
according to 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 A.8
How to Locate a Device According
to the IP Address.

2686058554 Command does not Ensure that the command supports the
support this device entered device name or IP address.
type.

2686058498 Missing, invalid Verify that the command is correct


parameter or according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The entered parameter names are
correct.
● The parameters are entered in the
correct order.

Example
To query performance data of Ethernet port 1 on ONT 7 under port 0/12/0 of
device 10.167.223.118, run the following command:
LST-
EPONONTETHPORTPERF::DEV=10.167.223.118,FN=0,SN=12,PN=0,ONTID=7,ON
TPORTID=1:CTAG::;
The result is as follows:
7340223 2011-08-16 14:46:41
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Eth Port of ONT Performance info of device 10.167.223.118


------------------------------------------------------------------------------------------------------------------------------
----
DID FN SN PN ONTID ONTPORTID INOCTES INUCASTPKTS INDISCARDS INERRORS OUTOCTES
OUTUCASTPKTS OUTDISCARDS OUTERRORS
7340223 0 12 0 7 1 0 0 0 0 0 0 0 0
------------------------------------------------------------------------------------------------------------------------------
----
;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1397


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Related Command
None.

14.9.16 Querying ONT SIP User Accounts (LST-


ONTSIPINFOQUERY-ONTSIPINFO)
Usage Note
This command is used to query the registration username, password, and
registration username of the SIP user ports. Query at levels other than ONT (NE,
board, or port level) supports GPON query only, and all the query results are
obtained from the database. Information that is not contained in the database is
displayed as --. For third-party ONTs (non-Huawei ONTs), only basic information
is displayed. Other information is displayed as --.

Command Format
LST-ONTSIPINFO::(DID=Device-ID|DEV=Device-name),((((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ont-key))[,SIPUSERNAME=Sip-userName])|([,FN=Frame-id][,SN=Slot-id][,PN=Port-id])):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T V800R008C00 and later


versions

249 MA5600T V800R008C00 and later


versions

2331 MA5608T

95 MA5603T V800R008C00 and later


versions

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1398


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
GPON or 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G GPON or
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1399


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET ● The range Indicates the N/A


STRING of the EPON ONT
value is key or the
SIZE (36) GPON ONT
when the authenticatio
GPON_PW n password.
D_FORMA An ONT is
T_IN_DB is located
set to 0. according to
● the range the device
of the and the ONT
value is key. If you set
SIZE (72) this
when the parameter,
GPON_PW you do not
D_FORMA need to set
T_IN_DB is the FN, SN,
set to 1. PN, and
ONTID
parameters.
NOTE
For the EPON
ONT key:
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1400


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SIPUSERNAM OCTET SIZE (64) Indicates the N/A


E STRING registration
username of
a SIP user
port. This
value is a
phone
number.
NOTE
You may use
personal
information of
users when
configuring
the relevant
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.

Set the parameters specified in one of the following items:


● Device name, subrack ID, slot ID, port ID, and ONT ID
● Device ID, subrack ID, slot ID, port ID, and ONT ID
● Device name and ONT key
● Device ID and ONT key

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
● Query at ONT level
title="ONT SIP INFO: " + SIPUSERNAME
name of attributes: SIPUSERNAME SIPUSERPWD SIPNAME

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1401


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● Query at levels other than ONT (NE, board, or port level):


title="ONT POTS attributes of the device " + DID FN SN PN ONTID SIPUSERNAME
SIPUSERPWD SIPNAME VENDORID EQUIPMENTID SERIALNUM

Output Parameter
Parameter Type Range Description

SIPUSERNAME OCTET STRING SIZE (64) Indicates the


registration
username of a SIP
user port. This
value is a phone
number.

SIPUSERPWD OCTET STRING SIZE (64) Indicates the


password of a SIP
user port.

SIPNAME OCTET STRING SIZE (64) Indicates the


authentication
username of a SIP
user port.

DID INTEGER - Indicates the OLT


ID, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

FN INTEGER 0-255 Indicates the OLT


subrack ID, which
is displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

SN INTEGER 0-35 Indicates the OLT


slot ID, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

PN INTEGER 0-63 Indicates the OLT


port ID, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1402


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONU


NOTE ID, which is
If the UNI port is displayed only
of 10G GPON or when ONT WAN
10G EPON, the port information
value range is
is queried at non-
0-255; if the UNI
port is of 1G ONT levels.
GPON or 1G
EPON, the value
range is 0-127.

VENDORID OCTET STRING SIZE (40) Indicates the


vendor ID, which
is displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

EQUIPMENTID OCTET STRING SIZE (40) Indicates the ONT


type, which is
displayed only
when ONT WAN
port information
is queried at non-
ONT levels.

SERIALNUM OCTET STRING SIZE (16) Indicates the


serial number,
which is displayed
only when ONT
WAN port
information is
queried at non-
ONT levels.

Error Code
ID Description Solution

2686058552 The resource does not The terminal does not


exist. exist. Verify that the
input parameters, such
as the device ID (or
device name), subrack
ID, slot ID, port ID, ONT
ID, and ONT key are
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1403


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
● Example 1: To query the ONT SIP user account on the device named
10.71.32.13, run the following command:
LST-
ONTSIPINFO::DEV=10.71.32.13,FN=0,SN=15,PN=0,ONTID=34,SIPUSERNAM
E=87654321:6::;
The returned result is as follows:
7340034 2010-11-20 13:55:45
M 6 COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
ONT SIP INFO: 87654321
-------------------------------------------
SIPUSERNAME SIPUSERPWD SIPNAME
87654321 123456 AAA
-------------------------------------------
;

● Example 2: To query the ONT SIP user account on the device named
10.71.59.65, run the following command:
LST-ONTSIPINFO::DEV=10.71.59.65,FN=0,SN=2,PN=0:6::;
The returned result is as follows:
7342239 2017-02-26 11:23:30
M COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4

ONT POTS attributes of the device


-----------------------------------------------------------------------------------------------
DID FN SN PN ONTID SIPUSERNAME SIPUSERPWD SIPNAME VENDORID
EQUIPMENTID SERIALNUM
7342239 0 2 0 0 -- ****** -- -1 -- FFFFFFFF02005E2B
7342239 0 2 0 1 -- ****** -- -1 -- FFFFFFFF02008DB6
7342239 0 2 0 2 -- ****** -- -1 -- FFFFFFFF0200D655
7342239 0 2 0 3 -- ****** -- -1 -- FFFFFFFF0200B91C
-----------------------------------------------------------------------------------------------

Related Command
None

14.9.17 Querying the VoIP Address of an ONT (LST-


ONTVAGVOIP)

Usage Note
This command is used to query the VoIP address of an ONT and the proxy IP
address of an IMS. Query at levels other than ONT (NE, board, or port level)
supports GPON query only, and all the query results are obtained from the
database. Information that is not contained in the database is displayed as --. For

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1404


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

third-party ONTs (non-Huawei ONTs), only basic information is displayed. Other


information is displayed as --.

Command Format
LST-ONTVAGVOIP::(DID=Device-id|DEV=Device-name),((((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ont-key))[,VAGNAME=vag-name])|([,FN=Frame-id][,SN=Slot-id][,PN=Port-id])):CTAG::
[SHOWOPTION=VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT SECPROXYIP
SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB INITJB INITFIXJB DTMF SGVLANID MGVLANID];

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

57 MA5606T

94 MA5603U

2331 MA5608T

95 MA5603T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1405


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING default OLT
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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

ONTID INTEGER 0-255 Indicates the N/A


NOTE ONT ID.
If the UNI
port is of 10G
GPON or 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G GPON or
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1406


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET ● The range Indicates the N/A


STRING of the EPON ONT
value is key.
SIZE (36)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 0.
● the range
of the
value is
SIZE (72)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 1.

VAGNAME OCTET SIZE (32) Indicates the N/A


STRING VAG name.

SHOWOPTIO OCTET VAGID (Optional) N/A


N STRING VAGNAME Specifies the
attributes
SGIP that can be
MGIP displayed in
HOMEDOMAI the response.
N If you set this
parameter,
PROXYIP the
PROXYPORT corresponding
SECPROXYIP attributes are
displayed. By
SECPROXYPO
default, the
RT
attributes are
GWNAME not displayed.
LPORT
REGISPRD
MAXJB
MINJB
INITJB
INITFIXJB
DTMF
SGVLANID
MGVLANID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1407


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="ONT VAG attributes of the device "+device-name
DID FN SN PN ONTID VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT SECPROXYIP
SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB INITJB INITFIXJB DTMF SGVLANID MGVLANID

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the device ID.

FN INTEGER 0-255 Indicates the subrack ID.

SN INTEGER 0-35 Indicates the slot ID.

PN INTEGER 0-63 Indicates the port ID.

ONTID INTEGER 0-255 Indicates the ONT ID.


NOTE
If the UNI
port is of
10G GPON
or 10G
EPON, the
value range
is 0-255; if
the UNI port
is of 1G
GPON or 1G
EPON, the
value range
is 0-127.

VAGID INTEGER 0-16777215 Indicates VAG ID.

VAGNAME OCTET SIZE (32) Indicates the VAG name.


STRING

SGIP IPADDRESS - Indicates the IP address of the


WAN port associated with the
signaling gateway.

MGIP IPADDRESS - Indicates the IP address of the


WAN port associated with the
media gateway.

HOMEDOMAIN OCTET SIZE (32) Indicates the name of the home


STRING domain.

PROXYIP IPADDRESS - Indicates the IP address of the


proxy server.

PROXYPORT INTEGER 0-65535 Indicates the port ID of the


proxy server.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1408


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SECPROXYIP IPADDRESS - Indicates the IP address of the


secondary proxy server.

SECPROXYPOR INTEGER 0-65535 Indicates the port ID of the


T secondary proxy server.

GWNAME OCTET SIZE (32) Indicates the VAG name.


STRING

LPORT INTEGER 0-65535 Indicates the local port ID.

REGISPRD INTEGER 1-65534 Indicates the registered lifecycle.


Unit: second.

MAXJB INTEGER 1-200 Indicates the largest dynamic JB


value.

MINJB INTEGER 1-200 Indicates the smallest dynamic


JB value.

INITJB INTEGER 1-200 Indicates the initial dynamic JB


value.

INITFIXJB INTEGER 1-200 Indicates the initial fixed JB


value.

DTMF INTEGER InBand Indicates the DTMF transmission


RFC2833 mode.

SGVLANID INTEGER 1-4095 Indicates the VLAN ID of the


WAN port associated with the
signaling gateway.

MGVLANID INTEGER 1-4095 Indicates the VLAN ID of the


WAN port associated with the
media gateway.

Error Code
None

Example
● Example 1: To query the VoIP address of ONT 20 of port 0/16/4 on the device
named 10.78.217.111, run the following command:
LST-
ONTVAGVOIP::DEV=10.78.217.111,FN=0,SN=16,PN=4,ONTID=20:CTAG::SH
OWOPTION=VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP
PROXYPORT SECPROXYIP SECPROXYPORT LPORT SGVLANID MGVLANID;
The result is as follows:
7340074 2011-06-15 00:31:21
M CTAG COMPLD

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1409


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ONT VAG attributes of the device 10.78.217.111


-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------------
DID FN SN PN ONTID VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT
SECPROXYIP SECPROXYPORT LPORT SGVLANID MGVLANID
7340074 0 16 4 20 1 vagf1 10.10.10.10 10.10.10.10 11.11.11.11 23.23.23.23 5060
22.22.22.22 5060 5060 201 201
-----------------------------------------------------------------------------------------------------------------------
---------------------------------------------------------------------------------------------------------------

● Example 2: To query the VoIP address of port 0/2/0 on the device named
10.71.59.65, run the following command:
LST-
ONTVAGVOIP::DEV=10.71.59.65,FN=0,SN=2,PN=0:6::SHOWOPTION=VAGID
VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP PROXYPORT SECPROXYIP
SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB INITJB
INITFIXJB DTMF SGVLANID MGVLANID;
The result is as follows:
1 2016-12-26 11:35:31
M COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=4
blktotal=4

ONT VAG attributes of the device


-----------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------
DID FN SN PN ONTID VAGID VAGNAME SGIP MGIP HOMEDOMAIN PROXYIP
PROXYPORT SECPROXYIP SECPROXYPORT GWNAME LPORT REGISPRD MAXJB MINJB
INITJB INITFIXJB DTMF SGVLANID MGVLANID
7342239 0 2 0 0 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
7342239 0 2 0 1 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
7342239 0 2 0 2 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
7342239 0 2 0 3 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
-- -- --
-----------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------
;

Related Command
None

14.9.18 Querying the ONT PSTN User Information (LST-


ONTVOIPPSTNUSER)

Usage Note
None

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1410


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-ONTVOIPPSTNUSER::(DID=devid|DEV=devname),((FN=frame-id,SN=slot-id,PN=port-id,ONTID=ont-id)|
(ONTKEY=ontkey))[,ONTPORTID=ontportid]:CTAG::[OFFQRYFLAG=Enable|Disable][,SHOWOPTION=VAGID
VAGNAME DIALMODE RPOLARITY DCTIME USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD
HOTLINE USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1 CODECSENABLE1 CODECS2
PKTPERIOD2 PRIORITY2 CODECSENABLE2 CODECS3 PKTPERIOD3 PRIORITY3 CODECSENABLE3 CODECS4
PKTPERIOD4 PRIORITY4 CODECSENABLE4 FIXJTBF DGTSNDMODE ALIAS HOTLINENUMBER
HOTLINETIMER CALLWAITINGENABLE CALLTRANSFERENABLE MWIENABLE THREEWAYENABLE
CALLHOLDENABLE DATASOURCE];

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

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1411


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID. This
If the UNI parameter,
port is of 10G the device
GPON or 10G name or ID,
EPON, the
and the
value range is
0-255; if the subrack, slot,
UNI port is of and port IDs
1G GPON or are used
1G EPON, the together to
value range is locate the
0-127.
ONT.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1412


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY INTEGER ● The range Indicates the -


of the EPON ONU
value is key.
SIZE (36)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 0.
● the range
of the
value is
SIZE (72)
when the
GPON_PW
D_FORMA
T_IN_DB is
set to 1.

ONTPORTID INTEGER 1-16 Indicates the -


user port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1413


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

OFFQRYFLAG OCTET Enable Specifies Disable


STRING Disable whether to
enable the
offline query
functions.
This
parameter is
optional.
The options
are as follows:
● Enable:
indicates
that the
NCE can
query
informatio
n about
offline
ONTs.
● Disable:
indicates
that the
NCE
cannot
query
informatio
n about
offline
ONTs.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1414


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

SHOWOPTIO OCTET VAGID Specifies the -


N STRING VAGNAME optional
attributes
DIALMODE that can be
RPOLARITY displayed in
DCTIME the returned
result. If you
USERPRIORIT do not set
Y this
DIGITMAP parameter,
DIRECTORYN the optional
O attributes are
not returned.
USERNM If you set this
USERPWD parameter,
HOTLINE the optional
attributes are
USERENABLE returned.
SENDGAIN Separate
RCVGAIN multiple
optional
CODECS1
attributes
PKTPERIOD1 with spaces.
PRIORITY1
CODECSENAB
LE1
CODECS2
PKTPERIOD2
PRIORITY2
CODECSENAB
LE2
CODECS3
PKTPERIOD3
PRIORITY3
CODECSENAB
LE3
CODECS4
PKTPERIOD4
PRIORITY4
CODECSENAB
LE4
FIXJTBF
DGTSNDMOD
E
ALIAS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1415


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

HOTLINENU
MBER
HOTLINETIME
R
CALLWAITING
ENABLE
CALLTRANSFE
RENABLE
MWIENABLE
THREEWAYEN
ABLE
CALLHOLDEN
ABLE
DATASOURCE

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=" ONT POTS attributes of the device "+device-name
name of attributes:
DID FN SN PN ONTID ONTPORTID VAGID VAGNAME DIALMODE RPOLARITY
DCTIME USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD HOTLINE
USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1 CODECSENABLE1
CODECS2 PKTPERIOD2 PRIORITY2 CODECSENABLE2 CODECS3 PKTPERIOD3 PRIORITY3
CODECSENABLE3 CODECS4 PKTPERIOD4 PRIORITY4 CODECSENABLE4 FIXJTBF
DGTSNDMODE ALIAS HOTLINENUMBER HOTLINETIMER CALLWAITINGENABLE
CALLTRANSFERENABLE MWIENABLE THREEWAYENABLE CALLHOLDENABLE DATASOURCE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1416


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G GPON or
10G EPON, the
value range is
0-255; if the UNI
port is of 1G
GPON or 1G
EPON, the value
range is 0-127.

ONTPORTID INTEGER 1-2 Indicates the user


port ID.

VAGID INTEGER 1-64 Indicates the VAG


port ID.

VAGNAME OCTET STRING SIZE (64) Indicates the VAG


name.

DIALMODE OCTET STRING SIZE (32) Indicates the


dialup mode.

RPOLARITY INTEGER 0-1 Specifies whether


to reverse the
polarity after the
called party picks
up the phone.
The options are as
follows:
● 0: not reverse
● 1: reverse

DCTIME INTEGER 0-1000 Indicates the


terminal power-
off period.
Unit: ms.

USERPRIORITY INTEGER 0-1 Specifies whether


to enable user
priorities.
The options are as
follows:
● 0: disable
● 1: enable

DIGITMAP OCTET STRING SIZE (32) Indicates the


digitmap profile
name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1417


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DIRECTORYNO OCTET STRING SIZE (64) Indicates the user


telephone
number.

USERNM OCTET STRING SIZE (64) Indicates the


authentication
username.

USERPWD OCTET STRING SIZE (64) Indicates the


authentication
password.

HOTLINE INTEGER 0-1 Specifies whether


to enable hotlines.

USERENABLE OCTET STRING SIZE (32) Specifies whether


to enable POTS
users.

SENDGAIN OCTET STRING SIZE (32) Indicates the port


transmit gain.
Unit: db.

RCVGAIN OCTET STRING SIZE (32) Indicates the port


receive gain.
Unit: db.

CODECS1 OCTET STRING G.711MuLaw Indicates the first


G.711ALaw codec.
G.729
G.722

PKTPERIOD1 INTEGER 10 Indicates the first


20 packetization
duration.
30
Unit: ms.

PRIORITY1 INTEGER 1-100 Indicates priority


1.

CODECSENABLE1 OCTET STRING Enable Specifies whether


Disable to enable the first
codec.

CODECS2 OCTET STRING G.711MuLaw Indicates the


G.711ALaw second codec.
G.729
G.722

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1418


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

PKTPERIOD2 INTEGER 10 Indicates the


20 second
packetization
30 duration.
Unit: ms.

PRIORITY2 INTEGER 1-100 Indicates priority


2.

CODECSENABLE2 OCTET STRING Enable Specifies whether


Disable to enable the
second codec.

CODECS3 OCTET STRING G.711MuLaw Indicates the third


G.711ALaw codec.
G.729
G.722

PKTPERIOD3 INTEGER 10 Indicates the third


20 packetization
duration.
30
Unit: ms.

PRIORITY3 INTEGER 1-100 Indicates priority


3.

CODECSENABLE3 OCTET STRING Enable Specifies whether


Disable to enable the
third codec.

CODECS4 OCTET STRING G.711MuLaw Indicates the


G.711ALaw fourth codec.
G.729
G.722

PKTPERIOD4 INTEGER 10 Indicates the


20 fourth
packetization
30 duration.
Unit: ms.

PRIORITY4 INTEGER 1-100 Indicates priority


4.

CODECSENABLE4 OCTET STRING Enable Specifies whether


Disable to enable the
fourth codec.

FIXJTBF OCTET STRING Enable Specifies whether


Disable to enable the JB
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1419


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

DGTSNDMODE OCTET STRING En-Bloc Indicates the


OverlapMultipleIn mode of sending
vites the called
number.
OverlapInDialogu
e The options are as
follows:
● En-Bloc: sends
the called
number in full
digitmap
mode.
● OverlapMultipl
eInvites: sends
the called
number in
overlap mode
with multiple
INVITE
messages.
● OverlapInDialo
gue: sends the
called number
in overlap
mode in a
session.

ALIAS OCTET STRING SIZE (32) Indicates the ONT


POTS user alias.

HOTLINENUMBER OCTET STRING SIZE (32) Indicates the


hotline number.

HOTLINETIMER INTEGER 0-255 Indicates the


hotline delay.
Unit: s.

CALLWAITINGENA OCTET STRING Enable Specifies whether


BLE Disable to enable call
waiting.

CALLTRANSFEREN OCTET STRING Enable Specifies whether


ABLE Disable to enable call
transfer.

MWIENABLE OCTET STRING Enable Specifies whether


Disable to enable
message signal
lamp.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1420


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

THREEWAYENABL OCTET STRING Enable Specifies whether


E Disable to enable three
way call.

CALLHOLDENABL OCTET STRING Enable Specifies whether


E Disable to enable call
hold.

DATASOURCE OCTET STRING ONT Indicates the data


EMS source.
The options are as
follows:
● ONT: indicates
that data is
obtained from
ONTs.
● EMS: indicates
that data is
obtained from
the NCE.

Error Code
None

Example
To query the PSTN user information on the ONT POTS port 20 of port 0/16/4 on
the device named 10.78.217.111, run the following command:
LST-
ONTVOIPPSTNUSER::DEV=10.78.217.111,FN=0,SN=16,PN=4,ONTID=20:CTAG::S
HOWOPTION=VAGID VAGNAME DIALMODE RPOLARITY DCTIME
USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD HOTLINE
USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1
CODECSENABLE1 CODECS2 PKTPERIOD2 PRIORITY2 CODECSENABLE2
CODECS3 PKTPERIOD3 PRIORITY3 CODECSENABLE3 CODECS4 PKTPERIOD4
PRIORITY4 CODECSENABLE4 FIXJTBF DGTSNDMODE ALIAS HOTLINENUMBER
HOTLINETIMER;
The result is as follows:
7340074 2011-06-15 18:18:09
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=2
blktotal=2
ONT POTS attributes of the device 10.78.217.111
----------------------------------------------------------------
DID FN SN PN ONTID ONTPORTID VAGID VAGNAME DIALMODE RPOLARITY
DCTIME USERPRIORITY DIGITMAP DIRECTORYNO USERNM USERPWD HOTLINE
USERENABLE SENDGAIN RCVGAIN CODECS1 PKTPERIOD1 PRIORITY1 CODECSENABLE1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1421


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

CODECS2 PKTPERIOD2 PRIORITY2 CODECSENABLE2 CODECS3 PKTPERIOD3 PRIORITY3


CODECSENABLE3 CODECS4 PKTPERIOD4 PRIORITY4 CODECSENABLE4 FIXJTBF
DGTSNDMODE ALIAS HOTLINENUMBER HOTLINETIMER
7340074 0 16 4 20 1 1 First -- -- Disable Enabled 0db -3.5db G.
711MuLaw 20 1 Enable G.711ALaw 20 2 Enable G.729 20 3 Enable G.722 20
4 Enable
7340074 0 16 4 20 2 1 First -- -- Disable Enabled 0db -3.5db G.
711MuLaw 20 1 Enable G.711ALaw 20 2 Enable G.729 20 3 Enable G.722 20
4 Enable Disable OverlapMultipleInvites 111 123456 20
-------------------------------------------------------------------------------
;

Related Command
None

14.9.19 Querying Call Record of an ONT Pots (LST-


ONTPOTSCALLRECORD)

Usage Note
OLT and ONT device is online.

Command Format
LST-ONTPOTSCALLRECORD::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id,ONTPORTID=ont-portid:CTAG::;

Supporting Device
Device Type No. Device Type

249 MA5600T

34 MA5680T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1422


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 ONT ID. -


0-255
NOTE
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

ONTPORTID INTEGER 1-32 ONT POTS ID. -

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1423


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title=ont pots call record information " + device-name
name of attributes:DID FN SN PN ONTID ONTPOTSID RECORDINDEX STARTTIME
DURATION CALLTYPE CALLCODEC CALLERNUMBER CALLEENUMBER PACKETSSENT
PACKETSRECEIVED PACKETSLOST ROUNDTRIPDELAY RCVINTERARRIVJITTER MOSLQ

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 ONT ID.


0-255
NOTE
If the UNI port is
of 10G GPON, the
value range is
0-255; if the UNI
port is of 1G
GPON, the value
range is 0-127.

ONTPOTSID INTEGER 0-32 ONT POTS ID.

RECORDINDEX INTEGER 1-20 Indicates the


index of the call
record.

STARTTIME OCTET STRING SIZE (19) Indicates the start


time of the call,
YYYY-MM-DD
HH:MM:SS.

DURATION INTEGER - Indicates the


duration of the
call (unit: second).

CALLTYPE OCTET STRING OUTGOINGCALL Indicates the type


INCOMINGCALL of the call.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1424


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CALLCODEC OCTET STRING G.711U Indicates the


Reserved codec used in the
call.
G.726
GSM
G.723
DVI4-8K
DVI4-16K
LPC
G.711A
G.722
L16-2channels
L16-1channels
QCELP
CN
MPA
G.728
DVI4-11K
DVI4-22K
G.729
T.38

CALLERNUMBER OCTET STRING - Indicates the


calling number.

CALLEENUMBER OCTET STRING - Indicates the


called number.

PACKETSSENT INTEGER - Indicates the


number of
packets sent
during the call.

PACKETSRECEIVE INTEGER - Indicates the


D number of
packets received
during the call.

PACKETSLOST INTEGER - Indicates the


number of
packets discarded
during the call.

ROUNDTRIPDELA INTEGER - Indicates the loop


Y delay of the call
(unit: ms).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1425


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RCVINTERARRIVJI INTEGER - Indicates the jitter


TTER of the call in the
Rx direction (unit:
ms).

MOSLQ FLOAT - Indicates the


average MOS
value of the call.

Error Code
ID Description Solution

2686058552 The resource There no call record on ONT Pots.


does not exist.

Example
To query call record of the 4th pots of the 6th ont on PON port 0/5/4 on NE
10.144.195.165, run the following command:
LST-
ONTPOTSCALLRECORD::DEV=10.144.195.165,FN=0,SN=5,PN=4,ONTID=6,ONTP
ORTID=4:CTAG::;
The result is as follows:
7340223 2015-10-13 14:47:05
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

ont pots call record information 10.144.195.165


------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
DID FN SN PN ONTID ONTPOTSID RECORDINDEX STARTTIME DURATION CALLTYPE
CALLCODEC CALLERNUMBER CALLEENUMBER PACKETSSENT PACKETSRECEIVED PACKETSLOST
ROUNDTRIPDELAY RCVINTERARRIVJITTER MOSLQ
7340185 0 5 4 6 4 1 2015-10-10 09:04:41 231 OUTGOINGCALL G.711A
****************** ****************** 22352 22351 0 0 0 4.4
7340185 0 5 4 6 4 2 2015-10-10 09:01:32 184 OUTGOINGCALL G.711A
****************** ****************** 17662 17666 0 0 0 4.4
7340185 0 5 4 6 4 3 2015-10-10 09:00:42 45 OUTGOINGCALL G.711A
****************** ****************** 3782 3785 0 0 0 4.4
7340185 0 5 4 6 4 4 2015-10-10 08:53:27 429 OUTGOINGCALL G.711A
****************** ****************** 42105 42106 0 0 0 4.4
7340185 0 5 4 6 4 5 2015-10-10 08:51:43 100 OUTGOINGCALL G.711A
****************** ****************** 9253 9255 0 0 0 4.4
7340185 0 5 4 6 4 6 2015-10-10 08:27:53 1412 OUTGOINGCALL G.711A
****************** ****************** 140466 140467 0 0 0 4.4
7340185 0 5 4 6 4 7 2015-10-10 08:23:57 231 OUTGOINGCALL G.711A
****************** ****************** 22346 22347 0 0 0 4.4
7340185 0 5 4 6 4 8 2015-10-10 08:20:21 211 OUTGOINGCALL G.711A
****************** ****************** 20357 20360 0 0 0 4.4

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1426


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340185 0 5 4 6 4 9 2015-10-10 08:19:23 54 OUTGOINGCALL G.711A


****************** ****************** 4710 4713 0 0 0 4.4
7340185 0 5 4 6 4 10 2015-10-10 08:19:21 1 OUTGOINGCALL G.711A
****************** ****************** 0 0 0 0 0 0
7340185 0 5 4 6 4 11 2015-10-10 08:12:08 429 OUTGOINGCALL G.711A
****************** ****************** 42076 42078 0 0 0 4.4
7340185 0 5 4 6 4 12 2015-10-10 08:12:05 0 OUTGOINGCALL G.711A
****************** ****************** 0 0 0 0 0 0
7340185 0 5 4 6 4 13 2015-10-10 08:10:23 100 OUTGOINGCALL G.711A
****************** ****************** 9252 18506 0 0 0 4.4
7340185 0 5 4 6 4 14 2015-10-10 07:46:05 1440 OUTGOINGCALL G.711A
****************** ****************** 143310 143310 0 0 0 4.4
7340185 0 5 4 6 4 15 2015-10-10 07:41:59 241 OUTGOINGCALL G.711A
****************** ****************** 23263 23263 0 0 0 4.4
7340185 0 5 4 6 4 16 2015-10-10 07:38:22 212 OUTGOINGCALL G.711A
****************** ****************** 20413 20416 0 0 0 4.4
7340185 0 5 4 6 4 17 2015-10-10 07:37:24 54 OUTGOINGCALL G.711A
****************** ****************** 4624 4626 0 0 0 4.4
7340185 0 5 4 6 4 18 2015-10-10 07:30:10 428 OUTGOINGCALL G.711A
****************** ****************** 42090 42091 0 0 0 4.4
7340185 0 5 4 6 4 19 2015-10-10 07:28:26 100 OUTGOINGCALL G.711A
****************** ****************** 9253 9255 0 0 0 4.4
7340185 0 5 4 6 4 20 2015-10-10 07:04:38 1408 OUTGOINGCALL G.711A
****************** ****************** 140030 140028 0 0 0 4.4
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
;

Related Command
There is no related command.

14.9.20 Querying the ONT WLAN Information (LST-


ONTUSERWLAN)

Usage Note
This command is used to query an ONT WLAN.

Command Format
LST-ONTUSERWLAN::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-MAC)|(NAME=ont-
name)):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1427


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1428


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

ONTSN OCTET SIZE (16) Indicates the -


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXX
XX or 16-byte
character
string
XXXXXXXXXX
XXXXXX.

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1429


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry ONT Wi-Fi Configuration of the device"+device-name
name of attributes:DID FN SN PN ONTID SSIDINDEX STATE SSIDNAME DEVNUM
FREQUENCY VISIBLE BROADCAST WMM TRANPOWER DOMAIN CHANNEL
CHANNELWIDTH MODE AUTHMODE ENCRYMODE

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1430


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

STATE OCTET STRING ● Active Indicates the


● Deactive activation status
of an AP.

SSIDNAME OCTET STRING SIZE (32) Indicates the SSID


name.

DEVNUM INTEGER 1-128 Indicates the


number of Wi-Fi
devices connected
to the WLAN.

FREQUENCY OCTET STRING ● 2.4GHz Indicates the


● 5GHz frequency used by
the ONT to
provide Wi-Fi
access.

VISIBLE OCTET STRING ● Enable Specifies whether


● Disable SSIDs are visible
on web pages.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1431


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

BROADCAST OCTET STRING ● Enable Specifies whether


● Disable to enable SSID
broadcasting.
NOTE
● enable
indicates that
SSID
broadcasting is
enabled. ONTs
will periodically
broadcast their
SSIDs, that is,
the WLAN
names. Any Wi-
Fi devices can
find the
WLANs.
● disable
indicates that
SSID
broadcasting is
disabled. ONTs
do not
broadcast their
SSIDs. Wi-Fi
devices cannot
find the
WLANs, and
can only apply
for SSIDs.

WMM OCTET STRING ● Enable Specifies whether


● Disable to enable
multimedia.

TRANPOWER OCTET STRING ● 20% Indicates the


● 40% transmit power of
Wi-Fi signals.
● 60% Larger value
● 80% indicates better
● 100% signal coverage.

DOMAIN OCTET STRING SIZE (2) Indicates the


country code of
the wireless
network.B.16
Country and
Region
Abbreviations

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1432


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CHANNEL OCTET STRING The options for Indicates the


the 2.4 GHz channel of a
frequency are as WLAN.
follows:
● Automatic
● 1-13
The options for
the 5 GHz
frequency are as
follows:
● Automatic
● 36-173

CHANNELWIDTH OCTET STRING The options for Indicates the


the 2.4 GHz wireless
frequency are as bandwidth.
follows:
● Auto 20/40
● 20MHz
● 40MHz
The options for
the 5 GHz
frequency are as
follows:
● Auto 20/40
● 20MHz
● 40MHz
● Auto 20/40/80

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1433


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MODE OCTET STRING The options for Indicates the


the 2.4 GHz supported
frequency are as wireless network
follows: mode.
● 802.11b
● 802.11g
● 802.11n
● 802.11b/g
● 802.11b/g/n
The options for
the 5 GHz
frequency are as
follows:
● 802.11a
● 802.11a/n
● 802.11a/n/ac
● 802.11b
● 802.11g
● 802.11n
● 802.11b/g
● 802.11b/g/n

AUTHMODE OCTET STRING ● Open Indicates the


● Shared authentication
mode for a Wi-Fi
● WPA Pre- device to access a
Shared Key WLAN.
● WPA2 Pre-
Shared Key
● WPA/WPA2
Pre-Shared Key
● WPA Enterprise
● WPA2
Enterprise
● WPA/WPA2
Enterprise

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1434


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ENCRYMODE OCTET STRING ● None Indicates the


● WEP encryption mode
for a Wi-Fi device
● AES to access a WLAN.
● TKIP The encryption
● TKIP&AES mode and
encryption
Relationship with parameters vary
other parameters: according to the
● If AUTHMODE authentication
is set to Open, mode.
ENCRYMODE
can be set to
None or WEP.
If
● AUTHMODE is
set to Shared,
ENCRYMODE
is WEP. If
● AUTHMODE is
set to WPA
Pre-Shared
Key, WPA2
Pre-Shared
Key, WPA/
WPA2 Pre-
Shared Key,
WPA
Enterprise,
WPA2
Enterprise, or
WPA/WPA2
Enterprise,
ENCRYMODE
can be set to
AES, TKIP, or
TKIP&AES.

Example
To Query the ONT WLAN information under port 0/15/0 on the device named
10.71.214.65, run the following command:
LST-ONTUSERWLAN::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=2:CTAG::;
The result is as follows:
7340038 2017-01-23 16:58:51
M CTAG COMPLD
EN=0 ENDESC=Succeed.
blktag=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1435


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blkcount=6
blktotal=6

Qry ONT Wi-Fi Configuration of the device 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
------------------------------------------
DID FN SN PN ONTID SSIDINDEX STATE SSIDNAME DEVNUM FREQUENCY VISIBLE
BROADCAST WMM TRANPOWER DOMAIN CHANNEL CHANNELWIDTH MODE
AUTHMODE ENCRYMODE
7340038 0 15 0 2 1 Active STC1-2.4G 25 2.4GHz Enable Enable Enable 80%
CN Automatic 20MHz 802.11b/g/n WPA2 Pre-Shared Key AES
7340038 0 15 0 2 2 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
7340038 0 15 0 2 3 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
7340038 0 15 0 2 4 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
7340038 0 15 0 2 5 Active STC1-5G 25 5GHz Enable Enable Enable 80% CN
Automatic 20MHz 802.11a/n/ac WPA2 Pre-Shared Key AES
7340038 0 15 0 2 6 Active WirelessNet 32 2.4GHz Enable Enable Enable 100%
CN 6 20MHz 802.11b/g/n Open None
------------------------------------------------------------------------------------------------------------------------------
------------------------------------------

Related Command
15.8.17 Configuring the ONT WLAN (CFG-ONTUSERWLAN)

14.9.21 Querying Wi-Fi Statistics (LST-ONTAPWIFISTATISTICS)

Usage Note
This command is used to query Wi-Fi statistics of an ONT.

Command Format
LST-ONTAPWIFISTATISTICS::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-
MAC)|(NAME=ont-name)),(SSIDINDEX=SsidIndex[,EAPID=EapID]):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1436


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1437


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1438


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) (Optional) -


STRING Indicates the
ONU alias.

SSIDINDEX INTEGER 1-8 Indicates the -


SSID index,
which is
mandatory.
NOTE
If EAPID is
left blank, the
Wi-Fi statistics
of a built-in
AP is queried.

EAPID INTEGER 1-8 Indicates the -


ID of an
external AP.
NOTE
This
parameter
must be
provisioned if
the Wi-Fi
statistics of an
external AP
needs to be
queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1439


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry the WIFI statistics of the device"+device-name
name of attributes: DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME
CONNECTDEVICES RECEIVEBYTES RECEIVEPKGS RECEIVEERRORPKGS TRANSBYTES TRANSPKGS
TRANSERRORPKGS TRANSDROPPKGS

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

SSIDNAME OCTET STRING SIZE (32) Indicates the SSID


name.

CONNECTDEVICE INTEGER 0-128 Indicates the


S number of
connected Wi-Fi
devices.

RECEIVEBYTES OCTET STRING SIZE (32) Indicates the total


number of
received bytes.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1440


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

RECEIVEPKGS OCTET STRING SIZE (32) Indicates the total


number of
received
packages.

RECEIVEERRORPK OCTET STRING SIZE (32) Indicates the


GS number of
received error
packages.

RECEIVEDROPPKG OCTET STRING SIZE (32) Indicates the


S number of
dropped packages
during package
receiving.

TRANSBYTES OCTET STRING SIZE (32) Indicates the total


number of
transmitted bytes.

TRANSPKGS OCTET STRING SIZE (32) Indicates the total


number of
transmit
packages.

TRANSERRORPKG OCTET STRING SIZE (32) Indicates the


S number of
transmit error
packages.

TRANSDROPPKGS OCTET STRING SIZE (32) Indicates the


number of
dropped packages
during package
transmission.

Example
To query Wi-Fi statistics under port 0/15/0 on the device named 10.71.214.65, run
the following command:
LST-
ONTAPWIFISTATISTICS::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=1,SSIDIN
DEX=1:CTAG::;
The result is as follows:
7340033 2016-12-20 10:31:37
M CTAG COMPLD
EN=0 ENDESC=Succeed
blktag=1
blkcount=1
blktotal=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1441


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Qry the WIFI statistics of the device 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------
DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME CONNECTDEVICES RECEIVEBYTES
RECEIVEPKGS RECEIVEERRORPKGS RECEIVEDROPPKGS TRANSBYTES TRANSPKGS
TRANSERRORPKGS TRANSDROPPKGS
7340033 0 15 0 1 1 -- WirelessNet_8125-2.4GRRRRRRRRRRT 0 1511634 8036 0 0
51167389 290677 7 1065881
------------------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------

Related Command
None.

14.9.22 Querying the Wi-Fi Device Information (LST-


ONTWIFIDEVICE)
Usage Note
This command is used to query the Wi-Fi device information of an ONT.

Command Format
LST-ONTWIFIDEVICE::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-id,ONTID=ont-
id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-MAC)|(NAME=ont-
name)),(SSIDINDEX=SsidIndex)[,EAPID=EapID]:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1442


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


ONT ID.
ONTMAC and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1443


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If this
parameter is
set, you do
not need to
set the FN,
SN, PN,
ONTMAC,
and ONTID
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1444


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.
ONTMAC and
ONTID are
alternative
parameters.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1445


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.
NOTE
In the
command
format, the
PWD in front
of the CTAG
indicates the
location
information
(current ONU
password)
and the PWD
following the
CTAG
indicates the
ONU
password
after
replacement.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) (Optional) -


STRING Indicates the
ONU alias.

SSIDINDEX INTEGER 1-8 Indicates the -


SSID index.
NOTE
If EAPID is
left blank, the
Wi-Fi device
information of
a built-in AP
is queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1446


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

EAPID INTEGER 1-8 Indicates the -


ID of an
external AP.
NOTE
This
parameter
must be
provisioned if
the Wi-Fi
device
information of
an external
AP needs to
be queried.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry ONT Wi-Fi Configuration the device"+device-name
name of attributes: DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME MACADDR
ONLINEDURATION RECEIVERATE TRANSRATE SIGNAL NOISE SNR SIGNALQUALITY

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1447


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

SSIDNAME OCTET STRING SIZE (32) Indicates the SSID


name.

ONLINEDURATIO OCTET STRING SIZE (32) Indicates the


N online duration of
an external AP.
Unit: s

RECEIVERATE OCTET STRING SIZE (32) Indicates the


receive rate of a
Wi-Fi device.
Unit: Mbps

TRANSRATE OCTET STRING SIZE (32) Indicates the


transmit rate of a
Wi-Fi device.
Unit: Mbps

SIGNAL OCTET STRING SIZE (32) Indicates the


signal strength of
a Wi-Fi device.
Unit: dBm

NOISE OCTET STRING SIZE (32) Indicates the


noise that a Wi-Fi
device suffers.
Unit: dBm

SNR OCTET STRING SIZE (32) Indicates the SNR


of a Wi-Fi device.
Unit: dB

SIGNALQUALITY OCTET STRING SIZE (32) Indicates the


signal quality of a
Wi-Fi device.
Unit: dBm

Example
To query the Wi-Fi device information under port 0/15/0 on the device named
10.71.214.65, run the following command:
LST-
ONTWIFIDEVICE::DEV=PCCW_wudong,FN=0,SN=15,PN=0,ONTID=1,SSIDINDEX
=1,EAPID=4:CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1448


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The result is as follows:


7340032 2016-12-20 17:49:50
M CTAG COMPLD
EN=0 ENDESC=Succeed.
blktag=1
blkcount=1
blktotal=1

Qry the Wi-Fi Device Info of ont user PCCW_wudong


------------------------------------------------------------------------------------------------------------------------------
-------------
DID FN SN PN ONTID SSIDINDEX EAPID SSIDNAME MACADDR ONLINEDURATION RECEIVERATE
TRANSRATE SIGNAL NOISE SNR SIGNALQUALITY
7340032 0 15 0 1 1 4 WirelessNet_8125-2.4GRRRRRRRRRRT 24:f0:94:c5:1d:2e 6640 24 - -47 - - 53
------------------------------------------------------------------------------------------------------------------------------
-------------

Related Command
None.

14.9.23 Querying the Online External AP Information (LST-


ONTEXTERNALAP)
Usage Note
This command is used to query the online external AP information of an ONT.

Command Format
LST-ONTEXTERNALAP::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-
MAC)|(NAME=ont-name)):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1449


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1450


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1451


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry the External AP of the device"+device-name
name of attributes: DID FN SN PN ONTID EAPID EAPTYPE SERIALNUM HARDVERSION
SOFTVERSION ONLINEDURATION FREQUENCYTYPE CHANNEL TRANPOWER

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

EAPTYPE OCTET STRING SIZE (32) Indicates the type


of an external AP.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1452


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

SERIALNUM OCTET STRING SIZE (32) Indicates the


serial number of
an external AP.

HARDVERSION OCTET STRING SIZE (32) Indicates the


hardware version
of an external AP.

SOFTVERSION OCTET STRING SIZE (32) Indicates the


software version
an external AP.

ONLINEDURATIO OCTET STRING SIZE (32) Indicates the


N online duration of
an external AP.

FREQUENCYTYPE OCTET STRING ● 2.4G Indicates the


● 5G frequency of a
WLAN.
● 2.4G,5G

CHANNEL OCTET STRING The options for Indicates the


the 2.4 GHz working channel
frequency are as of an external AP.
follows:
● 1-13
The options for
the 5 GHz
frequency are as
follows:
● 36-173

TRANPOWER OCTET STRING ● 20% Indicates the


● 40% current transmit
power level of an
● 60% external AP.
● 80%
● 100%

Example
To query the external AP information under port 0/15/0 on the device named
10.71.214.65, run the following command:

LST-ONTEXTERNALAP::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=1:CTAG::;

The result is as follows:


7340033 2016-12-20 09:30:25
M CTAG COMPLD
EN=0 ENDESC=Succeed
blktag=1

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1453


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

blkcount=2
blktotal=2

Qry the External AP of the device 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
-----
DID FN SN PN ONTID EAPID EAPTYPE SERIALNUM HARDVERSION SOFTVERSION
ONLINEDURATION FREQUENCYTYPE CHANNEL TRANPOWER
7340033 0 15 0 1 2 HN200 HWTCf0690096 00a80101 R1.0.01.021 22:32:50 2.4G
6 100
7340033 0 15 0 1 4 Honor W6E7S16111007258 VER.A V100R001C01B030 24:8:17
2.4G,5G -- --
------------------------------------------------------------------------------------------------------------------------------
-----

Related Command
None.

14.9.24 Querying the AP Neighbor Information (LST-


ONTAPNEIGHBOR)

Usage Note
This command is used to query the AP neighbor information of an ONT.

Command Format
LST-ONTAPNEIGHBOR::(DID=Device-ID|DEV=Device-name),((FN=Frame-id,SN=Slot-id,PN=Port-
id,ONTID=ont-id)|(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-
MAC)|(NAME=ont-name)),((EAPID=EapID)|(SSIDINDEX=SsidIndex)):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1454


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
GPON, the
value range is
0-255; if the
UNI port is of
1G GPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1455


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTSN OCTET SIZE (16) Indicates the -


STRING serial number.
Format: 12-
byte character
string
XXXXXXXXXX
XX or 16-byte
character
string
XXXXXXXXXX
XXXXXX.

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1456


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) (Optional) -


STRING Indicates the
ONU alias.

SSIDINDEX INTEGER 1-8 Indicates the -


SSID index.
NOTE
If this
parameter is
set, the Wi-Fi
statistics of a
built-in AP is
queried.

EAPID INTEGER 1-8 Indicates the -


ID of an
external AP.
NOTE
If this
parameter is
set, the Wi-Fi
statistics of an
external AP is
queried.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1457


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT: (1) subrack ID, slot
ID, port ID, and ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID and
NAME.
● You must enter either the parameter EAPID or the parameter SSIDINDEX.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Qry ONT Wi-Fi Configuration the device"+device-name
name of attributes: DID FN SN PN ONTID SSIDINDEX EAPID NEIGHBORSSIDNAME MAC
TYPE FREQUENCY CHANNEL SIGNAL NOISE BEACON DTIM AUTHMODE STANDARD
MAXBITRATE

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

SSIDINDEX INTEGER 1-8 Indicates the SSID


index.

EAPID INTEGER 1-8 Indicates the ID of


an external AP.

NEIGHBORSSIDN OCTET STRING SIZE (32) Indicates the SSID


AME of a neighbor
WLAN. The SSID
uniquely identifies
a WLAN.

MAC OCTET STRING SIZE (32) Indicates the MAC


address of a
neighbor device.

TYPE OCTET STRING SIZE (32) Indicates the type


of a neighbor
device.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1458


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

FREQUENCY OCTET STRING SIZE (32) Indicates the work


frequency of a
neighbor device.

CHANNEL OCTET STRING SIZE (32) Indicates the


working channel
of a neighbor
device.

SIGNAL INTEGER -128 to +128 Indicates the


signal strength of
a neighbor device.
Unit: dBm

NOISE INTEGER -128 to +128 Indicates the


noise of a
neighbor device.
Unit: dBm

BEACON INTEGER 0-1000 Indicates the


interval at which
beacon is sent.
Beacon is used for
communicating
with AP devices or
network control
devices, indicating
that the device
itself exists.
Unit: ms

DTIM INTEGER 0-64 Indicates the


interval at which
Delivery Traffic
Indication Map
(DTIM) is sent.

AUTHMODE OCTET STRING SIZE (32) Indicates the


authentication
mode for a Wi-Fi
device to access a
WLAN.

STANDARD OCTET STRING SIZE (32) Indicates the


802.11 work
mode.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1459


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

MAXBITRATE INTEGER 0-1000 Indicates the


maximum rate of
the neighbor
device of a Wi-Fi
device.
Unit: Mbit/s

Example
To query the AP neighbor information under port 0/15/0 on the device named
10.71.214.65, run the following command:
LST-
ONTAPNEIGHBOR::DEV=10.71.214.65,FN=0,SN=15,PN=0,ONTID=1,EAPID=1:CTA
G::;
The result is as follows:
7340033 2016-12-20 17:18:53
M CTAG COMPLD
EN=0 ENDESC=Succeed
blktag=1
blkcount=32
blktotal=32

Qry the Neighbor Information of ont user 10.71.214.65


------------------------------------------------------------------------------------------------------------------------------
-----------------------------
DID FN SN PN ONTID SSIDINDEX EAPID NEIGHBORSSIDNAME MAC TYPE
FREQUENCY CHANNEL SIGNAL NOISE BEACON DTIM AUTHMODE STANDARD
MAXBITRATE
7340033 0 15 0 1 -- 1 HUAWEI-2.4G-1035 3c:47:11:4a:39:40 AP -- 1 -8 -- 100
0 WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 HUAWEI-D695 78:f5:57:27:09:70 AP -- 1 -4 -- 100 1
WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 WirelessNet_8125-2.4GRRRRRRRRRRT 4c:f2:bf:fa:18:a0 AP --
1 -4 -- 100 0 WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 r17c10-yu d4:61:2e:b9:d2:c0 AP -- 1 -16 -- 100 1
WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
7340033 0 15 0 1 -- 1 HUAWEI-p59G d4:94:e8:01:bc:20 AP -- 2 -4 -- 100 1
WPA/WPA2-PSK(TKIP&AES) 11b/g/n --
------------------------------------------------------------------------------------------------------------------------------
-----------------------------

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1460


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.9.25 Querying the number of connected ONT users (LST-


ONTUSER)
Usage Note
This command is used to query the number of connected ont users information of
an ONT.

Command Format
LST-ONTUSER::(DID=Device-ID|DEV=Device-name)[,(FN=Frame-id,SN=Slot-id,PN=Port-id)],(ONTID=ont-id)|
(ONTKEY=ONT-key)|(PWD=password)|(LOID=loid)|(ONTSN=ont-SN)|(ONTMAC=ont-MAC)|(NAME=ont-
name)|(ALIAS=Alias):CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

94 MA5603U

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER 7340032-825 Indicates the -


3439 device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1461


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the -


STRING 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 A.8
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.

ONTID INTEGER 0-255 Indicates the -


ONT ID.
ONTMAC and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1462


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTKEY OCTET SIZE (32) Indicates the -


STRING ONT key. You
can locate an
ONT
according to
the device
and the ONT
key.
This
parameter
can contain
the following
characters:
● English
letters: a
to z and A
to Z
● Digits: 0-9
● Special
characters
except
question
marks (?),
colons (:),
and
semicolons
(;).
If this
parameter is
set, you do
not need to
set the FN,
SN, PN,
ONTMAC,
and ONTID
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1463


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

ONTMAC OCTET SIZE (17) Indicates the -


STRING ONT MAC
address. A 12-
digit
hexadecimal
number (the
digit ranges
from 0 to 9 or
A to F). For
example,
51-53-35-35-
22-44.
ONTMAC and
ONTID are
alternative
parameters.

ONTSN OCTET SIZE (16) Indicates the -


STRING ONU SN. The
value is in
XXXXXXXXXX
XXXXXX
format, where
X is a
hexadecimal
number (0 to
9 or A to F).
ONTSN and
ONTID are
alternative
parameters.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1464


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

PWD OCTET SIZE (36) Indicates the -


STRING ONU
password.
NOTE
In the
command
format, the
PWD in front
of the CTAG
indicates the
location
information
(current ONU
password)
and the PWD
following the
CTAG
indicates the
ONU
password
after
replacement.

LOID OCTET SIZE (24) Indicates the -


STRING logical
authenticatio
n code of the
ONU.

NAME OCTET SIZE (255) Indicates the -


STRING ONU name.

ALIAS OCTET SIZE (255) Indicates the -


STRING ONU alias.

● You must enter either the device ID or the device DEV.


● Set one of the following parameter combinations to locate an ONT:
● (1) subrack ID, slot ID, port ID,(1)ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5)
PWD(6) LOID(7)NAME (8)ALIAS.
● (2) (1)ONTID; (2) ONTMAC; (3) ONTKEY(4) ONTSN(5) PWD(6) LOID(7)NAME
(8)ALIAS.
● You must enter the subrack ID, slot ID, and port ID in order. For example, you can enter
the slot ID only after you enter the subrack ID.

Response Format
It complies with the response format of the operation command provided in 9.3
Response Format Description.
title="Querying the number of connected ont users on the device"+device-name
name of attributes: DID FN SN PN ONTID ACCESSTYPE MACADDR DEVSTATUS

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1465


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER 7340032-8253439 Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONU


ID.

ACCESSTYPE OCTET STRING SIZE (32) Interface type.

MACADDR OCTET STRING SIZE (32) Indicates the MAC


address of the
device.

DEVSTATUS OCTET STRING SIZE (32) Indicates the


status of the
device.

Example
To query the Wi-Fi device information under port 0/6/6 on the device named
10.176.99.12, run the following command:
LST-ONTUSER::DEV=10.176.99.12,FN=0,SN=6,PN=6,ONTID=0:CTAG::;
The result is as follows:
7340066 2017-10-31 17:39:57
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=25
blktotal=25

Qry the Connected Numbers of ont user 10.176.99.12


-----------------------------------------------------------
DID FN SN PN ONTID ACCESSTYPE MACADDR DEVSTATUS
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:3c offline
7340066 0 6 6 0 802.11 d0:ff:98:2c:ec:f0 online
7340066 0 6 6 0 802.11 04:4f:4c:22:75:e5 offline
7340066 0 6 6 0 802.11 d0:ff:98:2c:ec:ba online
7340066 0 6 6 0 802.11 04:4f:4c:22:76:06 offline
7340066 0 6 6 0 802.11 0c:8f:ff:69:7c:40 offline
7340066 0 6 6 0 802.11 70:8a:09:da:1d:b7 offline
7340066 0 6 6 0 802.11 c8:94:bb:e3:6c:cc offline
7340066 0 6 6 0 802.11 54:b1:21:90:09:9c offline
7340066 0 6 6 0 802.11 1c:15:1f:7e:be:d1 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:c3 offline
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:75 offline

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1466


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340066 0 6 6 0 802.11 0c:8f:ff:69:7b:c1 offline


7340066 0 6 6 0 802.11 c8:94:bb:c7:c9:37 online
7340066 0 6 6 0 802.11 0c:8f:ff:d3:d4:92 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:74 offline
7340066 0 6 6 0 802.11 c8:94:bb:7b:57:b7 offline
7340066 0 6 6 0 Ethernet 00:1b:21:d1:6a:25 online
7340066 0 6 6 0 802.11 2c:59:8a:5d:29:e8 online
7340066 0 6 6 0 802.11 0c:8f:ff:89:5a:b4 offline
7340066 0 6 6 0 802.11 0c:8f:ff:d3:d3:ec offline
7340066 0 6 6 0 802.11 3c:a9:f4:cc:ce:e4 offline
7340066 0 6 6 0 802.11 0c:8f:ff:89:5b:27 offline
7340066 0 6 6 0 802.11 c8:94:bb:c7:c9:3b offline
7340066 0 6 6 0 802.11 70:8a:09:d3:7d:6c offline
-----------------------------------------------------------

Related Command
None.

14.9.26 Querying the DBA Profile and CAR Profile Bound to an


EPON ONT (LST-EPONONTDBACARPROF)
Usage Note
● The OLT must be online.
● The OLT of a specific version must support the EPON service.

Command Format
LST-EPONONTDBACARPROF::(DID=Device-ID|DEV=Device-name),FN=Frame-num,SN=Slot-num,PN=Port-
num,ONTID=ont-id:CTAG::;

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

2331 MA5608T

249 MA5600T

2348 MA5683T

2369/2370/2398/2399 MA5801-GP08/MA5801-CG04/
MA5801-FL16/MA5801S-FL16

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1467


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the -


device ID.

DEV OCTET SIZE (192) Indicates the -


STRING 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
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.

ONTID INTEGER 0-255 Indicates the -


NOTE ONT ID.
If the UNI
port is of 10G
EPON, the
value range is
0-255; if the
UNI port is of
1G EPON, the
value range is
0-127.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1468


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

The device ID or device name must be specified.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Ont dba and car profile of the device " +device-name
name of attributes: DevID DevName NSN N ONTID LlidIndex LLidValue DbaProfileName
CarProfileName

Output Parameters
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

ONTID INTEGER 0-255 Indicates the ONT


NOTE ID.
If the UNI port is
of 10G EPON, the
value range is
0-255; if the UNI
port is of 1G
EPON, the value
range is 0-127.

LlidIndex INTEGER 0-255 Indicates the LLID


index.

LLidValue INTEGER 0-255 Indicates the LLID


NOTE value.
When the returned
value of LLID is
empty, the value is
displayed as --.

DbaProfileName OCTET STRING SIZE (32) Indicates the


NOTE name of the DBA
When the returned profile.
value of the DABA
profile name is
empty, the value is
displayed as --.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1469


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

CarProfileName OCTET STRING SIZE (32) Indicates the


NOTE name of the CAR
When the returned profile.
value of the DABA
profile name is
empty, the value is
displayed as --.

Error code
ID Description Solution

1610612764 Device The cause is usually that the device is offline.


timeout. Verify that the following faults do not occur:
● The physical connection is disconnected.
● The SNMP read and write community names
are set incorrectly.
● The NCE cannot ping the device because of
network faults.

2686058531 The device ● Check whether the device has been


does not successfully added to the NCE.
exist. ● By default, devices are located by name in
the location information. When the value of
DEVMEAN is set to 1, the meaning of DEV is
the IP address of the device.

2686058554 Command Ensure that the command supports the entered


does not device name or IP address.
support this
device type.

2686058498 Missing, Verify that the command is correct according to


invalid the following requirements:
parameter ● The parameter values do not exceed the
or ranges of the parameters specified by the
mandatory command.
parameter is
blank, or the ● The entered parameter names are correct.
parameter ● The parameters are entered in the correct
value is order.
wrong.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1470


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
● To query the name of the CAR profile and DBA profile of an ONT whose
ONTID is 3 on port 0/3/0 on the device named 10.185.215.2,
– run the following commands:
LST-
EPONONTDBACARPROF::DEV=10.185.215.2,FN=0,SN=3,PN=0,ONTID=3
:CTAG::;
– The result is as follows:
i. M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Ont dba and car profile of the device 10.185.215.2
--------------------------------------------------------------------------------
--------------------------------------------------
DevID DevName FN SN PN ONTID LlidIndex LLidValue
DbaProfileName CarProfileName
7340033 10.185.215.2 0 3 0 3 0 -- dba-profile_1 1111
--------------------------------------------------------------------------------
--------------------------------------------------
;

Related Commands
None

14.9.27 Querying a Global EPON Line Profile Name List(LST-


GLOBALEPONLINEPROFILENAME)
Usage Note
This command is used to query names of Global EPON Line Profiles.

Command Format
LST-GLOBALEPONLINEPROFILENAME:::CTAG::PROFILENAME=profile-name[,SCOPEPROFID=device-profile-
name];

Supporting Device
Device Type No. Device Type

34 MA5680T

95 MA5603T

249 MA5600T

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1471


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2

Input Parameter
Para Type Range Description Default
mete
r

PROFI OCTET SIZE(32) Indicates the name of the -


LENA STRING global EPON line profile.
ME

SCOP OCTET SIZE(32) (Optional) Indicates the device -


EPRO STRING scope profile name.
FID

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes: PROFILENAMESCOPEPROFID

Output Parameter
Param Type Range Description
eter

PROFIL OCTET SIZE(32) Indicates the name of the global


ENAME STRING EPON line profile.

SCOPE OCTET SIZE(32) Indicates the device scope profile


PROFID STRING name.

Error Code
ID Description Solution

2686058552 The resource does The required global EPON line profile
not exist. does not exist. In this case, verify that
the entered global EPON line profile is
correct.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1472


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058498 Missing, invalid Verify that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is null, ● The parameter values do not exceed
or the parameter the ranges of the parameters
value is wrong. specified by the command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

Example
To query a global EPON line profile list whose name is Test1.

● run the following command:


LST-GLOBALEPONLINEPROFILENAME:::CTAG::PROFILENAME=Test1;
● The result is as follows:
0 2018-05-17 00:37:56
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Profile information
----------------
PROFILENAME SCOPEPROFID
Test1 --
----------------
;

Related Command
None.

14.9.28 Querying a Global EPON Service Profile Name List


(LST-GLOBALEPONSRVPROFILENAME)

Usage Note
This command is used to query a global EPON service profile name list. To ensure
the query accuracy, a global EPON service profile must have been created before
this command is run.

Command Format
LST-GLOBALEPONSRVPROFILENAME:::CTAG::PROFILENAME=profile-name[,SCOPEPROFID=device-profile-
name];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1473


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2

Input Parameter
Paramet Type Range Description Default
er

PROFILE OCTET SIZE (32) Indicates the EPON -


NAME STRING service profile name.

SCOPEP OCTET SIZE(32) Indicates the device -


ROFID STRING scope profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Profile information"
name of attributes: PROFILENAMESCOPEPROFID

Output Parameter
Parameter Type Range Description

PROFILENA OCTET SIZE (32) Indicates the EPON service


ME STRING profile name.

SCOPEPROF OCTET SIZE (32) Indicates the device scope


ID STRING profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1474


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

26860584 Missing, invalid Ensure that the command is correct


98 parameter or according to the following requirements:
mandatory parameter ● The parameter values do not exceed
is blank, or the the ranges of the parameters specified
parameter value is by the command.
wrong.
● The parameter names are correct.
● The parameters are entered in the
correct order.

10269087 The resource does not Check whether the profile to be queried
3 exist. exists.

Example
To query a profile name list whose EPON service profile name is Test1, run the
following command:
LST-GLOBALEPONSRVPROFILENAME:::CTAG::PROFILENAME=Test1;
The result is as follows:
0 2018-05-16 19:26:42
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Profile information
-----------------------------
PROFILENAME SCOPEPROFID
Test1 --
-----------------------------

Related Command
None.

14.9.29 Querying EPON Line Profile Names (LST-


EPONLINEPROFILE)
Usage Note
This command is used to query names of NE-side EPON line profiles. To ensure
accurate query results, synchronize NE-side EPON line profiles to the NCE before
running this command.

Command Format
LST-EPONLINEPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=line-profile-name];

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1475


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

249 MA5600T

95 MA5603T

34 MA5680T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2

Input Parameter
Para Type Range Description Default
mete
r

DID INTEGER - Indicates the device ID. -

DEV OCTET SIZE Indicates the default OLT device -


STRING (192) 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 A.8 How
to Locate a Device According to
the IP Address.

PROF OCTET SIZE Indicates the name of a EPON -


ID STRING (32) line profile.
You can search for profiles by
profile name or some characters
in the profile name.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="EPON LineProfile of the Device"
name of attributes: DIDPROFID

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1476


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parame Type Range Description
ter

DID INTEGER - Indicates the device ID.

PROFID OCTET SIZE (32) Indicates the name of a EPON


STRING line profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is blank, ● The parameter values do not
or the parameter exceed the ranges of the
value is wrong. parameters specified by the
command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
To query the EPON line profile whose name contains characters "aa" on the device
named 10.185.215.115, run the following command:
LST-EPONLINEPROFILE:::CTAG::DEV=10.185.215.115,PROFID=xzvzxc;
The result is as follows:
0 2018-05-15 23:56:28
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

EPON LineProfile of the Device


----------------
DID PROFID
7340036 xzvzxc
----------------
;

Related Command
None.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1477


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

14.9.30 Querying EPON Service Profile Names (LST-


EPONSRVPROFILE)
Usage Note
This command is used to query names of NE-side EPON service profiles. To ensure
accurate query results, synchronize NE-side EPON service profiles to the NCE
before running this command.

Command Format
LST-EPONSRVPROFILE:::CTAG::(DID=Device-ID|DEV=Device-name)[,PROFID=service-profile-name];

Supporting Device
Device Type No. Device Type

34 MA5680T

249 MA5600T

95 MA5603T

2331 MA5608T

2348 MA5683T

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-X15/MA5800-X2

Input Parameter
Para Type Range Description Default
met
er

DID INTEGER - Indicates the device ID. -

DEV OCTET SIZE Indicates the default OLT device -


STRING (192) 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 A.8 How to Locate a
Device According to the IP Address.

PRO OCTET SIZE Indicates the name of a EPON -


FID STRING (32) service profile.
You can search for profiles by profile
name or some characters in the
profile name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1478


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="EPON ServiceProfile of the Device"
name of attributes: DIDPROFID

Output Parameter
Parame Type Range Description
ter

DID INTEGER - Indicates the device ID.

PROFID OCTET SIZE (32) Indicates the name of a EPON


STRING service profile.

Error Code
ID Description Solution

2686058498 Missing, invalid Ensure that the entered command is


parameter or correct according to the following
mandatory requirements:
parameter is ● The parameter values do not
blanks, or the exceed the ranges of the
parameter value is parameters specified by the
wrong. command.
● The parameter names are correct.
● The parameters are entered in the
correct order.

2686058552 The resource does Check whether the profile to be


not exist. queried exists.

Example
To query the EPON service profile whose name contains characters "asdf" on the
device named 10.78.217.216, run the following command:
LST-EPONSRVPROFILE:::CTAG::DEV=10.185.215.115,PROFID=asdf;
The result is as follows:
0 2018-05-17 00:37:56
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

EPON ServiceProfile of the Device


----------------

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1479


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

DID PROFID
7340036 asdf
----------------
;

Related Command
None.

14.10 CNU Resource Query


This topic describes commands and examples for querying a CNU list or details
about a CNU.

14.10.1 Querying the List of CNUs (LST-CNU)


Usage Note
The MA5631 is online and its H831HE1A board is working properly.

Command Format
LST-CNU::((DID=Device-ID|DEV=Device-name)[[,FN=Frame-id[,SN=Slot-id[,PN=Port-id[,CNUID=cnu-id]]]]|
(KEY=cnu-sn))]:CTAG::;

Supporting Device
Device Type No. Device Type

2317 MA5631
NOTE
The MA5631 V800R308C02 and later
versions support this command.

2318 MA5632
NOTE
The MA5632 V800R310 and later versions
support this command.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1480


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

CNUID INTEGER 0-63 Indicates the N/A


CNU ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1481


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

KEY OCTET SIZE (16) Indicates the N/A


STRING serial number
(SN) of the
CNU for
authenticatio
n. The SN can
contain
characters A-
F, a-f, 0-9, and
other special
characters
excluding ? : ;
,.
This
parameter
can be set
only when
AUTH is set
to SN.

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.
title="CNU information of the device "+device-name
name of attributes: DID FN SN PN CNUID NAME ALIAS AUTH MAC KEY LINEPROF
VENDORID TYPE VERSION

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

CNUID INTEGER 0-63 Indicates the CNU


ID.

NAME OCTET STRING SIZE (255) Indicates the CNU


name.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1482


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

ALIAS OCTET STRING SIZE (64) Indicates the CNU


alias.

AUTH OCTET STRING ● MAC Specifies in which


● SN mode the CNU is
authenticated by
the CBAT.

MAC OCTET STRING SIZE (17) Indicates the MAC


address of the
CNU for
authentication.
The MAC address
is a 12-digit
hexadecimal
number, for
example,
51-53-35-35-22-4
4.

KEY OCTET STRING SIZE (16) Indicates the


serial number
(SN) of the CNU
for
authentication.
The SN can
contain characters
A-F, a-f, 0-9, and
other special
characters
excluding ? : ; ,.

LINEPROF OCTET STRING SIZE (32) Indicates the line


profile bound to
the CNU.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID of the
CNU.

TYPE OCTET STRING SIZE (40) Indicates the CNU


type.

VERSION OCTET STRING SIZE (32) Indicates the


software version
of the CNU.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1483


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that


the device is offline.
Ensure that the following
faults do not occur:
● The physical
connection is
disconnected.
● The SNMP read and
write community
names are set
incorrectly.
● NCE cannot ping the
device because of
network faults.

2686058531 The device does not Ensure that the device is


exist. successfully added to the
NCE. If the device is
located according to the
device name, enter the
device name as the value
of the DEV parameter.
Otherwise, enter the IP
address of the device.

2686058554 Command does not Ensure that the


support this device type. command supports the
entered device name or
IP address.

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
the parameter value is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● The parameters are
entered in the correct
order.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1484


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Example
To query the list of CNUs connected to the device named 10.144.81.58, run the
following command:
LST-CNU::DEV=10.144.81.58:6::;
The result is as follows:
● Discrete mode:
7340161 2011-04-21 11:38:55
M 6 COMPLD
blktag=1
blkcount=14
blktotal=14

CNU information of the device 10.144.81.58


-----------------------------------------------------------------------------------------------
DID FN SN PN CNUID NAME ALIAS AUTHMODE MAC KEY LINEPROF
VENDORID TYPE VERSION
7340161 0 1 0 0 10.144.81.58/0/1/0/0 SN 4fr4t44 cnu-line-profile_1
7340161 0 1 0 1 10.144.81.58/0/1/0/1 iii SN FF-FF-FF-FF-FF-FF feafee
werwe
7340161 0 1 0 2 10.144.81.58/0/1/0/2 SN FF-FF-FF-FF-FF-FF fefeadf cnu-line-
profile_1
7340161 0 1 0 3 10.144.81.58/0/1/0/3 SN FF-FF-FF-FF-FF-FF 4551 cnu-line-
profile_1
7340161 0 1 0 4 10.144.81.58/0/1/0/4 SN FF-FF-FF-FF-FF-FF 124227 cnu-line-
profile_1
7340161 0 1 0 5 10.144.81.58/0/1/0/5 MAC 66-66-66-66-66-66 werwe
7340161 0 1 0 6 10.144.81.58/0/1/0/6 SN FF-FF-FF-FF-FF-FF 4584 cnu-line-
profile_1
7340161 0 1 0 7 10.144.81.58/0/1/0/7 SN FF-FF-FF-FF-FF-FF fefauiku cnu-line-
profile_1
7340161 0 1 0 8 10.144.81.58/0/1/0/8 SN FF-FF-FF-FF-FF-FF op9 cnu-line-
profile_1
7340161 0 1 0 9 10.144.81.58/0/1/0/9 SN FF-FF-FF-FF-FF-FF uyjyrgr cnu-line-
profile_1
7340161 0 1 0 10 10.144.81.58/0/1/0/10 SN FF-FF-FF-FF-FF-FF kuilkil cnu-line-
profile_1
7340161 0 1 0 11 10.144.81.58/0/1/0/11 SN FF-FF-FF-FF-FF-FF 42258 cnu-line-
profile_1
7340161 0 3 0 1 10.144.81.58/0/3/0/1 SN FF-FF-FF-FF-FF-FF 78feaf cnu-line-
profile_1
7340161 0 4 0 1 10.144.81.58/0/4/0/1 SN FF-FF-FF-FF-FF-FF 1111 cnu-line-
profile_1
-----------------------------------------------------------------------------------------------

Related Command
There is no related command.

14.10.2 Querying the Details of a CNU (LST-CNUDETAIL)


Usage Note
The MA5631 is online and its H831HE1A board is working properly.

Command Format
LST-CNUDETAIL::((DID=Device-ID|DEV=Device-name),(FN=Frame-id,SN=Slot-id,PN=Portid,CNUID=cnu-id)|
(NAME=cnu-name)|(ALIAS=cnu-alias)|(KEY=cnu-sn)):CTAG::;

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1485


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Supporting Device
Device Type No. Device Type

2317 MA5631
NOTE
The MA5631 V800R308C02 and later
versions support this command.

2318 MA5632
NOTE
The MA5632 V800R310 and later versions
support this command.

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-255 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1486


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

CNUID INTEGER 0-63 Indicates the N/A


CNU ID.

NAME OCTET SIZE (128) Indicates the N/A


STRING CNU name.

ALIAS OCTET SIZE (128) Indicates the N/A


STRING CNU alias.

KEY OCTET SIZE (16) Indicates the N/A


STRING serial number
(SN) of the
CNU for
authenticatio
n. The SN can
contain
characters A-
F, a-f, 0-9, and
other special
characters
excluding ? : ;
,.

Response Format
This response format complies with that of the query command provided in 9.3
Response Format Description.
title="CNU detail information of the device "+device-name
name of attributes: DID FN SN PN CNUID NAME ALIAS AUTH MAC KEY LINEPROF
VENDORID TYPE VERSION RUNSTATUS OPERSTATUS LPSTATUS CFGSTATUS
LSTTIMEONLINE LSTTIMEOFFLINE REASONOFFLINE

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

FN INTEGER 0-255 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

CNUID INTEGER 0-63 Indicates the CNU


ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1487


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

NAME OCTET STRING SIZE (255) Indicates the CNU


name.

ALIAS OCTET STRING SIZE (64) Indicates the CNU


alias.

AUTH OCTET STRING ● MAC Specifies in which


● SN mode the CNU is
authenticated by
the CBAT.

MAC OCTET STRING SIZE (17) Indicates the MAC


address of the
CNU for
authentication.
The MAC address
is a 12-digit
hexadecimal
number, for
example,
51-53-35-35-22-4
4.

KEY OCTET STRING SIZE (16) Indicates the


serial number
(SN) of the CNU
for
authentication.
The SN can
contain characters
A-F, a-f, 0-9, and
other special
characters
excluding ? : ; ,.

LINEPROF OCTET STRING SIZE (32) Indicates the line


profile bound to
the CNU.

VENDORID OCTET STRING SIZE (32) Indicates the


vendor ID of the
CNU.

TYPE OCTET STRING SIZE (40) Indicates the CNU


type.

VERSION OCTET STRING SIZE (32) Indicates the


software version
of the CNU.

RUNSTATUS OCTET STRING ● ONLINE Indicates the


● OFFLINE running status of
the CNU.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1488


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

OPERSTATUS OCTET STRING ● ACTIVE Specifies whether


● DEACTIVE the CNU is
activated.

LPSTATUS OCTET STRING ● LOOPBACK Indicates the


● NOLOOPBACK loopback status of
the CNU.

CFGSTATUS OCTET STRING ● INITIAL Indicates the


● NORMAL configuration
status of the CNU.
● CONFIG
● FAILED

LSTTIMEONLINE OCTET STRING SIZE (64) Indicates the last


online time of the
CNU. The time is
in UTC format.

LSTTIMEOFFLINE OCTET STRING SIZE (64) Indicates the last


offline time of the
CNU. The time is
in UTC format.

REASONOFFLINE OCTET STRING ● NOPOWER Specifies why the


● RESET CNU went offline
last time.
● OFFLINE
● DEACTIVE

Error Code
ID Description Solution

1610612764 Device timeout. The cause is usually that


the device is offline.
Ensure that the following
faults do not occur:
● The physical
connection is
disconnected.
● The SNMP read and
write community
names are set
incorrectly.
● NCE cannot ping the
device because of
network faults.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1489


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

ID Description Solution

2686058531 The device does not Ensure that the device is


exist. successfully added to the
NCE. If the device is
located according to the
device name, enter the
device name as the value
of the DEV parameter.
Otherwise, enter the IP
address of the device.

2686058554 Command does not Ensure that the


support this device type. command supports the
entered device name or
IP address.

2686058498 Missing, invalid Verify that the command


parameter or mandatory is correct according to
parameter is blank, or the following
the parameter value is requirements:
wrong. ● The parameter values
do not exceed the
ranges of the
parameters specified
by the command.
● The entered
parameter names are
correct.
● The parameters are
entered in the correct
order.

Example
To query details about the CNU (ID: 0) on port 0/1/0 on the device named
10.144.81.58, run the following command:
LST-CNUDETAIL::DEV=10.144.81.58,FN=0,SN=1,PN=0,CNUID=0:6::;
The result is as follows:
7340161 2011-04-21 16:10:36
M 6 COMPLD

blktag=1
blkcount=1
blktotal=1

CNU detail information of the device 10.144.81.58


------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------
DID FN SN PN CNUID NAME ALIAS AUTH MAC KEY LINEPROF VENDORID TYPE
VERSION RUNSTATUS OPERSTATUS LPSTATUS CFGSTATUS LSTTIMEONLINE
LSTTIMEOFFLINE REASONOFFLINE

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1490


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

7340161 0 1 0 0 10.144.81.58/0/1/0/0
uiuiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu
uuuuuuuuuuuuuuuuu SN FF-FF-FF-FF-FF-FF 4fr4t44 cnu-line-profile_1 OFFLINE
ACTIVE -- NORMAL -- -- --
------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------

Related Command
There is no related command.

14.11 Querying CM Resources


This command is used to query CM (cable modem) resources.

14.11.1 Querying the Info of CM (LST-CMINFO)


Usage Note
This command is used to export the CM information about the network-wide
MA5600T, MA5603T, MA5608T, or a specific OLT. The configuration item
DUMP_MAX_FILE_SIZE controls the export file size. The configuration item
DUMP_MAX_FILE_SAVE_NUM controls the maximum number of files that can be
stored.

Command Format
LST-CMINFO::DEV=Device-name,FN=Frame-id,SN=Slot-id,PN=Portid:CTAG::DATATYPE=CMONLINE|
CMOFFLINE|CMCONNECT|CMCOUNT|CMPHY|CMSUM|CMCLOAD|CMPRIMARYCHN|
ACCESSGROUP[,FILENAME=file-name];

Supporting Device
Device Type No. Device Type

41 MA5600T

45 MA5680T

75 MA5603T

2331 MA5608T

2348 MA5683T

2330 MA5633

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1491


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Input Parameter
Para Type Range Description Defa
mete ult
r

DEV OCTET SIZE (192) Indicates the subrack ID. N/A


STRING

FN INTEGER 0-512 Indicates the subrack ID. N/A

SN INTEGER 0-35 Indicates the slot ID. N/A

PN INTEGER 0-63 Indicates the port ID. N/A

DATA OCTET ● CMONLIN Used to indicate output details N/A


TYPE STRING E content. The numeration includes
● CMOFFLIN the following values and each
E value means the output file
contains the pertinent CM
● CMCONNE information.
CT
NOTE
● CMCOUNT
● CMONLINE,CMOFFLINE: Indicate
● CMPHY the output details include the
offline CM information or all the
● CMSUM cable modem information.
● CMCLOAD ● CMCONNECT: It provides the
● CMPRIMA information like CISCO 'show cable
modem connectivity'.
RYCHN
● CMCOUNT: It provides the
● ACCESSGR information like CISCO 'show cable
OUP modem summary total'.
● CMPHY: It provides the
information like CISCO 'show cable
modem phy'.
● CMSUM: It provides the
information like CISCO 'show cable
modem counters '.
● CMCLOAD: show cable load-
balance
● CMPRIMARYCHN: This command
is used get output like cisco
command 'show cable modem
primary-channel'.
● ACCESSGROUP: This command is
used get output like cisco
command 'show cable device
access group'. The details for this
command include the inventory of
CM and CPE.

FILEN OCTET SIZE (128) Indicate the file name output by N/A
AME STRING NCE. It is optional. NCE will
automatically generate the file
name if it is not input.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1492


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.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 file


path:
Euler:ftproot/
access/cminfo.
The file name is
similar to
ASD_CMSUM_yyy
y-mm-dd_hh-
mm-ss_n_m.csv,
where n indicates
the sequence
number of a file
and m indicates
the total number
of files. If the
Service node is
deployed in a
cluster, the
exported file is
stored on the
Common Service
node. If the
Service node is
deployed in
single-instance
mode, the
exported file is
stored on the
NMS node.
NOTE
If a CSV file is over
large, it will be
divided into
multiple smaller
ones. If only one
file exists, n or m is
not displayed, for
example,
ASD_CMSUM_2016
-08-27_16-07-08.cs
v

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1493


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Error Code
ID Description Solution

1615003650 Incorrect parameter Set DT to a supported


input. value.

Example
To export CM information files for the MA5600T, run the following command:
LST-
CMINFO::DEV=10.185.119.153,FN=1,SN=1,PN=0:CTAG::DATATYPE=CMSUM,FILE
NAME=ASD;
The result is as follows:
7340035 2013-05-25 18:06:35
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1

Path information of the device-type 10.185.119.153


---------
PATH
server : ftproot/access/cmtsinfo/ASD_CMSUM_2016-08-27_16-07-08.csv
---------
;

Related Command
None

14.11.2 Querying the CPE List of a CM (LST-CMCPELIST)


Usage Note
This command is used to query the customer premises equipment (CPE) list of a
cable modem (CM). The CPE list can be queried only when the CM is online.

Command Format
LST-CMCPELIST::((DID=Device-ID|DEV=Device-name),(FN=Frame-id,SN=Slot-id,PN=Portid,CMID=cm-id)|
(CMMAC=cm-mac))|(CMMAC=cm-mac):CTAG::[SHOWOPTION=IPv6 IPv6Prefix IPv6Len];

Supporting Device
Device Type No. Device Type

2330 MA5633 V800R313C00 and later


versions

249 MA5600T V800R13C00 and later


versions

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1494


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Device Type No. Device Type

95 MA5603T V800R13C00 and later


versions

2331 MA5608T V800R13C00 and later


versions

2348 MA5683T V800R13C00 and later


versions

34 MA5680T V800R13C00 and later


versions

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1495


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

FN INTEGER 0-512 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

CMID INTEGER 1-32768 Indicates the N/A


CM ID.

CMMAC OCTET SIZE (17) Indicates the N/A


STRING CM MAC
address. The
MAC address
is unique for
a D-CMTS.
The address
format is XX-
XX-XX-XX-XX-
XX.

SHOWOPTIO OCTET ● IPv6 (Optional) -


N STRING ● IPv6Prefix Specifies the
attributes
● IPv6Len that can be
displayed in
the returned
result. If you
set this
parameter,
the
corresponding
attributes are
returned. By
default, the
attributes are
not displayed.

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Qry the CPE of a CM "+device-name
DID DEV FN SN PN CMID MAC CPEID CPEMAC CPEIP IPv6 IPv6Prefix IPv6Len

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1496


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Output Parameter
Parameter Type Range Description

DID INTEGER - Indicates the


device ID.

DEV OCTET STRING SIZE (192) Indicates the


device name.

FN INTEGER 0-512 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

CMID INTEGER 1-32768 Indicates the CM


ID.

MAC OCTET STRING SIZE (17) Indicates the CM


MAC address. The
address format is
XX-XX-XX-XX-XX-
XX.

CPEID INTEGER 0-255 Indicates the CPE


index.

CPEMAC OCTET STRING SIZE (17) Indicates the CPE


MAC address. The
address format is
XX-XX-XX-XX-XX-
XX.

CPEIP IPADDRESS - Indicates the CPE


IP address.

IPv6 IPV6ADDRESS - Indicates the CPE


IPv6 address. The
standard IPv6
address format is
XXXX:XXXX:XXXX:X
XXX:XXXX:XXXX:XX
XX:XXXX.

IPv6Prefix IPV6ADDRESS - Indicates the


prefix of the CPE
IPv6 address. The
standard IPv6
address format is
XXXX:XXXX:XXXX:X
XXX:XXXX:XXXX:XX
XX:XXXX.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1497


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

IPv6Len INTEGER 0-128 Indicates the


length of the CPE
IPv6 address.

Error Code
ID Description Solution

2686058552 The resource does not If the queried resource


exist. does not exist, enter a
parameter to locate an
available resource and
then reissue the
command.

Example
To query the CPE List of the CM 4 connected to port 0/1/0 on the device named
10.144.76.223, run the following command:

LST-CMCPELIST::DEV=10.144.76.223,FN=0,SN=1,PN=0,CMID=4:CTAG::;

The result is as follows:


7340035 2013-05-25 18:06:35
M CTAG COMPLD
EN=0 ENDESC=Succeeded.
blktag=1
blkcount=1
blktotal=1
Qry the CPE of a CM 10.144.76.223
-----------------------------------------------------------------------------------------
DID DEV FN SN PN CMID MAC CPEID CPEMAC CPEIP
7340035 10.144.76.223 0 1 0 4 00-24-A2-17-E8-58 2 00-24-A1-15-E7-28 10.11.117.157

-----------------------------------------------------------------------------------------
;

Related Command
None

14.11.3 Collecting Statistics on a CM (LST-CMNUMSTATIC)

Usage Note
This command is used to collect statistics on a cable modem (CM). The statistics
on port 0/1/0 are collected by default if no subrack ID/slot ID/port ID is entered.
For OLTs, the subrack ID/slot ID/port ID is mandatory.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1498


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Command Format
LST-CMNUMSTATIC::(DID=Device-ID|DEV=Device-name),[FN=Frame-id,SN=Slot-id,PN=Portid]:CTAG::
[RFFLAG=TRUE|FALSE];

Supporting Device
Device Type No. Device Type

2330 MA5633 V800R313C00 and later


versions

249 MA5600T V800R13C00 and later


versions

95 MA5603T V800R13C00 and later


versions

2331 MA5608T V800R13C00 and later


versions

2348 MA5683T V800R13C00 and later


versions

34 MA5680T V800R13C00 and later


versions

2346/2349/2352/2353 MA5800-X17/MA5800-X7/MA5800-
X15/MA5800-X2

2363/2361/2362/2360 EA5800-X17/EA5800-X7/EA5800-X15/
EA5800-X2

Input Parameter
Parameter Type Range Description Default

DID INTEGER - Indicates the N/A


device ID.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1499


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description Default

DEV OCTET SIZE (192) Indicates the N/A


STRING 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 A.8
How to
Locate a
Device
According to
the IP
Address.

FN INTEGER 0-512 Indicates the N/A


subrack ID.

SN INTEGER 0-35 Indicates the N/A


slot ID.

PN INTEGER 0-63 Indicates the N/A


port ID.

RFFLAG OCTET ● TRUE Indicates the FALSE


STRING ● FALSE radio
frequency
(RF) port ID.
The options
are as follows:
● TRUE:
queries the
statistics
on RF
ports.
● FALSE:
queries the
statistics
on
upstream
channels.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1500


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Response Format
It complies with the response format of the query command provided in 9.3
Response Format Description.
title="Qry the static of cm number "+device-name
DID DEV FN SN PN USCHANNELID TOTAL REG UNREG OFFLINE WIDEBAND INIT-RC INIT-
D INIT-IO INIT-O DESC

Output Parameter
Parameter Type Range Description

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 A.8
How to Locate a
Device According
to the IP
Address.

FN INTEGER 0-512 Indicates the


subrack ID.

SN INTEGER 0-35 Indicates the slot


ID.

PN INTEGER 0-63 Indicates the port


ID.

USCHANNELID OCTET STRING 1-16 Indicates the ID of


UB the upstream
channel.
NOTE
UB indicates that When the
the channel is a RFFLAG is set to
cross channel. TRUE, the
displayed value is
invalid.

Issue 01 (2020-05-31) Copyright © Huawei Technologies Co., Ltd. 1501


iMaster NCE
Northbound TL1 Interface User Guide 14 Inventory Management

Parameter Type Range Description

TOTAL INTEGER 0-65535 Indicates the total


number of CMs.

REG INTEGER 0-65535 Indicates the total


number of CMs
that are registered
and online.

UNREG INTEGER 0-65535 Indicates the total


number of CMs
that are
unregistered.

OFFLINE INTEGER 0-65535 Indicates the total


number of CMs
that are offline.

WIDEBAND INTEGER 0-65535 Indicates the total


number of CMs
that are registered
as a wideband

You might also like