Northbound Interface
TL1

User Manual
Version: 04

FiberHome Telecommunication Technologies Co., Ltd.
January 2022

Copyright © FiberHome Telecommunication Technologies Co.,Ltd. All rights reserved.
No part of this document (including the electronic version) may be reproduced or transmitted in any form or by
any means without prior written permission from FiberHome.

Trademarks and Permissions
and other FiberHome trademarks are trademarks of FiberHome Telecommunication Technologies
Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective holders.

Legal Notice
The purchased products, services or features shall be subject to the commercial contracts made between
FiberHome and the customer. All or part of the products, services or features described in this document may
not be within the purchase or usage scope.
Information in this document is subject to change without notice. All statements, information and
recommendations in this document are believed to be accurate but do not constitute the warranty of any kind,
express or implied.

FiberHome Telecommunication Technologies Co., Ltd.

Address: No.6, Gaoxinsilu, High-Tech Development Zone, Wuhan, Hubei
Province, P. R. China
Postcode: 430205
Website: http://www.fiberhome.com
Tel: +86 800-8800787; +86 400-8890787

Preface
Version
Version

Description

01

Initial version for the UNM2000 V2R11

02

Update some command descriptions.

03

Add commands such as MODIFY-ONUVOIPSERVICE.

04

Modify some descriptions for CFG-WIFISERVICE and MODIFY-WIFISERVICE.

Symbol Conventions
Symbol

Convention

Description

Note

Important features or operation guide.

Caution

Warning

Possible injury to persons or systems, or cause traffic interruption or
loss.
May cause severe bodily injuries.

Contents
Preface ..................................................................................................................I
1

2

3

4

5

TL1 Northbound Interface Overview .............................................................. 1
1.1

TL1 Interface Introduction............................................................... 1

1.2

Network Diagram ............................................................................ 1

1.3

Protocols Used................................................................................ 3

1.4

Management Function..................................................................... 4

1.5

Security Mechanism........................................................................ 5

1.6

Performance Specifications ............................................................ 5

TL1 Northbound Interface Installation ........................................................... 7
2.1

Installing the TL1 Northbound Interface .......................................... 7

2.2

Starting / Stopping the TL1 Northbound Interface Service............... 7

Command Format ......................................................................................... 8
3.1

Format Overview ............................................................................. 8

3.2

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

3.3

Acknowledgment Message Format ............................................... 10

3.4

Response Message Format ........................................................... 11

3.5

Resource Change Notification Format ........................................... 13

3.6

Definition of Returned Error Codes ................................................ 14

Session Control........................................................................................... 16
4.1

Logging into the FiberHome EMS (LOGIN) ..................................... 16

4.2

Logging Out of the FiberHome EMS (LOGOUT).............................. 17

4.3

Handshake Command (SHAKEHAND) ........................................... 18

Service Commissioning Interface................................................................ 20
5.1

ONU Configuration (FTTH) ............................................................ 20
5.1.1

Adding an ONU (ADD-ONU) ............................................. 20

5.1.2

Configuring an ONU (CFG-ONU) ...................................... 22

5.1.3

Configuring the Bandwidth of an ONU (CFG-ONUBW)...... 24

5.1.4

Deleting an ONU (DEL-ONU) ............................................ 26

5.1.5

Configuring the MAC Address Limit of an LAN Port (CFGLANPORTMACLIMIT) ...................................................... 28

5.1.6

Configuring the Wi-Fi Service (CFG-WIFISERVICE) .......... 30

5.1.7

修改Wi-Fi业务（CFG-WIFISERVICE） .............................. 34

5.1.8

Configuring a WAN Connection (SET-WANSERVICE)....... 34

5.1.9

Deleting a WAN Connection (SET-WANSERVICE) ............ 37

5.1.10

配置ONU的带宽模板（CFG-ONUBWPROFILE） ............... 40

5.1.11

去绑定ONU的带宽模板（UNBIND-ONUBWPROFILE）...... 40

5.1.12

Configuring the Rate-control Bandwidth of a L3 Service
(CFG-LT-BWPROFILE) ..................................................... 40

5.1.13

Binding a Traffic Policy to an ONU Port (CFGPORTBINDFLOWPOLICY) ................................................ 42

5.1.14

Configuring Sub-port of Aggregation Port (SETUPLINKTRUNK) ............................................................... 44

5.1.15
5.2

Query Port of the TRUNK Port Link Aggregation.............. 46

Broadband / IPTV Services of a LAN Port...................................... 47
5.2.1

Activating a LAN Port (ACT-LANPORT) ........................... 47

5.2.2

Deactivating a LAN Port (DACT-LANPORT) ..................... 49

5.2.3

Configuring a LAN Port (CFG-LANPORT)......................... 51

5.2.4

Configuring the VLAN of a PON Port (ADD-PONVLAN) .... 54

5.2.5

Deleting the VLAN of a PON Port (DEL-PONVLAN) .......... 56

5.2.6

Configuring the VLAN of a LAN Port (CFGLANPORTVLAN).............................................................. 58

5.2.7

Deleting the VLAN of a LAN Port (DEL-LANPORTVLAN) .. 60

5.2.8

LAN端口配置IPTV 业务（CFG-LANIPTVPORT） ............. 62

5.2.9

Adding a LAN Port into a Multicast VLAN (ADDLANIPTVPORT) ............................................................... 62

5.2.10

Configuring the IPTV Service of a LAN Port (CFGLANIPTVPORT) ............................................................... 65

5.2.11

Deleting a LAN Port from a Multicast VLAN (DELLANIPTVPORT) ............................................................... 67

5.2.12

新增HG管理通道配置(CFG-NONOMCIMPATHCONFIG) .... 69

5.2.13

Adding VEIP Data Service (CFG-VEIPSERVICE) ............... 69

5.2.14

Modifying VEIP Data Service (MODIFY-VEIPSERVICE) .... 71

5.2.15

去绑定VEIP数据业务(UNBIND-VEIPSERVICE) .................. 73

5.2.16

Deleting VEIP Data Service (DEL-VEIPSERVICE) .............. 74

5.3

Broadband / IPTV Services of an xDSL Port .................................. 75
5.3.1

Activating a DSL Port (ACT-DSLPORT)............................ 75

5.3.2

Deactivating a DSL Port (DACT-DSLPORT)...................... 77

5.3.3

Configuring the Bandwidth of a DSL Port (CFGDSLPORTBW).................................................................. 79

5.3.4

Configuring the VLAN of a DSL Port (CFGDSLPORTVLAN) .............................................................. 80

5.3.5

Deleting the VLAN of a DSL Port (DEL-DSLPORTVLAN)... 82

5.3.6

Adding a Multicast User for a DSL Port (ADDDSLIPTVPORT) ............................................................... 84

5.3.7

Deleting a Multicast User of a DSL Port (DELDSLIPTVPORT) ............................................................... 86

5.3.8

Configuring the DSL Port Parameters (CFGDSLIPTVPORT) ............................................................... 88

5.4

VoIP Service.................................................................................. 90
5.4.1

Activating a VoIP Port (ACT-VOIPPORT) ......................... 90

5.4.2

Deactivating a VoIP Port (DACT-VOIPPORT) ................... 92

5.4.3

Configuring the Voice Service of a VoIP Port (CFGVOIPSERVICE)................................................................. 94

5.4.4

Deleting the Voice Service of a VoIP Port (DELVOIPSERVICE)................................................................. 97

5.4.5

Configuring the NGN Uplink Interface (SET-NGNUPLINK) .......................................................................... 99

5.4.6
5.5

5.6

修改VOIP端口语音编码（MODIFY-ONUVOIPSERVICE） 102

VLAN Service .............................................................................. 102
5.5.1

Creating a VLAN (ADD-VLAN) ....................................... 102

5.5.2

Deleting a VLAN (DEL-VLAN)......................................... 104

Configuring a Port Speed Rate Template..................................... 105
5.6.1

Adding a Port Rate Limiting Template (ADDPORTSPEEDLIMITPROFILE) .......................................... 106

5.6.2

Deleting a Port Rate Limiting Template (DELPORTSPEEDLIMITPROFILE) .......................................... 107

5.7

Configuring a Bandwidth Template.............................................. 109
5.7.1

Adding a Bandwidth Template (ADD-BWPROFILE) ........ 109

5.7.2

Deleting a Bandwidth Template (DEL-BWPROFILE) ....... 111

5.8

Configuring a Flow Policy ............................................................ 112
5.8.1

Adding a Traffic Policy (ADD-FLOWPOLICY) ................. 112

5.8.2

Deleting a Traffic Policy (DEL-FLOWPOLICY) ................ 114

5.8.3

Adding a Port Flow Policy (ADDPORTPVCFLOWPOLICY)................................................ 116

6

Integrated Testing Interface ...................................................................... 118
6.1

The Ping Command..................................................................... 118
6.1.1

6.2

6.3

Using PING on an ONU (PING) ....................................... 118

Querying the Equipment Information ........................................... 121
6.2.1

Querying the NE Information (LST-DEVINFO) ................ 121

6.2.2

Querying the Card Information (LST-BRDINFO) ............. 123

Querying the PON Information..................................................... 126
6.3.1

Querying the PON Port Information (LST-PONINFO)...... 126

6.3.2

Querying the PON Link Statistics Information (LSTPONPERF) ..................................................................... 127

6.3.3

Querying the ONU Configuration (LST-ONUCFG) ........... 131

6.3.4

Querying the ONU Status (LST-ONUSTATE) .................. 133

6.3.5

Querying the MAC Address Table of an ONU UNI Port (LSTPORTMACADDRESS) .................................................... 135

6.3.6

Querying the DDM Information of Optical Modules (LSTOMDDM) ....................................................................... 138

6.3.7

Querying the Unregistered ONU of a PON Port (LSTUNREGONU) .................................................................. 142

6.3.8

Querying the Wi-Fi Service Information of an ONU (LSTWIFISERVICE)................................................................ 144

6.3.9

Querying the WAN Service Information of an ONU (LSTONUWANSERVICECFG) ................................................. 147

6.3.10

Restarting an ONU (RESET-ONU)................................... 151

6.3.11

Querying the IP Address / Range Allocated to a User by WiFi (LST-USERDHCPSERVER) ......................................... 153

6.3.12

Modifying the IP Address / Range Allocated to a User by
Wi-Fi (CFG-USERDHCPSERVER).................................... 156

6.3.13

Querying the Web Interface Username and Password (LSTWEBADMINISTRATOR) ................................................. 158

6.3.14

Modifying the Web Interface Username and Password
(CFG-WEBADMINISTRATOR) ........................................ 160

6.3.15

Restoring an ONU to Factory Default Settings (RESTOREDEFAULTCFG) ............................................................... 162

6.4

Querying the LAN Information ..................................................... 163
6.4.1

Querying the LAN Port Information (LST-ONULANINFO) 164

6.4.2

Querying the LAN Port Rate Control (LST-LANCAR) ...... 167

6.4.3

Querying the ETH Performance (LST-LANPERF) ........... 170

6.4.4

Conducting the Broadband Dial-up Emulation Test (TESTPPPOESIMULATION)..................................................... 173

6.5

Querying the DSL Information ..................................................... 177
6.5.1

Querying the ADSL2+ Port Information (LST-ADSLINFO)177

6.5.2

Querying the ADSL2+ Port Performance (LSTADSLPERF) ................................................................... 181

6.5.3

Querying the ADSL2+ Port Statistics Information (LSTADSLSTAT) ................................................................... 183

6.5.4

Querying the VDSL2 Port Information (LST-VDSLINFO). 186

6.5.5

Querying the VDSL2 Port Performance (LSTVDSLPERF).................................................................... 190

6.5.6

Querying the VDSL2 Port Statistics Information (LSTVDSLSTAT) ................................................................... 193

6.5.7

Conducting the Single-ended Loop Test (SELT) ............ 196

6.5.8

Conducting the Double-ended Loop Test (DELT) ........... 199

6.5.9

Querying the xDSL Port PVC Information (LSTPVCINFO) ...................................................................... 201

6.6

Querying the VLAN Information................................................... 204
6.6.1

6.7

Querying the IPTV Information .................................................... 207
6.7.1

6.8

Querying the VLAN Forwarding (LST-VLANFWDINFO) ... 204

Querying the Multicast Configuration (LST-IPTVCFG) ... 207

Querying the VoIP Information .................................................... 210
6.8.1

Querying the Voice Quality Statistical Information (LSTVoIPINFO) ..................................................................... 210

6.8.2

Querying the MG Configuration (LST-MGCFG) .............. 212

6.8.3

Querying the MG Interface Information (LST-MGINFO) . 216

6.8.4

Querying the Port Fax Parameter (LST-FAXINFO).......... 219

6.8.5

Querying the POTS Port Information (LST-POTSINFO).. 222

6.8.6

Conducting the External Line Test (MELT)..................... 227

6.8.7

Conducting the Internal Line Test (TEST-POTSCIRCUIT)231

6.8.8

Conducting the Incoming Call Emulation Test (TESTCALLEESIMULATION) ................................................... 234

6.8.9

Conducting the Outgoing Call Emulation Test (TESTCALLERSIMULATION) ................................................... 238

6.9

Querying the Alarm Information .................................................. 242
6.9.1

7

Querying Alarms (QUERY-ALARM) ................................ 242

Integrated Query Interface......................................................................... 248
7.1

Querying the Equipment Information ........................................... 248
7.1.1

Querying the OLT Equipment Information (LST-DEVICE) 248

7.1.2

Querying the ONU Equipment Information (LST-ONU) ... 249

7.1.3

Querying the ONU Hardware / Software Version (LSTONUVERSION)............................................................... 253

7.1.4

Querying the Shelf Information (LST-SHELF)................. 255

7.1.5

Querying the Card Information (LST-BOARD) ................ 258

7.1.6

Querying ONU Distance Values in a Batch Manner (LSTONUDISTANCE)............................................................. 262

7.2

Querying Service Resources........................................................ 264
7.2.1

Querying the Media Gateway Information (LST-MG)...... 264

7.2.2

Querying the Voice Port Information (LST-POTS).......... 268

7.2.3

Querying the Multicast Service Information (LST-IPTV) 271

7.2.4

Querying the LAN Port Information (LST-LANPORT) ..... 274

7.2.5

Querying the DSL Port Information (LST-DSLPORT) ...... 277

7.2.6

Querying the Port VLAN Information (LST-PORTVLAN). 280

7.2.7

Querying the VLAN Information (LST-VLAN) ................. 283

7.2.8

Querying the ONU Port Service Information (LSTONUSERVICESTATUS) .................................................. 286

7.2.9

Querying the VLAN Service Port (LST-SERVICEPORT) .. 288

7.2.10

Querying the Flow Policy (LST-PORTPVCFLOWPOLICY) 290

7.2.11

Querying the Template Information (RTRV-TEMPLATEALL) .............................................................................. 292

7.2.12

Querying the Port Template Information (RTRVTEMPLATE-PORT) ........................................................ 294

7.3

Resource Change Notification ..................................................... 296
7.3.1

Registering the Resource Change Notification
(SUBSCRIBE)................................................................. 296

7.3.2

Deregistering the Resource Change Notification
(UNSUBSCRIBE) ............................................................ 298

7.3.3

Querying the Resource Change Notification (LSTRESNOTIFY) .................................................................. 299

7.3.4
7.4

8

9

Resource Change Notification Interface ........................ 301

Resource Data Full Export ........................................................... 305
7.4.1

Resource Full Export Interface (DUMP-RESOURCEINFO)305

7.4.2

Resource Full Export Notification .................................. 306

Integrated Alarm Interface ........................................................................ 308
8.1

Subscribing to Alarms (SUBSCRIBE) ........................................... 308

8.2

Enabling the Alarm Filter (ACT-ALARM-FILTER).......................... 309

8.3

Disabling the Alarm Filter (DACT-ALARM-FILTER) ...................... 310

8.4

Modifying the Alarm Filter Configuration (CHG-ALARM-FILTER). 311

8.5

Viewing the Alarm Filter Configuration (LST-ALARM-FILTER) ..... 312

8.6

Querying Alarms (LST-ALARM) ................................................... 314

8.7

Confirming an Alarm (ACK-ALARM) ............................................ 318

8.8

Canceling the Confirmation for an Alarm (UNACK-ALARM)......... 319

8.9

Clearing an Alarm (CLR-ALARM) ................................................. 320

Common Error Codes ................................................................................ 322

10 The List of Parameters .............................................................................. 323
11 The List of Alarms ..................................................................................... 327
12 Abbreviations ............................................................................................ 332

1

TL1 Northbound Interface Overview
The following introduces the position of the TL1 northbound interface in the network, its
used protocols, supported functions, adopted security mechanism as well as performance
specifications.

1.1

TL1 Interface Introduction
The TL1 northbound interface is used for connecting the Element Management System (EMS)
and the Operation Support System (OSS) / Network Management System (NMS).
The TL1 northbound interface enables the OSS or NMS to implement the provisioning and
maintenance of the EPON/GEPON FTTX broadband, IPTV and VoIP services.

1.2

Network Diagram
The position of the TL1 northbound interface in the network is as shown in Figure 1-1.

Version: 04

1

Northbound Interface TL1 User Manual

Figure 1-1

Network Diagram

In the network diagram, each node functions as follows:

2

Version: 04

1 TL1 Northbound Interface Overview

u

OSS / NMS: Indicates the Operation Support System / Network Management System.
It sends TL1 commands to the EMS to perform service provisioning and failure query
operations.

u

Third-party system: It is deployed between the OSS / NMS and the EMS, parsing the
OSS / NMS system command into the standard TL1 format and sending it to the EMS;
meanwhile, it parses the result returned from the EMS and presents it to OSS / NMS.

u

TL1 northbound interface: It processes the TL commands already parsed by the thirdparty system, and performs operations on the EMS and returns the result.

u

EMS: Indicates the FiberHome Element Management System, providing the TL1
interface to be used by the upper-level system.

u

1.3

Equipment: Indicates other sets of equipment in the network, managed by the EMS.

Protocols Used
The FiberHome EMS can establish the TCP connection with the upper-level system to
achieve connection and communication.
It offers the following default ports for the upper-level system to use: 3333 (alarm
management), 3334(service provisioning), 3335 (integrated testing), 3336 (resource query)
and 3337 (service provisioning / integrated testing / resource query).
After the login to OSS / NMS using the configured username and password, the operations
relevant to the TL1 northbound interface can be performed.
The protocols used by the TL1 northbound interface is as shown in Figure 1-2.

Version: 04

3

Northbound Interface TL1 User Manual

Figure 1-2

1.4

Protocols Used

u

OSS / NMS: Operation Support System / Network Management System.

u

TCP/IP: Transmission Control Protocol / Internet Protocol.

Management Function
The TL1 northbound interface supports the following functions:
u

Service provisioning: Supports the provisioning of the broadband, voice and multicast
services in the FTTB / FTTH scenario.

u

Integrated testing: Supports querying the running status of the equipment, and the
status of the PON, XDSL and POTS ports as well as troubleshooting.

u

Alarm management: Supports subscribing to, querying and filtering alarms so as to
monitor the running status of the EMS.

u

Resource query: Supports querying the equipment physical resource and service
configurations as well as the resource change notification report.

4

Version: 04

1 TL1 Northbound Interface Overview

1.5

Security Mechanism
The TL1 northbound interface adopts the security mechanism of the FiberHome EMS. To
implement this security mechanism, it is required to configure an account for the TL1
northbound interface on the EMS and then log in using this account. The FiberHome EMS
accepts a maximum of 32 concurrent TCP connections.
The security mechanism adopted by the TL1 northbound interface includes the following
functions:
u

Login authentication: When connecting to the TL1 northbound interface, the TCP
client needs to send the LOGIN command to login. Only after the successful login can
the subsequent commands of the TCP connection be accepted by the system. The
LOGIN username and password are exclusively allocated by the FiberHome EMS to
the TL1 northbound interface.

u

Automatic disconnection: If the TCP connection has no communication within 10
minutes, the system will initiatively disconnect it.

1.6

Performance Specifications
Table 1-1 describes the performance specifications of the TL1 northbound interface.
Table 1-1

Performance Specifications of the TL1 Northbound Interface

Performance Item
Maximum quantity of
concurrent TCP connections

Specification
32
u

Service provisioning interface

Each connection supports more than two service provisioning /
deletion work orders per minute.

u

Each connection supports more than four service suspension /
recovery / modification work orders per minute.

u

external line test, SELT, DELT and incoming / outgoing call

Integrated testing interface

emulation tests.
u

Version: 04

The result is returned within one minute for the internal line test,

The result for a query command is returned within five seconds.

5

Northbound Interface TL1 User Manual

Table 1-1

Performance Specifications of the TL1 Northbound Interface (Continued)

Performance Item

Specification
u

The alarm delay is less than 10 seconds in normal running status
and is less than 30 seconds in case of alarm storm.

Integrated alarm interface

u

The maximum delay for synchronizing 1000 alarm data entries
is 10 minutes.

u

The alarm throughput is more than 20 entries per second.

u

The query time is less than 5 seconds when the number of
queried records is smaller than 500, and less than 10 seconds

Integrated query interface

when the number of queried records is greater than 500.
u

Full export of configuration data is up to 10000 ports per
minute.

6

Version: 04

2

TL1 Northbound Interface Installation
The following introduces how to install and run the TL1 northbound interface on Windows
operating system.

2.1

Installing the TL1 Northbound Interface
Run the FiberHome EMS installation file on Windows operating system and select the
required TL1 service when proceeding to the step for selecting the installation components.
For more information, refer to the Installation Guide of the corresponding EMS.

2.2

Starting / Stopping the TL1 Northbound
Interface Service
The following introduces how to start / stop the TL1 northbound interface service.
1.

In the Running window, enter Services.msc to open the service list.

2.

Start / stop the TL1 northbound interface service.

4 The ANM2000 TL1 interface services are AEMS-TL1Server(alarm), AEMSUDIServer, AEMS-TL1Server(resource), AEMS-TL1Server(services) and
AEMS-TL1Server(test).

4 The UNM2000 TL1 interface services are unmextendeventservice,
unmextendmoduleserver, unmnbi_tl1_ctc_alarm_main, unmnbi_tl1_ctc_main and
unmnbi_tl1_fh_main.

Version: 04

7

3

Command Format
The following introduces the command format and response message format of the TL1
northbound interface.

3.1

Format Overview
The following introduces the command format, response format and annotation symbols.

Command Format
The command format indicates the format of the command entered. When executing
commands, the matching patterns are as follows:
u

Executing an operation command: Adopts exact matching for all character strings.

u

Executing a query command: Adopts fuzzy query for optional parameters with data
type being character string and adopts exact matching for required parameters with
data type being character string.

Note:
If the filter condition entered matches multiple records instead of one record, the
TL1 northbound interface returns all the matching records as a list.
Response Format
Response format indicates the format of the message returned after a command is executed.

Annotation Symbols
For the description of annotation symbols, see Table 3-1.
Table 3-1
Annotation
Symbol

8

Annotation Symbols

Description

<>

Encapsulates an identifier. For example, <int-num> indicates any integer.

[]

Encapsulates an optional symbol or message body.
Version: 04

3 Command Format

Table 3-1
Annotation
Symbol
""
()
*
+

Description
Encapsulates an English letter. For example, a indicates the English letter "a"
instead of a variable identifier.
Encapsulates a group of required symbols or message body.
A suffix, indicating the current symbol or symbol group occurs 0 times or
several times.
A suffix, indicating the current symbol or symbol group occurs 1 times or
several times.

^

A blank space

cr

A carriage return

lf

A line feed

|

::=

3.2

Annotation Symbols (Continued)

Separates multiple options, among which only one option can be selected. For
example, a|b|c indicates selecting a, b or c.
Separates two parts in a syntax rule. For example, <TESTit> ::= (0|1|~|9)
indicates the value of <TESTit> is a number among 0-9 (including 0 and 9).

Command Format
The following introduces the command format and parameters of the TL1 northbound
interface.

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

Version: 04

9

Northbound Interface TL1 User Manual

Parameters
Parameter

Description
Command code, indicating the operation to be performed. The format is
as follows:
<verb>[-<modifier>[-<modifier>]]

command_code

u

verb: required parameter, identifying the name of the command.
Normally, it is a simple verb or an abbreviation describing an action.

u

modifier: command modifier. "verb" can be followed by two optional
modifiers, separated from each other by -.

Task identifier block. The format is as follows:
[<target identifier>]:<access identifier(s)>:
<ctag>:
staging_blocks

u

target identifier: not used at present.

u

access identifier: location information, indicating the specific object
on which the command is executed.

u

ctag (correlation tag): command tag, used for matching the input
command and output command; its value in the response message
should be the same as that in the input message.

Pass parameter block, which can be null. The format is as follows:
datablock1,datablock2
payload_blocks

The format of each parameter block (datablock) is Parameter
Name=Parameter Value, and a comma is used to separate two parameter
blocks.

3.3

Acknowledgment Message Format
The acknowledgment message format is shown as follows:
acknowledgment_code ctag<
acknowledgment_code:
IP:In Progress
NA:No acknowledgment
RL:Repeat Later system busy

The acknowledgment message response time generally cannot be longer than 2 seconds;
otherwise, a transmission error or equipment failure is suspected. Besides, not all
commands require acknowledgment messages. The command that can be quickly
responded will be returned the response message, such as the set command and stop
command.

10

Version: 04

3 Command Format

3.4

Response Message Format
There are two types of response messages:
u

Operation command response messages

u

Query command response messages

Operation Command Response Message Format
<header><response_id>[<response_block>]<terminator>
header::=<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:
<second>
response_id::=<cr><lf>M^^<ctag>^<completion code>
response_block::=((<cr><lf>^^^<EN=error-code>^^^<ENDESC=errordescription>)
terminator::=<cr><lf>(;|>)

Query Command Response Message Format
<header><response_id>[<response_block>]<terminator>
header::=<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:
<second>
response_id::=<cr><lf>M^^<ctag>^<completion code>
response_block::=((<cr><lf>^^^<EN=error-code>^^^<ENDESC=errordescription>)|(<cr><lf>^^^<quoted line>))
quoted line::=<total_blocks=total-count><cr><lf>^^^<block_number=blocknum><cr><lf>^^^<block_records=current-record-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>(;|>)

Response Parameters
The following table describes the parameters in the command response result.

Version: 04

11

Northbound Interface TL1 User Manual

Parameter

Description
Message header, the public part of all response messages and automatic reported
messages, including equipment ID (sid), date and time. The format is as follows:

header

<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:
<second>
sid: manufacturer name abbreviation_network management server IP. The value is FH_
IP.
Response ID. The format is as follows:
<cr><lf>M^^<ctag>^<completion code>
u

ctag (correlation tag): command tag, used for matching the input command and
output command; its value in the response message should be the same as that in the
input message.

u

completion code: response completion identifier. The value is as follows:

4 COMPLD: Indicates that the command is executed correctly.

response_id

4 DELAY: Indicates that the command execution is delayed.
4 DENY: Indicates that the command execution fails.
4 PRTL: Indicates that the command is partially executed.
4 RTRV: Indicates that the results of the tested items are returned and other items
are being tested.
Response message body.
u

EN: error code.

u

ENDESC: error description.

u

quoted line: returned parameter. When the amount of queried data is very large, the
TL1 northbound interface will send the queried data to the client through several

response_

small packets. total_blocks indicates the total number of data packets;

block

block_number indicates the numbering of the current packet; block_records
indicates the number of data entries contained in the current packet.
u

title: character string, indicating the title information of the result.

u

attrib: character string, indicating the attribute name.

u

value: character string, indicating the attribute value. If it is not supported, – will be
returned.

Indicated by > or ;
terminator

u

received.
u

12

>: Indicates that not all packets are sent and the next packet is waiting to be
;: Indicates that all packets are sent. There should be only one ; in the returned data.

Version: 04

3 Command Format

3.5

Resource Change Notification Format
The following introduces the resource change notification format and parameters of the TL1
northbound interface.

Resource Change Notification Format
<header><auto id><alarm_body><terminator>
header::=<cr><lf><lf><sid>^<year>-<month>-<day><hour>:<minute>:<second>
auto id ::= <cr><lf> <almcde><atag><verb><modifier1><modifier2>
body::= <cr><lf><attrib>=<value>((<tab><attrib>=<value>)*)<cr><lf>
terminator::=<cr><lf>(;|>)

Version: 04

13

Northbound Interface TL1 User Manual

Resource Change Notification Parameters
Parameter

Description
Message header, the public part of all response messages and automatic reported
messages, including equipment ID (sid), date and time.
sid: manufacturer name abbreviation_network management server IP. The value is as

header

follows:
u

HW_IP

u

ZTE_IP

u

FH_IP

Level and status of the automatic reported message, where:
u

almcde: alarm level. According to the severity of the reported message, the
value will be one of the following levels:

4 *C: critical alarm
4 **: major alarm
4 *: minor alarm
4 A: warning alarm
u

atag: association tag generated by automatic reporting. It is assigned by the
EMS and must be continuous and contained by all automatic reported messages.
It enables the upper-layer network management system to associate the
automatic reported message with the common cause that triggers the automatic

Auto id

reporting. It can also be used to check whether an error occurs upon receipt of
the message by the upper-layer network management system. For resource
change notification messages, almcde is A.
u

verb: REPT

u

Modifier1: RES

u

Modifier2: resource change type. The value is as follows:

4 ADD/DEL/MOD_OLT: Indicates adding / deleting / modifying an OLT
network element (NE).

4 ADD/DEL/MOD_ONU: Indicates adding / deleting / modifying an ONU
NE.

4 ADD/DEL_SHELF: Indicates adding / deleting a shelf.
4 ADD/DEL_BOARD: Indicates adding / deleting a card.

3.6

Definition of Returned Error Codes
The error codes returned by the TL1 northbound interface are as shown in Table 3-2.

14

Version: 04

3 Command Format

Table 3-2

Version: 04

Definition of Returned Error Codes

EN (error- code)

Error Type

ENDESC (error-description)

IRNE

INPUT

resource does not exist

IANE

INPUT

the alarm does not exist

IMP

INPUT

missing parameter

IIPF

INPUT

invalid parameter format

IIPE

INPUT

input parameter error

DDNS

DEVICE

device may not support this operation

DDOF

DEVICE

device operation failed

DDB

DEVICE

device is busy

SENS

SYSTEM

EMS may not support this operation

SEOF

SYSTEM

EMS operation failed

EEEH

EXCEPTION

EMS exception happens

TUB

TEST

user is busy

TUT

TEST

user is testing

TTMB

TEST

test module is busy

15

4

Session Control
The session control is used for managing the SOCKET connection between the access
adaptation module and the FiberHome EMS, providing a secure layer to prevent against
access by unauthorized users. It is recommended to modify the user ID and password
periodically during running and maintaining of the EMS.

4.1

Logging into the FiberHome EMS (LOGIN)

Function Description
u

To use the service provisioning interface of the TL1 northbound interface, establish the
TCP connection with the FiberHome EMS through the port 3334.

u

To use the integrated query interface, establish the TCP connection with the
FiberHome EMS through the port 3336.

u

To use the integrated testing interface, establish the TCP connection with the
FiberHome EMS through the port 3335.

u

To use the integrated alarm interface, establish the TCP connection with the
FiberHome EMS through the port 3333.

When successfully establishing the TCP connection, log into the FiberHome EMS through
the command. After login, send commands of the TL1 northbound interface to perform
operations over the equipment.

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

Input Parameter
Parameter

Data Type

Value Range

Description

Default Value

UN

OCTET STRING

Size (20)

User Name

-

PWD

OCTET STRING

Size (16)

Password

-

Name

16

Version: 04

4 Session Control

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, after establishing the TCP connection with the server, enter the username
EMSUSER and password EMSPWD to log into the FiberHome EMS.
u

Command

LOGIN:::CATG::UN=EMSUSER,PWD=EMSPWD;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

4.2

Logging Out of the FiberHome EMS (LOGOUT)

Function Description
Log out of the FiberHome EMS and disconnect the TCP connection with the TL1
northbound interface.

Command Format
LOGOUT:::CTAG::;

Input Parameter
None

Version: 04

17

Northbound Interface TL1 User Manual

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, the current user logs out of the FiberHome EMS.
u

Command

LOGOUT:::CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

4.3

Handshake Command (SHAKEHAND)

Function Description
If the TCP connection has no communication within 10 minutes, the system will initiatively
disconnect the TCP connection. However, sending the handshake command can keep it
connected with no operations performed.

Command Format
SHAKEHAND:::CTAG::;

Input Parameter
None

18

Version: 04

4 Session Control

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, send the handshake command to the system.
u

Command

SHAKEHAND:::CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

Version: 04

19

5

Service Commissioning Interface
The following introduces the commands for the provisioning of the IPTV, broadband and
VOIP services in the FTTx scenario.

5.1

ONU Configuration (FTTH)
The following introduces how to add, delete and configure an optical network unit (ONU)
of the FTTH type.

5.1.1

Adding an ONU (ADD-ONU)

Function Description
This command is used for adding an ONU on the optical line terminal (OLT). Upon initial
service installation, you can send this command to the PON port that has not been fully
configured after configuring the OLT.

Command Format
ADD-ONU::OLTID=olt-name,PONID=ponport_location:CTAG::[AUTHTYPE=authtype],ONUID=onu-index[,PWD=onu password][,ONUNO=onu-no][,NAME=name][,
DESC=onu description],ONUTYPE=onu type;

Supported Equipment

20

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter
Name
OLTID

Data Type

Value Range

Description

OCTET STRING

Size (128)

OLT IP address, name or ID.
PON port information location.

PONID

OCTET STRING

Size (128)

Locate through the approach of

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON

slot - PON port

port number. Enter NA if the

number

corresponding information is not
specified.

MAC
AUTHTYPE

OCTET STRING

LOID
LOIDONCEON

Authentication mode. Default value
is LOID. In LOIDONCEON
authentication mode, LOID and
MAC will be bound.
Authentication information. If
AUTHTYPE is set to MAC,

ONUID

OCTET STRING

Size (64)

ONUID is MAC address. If
AUTHTYPE is set to LOID,
ONUID is LOID.

PWD

OCTET STRING

Size (128)

LOID PASSWORD

ONUNO

INTEGER

1 - 512

ONU authorization code

NAME

OCTET STRING

Size (128)

ONU name
ONU description. When the
FiberHome EMS description and

DESC

OCTET STRING

Size (64)

equipment description are required
to be consistent, this parameter
cannot be Chinese.

ONUTYPE

OCTET STRING

Size (32)

ONU type

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Version: 04

21

Northbound Interface TL1 User Manual

Example
Example 1, add an ONU for the slot 1 - PON 2 port of the OLT whose IP address is
10.78.11.102. The information of the ONU is as follows: ONUID is Test00002; PWD is
Password2; ONU authorization code is 10; description is Test_ONU2; ONU authentication
mode is LOID.
u

Command

ADD-ONU::OLTID=10.78.11.102,PONID=NA-NA-1-2:CTAG::AUTHTYPE=LOID,
ONUID=Test00002,PWD=Password2,ONUNO=10,NAME=Test2,DESC=Test_ONU2,
ONUTYPE=AN5006-04;

u

Response Message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Example 2, add an ONU for the slot 15 - PON 2 port of the OLT whose IP address is
10.78.11.102. The information of the ONU is as follows: MAC address is 54-4B-40-04-2C1F; ONU authentication mode is MAC.
u

Command

ADD-ONU::OLTID=10.78.11.102,PONID=NA-NA-15-2:CTAG::AUTHTYPE=MAC,
ONUID=54-4B-40-04-2C-1F,ONUNO=11,NAME=Test3,DESC=Test_ONU3,
ONUTYPE=AN5006-04;

u

Response Message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
DEL-ONU

5.1.2

Configuring an ONU (CFG-ONU)

Function Description
This command is used for modifying the ONU authentication mode and authentication ID
information when replacing the ONU.
22

Version: 04

5 Service Commissioning Interface

Command Format
CFG-ONU::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-type,
ONUID=onu-index:CTAG::AUTHTYPE=auth-type[,AUTHINFO=onu-index];

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
Name
OLTID

Data Type

Value Range

Description

OCTET STRING

Size (128)

OLT IP address, name or ID.
PON port information location.

Size (128)
PONID

OCTET STRING

Cabinet rack - shelf slot - PON port number

Locate through the approach of
cabinet rack - shelf - slot - PON
port number. Enter NA if the
corresponding information is
not specified.

ONUIDTYPE

OCTET STRING

Size (128)

ONU ID type (NAME, MAC,
LOID, ONU_Number).
ONU identifier, used for
uniquely identifying the ONU

ONUID

OCTET STRING

Size (128)

connected to the PON port. The
value is ONU_NAME, MAC,
LOID or ONU_NUMBER.

MAC
AUTHTYPE

OCTET STRING

LOID

Authentication mode

LOIDONCEON
LOID or MAC of the ONU.
u

If AUTHTYPE is set to
MAC, this parameter
indicates MAC address of
the ONU. MAC address

AUTHINFO

OCTET STRING

Size (128)

format is XX-XXXX-XXXX-XX.
u

If AUTHTYPE is set to
LOID or LOIDONCEON,
this parameter indicates
LOID of the ONU.

Version: 04

23

Northbound Interface TL1 User Manual

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, configure the ONU connected to the slot 3 - PON 1 port of the OLT whose
OLTID is 10.250.18.100. The information of the ONU is as follows: ONUID is Test0001;
authentication mode is LOID; LOID is test0002.
u

Command

CFG-ONU::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001:CTAG::AUTHTYPE=LOID,AUTHINFO= test0002;

u

Response Message
FH_10.78.20.120 2011-02-21 13:51:24

M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
ADD-ONU
DEL-ONU

5.1.3

Configuring the Bandwidth of an ONU (CFG-ONUBW)

Function Description
This command is used for configuring the uplink and downlink bandwidths of an ONU.

Prerequisite
Make sure the uplink and downlink bandwidth templates are configured in the EMS before
using this command to configure the ONU uplink and downlink bandwidths.

24

Version: 04

5 Service Commissioning Interface

Command Format
CFG-ONUBW::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]:CTAG::UPBW=onu-up-bandwidth[,
DOWNBW=onu-down-bandwidth];

Input Parameter
Parameter
ONUIP
OLTID

Data Type
OCTET

Value Range
Size (128)

STRING
OCTET

Size (128)

STRING

Size (128)
PONID

OCTET

Rack - shelf - slot

STRING

- PON port
number

ONUIDTYPE

ONUID

UPBW
DOWNBW

OCTET

Size (128)

STRING

Description
IP address, name or ID of the ONU that has a management IP
address
IP address, name or ID of the OLT
PON port location information. Locate a port through the information
rack - shelf - slot - PON port number. If any part of the
information is unavailable, enter NA instead.
ONU identifier type (ONU_NAME, MAC, LOID and ONU_
NUMBER)
ONU identifier, used for uniquely identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_NAME, MAC, LOID or ONU_
NUMBER.

OCTET
STRING
OCTET
STRING

Size (32)

Uplink DBA bandwidth template name

Size (32)

Downlink bandwidth template name

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Configure the uplink bandwidth template BW_UP and the downlink bandwidth template
BW_DOWN for the ONU (ONUID being Test0001) connected to PON port 1 in slot 3 of
the OLT whose IP address is 10.250.18.100.
u
Version: 04

Command issued
25

Northbound Interface TL1 User Manual

CFG-ONUBW::OLTID=10.71.227.56,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001:CTAG::UPBW=BW_UP,DOWNBW=BW_DOWN;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
ADD-ONU
DEL-ONU

5.1.4

Deleting an ONU (DEL-ONU)

Note:
Deleting an ONU will simultaneously delete the services that the ONU bears. To
re-activate the services on the ONU, add and configure the services again.
Function Description
This command is used for deleting the ONU authorized by the OLT.

Command Format
DEL-ONU::OLTID=olt-name,PONID=ponport_location:CTAG::ONUIDTYPE=onuidtype,ONUID=onu-index;

Supported Equipment

26

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter
Name
OLTID

Data Type

Value Range

Description

OCTET STRING

Size (128)

OLT IP address, name or ID.
PON port information location.

Size (128)
PONID

OCTET STRING

Cabinet rack - shelf slot - PON port number

Locate through the approach
of cabinet rack - shelf - slot PON port number. Enter NA if
the corresponding information
is not specified.

MAC
ONUIDTYPE

OCTET STRING

LOID

ONU identifier type (NAME,

ONU_Number

MAC, LOID, ONU_Number).

ONU_NAME
ONU identifier, used for
uniquely identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the PON port.
The value is ONU_NAME,
MAC, LOID or ONU_
NUMBER.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, delete an ONU from the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100. The information of the ONU is as follows: ONUID is Test0001;
authentication mode is LOID.
u

Command

DEL-ONU::OLTID=10.250.18.100,PONID=NA-NA-3-1:CTAG::ONUIDTYPE=LOID,
ONUID=Test0001;

u

Response Message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
Version: 04

27

Northbound Interface TL1 User Manual

EN=0 ENDESC=No error
;

For example, delete the ONU from the slot 15 - PON 2 port of the OLT whose IP address is
10.250.18.100. The information of the ONU is as follows: MAC address is 54-4B-40-042C-1F; authentication mode is MAC.
u

Command

DEL-ONU::OLTID=10.250.18.100,PONID=NA-NA-15-2:CTAG::ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1F

u

Response Message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
ADD-ONU

5.1.5

Configuring the MAC Address Limit of an LAN Port (CFGLANPORTMACLIMIT)

Function Description
This command is used for configuring the limit of MAC addresses for a LAN port of the
ONU.

Command Format
CFG-LANPORTMACLIMIT::OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
COUNT=count_num;

Supported Equipment

28

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter
Name

OLTID

Data Type

OCTET
STRING

Value
Range

PONID

STRING

Remark
The ONU that has no

Size (128)

OLT IP address or name.

management IP
address. Required.

Size (128)
OCTET

Description

Cabinet rack
- shelf - slot PON port
number

PON port information location.
Locate through the approach of
cabinet rack - shelf - slot - PON
port number. Enter NA if the
corresponding information is not

The ONU that has no
management IP
address. Required.

specified.

MAC
LOID
ONUID-

OCTET

ONU_

ONU identifier type (NAME,

TYPE

STRING

Number

MAC, LOID, ONU_Number).

ONU_

The ONU that has no
management IP
address. Required.

NAME
ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.
Locates card port through the
ONUPORT

OCTET
STRING

approach of cabinet rack - shelf Size (128)

slot - PON port number. Enter NA

Required.

if the corresponding information
is not specified.

COUNT

INTEGER

Size (0 - 254)

Limits the number of MAC
addresses.

Required.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Version: 04

29

Northbound Interface TL1 User Manual

Related Command
None

5.1.6

Configuring the Wi-Fi Service (CFG-WIFISERVICE)

Function Description
This command is used for configuring the Wi-Fi service for the ONU authorized by OLT. It
is allowed to add SSID and configure it with different keys.

Command Format
CFG-WIFISERVICE::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]:CTAG::ENABLE=enable,WILESSAREA=area,WILESS-CHANNEL=channel,WILESS-STANDARD=standard,WORKINGFREQUENCY=frequency,T-POWER=tpower,SSID=ssid,SSID-ENABLE=ssid-enable,
SSID-NAME=name,SSID-VISIBALE=visible,AUTH-MODE=mode,ENCRYP-TYPE=type[,
PRESHARED-KEY=key,UPDATEKEY-INTERVAL=interval,FREQUENCYBANDWIDTH=bandwidth][,RADIUS-SERVER=server,RADIUS-PORT=port,RADIUSKEY=key][,WEP-ENCRYPTIONLEVEL=level,WEP-KEYINDEX=index,WEPKEY1=key1,
WEPKEY2=key2,WEPKEY3=key3,WEPKEY4=key4];

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5506-04-F1.

Input Parameter
Parameter

OLTID

PONID

ONUIDTYPE

30

Data Type
OCTET
STRING

Value Range

Parameter Description

The ONU that has
Size (128)

OLT IP address, name or ID.

PON port information location. Locate

OCTET

Cabinet rack - shelf

through cabinet rack - shelf - slot - PON port

STRING

- slot - PON port

number. Enter NA if the corresponding

number

information is not specified.

STRING

no management IP
address. Required.

Size (128)

OCTET

Remark

Size (128)

ONU ID type (NAME, MAC, LOID, ONU_
Number).

The ONU that has
no management IP
address. Required.
The ONU that has
no management IP
address. Required.

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

Value Range

Parameter Description
ONU identifier, used for uniquely

ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the PON
port. The value is ONU_NAME, MAC,
LOID or ONU_NUMBER.

ENABLE
WILESSAREA
WILESSCHANNEL

OCTET

enable

STRING

disable

INTEGER

0 to 13

INTEGER

0 to 13

Enable
Wireless area. The corresponding code for
displaying a certain area in the EMS GUI.

Remark
The ONU that has
no management IP
address. Required.

Required

Optional

Wireless channel number

Optional

Wireless standard

Required

802.11b
802.11g
802.11b/g
WILESS-

OCTET

802.11n

STANDARD

STRING

802.11bgn
802.11a
802.11an
802.11ac

Working frequency band
u

If the user has input the working
frequency band parameter, TL1 can
find the service of the same working
frequency band from the obtained one
or two Wi-Fi service configurations,
then modify this service, and then

WORKING-

OCTET

2.4GHZ

deliver the command to the device. If

FREQUENCY

STRING

5.8GHZ

TL1 does not find the service of the

Required

same working frequency band, it will
not deliver the command to the device.
An error message will be displayed.
u

If the user does not input the working
frequency band parameter, the
northbound interface will return an
error.

[20, 40, 60, 80, 100,
T-POWER

INTEGER

120, 140, 160, 180,

Wi-Fi power control

Optional

200]

Version: 04

31

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Parameter Description

Remark
Optional. When
other SSID
parameters are
provided, this

SSID

INTEGER

1 to 4

SSID index. A key word in the subordinate

parameter must be

table; used for locating a specific SSID item.

provided as an
index to look for
the SSID
configuration items
to be modified.

Enable or disable
SSIDENABLE

SSID-NAME

INTEGER

OCTET
STRING

0, 1

Size (32)

u

0: disable

u

1: enable

SSID name

Optional

Optional

Indicates whether to hide SSID.
SSIDVISIBALE

INTEGER

0 and 1

u

0: unhide (Available)

u

1: hide (Not Available)

Optional

OPEN SHARED
WEPAUTO
AUTH-MODE

OCTET
STRING

WPAPSK WPA
WPA2PSK WPA2

WLAN authentication mode

Optional

WLAN encryption type

Optional

WPA pre-shared key

Optional

WPA/WPA2
WPAPSK
WPA2PSK

ENCRYP-

OCTET

NONE, WEP, TKIP,

TYPE

STRING

AES, TKIPAES

PRESHARED-

OCTET

KEY

STRING

UPDATEKEYINTERVAL

INTEGER

STRING (64)
[0, 4194303]

WPA key update interval
Unit: s

Optional

20/40MHZ
FREQUENCY-

OCTET

20MHZ

BANDWIDTH

STRING

40MHZ

Frequency band bandwidth

Required

Size (128)

RADIUS server

Optional

STRING (2)

RADIUS server port

Optional

80MHZ
RADIUS-

OCTET

SERVER

STRING

RADIUS-

OCTET

PORT

STRING

32

Version: 04

5 Service Commissioning Interface

Parameter
RADIUS-KEY

Data Type
OCTET
STRING

WEPENCRYP-

INTEGER

TIONLEVEL
WEPKEYINDEX
WEPKEY1
WEPKEY2
WEPKEY3
WEPKEY4

INTEGER
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING

Value Range

Parameter Description

Remark

STRING (32)

RADIUS-KEY

Optional

WEP key length

Optional

[1, 4]

Key index

Optional

STRING (64)

WEP key 1

Optional

STRING (64)

WEP key 2

Optional

STRING (64)

WEP key 3

Optional

STRING (64)

WEP key 4

Optional

1: 40 bit
2: 104 bit

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, for the ONU whose ONU ID is FHTT01E84310 and ONU authentication
mode is physical ID. Set encryption mode to TKIP. This ONU is connected to PON port 1
slot 7 on the OLT equipment whose IP address is 10.171.0.22.
u

Command

CFG-WIFISERVICE::OLTID=10.171.0.22,PONID=NA-NA-7-1,ONUIDTYPE=MAC,
ONUID=FHTT01E84310:865815::ENABLE=enable,WILESS-AREA=5,WILESSCHANNEL=5,WILESS-STANDARD=802.11n,WORKING-FREQUENCY=2.4GHZ,T-POWER=140,
SSID=2,SSID-ENABLE=0,SSID-NAME=brisa-81805,SSID-VISIBALE=1,AUTHMODE=WPAPSK,ENCRYP-TYPE=TKIP,PRESHARED-KEY=naotemsenha12,UPDATEKEYINTERVAL=3600,FREQUENCY-BANDWIDTH=20/40MHZ

u

Response Message

FH_10.78.20.120 2017-03-16 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
Version: 04

33

Northbound Interface TL1 User Manual

;

Related Command
None

5.1.7

修改Wi-Fi业务（CFG-WIFISERVICE）

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 46 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739583-en.xml#fhconcept-修改Wi-Fi业务（CFGWIFISERVICE）_X14878411827488"。

5.1.8

Configuring a WAN Connection (SET-WANSERVICE)

Function Description
This command is used for configuring WAN connections for the ONU authorized by OLT.

Command Format
SET-WANSERVICE::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]:CTAG::STATUS=status,MODE=mode,
CONNTYPE=connecttype[,VLAN=vlan][,COS=cos][,QOS=qos][,NAT=nat[,
IPMODE=ipmode][,WANIP=wanip,WANMASK=mask,WANGATEWAY=gateway,
MASTERDNS=maskdns,SLAVEDNS=slavedns][[,PPPOEPROXY=proxy],
PPPOEUSER=pppoeusername,PPPOEPASSWD=pppoepassword,PPPOENAME=pppoename[,
PPPOEMODE=pppoemode]]],[UPORT=uport,SSID=ssidno,WANSVC=1];

Supported Equipment

34

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5506-04-F1, AN5506-04-B2.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter

Data Type

Value Range

Parameter Description

OLTID

OCTET STRING

Size (128)

OLT IP address, name or ID.

Size (128)

PON port information location. Locate through cabinet

Cabinet rack - shelf - slot -

rack - shelf - slot - PON port number. Enter NA if the

PON port number

corresponding information is not specified.

PONID

OCTET STRING

MAC
ONUIDTYPE

OCTET STRING

LOID

ONU identifier type (NAME, MAC, LOID, ONU_

ONU_Number

Number).

ONU_NAME
ONU identifier, used for uniquely identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

STATUS

INTEGER

1 - add
2 - delete

1: adding; 2: deleting.
WAN connection mode: 1-TR069, 2-INTERNET, 3-

MODE

INTEGER

1 to 4

TR069 INTERNET, 4-Other.
In bridge connection type, the WAN connection mode
can only be set to 2-INTERNET or 4-Other.

CONNTYPE

INTEGER

1 to 2

WAN connection type: 1 - bridge; 2 - route

VLAN

INTEGER

0 to 4085

VLAN ID of the WAN connection.

COS

INTEGER

1 to 7

VLAN COS of the WAN connection.

QOS

INTEGER

1: enable

Indicates whether to enable the QoS function. 1: enable;

2: disable

2: disable.

NAT

INTEGER

IPMODE

INTEGER

1: enable
2: disable
1 to 3

Indicates whether to enable NAT. 1: enable; 2: disable.
IP obtaining mode of the WAN connection. 1: DHCP; 2:
STATIC; 3: PPPOE.
Static IP of the WAN connection. It must be a valid IP

WANIP

OCTET STRING

Size (16)

address, in format of dotted decimal notation. This
parameter is valid only when IPMODE is set to STATIC.
Subnet mask of the WAN connection. It must be a valid

WANMASK

OCTET STRING

Size (16)

IP address, in format of dotted decimal notation. This
parameter is valid only when IPMODE is set to STATIC.
Default gateway of the WAN connection. It must be a

WANGATEWAY

OCTET STRING

Size (16)

valid IP address, in format of dotted decimal notation.
This parameter is valid only when IPMODE is set to
STATIC.

Version: 04

35

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

OCTET STRING

Size (16)

Parameter Description
Primary DNS of the WAN connection. It must be a valid

MASTERDNS

IP address, in format of dotted decimal notation. This
parameter is valid only when IPMODE is set to STATIC.
Secondary DNS of the WAN connection. It must be a

SLAVEDNS

OCTET STRING

Size (16)

valid IP address, in format of dotted decimal notation.
This parameter is valid only when IPMODE is set to
STATIC.

PPPOEPROXY

INTEGER

1 to 2

1: enable; 2: disable.

PPPOEUSER

OCTET STRING

STRING (32)

Username of the PPPoE connection.

OCTET STRING

STRING (32)

Password of the PPPoE connection.

PPPOENAME

OCTET STRING

STRING (32)

PPPoE service name.

PPPOEMODE

INTEGER

1 to 2

UPORT

INTEGER

1 to 4, 0

PPPOEPASSWD

PPPoE dial-up mode. 1: Auto connect; 2: Connect when
traffic is detected
FE port. Value range is 1 to 4. 0 indicates all LAN ports.
Only one of the three parameters UPORT, SSID and
WANSVC can be configured.
SSID number. Value range is 1 to 4. Only one of the

SSID

INTEGER

1 to 4

three parameters UPORT, SSID and WANSVC can be
configured.
It is configured when WAN connection mode is set to

WANSVC

INTEGER

1

TR069. The value is 1. Only one of the three parameters
UPORT, SSID and WANSVC can be configured.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, configure the TR069 WAN connection for the ONU connected to the slot 3 PON 1 port of the OLT whose IP address is 10.250.18.100. The information of the ONU is
as follows: ONUID is 999999999997; authentication mode is physical ID.
Command

36

Version: 04

5 Service Commissioning Interface

SET-WANSERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=999999999997:CTAG::STATUS=1,MODE=1,CONNTYPE=2,VLAN=88,NAT=2,
IPMODE=2,WANIP=43.43.43.43,WANMASK=255.255.255.0,
WANGATEWAY=43.43.43.43,MASTERDNS=3.3.3.3,SLAVEDNS=4.4.4.4,WANSVC=1;

Response Message
FH_10.78.20.120 2012-10-15 14:36:03
M CATG COMPLD
EN=0 ENDESC=No error
;

Example 2, configure a WAN connection with the INTERNET connection mode and Route
connection type for all the LAN ports of the ONU connected to the slot 7 - PON 4 port of
the OLT whose IP address is 10.78.200.200. The information of the ONU is as follows:
ONUID is FHTT01e821a; authentication mode is physical ID.
Command
SET-WANSERVICE::OLTID=10.78.200.200,PONID=NA-NA-7-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::STATUS=1,MODE=2,CONNTYPE=2,VLAN=88,COS=1,
NAT=2,IPMODE=1,UPORT=0;

Response Message
FH_10.78.12.155 2014-07-15 18:47:53
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
ADD-ONU

5.1.9

Deleting a WAN Connection (SET-WANSERVICE)

Function Description
This command is used for deleting WAN connections.

Version: 04

37

Northbound Interface TL1 User Manual

Command Format
SET-WANSERVICE::OLTID=olt_name,PONID=ponport_location,ONUIDTYPE=idtype,ONUID=onu_index:CTAG::STATUS=status,MODE=mode,CONNTYPE=conntype,
VLAN=vlan_id,COS=cos_value,UPORT=port_id;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5506-04-F1.

Input Parameter
Parameter
Name

ONUIP

OLTID

Data Type

OCTET
STRING

OCTET
STRING

Value Range

Size (128)

Description

Remark

IP address, name or ID of the

The ONU that has a

ONU that has a management

management IP address.

IP address.

Required.
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information
Size (128)
PONID

OCTET

Cabinet rack - shelf -

STRING

slot - PON port
number

location. Locate through the
approach of cabinet rack -

The ONU that has no

shelf - slot - PON port

management IP address.

number. Enter NA if the

Required.

corresponding information is
not specified.

ONUIDTYPE

OCTET
STRING

ONU_NAME, MAC,

ONU identifier type (ONU_

The ONU that has no

LOID, ONU_

NAME, MAC, LOID, ONU_

management IP address.

NUMBER

NUMBER ).

Required.

ONU identifier, used for
uniquely identifying the
ONUID

OCTET
STRING

Size (128)

ONU connected to the PON
port. The value is ONU_
NAME, MAC, LOID or

The ONU that has no
management IP address.
Required.

ONU_NUMBER.

STATUS

38

INTEGER

1-2

u

1: configure

u

2: delete

Required. Here it is used for
deleting and therefore
STATUS can only be set to 2.

Version: 04

5 Service Commissioning Interface

Parameter
Name

MODE

Data Type

INTEGER

Value Range
u

1: TR069

u

2: INTEGER

u

3: TR069

Description

Remark

WAN connection mode.

Required.

WAN connection type.

Required.

INTEGER
u

4: Other

u

1: bridge

u

2: route

CONNTYPE

INTEGER

VLAN

INTEGER

1 - 4085

COS

INTEGER

0-7

VLAN ID of the WAN
connection
Priority level of 802.1p of the
WAN connection.

Required.
Required.

Binding LAN port
u

When UPORT is set to
1- 4, it indicates LAN1 -

UPORT

INTEGER

1 - 4, 101 - 104

LAN4.
u

Required.

When UPORT is set to
101 - 104, it indicates
SSID1 - SSID4.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, delete the WAN connection of the ONU (MAC address being FHTT01e821a0)
connected to the slot 18 - PON 4 port of the OLT whose IP address is 10.78.191.100.
u

Command

SET-WANSERVICE::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::STATUS=2,MODE=2,CONNTYPE=2,VLAN=88,COS=3,
UPORT=1;

u

Response Message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
Version: 04

39

Northbound Interface TL1 User Manual

;

Related Command
None

5.1.10

配置ONU的带宽模板（CFG-ONUBWPROFILE）

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 49 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739584-en.xml#fhconcept-配置ONU的带宽模板
（CFG-ONUBWPROFILE）_01487841182836m"。

5.1.11

去绑定ONU的带宽模板（UNBIND-ONUBWPROFILE）

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 50 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739585-en.xml#fhconcept-去绑定ONU的带宽模
板（UNBIND-ONUBWPROFILE）_r1487841182840E"。

5.1.12

Configuring the Rate-control Bandwidth of a L3 Service
(CFG-LT-BWPROFILE)

Function Description
This command is used to configure the rate-control bandwidth of a L3 service.

Command Format
CFG-LT-BWPROFILE::OLTID=olt_name,PONID=ponport_location,ONUIDTYPE=idtype,ONUID=onu_index:CTAG::WANNAME=wan_name, WANINDEX=wan_index,
UPBWPROFILE=up_bwprofile,DOWNBWPROFILE=down_bwprofile;

40

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

OLTID

OCTET STRING

Size (128)

IP address, name or ID of the OLT

Required

PON port location information.
PONID

OCTET STRING

Size (128)

Locate a port through rack - shelf -

Rack - shelf - slot - PON

slot - PON port number. Enter NA

port number

for the corresponding unspecified

Required

information.
MAC
ONUIDTYPE

OCTET STRING

LOID

ONU identifier type (NAME, MAC,

ONU_Number

LOID, ONU_Number).

Required

ONU_NAME
ONU identifier, used for uniquely
identifying the ONU connected to
ONUID

OCTET STRING

Size (128)

the PON port. The value is ONU_

Required

NAME, MAC, LOID or ONU_
NUMBER.
WANNAME

OCTET STRING

Size (64)

WAN connection name

Optional

WANINDEX

INTEGER

-

WAN connection index

Optional

UPBWPROFILE

OCTET STRING

Size (64)

Uplink bandwidth template

Required

OCTET STRING

Size (64)

Downlink bandwidth template

Required

DOWNBWPROFILE

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Limit the L3 bandwidth rate.
u

Command issued

CFG-LT-BWPROFILE::OLTID=172.30.18.84,PONID=NA-NA-13-2,ONUIDTYPE=MAC,
ONUID=FHTT10d62468:CTAG::WANNAME=1_INTERNET_R_VID_37,WANINDEX=1,
UPBWPROFILE=GPON_DN_60_UP_30M,DOWNBWPROFILE=GPON_DN_60_UP_30M;

u
Version: 04

Response message
41

Northbound Interface TL1 User Manual

FH_10.170.162.232019-06-1115:34:18
M CATG COMPLD
EN=0 ENDESC=No error
;

Example 2: Limit the L3 multicast rate.
u

Command issued

CFG-LT-BWPROFILE::OLTID=172.30.18.84,PONID=NA-NA-13-2,ONUIDTYPE=MAC,
ONUID=FHTT10d62468:CTAG::WANNAME=2_MULTICAST_R_VID_3,WANINDEX=2,
UPBWPROFILE=IPTV_DN_100_UP_2M,DOWNBWPROFILE=IPTV_DN_100_UP_2M;

u

Response message

FH_10.170.162.232019-06-1010:18:34
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

5.1.13

Binding a Traffic Policy to an ONU Port (CFGPORTBINDFLOWPOLICY)

Function Description
This command is used to bind a traffic policy to an ONU port.

Command Format
CFG-PORTBINDFLOWPOLICY::ONUIP=onu-name|OLTID=olt_name,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index, ONUPORT=onuport:CTAG::IngressPolicy=Ingress_Policy, EgressPolicy=Egress_Policy,
IngressRule=Ingress_Rule,EgressRule=Egress_Rule;

42

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter

Data Type

Value Range

Description
IP address, name or ID of the

ONUIP

OCTET STRING

Size (128)

ONU that has a management IP
address

Remark
Required for an
ONU that has a
management IP
address
Required for an

OLTID

OCTET STRING

Size (128)

IP address, name or ID of the OLT

ONU that has no
management IP
address

PON port location information.
PONID

OCTET STRING

Size (128)

Locate a port through rack - shelf -

Rack - shelf - slot -

slot - PON port number. Enter NA

PON port number

for the corresponding unspecified

Required

information.
MAC
ONUIDTYPE

OCTET STRING

LOID

ONU identifier type (NAME,

ONU_Number

MAC, LOID, ONU_Number).

Required

ONU_NAME
ONU identifier, used for uniquely
identifying the ONU connected to
ONUID

OCTET STRING

Size (128)

the PON port. The value is ONU_

Required

NAME, MAC, LOID or ONU_
NUMBER.
Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot port number

Locate a port through rack - shelf slot - port number. Enter NA for
the corresponding unspecified

Required

information.

IngressPolicy

OCTET STRING

Size (20)

Uplink traffic policy

Required

EgressPolicy

OCTET STRING

Size (20)

Downlink traffic policy

Required

IngressRule

OCTET STRING

Size (20)

Uplink rule

EgressRule

OCTET STRING

Size (20)

Downlink rule

OLTv4.x version.
Required.
OLTv4.x version.
Required.

Response Format
It complies with the operation command response format in Response Message Format.

Version: 04

43

Northbound Interface TL1 User Manual

Output Parameter
None

Example
Configure a traffic policy on PON port 1 in slot 16 on the OLT with the IP address
10.171.0.16.
u

Command issued

CFG-PORTBINDFLOWPOLICY::OLTID=10.171.0.16,PONID=NA-NA-16-1,
ONUIDTYPE=MAC,ONUID=1111aaaa3333,ONUPORT=NA-NA-NA-1:CTAG::
IngressPolicy=test,EgressPolicy=default1,IngressRule=de_rule_4,
EgressRule=de_rule_5;

u

Response message

FH_10.170.163.1122017-02-1515:55:52
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

5.1.14

Configuring Sub-port of Aggregation Port (SETUPLINKTRUNK)

Function Description
This command is used to configure the TRUNK port link aggregation.

Prerequisite
You have configured the aggregation group in Local Service Configuration→PON
Service→Aggregation Mode Setting in the EMS.

Command Format
SET-UPLINKTRUNK::OLTID=olt_name:ctag::TRUNKNO=trunk_no,MASTERPORT=NANA-2,MEMBERPORT=NA-NA-NA-NA;

44

Version: 04

5 Service Commissioning Interface

Supported Equipment
OLT: AN5516 series.

Input Parameter
Parameter
OLTID

Data Type
OCTET
STRING

TRUNKNO

INTEGER

MASTER-

OCTET

PORT

STRING

MEMBER-

OCTET

PORT

STRING

Value Range

Parameter Description

Remark

Size (128)

OLT IP address, name or ID.

Required.

1 to 16

Set the TRUNK group serial number in
Aggregation Mode Setting

Required.

1 to 12

Main port number of the TRUNK group

Required.

1 to 12

Member port number of the TRUNK group

Required.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example: Configure the TRUNK port link aggregation on the OLT equipment with the IP
10.171.0.22.
u

Command

SET-UPLINKTRUNK::OLTID=10.171.0.22:ctag::TRUNKNO=2,MASTERPORT=NA-NA-192,MEMBERPORT=NA-NA-20-5;

u

Response Message

FH_10.170.163.112 2017-02-15 16:55:52
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

Version: 04

45

Northbound Interface TL1 User Manual

5.1.15

Query Port of the TRUNK Port Link Aggregation

Function Description
This command is used to query the port of the TRUNK port link aggregation.

Command Format
LST-UPLINKTRUNK::OLTID=olt_name:ctag::;

Supported Equipment
OLT: AN5116-06B, AN5516-04, AN5516-06.

Input Parameter
Parameter

Data Type

Value Range

Parameter Description

Remark

OLTID

OCTET STRING

Size (128)

OLT IP address, name or ID.

Required.

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter

Data Type

Value Range

TRUNKNO

INTEGER

1 to 16

MASTERPORT
MEMBERPORT

OCTET
STRING
OCTET
STRING

Parameter Description
TRUNK group serial number, created in the aggregation mode
setting.

1 to 12

Main port number of the TRUNK group

1 to 12

Member port number of the TRUNK group

Example
Example: query the TRUNK port link aggregation of the OLT equipment with the IP
10.171.0.22.
u

Command

LST-TRUNKINFO::OLTID=10.171.0.22:ctag::;

u
46

Response Message
Version: 04

5 Service Commissioning Interface

FH_127.0.0.1 2016-05-09 10:50:27
M

ctag COMPLD

total_blocks=1
block_number=1
block_records=2
Lst Of Trunk Info
-----------------------------------TRUNKNO MASTERPORT

MEMBERPORT

1

1-1-19-2

1-1-19-3

2

1-1-20-1

1-1-20-2|1-1-20-3

------------------------------------

Related Command
SET-UPLINKTRUNK

5.2

Broadband / IPTV Services of a LAN Port
The following introduces how to configure the broadband and IPTV services of a LAN port.

5.2.1

Activating a LAN Port (ACT-LANPORT)

Function Description
This command is used for activating a LAN port of the ONU to enable it.

Command Format
ACT-LANPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;

Supported Device

Version: 04

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

47

Northbound Interface TL1 User Manual

Input Parameter
Parameter
ONUIP

OLTID

Data Type

Value Range

OCTET

Size (128)

STRING
OCTET

Size (128)

STRING

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has
no management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf - slot

information rack - shelf - slot -

Required for an ONU that has

STRING

- PON port

PON port number. If any part of

no management IP address

number

the information is unavailable, enter
NA instead.

ONUIDTYPE

OCTET

Size (128)

STRING

ONU identifier type (ONU_NAME,

Required for an ONU that has

MAC, LOID, ONU_NUMBER)

no management IP address

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has
no management IP address

NUMBER.
Locate a card port through the
ONUPORT

OCTET
STRING

Size (128)

information rack - shelf - slot -

Rack - shelf - slot

port number. If any part of the

- port number

information is unavailable, enter NA

Required

instead.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Activate the LAN port 1 of the ONU (having no management IP address)
connected to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100. The
information of the ONU is as follows: ONUID is Test0001; the authentication mode is
LOID.
u
48

Command issued
Version: 04

5 Service Commissioning Interface

ACT-LANPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Example 2: Activate the LAN port 1 in slot 4 of the ONU (having a management IP address)
whose IP address is 10.250.18.20.
u

Command issued

ACT-LANPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
DACT-LANPORT

5.2.2

Deactivating a LAN Port (DACT-LANPORT)

Function Description
This command is used for deactivating a LAN port of the ONU to disable it.

Command Format
DACT-LANPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;

Supported Device

Version: 04

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

49

Northbound Interface TL1 User Manual

Input Parameter
Parameter

ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management IP

-

address
Size (128)

IP address, name or ID of the

Required for an ONU that has no

OLT

management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf -

information rack - shelf - slot -

Required for an ONU that has no

STRING

slot - PON port

PON port number. If any part of

management IP address

number

the information is unavailable,
enter NA instead.

ONUID-

OCTET

TYPE

STRING

ONU identifier type (ONU_
Size (128)

NAME, MAC, LOID, ONU_
NUMBER)

Required for an ONU that has no
management IP address

ONU identifier, used for uniquely
ONUID

OCTET
STRING

identifying the ONU connected to
Size (128)

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

Locate a card port through the
information rack - shelf - slot port number. If any part of the

Required

information is unavailable, enter
NA instead.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Deactivate LAN port 1 of the ONU (having no management IP address)
connected to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100. The
information of the ONU is as follows: ONUID is Test0001; the authentication mode is
LOID.
50

Version: 04

5 Service Commissioning Interface

u

Command issued

DACT-LANPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001,ONUPORT=NA-NA-NA-1:CTAG::

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Example 2: Deactivate the LAN port 1 in slot 4 of the ONU (having a management IP
address) whose IP address is 10.250.18.20.
u

Command issued

DACT-LANPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
ACT-LANPORT

5.2.3

Configuring a LAN Port (CFG-LANPORT)

Function Description
This command is used for configuring the bandwidth, default VLAN and default priority of
a LAN port.

Prerequisite
Before using the command, ensure the bandwidth template is configured on the OLT.

Command Format
CFG-LANPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[BW=band
width][,VLANMOD=mode][,PVID=vlan id][,PCOS=port qos];

Version: 04

51

Northbound Interface TL1 User Manual

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Rack - shelf - slot

STRING

- PON port
number

OCTET

TYPE

STRING

has a management IP address

IP address, name or ID of the OLT

ONUID

STRING

has no management IP

Size (128)

PON port location information. Locate a
port through the information rack -

Required for an ONU that

shelf - slot - port number. If any part

has no management IP

of the information is unavailable, enter

address

NA instead.
ONU identifier type (ONU_NAME,
MAC, LOID or ONU_NUMBER)
ONU identifier, used for uniquely

OCTET

-

address

OCTET

ONUID-

IP address, name or ID of the ONU that

Remark

Required for an ONU that
Size (128)

Size (128)
PONID

Description

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

Required for an ONU that
has no management IP
address
Required for an ONU that
has no management IP
address
Required. It can be a list
of multiple ports,

ONUPORT

OCTET
STRING

Size (128)
Rack - shelf - slot
- port number

Locate a card port through the
information rack - shelf - slot - port
number. If any part of the information is
unavailable, enter NA instead.

separated by vertical bars,
for example, NA-NA-NA0| NA-NA-NA-1. Entering
multiple ports means that
these ONU ports will be
configured
simultaneously.

BW

52

OCTET
STRING

Size (128)

Port rate limiting template configured for
the ONU data port

Optional

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

Value Range

Description

Remark

VLAN mode settings of the port:
u

TAG (SFU or HGU scenario): used
with the VLAN configuration
command for the OLT PON port.

u

Tag

VLAN-

OCTET

u

Trunk

MOD

STRING

u

Transparent

u

Translation

u

TRUNK (SFU+HGU scenario):
used with the VLAN configuration
command for the OLT PON port.

u

Optional

Transparent (SFU+HGU scenario):
used with the VLAN configuration
command for the OLT PON port.

u

Translate (SFU+HGU scenario):
used with the VLAN configuration
command for the ONU LAN port.

PVID

INTEGER

-

Default VLAN of the port

Optional

PCOS

INTEGER

-

Default priority of the port

Optional

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Configure the bandwidth template BW_UP, default VLAN102 and priority 1
for LAN port 2 of the ONU (having no management IP address) connected to PON port 2
in slot 15 of the OLT whose IP address is 10.78.11.102. The information of the ONU is as
follows: ONUID is 54-4B-40-04-2C-1E; the authentication mode is MAC.
u

Command issued

CFG-LANPORT::OLTID=10.78.11.102,PONID=NA-NA-15-2,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-2:CTAG::BW=BW_UP,VLANMOD=Tag,
PVID=102,PCOS=1;

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Version: 04

53

Northbound Interface TL1 User Manual

Example 2: Configure the bandwidth template BW_2M for LAN port 1 in slot 1 of the
ONU (having a management IP address) whose IP address is 10.250.18.20.
u

Command issued

CFG-LANPORTBW::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::BW=BW_2M

u

Response message

FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;

Related Command
None

5.2.4

Configuring the VLAN of a PON Port (ADD-PONVLAN)

Function Description
This command is used for configuring the VLAN information of the OLT PON port.

Note:
To implement switching between VLAN and CVLAN on the OLT and VLAN
transparent transmission on the SFU, it is required to configure the VLAN
configuration interface of the OLT PON port (ADD-PONVLAN) and the
attribute configuration interface of the ONU LAN port (CFGLANPORTVLAN).
Command Format
ADD-PONVLAN::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,ONUID=onu-index:CTAG::[SVLAN=outer vlan,]CVLAN=Inner vlan[,UV=uservlan][,SCOS=outer qos][,CCOS=inner qos];

Supported Equipment

54

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.
Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter Name

OLTID

PONID

ONUIDTYPE

Data Type
OCTET
STRING

OCTET
STRING

OCTET
STRING

Value Range

Description

The ONU that has no
Size (128)

OLT IP address, name or ID.

ONUID

STRING

management IP address.
Required.

Size (128)

PON port information location. Locate

Cabinet rack -

through the approach of cabinet rack -

The ONU that has no

shelf - slot -

shelf - slot - PON port number. Enter

management IP address.

PON port

NA if the corresponding information is

Required.

number

not specified.

Size (128)

ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER ).
ONU identifier, used for uniquely

OCTET

Remark

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

The ONU that has no
management IP address.
Required.
The ONU that has no
management IP address.
Required.
Optional. It is required

SVLAN

INTEGER

0 - 4095

SVLAN

for stacked VLAN
service.

CVLAN

INTEGER

0 - 4095

CVLAN

Required.

UV

INTEGER

0 - 4095

VLAN at user side

Optional.

SCOS

INTEGER

0-7

Outer priority level

Optional.
Optional (in case the

CCOS

INTEGER

0-7

Inner priority level

inner COS and outer
COS are the same, only
the inner COS is sent).

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Version: 04

55

Northbound Interface TL1 User Manual

Example
For example, configure the VLAN information for the No. 1 port of the ONU connected to
the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100. The information of
the ONU is as follows: ONUID is 54-4B-40-04-2C-1E; authentication mode is MAC.
u

Command

ADD-PONVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E:CTAG::SVLAN=100,CVLAN=78,UV=98,SCOS=5,CCOS=4;

u

Response Message

FH_10.78.20.120 2011-02-21 14:55:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DEL-PONVLAN

5.2.5

Deleting the VLAN of a PON Port (DEL-PONVLAN)

Function Description
This command is used for deleting the VLAN information of an OLT PON port.

Command Format
DEL-PONVLAN::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,ONUID=onu-index:CTAG::[,UV=user-vlan];

Input Parameter
Parameter
OLTID

Data Type
OCTET
STRING

Value Range
Size (128)

Description

Remark

IP address, name or ID of the

Required for an ONU that has

OLT

no management IP address

PON port location information.

PONID

OCTET
STRING

Size (128)
Rack - shelf - slot PON port number

Locate a port through the
information rack - shelf - slot

Required for an ONU that has

- PON port number. If any part

no management IP address

of the information is
unavailable, enter NA instead.

56

Version: 04

5 Service Commissioning Interface

Parameter

ONUIDTYPE

Data Type

Value Range

Description
ONU identifier type (ONU_

OCTET

Size (128)

STRING

NAME, MAC, LOID or ONU_
NUMBER)

Remark
Required for an ONU that has
no management IP address

ONU identifier, used for
ONUID

uniquely identifying the ONU

OCTET

Size (128)

STRING

connected to the PON port. The
value is ONU_NAME, MAC,

Required for an ONU that has
no management IP address

LOID or ONU_NUMBER.
UV

INTEGER

-

User-side VLAN

Optional

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Delete the VLAN information of port 1 of the ONU connected to PON port 1 in slot 3 of
the OLT whose IP address is 10.250.18.100. The information of the ONU is as follows:
ONUID is 54-4B-40-04-2C-1E; the authentication mode is MAC.
u

Command issued

DEL-PONVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E:CTAG::[,UV=98];

u

Response message

FH_10.78.20.120 2011-02-21 15:57:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
ADD-PONVLAN

Version: 04

57

Northbound Interface TL1 User Manual

5.2.6

Configuring the VLAN of a LAN Port (CFGLANPORTVLAN)

Function Description
This command is used for configuring the VLAN information of a LAN port.

Command Format
CFG-LANPORTVLAN::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan][,SCOS=outer qos][,
CCOS=inner qos];

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON port

STRING

shelf - slot - PON

number. Enter NA if the

port number

corresponding information is not

The ONU that has no
management IP address.
Required.

specified.

ONUIDTYPE

OCTET
STRING

Size (128)

ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER ).

The ONU that has no
management IP address.
Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP address.

NAME, MAC, LOID or ONU_

Required.

NUMBER.

58

Version: 04

5 Service Commissioning Interface

Parameter Name

Data Type

Value Range

Description

Remark
Required. It can be a list
of multiple ports,

Size (128)
ONUPORT

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

Locates card port through the

separated by vertical bars,

approach of cabinet rack - shelf -

for example, NA-NA-

slot - port number. Enter NA if the

NA-0| NA-NA-NA-1.

corresponding information is not

Entering multiple ports

specified.

means these ONU ports
will be configured
simultaneously.

SVLAN

INTEGER

0 - 4095

SVLAN

Optional.

CVLAN

INTEGER

0 - 4095

CVLAN

Required.

UV

INTEGER

0 - 4095

VLAN at user side

Optional.

SCOS

INTEGER

0-7

Outer priority level

Optional.
Optional (in case the

CCOS

INTEGER

0-7

Inner priority level

inner COS and outer COS
are the same, only the
inner COS is sent).

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, configure the CVLAN 21 and priority level 3 for the LAN 1 port of the ONU
(having no management IP address) connected to the slot 3 - PON 1 port of the OLT whose
IP address is 10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B40-04-2C-1E; authentication mode is MAC.
u

Command

CFG-LANPORTVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::CVLAN=21,CCOS=3;

u

Response Message

FH_10.78.20.120 2011-02-21 14:55:17
M

CTAG COMPLD
EN=0

Version: 04

ENDESC=No error
59

Northbound Interface TL1 User Manual

;

Example 2, configure the CVLAN 21 for the LAN 2 port located in the No. 2 slot of the
ONU (having a management IP address) whose IP address is 10.250.18.121.
u

Command

CFG-LANPORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-2:CTAG::CVLAN=21,
CCOS=3;

u

Response Message

FH_10.78.20.120 2011-02-21 13:51:33
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
DEL-LANPORTVLAN

5.2.7

Deleting the VLAN of a LAN Port (DEL-LANPORTVLAN)

Function Description
This command is used for deleting the VLAN information of an ONU LAN port.

Command Format
DEL-LANPORTVLAN::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,ONUID=onu-index,ONUPORT=onu-port:CTAG::[,UV=user-vlan];

Input Parameter
Parameter
OLTID

Data Type
OCTET
STRING

Value Range
Size (128)

Description

Remark

IP address, name or ID of the

Required for an ONU that has no

OLT

management IP address

PON port location information.

PONID

OCTET
STRING

Size (128)
Rack - shelf - slot PON port number

Locate a port through the
information rack - shelf - slot -

Required for an ONU that has no

PON port number. If any part of

management IP address

the information is unavailable,
enter NA instead.

60

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

ONUID-

OCTET

TYPE

STRING

Value Range

Description
ONU identifier type (ONU_

Size (128)

NAME, MAC, LOID or ONU_
NUMBER)

Remark
Required for an ONU that has no
management IP address

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Required. It can be a list of

ONUPORT

OCTET
STRING

Locate a card port through the

multiple ports, separated by

Size (128)

information rack - shelf - slot -

vertical bars, for example, NA-

Rack - shelf - slot -

port number. If any part of the

NA-NA-0| NA-NA-NA-1.

port number

information is unavailable, enter

Entering multiple ports means

NA instead.

that these ONU ports will be
configured simultaneously.

UV

-

INTEGER

User-side VLAN

Optional

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Delete the VLAN configuration of LAN port 1 of the ONU (that has no
management IP) connected to PON port 1 in slot 3 of the OLT whose IP address is
10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E;
the authentication mode is MAC.
u

Command issued

DEL-LANPORTVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-22 15:55:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;
Version: 04

61

Northbound Interface TL1 User Manual

Example 2: Delete the VLAN configuration of PON port 10 in slot 4 of the ONU (having a
management IP address) whose IP address is 10.78.11.115.
u

Command issued

DEL-LANPORTVLAN::ONUIP=10.78.11.115,ONUPORT=NA-NA-4-10:CTAG::CVLAN=21,
CCOS=3;

u

Response message

FH_10.78.20.120 2011-02-22 17:05:49
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
ADD-LANPORTVLAN

5.2.8

LAN端口配置IPTV 业务（CFG-LANIPTVPORT）

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 63 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739590-en.xml#fhconcept-LAN端口配置IPTV业
务（CFG-LANIPTVPORT）_I1487841183073e"。

5.2.9

Adding a LAN Port into a Multicast VLAN (ADDLANIPTVPORT)

Function Description
This command is used for adding a LAN port into a multicast VLAN.

Command Format
ADD-LANIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[UV=user
vlan][,MVLAN=mvlan] [,CCOS=ccos] [,SVCMODPROFILE=svc mod profile];

Supported Equipment
u
62

OLT: AN5516 series, AN5116 series.
Version: 04

5 Service Commissioning Interface

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Cabinet rack -

STRING

shelf - slot - PON
port number

ONUIDTYPE

STRING

has a management IP address.

OLT IP address, name or ID.

ONUID

STRING

management IP address.

Size (128)

PON port information location. Locate
through cabinet rack - shelf - slot -

The ONU that has no

PON port number. Enter NA if the

management IP address.

corresponding information is not

Required.

specified.
ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER ).
ONU identifier, used for uniquely

OCTET

-

Required.

OCTET

OCTET

IP address, name or ID of the ONU that

Remark

The ONU that has no
Size (128)

Size (128)
PONID

Parameter Description

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

The ONU that has no
management IP address.
Required.
The ONU that has no
management IP address.
Required.
Required. It can be a list
of multiple ports,

ONUPORT

Size (128)

Locates card port through cabinet rack -

OCTET

Cabinet rack -

shelf - slot - port number. Enter NA if

STRING

shelf - slot - port

the corresponding information is not

number

specified.

separated by vertical
bars, for example, NANA-NA-0| NA-NA-NA1. Entering multiple
ports means these ONU
ports will be configured
simultaneously.

UV

INTEGER

0 to 4095

Customer VLAN.

Optional
Optional. Specified

MVLAN

INTEGER

0 to 4095

Associated multicast VLAN

multicast VLAN for
service provisioning.

CCOS

INTEGER

SVCMOD-

OCTET

PROFILE

STRING

Version: 04

0 to 7

Multicast priority

Optional

Size (20)

Service model template name

Optional

63

Northbound Interface TL1 User Manual

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, add the LAN 1 port of the ONU (having no management IP address) into the
MVLAN. The ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E;
authentication mode is MAC.
u

Command

ADD-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::UV=109,MVLAN=88;

u

Response Message

FH_10.78.20.120 2011-02-21 14:56:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2, bind the No. 1 LAN port located in the No. 4 slot of the ONU (having an
independent management IP address) whose IP address is 10.250.18.20 to the MVLAN88
(multicast VLAN).
u

Command

ADD-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::UV=100,
MVLAN=88;

u

Response Message

FH_10.78.20.120 2011-02-21 13:59:14
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
DEL-LANIPTVPORT

64

Version: 04

5 Service Commissioning Interface

5.2.10

Configuring the IPTV Service of a LAN Port (CFGLANIPTVPORT)

Function Description
This command is used for configuring the IPTV service of a LAN port.

Command Format
CFG-LANIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[FLMODE=iptv-fastleave-mode][,MAXGRP=Max-group-number];

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name

ONUIP

OLTID

Data Type
OCTET
STRING

OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management IP

-

address.
The ONU that has no
Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON

STRING

shelf - slot - PON

port number. Enter NA if the

port number

corresponding information is not

The ONU that has no
management IP address.
Required.

specified.

ONUIDTYPE

OCTET
STRING

Size (128)

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP address.

NUMBER ).

Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP address.

NAME, MAC, LOID or ONU_

Required.

NUMBER.

Version: 04

65

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range
Size (128)

ONUPORT

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

FLMODE

Description

Remark

Locates card port through the
approach of cabinet rack - shelf slot - port number. Enter NA if the

Required.

corresponding information is not
specified.
Fast leave mode:

OCTET

Size (32)

STRING

Enabled

Optional.

Disabled
Maximum number of multicast

MAXGRP

INTEGER

0 - 255

programs that a port can join

Optional.

simultaneously.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, delete the multicast service with the fast leave mode being enabled and
MAXGRP being 23 of the LAN 1 port of the ONU (having no management IP address)
with ONUID being 54-4B-40-04-2C-1E and ONU authentication mode being MAC. The
ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u

Command

CFG-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::FLMODE=Enabled,
MAXGRP=23;

u

Response Message

FH_10.78.20.120 2/22/2011 9:17:13
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2, configure the multicast service for the LAN 1 port located in the No. 4 slot of
the ONU (having a management IP address) whose IP address is 10.250.18.20.
u
66

Command
Version: 04

5 Service Commissioning Interface

CFG-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::
FLMODE=Enabled,MAXGRP=32;

u

Response Message

FH_10.78.20.120 2/22/2011 9:18:14
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
ADD-LANIPTVPORT
DEL-LANIPTVPORT

5.2.11

Deleting a LAN Port from a Multicast VLAN (DELLANIPTVPORT)

Function Description
This command is used for deleting a LAN port from a multicast VLAN.

Command Format
DEL-LANIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[UV=user
vlan][,MVLAN=mvlan];

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name
ONUIP

OLTID

Version: 04

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP
address. Required.

67

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

Description

Remark

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON

STRING

slot - PON port

port number. Enter NA if the

number

corresponding information is not

The ONU that has no
management IP
address. Required.

specified.

ONUIDTYPE

OCTET
STRING

Size (128)

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP

NUMBER ).

address. Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.
Locates card port through the
ONUPORT

OCTET
STRING

Size (128)

approach of cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if the

slot - port number

corresponding information is not

Required.

specified.
Optional. It is required
when the multicast
UV

INTEGER

0 - 4095

VLAN at user side

service is accessed
through a home
gateway.

MVLAN

INTEGER

0 - 4095

Associated multicast VLAN

Optional.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, delete the multicast service with the fast leave mode being enabled and
MAXGRP being 23 of the LAN 1 port of the ONU (having no management IP address)
with ONUID being 54-4B-40-04-2C-1E and ONU authentication mode being MAC. The
ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
68

Version: 04

5 Service Commissioning Interface

u

Command

DEL-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::UV=109,MVLAN=88;

u

Response Message

FH_10.78.20.120 2011-02-21 15:18:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2, delete the LAN 1 port from the MVLAN88 (multicast VLAN). The LAN 1 port
locates in the No. 4 slot of the ONU (having a management IP address) whose IP address is
10.250.18.20.
u

Command

DEL-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::UV=100,
MVLAN=88;

u

Response Message

FH_10.78.20.120 2011-02-21 08:59:14
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
ADD-LANIPTVPORT

5.2.12

新增HG管理通道配置(CFG-NONOMCIMPATHCONFIG)

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 67 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739591-en.xml#fhconcept-新增HG管理通道配置
(CFG-NONOMCIMPATHCONFIG)_X1487841183157M"。

5.2.13

Adding VEIP Data Service (CFG-VEIPSERVICE)

Function Description
This command is used to configure the VEIP data service of the LAN port.

Version: 04

69

Northbound Interface TL1 User Manual

Command Format
CFG-VEIPSERVICE::ONUIP=onu-ip|OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
ServiceId=service-id,CVLANID=cvlanid,CCOS=ccos,TVLANID=T-vlan,TCOS=Tcos,UpAssuredRateLimit=up-bandwidth profile,DownAssuredRateLimit=downbandwidth-profile,ServiceModelProfile=service-model-profile,
ServiceType=service-type;

Supported Equipment
u

OLT: AN5116 series, AN5516 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
OLTID

PONID

ONUIDTYPE

ONUID

ONUPORT

Data Type

Value Range

Parameter Description

Remark

Size (128)

OLT IP address, name or ID.

Required.

Size (128)

PON port information location. Locate through

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON port number.

STRING

slot - PON port

Enter NA if the corresponding information is not

number

specified.

OCTET
STRING

OCTET
STRING
OCTET
STRING

OCTET
STRING

Size (128)

ONU identifier type (ONU_NAME, MAC,
LOID, ONU_NUMBER ).

Required.

Required.

ONU identifier, used for uniquely identifying the
Size (128)

ONU connected to the PON port. The value is

Required.

ONU_NAME, MAC, LOID or ONU_NUMBER.
Size (128)

Locates card port through cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if the corresponding

slot - port number

information is not specified.

Required.

ServiceId

INTEGER

1 to 16

Service serial number under the port

Optional

CVLANID

INTEGER

1 to 4085

CVLAN ID

Optional

CCOS

INTEGER

0 to 7

CVLAN PON priority or COS

Optional

TVLANID

INTEGER

1 to 4085

TVLAN ID

Optional

TCOS

INTEGER

0 to 7

TCOS

Optional

UpAssuredRa-

OCTET

teLimit

STRING

Size (20)

Uplink bandwidth profile name.

Optional

DownAssure-

OCTET

dRateLimit

STRING

Size (20)

Downlink bandwidth profile name.

Optional

70

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

ServiceModel-

OCTET

Profile

STRING

Value Range

Parameter Description

Remark

Size (20)

Service model template name

Required.

Service Type

Optional

NONE
ServiceType

DATA

OCTET

IPTV

STRING

MANAGEMENT
VOIP

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, configure the VEIP data service of the LAN port 1 on the ONU with ID 1,
which is in the PON port 5 in slot 4 on the OLT device with IP 10.171.0.16.
u

Command

CFG-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,ONUIDTYPE=ONU_NUMBER,
ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::ServiceId=1,CVLANID=500,CCOS=0,
UpAssuredRateLimit=1,DownAssuredRateLimit=2,ServiceModelProfile=1,
ServiceType=VOIP;

u

Response Message

FH_10.78.20.120 2011-02-21 14:55:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

5.2.14

Modifying VEIP Data Service (MODIFY-VEIPSERVICE)

Function Description
This command is used to modify the bandwidth configuration in the VEIP settings of the
LAN port.

Version: 04

71

Northbound Interface TL1 User Manual

Command Format
MODIFY-VEIPSERVICE::ONUIP=onu-ip|OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
CVLANID=cvlanid,UpAssuredRateLimit=up-bandwidth-profile,
DownAssuredRateLimit=down-bandwidth-profile,ServiceId=service-id;

Supported Equipment
u

OLT: AN5116-02, AN5116-06B.

u

ONU: AN5006 series, HG series.

Input Parameter
Parameter

ONUIP

OLTID

Data Type
OCTET
STRING

OCTET
STRING

Value Range

Size (128)

Size (128)

OCTET

Cabinet rack -

STRING

shelf - slot - PON

OCTET
STRING

has a management IP address.

It is compulsory for the
ONU that has a
management IP address.

OLT IP address, name or ID.

or OLT that has no
management IP address.

port number

ONUIDTYPE

IP address, name or ID of the ONU that

Remark

It is required for the ONU

Size (128)
PONID

Parameter Description

Size (128)

PON port information location. Locate
through cabinet rack - shelf - slot - PON
port number. Enter NA if the

Required.

corresponding information is not
specified.
ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER ).

Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,

Required.

MAC, LOID or ONU_NUMBER.

ONUPORT

Size (128)

Locates card port through cabinet rack -

OCTET

Cabinet rack -

shelf - slot - port number. Enter NA if

STRING

shelf - slot - port

the corresponding information is not

number

specified.

1 to 4085

CVLAN ID

Optional

Size (20)

Uplink bandwidth profile name.

Optional

CVLANID

INTEGER

UpAssure-

OCTET

dRateLimit

STRING

72

Required.

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

DownAssure-

OCTET

dRateLimit

STRING

ServiceId

INTEGER

Value Range

Parameter Description

Remark

Size (20)

Downlink bandwidth profile name.

Optional

1 to 16

Service serial number under the port

Optional

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
Example 1, modify the bandwidth configuration in the VEIP settings of the LAN port 1 on
the ONU with ID 1, which is in the PON port 5 in slot 4 on the OLT device with IP
10.171.0.16.
u

Command

MODIFY-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,
ONUIDTYPE=ONU_NUMBER,ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::CVLANID=500,
UpAssuredRateLimit=2,DownAssuredRateLimit=1,ServiceId=1;

u

Response Message

FH_10.78.20.120 2011-02-21 14:55:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

5.2.15

去绑定VEIP数据业务(UNBIND-VEIPSERVICE)

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 70 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739594-en.xml#fhconcept-去绑定VEIP数据业务
(UNBIND-VEIPSERVICE)_Z1487841183172t"。

Version: 04

73

Northbound Interface TL1 User Manual

5.2.16

Deleting VEIP Data Service (DEL-VEIPSERVICE)

Function Description
This command is used to delete the VEIP data service configuration of the LAN port.

Command Format
DEL-VEIPSERVICE::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,ONUID=onu-index,ONUPORT=onu-port:CTAG::ServiceId=service-id;

Supported Equipment
u

OLT: AN5116 series, AN5516 series.

u

ONU: AN5006 series, HG series.

Input Parameter
Parameter
OLTID

PONID

ONUIDTYPE

ONUID

ONUPORT

ServiceId

Data Type

Value Range

Parameter Description

Remark

Size (128)

OLT IP address, name or ID.

Required.

Size (128)

PON port information location. Locate through

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON port number.

STRING

slot - PON port

Enter NA if the corresponding information is not

number

specified.

OCTET
STRING

OCTET
STRING
OCTET
STRING

OCTET
STRING
INTEGER

Size (128)

ONU identifier type (ONU_NAME, MAC,
LOID, ONU_NUMBER ).

Required.

Required.

ONU identifier, used for uniquely identifying the
Size (128)

ONU connected to the PON port. The value is

Required.

ONU_NAME, MAC, LOID or ONU_NUMBER.
Size (128)

Locates card port through cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if the corresponding

slot - port number

information is not specified.

1 to 16

Service serial number under the port

Required.

Required.

Response Format
It complies with the operation-command response format in Response Message Format.

74

Version: 04

5 Service Commissioning Interface

Output Parameter
None

Example
Example 1, delete the VEIP data service of the LAN port 1 on the ONU with ID 1, which is
in the PON port 5 in slot 4 on the OLT device with IP 10.171.0.16.
u

Command

DEL-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,ONUIDTYPE=ONU_NUMBER,
ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::ServiceId=1;

u

Response Message

FH_10.78.20.120 2011-02-21 14:55:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

5.3

Broadband / IPTV Services of an xDSL Port
The following introduces how to configure the broadband / IPTV services of an xDSL port.

5.3.1

Activating a DSL Port (ACT-DSLPORT)

Function Description
This command is used for activating a DSL port.

Command Format
ACT-DSLPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;

Supported Device

Version: 04

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

75

Northbound Interface TL1 User Manual

Input Parameter
Parameter
ONUIP

OLTID

Data Type

Value Range

OCTET

Size (128)

STRING
OCTET

Size (128)

STRING

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has no
management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf - slot

information rack - shelf - slot -

Required for an ONU that has no

STRING

- PON port

PON port number. If any part of

management IP address

number

the information is unavailable,
enter NA instead.

ONUID-

OCTET

TYPE

STRING

ONU identifier type (ONU_
Size (128)

NAME, MAC, LOID, ONU_
NUMBER)

Required for an ONU that has no
management IP address

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Locate a card port through the
ONUPORT

OCTET
STRING

Size (128)

information rack - shelf - slot -

Rack - shelf - slot

port number. If any part of the

- port number

information is unavailable, enter

Required

NA instead.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Activate DSL port 1 in slot 3 of the ONU whose IP address is 10.250.18.121.
u

Command issued

ACT-DSLPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u
76

Response message
Version: 04

5 Service Commissioning Interface

FH_10.78.20.120 2011-02-22 17:13:17
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DACT-DSLPORT

5.3.2

Deactivating a DSL Port (DACT-DSLPORT)

Function Description
This command is used for deactivating a DSL port.

Command Format
DACT-DSLPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has no
management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf -

information rack - shelf - slot -

Required for an ONU that has no

STRING

slot - PON port

PON port number. If any part of

management IP address

number

the information is unavailable, enter
NA instead.

ONUID-

OCTET

TYPE

STRING

Version: 04

Size (128)

ONU identifier type (ONU_NAME,

Required for an ONU that has no

MAC, LOID, ONU_NUMBER)

management IP address

77

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

Locate a card port through the
information rack - shelf - slot port number. If any part of the

Required

information is unavailable, enter
NA instead.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Deactivate DSL port 1 in slot 3 of the ONU whose IP address is 10.250.18.121.
u

Command issued

DACT-DSLPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-22 17:14:19
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
ACT-DSLPORT

78

Version: 04

5 Service Commissioning Interface

5.3.3

Configuring the Bandwidth of a DSL Port (CFGDSLPORTBW)

Function Description
This command is used for configuring the bandwidth of a DSL port. Before using the
command, ensure the ONU is bound with the DSL line template and the bandwidth
template is correctly configured.

Command Format
CFG-DSLPORTBW::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::BW=band
width;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP
address. Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON

STRING

slot - PON port

port number. Enter NA if the

number

corresponding information is not

The ONU that has no
management IP
address. Required.

specified.

ONUIDTYPE

OCTET
STRING

Size (128)

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP

NUMBER).

address. Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.
Version: 04

79

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

Description

Remark

Locates card port through the
ONUPORT

OCTET
STRING

Size (128)

approach of cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if the

slot - port number

corresponding information is not

Required.

specified.
BW

OCTET

Size (32)

STRING

Bandwidth template name: setting
uplink / downlink bandwidth.

Optional.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example: configure the bandwidth template for the No. 1 DSL port located in the No. 3
slot of the ONU whose IP address is 10.250.18.121.
u

Command

CFG-DSLPORTBW::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::BW=BW_2M

u

Response Message
FH_10.78.20.120 2/22/2011 17:17:19

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
None

5.3.4

Configuring the VLAN of a DSL Port (CFGDSLPORTVLAN)

Function Description
This command is used for configuring the VLAN information of a DSL port.

80

Version: 04

5 Service Commissioning Interface

Command Format
CFG-DSLPORTVLAN::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][,SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan];

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OCTET STRING

Size (128)

Parameter Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has no

OLTID

OLT IP address, name or ID.

management IP address.
Required.

Size (128)
PONID

OCTET STRING

Cabinet rack shelf - slot - PON
port number

ONUIDTYPE

OCTET STRING

Size (128)

PON port information location.
Locate through cabinet rack - shelf -

The ONU that has no

slot - PON port number. Enter NA

management IP address.

if the corresponding information is

Required.

not specified.
ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER).

The ONU that has no
management IP address.
Required.

ONU identifier, used for uniquely
ONUID

OCTET STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP address.

NAME, MAC, LOID or ONU_

Required.

NUMBER.

ONUPORT

OCTET STRING

Size (128)

Locates card port through cabinet

Cabinet rack -

rack - shelf - slot - port number.

shelf - slot - port

Enter NA if the corresponding

number

information is not specified.

Required

VPI

INTEGER

0 to 4095

VPI

Optional

VCI

INTEGER

32 to 65535

VCI

Optional

SVLAN

INTEGER

0 to 4095

SVLAN

Optional

CVLAN

INTEGER

0 to 4095

CVLAN

Required

UV

INTEGER

0 to 4095

Customer VLAN.

Optional

Version: 04

81

Northbound Interface TL1 User Manual

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, configure the VLAN information for the No. 1 DSL port located in the No. 3
slot of the ONU whose IP address is 10.250.18.121.
u

Command

CFG-DSLPORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::VPI=0,
VCI=35,CVLAN=261;

u

Response Message

FH_10.78.20.120 2011-02-22 17:19:01
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DEL-DSLPORTVLAN

5.3.5

Deleting the VLAN of a DSL Port (DEL-DSLPORTVLAN)

Function Description
This command is used for deleting the VLAN information of a DSL port.

Command Format
DEL-DSLPORTVLAN::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][,SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan];

Supported Equipment
u

82

OLT: AN5516 series, AN5116 series.

Version: 04

5 Service Commissioning Interface

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Cabinet rack -

STRING

shelf - slot - PON
port number

ONUIDTYPE

STRING

has a management IP address.

OLT IP address, name or ID.

ONUID

STRING

Size (128)

through the approach of cabinet rack -

The ONU that has

shelf - slot - PON port number. Enter NA

no management IP

if the corresponding information is not

address. Required.

specified.
ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER).

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

ONUPORT

no management IP

PON port information location. Locate

ONU identifier, used for uniquely
OCTET

-

address. Required.

OCTET

OCTET

IP address, name or ID of the ONU that

Remark

The ONU that has
Size (128)

Size (128)
PONID

Description

Size (128)

Locates card port through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - port number.

STRING

shelf - slot - port

Enter NA if the corresponding

number

information is not specified.

The ONU that has
no management IP
address. Required.
The ONU that has
no management IP
address. Required.

Required.

VPI

INTEGER

0 - 4095

Vpi

Optional.

VCI

INTEGER

32 - 65535

Vci

Optional.

SVLAN

INTEGER

0 - 4095

SVLAN

Optional.

CVLAN

INTEGER

0 - 4095

CVLAN

Required.

UV

INTEGER

0 - 4095

VLAN at user side

Optional.

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Version: 04

83

Northbound Interface TL1 User Manual

Example
For example, delete the VLAN information of the No. 1 DSL port located in the No. 3 slot
of the ONU whose IP address is 10.250.18.121.
u

Command

DEL-DSLPORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::VPI=0,
VCI=35,CVLAN=261;

u

Response Message
FH_10.78.20.120 2/22/2011 18:13:38

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
CFG-DSLPORTVLAN

5.3.6

Adding a Multicast User for a DSL Port (ADDDSLIPTVPORT)

Function Description
This command is used for adding a multicast user for a DSL port.

Command Format
ADD-DSLIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[UV=user
vlan][VPI=vpi][,VCI=vci][,MVLAN=mvlan];

Supported Equipment

84

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter Name

ONUIP

OLTID

Data Type
OCTET
STRING

OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management IP

-

address.
The ONU that has no
Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON

STRING

shelf - slot - PON

port number. Enter NA if the

port number

corresponding information is not

The ONU that has no
management IP address.
Required.

specified.

ONUIDTYPE

OCTET
STRING

Size (128)

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP address.

NUMBER).

Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP address.

NAME, MAC, LOID or ONU_

Required.

NUMBER.
Size (128)
ONUPORT

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

Locates card port through the
approach of cabinet rack - shelf slot - port number. Enter NA if the

Required.

corresponding information is not
specified.

VPI

INTEGER

0 - 4095

Vpi

Optional.

VCI

INTEGER

32 - 65535

Vci

Optional.
Optional. It is required

UV

INTEGER

0 - 4095

VLAN at user side

when VDSL works in
VDSL mode.
Optional. Specified

MVLAN

INTEGER

Size (32)

Associated multicast VLAN

multicast VLAN for service
provisioning.

Response Format
It complies with the operation-command response format in Response Message Format.

Version: 04

85

Northbound Interface TL1 User Manual

Output Parameter
None

Example
For example, add a multicast user for the DSL 1 port located in the No. 3 slot of the ONU
whose IP address is 10.250.18.121.
u

Command

ADD-DSLIPTVPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::UV=100,
VPI=0,VCI=35,MVLAN=88;

u

Response Message

FH_10.78.20.120 2/22/2011 18:15:38
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DEL-DSLIPTVPORT

5.3.7

Deleting a Multicast User of a DSL Port (DELDSLIPTVPORT)

Function Description
This command is used for deleting the multicast service of a DSL port.

Command Format
DEL-DSLIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][UV=user vlan][,MVLAN=mvlan];

Input Parameter
Parameter
ONUIP

OLTID
86

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has no
management IP address
Version: 04

5 Service Commissioning Interface

Parameter

Data Type

Value Range

Description

Remark

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf -

information rack - shelf - slot -

Required for an ONU that has no

STRING

slot - PON port

PON port number. If any part of

management IP address

number

the information is unavailable, enter
NA instead.

ONUID-

OCTET

TYPE

STRING

Size (128)

ONU identifier type (ONU_NAME,

Required for an ONU that has no

MAC, LOID, ONU_NUMBER)

management IP address

ONU identifier, used for uniquely
ONUID

OCTET
STRING

identifying the ONU connected to
Size (128)

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

VPI

INTEGER

-

Locate a card port through the
information rack - shelf - slot port number. If any part of the

Required

information is unavailable, enter NA
instead.
Vpi

Optional. It is required for ADSL or
VDSL working in ADSL mode.
Optional. It is required for the

VCI

INTEGER

-

Vci

ADSL or the VDSL working in
ADSL mode.

UV

INTEGER

0 to 4085

User-side VLAN

MVLAN

INTEGER

Size (32)

Associated multicast VLAN

Optional. It is required for the
VDSL working in VDSL mode.
Optional (specified multicast VLAN
for service provisioning)

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Delete the multicast service of DSL port 1 in slot 3 of the ONU whose IP address is
10.250.18.121.

Version: 04

87

Northbound Interface TL1 User Manual

u

Command issued

DEL-DSLIPTVPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::VPI=0,
VCI=35,UV=100,MVLAN=88;

u

Response message

FH_10.78.20.120 2011-02-22 18:17:31
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
ADD-DSLIPTVPORT

5.3.8

Configuring the DSL Port Parameters (CFGDSLIPTVPORT)

Function Description
This command is used for configuring the IPTV service of a DSL port.

Command Format
CFG-DSLIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[,UV=uv][,
FLMODE][,MAXGRP=Max-group-number];

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has no
management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf -

information rack - shelf - slot -

Required for an ONU that has no

STRING

slot - PON port

PON port number. If any part of

management IP address

number

the information is unavailable, enter
NA instead.

ONUID-

OCTET

TYPE

STRING

88

Size (128)

ONU identifier type (ONU_NAME,

Required for an ONU that has no

MAC, LOID, ONU_NUMBER)

management IP address

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

Value Range

Description

Remark

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

Locate a card port through the
information rack - shelf - slot port number. If any part of the

Required

information is unavailable, enter NA
instead.
Optional. Applicable to the MSAN

UV

Port signaling VLAN

-

INTEGER

card port parameter protocol. The
default value is 0.

FLMODE

Fast leave mode:

OCTET

Size (32)

STRING

Enabled

Optional

Disabled
Maximum number of multicast

MAXGRP

programs that a port can join

-

INTEGER

Optional

simultaneously.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Configure the IPTV service of DSL port 1 in slot 3 of the ONU whose IP address is
10.250.18.121.
u

Command issued

CFG-DSLIPTVPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::
FLMODE=Enabled,MAXGRP=20;

u

Response message

FH_10.78.20.120 2011-02-22 18:17:31
M

CTAG COMPLD
EN=0

ENDESC=No error

;
Version: 04

89

Northbound Interface TL1 User Manual

Related Command
DEL-DSLIPTVPORT
ADD-DSLIPTVPORT

5.4

VoIP Service
The following introduces how to activate / deactivate a VoIP port, and configure / delete the
voice service of the VoIP port.

5.4.1

Activating a VoIP Port (ACT-VOIPPORT)

Function Description
The command is used for activating a VoIP port.

Command Format
ACT-VOIPPORT::ONUIP=onu-name|[OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has no
management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf -

information rack - shelf - slot -

Required for an ONU that has no

STRING

slot - PON port

PON port number. If any part of

management IP address

number

the information is unavailable,
enter NA instead.

90

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

ONUID-

OCTET

TYPE

STRING

Value Range

Description
ONU identifier type (ONU_

Size (128)

NAME, MAC, LOID, ONU_
NUMBER)

Remark
Required for an ONU that has no
management IP address

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

Locate a card port through the
information rack - shelf - slot port number. If any part of the

Required

information is unavailable, enter
NA instead.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Activate voice port 1 of the ONU (that has no management IP address)
connected to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100. The
information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E; the authentication
mode is MAC.
u

Command issued

ACT-VOIPPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 18:09:11
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2: Activate POTS port 1 in slot 2 of the ONU (having a management IP address)
whose IP address is 10.250.18.121.

Version: 04

91

Northbound Interface TL1 User Manual

u

Command issued

ACT-VOIPPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 19:01:47
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
DACT-VOIPPORT

5.4.2

Deactivating a VoIP Port (DACT-VOIPPORT)

Function Description
The command is used for deactivating a VoIP port.

Command Format
DACT-VOIPPORT::ONUIP=onu-name|[OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Remark
Required for an ONU that has no
management IP address

PON port location information.

PONID

Size (128)

Locate a port through the

OCTET

Rack - shelf -

information rack - shelf - slot -

Required for an ONU that has no

STRING

slot - PON port

PON port number. If any part of

management IP address

number

the information is unavailable, enter
NA instead.

92

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

ONUID-

OCTET

TYPE

Value Range
Size (128)

STRING

Description

Remark

ONU identifier type (ONU_NAME,

Required for an ONU that has no

MAC, LOID, ONU_NUMBER)

management IP address

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

Required for an ONU that has no
management IP address

NUMBER.
Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

Locate a card port through the
information rack - shelf - slot port number. If any part of the

Required

information is unavailable, enter NA
instead.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Deactivate voice port 1 of the ONU (having no management IP address)
connected to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100. The
information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E; the authentication
mode is MAC.
u

Command issued

DACT-VOIPPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 18:11:12
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2: Deactivate POTS port 1 in slot 2 of the ONU (having a management IP address)
whose IP address is 10.250.18.121.
u
Version: 04

Command issued
93

Northbound Interface TL1 User Manual

DACT-VOIPPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 19:01:57
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
ACT-VOIPPORT

5.4.3

Configuring the Voice Service of a VoIP Port (CFGVOIPSERVICE)

Function Description
The command is used for configuring the voice service of a VoIP port.

Command Format
CFG-VOIPSERVICE::ONUIP=onu-name|[OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[PHONENUMBER=phonenumber][,PT=protocoltype][,SLVAN=voipoutervlan][,
VOIPVLAN=voipinnervlan][,SCOS=outerqos][,CCOS=innerqos][,
EID=equipmentid][TID=Terminal-ID][SIPREGDM=sipregisterdomain][,
SIPUSERNAME=sipusername][,SIPUSERPWD=sipuserpassword]
[MGCIP1=activebacip][,MGCIP2=standbybacip][,IPMODE=ipmode][,
IP=ipaddress,IPMASK=ipmask,IPGATEWAY=ipgateway][,PPPOEUSER=pppoeuser,
PPPOEPWD=pppoepassword]，VOICECODEC=voice;

Supported Equipment

94

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

Parameter Description

Remark

IP address, name or ID of the
ONU that has a management

-

IP address.
The ONU that has no
OLTID

OCTET STRING

Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information

PONID

OCTET STRING

Size (128)

location. Locate through

Cabinet rack - shelf -

cabinet rack - shelf - slot -

slot - PON port

PON port number. Enter NA

number

if the corresponding

The ONU that has no
management IP address.
Required.

information is not specified.

ONUIDTYPE

OCTET STRING

Size (128)

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP address.

NUMBER).

Required.

ONU identifier, used for
uniquely identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the PON port.
The value is ONU_NAME,
MAC, LOID or ONU_

The ONU that has no
management IP address.
Required.

NUMBER.
Locates card port through
ONUPORT

OCTET STRING

Size (128)

cabinet rack - shelf - slot -

Cabinet rack - shelf -

port number. Enter NA if the

slot - port number

corresponding information is

Required

not specified.
PHONENUM-

Size (1 to 32)

PT

OCTET STRING

Size (1 to 32)

EID

OCTET STRING

Size (1 to 64)

TID

OCTET STRING

Size (1 to 64)

H248 user terminal identifier

SIPREGDM

OCTET STRING

Size (1 to 32)

SIP register server

Optional

OCTET STRING

Size (1 to 32)

Username corresponding to

Optional. It is required for the

the SIP user port

SIP protocol.

BER

SIPUSERNAME

Version: 04

Telephone number

Optional. It is required for the

OCTET STRING

Voice protocol type (H.248,
SIP)

SIP protocol.
Optional

MG gateway domain name in

Optional. It is required for the

the H248 configuration.

H248 protocol.
Optional. It is required for the
H248 protocol.

95

Northbound Interface TL1 User Manual

Parameter
SIPUSERPWD

SVLAN

Data Type

Value Range

OCTET STRING

Size (1 to 32)

INTEGER

0 to 4095

Parameter Description

Remark

Password corresponding to

Optional. It is required for the

the SIP user port

SIP protocol.

Outer VLAN of the voice
service

Optional. Indicates the outer
VLAN of the stacked VLAN
in the FTTH scenario.

Inner VLAN of the voice

Optional. It is required for the

service.

FTTH scenario.

VOIPVLAN

INTEGER

0 to 4095

IPMODE

OCTET STRING

Size (1 to 32)

IP

OCTET STRING

Size (1 to 32)

IP address

IPMASK

OCTET STRING

Size (1 to 32)

IP address mask

IPGATEWAY

OCTET STRING

Size (1 to 32)

Gateway address

PPPOEUSER

OCTET STRING

Size (1 to 32)

PPPOE username

PPPOEPWD

OCTET STRING

Size (1 to 32)

PPPOE password.

SCOS

INTEGER

0 to 7

Outer service priority level

Optional

CCOS

INTEGER

0 to 7

Inner service priority level

Optional

MGCIP1

OCTET STRING

Size (32)

MGCIP2

OCTET STRING

Size (32)

VOICECODEC

IP obtaining mode: DHCP,
PPPOE, STATIC.

IP address of the active
softswitch
IP address of the standby
softswitch.

Optional
Optional. It is required for
static IP allocation.
Optional. It is required for
static IP allocation.
Optional. It is required for
static IP allocation.
Optional. It is required for the
PPPOE mode.
Optional. It is required for the
PPPOE mode.

Optional
Optional

Size (128)
OCTET STRING

G.711U, G.711A, G.

Speech encoding protocol

Optional

723, G.729 and G.722

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

96

Version: 04

5 Service Commissioning Interface

Example
Example 1, configure the voice service for No. 1 voice port of the ONU (having no
management IP address) connected to the slot 3 - PON 1 port of the OLT whose IP address
is 10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B-40-04-2C1E; authentication mode is MAC.
u

Command

CFG-VOIPSERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::PHONENUMBER=77777777,
PT=H.248,VOIPVLAN=1645,CCOS=0,EID=eid,TID=tid,IPMODE=STATIC,
IP=14.14.14.7,IPMASK=255.255.0.0,IPGATEWAY=14.14.14.1;

u

Response Message

FH_10.78.20.120 2011-02-21 18:56:13
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2, configure the voice service for the POTS 4 port located in the No. 1 slot of the
ONU (having a management IP address) whose IP address is 10.78.11.115.
u

Command

CFG-VOIPSERVICE::ONUIP=10.78.11.115,ONUPORT=NA-NA-1-4:CTAG::PT=H.248,
VOIPVLAN=3111,CCOS=0,EID=AAA,TID=12365478;

u

Response Message

FH_10.78.20.120 2011-02-21 13:41:37
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
ACT-VOIPPORT
DEL-VOIPSERVICE

5.4.4

Deleting the Voice Service of a VoIP Port (DELVOIPSERVICE)

Function Description
The command is used for deleting the voice service of a VoIP port.
Version: 04

97

Northbound Interface TL1 User Manual

Command Format
DEL-VOIPSERVICE::OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index,ONUPORT=onu-port:CTAG::;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
OLTID

PONID

Data Type
OCTET
STRING

Remark

Size (128)

IP address, name or ID of the OLT

Required

Size (128)

PON port location information. Locate a port

Rack - shelf - slot

through the information rack - shelf - slot -

STRING

- PON port

PON port number. If any part of the information

number

is unavailable, enter NA instead.

OCTET

TYPE

STRING

ONUPORT

Description

OCTET

ONUID-

ONUID

Value Range

OCTET
STRING

OCTET
STRING

Size (128)

ONU identifier type (ONU_NAME, MAC, LOID,
ONU_NUMBER)

Required

Required

ONU identifier, used for uniquely identifying the
Size (128)

ONU connected to the PON port. The value is

Required

ONU_NAME, MAC, LOID or ONU_NUMBER.
Size (128)

Locate a card port through the information rack -

Rack - shelf - slot

shelf - slot - port number. If any part of the

- port number

information is unavailable, enter NA instead.

Required

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

98

Version: 04

5 Service Commissioning Interface

Example
Example 1: Delete the voice service of voice port 1 of the ONU (having no management IP
address) connected to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
The information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E; the
authentication mode is MAC.
u

Command issued

DEL-VOIPSERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.78.20.120 2011-02-21 19:06:14
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2: Delete the voice service of POTS port 4 in slot 1 of the ONU (having a
management IP address) whose IP address is 10.78.11.115.
u

Command issued

DEL-VOIPSERVICE::ONUIP=10.78.11.115,ONUPORT=NA-NA-1-4:CTAG::PT=H.248,
VOIPVLAN=3111,CCOS=0,EID=AAA,TID=12365478;

u

Response message

FH_10.78.20.120 2011-02-22 19:08:09
M

CATG COMPLD

EN=0

ENDESC=No error

;

Related Command
ACT-VOIPPORT
CFG-VOIPSERVICE

5.4.5

Configuring the NGN Uplink Interface (SET-NGN-UPLINK)

Function Description
This command is used for configuring the NGN uplink interface parameters, including the
uplink MGC and SIP server information.

Version: 04

99

Northbound Interface TL1 User Manual

Command Format
The command format for the ANM2000 is as follows:
SET-NGN-UPLINK::OLTID=device-ID:CTAG::SVCNAME=servicename|
SVCVLAN=servicevlan,NGNPROTOCOL=ngn_protocol[,
MASTERDNS=master_dns_ipaddress][,SLAVEDNS=slave_dns_ipaddress][,
DHCP=dhcp],SIPREGSERVER=sip_registerar_server_ipaddress,
SIPREGPORT=sip_registerar_server_port,SIPPROSERVER=sip_proxy_serveripaddress,SIPPROPORT=sip_proxy_server_port,SIPEXP=sip_expires,
STATUS=enable;

The command format for the UNM2000 is as follows:
SET-NGN-UPLINK::OLTID=device-ID:CTAG::SVCNAME=servicename,
NGNPROTOCOL=ngn_protocol ,[MGCIP1=mgcip1,MGCIP1PORT=mgcip1port][,
MGCIP2=mgcip2,MGCIP2PORT=mgcip2port][,MASTERDNS=master_dns_ipaddress][,
SLAVEDNS=slave_dns_ipaddress] [,DHCP=dhcp][,
SIPREGSERVER=sip_registerar_server_ipaddress,
SIPREGPORT=sip_registerar_server_port,SIPPROSERVER=sip_proxy_serveripaddress,SIPPROPORT=sip_proxy_server_port,SIPEXP=sip_expires],
STATUS=status;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

OLTID

OCTET STRING

Size (128)

IP address, name or ID of the OLT

Required

SVCNAME

STRING

Size (0 to 30)

Signaling service name

Required

SVCVLAN

INTEGER

0 to 4085

NGNPROTOCOL

When it is used, the EMS matches
it from the existing local VLANs.

-

0: MGCP
INTEGER

1: H.248

NGN uplink protocol

-

Active DNS server

-

Standby DNS server

-

2: SIP
1 to 65535

MASTERDNS

OCTET STRING

SLAVEDNS

OCTET STRING

DHCP

INTEGER

0 or 1

A switch to enable DHCP

-

STRING

Size (0 to 64)

SIP register server address

-

INTEGER

1 to 65535

SIP register server port

-

STRING

Size (0 to 64)

SIP proxy server address

-

SIPREGSERVER
SIPREGPORT
SIPPROSERVER
100

(sample:lefefefe)
1 to 65535
(sample:lefefefe)

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

Value Range

Description

Remark

SIPPROPORT

INTEGER

1 to 65535

SIP proxy server port

-

SIPEXP

INTEGER

1 to 4294967294

SIP protocol timeout

-

STATUS

INTEGER

1: create

1: create

2: delete

2: delete

MGCIP1

OCTET STRING

Size (64)

MGCIP1PORT

INTEGER

1024 to 65535

MGCIP2

OCTET STRING

Size (64)

MGCIP2PORT

INTEGER

1024 to 65535

MGC1 IP address / standby SIP
registrar server address
MGC1 port No. / standby SIP
registrar server port No.
MGC2 IP address / standby SIP
proxy server address
MGC2 port No. / standby SIP
proxy server port No.

-

-

-

-

-

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
For example, configure the NGN uplink interface parameters of the OLT whose IP address
is 10.78.200.200 (The ONU has no management IP address).
u

Command issued

SET-NGN-UPLINK::OLTID=10.78.200.200:CTAG::SVCNAME=xx,NGNPROTOCOL=2,
MGCIP1=1.1.1.5,MGCIP1PORT=5060,MGCIP2=5.3.6.2,MGCIP2PORT=5060,
MASTERDNS=1.1.1.1,SLAVEDNS=2.6.6.2,DHCP=1,SIPREGSERVER=2.2.2.2,
SIPREGPORT=2222,SIPPROSERVER=3.3.3.3,SIPPROPORT=5060,SIPEXP=3600,
STATUS=2;

u

Response message

M

CTAG COMPLD

FH_10.78.12.155 2014-07-16 14:00:31
EN=0

ENDESC=No error

;

Version: 04

101

Northbound Interface TL1 User Manual

Related Command
None

5.4.6

修改VOIP端口语音编码（MODIFY-ONUVOIPSERVICE）

[A60110] 文档 "x-wc://file=pubm-0000739664-en.xml" 中第 87 行的引用 (topicref) 错
误: 找不到引用 ID "x-wc://file=t-0000739596-en.xml#fhconcept-修改VOIP端口语音编
码（MODIFY-ONUVOIPSERVICE）_X14878411836045"。

5.5

VLAN Service
The following introduces how to create and delete the VLAN service.

5.5.1

Creating a VLAN (ADD-VLAN)

Function Description
This command is used for creating a VLAN.

Command Format
ADD-VLAN::ONUIP=onu-name|OLTID=olt-name:CTAG::VLAN=vlanid[,DESC=vlanalias],VLANMODE=vlan-type[,PORTLIST=port-list][,MVLANFLAG=mvlan-flag][,
MVLANPRI=mvlan-priority][,SERVICE=service];

Supported Device

102

u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-20, AN5006-15.

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter

ONUIP

OLTID
VLAN
DESC

Data Type

OCTET
STRING
OCTET
STRING
INTEGER
OCTET
STRING

Value
Range

Size (128)

Description

IP address, name or ID of the ONU
that has a management IP address

Remark
In FTTB / FTTN scenario, it is
required to create a VLAN on the
ONU.
It is required to create a VLAN on

Size (128)

IP address, name or ID of the OLT

0 to 4094

VLANID

Required

Size (128)

VLAN alias

Optional

the OLT.

VLAN attribute.
SINGLE: Switches the outer VLAN
tag or adds a VLAN tag to the
untagged message in the uplink
direction.
VLAN-

OCTET

MODE

STRING

SINGLE

STACKING: Switches the inner

QINQ

VLAN tag and adds the outer VLAN

STACKING

tag, or adds the outer and inner

Required

VLAN tags to the untagged message
in the uplink direction.
QINQ: Adds a VLAN tag to the
message uplinked, mainly for the
private line application.

PORTLIST

MVLANFLAG
MVLANPRI

OCTET

NA-NA-NA-

STRING

NA

INTEGER

INTEGER

-

-

A list of uplink ports that allow the
packets with the specified VLAN ID
to pass through

Indicates whether it is a multicast
VLAN or non-multicast VLAN.
Priority of the IGMP message

Optional. It can be a list of uplink
ports, separated by vertical bars, for
example, NA-0-19-0|NA-0-19-1|NA0-20-0.
Optional. The default value is 0.
0: Non-multicast VLAN
1: Multicast VLAN
Optional
Default value: 6
Optional
HSI (Internet access)
IPTV (unicast)

SERVICE

OCTET
STRING

VOIP (voice)
-

Service type of the VLAN

Default value: HSI
This parameter can contain the
meaning of MVLANFLAG by
adding a parameter value to indicate
multicast or non-multicast.

Version: 04

103

Northbound Interface TL1 User Manual

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Create a VLAN with VLAN ID being 101 and VLANMODE being STACKING for the
OLT (the ONU has no management IP address) whose IP address is 10.78.200.200.
u

Command issued

ADD-VLAN::OLTID=10.78.200.200:CTAG::VLAN=101,VLANMODE=STACKING,
PORTLIST=NA-NA-19-1;

u

Response message
FH_10.98.100.16 2014-06-12 15:45:15

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DEL-VLAN

5.5.2

Deleting a VLAN (DEL-VLAN)

Function Description
This command is used for deleting a VLAN.

Command Format
DEL-VLAN:: ONUIP=onu-name|OLTID=olt-name:CTAG::VLAN=vlanid;

104

Version: 04

5 Service Commissioning Interface

Input Parameter
Parameter

Data Type

Value
Range

Description

Remark

IP address, name or ID
ONUIP

OCTET
STRING

Size (128)

of the ONU that has a
management IP

-

address
OLTID
VLAN

OCTET
STRING
INTEGER

Size (128)
-

IP address, name or ID

Required for an ONU that has no

of the OLT

management IP address

VLANID

Required

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Delete the VLAN with VLAN ID being 101 of the OLT (the ONU has no management IP
address) whose IP address is 10.78.200.200.
u

Command issued

DEL-VLAN::OLTID=10.78.200.200:CTAG::VLAN=101;

u

Response message

FH_10.98.100.16 2014-06-12 16:03:26
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
ADD-VLAN

5.6

Configuring a Port Speed Rate Template
The following introduces the PORTSPEEDLIMITPROFILE command and example for
adding / deleting the port speed limit template.

Version: 04

105

Northbound Interface TL1 User Manual

5.6.1

Adding a Port Rate Limiting Template (ADDPORTSPEEDLIMITPROFILE)

Function Description
This command is used for adding a port rate limiting template.

Command Format
ADD-PORTSPEEDLIMITPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG::
PROFILENAME=profile name, [USPOLICINGSTATUS=status,UMABW=uplink maximum
allowed bandwidth,UPCIR=UsPolicingCIR,USCBS=us cbs,USEBS=us ebs,
DSPOLICINGSTATUS=status,SDBW=servicedownlinkbandwidth,
DPCIR=DsPolicingCIR,DSPIR=ds pir];

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management IP

-

address
Required for an ONU

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of the OLT

that has no
management IP
address

PROFILENAME

USPOLICINGSTATUS
UMABW

OCTET
STRING

Size (128)

Name of the port rate limiting
template

Required

Uplink policing status
INTEGER

0 or 1

0: disable

Optional

1: enable
INTEGER

0 to 1000000

Maximum service uplink
bandwidth

Optional

0 to 1000000
UPCIR

INTEGER

The AN5006-20 / 30:

Assured uplink port rate

Optional

64 to 1000000
USCBS

INTEGER

0 to 4294967294

Uplink committed burst size

Optional

USEBS

INTEGER

0 to 4294967294

Uplink excess burst size

Optional

DSPOLICINGSTATUS
SDBW

106

Downlink policing status
INTEGER

0 or 1

0: disable

Optional

1: enable
INTEGER

0 to 1000000

Service downlink bandwidth

Optional

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

DPCIR

INTEGER

Value Range

Description

Remark

Assured downlink port rate

Optional

Downlink peak cell rate

Optional

0 to 1000000
The AN5006-20 / 30:
64 to1000000
DSPIR

INTEGER

0 to 16777215

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Add a rate limiting template named as hello for the ONU whose IP address is
10.171.0.38, and set the rate limiting parameters.
u

Command issued

ADD-PORTSPEEDLIMITPROFILE::ONUIP=10.171.0.38:CTAG::PROFILENAME=hello,
USPOLICINGSTATUS=1,UPCIR=200,USCBS=111,USEBS=222,DSPOLICINGSTATUS=1,
DPCIR=400,DSPIR=444;

u

Response message

FH_0.0.0.0 2010-11-04 11:45:19
M

CTAG COMPLD
EN=0

ENDESC=No error

Related Command
DEL-PORTSPEEDLIMITPROFILE

5.6.2

Deleting a Port Rate Limiting Template (DELPORTSPEEDLIMITPROFILE)

Function Description
This command is used for deleting a port rate limiting template.

Version: 04

107

Northbound Interface TL1 User Manual

Command Format
DEL-PORTSPEEDLIMITPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG::
PROFILENAME=profile name;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter
ONUIP

OLTID

Data Type
OCTET

Value Range
Size (128)

STRING

Description
IP address, name or ID of the ONU
that has a management IP address

Remark
Required for an ONU

OCTET

Size (128)

STRING

PROFILE-

OCTET

NAME

STRING

IP address, name or ID of the OLT

that has no
management IP address

Size (128)

Name of the port rate limiting
template

Required

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Delete the rate limiting template hello on the ONU whose IP address is 10.171.0.38.
u

Command issued

DEL-PORTSPEEDLIMITPROFILE::ONUIP=10.171.0.38:CTAG::PROFILENAME=hello;

u

Response message

FH_0.0.0.0 2010-11-04 11:45:19
M

CTAG COMPLD
EN=0

108

ENDESC=No error

Version: 04

5 Service Commissioning Interface

Related Command
ADD-PORTSPEEDLIMITPROFILE

5.7

Configuring a Bandwidth Template
The following introduces the BWPROFILE command and example for adding / deleting a
bandwidth template.

5.7.1

Adding a Bandwidth Template (ADD-BWPROFILE)

Function Description
This command is used for adding a bandwidth template.

Command Format
ADD-BWPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG::PROFILENAME=profile
name [,UPMGBW=Up MIN Guaranteed Bandwidth,UMABW=uplink maximum allowed
bandwidth, DMGBW=Down MIN Guaranteed Bandwidth,DMABW=Down MAX Allowed
Bandwidth, UFBW=Upstream Fixed Bandwidth];

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of
Size (128)

the ONU that has a

-

management IP address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of

ONU that has no

the OLT

management IP
address

Version: 04

PROFILE-

OCTET

NAME

STRING

Size (128)

Name of the bandwidth
template

Required

109

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

UPMGBW

INTEGER

-

UMABW

INTEGER

-

DMGBW

INTEGER

-

DMABW

INTEGER

-

UFBW

INTEGER

-

Description
Minimum service uplink
bandwidth
Maximum service uplink
bandwidth
Minimum service downlink
bandwidth
Maximum service
downlink bandwidth
Fixed service uplink
bandwidth

Remark
Optional
Optional
Optional
Optional
Optional

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Add the bandwidth template for the OLT whose IP address is 10.171.0.33.
u

Command issued

ADD-BWPROFILE::OLTID=10.171.0.33:CTAG::PROFILENAME=hello,UPMGBW=100,
UMABW=11111,DMGBW=2222,DMABW=3333,UFBW=4444;

u

Response message

FH_0.0.0.0 2010-11-04 11:45:19
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DEL-BWPROFILE

110

Version: 04

5 Service Commissioning Interface

5.7.2

Deleting a Bandwidth Template (DEL-BWPROFILE)

Function Description
This command is used for deleting a bandwidth template.

Command Format
DEL-BWPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG:: PROFILENAME=profile
name;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of
Size (128)

the ONU that has a

-

management IP address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of

ONU that has no

the OLT

management IP
address

PROFILE-

OCTET

NAME

STRING

Size (128)

Name of the bandwidth
template

Required

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Delete the bandwidth template on the OLT whose IP address is 10.171.0.33.
u
Version: 04

Command issued
111

Northbound Interface TL1 User Manual

DEL-BWPROFILE::OLTID=10.171.0.33:CTAG::PROFILENAME=hello;

u

Response message

FH_0.0.0.0 2015-11-04 11:45:19
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
ADD-BWPROFILE

5.8

Configuring a Flow Policy
The following introduces the FLOWPOLICY command and example for adding / deleting a
flow policy.

5.8.1

Adding a Traffic Policy (ADD-FLOWPOLICY)

Function Description
This command is used for adding a traffic policy.

Command Format
ADD-FLOWPOLICY::ONUIP=onu-name|OLTID=olt-name:CTAG::PROFILENAME=profile
name ,RULENAME=rule name,PRECEDENCE=Precedence[,ACL=acl enable,RATELIMIT=
rate limit, CIR=cir,CBS=cbs,QUEUEENABLE=QueueEnable,QUEUEMAP=Queue
Mapped, COSREMARK=cos remark,COS=cos, DSCPREMARK=dscp remark,DSCP=dscp,
RTC= Remark traffic class,TC= Traffic class,REPORTENABLE=RePortEnable,
REPORTNO=port no,PMENABLE=PortMirrorEnable,MPORTNO=port no];

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of
Size (128)

the ONU that has a

-

management IP address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of

ONU that has no

the OLT

management IP
address

112

Version: 04

5 Service Commissioning Interface

Parameter

Data Type

PROFILE-

OCTET

NAME

STRING

RULENAME
PRECEDENCE

OCTET
STRING
INTEGER

Value Range

Description

Remark

Size (20)

Name of the traffic policy

Required

Size (128)

1 to 12

Name of the traffic
classification rule
Policy priority

Required
Required

Indicates whether to enable
ACL

INTEGER

0 or 1

the ACL.
0: disable

Optional

1: enable
Indicates whether to enable
RATELIMIT

INTEGER

0 or 1

rate control.
0: disable

Optional

1: enable
CIR

INTEGER

0 to 1000000

Assured rate

Optional

CBS

INTEGER

0 to 262144

Burst length

Optional

Indicates whether to enable
QUEUEENABLE

the queue mapping
INTEGER

0 or 1

function.

Optional

0: disable
1: enable

QUEUEMAP

INTEGER

0 to 7

Mapping queue

Optional

Indicates whether to enable
COSREMARK

INTEGER

0 or 1

the re-marking function.
0: disable

Optional

1: enable
COS

INTEGER

0 to 7

Priority label

Optional

Indicates whether to enable
DSCPREMARK

INTEGER

0 or 1

the re-marking function.
0: disable

Optional

1: enable
DSCP

INTEGER

0 to 63

DSCP

Optional

Re-marking traffic class
RTC

INTEGER

0 or 1

0: disable

Optional

1: enable
TC
REPORTENABLE

Version: 04

INTEGER

0 to 255

Communication
classification

Optional

Port re-direction
INTEGER

0 or 1

0: disable

Optional

1: enable

113

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

REPORTNO

INTEGER

1 to 101

Port number

Optional

Port mirroring
PMENABLE

INTEGER

0 or 1

0: disable

Optional

1: enable
MPORTNO

INTEGER

1 to 100

Port number

Optional

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Add a traffic policy named hello for the ONU whose IP address is 10.171.0.39.
u

Command issued

ADD-FLOWPOLICY::ONUIP=10.171.0.39:CTAG::PROFILENAME=hello,
RULENAME=nimei,PRECEDENCE=2,ACL=1,RATELIMIT=1,CIR=1111,CBS=2222,
QUEUEENABLE=1,QUEUEMAP=1,COSREMARK=1,COS=2,DSCPREMARK=1,DSCP=3,RTC=1,
TC=4,REPORTENABLE=1,REPORTNO=5,PMENABLE=1,MPORTNO=6;

u

Response message

FH_0.0.0.0 2015-11-04 11:45:19
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
DEL-FLOWPOLICY
ADD-PORTPVCFLOWPOLICY

5.8.2

Deleting a Traffic Policy (DEL-FLOWPOLICY)

Function Description
This command is used for deleting a traffic policy.

114

Version: 04

5 Service Commissioning Interface

Command Format
DEL-FLOWPOLICY::ONUIP=onu-name|OLTID=olt-name:CTAG:: PROFILENAME=profile
name;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of
Size (128)

the ONU that has a

-

management IP address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of

ONU that has no

the OLT

management IP
address

PROFILE-

OCTET

NAME

STRING

Size (128)

Name of the traffic policy

Required

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Delete the traffic policy hello on the ONU whose IP address is 10.171.0.39.
u

Command issued

DEL-FLOWPOLICY::ONUIP=10.171.0.39:CTAG::PROFILENAME=hello;

u

Response message

FH_0.0.0.0 2015-11-04 11:45:19
M

CTAG COMPLD
EN=0

ENDESC=No error

;
Version: 04

115

Northbound Interface TL1 User Manual

Related Command
ADD-FLOWPOLICY
ADD-PORTPVCFLOWPOLICY

5.8.3

Adding a Port Flow Policy (ADD-PORTPVCFLOWPOLICY)

Function Description
This command is used for adding a port flow policy.

Command Format
ADD-PORTPVCFLOWPOLICY::ONUIP=|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::PVCNO=0,
UPPOLICYID=ubrPcr_1024K,DOWNPOLICYID=ubrPcr_1024K;

Supported Equipment
ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OLTID

OCTET STRING

Size (128)

Name

Size (128)
PONID

OCTET STRING

Cabinet rack - shelf - slot PON port number

ONUIDTYPE

OCTET STRING

Size (128)

Description
IP address or name of the ONU that has a management
IP address.
OLT IP address or name.
PON port information location. Locate through the
approach of cabinet rack - shelf - slot - port number.
Enter NA if the corresponding information is not
specified.
ONU identifier type (ONU_NAME, MAC, LOID,
ONU_NUMBER).
ONU identifier, used for uniquely identifying the ONU

ONUID

OCTET STRING

Size (128)

connected to the PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

116

Version: 04

5 Service Commissioning Interface

Parameter
Name

ONUPORT

Data Type

OCTET STRING

Value Range

Description

Size (128)

Locates through the approach of cabinet rack - shelf -

Cabinet rack - shelf - slot -

slot - port number. Enter NA if the corresponding

port number

information is not specified.
Locates the card through the approach of cabinet rack -

Size (128)
PORTID

OCTET STRING

Cabinet rack - shelf - slot port number

shelf - slot - port number. Enter NA if the corresponding
information is not specified. To only specify the shelf
number, enter it in format of NA-0-NA-NA. To specify
the card, enter it in format of NA-0-6-NA. To specify
the port number, enter it in format of NA-0-6-5.

Response Format
It complies with the query-command response format in Response Message Format.

Example
Issue the command
ADD-PORTPVCFLOWPOLICY::ONUIP=172.28.148.57,ONUPORT=1-1-1-1:CTAG::
PVCNO=1,UPPOLICYID=ubrPcr_1024K,DOWNPOLICYID=ubrPcr_1024K;

Response Message
None

Related Command
ADD-FLOWPOLICY
DEL-FLOWPOLICY

Version: 04

117

6

Integrated Testing Interface
The following introduces the testing commands for related resources of the PON line, voice
service, xDSL port and LAN port.

6.1

The Ping Command
The following introduces the PING command and the related example to use it.

6.1.1

Using PING on an ONU (PING)

Function Description
Pinging an IP address on an ONU can test the connectivity at IP layer between the ONU
and the device corresponding to the IP address.

Command Format
PING::ONUIP=onu name|OLTID=OLT_name[,PONID=ponport_location,ONUIDTYPE
=id-type,ONUID=onu_index]:CTAG::IP=ip-address;

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management

-

IP address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of the

ONU that has no

OLT

management IP
address

PON port location
Size (128)
PONID

OCTET

Rack - shelf - slot

STRING

- PON port
number

information. Locate a port

If input parameters

through the information rack -

exclude the

shelf - slot - PON port

ONUID, the

number. If any part of the

PONID is

information is unavailable,

optional.

enter NA instead.

118

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

ONUID-

OCTET

TYPE

STRING

Value Range

Description

Remark

ONU identifier type: ONU_
Size (128)

Optional

NAME, MAC, LOID, ONU_
NUMBER
ONU identifier, used for
uniquely identifying the ONU

ONUID

OCTET
STRING

Size (128)

connected to the PON port.

Optional

The value is ONU_NAME,
MAC, LOID or ONU_
NUMBER.

IP

OCTET
STRING

Size (20)

Destination IP address of the

Required

PING command

Response Format
It complies with the query command response format in Response Message Format.
Title = List of PING Info
TxPkts RxPkts LostPkts LostPktRatio MinDelay MaxDelay AvgDelay

Output Parameter
Parameter

Data Type

Value Range

Description

Remark

TxPkts

INTEGER

0 to 10

Number of sent packets

-

RxPkts

INTEGER

0 to 10

Number of received packets

-

LostPkts

INTEGER

0 to 10

Number of lost packets

-

LostPktRatio

Version: 04

INTEGER

0 to 100

MinDelay

INTEGER

0 to 2000

MaxDelay

INTEGER

0 to 2000

AvgDelay

INTEGER

0 to 2000

Packet loss rate
Unit: %
Minimum delay time
Unit: ms
Maximum delay time
Unit: ms
Mean delay
Unit: ms

Number of lost
packets / number of
sent packets
-

119

Northbound Interface TL1 User Manual

Example
Example 1: Ping the IP address 10.250.18.100 on the ONU (having no management IP
address) connected to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
The information of the ONU is as follows: ONUID is Test0001; the authentication mode is
LOID.
u

Command issued

PING::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001:CTAG::IP=10.250.18.100;

u

Response message

FH_10.250.18.133 2010-10-27 10:56:34
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

Ping from ONU
----------------------------------------------------------TxPkts RxPkts LostPkts LostPktRatio MinDelay MaxDelay AvgDelay
4

4

0

0

1

1

1

----------------------------------------------------------;

Example 2: Ping the IP address 10.250.18.100 on the ONU (having a management IP address)
whose IP address is 10.250.18.20.
u

Command issued

PING::ONUIP=10.250.18.121:CTAG::IP=10.250.18.100;

u

Response message
FH_10.250.18.133 2010-11-02 09:42:08

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

Ping from ONU
----------------------------------------------------------TxPkts RxPkts LostPkts LostPktRatio MinDelay MaxDelay
2

2

0

0

0

0

AvgDelay

0

----------------------------------------------------------;

120

Version: 04

6 Integrated Testing Interface

Related Command
None

6.2

Querying the Equipment Information
The following introduces the commands and examples for querying the equipment
information.

6.2.1

Querying the NE Information (LST-DEVINFO)

Function Description
This command is used to query the equipment model, software version, memory, CPU and
temperature of the NE (OLT and ONU).

Command Format
LST-DEVINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport-location,
ONUIDTYPE=id-type,ONUID=onu-index]:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter
Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.
OLT IP address, name or ID.

Remark
-

-

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON port

STRING

shelf - slot - PON

number. Enter NA if the

port number

corresponding information is not

The ONU that has no
management IP address.
Required.

specified.

Version: 04

121

Northbound Interface TL1 User Manual

Parameter
Name

Data Type

Value Range

Description

Remark

ONU_NAME
ONUIDTYPE

OCTET
STRING

MAC
LOID
ONU_NUMBER

ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER).

-

ER
ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

The ONU that has no
management IP address.
Required.

Response Format
It complies with the query-command response format in Response Message Format.
Title= List of Device Info
name of attributes: DEVNAME DEVIP DT DEVER MEM CPU TEMPERATURE

Output Parameter
Parameter Name

Data Type

Value Range

Description

DEVNAME

OCTET STRING

Size (128)

Equipment name

DEVIP

OCTET STRING

Size (128)

Equipment IP address

DT

OCTET STRING

Size (255)

Equipment model

DEVER

OCTET STRING

Size (255)

Software version

MEM

INTEGER

0 - 100

CPU

INTEGER

0 - 100

TEMPERATURE

INTEGER

-50 - 100

Memory usage
Unit: %
CPU usage
Unit: %
Temperature
Unit: ℃

Example
For example, query the information of the NE whose IP address is 10.250.18.100.
u

Command

LST-DEVINFO::OLTID=10.250.18.100:CTAG::;

u

Response Message
FH_10.250.18.133 2010-11-01 10:09:57

122

Version: 04

6 Integrated Testing Interface

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of Device Info
----------------------------------------------------------DEVNAME DEVIP
1

DT

DEVER

10.250.18.100

AN5516_01

MEM

CPU

TEMPERATURE

RP0121

68.98

5.57 30

-----------------------------------------------------------

Related Command
None

6.2.2

Querying the Card Information (LST-BRDINFO)

Function Description
This command is sued for querying the type, status and version of the card.

Command Format
LST-BRDINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index][,BOARDID=board-name]:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter Name
ONUIP

OLTID

Version: 04

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.
OLT IP address, name or ID.

Remark
-

-

123

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

Description
PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON port

STRING

slot - PON port

number. Enter NA if the

number

corresponding information is not
specified.

Remark
It is required when
querying the ONU
that has no
management IP
address.

ONU_NAME,
ONUIDTYPE

OCTET

MAC

ONU identifier type (ONU_NAME,

STRING

LOID

MAC, LOID, ONU_NUMBER).

-

ONU_NUMBER

ONUID

OCTET
STRING

Size (128)

ONU identifier, used for uniquely

It is required when

identifying the ONU connected to

querying the ONU

the PON port. The value is ONU_

that has no

NAME, MAC, LOID or ONU_

management IP

NUMBER.

address.

Card information location. Locating
BOARDID

OCTET
STRING

Size (128)

through the approach of cabinet

Optional. If it is not

Cabinet rack - shelf -

rack - shelf - slot number. Enter NA

specified, it indicates

slot

if the corresponding information is

querying all cards.

not specified.

Response Format
It complies with the query-command response format in Response Message Format.
Title= List of Device Info
BOARDID BSTAT BOARDTYPE BSERVICE PNUM SWVER HWVER MEM CPU

Output Parameter
Parameter Name

Data Type

Value Range

Description

Remark

Locates the information of the card connected
BOARDID

OCTET
STRING

Size (128)

with the ONU through the approach of

Cabinet rack -

cabinet rack - shelf - slot number. Enter NA if

shelf - slot

the corresponding information is not

-

specified.

BSTAT

BOARDTYPE

124

OCTET
STRING
OCTET
STRING

Normal
Fault

Card status

-

Card Type

-

Offline
Size (128)

Version: 04

6 Integrated Testing Interface

Parameter Name

Data Type

Value Range

Description

Remark

Power
ETH
ADSL
VDSL
BSERVICE

OCTET

POTS

Card service type (such as ADSL2P and

SCU: main

STRING

E1

SHDSL)

control unit

0 - 64

Number of ports

-

Size (255)

Software version

-

Size (255)

Hardware Version

-

GPON
EPON
SCU
Other
PNUM
SWVER
HWVER

INTEGER
OCTET
STRING
OCTET
STRING

MEM

INTEGER

0 - 100

CPU

INTEGER

0 - 100

Memory usage

-

Unit: %
CPU usage

-

Unit: %

Example
For example, query the card information of the NE whose IP address is 10.250.18.100.
u

Command

LST-BRDINFO::OLTID=10.250.18.100,BOARDID=NA-NA-3:CTAG::;

u

Response Message
FH_10.250.18.133 2010-10-27 10:59:09

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of Board Info
----------------------------------------------------------BOARDID

BSTAT

NA-1-3 Normal

BOARDTYPE

BSERVICE

PNUM

EC4B

4 RP0121

WKE2.119.318R2A 38.88

EPON

SWVER

HWVER

MEM CPU
2.73

----------------------------------------------------------;

Version: 04

125

Northbound Interface TL1 User Manual

Related Command
None

6.3

Querying the PON Information
The following introduces the commands and examples for querying the PON information.

6.3.1

Querying the PON Port Information (LST-PONINFO)

Function Description
This command is used for querying the status and configuration information of an OLT
PON port.

Command Format
LST-PONINFO::OLTID=olt-name,PONID=pon_name:CTAG::;

Input Parameter
Parameter
OLTID

Data Type
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID
of the OLT

Remark
-

PON port location
information. Locate a
Size (128)
PONID

OCTET

Rack - shelf -

STRING

slot - PON port
number

port through the
information rack shelf - slot - PON

-

port number. If any
part of the information
is unavailable, enter
NA instead.

Response Format
It complies with the query command response format in Response Message Format.
Title = List of olt pon port information
AdminState OperState

126

Version: 04

6 Integrated Testing Interface

Output Parameter
Parameter
AdminState
OperState

Data Type

Value Range

OCTET

UP

STRING

DOWN

OCTET

UP

STRING

DOWN

Description
Management status
Operating status

Example
Query the status of PON port 1 in slot 3 of the NE whose IP address is 10.250.18.100.
u

Command issued

LST-PONINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1:CTAG::;

u

Response message
FH_10.250.18.133 2010-10-27 11:02:13

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of olt pon port information
----------------------------------------------------------AdminState
UP

OperState

UP

-----------------------------------------------------------

Related Command
None

6.3.2

Querying the PON Link Statistics Information (LSTPONPERF)

Function Description
This command is used for querying the statistics information of the OLT PON port or ONU
PON port, such as the number of sent / received packets, sent / received bytes as well as
error frames.

Version: 04

127

Northbound Interface TL1 User Manual

Command Format
LST-PONPERF::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location[,
ONUIDTYPE=id-type,ONUID=onu-index]):CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management IP

-

address.
It is required when
querying the OLT

OLTID

OCTET
STRING

Size (128)

OLT IP address, name or ID.

PON port or the ONU
that has no
management IP
address.

PONID

OCTET
STRING

Size (128)
Cabinet rack - shelf slot - PON port number

ONU_NAME
ONUIDTYPE

OCTET

MAC

STRING

LOID
ONU_NUMBER

PON port information location.

It is required when

Locate through the approach of

querying the OLT

cabinet rack - shelf - slot - PON

PON port or the ONU

port number. Enter NA if the

that has no

corresponding information is not

management IP

specified.

address.

ONU identifier type:
ONU_NAME
MAC
LOID
ONU_NUMBER
ONU identifier, used for uniquely

ONUID

OCTET
STRING

identifying the ONU connected to
Size (128)

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_
NUMBER.

It is required when
querying the ONU that
has no management IP
address.

It is required when
querying the ONU that
has no management IP
address.

Response Format
It complies with the query-command response format in Response Message Format.
128

Version: 04

6 Integrated Testing Interface

Title = list of pon port performance
OutPkts InPkts OutOctets InOctets CRC UnderSizePkts OverSizePkts InErrors
OutErrors InDiscards OutDiscards InUnicastPkts InMulticastPkts
InBroadcastPkts OutUnicastPkts OutMulticastPkts OutBroadcastPkts

Output Parameter
Parameter Name

Data Type

Value Range

Description

OutPkts

DOUBLE

0 - 1.85E19

Number of sent packets.

InPkts

DOUBLE

0 - 1.85E19

Number of received packets.

OutOctets

DOUBLE

0 - 1.85E19

Number of sent bytes

InOctets

DOUBLE

0 - 1.85E19

Number of received bytes

CRC

DOUBLE

0 - 1.85E19

Number of received CRC error packets

UnderSizePkts

DOUBLE

0 - 1.85E19

Number of received undersized packets

OverSizePkts

DOUBLE

0 - 1.85E19

Number of received oversized packets

InErrors

DOUBLE

0 - 1.85E19

Number of received error packets

OutErrors

DOUBLE

0 - 1.85E19

Number of unsent error packets

InDiscards

DOUBLE

0 - 1.85E19

Number of discarded received packets

OutDiscards

DOUBLE

0 - 1.85E19

Number of discarded sent packets

InUnicastPkts

DOUBLE

0 - 1.85E19

Number of received unicast packets

InMulticastPkts

DOUBLE

0 - 1.85E19

Number of received multicast packets

InBroadcastPkts

DOUBLE

0 - 1.85E19

Number of received broadcast packets

OutUnicastPkts

DOUBLE

0 - 1.85E19

Number of sent unicast packets

OutMulticastPkts

DOUBLE

0 - 1.85E19

Number of sent multicast packets

OutBroadcastPkts

DOUBLE

0 - 1.85E19

Number of sent broadcast packets

Example
Example 1, query the PON link status of the ONU (having no management IP address) with
ONUID being aa_bbb_ccc_111_222. The ONU is connected to the slot 3 - PON 1 port of
the NE whose IP address is 10.250.18.100.
u

Command

LST-PONPERF::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;

u

Response Message

FH_10.250.18.133 2010-10-27 11:05:41
M

CTAG COMPLD
total_blocks=1

Version: 04

129

Northbound Interface TL1 User Manual

block_number=1
block_records=1
list of pon port performance
----------------------------------------------------------OutPkts InPkts

OutOctets

InOctets

CRC

OverSizePkts

InErrors

OutErrors

InDiscards

UnderSizePkts

OutDiscards InUnicastPkts InMulticastPkts InBroadcastPkts OutUnicastPkts
OutMulticastPkts
2832
0

411
0

OutBroadcastPkts

240431

29259

--

--

--

8

364

542

885

1405

47

--

0

-----------------------------------------------------------

Example 2, query the PON link status of the ONU (having a management IP address)
whose IP address is 10.250.18.121.
u

Command

LST-PONPERF::ONUIP=10.250.18.121:CTAG::;

u

Response Message
FH_10.250.18.133 2010-11-02 09:48:20

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of pon port performance
----------------------------------------------------------OutPkts InPkts OutOctets
InErrors

OutErrors

OutDiscards

InOctets

InUnicastPkts

4409

450601

0

0

1295

8

OverSizePkts

InMulticastPkts InBroadcastPkts

OutMulticastPkts

0

UnderSizePkts

InDiscards

OutUnicastPkts
1385

CRC

202533
90

OutBroadcastPkts
--

667

-926

--

--

2816

-----------------------------------------------------------

Related Command
None

130

Version: 04

6 Integrated Testing Interface

6.3.3

Querying the ONU Configuration (LST-ONUCFG)

Function Description
This command is used for querying the configuration information of an ONU on the OLT,
including ONU status, optical fiber length and authentication information.

Command Format
LST-ONUCFG::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=id-type,
ONUID=onu-index:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
Name
OLTID

PONID

Data Type

Value Range

Description

Size (128)

OLT IP address, name or ID.

Size (128)

PON port information location. Locate

OCTET

Cabinet rack - shelf -

through the approach of cabinet rack - shelf

STRING

slot - PON port

- slot - PON port number. Enter NA if the

number

corresponding information is not specified.

OCTET
STRING

ONU_NAME
ONUIDTYPE

OCTET

MAC

ONU identifier type (ONU_NAME, MAC,

STRING

LOID, ONU_

LOID, ONU_NUMBER).

NUMBER
ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the PON
port. The value is ONU_NAME, MAC,
LOID or ONU_NUMBER.

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of ONU info

Version: 04

131

Northbound Interface TL1 User Manual

AdminState OperState AUTH AUTHINFO Length UsFixedBw UsAssuredBw UsMaxBw
DsMaxBw

Output Parameter
Parameter
Name
AdminState

OperState

AUTHTYPE

Data Type

Value Range

OCTET

UP

STRING

DOWN

OCTET
STRING
OCTET
STRING

Description

Administration status

UP
Power-Off

Running status

LOS
MAC
LOID

Authentication mode

LOIDONCEON
Authentication information. If AUTHTYPE

AUTHINFO

OCTET
STRING

Size (64)

is set to MAC, AUTHINFO is MAC
address. If AUTHTYPE is set to LOID,
AUTHINFO is LOID.

Length

DOUBLE

0 - 100

UsFixedBw

INTEGER

0 - 40000

UsAssuredBw

INTEGER

0 - 40000

UsMaxBw

INTEGER

0 - 40000

DsMaxBw

INTEGER

0 - 40000

Optical fiber length
Unit: km
Fixed uplink bandwidth
Unit: Mbit/s
Guaranteed uplink bandwidth
Unit: Mbit/s
Maximum uplink bandwidth
Unit: Mbit/s
Maximum downlink bandwidth
Unit: Mbit/s

Example
For example, query the configuration information of the ONU with ONUID being
aa_bbb_ccc_111_222. The ONU is connected to the slot 3 - PON 1 port of the OLT whose
IP address is 10.250.18.100.
u

Command

LST-ONUCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;

u

Response Message
FH_10.250.18.133 2010-10-27 11:03:08

M
132

CTAG COMPLD
Version: 04

6 Integrated Testing Interface

total_blocks=1
block_number=1
block_records=1
list of ONU info
----------------------------------------------------------AdminState

OperState

AUTH

UsFixedBw

UsAssuredBw

UsMaxBw DsMaxBw

UP

UP

1000

LOID

AUTHINFO

aaa_bbb_ccc_111_222

Length
0

0

0

1000

-----------------------------------------------------------

Related Command
None

6.3.4

Querying the ONU Status (LST-ONUSTATE)

Function Description
This command is used for querying the status or authentication information of a single
ONU or all ONUs on the OLT PON port.

Command Format
LST-ONUSTATE::OLTID=olt-name,PONID=ponport_location[,ONUIDTYPE=id-type,
ONUID=onu-index]:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

OLTID

OCTET STRING

Size (128)

Description
IP address, name or ID of
the OLT

Remark
-

PON port location
information. Locate a port
Size (128)
PONID

OCTET STRING

Rack - shelf - slot PON port number

through the information
rack - shelf - slot - PON
port number. If any part of

-

the information is
unavailable, enter NA
instead.

Version: 04

133

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description
ONU identifier type: ONU_

ONUIDTYPE

OCTET STRING

Size (128)

NAME, MAC, LOID,
ONU_NUMBER

Remark
Optional. If it is not
specified, the status of all
ONUs on the OLT PON port
will be queried.

ONU identifier, used for

ONUID

OCTET STRING

Size (128)

uniquely identifying the

Optional. If it is not

ONU connected to the PON

specified, the status of all

port. The value is ONU_

ONUs on the OLT PON port

NAME, MAC, LOID or

will be queried.

ONU_NUMBER.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of ONU state
ONUID AdminState OperState AUTH AUTHINFO ONUIP

Output Parameter
Parameter

Data Type

Value Range

ONUID

OCTET STRING

Size (128)

AdminState

OCTET STRING

OperState

OCTET STRING

UP
DOWN

Description
ONU identifier, used for uniquely identifying the ONU
connected to the PON port. The value is ONU_Number.
Management status

UP
Power-Off

Operating status

LOS
AUTH

OCTET STRING

MAC
LOID

Authentication mode
Authentication information.

AUTHINFO

OCTET STRING

Size (64)

If AUTH is set to MAC, AUTHINFO is MAC address.
If AUTH is set to LOID, AUTHINFO is LOID.

ONUIP
LASTOFFTIME
ACTIVESTATE

134

OCTET STRING

-

ONU management IP

OCTET STRING

-

ONU offline time

Active

ONU activation status. Whether the field will be returned

Deactive

depends on the switch.

OCTET STRING

Version: 04

6 Integrated Testing Interface

Parameter
LASTDOWNCAUSE
LASTONTIME

Data Type

Value Range

OCTET STRING

-

OCTET STRING

Size (128)

Description
Offline cause. This parameter and LASTOFFTIME are
alternative, depending on the switch.
The last online time of the ONU. The time format (Beijing
time) is YYYY-MM-DD HH-MM-SS.

Example
Query the status of the ONU with ONUID being aaa_bbb. The ONU is connected to PON
port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-ONUSTATE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-27 11:03:48
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of ONU state
----------------------------------------------------------------ONUID AdminState OperStat AUTH AUTHINFO ONUIP LASTOFFTIME
5

UP

UP

LOID aaa_bbb

--

0000-00-00 00:00:00

-----------------------------------------------------------------

Related Command
None

6.3.5

Querying the MAC Address Table of an ONU UNI Port
(LST-PORTMACADDRESS)

Function Description
This command is used for querying the MAC address table learned by an ONU UNI port.
The MAC address format is XX-XX-XX-XX-XX-XX.

Version: 04

135

Northbound Interface TL1 User Manual

Command Format
LST-PORTMACADDRESS::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location][,ONUIDTYPE=id-type,ONUID=onu_index][,
PORTID=uniport_index][,VLAN=vlan_value]:CTAG::;

u

The ONU that has a management IP address.

LST-PORTMACADDRESS::ONUIP=onu_name,PORTID=uniport_index[,
VLAN=vlan_value]:CTAG::;

u

The ONU that has no management IP address.

LST-PORTMACADDRESS::OLTID=olt_name,PONID=ponport_location,ONUID TYPE=idtype,ONUID=onu_index,PORTID=uniport_index[,VLAN=vlan_value]:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name
ONUIP

Data Type
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
It is required for the

OLTID

OCTET
STRING

Size (128)

OLT IP address, name or ID.

ONU that has no
management IP
address.

PON port information location.

PONID

Size (128)

Locate through the approach of

It is required for the

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON port

ONU that has no

STRING

shelf - slot - PON

number. Enter NA if the

management IP

port number

corresponding information is not

address.

specified.
ONU_NAME
ONUIDTYPE

OCTET

MAC

STRING

LOID
ONU_NUMBER

136

ONU identifier type:
ONU_NAME
MAC
LOID
ONU_NUMBER

It is required for the
ONU that has no
management IP
address.

Version: 04

6 Integrated Testing Interface

Parameter Name

Data Type

Value Range

Description

Remark

ONU identifier, used for uniquely
ONUID

identifying the ONU connected to

OCTET

Size (128)

STRING

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_

PORTID

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

VLAN

INTEGER

0 - 4096

ONU that has no
management IP
address.

NUMBER.
Size (128)

It is required for the

Locates the card through the
approach of cabinet rack - shelf slot - port number. Enter NA if the

Required.

corresponding information is not
specified.
VLAN number

VLAN number

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of MAC Address
VLAN MAC

Output Parameter
Parameter Name

Data Type

Value Range

Description

VLAN

INTEGER

0 - 4095

VLAN

MAC

OCTET STRING

Size (128)

MAC address format is XXXXXX-XX-XX-XX.

Example
Example 1, query the MAC address table of the UNI port of the ONU (having no
management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is connected
to the slot 3 - PON1 port of the OLT whose IP address is 10.250.18.100.
u

Command

LST-PORTMACADDRESS::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,PORTID=NA-NA-NA-1,VLAN=2114:CTAG::;

u

Response Message

FH_10.250.18.133 2010-10-27 11:06:25
M

CTAG COMPLD
total_blocks=1
block_number=1

Version: 04

137

Northbound Interface TL1 User Manual

block_records=1
list of MAC Address
----------------------------------------------------------VLAN

MAC

2114
-----------------------------------------------------------

Example 2, query the MAC address table of the No. 1 port located in the No. 4 slot of the
ONU (having a management IP address) whose IP address is 10.250.18.121.
u

Command

LST-PORTMACADDRESS::ONUIP=10.250.18.121,PORTID=NA-NA-4-1,VLAN=2114:
CTAG::;

u

Response Message

FH_10.250.18.133 11/2/2010 9:45:19
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of MAC Address
----------------------------------------------------------VLAN

MAC

2114
-----------------------------------------------------------

Related Command
None

6.3.6

Querying the DDM Information of Optical Modules (LSTOMDDM)

Function Description
This command is used for querying the DDM information of optical modules, including the
ETH optical module, OLT PON optical module and ONU PON optical module.

Command Format
LST-OMDDM::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location][,
ONUIDTYPE=id-type,ONUID=onu-index][,PORTID=lanport_index][,
PEERFLAG=flag]:CTAG::;
138

Version: 04

6 Integrated Testing Interface

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name
ONUIP

Data Type
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
It is required when

OLTID

OCTET
STRING

querying the OLT PON
Size (128)

OLT IP address, name or ID.

optical module or the
ONU that has no
management IP address.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON port

STRING

shelf - slot - PON

number. Enter NA if the

port number

corresponding information is not
specified.

ONU_NAME
ONUIDTYPE

optical module or the
ONU that has no
management IP address.

OCTET

MAC

ONU identifier type (ONU_NAME,

querying the ONU that has

STRING

LOID

MAC, LOID, ONU_NUMBER).

no management IP
address.

ONU identifier, used for uniquely
OCTET
STRING

identifying the ONU connected to
Size (128)

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_
NUMBER.

Size (128)
PORTID

querying the OLT PON

It is required when

ONU_NUMBER

ONUID

It is required when

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

It is required when
querying the ONU that has
no management IP
address.

Locates the card through the
approach of cabinet rack - shelf -

Optional. It is used for

slot - port number. Enter NA if the

querying the OLT uplink

corresponding information is not

port.

specified.
Optional. It is used for

PEERFLAG

OCTET
STRING

returning the far-end
Size (128)

True, False.

optical power information
upon the query. The
default value is False.

Version: 04

139

Northbound Interface TL1 User Manual

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of MAC Address
ONUID RxPower RxPowerR TxPower TxPowerR CurrTxBias CurrTxBiasR Temperature
TemperatureR Voltage VoltageR PTxPower PRxPower

Output Parameter
Parameter Name

Data Type

Value Range

Description
When querying the OLT optical module, a dash (–) will be

ONUID

OCTET
STRING

Size (128)

returned.
When querying the ONU optical module, the ONU identifier
will be returned. The value is ONU_Number.

RxPower

RxPowerR

TxPower

TxPowerR

CurrTxBias

CurrTxBiasR

Temperature

TemperatureR

Voltage

VoltageR

140

OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING

-40 to 10

Received optical power. Unit: dBm.

Normal
High

Indicates whether the received optical power is normal.

Low
-40 to 10

Sent optical power. Unit: dBm.

Normal
High

Indicates whether the sent optical power is normal.

Low
0 to 131

Bias current. Unit: mA.

Normal
High

indicates whether the bias current is normal.

Low
-45 to 90

Temperature. Unit: ℃.

Normal
High

Indicates whether the temperature is normal.

Low
0 to 6.55

Supply voltage. Unit: V.

Normal
High

Indicates whether the supply voltage is normal.

Low

Version: 04

6 Integrated Testing Interface

Parameter Name
PTxPower

PRxPower

Data Type
OCTET

Value Range

Description
Far-end sent optical power. Unit: dBm. A dash (–) will be

-40 to 10

STRING
OCTET

returned if no optical power is sent.
Far-end received optical power. Unit: dBm. A dash (–) will be

-40 to 10

STRING

returned if no optical power is received.

Example
Example 1, query the optical module information of the ONU (having no management IP
address) with ONUID being aa_bbb_ccc_111_222. The ONU is connected to the slot 3 PON 1 port of the OLT whose IP address is 10.250.18.100.
u

Command

LST-OMDDM::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;

u

Response Message

FH_10.250.18.133 2010-10-27 11:05:05
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of Optical Power Info
----------------------------------------------------------ONUID

RxPower

CurrTxBiasR

RxPowerR

Temperature

TxPower TxPowerR

CurrTxBias

TemperatureR Voltage VoltageR

PTxPower PRxPower
5

-9.76

Normal

Normal

3.40

1.76

Normal

--

Normal

15.80

Normal

62.37

--

-----------------------------------------------------------

Example 2, query the optical module information of the ONU (having a management IP
address) whose IP address is 10.250.18.121.
u

Command

LST-OMDDM::ONUIP=10.250.18.121:CTAG::;

u

Response Message
FH_10.250.18.133 2010-11-02 09:47:44

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

Version: 04

141

Northbound Interface TL1 User Manual

List of Optical Power Info
----------------------------------------------------------ONUID

RxPower RxPowerR

CurrTxBiasR
PTxPower

TxPower TxPowerR

Temperature

TemperatureR

CurrTxBias
Voltage VoltageR

PRxPower

2

-13.44

Normal

2.64

Normal

Normal

3.26

Normal

--

--

20.00

Normal

41.41

-----------------------------------------------------------

Related Command
None

6.3.7

Querying the Unregistered ONU of a PON Port (LSTUNREGONU)

Function Description
This command is used for querying the status of the unregistered ONU of a OLT PON port.

Command Format
LST-UNREGONU::OLTID=olt-name,PONID=pon_name:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
Name
OLTID

Data Type

Value Range

Description

OCTET STRING

Size (128)

OLT IP address, name or ID.

Size (128)
PONID

OCTET STRING

Cabinet rack - shelf - slot PON port number

142

PON port information location. Locate through the
approach of cabinet rack - shelf - slot - PON port
number. Enter NA if the corresponding
information is not specified.

Version: 04

6 Integrated Testing Interface

Response Format
It complies with the query-command response format in Response Message Format.
Title = List of unreg onu information
MAC LOID PWD ERROR AUTHTIME DT

Output Parameter
Parameter Name
MAC
LOID

PWD

ERROR

AUTHTIME

DT

Data Type
OCTET
STRING
OCTET

Value Range

Description

Size (128)

MAC address of the EPON ONU or SN of the GPON ONU.

Size (64)

STRING
OCTET

Size (128)

STRING
OCTET

Size (128)

STRING

Conflict

OCTET

Size (128)

STRING
OCTET

Size (255)

STRING

When the MAC authentication is adopted, a dash (–) will be
returned.
LOID/GPON password. A dash (–) will be returned if there is no
password.
Conflict indicates an authentication information conflict.
ONU authentication time. The time format (Beijing time) is
YYYY-MM-DD HH-MM-SS. Optional.
ONU equipment model. Optional.

Example
For example, query the status information of the unregistered ONU (having no management
IP address). The ONU is connected to the slot 7 - PON 1 port of the OLT whose IP address
is 10.78.200.200.
u

Command

LST-UNREGONU::OLTID=10.78.200.200,PONID=NA-NA-7-1:CTAG::;

u

Response Message
FH_10.98.100.16 2014-06-12 16:29:21

M

CTAG COMPLD
total_blocks=0
block_number=0
block_records=0

List of Unreg Onu information
-------------------------------------------------------------MAC

Version: 04

LOID

PWD

ERROR

AUTHTIME

143

Northbound Interface TL1 User Manual

--------------------------------------------------------------

;

Related Command
None

6.3.8

Querying the Wi-Fi Service Information of an ONU (LSTWIFISERVICE)

Function Description
This command is used for querying the Wi-Fi service information of an ONU.

Command Format
LST-WIFISERVICE::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location]
[,ONUIDTYPE=id-type,ONUID=onu-index]:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description
IP address, name or ID of

ONUIP

OCTET STRING

Size (128)

the ONU that has a
management IP address

OLTID

OCTET STRING

Size (128)

Remark
Required for an ONU that has a
management IP address

IP address, name or ID of

Required for an ONU that has

the OLT

no management IP address

PON port location
information. Locate a port
Size (128)
PONID

OCTET STRING

Rack - shelf - slot PON port number

through the information
rack - shelf - slot - PON

If input parameters exclude the

port number. If any part

ONUID, the PONID is optional.

of the information is
unavailable, enter NA
instead.

144

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range
ONU_NAME

ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Description

Remark

ONU identifier type:
ONU_NAME, MAC,

Optional

LOID, ONU_NUMBER
ONU identifier, used for
uniquely identifying the

ONUID

OCTET STRING

Size (128)

ONU connected to the
PON port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_NUMBER.

Response Format
It complies with the query command response format in Response Message Format.
Title = result of wifiservice
SSIDNO WIFIENABLE WILESSAREA WILESSCHANNEL WILESSSTANDARD TPOWER SSIDNAME
SSIDENABLE SSIDVISIBALE AUTHMODE ENCRYPTYPE PRESHAREDKEY UPDATEKEYINTERVAL
RADIUSSERVER RADIUSPORT RADIUSKEY WEPENCRYPTIONLEVEL WEPKEYINDEX WEPKEY1
WEPKEY2 WEPKEY3 WEPKEY4

Output Parameter
Parameter

Data Type

Value Range

Description

SSIDNO

INTEGER

1 to 4

SSID index

WIFIENABLE

OCTET STRING

Enable, Disable

FREQBANDWIDTH
WILESSAREA

OCTET STRING
OCTET STRING

20/40MHz, 20MHz,
40MHz, 80MHz
USA, EURO

Indicates whether to
enable the Wi-Fi.
Frequency bandwidth
Wi-Fi wireless area

[0, 13] for WILESSAREA
WILESSCHANNEL

INTEGER

=0
[1, 11] for WILESSAREA

Wireless channel number

=1
WILESSSTANDARD

Version: 04

OCTET STRING

802.11b, 802.11g, 802.
11b/g, 802.11n, 802.11bgn

Wireless standard

TPOWER

INTEGER

[0, 20]

Launched power

SSIDNAME

OCTET STRING

Size (32)

SSID name

145

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description
Indicates whether to
enable SSID. Enable

SSIDENABLE

OCTET STRING

Enable, Disable

indicates enabling SSID
and Disable indicates
disabling SSID.

SSIDVISIBALE

OCTET STRING

Available, Not-Available

Indicates whether to hide
SSID.

OPEN, SHARED,
WEPAUTO, WPAPSK,
AUTHMODE

OCTET STRING

WPA, WPA2PSK, WPA2,
WPA/WPA2 WPAPSK,

WLAN authentication
mode

WPA2PSK
NONE, WEP, TKIP, AES,

WLAN encryption type

ENCRYPTYPE

OCTET STRING

PRESHAREDKEY

OCTET STRING

STRING (64)

INTEGER

[0, 4194303]

RADIUSSERVER

OCTET STRING

Size (128)

RADIUS server

RADIUSPORT

OCTET STRING

STRING (2)

RADIUS server port

RADIUSKEY

OCTET STRING

STRING (32)

RADIUS-KEY

UPDATEKEYINTERVAL

WEPENCRYPTIONLEVEL

INTEGER

TKIPAES

1: 40 bits
2: 104 bits

WPA pre-shared key
WPA key update interval
Unit: s

WEP key length

WEPKEYINDEX

INTEGER

[1, 4]

Key index

WEPKEY1

OCTET STRING

STRING (64)

WEP key 1

WEPKEY2

OCTET STRING

STRING (64)

WEP key 2

WEPKEY3

OCTET STRING

STRING (64)

WEP key 3

WEPKEY4

OCTET STRING

STRING (64)

WEP key 4

Example
Query the Wi-Fi service information of the ONU (having no management IP address) with
MAC being FHTT01e821a0. The ONU is connected to PON port 4 in slot 18 of the OLT
whose IP address is 10.78.191.100.
u

Command issued

LST-WIFISERVICE::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;

u

146

Response message

Version: 04

6 Integrated Testing Interface

FH_10.82.25.73 2017-02-24 16:20:25
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=4

result of wifiservice
----------------------------------------------------------------SSIDNO WIFIENABLEFREQBANDWIDTH WILESSAREA WILESSCHANNEL
WILESSSTANDARD TPOWER SSIDNAME SSIDENABLE SSIDVISIBALE
AUTHMODE

ENCRYPTYPE

PRESHAREDKEY

UPDATEKEYINTERVAL

RADIUSSERVER RADIUSPORT RADIUSKEY WEPENCRYPTIONLEVEL
WEPKEYINDEX
WEPKEY3

WEPKEY1

WEPKEY2

WEPKEY4

1 Enable 20MHz/40MHz USA 5 802.11g 15 Bgolas Disable
Not-Available WPA2PSK AES 1111111111 3600
40 bit

1

--

--

5 802.11g 15 eeeeea Disable

Available WPA2PSK AES ru83n55c
--

--

-- --

2 Enable 20MHz/40MHz USA
1

-- --

3600

--

--

--

40

bit

-- -- --

3 Enable 20MHz/40MHz USA
OPEN AES --

86400

--

--

4 Enable 20MHz/40MHz USA
WPA2PSK AES ru83n55c

5 802.11g 15 ghhhhhh Disable Available
--

40 bit

1

--

--

--

--

5 802.11g 15 wwwwww Disable Available

3600

--

--

--

40

bit

1

--

-- -- --

-------------------------------------------------------------------;

Related Command
None

6.3.9

Querying the WAN Service Information of an ONU (LSTONUWANSERVICECFG)

Function Description
This command is used for querying the WAN connection service information of an ONU.

Version: 04

147

Northbound Interface TL1 User Manual

Command Format
LST-ONUWANSERVICECFG::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index][,
ONUPORT=port-id]:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5506-04-F1.

Input Parameter
Parameter Name

ONUIP

OLTID

Data Type
OCTET
STRING

OCTET
STRING

Value Range

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has a
management IP address.
Required.
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack -

cabinet rack - shelf - slot - PON port

STRING

shelf - slot - PON

number. Enter NA if the

port number

corresponding information is not

The ONU that has no
management IP address.
Required.

specified.

ONUIDTYPE

OCTET
STRING

ONU_NAME,
MAC, LOID,
ONU_NUMBER

ONU identifier type (ONU_NAME,
MAC, LOID, ONU_NUMBER ).

The ONU that has no
management IP address.
Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the

The ONU that has no

PON port. The value is ONU_

management IP address.

NAME, MAC, LOID or ONU_

Required.

NUMBER.
Locates the card through the
ONUPORT

OCTET
STRING

approach of cabinet rack - shelf - slot
Size (128)

- port number. Enter NA if the
corresponding information is not
specified.

148

Optional. The LAN port
range is NA-NA-NA-1 to
NA-NA-NA-4; the Wi-Fi
port range is NA-NANA-101 to NA-NA-NA104.

Version: 04

6 Integrated Testing Interface

Response Format
It complies with the query-command response format in Response Message Format.
Title = List of Onu Wan service cfg
SVCNAME CONNMODE CONNTYPE VLANID VLANCOS NATFLAG IPOBTAINTYPE
STATICIPADDRESS STATICIPSUBNET STATICGATEWAY MASTERDNS SLAVEDNS
PPPOEPROXYFLAG PPPOEUSERNAME PPPOEPASSWD PPPOESVCNAME PPPOEMODE QOSFLAG
BINDPORTNO

Output Parameter
Parameter Name
SVCNAME

Data Type
OCTET
STRING

Value Range

Description

Size (128)

Name of the WAN connection

1: TR069
CONNMODE

INTEGER

2: INTERNET
3: TR069INTERNE

WAN connection mode

4: Other
1: bridge

WAN connection type

CONNTYPE

INTEGER

VLANID

INTEGER

1 - 4085. It can be null.

VLAN ID of the WAN connection

VLANCOS

INTEGER

0 - 7. It can be null.

VLAN ID of the WAN connection

NATFLAG

INTEGER

1: Enable

Indicates whether to enable NAT for the WAN

2: Disable

connection

IPOBTAINTYPE

INTEGER

2: route

1: DHCP
2: Static

IP obtaining mode of the WAN connection

3: PPPOE
It is valid only when
STATICIPAD-

OCTET

IPOBTAINTYPE is set to

DRESS

STRING

Static. Otherwise, it is

Static IP address of the WAN connection

disabled.
It is valid only when
STATICIPSUB-

OCTET

IPOBTAINTYPE is set to

NET

STRING

Static. Otherwise, it is

Subnet mask of the WAN connection

disabled.
It is valid only when
STATICGATE-

OCTET

IPOBTAINTYPE is set to

WAY

STRING

Static. Otherwise, it is

Default gateway of the WAN connection

disabled.

Version: 04

149

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

Description

It is valid only when
MASTERDNS

OCTET

IPOBTAINTYPE is set to

STRING

Static. Otherwise, it is

Primary DNS of the WAN connection

disabled.
It is valid only when
SLAVEDNS

OCTET

IPOBTAINTYPE is set to

STRING

Static. Otherwise, it is

Secondary DNS of the WAN connection

disabled.
PPPOEPROXYFLAG

INTEGER

1: Enable

Indicates whether to enable PPPoE Proxy for the WAN

2: Disable

connection.

It is valid only when
PPPOEUSER-

OCTET

IPOBTAINTYPE is set to

NAME

STRING

PPPoE. Otherwise, it is

Username of the PPPoE connection.

disabled.
It is valid only when
PPPOEPASSWD

OCTET

IPOBTAINTYPE is set to

STRING

PPPoE. Otherwise, it is

Password of the PPPoE connection.

disabled.
It is valid only when
PPPOESVC-

OCTET

IPOBTAINTYPE is set to

NAME

STRING

PPPoE. Otherwise, it is

PPPoE service name

disabled.
It is valid only when
IPOBTAINTYPE is set to
PPPoE. Otherwise, it is
PPPOEMODE

INTEGER

disabled.

PPPoE dial-up mode

1: Auto connect
2. Connect when traffic is
deleted
QOSFLAG

INTEGER

1: Enable

Indicates whether to enable the QoS function for the

2: Disable

WAN connection.

1 - 4 indicates LAN1 to
BINDPORTNO

INTEGER

LAN4; 101 - 104 indicates

Binding LAN port

SSID1 to SSID4.

Example
For example, query the WAN connection service information of the ONU (having no
management IP address) with MAC address being FHTT01e821a0. The ONU is connected
to the slot 18 - PON 4 port of the OLT whose IP address is 10.78.191.100.

150

Version: 04

6 Integrated Testing Interface

u

Command

LST-ONUWANSERVICECFG::OLTID=10.78.191.100,PONID=NA-NA-18-4,
ONUIDTYPE=MAC,ONUID=FHTT01e821a0:CTAG::;

u

Response Message

M

CTAG COMPLD

FH_10.82.25.73 2013-02-05 16:52:02
total_blocks=1
block_number=1
block_records=1
List of Onu Wan service cfg:
------------------------------------------------------------SVCNAME CONNMODE CONNTYPE VLANID VLANCOS NATFLAG
IPOBTAINTYPE STATICIPADDRESS STATICIPSUBNET STATICGATEWAY
MASTERDNS SLAVEDNS PPPOEPROXYFLAG PPPOEUSERNAME
PPPOEPASSWD PPPOESVCNAME PPPOEMODE QOSFLAG BINDPORTNO
route_tr069_internet_vid_2 3 2 2 5 1 2 192.168.1.5
255.255.0.0 192.168.1.1 3.3.3.3 4.4.4.4 2
1234567890123456789012345678901
1234567890123456789012345678901 -- 1 1 1
------------------------------------------------------------;

Related Command
None

6.3.10

Restarting an ONU (RESET-ONU)

Function Description
This command is used for restarting an ONU.

Command Format
RESET-ONU::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index][,portid=port-id]:CTAG::
[RESETTYPE=resettype];

Version: 04

151

Northbound Interface TL1 User Manual

Input Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

Description
IP address, name or ID of the
ONU that has a management
IP address

OLTID

OCTET STRING

Size (128)

Remark
Required for an ONU that has
a management IP address

IP address, name or ID of the

Required for an ONU that has

OLT

no management IP address

PON port location
information. Locate a port
PONID

OCTET STRING

Size (128)

through the information rack

If input parameters exclude

Rack - shelf - slot -

- shelf - slot - PON port

the ONUID, the PONID is

PON port number

number. If any part of the

optional.

information is unavailable,
enter NA instead.
ONUIDTYPE

OCTET STRING

ONU_NAME, MAC,

ONU identifier type: ONU_

LOID and ONU_

NAME, MAC, LOID or

NUMBER

ONU_NUMBER

Optional

ONU identifier, used for
uniquely identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the PON port.
The value is ONU_NAME,

Optional

MAC, LOID or ONU_
NUMBER.
Locate a card through rack -

PORTID

OCTET STRING

Size (128)

shelf - slot - port number.

Optional. It is required for

Enter NA for the

restarting a line card or the

corresponding unspecified

main control unit of the ONU

information. For example,

that has a management IP

with NA-NA-X-0 entered, the

address.

card to be restarted is located.
The value is 0 or 1. 0
RESETTYPE

INTEGER

0 or 1

indicates restarting the entire

Optional. If it is not specified,

system; 1 indicates restarting

the entire system will be

a line card or the main control

restarted.

unit.

Response Format
It complies with the operation command response format in Response Message Format.

152

Version: 04

6 Integrated Testing Interface

Output Parameter
None

Example
Example 1: Restart the ONU (having no management IP address) with MAC address being
FHTT01e821a0. The ONU is connected to PON port 4 in slot 18 of the OLT whose IP
address is 10.78.191.100.
u

Command issued

RESET-ONU::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;

u

Response message
FH_10.82.25.73 2013-02-21 14:52:34

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Example 2: Restart the ONU (having a management IP address) whose IP address is
10.78.191.119.
u

Command issued

RESET-ONU::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;

u

Response message
FH_10.82.25.73 2013-02-21 14:52:34

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
None

6.3.11

Querying the IP Address / Range Allocated to a User by
Wi-Fi (LST-USERDHCPSERVER)

Function Description
This command is used for querying the IP address or range allocated to a user by Wi-Fi.
Version: 04

153

Northbound Interface TL1 User Manual

Command Format
LST-USERDHCPSERVER::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::;

Input Parameter
Parameter

ONUIP

OLTID

Data Type

OCTET STRING

OCTET STRING

Value Range

Size (128)

Size (128)

Description

Remark

IP address, name or ID of

Required for an ONU that

the ONU that has a

has a management IP

management IP address

address

IP address, name or ID of
the OLT

Required for an ONU that
has no management IP
address

PON port location
information. Locate a port
Size (128)
PONID

OCTET STRING

Rack - shelf - slot - PON
port number

through the information
rack - shelf - slot - PON
port number. If any part of
the information is

If input parameters exclude
the ONUID, the PONID is
optional.

unavailable, enter NA
instead.

ONUIDTYPE

OCTET STRING

ONU_NAME, MAC,

ONU identifier type: ONU_

LOID and ONU_

NAME, MAC, LOID,

NUMBER

ONU_NUMBER

Optional

ONU identifier, used for
uniquely identifying the
ONUID

OCTET STRING

Size (128)

ONU connected to the PON
port. The value is ONU_

Optional

NAME, MAC, LOID or
ONU_NUMBER.

Response Format
It complies with the query command response format in Response Message Format.
Title = List of user DHCP server cfg:
LANIP ENABLE DHCPSTART DHCPEND DHCPPRIDNS DHCPSECDNS DHCPGATEWAY

154

Version: 04

6 Integrated Testing Interface

Output Parameter
Parameter

LANIP

ENABLE

Data Type
OCTET
STRING

Description
The value (IP address) should be in the same

Size (128)

network segment as the DHCPSTART and
DHCPEND.

OCTET

Size (128)

Indicates whether to enable the configured IP

STRING

Enable; Disable

address.

DHCPSTAR-

OCTET

T

STRING

DHCPEND

Value Range

OCTET
STRING

DHCPPRID-

OCTET

NS

STRING

DHCPSECD-

OCTET

NS

STRING

DHCPGATE-

OCTET

WAY

STRING

Size (128)

Start IP address of DHCP, which should be
smaller than the end IP address of DHCP.

Size (128)

End IP address of DHCP

Size (128)

Active DNS server of DHCP

Size (128)

Standby DNS server of DHCP

Size (128)

DHCP default gateway

Example
Query the IP address or range allocated to a user by Wi-Fi of the ONU (having no
management IP address) with MAC being FHTT01e821a0. The ONU is connected to PON
port 4 in slot 18 of the OLT whose IP address is 10.78.191.100.
u

Command issued

LST-USERDHCPSERVER::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;

u

Response message

FH_10.82.25.73 2013-02-22 17:03:25
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of user DHCP server cfg:
---------------------------------------------------------------LANIP ENABLE DHCPSTART DHCPEND DHCPPRIDNS DHCPSECDNS DHCPGATEWAY
192.168.1.1Enable192.168.1.2 192.168.1.2530.0.0.0 0.0.0.0
192.168.1.1
---------------------------------------------------------------;
Version: 04

155

Northbound Interface TL1 User Manual

Related Command
None

6.3.12

Modifying the IP Address / Range Allocated to a User by
Wi-Fi (CFG-USERDHCPSERVER)

Function Description
This command is used for modifying the IP address or range allocated to the user by Wi-Fi.

Command Format
CFG-USERDHCPSERVER::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::
LANIP=lan_ip,ENABLE=enable_value,DHCPPOOLSTART=dhcp_start_value,
DHCPPOOLEND=dhcp_end_value,DHCPPRIDNS=pri_dns,DHCPSECDNS=sec_dns,
DHCPGATEWAY=gateway_value,DHCPMASK=mask_value;

Input Parameter
Parameter

ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Description
IP address, name or ID of the

Size (128)

ONU that has a management
IP address

Size (128)

IP address, name or ID of the
OLT

Remark
Required for an ONU that
has a management IP address
Required for an ONU that
has no management IP
address

PON port location
information. Locate a port
PONID

OCTET
STRING

Size (128)

through the information rack

If input parameters exclude

Rack - shelf - slot -

- shelf - slot - PON port

the ONUID, the PONID is

PON port number

number. If any part of the

optional.

information is unavailable,
enter NA instead.
ONUIDTYPE

156

OCTET
STRING

ONU_NAME, MAC,

ONU identifier type: ONU_

LOID and ONU_

NAME, MAC, LOID, ONU_

NUMBER

NUMBER

Optional

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

ONU identifier, used for
uniquely identifying the
ONUID

OCTET
STRING

Size (128)

ONU connected to the PON
port. The value is ONU_

Optional

NAME, MAC, LOID or
ONU_NUMBER.
The value (IP address)
LANIP

OCTET
STRING

should be in the same
Size (128)

network segment as the

Required

DHCPPOOLSTART and
DHCPPOOLEND.

ENABLE

OCTET

Size (128)

Indicates whether to enable

STRING

true / false

the configured IP address.

DHCPPOOL-

OCTET

START

STRING

DHCPPOO-

OCTET

LEND

STRING

DHCPPRIDNS
DHCPSECDNS

OCTET
STRING
OCTET
STRING

DHCPGATE-

OCTET

WAY

STRING

DHCPMASK

OCTET
STRING

Required

Start IP address of DHCP,
Size (128)

which should be smaller than

Required

the end IP address of DHCP.
Size (128)

End IP address of DHCP

Required

Size (128)

Active DNS server of DHCP

Required

Size (128)

Standby DNS server of
DHCP

Required

Size (128)

DHCP default gateway

Required

Size (128)

DHCP mask

Required

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Modify the IP address or range allocated to a user by Wi-Fi of the ONU (having no
management IP address) with MAC being FHTT01e821a0. The ONU is connected to PON
port 4 in slot 18 of the OLT whose IP address is 10.78.191.100.

Version: 04

157

Northbound Interface TL1 User Manual

u

Command issued

CFG-USERDHCPSERVER::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::LANIP=10.78.11.6,ENABLE=true,
DHCPPOOLSTART=10.78.11.3,DHCPPOOLEND=10.78.11.9,DHCPPRIDNS=6.6.6.6,
DHCPSECDNS=5.5.5.5,DHCPGATEWAY=10.78.11.1,DHCPMASK=255.255.0.0;

u

Response message
FH_10.82.25.73 2013-02-22 17:05:44

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
None

6.3.13

Querying the Web Interface Username and Password
(LST-WEBADMINISTRATOR)

Function Description
This command is used for querying the username and password of the web interface.

Command Format
LST-WEBADMINISTRATOR::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::;

Input Parameter
Parameter

ONUIP

Data Type

OCTET STRING

Value Range

Size (128)

Description

Remark

IP address, name or ID of

Required for an ONU that

the ONU that has a

has a management IP

management IP address.

address
Required for an ONU that

OLTID

OCTET STRING

Size (128)

OLT IP address, name or ID

has no management IP
address

PON port location

PONID

OCTET STRING

Size (128)

information. Locate through

If the parameter entered

Cabinet rack - shelf -

cabinet rack - shelf - slot -

does not include the

slot - PON port

PON port number. Enter NA

ONUID, the PONID is

number

if the corresponding

optional.

information is not specified.
158

Version: 04

6 Integrated Testing Interface

Parameter

ONUIDTYPE

Data Type

OCTET STRING

Value Range

Description

ONU_NAME,

ONU identifier type (ONU_

MAC, LOID, ONU_

NAME, MAC, LOID,

NUMBER

ONU_NUMBER).

Remark

Optional

ONU identifier, used for
uniquely identifying the
ONUID

OCTET STRING

Size (128)

ONU connected to the PON
port. The value is ONU_

Optional

NAME, MAC, LOID or
ONU_NUMBER.

Response Format
It complies with the query-command response format in Response Message Format.
Title = List of web administrator cfg:
WEBUSERNAME WEBPASSWORD GROUP

Output Parameter
Parameter

Data Type

Value Range

Description

WEBUSERNAME

OCTET STRING

Size (128)

Web username

WEBPASSWORD

OCTET STRING

Size (128)

Web password

GROUP

OCTET STRING

Size (128)

Admin indicates the

Admin

administrator.

Example
For example, query the Web interface username and password of the ONU (having no
management IP address) with MAC being FHTT01e821a0.The ONU is connected to PON
port 4 in slot 18 of the OLT whose IP address is 10.78.191.100.
u

Command issued

LST-WEBADMINISTRATOR::OLTID=10.78.191.100,PONID=NA-NA-18-4,
ONUIDTYPE=MAC,ONUID=FHTT01e821a0:CTAG::;

u

Response message
FH_10.82.25.73 2013-02-22 17:07:31

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

Version: 04

159

Northbound Interface TL1 User Manual

List of web administrator cfg:
------------------------------------------WEBUSERNAME

WEBUSERNAME

admin

Admin

admin

GROUP

------------------------------------------;

Related Command
None

6.3.14

Modifying the Web Interface Username and Password
(CFG-WEBADMINISTRATOR)

Function Description
This command is used for modifying the username and password of the web interface.

Command Format
CFG-WEBADMINISTRATOR::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::
[WEBUSERNAME=user_name][,WEBPASSWORD=web_password];

Input Parameter
Parameter

ONUIP

OLTID

Data Type

OCTET STRING

OCTET STRING

Value Range

Size (128)

Size (128)

Description

Remark

IP address, name or ID of

Required for an ONU that

the ONU that has a

has a management IP

management IP address

address

IP address, name or ID of
the OLT

Required for an ONU that
has no management IP
address

PON port location
information. Locate a port
Size (128)
PONID

OCTET STRING

Rack - shelf - slot - PON
port number

through the information
rack - shelf - slot - PON
port number. If any part of
the information is

If input parameters exclude
the ONUID, the PONID is
optional.

unavailable, enter NA
instead.
160

Version: 04

6 Integrated Testing Interface

Parameter

ONUIDTYPE

Data Type

OCTET STRING

Value Range

Description

ONU_NAME, MAC,

ONU identifier type: ONU_

LOID and ONU_

NAME, MAC, LOID,

NUMBER

ONU_NUMBER

Remark

Optional

ONU identifier, used for
uniquely identifying the
ONUID

OCTET STRING

Size (128)

ONU connected to the PON
port. The value is ONU_

Optional

NAME, MAC, LOID or
ONU_NUMBER.
WEBUSERNAME

WEBPASSWORD

Web username, containing
OCTET STRING

Size (128)

the alphanumeric characters
and the symbols ., /, - or _.
Web password, containing

OCTET STRING

Size (128)

the alphanumeric characters
and the symbols ., /, - or _.

(Optional) Default value:
admin

(Optional) Default value:
admin

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Modify the Web interface username and password of the ONU (having no management IP
address) with MAC being FHTT01e821a0. The ONU is connected to PON port 4 in slot 18
of the OLT whose IP address is 10.78.191.100.
u

Command issued

CFG-WEBADMINISTRATOR::OLTID=10.78.191.100,PONID=NA-NA-18-4,
ONUIDTYPE=ONU_NUMBER,ONUID=1:CTAG::WEBUSERNAME=user_name,
WEBPASSWORD=web_password;

u

Response message

FH_10.82.25.73 2013-02-22 17:07:42
M

CTAG COMPLD
EN=0

ENDESC=No error

;

Version: 04

161

Northbound Interface TL1 User Manual

Related Command
None

6.3.15

Restoring an ONU to Factory Default Settings (RESTOREDEFAULTCFG)

Function Description
This command is used for restoring an ONU to factory default settings.

Command Format
RESTORE-DEFAULTCFG::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::;

Supported Device
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5506-04-F1.

Input Parameter
Parameter

ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Description
IP address, name or ID of the

Size (128)

ONU that has a management
IP address

Size (128)

Remark
Required for an ONU that has a
management IP address

IP address, name or ID of the

Required for an ONU that has

OLT

no management IP address

PON port location information.

PONID

OCTET
STRING

Size (128)
Rack - shelf - slot PON port number

Locate a port through the
information rack - shelf - slot
- PON port number. If any
part of the information is

If input parameters exclude the
ONUID, the PONID is
optional.

unavailable, enter NA instead.

162

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

ONUID-

OCTET

TYPE

STRING

Value Range

Description

ONU_NAME, MAC,

ONU identifier type: ONU_

LOID and ONU_

NAME, MAC, LOID, ONU_

NUMBER

NUMBER

Remark
Optional

ONU identifier, used for
uniquely identifying the ONU
ONUID

OCTET

Size (128)

STRING

connected to the PON port.
The value is ONU_NAME,

Optional

MAC, LOID or ONU_
NUMBER.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
None

Example
Example 1: Restore the ONU (having no management IP address) with MAC address being
FHTT01e821a0 to factory default settings. The ONU is connected to PON port 4 in slot 18
of the OLT whose IP address is 10.78.191.100.
u

Command issued

RESTORE-DEFAULTCFG::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;

u

Response message
FH_10.82.25.73 2013-02-22 17:16:32

M

CTAG COMPLD
EN=0

ENDESC=No error

;

Related Command
None

6.4

Querying the LAN Information
The following introduces the command and example for querying the LAN information.

Version: 04

163

Northbound Interface TL1 User Manual

6.4.1

Querying the LAN Port Information (LST-ONULANINFO)

Function Description
This command is used for querying the LAN port status and configuration of an ONU.

Command Format
LST-ONULANINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=lanport_index:CTAG::;

Input Parameter
Parameter

ONUIP

Data Type
OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of
Size (128)

the ONU that has a

-

management IP address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address, name or ID of

ONU that has no

the OLT

management IP
address

PON port location
Size (128)
PONID

OCTET

Rack - shelf - slot

STRING

- PON port
number

information. Locate a
port through rack - shelf slot - PON port number.
Enter NA for the
corresponding
unspecified information.

ONU_NAME
ONUID-

OCTET

MAC

TYPE

STRING

LOID
ONU_NUMBER

164

If input
parameters
exclude the
ONUID, the
PONID is
optional.

ONU identifier type:
ONU_NAME, MAC,

Optional

LOID, ONU_NUMBER

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

ONU identifier, used for
uniquely identifying the
ONUID

OCTET
STRING

ONU connected to the
Size (128)

PON port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card through

ONUPORT

OCTET
STRING

Size (128)

rack - shelf - slot - port

Rack - shelf - slot

number. Enter NA for the

- port number

corresponding

Optional

unspecified information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of lan port info
AdminStatus OperStatus DUPLEX PVID VLANPRIORITY SPEED

Output Parameter
Parameter

Data Type

AdminStatus

OCTET STRING

OperStatus

-

Value Range
UP
DOWN
UP
DOWN

Description
Management status
Operating status

Full
Half
DUPLEX

OCTET STRING

Auto

Working mode

Auto-Full
Auto-Half
PVID

Version: 04

OCTET STRING

Integer (1-4094)

VLAN ID. The default VLAN ID is
adopted.

165

Northbound Interface TL1 User Manual

Parameter
VLANPRIORITY

Data Type

Value Range

OCTET STRING

Integer (0-7)

Description
VLAN priority. The default priority is
adopted.

Auto-negotiation
10M
100M
SPEED

INTEGER

Port rate

1000M
Auto-10M
Auto-100M
Auto-1000M

Example
Example 1: Query the information of LAN port 1 of the ONU (having no management IP
address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1
in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-ONULANINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-01 10:37:58
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of lan port info
----------------------------------------------------------AdminStatus
UP

OperStatus

DOWN

--

4088

DUPLEX

PVID

0

--

VLANPRIORITY

SPEED

-----------------------------------------------------------

Example 2: Query the information of LAN port 1 in slot 4 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-ONULANINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message

F FH_10.250.18.133 2010-11-02 10:33:09
M

CTAG COMPLD
total_blocks=1
block_number=1

166

Version: 04

6 Integrated Testing Interface

block_records=1
list of lan port info
----------------------------------------------------------AdminStatus

OperStatus

UP

Auto-Half

DOWN

DUPLEX

4088

0

PVID VLANPRIORITY

SPEED

Auto-10M

-----------------------------------------------------------

Related Command
None

6.4.2

Querying the LAN Port Rate Control (LST-LANCAR)

Function Description
This command is used for querying the uplink and downlink rate control of an ONU LAN
port.

Command Format
LST-LANCAR::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=lanport_index:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name or
ONUIP

OCTET
STRING

Size (128)

ID of the ONU that
has a management IP

-

address
Required for an ONU
OLTID

OCTET
STRING

Size (128)

IP address, name or

that has no

ID of the OLT

management IP
address

Version: 04

167

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

PON port location
information. Locate a
Size (128)
PONID

OCTET

Rack - shelf - slot

STRING

- PON port
number

port through rack shelf - slot - PON
port number. Enter
NA for the
corresponding

If input parameters
exclude the ONUID,
the PONID is
optional.

unspecified
information.
ONU_NAME

ONU identifier type:

ONUID-

OCTET

MAC

ONU_NAME, MAC,

TYPE

STRING

LOID

LOID, ONU_

ONU_NUMBER

NUMBER

Optional

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET
STRING

Size (128)

connected to the PON
port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card through
rack - shelf - slot ONUPORT

OCTET
STRING

Size (128)

port number. Enter

Rack - shelf - slot

NA for the

- port number

corresponding

Optional

unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of LAN port rate-limit info
RateLimitUs RateLimitDs

Output Parameter

168

Parameter

Data Type

Value Range

Description

RateLimitUs

INTEGER

0 to 1000000

Uplink rate limit (unit: kbps)

RateLimitDs

INTEGER

0 to 1000000

Downlink rate limit (unit: kbps)

Version: 04

6 Integrated Testing Interface

Example
Example 1: Query the rate control information of LAN port 1 of the ONU (having no
management IP address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected
to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-LANCAR::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-01 10:40:21
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of LAN port rate-limit info
----------------------------------------------RateLimitUs
1024

RateLimitDs

2048

-----------------------------------------------

Example 2: Query the rate control information of LAN port 1 in slot 4 of the ONU (having
a management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-LANCAR::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 10:33:28
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of LAN port rate-limit info
---------------------------------------RateLimitUs
64

RateLimitDs

1024

----------------------------------------

Related Command
None

Version: 04

169

Northbound Interface TL1 User Manual

6.4.3

Querying the ETH Performance (LST-LANPERF)

Function Description
This command is used for querying the ETH performance information of an OLT uplink
port or ONU LAN port.

Command Format
LST-LANPERF::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],PORTID=lanport_index:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Parameters

Remark

IP address, name or
ONUIP

OCTET STRING

Size (128)

ID of the ONU that
has a management IP

-

address
OLTID

OCTET STRING

Size (128)

IP address, name or
ID of the OLT

-

PON port location
information. Locate a
Size (128)
PONID

OCTET STRING

Rack - shelf - slot
- PON port
number

port through rack shelf - slot - PON
port number. Enter
NA for the
corresponding

If input parameters
exclude the ONUID,
the PONID is
optional.

unspecified
information.

ONUIDTYPE

170

OCTET STRING

ONU_NAME

ONU identifier type:

MAC

ONU_NAME, MAC,

LOID

LOID, ONU_

ONU_NUMBER

NUMBER

Optional

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Parameters

Remark

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET STRING

connected to the

Size (128)

PON port. The value

Optional

is ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack - shelf PORTID

OCTET STRING

Size (128)

slot - port number.

Rack - shelf - slot

Enter NA for the

- port number

corresponding

OLT uplink port or
ONU LAN port

unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = List of Ethenet performance
OutPkts InPkts OutOctets InOctets CRC UnderSizePkts OverSizePkts InErrors
OutErrors InDiscards OutDiscards InUnicastPkts InMulticastPkts
InBroadcastPkts OutUnicastPkts OutMulticastPkts OutBroadcastPkts
StateChangeCounters

Output Parameter

Version: 04

Parameter

Data Type

Value Range

Parameters

OutPkts

DOUBLE

0-1.85E19

Number of sent packets

InPkts

DOUBLE

0-1.85E19

Number of received packets

OutOctets

DOUBLE

0-1.85E19

Number of sent bytes

InOctets

DOUBLE

0-1.85E19

Number of received bytes

CRC

DOUBLE

0-1.85E19

UnderSizePkts

DOUBLE

0-1.85E19

OverSizePkts

DOUBLE

0-1.85E19

Number of received CRC
error packets
Number of received
undersized packets
Number of received
oversized packets

171

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

InErrors

DOUBLE

0-1.85E19

OutErrors

DOUBLE

0-1.85E19

InDiscards

DOUBLE

0-1.85E19

OutDiscards

DOUBLE

0-1.85E19

InUnicastPkts

DOUBLE

0-1.85E19

InMulticastPkts

DOUBLE

0-1.85E19

InBroadcastPkts

DOUBLE

0-1.85E19

OutUnicastPkts

DOUBLE

0-1.85E19

OutMulticastPkts

DOUBLE

0-1.85E19

OutBroadcastPkts

DOUBLE

0-1.85E19

StateChangeCounters

INTEGER

0-4294967295

Parameters
Number of received error
packets
Number of unsent error
packets
Number of discarded
received packets
Number of discarded sent
packets
Number of received unicast
packets
Number of received
multicast packets
Number of received
broadcast packets
Number of sent unicast
packets
Number of sent multicast
packets
Number of sent broadcast
packets
Number of port status
changes

Example
Example 1: Query the performance information of uplink port 1 in slot 29 of the OLT
whose IP address is 10.250.18.102.
u

Command issued

LST-LANPERF::OLTID=10.250.18.102,PORTID=NA-NA-29-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-27 11:01:43
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of Ethenet performance
----------------------------------------------------------OutPkts InPkts
172

OutOctets InOctets CRC UnderSizePkts
Version: 04

6 Integrated Testing Interface

OverSizePkts InErrors OutErrors InDiscards
OutDiscards

InUnicastPkts

OutUnicastPkts

InMulticastPkts InBroadcastPkts

OutMulticastPkts

OutBroadcastPkts

StateChangeCounters
0

0

0

0

0

0

0

0

0

0

0

0

--

0

0

0

0

0

-----------------------------------------------------------

Example 2: Query the performance information of port 1 in slot 4 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-LANPERF::ONUIP=10.250.18.121,PORTID=NA-NA-4-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:44:54
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

List of Ethenet performance
----------------------------------------------------------OutPkts InPkts
OverSizePkts

OutOctets

InErrors

InOctets
OutErrors

OutDiscards InUnicastPkts
OutUnicastPkts

CRC

UnderSizePkts

InDiscards

InMulticastPkts InBroadcastPkts

OutMulticastPkts

OutBroadcastPkts

StateChangeCounters
0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

-----------------------------------------------------------

Related Command
None

6.4.4

Conducting the Broadband Dial-up Emulation Test
(TEST-PPPOESIMULATION)

Function Description
The broadband dial-up emulation test is conducted on a LAN port or DSL port of the MDU,
SFU or HGU (bridge) to simulates a user initiating the PPPoE dial-up so as to verify
whether the user dial-up service connection can be normally established.
Version: 04

173

Northbound Interface TL1 User Manual

Command Format
TEST-PPPOESIMULATION::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=post_index:CTAG::ACTION=action-type,USERNAME=username,
PASSWORD=password[,VPI=vpi,VCI=vci][,UV=user vlan][,AUTHMODE=authmode]
[timeout=timeout];

Input Parameter
Parameter

Data Type

Value Range

OCTET STRING

Size (128)

Description

Remark

IP address, name or ID of the
ONUIP

ONU that has a management IP

-

address
OLTID

OCTET STRING

Size (128)

IP address, name or ID of the OLT

-

PON port location information.
PONID

OCTET STRING

Size (128)

Locate a port through rack - shelf -

If input parameters

Rack - shelf - slot -

slot - PON port number. Enter NA

exclude the ONUID,

PON port number

for the corresponding unspecified

the PONID is optional.

information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOI
ONU_NUMBER

ONU identifier type: ONU_
NAME, MAC, LOID, ONU_
NUMBER
ONU identifier, used for uniquely
identifying the ONU connected to

ONUID

OCTET STRING

Size (128)

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_
NUMBER.

Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot port number

Optional

Required for an ONU
that has no
management IP
address

Locate a card through rack - shelf
- slot - port number. Enter NA for
the corresponding unspecified

-

information.

Start: Starts the
test.
ACTION

OCTET STRING

Stop: Ends the test.

Test Type

-

Query: Queries the
test.
USERNAME

OCTET STRING

Size (1 to 64)

PASSWORD

OCTET STRING

Size (1 to 16)

174

Username of the broadband dialup account
Password of the broadband dial-up
account

-

-

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

VPI corresponding to the
VPI

INTEGER

0 to 255

broadband access service of the

Optional

DSL port
VCI corresponding to the
VCI

INTEGER

0 to 65535

broadband access service of the

Optional

DSL port
Optional. By default, it
UV

INTEGER

1 to 4094

User-side VLAN

is not specified
(simulating the
UNTAG application).

AUTO
AUTHMODE

OCTET STRING

CHAP

Dial-up authentication mode

PAP
TIMEOUT

INTEGER

0 to 300

Testing time duration. Unit: s.

Optional. Default
value: AUTO
Optional

Response Format
The format of the response for starting the test is the same as the operation command
response format in Response Message Format. The format of the response for querying and
ending the test is the same as the query command response format in Response Message
Format.
Title = result of pppoe simulation
State Conclusion FailReason

Output Parameter
Parameter

Data Type

Value Range

Description

This parameter is

In Progress: The test is
State

OCTET STRING

ongoing.
Testend: The test is

Current status

FailReason

INTEGER

returned when the input
parameter "Action" is
"Stop" or "Query".

ended.

Conclusion

Remark

Indicates the test

These two parameters are

succeeds.

returned when the input

2 Failed

Indicates the test fails.

parameter "Action" is

1 PADITimeout

PADI request timeout.

"Stop" or "Query". If

2 PADRTimeout

PADR request timeout.

1 Success

INTEGER
3 LCPNegotiationFail

PPP establishing link
failed.

testing status is "In
Progress", the testing
result returns –; if the test
result is successful, the
failure reason returns –.

Version: 04

175

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range
4
WrongUsernameOrPassword
5 CanNotGetIPAddress

Description

Remark

Username or password
error.
Unable to obtain the IP
address.

10 TestTimeout

Testing timeout.

12: Other

Other causes.

Example
Conduct an outgoing call emulation test on POTS port 1 of the ONU (has no management
IP address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port
1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

TEST-PPPOESIMULATION::OLTID=10.171.0.16,PONID=NA-NA-1-1,ONUIDTYPE=MAC,
ONUID=FHTT03317368,ONUPORT=NA-NA-NA-1:CTAG::ACTION=Start,USERNAME=t,
PASSWORD=y;(Start testing)
TEST-PPPOESIMULATION::OLTID=10.171.0.16,PONID=NA-NA-1-1,ONUIDTYPE=MAC,
ONUID=FHTT03317368,ONUPORT=NA-NA-NA-1:CTAG::ACTION=Query,USERNAME=t,
PASSWORD=y;(query status)

u

Response message

FH_10.170.4.2372015-12-2509:52:06
M

CTAG COMPLD
EN=0

ENDESC=No error

;
FH_10.98.100.16 2014-06-12 17:07:20
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of PPPoESimulation
--------------------------------------------------State

Conclusion FailReason

Test
-end

--

---------------------------------------------------;

176

Version: 04

6 Integrated Testing Interface

Related Command
None

6.5

Querying the DSL Information
The following introduces the command and example for querying the DSL information.

6.5.1

Querying the ADSL2+ Port Information (LST-ADSLINFO)

Function Description
This command is used for querying the status and configuration information of the ADSL
port.

Command Format
LST-ADSLINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter
Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Size (128)

has a management IP address.

-

OLT IP address, name or ID.

management IP
address. Required.

OCTET

Cabinet rack - shelf

STRING

- slot - PON port
number

Version: 04

IP address, name or ID of the ONU that

Remark

The ONU that has no
Size (128)

Size (128)
PONID

Description

PON port information location. Locate
through the approach of cabinet rack -

The ONU that has no

shelf - slot - PON port number. Enter NA

management IP

if the corresponding information is not

address. Required.

specified.

177

Northbound Interface TL1 User Manual

Parameter
Name

Data Type

Value Range

Description

Remark

ONU_NAME
ONUIDTYPE

OCTET

MAC

ONU identifier type (ONU_NAME,

STRING

LOID

MAC, LOID, ONU_NUMBER).

ONU_NUMBER
ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

ONUPORT

Size (128)

OCTET
STRING

Cabinet rack - shelf
- slot - port number

The ONU that has no
management IP
address. Required.

The ONU that has no
management IP
address. Required.

Locates the card through the approach of
cabinet rack - shelf - slot - port number.
Enter NA if the corresponding

-

information is not specified.

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of adsl port info
OPERSTATUS ADMINSTATUS TM LineType AturRateMode AtucRateMode TGTSNRMGNDS
MAXSNRMGNDS MINSNRMGNDS TGTSNRMGNUS MAXSNRMGNUS MINSNRMGNUS FASTMINRATEDS
FASTMAXRATEDS FASTMINRATEUS FASTMAXRATEUS INTVMINRATEDS INTVMAXRATEDS
INTVMINRATEUS INTVMAXRATEUS INTVDELAYDS INTVDELAYUS

Output Parameter
Parameter Name

Data Type

OPERSTATUS

String

ADMINSTATUS

String

TM
LineType

OCTET
STRING

Value Range
UP
DOWN
UP
DOWN
See the The List of Parameters.

OCTET

Fast

STRING

Interleaved

Description
Running status

Administration status
Actual transfer mode.
Line type.

Fixed: Indicates fixed rate.
AutoAdaptAtStartup: Indicates
AturRateMode

OCTET

automatically adapting on startup.

STRING

AutoAdaptAtRunning: Indicates

Atur rate adaptation mode.

automatically adapting during
running.

178

Version: 04

6 Integrated Testing Interface

Parameter Name

Data Type

Value Range

Description

Fixed: Indicates fixed rate.
AutoAdaptAtStartup: Indicates
AtucRateMode

OCTET

automatically adapting on startup.

STRING

AutoAdaptAtRunning: Indicates

Atuc rate adaptation mode.

automatically adapting during
running.
TGTSNRMGNDS

INTEGER

0 - 310

MAXSNRMGNDS

INTEGER

0 - 310

MINSNRMGNDS

INTEGER

0 - 310

TGTSNRMGNUS

INTEGER

0 - 310

MAXSNRMGNUS

INTEGER

0 - 310

MINSNRMGNUS

INTEGER

0 - 310

FASTMINRATEDS

INTEGER

32 - 32000

FASTMAXRATEDS

INTEGER

32 - 32000

FASTMINRATEUS

INTEGER

32 - 32000

FASTMAXRATEUS

INTEGER

32 - 32000

Downlink target noise tolerance
Unit: 0.1dB.
Maximum downlink noise tolerance
Unit: 0.1dB.
Minimum downlink noise tolerance
Unit: 0.1dB.
Uplink target noise tolerance
Unit: 0.1dB.
Maximum uplink noise tolerance
Unit: 0.1dB.
Minimum uplink noise tolerance
Unit: 0.1dB.
Minimum rate of the fast downlink channel.
Unit: kbit/s.
Maximum rate of the fast downlink channel.
Unit: kbit/s.
Minimum rate of the fast uplink channel.
Unit: kbit/s.
Maximum rate of the fast uplink channel.
Unit: kbit/s.
Minimum rate of the interleaved downlink

INTVMINRATEDS

INTEGER

32 - 32000

channel.
Unit: kbit/s.
Maximum rate of the interleaved downlink

INTVMAXRATEDS

INTEGER

32 - 32000

channel.
Unit: kbit/s.
Minimum rate of the interleaved uplink

INTVMINRATEUS

INTEGER

32 - 32000

channel.
Unit: kbit/s.
Maximum rate of the interleaved uplink

INTVMAXRATEUS

INTEGER

32 - 32000

channel.
Unit: kbit/s.

Version: 04

179

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

INTVDELAYDS

INTEGER

0 - 255

INTVDELAYUS

INTEGER

0 - 255

Description
Interleaved downlink delay.
Unit: ms
Interleaved uplink delay.
Unit: ms

Example
For example, query the information of the No. 1 ADSL port located in the No. 3 slot of the
ONU whose IP address is 10.250.18.121.
u

Command

LST-ADSLINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-02 13:54:42
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of adsl port info
----------------------------------------------------------OPERSTATUS ADMINSTATUS

TM LineType AturRateMode

AtucRateMode TGTSNRMGNDS

MAXSNRMGNDS MINSNRMGNDS

TGTSNRMGNUS

MINSNRMGNUS

MAXSNRMGNUS

FASTMINRATEDS

FASTMAXRATEDS

FASTMINRATEUS

FASTMAXRATEUS

INTVMINRATEDS

INTVMAXRATEDS

INTVMINRATEUS

INTVMAXRATEUS

INTVDELAYDS

INTVDELAYUS
DOWN DOWN 3 Interleaved AutoAdaptAtStartup
AutoAdaptAtStartup

6.00

100000

100000

0 100000 0

31

0
0

6.00 31

100000

0

0

16 16

----------------------------------------------------------

Related Command
None

180

Version: 04

6 Integrated Testing Interface

6.5.2

Querying the ADSL2+ Port Performance (LSTADSLPERF)

Function Description
This command is used for querying the ADSL link traffic and line real-time information.
Before using the command, ensure the ONU is online and the ADSL port is enabled.

Command Format
LST-ADSLPERF::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter Name

ONUIP

OLTID

Data Type
OCTET
STRING

OCTET
STRING

Value Range

Description

Remark

IP address, name or ID of the
Size (128)

ONU that has a management IP

-

address.
The ONU that has no
Size (128)

OLT IP address, name or ID.

management IP address.
Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON

STRING

slot - PON port

port number. Enter NA if the

number

corresponding information is not

The ONU that has no
management IP address.
Required.

specified.
ONU_NAME
ONUIDTYPE

OCTET

MAC

STRING

LOID
ONU_NUMBER

Version: 04

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP address.

NUMBER).

Required.

181

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

Description

Remark

ONU identifier, used for
ONUID

OCTET
STRING

Size (128)

uniquely identifying the ONU

The ONU that has no

connected to the PON port. The

management IP address.

value is ONU_NAME, MAC,

Required.

LOID or ONU_NUMBER.
Locates the card through the
ONUPORT

OCTET
STRING

Size (128)

approach of cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if

slot - port number

the corresponding information is

-

not specified.

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of adsl port performance
InOctets OutOctets SnrMgnDs SnrMgnUs AtnDs AtnUs OutputPwrDs OutputPwrUs
ChanTxRateDs ChanTxRateUs AttainableRateDs AttainableRateUs

Output Parameter
Parameter Name

Data Type

Value Range

Description

InOctets

INTEGER

0 - 2147483647

Number of received bytes

OutOctets

INTEGER

0 - 2147483647

Number of sent bytes

SnrMgnDs

INTEGER

-640 - 640

SnrMgnUs

INTEGER

-640 - 640

AtnDs

INTEGER

0 - 630

AtnUs

INTEGER

0 - 630

OutputPwrDs

FLOAT

-310 - 310

OutputPwrUs

FLOAT

-310 - 310

ChanTxRateDs

INTEGER

32 - 32000

ChanTxRateUs

INTEGER

32 - 32000

182

Downlink noise tolerance
Unit: 0.1dB.
Uplink noise tolerance
Unit: 0.1dB.
Downlink power attenuation
Unit: 0.1dB.
Uplink power attenuation
Unit: 0.1dB.
Downlink output power
Unit: 0.1dBm.
Uplink output power
Unit: 0.1dBm.
Sent Rate of the downlink channel.
Unit: kbit/s.
Sent Rate of the uplink channel.
Unit: kbit/s.

Version: 04

6 Integrated Testing Interface

Parameter Name

Data Type

Value Range

AttainableRateDs

INTEGER

32 - 32000

AttainableRateUs

INTEGER

32 - 32000

Description
Maximum attainable downlink rate.
Unit: kbit/s.
Maximum attainable uplink rate.
Unit: kbit/s.

Example
For example, query the information of the No. 1 ADSL port located in the No. 3 slot of the
ONU whose IP address is 10.250.18.121.
u

Command

LST-ADSLPERF::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-02 13:54:51
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of adsl port performance
----------------------------------------------------------InOctets

OutOctets

SnrMgnDs

SnrMgnUs

AtnUs OutputPwrDs

OutputPwrUs

AttainableRateDs

AttainableRateUs

0

0

1736

0

0

0

0

0

0

AtnDs

ChanTxRateDs
0

ChanTxRateUs

0 0

-----------------------------------------------------------

Related Command
None

6.5.3

Querying the ADSL2+ Port Statistics Information (LSTADSLSTAT)

Function Description
This command is used for querying the ADSL link quality information, including the
initialization information, statistics information and channel statistics information over the
current 15 minutes, the current day as well as the past day. Before using the command,
ensure the ONU is online and the performance statistics switch is on.
Version: 04

183

Northbound Interface TL1 User Manual

Command Format
LST-ADSLSTAT:: NUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter
Name

Data Type

Value Range

OCTET STRING

Size (128)

Description

Remark

IP address, name or ID of the
ONUIP

ONU that has a management IP

-

address.
The ONU that has no
OLTID

OCTET STRING

Size (128)

OLT IP address, name or ID.

management IP
address. Required.

PON port information location.

PONID

OCTET STRING

Size (128)

Locate through the approach of

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON

slot - PON port

port number. Enter NA if the

number

corresponding information is not

The ONU that has no
management IP
address. Required.

specified.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP

NUMBER).

address. Required.

ONU identifier, used for uniquely
ONUID

OCTET STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.
Locates the card through the
ONUPORT

OCTET STRING

Size (128)

approach of cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if the

slot - port number

corresponding information is not

-

specified.

184

Version: 04

6 Integrated Testing Interface

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of adsl statistics
AtucPerfCurr15MinTimeElapsed Curr15MinInits Curr15MinAtucEss
Curr15MinAtucLoss Curr15MinAtucSes AtucPerfCurr1DayTimeElapsed
Curr1DayInits Curr1DayAtucEss Curr1DayAtucLoss Curr1DayAtucSes
AtucPerfPrev1DayTimeElapsed Prev1DayInits Prev1DayAtucEss
Prev1DayAtucLoss Prev1DayAtucSes

Output Parameter
Parameter Name

Data Type

Value Range

Description

AtucPerfCurr15MinTimeElapsed

INTEGER

0 - 900

Elapsed time of the current 15 minutes.

Curr15MinInits

INTEGER

0 - 2147483647

Initialization times over the current 15 minutes.

Curr15MinAtucEss

INTEGER

0 - 900

Curr15MinAtucLoss

INTEGER

0 - 900

Curr15MinAtucSes

INTEGER

0 - 900

AtucPerfCurr1DayTimeElapsed

INTEGER

0 - 86400

Elapsed time of the current day.

Curr1Day Inits

INTEGER

0 - 2147483647

Initialization times over the current day.

Curr1Day AtucEss

INTEGER

0 - 86400

ATUC side errored seconds over the current day.

Curr1Day AtucLoss

INTEGER

0 - 86400

Curr1Day AtucSes

INTEGER

0 - 86400

AtucPerfPrev1DayTimeElapsed

INTEGER

0 - 86400

Elapsed time of the past day

Prev1Day Inits

INTEGER

0 - 2147483647

Initialization times over the past day.

Prev1Day AtucEss

INTEGER

0 - 86400

ATUC side errored seconds over the past day.

Prev1Day AtucLoss

INTEGER

0 - 86400

ATUC side signal-loss seconds over the past day.

Prev1Day AtucSes

INTEGER

0 - 86400

ATUC side errored seconds over the current 15
minutes.
ATUC side signal-loss seconds over the current
15 minutes.
ATUC side severely errored seconds over the
current 15 minutes.

ATUC side signal-loss seconds over the current
day.
ATUC side severely errored seconds over the
current day.

ATUC side severely errored seconds over the past
day.

Example
For example, query the performance statistics information over the current 15 minutes, the
current day and the past day of the No. 1 ADSL port located in the No. 3 slot of the ONU
whose IP address is 10.250.18.121.
Version: 04

185

Northbound Interface TL1 User Manual

u

Command

LST-ADSLSTAT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-02 13:55:02
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of adsl statistics
--------------------------------------------------------AtucPerfCurr15MinTimeElapsed
Curr15MinAtucLoss

Curr15MinInits

Curr15MinAtucEss

Curr15MinAtucSes

AtucPerfCurr1DayTimeElapsed
Curr1DayAtucLoss

Curr1DayInits

Curr1DayAtucEss

Curr1DayAtucSes AtucPerfPrev1DayTimeElapsed

Prev1DayInits

Prev1DayAtucEss Prev1DayAtucLoss

444

0

0

0

4.29497e+09

0

0
0

0

10746

--

0

0

Prev1DayAtucSes

4.29497e+09
0

---------------------------------------------------------

Related Command
None

6.5.4

Querying the VDSL2 Port Information (LST-VDSLINFO)

Function Description
This command is used for querying the status and configuration information of the VDSL2
port.

Command Format
LST-VDSLINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;

186

Version: 04

6 Integrated Testing Interface

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name or
ONUIP

OCTET
STRING

Size (128)

ID of the ONU that
has a management IP

-

address
Required for an ONU
OLTID

OCTET
STRING

Size (128)

IP address, name or

that has no

ID of the OLT

management IP
address

PON port location
information. Locate a
port through rack PONID

OCTET
STRING

Size (128)

shelf - slot - PON

Rack - shelf - slot -

port number. Enter

PON port number

NA for the
corresponding

If input parameters
exclude the ONUID,
the PONID is
optional.

unspecified
information.

ONUIDTYPE

ONU_NAME

ONU identifier type:

OCTET

MAC

ONU_NAME, MAC,

STRING

LOID

LOID, ONU_

ONU_NUMBER

NUMBER

Optional

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET
STRING

Size (128)

connected to the PON
port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card through
rack - shelf - slot ONUPORT

OCTET
STRING

Size (128)

port number. Enter

Rack - shelf - slot -

NA for the

port number

corresponding

Optional

unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Version: 04

187

Northbound Interface TL1 User Manual

Title = list of vdsl port info
ADMINSTATUS OPERSTATUS INPDS INPUS RateModeDs RateModeUs ChannelTMode
MAXRATEUS MINRATEUS MAXRATEDS MINRATEDS INTVDELAYUS INTVDELAYDS TGTSNRMGNDS
MAXSNRMGNDS MINSNRMGNDS TGTSNRMGNUS MAXSNRMGNUS MINSNRMGNUS

Output Parameter
Parameter

Data Type

ADMINSTATUS

OCTET STRING

OPERSTATUS

String

INPDS

OCTET STRING

0-16, 0.5

INPUS

OCTET STRING

0-16, 0.5

Value Range
UP
DOWN
UP
DOWN

Description
Management status
Operating status
Downlink pulse noise
protection; unit: symbol
Uplink pulse noise
protection; unit: symbol

Fixed: Indicates fixed
rate.
AutoAdaptAtStartup:
Indicates automatic
RateModeDs

OCTET STRING

adaptation upon startup.
AutoAdaptAtRunning:

Downlink rate adaptation
mode

Indicates automatic
adaptation during
operation.
Fixed: Indicates fixed
rate.
AutoAdaptAtStartup:
Indicates automatic
RateModeUs

OCTET STRING

adaptation upon startup.
AutoAdaptAtRunning:

Uplink rate adaptation
mode

Indicates automatic
adaptation during
operation.
ATM
ChannelTMode

OCTET STRING

PTM
BOTH

188

MAXRATEUS

INTEGER

-

MINRATEUS

INTEGER

-

Data channel mode of
channel 1
Maximum uplink rate of
channel 1 (unit: kbps)
Minimum uplink rate of
channel 1 (unit: kbps)

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

MAXRATEDS

INTEGER

-

MINRATEDS

INTEGER

-

Description
Maximum downlink rate
of channel 1 (unit: kbps)
Maximum downlink rate
of channel 1 (unit: kbps)
Maximum uplink

INTVDELAYUS

INTEGER

0 to 63

interleaved delay (unit:
ms)
Maximum downlink

INTVDELAYDS

INTEGER

0 to 63

interleaved delay (unit:
ms)

TGTSNRMGNDS

INTEGER

0 to 310

Downlink target noise
tolerance (unit: 0.1dB)
Maximum downlink

MAXSNRMGNDS

INTEGER

0 to 310

noise tolerance (unit: 0.
1dB)
Minimum downlink

MINSNRMGNDS

INTEGER

0 to 310

noise tolerance (unit: 0.
1dB)

TGTSNRMGNUS

INTEGER

0 to 310

MAXSNRMGNUS

INTEGER

0 to 310

MINSNRMGNUS

INTEGER

0 to 310

Uplink target noise
tolerance (unit: 0.1dB)
Maximum uplink noise
tolerance (unit: 0.1dB)
Minimum uplink noise
tolerance (unit: 0.1dB)

Example
Query the information of VDSL port 1 in slot 1 of the ONU whose IP address is
10.250.18.121.
u

Command issued

LST-VDSLINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 13:55:14
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of vdsl port info
Version: 04

189

Northbound Interface TL1 User Manual

----------------------------------------------------------ADMINSTATUS

OPERSTATUS

RateModeUs

ChannelTMode MAXRATEUS

MINRATEUS

MAXRATEDS

MINRATEDS

INTVDELAYUS

INTVDELAYDS

TGTSNRMGNDS

MAXSNRMGNDS

MINSNRMGNDS TGTSNRMGNUS

MAXSNRMGNUS

MINSNRMGNUS

DOWN

0.00

DOWN

0.00

INPDS

PTM

16

0.006.00

31.00

RateModeDs

AutoAdaptAtStartup

AutoAdaptAtStartup
6.00

INPUS

28000

64

128000

31.00

0.00

64

16

-----------------------------------------------------------

Related Command
None

6.5.5

Querying the VDSL2 Port Performance (LST-VDSLPERF)

Function Description
This command is used for querying VDSL link traffic and line real-time information.

Command Format
LST-VDSLPERF::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=vdslport_num:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter
Name
ONUIP

OLTID

190

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP
address. Required.

Version: 04

6 Integrated Testing Interface

Parameter
Name

Data Type

Value Range

Size (128)
PONID

OCTET

Cabinet rack - shelf

STRING

- slot - PON port
number

Description
PON port information location. Locate
through the approach of cabinet rack -

The ONU that has no

shelf - slot - PON port number. Enter

management IP

NA if the corresponding information is

address. Required.

not specified.

ONU_NAME
ONUIDTYPE

OCTET

MAC

ONU identifier type (ONU_NAME,

STRING

LOID

MAC, LOID, ONU_NUMBER).

ONU_NUMBER
ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to the
PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.

ONUPORT

OCTET
STRING

Size (128)
Cabinet rack - shelf
- slot - port number

Remark

The ONU that has no
management IP
address. Required.

The ONU that has no
management IP
address. Required.

Locates the card through the approach
of cabinet rack - shelf - slot - port
number. Enter NA if the corresponding

-

information is not specified.

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of vdsl port performance
InOctets OutOctets SnrMgnDs SnrMgnUs AtnDs AtnUs OutputPwrDs OutputPwrUs
CH1ACTDATARATEDS CH1ACTDELAYDS CH1ACTDATARATEUS CH1ACTDELAYUS

Output Parameter
Parameter Name

Data Type

Value Range

Description

InOctets

INTEGER

0 - 2147483647

Number of received bytes

OutOctets

INTEGER

0 - 2147483647

Number of sent bytes

SnrMgnDs

INTEGER

-640 - 630

SnrMgnUs

INTEGER

-640 - 630

AtnDs

INTEGER

0 - 1270

AtnUs

INTEGER

0 - 1270

Version: 04

Downlink noise tolerance
Unit: 0.1dB.
Uplink noise tolerance
Unit: 0.1dB.
Downlink power attenuation
Unit: 0.1dB.
Uplink power attenuation
Unit: 0.1dB.

191

Northbound Interface TL1 User Manual

Parameter Name

Data Type

Value Range

OutputPwrDs

FLOAT

-310 - 310

OutputPwrUs

FLOAT

-310 - 310

INTEGER

0 - 200000

INTEGER

0 - 200

INTEGER

0 - 200000

INTEGER

0 - 200

CH1ACTDATARATEDS
CH1ACTDELAYDS
CH1ACTDELAYDS
CH1ACTDELAYUS

Description
Downlink output power
Unit: 0.1dBm.
Uplink output power
Unit: 0.1dBm.
Channel - downlink rate.
Unit: kbps.
Channel - downlink delay.
Unit: ms
Channel - uplink rate.
Unit: kbps.
Channel - uplink delay.
Unit: ms

Example
For example, query the information of the No. 1 VDSL port located in the No. 1 slot of the
ONU whose IP address is 10.250.18.121.
u

Command

LST-VDSLPERF::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-02 13:55:22
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of vdsl port performance
------------------------------------------------------InOctets
AtnUs

OutOctets
OutputPwrDs

SnrMgnDs

SnrMgnUs

OutputPwrUs

AtnDs

CH1ACTDATARATEDS

CH1ACTDELAYDS

CH1ACTDATARATEUS

CH1ACTDELAYUS

0

1860

0.00

0

0

0

0.00

0

0

0

0

0

-------------------------------------------------------

Related Command
None

192

Version: 04

6 Integrated Testing Interface

6.5.6

Querying the VDSL2 Port Statistics Information (LSTVDSLSTAT)

Function Description
This command is used for querying the VDSL link quality information, including the
initialization information, statistics information and channel statistics information over the
current 15 minutes, the current day and the past day.

Command Format
LST-VDSLSTAT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUID=onu_index],ONUPORT=vdslport_num:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name,
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

having a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Version: 04

ONU identifier
type: ONU_
NAME, MAC,

Optional

LOID and ONU_
NUMBER

193

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

ONU identifier,
used for uniquely
identifying the
ONU connected
ONUID

OCTET STRING

Size (128)

to the PON port.

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot
- port number

shelf - slot - port
number. Enter NA
for the

Optional

corresponding
unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of vdsl statistics
xdsl2PMLCurr15MTimeElapsed xdsl2PMLCurr15MLoss
xdsl2PMLCurrInit15MFullInits Curr15MinAtucEss xdsl2PMLCurr15MSes
xdsl2PMLCurrInit15MFailedFullInits xdsl2PMLCurr1DayTimeElapsed
xdsl2PMLCurrInit1DayFullInits xdsl2PMLCurr1DayEs xdsl2PMLCurr1DayLoss
xdsl2PMLCurr1DaySes xdsl2PMLCurrInit1DayFailedFullInits
xdsl2PMLHist1DMonitoredTime xdsl2PMLHistinit1DFullInits
xdsl2PMLHistinit1DFailedFullInits xdsl2PMLHist1DEs xdsl2PMLHist1DLoss
xdsl2PMLHist1DSes

Output Parameter
Parameter
xdsl2PMLCurr15MTimeElapsed
xdsl2PMLCurr15MLoss
xdsl2PMLCurrInit15MFullInits

194

Data Type

Value Range

INTEGER

0 to 900

INTEGER

0 to 900

INTEGER

0 to 2147483647

Description
Elapsed time of the current 15
minutes
Signal-loss seconds over the
current 15 minutes
Initialization times over the
current 15 minutes

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Curr15MinAtucEss

INTEGER

0 to 900

xdsl2PMLCurr15MSes

INTEGER

0 to 900

INTEGER

0 to 2147483647

INTEGER

0 to 86400

INTEGER

0 to 2147483647

xdsl2PMLCurr1DayEs

INTEGER

0 to 86400

xdsl2PMLCurr1DayLoss

INTEGER

0 to 86400

xdsl2PMLCurr1DaySes

INTEGER

0 to 86400

INTEGER

0 to 2147483647

INTEGER

0 to 86400

INTEGER

0 to 2147483647

INTEGER

0 to 2147483647

xdsl2PMLHist1DEs

INTEGER

0 to 86400

xdsl2PMLHist1DLoss

INTEGER

0 to 86400

xdsl2PMLHist1DSes

INTEGER

0 to 86400

xdsl2PMLCurrInit15MFailedFullInits
xdsl2PMLCurr1DayTimeElapsed
xdsl2PMLCurrInit1DayFullInits

xdsl2PMLCurrInit1DayFailedFullInits
xdsl2PMLHist1DMonitoredTime
xdsl2PMLHistinit1DFullInits
xdsl2PMLHistinit1DFailedFullInits

Description
Errored seconds over the current
15 minutes
Severely errored seconds over
the current 15 minutes
Initialization failures over the
current 15 minutes
Elapsed time of the current day
Initialization times over the
current day
Errored seconds over the current
day
Signal-loss seconds over the
current day
Severely errored seconds over
the current day
Initialization failures over the
current day
Elapsed time of the past day
Initialization times over the past
day
Initialization failures over the
past day
Errored seconds over the past
day
Signal-loss seconds over the past
day
Severely errored seconds over
the past day

Example
Query the performance statistics information over the current 15 minutes, the current day
and the past day of VDSL port 1 in slot 1 of the ONU whose IP address is 10.250.18.121.
u

Command issued

LST-VDSLSTAT::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::;

u
Version: 04

Response message
195

Northbound Interface TL1 User Manual

FH_10.250.18.133 2010-11-02 13:55:30
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of vdsl statistics
----------------------------------------------------------xdsl2PMLCurr15MTimeElapsed

xdsl2PMLCurr15MLoss

xdsl2PMLCurrInit15MFullInits

Curr15MinAtucEss

xdsl2PMLCurr15MSes

xdsl2PMLCurrInit15MFailedFullInits

xdsl2PMLCurr1DayTimeElapsed
xdsl2PMLCurr1DayEs

xdsl2PMLCurrInit1DayFullInits

xdsl2PMLCurr1DayLoss

xdsl2PMLCurrInit1DayFailedFullInits
xdsl2PMLHistinit1DFullInits
xdsl2PMLHist1DEs

xdsl2PMLCurr1DaySes

xdsl2PMLHist1DMonitoredTime

xdsl2PMLHistinit1DFailedFullInits

xdsl2PMLHist1DLoss

463

0

0

0

0

0

10714

0

0

0

0

--

0

0

0

0

xdsl2PMLHist1DSes
--

0

-----------------------------------------------------------

Related Command
None

6.5.7

Conducting the Single-ended Loop Test (SELT)

Function Description
The command is used for conducting the single-ended loop test on the ADSL2+ / VDSL2
port.

Command Format
SELT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=dslport_num:CTAG::;

196

Version: 04

6 Integrated Testing Interface

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address.
Required for an
OLTID

OCTET STRING

Size (128)

OLT IP address,

ONU that has no

name or ID

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate through

If the parameter

Size (128)

cabinet rack -

entered does not

Cabinet rack -

shelf - slot - PON

include the

shelf - slot - PON

port number.

ONUID, the

port number

Enter NA if the

PONID is

corresponding

optional.

information is not
specified.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Version: 04

ONU identifier
type (ONU_
NAME, MAC,

Optional

LOID, ONU_
NUMBER).

197

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

ONU identifier,
used for uniquely
identifying the
ONU connected
ONUID

OCTET STRING

to the PON port.

Size (128)

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate the card
through cabinet
rack - shelf - slot -

Size (128)
ONUPORT

OCTET STRING

Cabinet rack shelf - slot - port

port number.

Optional

Enter NA if the
corresponding
information is not
specified.

Response Format
It complies with the operation-command response format in Response Message Format.
Title = result of selt test
LINE_LENGTH LINE_STATUS ATTAINABLE_XTUC_RATE ATTAINABLE_XTUR_RATE

Output Parameter
Parameter

Data Type

Value Range

Description

LINE_LENGTH

OCTET STRING

-

Line length. Unit: m.

LINE_STATUS

String

ATTAINABLE_
XTUC_RATE
ATTAINABLE_
XTUR_RATE

Open
Short

Integer

-

Integer

-

Status
Attainable downlink
rate (kbps).
Attainable uplink rate
(kbps).

Example
For example, conduct the single-ended loop test on the No. 1 ADSL port located in the No.
3 slot of the ONU whose IP address is 10.250.18.121.

198

Version: 04

6 Integrated Testing Interface

u

Command issued

SELT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 13:57:37
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of selt test
----------------------------------------------------------LINE_LENGTH

LINE_STATUS

3910

8260

Short

ATTAINABLE_XTUC_RATE

ATTAINABLE_XTUR_RATE

1264

-----------------------------------------------------------

Related Command
None

6.5.8

Conducting the Double-ended Loop Test (DELT)

Function Description
The command is used for conducting the double-ended loop test on an ADSL2+ or a
VDSL2 port.

Command Format
DELT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=dslport_num:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name or ID
ONUIP

OCTET
STRING

Size (128)

of the ONU that has a
management IP

-

address
Required for an
OLTID

OCTET
STRING

Size (128)

IP address, name or ID

ONU that has no

of the OLT

management IP
address

Version: 04

199

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

PON port location
information. Locate a

PONID

port through rack -

Size (128)

OCTET

Rack - shelf - slot -

STRING

PON port number

shelf - slot - PON port
number. Enter NA for
the corresponding

If input parameters
exclude the
ONUID, the
PONID is
optional.

unspecified
information.
ONU_NAME

ONU identifier type:
ONU_NAME, MAC,

ONUID-

OCTET

MAC

TYPE

STRING

LOID

LOID, ONU_

ONU_NUMBER

NUMBER

Optional

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET

connected to the PON

Size (128)

STRING

port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card through

ONUPORT

rack - shelf - slot - port

Size (128)

OCTET

Rack - shelf - slot -

STRING

port number

number. Enter NA for
the corresponding

Optional

unspecified
information.

Response Format
It complies with the operation command response format in Response Message Format.
Title = result of delt test
XTUC_DELT_SATN XTUR_DELT_SATN XTUC_DELT_SNRM XTUR_DELT_SNRM

Output Parameter

200

Parameter

Data Type

Value Range

XTUC_DELT_SATN

OCTET STRING

Size (128)

XTUR_DELT_SATN

OCTET STRING

Size (128)

Description
Uplink signal attenuation
(dB)
Downlink signal
attenuation (dB)

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

XTUC_DELT_SNRM

OCTET STRING

Size (128)

XTUR_DELT_SNRM

OCTET STRING

Size (128)

Description
Uplink signal-to-noise
ratio margin (dB)
Downlink signal-to-noise
ratio margin (dB)

Example
Conduct a double-ended loop test on ADSL port 2 in slot 3 of the ONU whose IP address is
10.250.18.121.
u

Command issued

DELT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-2:CTAG::;

u

Response message
FH_10.250.18.133 2010-11-02 14:03:01

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of delt test
----------------------------------------------------------XTUC_DELT_SATN

XTUR_DELT_SATN

0.00

0.00

0.00

XTUC_DELT_SNRM

XTUR_DELT_SNRM

0.00

-----------------------------------------------------------

Related Command
None

6.5.9

Querying the xDSL Port PVC Information (LST-PVCINFO)

Function Description
This command is used for querying the PVC information of an ADSL port.

Command Format
LST-PVCINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;

Version: 04

201

Northbound Interface TL1 User Manual

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name or
ONUIP

OCTET STRING

Size (128)

ID of the ONU that
has a management IP

-

address
Required for an ONU
OLTID

OCTET STRING

Size (128)

IP address, name or

that has no

ID of the OLT

management IP
address

PON port location
information. Locate a
Size (128)
PONID

OCTET STRING

Rack - shelf slot - PON port
number

port through rack shelf - slot - PON
port number. Enter
NA for the
corresponding

If input parameters
exclude the ONUID,
the PONID is
optional.

unspecified
information.

ONUIDTYPE

OCTET STRING

ONU_NAME

ONU identifier type:

MAC

ONU_NAME, MAC,

LOID

LOID and ONU_

ONU_NUMBER

NUMBER

Optional

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the
PON port. The value

Optional

is ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card through
Size (128)
ONUPORT

OCTET STRING

Rack - shelf slot - port
number

rack - shelf - slot port number. Enter
NA if the

Optional

corresponding
information is not
specified.

202

Version: 04

6 Integrated Testing Interface

Response Format
It complies with the query command response format in Response Message Format.
Title = list of vdsl statistics
PVCOPERSTATUS PVCADMINSTATUS VPI VCI PVID VLANPRIORITY

Output Parameter
Parameter

Data Type

PVCOPERSTATUS

OCTET STRING

PVCADMINSTATUS

OCTET STRING

VPI

Value Range
UP

Description
PVC running status.

DOWN
UP

PVC management

DOWN

status.

INTEGER

-

VPI

VCI

INTEGER

-

VCI

PVID

INTEGER

-

VLAN ID

VLANPRIORITY

OCTET STRING

Integer (0-7)

VLAN default priority

Example
Query the PVC information of ADSL port 1 in slot 3 of the ONU whose IP address is
10.250.18.121.
u

Command issued

LST-PVCINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 14:03:21
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=8

list of PVC info
----------------------------------------------------------PVCOPERSTATUS PVCADMINSTATUS VPI

Version: 04

VCI

PVID

UP

UP

8

35

4088

0

DOWN

DOWN

0

0

4088

0

DOWN

DOWN

0

0

4088

0

DOWN

DOWN

0

0

4088

0

DOWN

DOWN

0

0

4088

0

DOWN

DOWN

0

0

4088

0

DOWN

DOWN

0

0

4088

0

VLANPRIORITY

203

Northbound Interface TL1 User Manual

DOWN

DOWN

0

0

4088

0

-----------------------------------------------------------

Related Command
None

6.6

Querying the VLAN Information
The following introduces the command and example for querying the VLAN information.

6.6.1

Querying the VLAN Forwarding (LST-VLANFWDINFO)

Function Description
This command is used for querying the information of VLAN-based forwarded messages,
including messages forwarded based on C VLAN and S+C VLAN.

Command Format
LST-VLANFWDINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport-location]
[,ONUIDTYPE=id-type,ONUID=onu-id],VLANID=svlan-id:CTAG::;

u

Gather statistics of OLT VLAN forwarding information:

LST-VLANFWDINFO::OLTID=olt-name,VLANID=vlan-id:CTAG::;

u

Gather statistics of ONU VLAN forwarding information (the ONU has a management
IP address):

LST-VLANFWDINFO::ONUIP=onu-name,VLANID=vlan-id:CTAG::;

u

Gather statistics of the ONU uplink VLAN tag forwarding on OLT (the ONU has no
management IP address):

LST-VLANFWDINFO::OLTID=olt-name,PONID=ponport-location,
ONUIDTYPE=idtype,ONUID=onu-id,VLANID=svlan-id:CTAG::;

Input Parameter

204

Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OLTID

OCTET STRING

Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address
IP address, name or ID of the OLT

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description
PON port location information.

PONID

OCTET STRING

Size (128)

Locate a port through rack - shelf -

Rack - shelf - slot -

slot - PON port number. Enter NA

PON port number

for the corresponding unspecified
information.

ONU_NAME
ONUIDTYPE

OCTET STRING

MAC

ONU identifier type: ONU_
NAME, MAC, LOID, ONU_

LOID
ONU_NUMBER

NUMBER
ONU identifier, used for uniquely
identifying the ONU connected to

ONUID

OCTET STRING

Size (128)

the PON port. The value is ONU_
NAME, MAC, LOID or ONU_
NUMBER.

VLANID

INTEGER

-

0 to 4095

Response Format
It complies with the query command response format in Response Message Format.
Title = list of VLAN forward info
FramesUs FramesDs OctetsUs OctetsDs DiscardsUs DiscardsDs

Output Parameter
Parameter

Data Type

Value Range

FramesUs

DOUBLE

0 to 2147483647

FramesDs

DOUBLE

0 to 2147483647

OctetsUs

DOUBLE

0 to 2147483647

OctetsDs

DOUBLE

0 to 2147483647

Description
Number of uplink
messages
Number of downlink
messages
Number of uplink bytes
Number of downlink
bytes
(Optional) Number of

DiscardsUs

DOUBLE

0-1.85E19

discarded uplink
message
(Optional) Number of

DiscardsDs

DOUBLE

0-1.85E19

discarded downlink
message

Version: 04

205

Northbound Interface TL1 User Manual

Example
Example 1: Query the VLAN 321 forwarding information of the ONU (having no
management IP address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected
to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-VLANFWDINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1,VLANID=321:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-28 12:01:50
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of VLAN forward info
----------------------------------------------------------FramesUs
0

FramesDs
0

0

OctetsUs OctetsDs DiscardsUs
0

0

DiscardsDs

0

-----------------------------------------------------------

Example 2: Query the VLAN 1 forwarding information of PON port 1 in slot 4 of the ONU
(having a management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-VLANFWDINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1,VLANID=1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 10:37:30
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of VLAN forward info
----------------------------------------------------------FramesUs
--

FramesDs
--

--

OctetsUs
--

OctetsDs
--

DiscardsUs

DiscardsDs

--

-----------------------------------------------------------

Related Command
None

206

Version: 04

6 Integrated Testing Interface

6.7

Querying the IPTV Information
The following introduces the command and example for querying the IPTV information.

6.7.1

Querying the Multicast Configuration (LST-IPTVCFG)

Function Description
This command is used for querying the multicast configuration information.

Command Format
LST-IPTVCFG::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index][,ONUPORT=port_index][,UV=user-vlan]:
CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.

Version: 04

207

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range
ONU_NAME

ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Description

Remark

ONU identifier
type (ONU_
NAME, MAC,

Optional

LOID and ONU_
NUMBER)
ONU identifier,
used for uniquely
identifying the
ONU connected

ONUID

OCTET STRING

Size (128)

to the PON port.

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot
- port number

shelf - slot - port
number. Enter NA
for the

Optional

corresponding
unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of IPTV configuration
MVLAN VLANID VPI VCI

Output Parameter
Parameter

Data Type

Value Range

Description

MVLAN

INTEGER

-

Multicast VLAN
VLAN at user side. Optional

VLANID

INTEGER

-

(multicast service VLAN accessed
through a home gateway).

208

VPI

INTEGER

-

VCI

INTEGER

-

VPI. Optional (DSL multicast
service).
VCI. Optional (DSL multicast
service).
Version: 04

6 Integrated Testing Interface

Example
Example 1: Query the multicast user information of the ONU (having no management IP
address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1
in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-IPTVCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message
FH_10.250.18.133 2010-10-28 11:58:45

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of IPTV configuration
----------------------------------------------------------MVLAN

VLANID

VPI

VCI

321

123

--

--

-----------------------------------------------------------

Example 2: Query the multicast user information of port 1 in slot 4 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-IPTVCFG::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 10:33:57
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of IPTV configuration
----------------------------------------------------------MVLAN

VLANID

VPI

VCI

2525

--

--

--

-----------------------------------------------------------

Related Command
None

Version: 04

209

Northbound Interface TL1 User Manual

6.8

Querying the VoIP Information
The following introduces the command and example for querying the VoIP information.

6.8.1

Querying the Voice Quality Statistical Information (LSTVoIPINFO)

Function Description
This command is used for querying the voice quality statistics information of the voice user.

Command Format
LST-VOIPINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT= pots_num:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range
Size (128)

Description
IP address, name or ID of the ONU
that has a management IP address.

Remark
The ONU that has no

Size (128)

OLT IP address, name or ID.

management IP
address. Required.

PON port information location.

PONID

Size (128)

Locate through the approach of

OCTET

Cabinet rack - shelf -

cabinet rack - shelf - slot - PON

STRING

slot - PON port

port number. Enter NA if the

number

corresponding information is not

The ONU that has no
management IP
address. Required.

specified.
ONU_NAME
ONUIDTYPE

OCTET

MAC

STRING

LOID
ONU_NUMBER

210

ONU identifier type (ONU_

The ONU that has no

NAME, MAC, LOID, ONU_

management IP

NUMBER).

address. Required.

Version: 04

6 Integrated Testing Interface

Parameter Name

Data Type

Value Range

Description

Remark

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.
Locates the card through the
ONUPORT

OCTET
STRING

Size (128)

approach of cabinet rack - shelf -

Cabinet rack - shelf -

slot - port number. Enter NA if the

slot - port number

corresponding information is not

-

specified.

Response Format
It complies with the query-command response format in Response Message Format.
Title = list of voip info
tatTime TxPackets RxPackets MeanDelay MeanJitter FractionLoss

Output Parameter
Parameter Name

Data Type

Value Range

StatTime

OCTET STRING

Size (20)

TxPackets

INTEGER

0 - 4294967295

Number of sent packets

RxPackets

INTEGER

0 - 4294967295

Number of received packets

MeanDelay

INTEGER

0 - 65535

Mean delay

MeanJitter

INTEGER

0 - 65535

Mean jitter

FractionLoss

INTEGER

0 - 100

Packet loss rate. Unit: %.

Description
Record generation time,
yyyy-mm-dd hh:mm:ss

Example
Example 1, query the quality statistics information of the No. 1 voice port of the ONU
(having no management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u

Command

LST-VOIPINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Version: 04

Response Message

211

Northbound Interface TL1 User Manual

FH_10.250.18.133 2010-10-27 14:45:28
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of voip info
----------------------------------------------------------StatTime TxPackets RxPackets

MeanDelay

MeanJitter FractionLoss
-1008762211

0

0

1630209 0

-----------------------------------------------------------

Example 2, query the quality statistics information of the POTS 1 port located in the No. 2
slot of the ONU (having a management IP address) whose IP address is 10.250.18.121.
u

Command

LST-VOIPINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-02 09:51:49
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of voip info
----------------------------------------------------------StatTime
MeanJitter

TxPackets

RxPackets

MeanDelay

FractionLoss

1970-01-01 00:00:00

0

0

0

0

0

-----------------------------------------------------------

Related Command
None

6.8.2

Querying the MG Configuration (LST-MGCFG)

Function Description
This command is used for querying the configuration information of an access gateway
interface.

212

Version: 04

6 Integrated Testing Interface

Command Format
LST-MGCFG::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu-index][,MGID=mg-id]:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Version: 04

ONU identifier
type: ONU_
NAME, MAC,

Optional

LOID, ONU_
NUMBER

213

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

ONU identifier,
used for uniquely
identifying the
ONU connected
ONUID

OCTET STRING

to the PON port.

Size (128)

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.

MGID

INTEGER

0 to 16

(Optional) MG

If it is not

identifier, used for

specified, the

uniquely

configurations of

identifying the

all MG modules

MG module on

in use will be

the ONU

returned.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of MG port configuration
GID PT EID SIPREGDM SVLAN VOIPVLAN IPMODE IPADDRESS IPMASK IPGATEWAY
PPPOEUSER PPPOEPWD SCOS CCOS MGCIP1 MGCIP2 HEARTBEATMODE HEARTBEATCYCLE
HEARTBEATNUM

Output Parameter
Parameter

Data Type

Value Range

Description
MG identifier, used for

MGID

INTEGER

0 to 16

uniquely identifying the
MG module on the
ONU.

PT

OCTET STRING

Size (1 to 32)

Voice protocol type (H.
248, SIP)
MG gateway domain

EID

OCTET STRING

Size (1 to 64)

name in the H248
configuration

214

SIPREGDM

OCTET STRING

Size (1 to 64)

SVLAN

INTEGER

0 to 4095

SIP register server
Outer VLAN of the
voice service

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

VOIPVLAN

INTEGER

0 to 4095

Description
Inner VLAN of the
voice service
IP obtaining mode:

IPMODE

OCTET STRING

Size (1 to 64)

DHCP, PPPOE,
STATIC

IPADDRESS

OCTET STRING

Size (1 to 64)

IP address

IPMASK

OCTET STRING

Size (1 to 64)

IP address mask

IPGATEWAY

OCTET STRING

Size (1 to 64)

Gateway address

PPPOEUSER

OCTET STRING

Size (1 to 64)

PPPOE username

PPPOEPWD

OCTET STRING

Size (1 to 64)

PPPOE password

SCOS

INTEGER

0 to 7

Outer service priority

CCOS

INTEGER

0 to 7

Inner service priority

MGCIP1

OCTET STRING

Size (32)

MGCIP2

OCTET STRING

Size (32)

HEARTBEATMODE

OCTET STRING

HEARTBEATCYCLE

Integer

0 to 65535

HEARTBEATNUM

Integer

1 to 3

Enabled
Disable

IP address of the active
softswitch
IP address of the
standby softswitch
Heartbeat mode
Heartbeat cycle
Unit: s
Number of detected
heartbeats

Example
Example 1: Query the MG configuration of the ONU (having no management IP address)
with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1 in slot 3
of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-MGCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-27 14:45:56
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of MG port configuration
Version: 04

215

Northbound Interface TL1 User Manual

----------------------------------------------------------MGID PT

EID

IPADDRESS
SCOS

SIPREGDM

IPMASK

CCOSMGCIP1

SVLAN

VOIPVLAN

IPMODE

IPGATEWAY

PPPOEUSER

PPPOEPWD

MGCIP2

HEARTBEATMODE

HEARTBEATCYCLE

HEARTBEATNUM
0

H.248

10.37.0.1

255.255.255.0

65535

1515

STATIC

10.37.0.254

10.37.0.103 Enable

30

10.37.0.1

65535

7

3

-----------------------------------------------------------

Example 2: Query the MG configuration of the ONU (having a management IP address)
whose IP address is 10.250.18.121.
u

Command issued

LST-MGCFG::ONUIP=10.250.18.121:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:52:03
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of MG port configuration
----------------------------------------------------------MGID

PT

IPADDRESS

EID

SIPREGDM

IPMASK

SCOS CCOSMGCIP1

SVLAN

IPGATEWAY

MGCIP2

VOIPVLAN

PPPOEUSER

HEARTBEATMODE

IPMODE

PPPOEPWD

HEARTBEATCYCLE

HEARTBEATNUM
0

H.248

12345678

0.0.0.0 0.0.0.0

1515
7

0

STATIC
Enable

0.0.0.0
30

3

-----------------------------------------------------------

Related Command
None

6.8.3

Querying the MG Interface Information (LST-MGINFO)

Function Description
This command is used for querying the running status of an access gateway interface.

216

Version: 04

6 Integrated Testing Interface

Command Format
LST-MGINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu-index][,MGID=mg-id]:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Version: 04

ONU identifier
type (ONU_
NAME, MAC,

Optional

LOID and ONU_
NUMBER)

217

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

ONU identifier,
used for uniquely
identifying the
ONU connected
ONUID

OCTET STRING

to the PON port.

Size (128)

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.

MGID

INTEGER

0 to 16

(Optional) MG

If it is not

identifier, used for

specified, the

uniquely

configurations of

identifying the

all MG modules

MG module on

in use will be

the ONU

returned.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of MG port info
MGID OperState

Output Parameter
Parameter

Data Type

Value Range

Description

MGID

INTEGER

0 to 16

-

Registering

Registering.

UP

Registered successfully.

Fault

IAD failure.

Deregistered

Logout

Restarting

IAD restarting.

Other

Others

OperState

OCTET STRING

Example
Example 1: Query the status of the MG module with MGID being 0 on the ONU (having no
management IP address) whose ONUID is aaa_bbb_ccc_111_222. The ONU is connected
to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u
218

Command issued
Version: 04

6 Integrated Testing Interface

LST-MGINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,MGID=0:CTAG::;

u

Response message
FH_10.250.18.133 2010-10-27 14:46:12

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of MG port info
----------------------------------------------------------MGID

OperState

0

UP

-----------------------------------------------------------

Example 2: Query the running status of the MG on the ONU (having a management IP
address) whose IP address is 10.250.18.121.
u

Command issued

LST-MGINFO::ONUIP=10.250.18.121:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:52:14
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of MG port info
----------------------------------------------------------MGID

OperState

0

Fault

-----------------------------------------------------------

Related Command
None

6.8.4

Querying the Port Fax Parameter (LST-FAXINFO)

Function Description
This command is used for querying the fax parameter of a POTS port.

Version: 04

219

Northbound Interface TL1 User Manual

Command Format
LST-FAXINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=pots_num:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

220

ONU identifier
type: ONU_
NAME, MAC,

Optional

LOID, ONU_
NUMBER

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

ONU identifier,
used for uniquely
identifying the
ONU connected
ONUID

OCTET STRING

to the PON port.

Size (128)

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack shelf - slot - port

Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot
- port number

number. Enter NA
for the

Optional

corresponding
unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
list of ONU pots info
FAXMODE CONTROLMODE

Output Parameter
Parameter

Data Type

FAXMODE

String

Value Range
T30
T38
NONE

CONTROLMODE

String

SS
AUTOVBD

Description
Fax mode
Voice channel of the
control mode
Full control
Auto-negotiation

Example
Example 1: Query the fax parameter of the ONU (having no management IP address) with
ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1 in slot 3 of the
OLT whose IP address is 10.250.18.100.

Version: 04

221

Northbound Interface TL1 User Manual

u

Command issued

LST-FAXINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message
FH_10.250.18.133 2010-10-27 14:46:39

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of ONU pots info
----------------------------------------------------------FAXMODE CONTROLMODE
T30

NONE

-----------------------------------------------------------

Example 2: Query the fax parameter of the ONU (having a management IP address) whose
IP address is 10.250.18.121.
u

Command issued

LST-FAXINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:52:25
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of ONU pots info
----------------------------------------------------------FAXMODE CONTROLMODE
T30

AUTOVBD

-----------------------------------------------------------

Related Command
None

6.8.5

Querying the POTS Port Information (LST-POTSINFO)

Function Description
This command is used for querying the POTS port information, including the line status,
service status, impedance and gain.
222

Version: 04

6 Integrated Testing Interface

Command Format
LST-POTSINFO::onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=pots_num:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

Version: 04

ONU identifier
type: ONU_
NAME, MAC,

Optional

LOID, ONU_
NUMBER

223

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

ONU identifier,
used for uniquely
identifying the
ONU connected
ONUID

OCTET STRING

Size (128)

to the PON port.

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot
- port number

shelf - slot - port
number. Enter NA
for the

Optional

corresponding
unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of VOIP pots info
LineState ServiceState EchoCancel ReversedPolarity RxGain TxGain PN TID
SIPUSERNAME SIPUSERPWD MGID

224

Version: 04

6 Integrated Testing Interface

Output Parameter
Parameter

Data Type

Value Range
Registering
Idle
Off-hook
Dialing
Ringing

LineState

OCTET STRING

Ringing-back
Connecting
Connected
Releasing
Register-failed
Deactived
Other

Description
Line status:
Registering port.
Port is idle.
Off-hook.
Dialing.
Ringing.
Ringing back.
Connecting.
Connected.
Releasing the connection.
Registering port failed.
The port is not activated.
Others.
Service status:
endLocal: The service is
terminated by the local end
due to the port disabled by
the user.

ServiceState

OCTET STRING

EndLocal

endRemote: The service is

EndRemote

terminated by the far end due

EndAuto

to the command sent by

Normal

MGC.
endAuto: The service is
terminated automatically due
to the MGC failure.
normal: The service is
normal.

Enabled

Echo suppression

EchoCancel

OCTET STRING

ReversedPolarity

OCTET STRING

RxGain

Float

-20 to 20

TxGain

Float

-20 to 20

PN

OCTET STRING

Size (1 to 32)

SIP telephone number

TID

OCTET STRING

Size (1 to 64)

H248 user terminal identifier

SIPUSERNAME

OCTET STRING

Size (1 to 32)

Version: 04

Disable
Enabled
Disable

Polarity reversal signal
Receive gain
Unit: dB
Send gain
Unit: dB

Username corresponding to
the SIP user port

225

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

SIPUSERPWD

OCTET STRING

Size (1 to 32)

Description
Password corresponding to
the SIP user port
MG identifier, identifying the

MGID

INTEGER

0 to 16

MG module being used by
the user.

Example
Example 1: Query the information of POTS port 1 of the ONU (having no management IP
address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1
in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

LST-POTSINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-27 14:47:14
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of pots info
----------------------------------------------------------LineState
RxGain
Idle

ServiceState

TxGain

Normal

PN

Enable

TID

EchoCancel

ReversedPolarity

SIPUSERNAME

Enable

0

0

SIPUSERPWD
a1

-----------------------------------------------------------

Example 2: Query the information of POTS port 1 in slot 2 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-POTSINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:52:36
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of pots info
----------------------------------------------------------226

Version: 04

6 Integrated Testing Interface

LineState
RxGain

ServiceState

TxGain

PN

TID

EchoCancel

ReversedPolarity

SIPUSERNAME

SIPUSERPWD

Register-failed EndAuto Enable

Disable 0

0

--

-----------------------------------------------------------

Related Command
None

6.8.6

Conducting the External Line Test (MELT)

Function Description
This command is used for testing the external line of a voice or DSL user to detect whether
line errors occur.

Command Format
MELT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=fttbpost_index:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

Version: 04

227

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.
ONU_NAME
ONUIDTYPE

OCTET STRING

MAC
LOID
ONU_NUMBER

ONU identifier
type: ONU_
NAME, MAC,

Optional

LOID, ONU_
NUMBER
ONU identifier,
used for uniquely
identifying the
ONU connected

ONUID

OCTET STRING

Size (128)

to the PON port.

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot
- port number

shelf - slot - port

(Optional) Port of

number. Enter NA

the voice service

for the

corresponding to

corresponding

the broadband

unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of outside line test
onclusion ACAG ACBG ACAB DCAG DCBG DCAB RAG RBG RAB CapAG CapBG CapAB

228

Version: 04

6 Integrated Testing Interface

Output Parameter
Parameter

Data Type

Value Range

Description

Conclusion

INTEGER

0 to 100

Test result

INTEGER

-

T568A-to-ground AC
ACAG

voltage
Unit: mV
T568B-to-ground AC

ACBG

INTEGER

-

voltage
Unit: mV
T568A / T568B AC

ACAB

INTEGER

-

voltage
Unit: mV
T568A-to-ground DC

DCAG

INTEGER

-

voltage
Unit: mV
T568B-to-ground DC

DCBG

INTEGER

-

voltage
Unit: mV
T568A/T568B DC

DCAB

INTEGER

-

voltage
Unit: mV
T568A-to-ground

RAG

INTEGER

-

resistance
Unit: ohm
T568B-to-ground

RBG

INTEGER

-

resistance
Unit: ohm
T568A/T568B

RAB

INTEGER

-

resistance
Unit: ohm
T568A-to-ground

CapAG

INTEGER

-

capacitance
Unit: nF
T568B-to-ground

CapBG

INTEGER

-

capacitance
Unit: nF
T568A/T568B

CapAB

INTEGER

-

capacitance
Unit: nF

Version: 04

229

Northbound Interface TL1 User Manual

Example
Example 1: Test the external line of POTS port 1 of the ONU (having no management IP
address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1
in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

MELT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-27 14:52:26
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of outside line test
----------------------------------------------------------Conclusion

ACAG

ACBG

ACAB
CapAB

RBG

RAB

CapAG

CapBG

22

15

15

21

>10M

>10M

477

1365005500

DCAG
485

DCBG
14

1365204625

DCAB

RAG

>10M
2031075

-----------------------------------------------------------

Example 2: Test the external line of POTS port 1 in slot 2 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

MELT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:53:59
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of outside line test
----------------------------------------------------------Conclusion ACAG ACBG ACAB DCAG DCBG DCAB RAG
RBG RAB CapAG CapBG CapAB
22 124 219 190 410 410
58 >10M >10M >10M 1365300000 1365400000 2000000
-----------------------------------------------------------

230

Version: 04

6 Integrated Testing Interface

Related Command
None

6.8.7

Conducting the Internal Line Test (TEST-POTSCIRCUIT)

Function Description
This command is used for testing the internal line of a voice or DSL user to detect whether
line errors occur.

Command Format
TEST-POTSCIRCUIT::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=fttbpost_index:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name
or ID of the ONU
ONUIP

OCTET STRING

Size (128)

that has a

-

management IP
address
Required for an
OLTID

OCTET STRING

Size (128)

IP address, name

ONU that has no

or ID of the OLT

management IP
address

PON port location
information.

PONID

OCTET STRING

Locate a port

If input

Size (128)

through rack -

parameters

Rack - shelf - slot

shelf - slot - PON

exclude the

- PON port

port number.

ONUID, the

number

Enter NA for the

PONID is

corresponding

optional.

unspecified
information.

Version: 04

231

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range
ONU_NAME

ONUIDTYPE

OCTET STRING

MAC

Description

Remark

ONU identifier
type: ONU_
Optional

NAME, MAC,

LOID
ONU_NUMBER

LOID, ONU_
NUMBER
ONU identifier,
used for uniquely
identifying the
ONU connected

ONUID

OCTET STRING

to the PON port.

Size (128)

Optional

The value is
ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card
through rack Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot
- port number

shelf - slot - port

(Optional) Port of

number. Enter NA

the voice service

for the

corresponding to

corresponding

the broadband

unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of pots inside line test
LoopCurrent FeedV RingV FeedVValue RingVValue LoopCurrentValue

Output Parameter

232

Parameter

Data Type

LoopCurrent

OCTET STRING

FeedV

OCTET STRING

RingV

OCTET STRING

FeedVValue

INTEGER

Value Range

Description

Normal

Indicates whether the

Abnormal

loop current is normal.

Normal

Indicates whether the

Abnormal

feed voltage is normal.

Normal

Indicates whether the

Abnormal

ring voltage is normal.

-

Feed voltage
Unit: mV
Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

RingVValue

INTEGER

-

LoopCurrentValue

INTEGER

-

Description
Ring voltage
Unit: mV
Loop current
Unit: mA

Example
Example 1: Test the internal line of POTS port 1 of the ONU (having no management IP
address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1
in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

TEST-POTSCIRCUIT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-10-27 14:52:52
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of pots inside line test
----------------------------------------------------------LoopCurrent FeedV RingV FeedVValue RingVValue LoopCurrentValue
Normal Normal Normal 48444 58557

18

-----------------------------------------------------------

Example 2: Test the internal line of POTS port 1 in slot 2 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

TEST-POTSCIRCUIT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-02 09:55:02
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of pots inside line test
-----------------------------------------------------------

Version: 04

LoopCurrent FeedV RingV

FeedVValue

Normal

39278

Normal

Abnormal

RingVValue LoopCurrentValue

64314

22
233

Northbound Interface TL1 User Manual

-----------------------------------------------------------

Related Command
None

6.8.8

Conducting the Incoming Call Emulation Test (TESTCALLEESIMULATION)

Function Description
This command is used for conducting the incoming call emulation test.
The incoming call emulation test simulates an incoming call during which a program acts as
the called party and automatically completes all the operations that should be responded by
the called party to the caller. The testing personnel will check whether the ringing of the
called party can be heard so as to verify whether the called port is ringing and being called
normally.
Note: If the system does not send the ending test command after a certain period of time
since the sending of the starting test command, the test will be automatically ended.

Command Format
TEST-CALLEESIMULATION::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=pots_num:CTAG:: ACTION=action-type[,TIMEOUT=timeout];

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name or ID
ONUIP

OCTET STRING

Size (128)

of the ONU that has a
management IP

-

address
Required for an ONU
OLTID

OCTET STRING

Size (128)

IP address, name or ID

that has no

of the OLT

management IP
address

234

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

PON port location
information. Locate a
Size (128)
PONID

OCTET STRING

Rack - shelf - slot PON port number

port through rack shelf - slot - PON port
number. Enter NA for
the corresponding

If input parameters
exclude the ONUID,
the PONID is optional.

unspecified
information.

ONUIDTYPE

OCTET STRING

ONU_NAME

ONU identifier type

MAC

(ONU_NAME, MAC,

LOID

LOID and ONU_

ONU_NUMBER

NUMBER)

Optional

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the PON
port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card through
Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot port number

rack - shelf - slot - port
number. Enter NA for
the corresponding

Optional

unspecified
information.
Returned status of the
call upon query:
1. The port is idle.

Start: Starts the test.
ACTION

OCTET STRING

Stop: Ends the test.
Query: Queries the

2. Off-hook.
Test type

3. Ringing.
4. Call connected.

test.

5. Busy tone.
6. On-hook.
7. Testing is ended.

TIMEOUT

Version: 04

INTEGER

60 to 300

Test time
Unit: s

-

235

Northbound Interface TL1 User Manual

Response Format
The format of the response for starting the test is the same as the operation command
response format in Response Message Format. The format of the response for querying and
stopping the test is the same as the query command response format in Response Message
Format.
Title = result of callin simulation
STATE Conclusion FailReason

Output Parameter
Data Type

Parameter

Value Range

Description

1: The port is idle.

This parameter is

2: Off-hook.
STATE

OCTET STRING

Remark

3: Ringing.

Current status of the

4: Connected.

call

5: On-hook.

returned when the
input parameter
"Action" is "Stop" or
"Query".

6: Testing is ended.
1

Succeeded

2

Failed
The call connection is

Conclusion

INTEGER

established, but the
3

tester has not
confirmed the call
connection status.

1

No signaling
interaction.
The called party hooks

FailReason

INTEGER

2

These two parameters
are returned when the
input parameter
"Action" is "Stop".

off, but SS does not
respond to the off-hook
signaling.

3

MG internal reason.

4

Others

Example
Example 1: Conduct an incoming call emulation test on POTS port 1 of the ONU (has no
management IP address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected
to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u
236

Command issued
Version: 04

6 Integrated Testing Interface

TEST-CALLEESIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Start,TIMEOUT=60;
TEST-CALLEESIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Stop,TIMEOUT=60;

u

Response message

FH_10.250.18.133 2010-10-27 14:54:09
M

CTAG COMPLD
EN=0

ENDESC=No error

FH_10.250.18.133 2010-10-27 14:55:42
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of callin simulation
----------------------------------------------------------STATE

Conclusion

6

2

FailReason

1

-----------------------------------------------------------

Example 2: Conduct an incoming call emulation test on POTS port 1 in slot 2 of the ONU
(having a management IP address) whose IP address is 10.250.18.121.
u

Command issued

TEST-CALLEESIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Start,TIMEOUT=60;
TEST-CALLEESIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Stop,TIMEOUT=60;

u

Response message

FH_10.250.18.133 2010-11-02 15:11:04
M

CTAG COMPLD
EN=0

ENDESC=No error

FH_10.250.18.133 2010-11-02 15:11:22
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of callin simulation
----------------------------------------------------------STATE

Conclusion

6

2

FailReason

1

----------------------------------------------------------Version: 04

237

Northbound Interface TL1 User Manual

Related Command
None

6.8.9

Conducting the Outgoing Call Emulation Test (TESTCALLERSIMULATION)

Function Description
This command is used for conducting the outgoing call emulation test.
The outgoing call emulation test simulates an outgoing call during which a program acts as
the caller and automatically completes all the operations that should be performed by the
caller. After the call is connected, the tester will check whether the ringing of the caller can
be heard so as to verify whether the calling emulation port is ringing and calling normally.

Note:
If the system does not send the test ending command after a certain period of
time since the sending of the test starting command, the test will be
automatically ended.
Command Format
TEST-CALLERSIMULATION::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=post_index:CTAG::ACTION=action-type,TEL=tel-number[,
TIMEOUT=timeout];

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

IP address, name or ID
ONUIP

OCTET STRING

Size (128)

of the ONU that has a
management IP

-

address
OLTID

238

OCTET STRING

Size (128)

IP address, name or ID
of the OLT

-

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

PON port location
information. Locate a
Size (128)
PONID

OCTET STRING

Rack - shelf - slot PON port number

port through rack shelf - slot - PON port
number. Enter NA for
the corresponding

If input parameters
exclude the ONUID,
the PONID is optional.

unspecified
information.

ONUIDTYPE

OCTET STRING

ONU_NAME

ONU identifier type:

MAC

ONU_NAME, MAC,

LOID

LOID, ONU_

ONU_NUMBER

NUMBER

Optional

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET STRING

Size (128)

connected to the PON
port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card through
Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot port number

rack - shelf - slot - port
number. Enter NA for
the corresponding

Optional

unspecified
information.

Start: Starts the test.
ACTION

OCTET STRING

Stop: Ends the test.
Query: Queries the

Test Type

-

test.
The telephone number
TEL

OCTET STRING

Size (20)

dialed for testing. It is
entered when starting

-

the test.
TIMEOUT

Version: 04

INTEGER

60 to 300

Test time
Unit: s

-

239

Northbound Interface TL1 User Manual

Response Format
The format of the response for starting the test is the same as the operation command
response format in Response Message Format. The format of the response for querying and
stopping the test is the same as the query command response format in Response Message
Format.
Title = result of call out simulation
STATE DIALNUMBER TARGETNUMBER FAILEDSIG Conclusion FailReason

Output Parameter
Parameter

Data Type

Value Range

Description

Remark

1: The port is idle.
2: Off-hook.
3: Dial tone.
4: Receiving (digit
This parameter is

collection).
STATE

OCTET STRING

5: ReceiveEnd (digit
collection completed).

Current status of the call

returned when the input
parameter "Action" is
"Stop" or "Query".

6: Ringing back.
7: Connected.
8: Busy tone.
9: On-hook.
10: Testing is ended.
DIALNUMBER
TARGETNUMBER

OCTET STRING

Size (32)

OCTET STRING

Size (32)

Telephone number dialed
for testing.
Telephone number
reported to softswitch.

-

-

Specific error signaling
FAILEDSIG

OCTET STRING

Size (128)

returned when
establishing the channel

-

failed

Conclusion

1

Succeeded

2

Failed
The call connection is

INTEGER
3

established, but the tester
has not confirmed the
call connection status.

These two parameters
are returned when the
input parameter
"Action" is "Stop".

The SS off-hook
FailReason

INTEGER

1

response signaling is not
received.

240

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

Remark

The SS dial tone sending

2

signaling is not received.
The dialed telephone
number is not consistent

3

with that reported to SS.
The ring back tone is not

4

received.
The opposite end has not

5

hooked off.
Establishing the channel

6

failed.
SS does not respond to

7

the on-hook signaling.

8

Others

Example
Example 1: Conduct an outgoing call emulation test on POTS port 1 of the ONU (has no
management IP address) with ONUID being aaa_bbb_ccc_111_222. The ONU is connected
to PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u

Command issued

TEST-CALLERSIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Start,TEL=1110,TIMEOUT=60;
TEST-CALLERSIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Stop,TEL=1110,TIMEOUT=60;

u

Response message

FH_10.250.18.133 2010-10-27 14:56:53
M

CTAG COMPLD
EN=0

ENDESC=No error

FH_10.250.18.133 2010-10-27 14:57:02
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of call out simulation
----------------------------------------------------------STATE DIALNUMBER
Version: 04

TARGETNUMBER FAILEDSIG
241

Northbound Interface TL1 User Manual

Conclusion FailReason
10

1110

port_register_failed

2

8

-----------------------------------------------------------

Example 2: Conduct an outgoing call emulation test on POTS port 1 in slot 2 of the ONU
(having a management IP address) whose IP address is 10.250.18.121.
u

Command issued

TEST-CALLERSIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Start,TEL=1110,TIMEOUT=60;
TEST-CALLERSIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Stop,TEL=1110,TIMEOUT=60;

u

Response message
FH_10.250.18.133 2010-11-02 15:11:27

M

CTAG COMPLD
EN=0

ENDESC=No error

FH_10.250.18.133 2010-11-02 15:11:40
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

result of call out simulation
----------------------------------------------------------STATE DIALNUMBER

TARGETNUMBER

FAILEDSIG

Conclusion FailReason
10

1110

no response from ss

2

1

-----------------------------------------------------------

Related Command
None

6.9

Querying the Alarm Information
The following introduces the command and example for querying the alarm information.

6.9.1

Querying Alarms (QUERY-ALARM)

Function Description
The command is used for querying the recovered / unrecovered alarms of a specified NE.
242

Version: 04

6 Integrated Testing Interface

Command Format
QUERY-ALARM::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location][,
ONUIDTYPE=id-type,ONUID=onu-index]:CTAG::[BEGINTIME=begin-time][,
ENDTIME=end-time][,FAULTFLAG=flag];

u

Query an ONU that has a management IP address:

QUERY-ALARM::ONUIP=onu-name:CTAG::[BEGINTIME=begin-time][,ENDTIME=endtime][,FAULTFLAG=flag];

u

Query an ONU that has no management IP address:

QUERY-ALARM::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=id-type,
ONUID=onu-index:CTAG::[BEGINTIME=begin-time][,ENDTIME=end-time][,
FAULTFLAG=flag];

u

Query an OLT PON port:

QUERY-ALARM::OLTID=olt-name,PONID=ponport_location:CTAG::
[BEGINTIME=begin-time][,ENDTIME=end-time][,FAULTFLAG=flag];

u

Query an OLT:

QUERY-ALARM::OLTID=olt-name:CTAG::[BEGINTIME=begin-time][,ENDTIME=endtime][,FAULTFLAG=flag];

Input Parameter
Parameter

Data Type

Value Range

Description

Remark
It is required for

ONUIP

OCTET
STRING

Size (128)

IP address, name or ID

querying an ONU

of the ONU that has a

that has a

management IP address

management IP
address.
It is required for
querying an OLT

OLTID

OCTET
STRING

Size (128)

IP address, name or ID

or an ONU that

of the OLT

has no
management IP
address.

PON port location

PONID

OCTET
STRING

Size (128)
Rack - shelf - slot PON port number

information. Locate a

If input

port through rack -

parameters

shelf - slot - PON port

exclude the

number. Enter NA for

ONUID, the

the corresponding

PONID is

unspecified

optional.

information.

Version: 04

243

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

ONU_NAME

ONU identifier type:
ONU_NAME, MAC,

Remark

ONUID-

OCTET

MAC

TYPE

STRING

LOID

LOID, ONU_

ONU_NUMBER

NUMBER

Optional

ONU identifier, used
for uniquely identifying
ONUID

the ONU connected to

OCTET

Size (128)

STRING

the PON port. The

Optional

value is ONU_NAME,
MAC, LOID or ONU_
NUMBER.
Format of start time

BEGINTIME

String

Size (32)

(Beijing time)
YYYY-MM-DD HH-

Optional

MM-SS
Format of end time
ENDTIME

String

Size (32)

(Beijing time)
YYYY-MM-DD HH-

Optional

MM-SS
Alarm status. Default
FAULTFLAG

Fault-Only

STRING

ALL

value: Fault-Only.
Fault-Only includes

Optional

events and excludes
recovered alarms.

Response Format
It complies with the query command response format in Response Message Format.
Title = list of alarm info
SERIALID ALARMNAME DIP DNAME DTYPE POSITION SEVERITY FaultFlag HAPPENTIME
RECOVERTIME ALARMTYPE AditionalInfo EVENT_CODE PROBABLE_CAUSE_DESC
PROBABEL_CAUSE_CODE PROPOSED_ADVISE

Output Parameter
Parameter

Data Type

Value Range

Description

SERIALID

String

Size (0 to 100)

Alarm ID
Alarm name, corresponding to

ALARMNAME

String

Size (0 to 256)

the alarm code parameter
(EVENT_CODE)

244

Version: 04

6 Integrated Testing Interface

Parameter

Data Type

Value Range

Description

DIP

String

IP address

NE IP address

DNAME

String

Size (0 to 100)

NE name

DTYPE

String

Size (0 to 100)

NE type
Position where the alarm
occurs.

POSITION

String

RACK: rackid

RACK: rack

SHELF: shelfid

SHELF: shelf

SLOT: slotid

SLOT: slot

PORT: portid

PORT: port number

ONUNUM: onunumber

ONUNUM: ONU number

ONUNAME: onuname

ONUNAME: ONU name

ONUPORTTYPE:

ONUPORTTYPE: ONU port

onuporttype

type (LAN, E1, DSL, POTS

ONUPORT: onuportid

and PON)

EMUNUM: emunum

ONUPORT: ONU port number
EMUNUM: environment
monitoring unit

Critical
SEVERITY

String

Major
Minor

Alarm level

Warning
Fault
FaultFlag

String

Recovery

Alarm status

Event
Alarm generation time.
HAPPENTIME

String

Size (0 to 32)

Format: YYYY-MM-DD HH:
MM:SS.

RECOVERTIME

String

Size (0 to 32)

Alarm recovery time. Format:
YYYY-MM-DD HH:MM:SS.

communicationsAlarm
qualityOfServiceAlarm
ALARMTYPE

String

processingErrorAlarm

Alarm type

equipmentAlarm
environmentalAlarm
Additional information,
AditionalInfo

String

Size (0 to 256)

describing additional
information related to the
alarm.

PROBABLE_CAUSE
_DESC

Version: 04

String

Size (0 to 256)

Alarm cause

245

Northbound Interface TL1 User Manual

Parameter
PROBABEL_CAUSE_
CODE
PROPOSED_ADVISE

Data Type

Value Range

Description

Integer

-

Alarm cause code

String

Size (0 to 512)

Handling advice

Example
Example 1: Query alarm information of the ONU (having no management IP address) with
ONUID being aaa_bbb_ccc_111_222. The ONU is connected to PON port 1 in slot 3 of the
OLT whose IP address is 10.78.200.200.
u

Command issued

QUERY-ALARM::OLTID=10.78.200.200,PONID=NA-NA-15-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-01 15:31:06
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=14

Alarm
SERIALID

ALARMNAME

DIP

DNAME

SEVERITY

FaultFlag

HAPPENTIME

ALARMTYPE

ADITIONALINFO

DTYPE

POSITION

RECOVERTIME
EVENT_CODE

PROBABLE_CAUSE_DESC
135

ONU_H248_BREAKOUT

AN5006-04

10.250.18.100

AN5006-04

RACK:NA,SHELF:NA,SLOT:3,PORT:1,ONUNUM:5,ONUNAME:AN5006-04
Critical

Faul2010-11-01 14:51:51

-- 320001

ONU_H248_BREAKOUT99

AN5006-04

AN5006-04

--

CommunicationAlarm

ONU_H248_BREAKOUT

10.250.18.100

Example 2: Query the alarm information of the ONU (having a management IP address)
whose IP address is 10.250.18.121.
u

Command issued

QUERY-ALARM::ONUIP=10.250.18.121:CTAG::;

u

Response message
FH_10.250.18.133 2010-11-02 10:34:38

M

CTAG COMPLD
total_blocks=2

246

Version: 04

6 Integrated Testing Interface

block_number=2
block_records=3
Alarm
SERIALID ALARMNAME DIP

DNAME

SEVERITY

FaultFlag

HAPPENTIME

ALARMTYPE

ADITIONALINFO

2

ONU_H248_BREAKOUT

DTYPE

EVENT_CODE

10.250.18.121

RACK:NA,SHELF:NA,SLOT:5,PORT:0
2010-10-28 09:13:14
320001

AN5006-20

2010-11-01 11:06:42
110003

PROBABLE_CAUSE_DESC
system 2

Critical

AN5006-20

Recovery

2010-11-01 09:48:13

ONU_H248_BREAKOUT3

system 2

POSITION
RECOVERTIME

CommunicationAlarm

--

OLT card status anomaly 10.250.18.121

RACK:NA,SHELF:NA,SLOT:4 Critical
2010-11-01 11:15:34

Recovery

EquipmentAlarm

--

OLT card status anomaly, including (running anomaly,

not activated, inconsistent of the card and configuration type)4
OLT card status anomaly 10.250.18.121

system 2

RACK:NA,SHELF:NA,SLOT:4 Critical

Recovery

15:11:06

2010-11-01 15:19:14

EquipmentAlarm

AN5006-20
2010-11-01
--

110003

OLT card status anomaly, including (running anomaly, not activated,
inconsistent of the card and configuration type)-

Related Command
None

Version: 04

247

7

Integrated Query Interface
The following introduces the commands for physical resource query, service resource query,
resource change notification and resource file export.

7.1

Querying the Equipment Information
The following introduces the commands and examples for querying the equipment
information.

7.1.1

Querying the OLT Equipment Information (LST-DEVICE)

Function Description
This command is used for querying the information of a specified set or all sets of OTL
equipment.

Command Format
LST-DEVICE::[OLTID=olt-name]:CTAG::;

Supported Equipment
OLT: AN5516 series, AN5116 series.

Input Parameter
Parameter Name

Data Type

Value Range

OLTID

OCTET STRING

Size (128)

Description
OLT IP address or
name.

Response Format
It complies with the query-command response format in Response Message Format.

248

Version: 04

7 Integrated Query Interface

Output Parameter
Parameter Name

Data Type

Value Range

Description

DEVNAME

OCTET STRING

Size (128)

Equipment name

DEVIP

OCTET STRING

Size (128)

Equipment IP address

DT

OCTET STRING

Size (255)

Equipment model

DEVER

OCTET STRING

Size (255)

Software version

Example
For example, query the information of the OLT whose IP address is 10.250.18.100.
u

Command

LST-DEVICE::OLTID=10.250.18.100:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 10:37:35
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------DEVNAME DEVIP
system1

DT

10.250.18.100

DEVER
AN5516_01

RP0121

-----------------------------------------------------------

Related Command
LST-DEVINFO

7.1.2

Querying the ONU Equipment Information (LST-ONU)

Function Description
This command is used for querying the information of a specified ONU or all ONUs
connected to the OLT.

Command Format
LST-ONU::ONUIP=onu-name|(OLTID=olt-name[,PONID=ponport_location[,
ONUIDTYPE=onuidtype,ONUID=onu-index]]):CTAG::;

Version: 04

249

Northbound Interface TL1 User Manual

u

Query all ONUs connected to the OLT:

LST-ONU::OLTID=olt-name:CTAG::;

u

Query all ONUs connected to a specified PON port of the OLT:

LST-ONU::OLTID=olt-name,PONID=ponport_location:CTAG::;

u

Query the information of the ONU that has a management IP address:

LST-ONU::ONUIP=onu-name:CTAG::;

u

Query the information of the ONU that has no management IP address:

LST-ONU::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-type,
ONUID=onuindex:CTAG::;

Supported Equipment
ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
Name

ONUIP

OLTID

Data Type

OCTET
STRING

OCTET
STRING

Value Range

Size (128)

Size (128)

Description

Remark

IP address or name of

The ONU that has a

the ONU that has a

management IP address.

management IP address.

Required.

OLT IP address or
name.

OLT or the ONU that
has no management IP
address. Required.

PON port information
Size (128)
PONID

OCTET
STRING

Cabinet rack shelf - slot PON port
number

location. Locate through
the approach of cabinet
rack - shelf - slot - PON
port number. Enter NA
if the corresponding

The ONU that has no
management IP address.
Optional.

information is not
specified.

250

Version: 04

7 Integrated Query Interface

Parameter
Name

ONUIDTYPE

Data Type

OCTET
STRING

Value Range

Size (128)

Description

Remark

ONU_NAME, MAC,

The ONU that has no

LOID, ONU_

management IP address.

NUMBER.

Optional.

ONU identifier, used for
uniquely identifying the
ONUID

OCTET
STRING

Size (128)

ONU connected to the

The ONU that has no

PON port. The value is

management IP address.

ONU_NAME, MAC,

Optional.

LOID or ONU_
NUMBER.

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter
Name
OLTID

Data Type
OCTET
STRING

Value Range

Description

Size (128)

OLT IP address or name.
Locates the card through the

PONID

OCTET
STRING

Size (128)

approach of cabinet rack - shelf - slot

Cabinet rack - shelf - slot -

- port number. Enter NA if the

port number

corresponding information is not
specified.

ONUNO
NAME
DESC
ONUTYPE
IP

AUTHTYPE

MAC

Version: 04

INTEGER
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING
OCTET
STRING

0 - 512

ONU authorization code

Size (128)

ONU name

Size (128)

ONU description information.

Size (128)

ONU type

Size (128)

The management IP address of the
ONU.

MAC

Authentication mode. When no

LOID

authentication mode is specified, a

LOIDONCEON

dash (–) will be returned.

Size (128)

The registered MAC information of
the ONU.
251

Northbound Interface TL1 User Manual

Parameter

Data Type

Name

Value Range

OCTET

LOID

OCTET

adopted, a dash (–) will be returned.
LOID password. If no password is

Size (128)

STRING
OCTET

SWVER

When the MAC authentication is

Size (64)

STRING

PWD

Description

specified, a dash (–) will be returned.

Size (128)

STRING

Software version

Example
Example 1, query the information of the ONU (having no management IP address) with
ONUID being aa_whdx04. The ONU is connected to the shelf 0 - slot 4 - PON 1 port of the
OLT whose IP address is 10.250.18.102.
u

Command

LST-ONU::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 11:06:08
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------OLTID

PONID

ONUNO

LOID

PWD

SWVER

NAME

10.250.18.102

NA-1-4-1

AN5006-04

LOID

--

DESC
2

ONUTYPE IP

AN5006-04

54-4b-40-0c-79-a8

whdx04

AUTH

MAC

---

R4.05.60.25
-----------------------------------------------------------

Example 2, query the information of the ONU (having a management IP address) whose IP
address is 10.250.18.121.
u

Command

LST-ONU::ONUIP=10.250.18.121:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 10:53:54
M

CTAG COMPLD
total_blocks=1

252

Version: 04

7 Integrated Query Interface

block_number=1
block_records=1
-------------------------------------------------OLTID PONID

ONUNO

LOID

SWVER

PWD

10.250.18.100

NAME

NA-1-1-1

AN5006-20

10.250.18.121

whdx2020

--

DESC
2

ONUTYPE IP

AN5006-20
MAC

AUTH

MAC

--

54-4b-17-00-00-80

b230

-----------------------------------------------------------

Related Command
LST-ONUCFG

7.1.3

Querying the ONU Hardware / Software Version (LSTONUVERSION)

Function Description
This command is used for querying the ONU hardware / software version information.

Command Format
LST-ONUVERSION::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=idtype,ONUID=onu-index:CTAG::;

Input Parameter
Parameter

ONUIP

Data Type

OCTET
STRING

Value Range

Description
IP address or name of

Size (128)

the ONU that has a
management IP address

Remark
Required for an
ONU that has a
management IP
address
Required for the

OLTID

OCTET
STRING

Size (128)

IP address or name of
the OLT

OLT or the ONU
that has no
management IP
address

Version: 04

253

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

Remark

PON port location
information. Locate a

PONID

Size (128)

port through rack - shelf

Optional for an

OCTET

Rack - shelf - slot

- slot - PON port

ONU that has no

STRING

- PON port

number. Enter NA for

management IP

number

the corresponding

address

unspecified
information.
ONUID-

OCTET

TYPE

STRING

ONU_NAME, MAC,
Size (128)

LOID and ONU_
NUMBER

Optional for an
ONU that has no
management IP
address

ONU identifier, used
for uniquely identifying
ONUID

OCTET
STRING

the ONU connected to
Size (128)

the PON port. The
value is ONU_NAME,
MAC, LOID or ONU_

Optional for an
ONU that has no
management IP
address

NUMBER.

Response Format
It complies with the query command response format in Response Message Format.

Output Parameter
Parameter

Data Type

Value Range

Description

OLTID

OCTET STRING

Size (128)

IP address or name of the OLT

Size (128)
PONID

OCTET STRING

Rack - shelf - slot port number

Locate a card through rack - shelf slot - port number. Enter NA for
the corresponding unspecified
information.
ONU identifier, used for uniquely

ONUID

OCTET STRING

Size (128)

identifying the ONU on the PON
port. The value is ONU_Number.

254

SWVER

OCTET STRING

Size (128)

Software version

HWVER

OCTET STRING

Size (128)

Hardware version

Version: 04

7 Integrated Query Interface

Example
Query the version information of the ONU (having no management IP address) with
ONUID being 54-4B-70-03-FB-98. The ONU is connected to PON port 4 in slot 11 on
shelf 0 of the OLT whose IP address is 10.78.200.200.
u

Command issued

LST-ONUVERSION::OLTID=10.78.200.200,PONID=NA-NA-11-4,ONUIDTYPE=MAC,
ONUID=54-4B-70-03-FB-98:CTAG::;

u

Response message
FH_10.98.30.151 2014-07-07 14:32:20

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of ONU version:
----------------------------------------------------------------OLTID

PONID

ONUID

SWVER

HWVER

10.78.200.200 1-1-11-4 3 R3.07.05.64 WKE2.119.195R1B
-----------------------------------------------------------------

;

Related Command
None

7.1.4

Querying the Shelf Information (LST-SHELF)

Function Description
This command is used for querying the shelf information of a specified OLT, a specified
ONU or all devices in the entire network.

Command Format
LST-SHELF::[ONUIP=onu-name]|[OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]]:CTAG::;

u
Version: 04

Query the shelf information of all devices in the entire network:
255

Northbound Interface TL1 User Manual

LST-SHELF:::CTAG::;

u

Query the shelf information of a specified OLT:

LST-SHELF::OLTID=olt-name:CTAG::;

u

Query the shelf information of an ONU that has a management IP address:

LST-SHELF::ONUIP=onu-name:CTAG::;

u

Query the shelf information of an ONU that has no management IP address:

LST-SHELF::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index:CTAG::;

Input Parameter
Parameter

ONUIP

Data Type

OCTET
STRING

Value Range

Description
IP address or name of

Size (128)

the ONU that has a
management IP address

Remark
Required for an
ONU that has a
management IP
address
Required for the

OLTID

OCTET
STRING

Size (128)

IP address or name of
the OLT

OLT or the ONU
that has no
management IP
address.

PON port location
Size (128)
PONID

OCTET

Rack - shelf - slot

STRING

- PON port
number

information. Locate a

If input

port through rack - shelf

parameters

- slot - PON port

exclude ONUID,

number. Enter NA for

PONID is

the corresponding

optional.

unspecified information.
ONUID-

OCTET

TYPE

STRING

ONU_NAME, MAC,
Size (128)

LOID and ONU_

Optional

NUMBER
ONU identifier, used for
uniquely identifying the

ONUID

OCTET
STRING

ONU connected to the
Size (128)

PON port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.

256

Version: 04

7 Integrated Query Interface

Response Format
It complies with the query command response format in Response Message Format.

Output Parameter
Parameter

Data Type

Value Range

Description
When a single ONU is queried, the input
parameter will be returned (when all

ONUIP

OCTET STRING

Size (128)

ONUs in the entire network are queried,
the ONUIPs will be returned if they
exist; otherwise, the OLTIDs, PONIDs
or ONUIDs will be returned).
IP address or name of the OLT. When all

OLTID

OCTET STRING

Size (128)

devices in the entire network are
queried, the IP addresses will be
returned.

PONID

OCTET STRING

Size (128)

Locate a card through rack - shelf - slot -

Rack - shelf - slot -

port number. Enter NA for the

port number

corresponding unspecified information.
When a single ONU is queried, the input

ONUID

OCTET STRING

Size (128)

parameter will be returned; when all
ONUs in the entire network are queried,
the ONUNOs will be returned.

SHELFID

SHELFTYPE

OCTET STRING

OCTET STRING

Size (128)

Locate a shelf through rack - shelf

Rack - shelf

number. Enter NA for the corresponding

number

unspecified information.

Size (128)

Shelf type

Example
Example 1: Query the information of all shelves of the OLT whose IP address is
10.250.18.100.
u

Command issued

LST-SHELF::OLTID=10.250.18.100:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 10:37:54
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

Version: 04

257

Northbound Interface TL1 User Manual

----------------------------------------------------------ONUIP

OLTID

PONID

--

10.250.18.100

ONUID

SHELFID SHELFTYPE

--

--

NA-1

AN5516-01

-----------------------------------------------------------

Example 2: Query the information of all shelves of the ONU (having a management IP
address) whose IP address is 10.250.18.121.
u

Command issued

LST-SHELF::ONUIP=10.250.18.121:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 10:54:02
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP

OLTID

10.250.18.121

PONID

ONUID

10.250.18.100

SHELFID SHELFTYPE
NA-1-1-1

NA-1

AN5006-20

-----------------------------------------------------------

Related Command
None

7.1.5

Querying the Card Information (LST-BOARD)

Function Description
This command is used for querying the shelf information of a specified OLT or a specified
ONU or all sets of equipment in the entire network.

Command Format
LST-BOARD::[ONUIP=onu-name]|[[OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]][,BOARDID=BOARD_location]]:
CTAG::;

u

Query the card information of all sets of equipment in the entire network:

LST-BOARD:::CTAG::;

u

Query the card information of a specified OTL:

LST-BOARD::OLTID=olt-name[,BOARDID=BOARD_location]:CTAG::;
258

Version: 04

7 Integrated Query Interface

u

Query the card information of the ONU that has a management IP address:

LST-BOARD::ONUIP=onu-name[,BOARDID=BOARD_location]:CTAG::;

u

Query the card information of the ONU that has no management IP address:

LST-BOARD::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index[,BOARDID=BOARD_location]:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter

Data Type

Name

ONUIP

OLTID

OCTET
STRING

OCTET
STRING

Value
Range

Size (128)

OCTET
STRING

Size (128)

OCTET

TYPE

STRING

that has a management IP address.

The ONU that has a
management IP
address. Required.

OLT IP address or name.

has no management
IP address. Required.

Cabinet rack
- shelf - slot
- PON port
number

ONUID-

IP address or name of the ONU

Remark

OLT or the ONU that

Size (128)
PONID

Description

Size (128)

PON port information location.
Locate through the approach of
cabinet rack - shelf - slot - port
number. Enter NA if the
corresponding information is not

The ONU that has no
management IP
address. Required.

specified.
ONU_NAME, MAC, LOID,
ONU_NUMBER.

The ONU that has no
management IP
address. Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has no

the PON port. The value is ONU_

management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.
Locates the card through the
BOAR-

OCTET

DID

STRING

Size (128)
Cabinet rack
- shelf - slot

approach of cabinet rack - shelf slot. Enter NA if the corresponding
information is not specified. To

Optional.

only specify the shelf number,
enter it in format of NA-0-NA.

Version: 04

259

Northbound Interface TL1 User Manual

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parame-

Data

ter Name

Type

Value Range

Description
When querying a single ONU, the input parameter will be

ONUIP

OCTET
STRING

Size (128)

returned (when querying all ONUs in the entire network,
the ONUIP will be returned if the ONUIP exists; otherwise,
the OLTID, PONID or ONUID will be returned).

OLTID

OCTET
STRING

Size (128)
Size (128)

PONID

OCTET

Cabinet rack -

STRING

shelf - slot port number

ONUID

OCTET
STRING

BOAR-

OCTET

DID

STRING

BOARD-

OCTET

TYPE

STRING

OLT IP address or name. When querying the equipment in
the entire network, the IP address will be returned.
Locates the card through the approach of cabinet rack shelf - slot - port number. Enter NA if the corresponding
information is not specified.
When querying a single ONU, the input parameter will be

Size (128)

returned; when querying all ONUs in the entire network,
the ONUNO will be returned.

Size (128)
Cabinet rack shelf - slot
Size (128)

Locates the card through the approach of cabinet rack shelf - slot. Enter NA if the corresponding information is
not specified. To only specify the shelf number, enter it in
format of NA-0-NA.
Card Type

1. Power
2. ETH
3. ADSL
4. VDSL
5. POTS
BSER-

OCTET

6. E1

VICE

STRING

7. GPON

Card service type.

8. EPON
9. Control
(main control
unit)
10. Other
PNUM

260

INTEGER

0 - 64

Number of ports

Version: 04

7 Integrated Query Interface

Parame-

Data

ter Name

Type

SWVER
HWVER

OCTET
STRING
OCTET
STRING

Value Range

Description

Size (255)

Software version

Size (255)

Hardware Version

Example
Example 1, query the information of a card on the OLT whose IP address is 10.250.18.100.
u

Command

LST-BOARD::ONUIP=10.250.18.100:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 10:38:05
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=10

----------------------------------------------------------ONUIP OLTID PONID ONUID BOARDID BOARDTYPE
PNUM

SWVER HWVER

--

10.250.18.100

RP0121
--------

Version: 04

EC4B

EPON

4

--NA-1-3

EC4B

EPON

4

-- NA-1-9

HSWA

SCU

3

----

-- NA-1-18 PUBA

Other 2

--

-- NA-1-19 HU1A

Other 5

-- --NA-1-20 HU1A

Other 5

WKE2.170.846R3A

10.250.18.100

--

--

--

10.250.18.100

--

--

--

10.250.18.100

--

NA-1-2

WKE2.170.846R3A

10.250.18.100

RP0103

-- --

WKE2.167.177R1A

10.250.18.100

RP0103

4

WKE2.115.334R1A

10.250.18.100

RP0107

EPON

WKE2.119.318R2A

10.250.18.100

RP0121

EC4B

WKE2.119.318R2A

10.250.18.100

RP0121

NA-1-1

WKE2.119.318R1A

10.250.18.100

RP0121

-- --

BSERVICE

-- --

NA-1-21 FAN

Other 2

--

-- NA-1-22 FAN

Other

2

--

-- NA-1-23 FAN

Other

2

--

261

Northbound Interface TL1 User Manual

-----------------------------------------------------------

Example 2, query the information of a card connected with the ONU (having a management
IP address) whose IP address is 10.250.18.121.
u

Command

LST-BOARD::ONUIP=10.250.18.121:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 10:54:12
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=7

----------------------------------------------------------ONUIP OLTID

PONID

PNUM

HWVER

SWVER

10.250.18.121
RP0105

--

ONUID

BOARDID BOARDTYPE

BSERVICE

--

--

NA-1-1

VD24

VDSL

--

NA-1-2

POTS64-20

POTS

WKE2.170.853R2A

10.250.18.121

--

64

WKE2.170.815R2A

RP0104

10.250.18.121
RP0106

NA-1-3

AD32-20 ADSL

32

--

--

--

NA-1-4

ETH

ETH

16

--

--

--

NA-1-5

MCU

SCU

3

--

--

--

NA-1-6

PWR

Power

1

--

--

--

NA-1-7

FAN-1

Other

2

--

10.250.18.121
--

--

WKE2.119.372R2A

10.250.18.121
--

--

WKE2.170.813R2A

10.250.18.121
RP0106

--

--

WKE2.170.814R2C

10.250.18.121
RP0100

24

--

-----------------------------------------------------------

Related Command
LST-BRDINFO

7.1.6

Querying ONU Distance Values in a Batch Manner (LSTONUDISTANCE)

Function Description
This command is used to query the ONU distance values in a batch manner.
262

Version: 04

7 Integrated Query Interface

Prerequisite
The PON traffic statistics is enabled in the EMS.

Command Format
LST-ONUDISTANCE::OLTID=olt-name:CTAG::;

Input Parameter
Parameter

OLTID

Data Type
OCTET
STRING

Value Range

Size (128)

Description

Remark

IP address or name
of the OLT

Required for the OLT or the
ONU that has no management
IP address

Response Format
It complies with the query command response format in Response Message Format.

Output Parameter
Parameter

Data Type

Value Range

Description
IP address or name of the OLT. When

OLTID

OCTET STRING

Size (128)

devices in the entire network are
queried, the IP addresses will be
returned.

ONUNO

INTEGER

0 to 512

ONU authorization number

NAME

OCTET STRING

Size (128)

ONU name

MAC

OCTET STRING

Size (128)

LOID

OCTET STRING

Size (128)

PWD

OCTET STRING

Size (128)

Length

DOUBLE

0 to 100

Registered MAC information of the
ONU
When the MAC authentication is
adopted, a dash – will be returned.
LOID password. If no password is
specified, a dash – will be returned.
Optical fiber length (i.e. the ONU
distance value)
Unit: km

Example
Example 1: Query the distance values of all ONUs connected to the OLT with the IP
address 10.250.18.100.
Version: 04

263

Northbound Interface TL1 User Manual

u

Command issued

LST-ONUDISTANCE::OLTID=10.190.42.3:CTAG::;

u

Response message

FH_10.170.162.232017-02-1710:35:34
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=2

listofonudistance
-------------------------------------------------------------OLTIDPONIDONUNONAMEMACLOIDPWDLength
10.190.42.31-1-4-11--------0.000
10.190.42.31-1-14-13PON[1]-AN5506-07-A1[3]FHTT0002010f----0.000
--------------------------------------------------------------

Related Command
None

7.2

Querying Service Resources
The following introduces the command and example for querying service resources.

7.2.1

Querying the Media Gateway Information (LST-MG)

Function Description
This command is used for querying the media gateway information of a specified device.

Command Format
LST-MG::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=idtype,ONUID=onu-index):CTAG::[GETSVLAN=TRUE];

264

Version: 04

7 Integrated Query Interface

Input Parameter
Parameter

ONUIP

Data Type

OCTET
STRING

Value Range

Description
IP address or name of

Size (128)

the ONU that has a
management IP address

Remark
Required for an
ONU that has a
management IP
address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address or name of

ONU that has no

the OLT

management IP
address

PON port location
information. Locate a

PONID

OCTET
STRING

Size (128)
Rack - shelf - slot PON port number

port through rack shelf - slot - PON port
number. Enter NA for
the corresponding
unspecified

If input parameters
exclude the
ONUID, the
PONID is
optional.

information.
ONUID-

OCTET

TYPE

STRING

ONU_NAME, MAC,
Size (128)

LOID and ONU_

Optional

NUMBER
ONU identifier, used
for uniquely identifying

ONUID

OCTET
STRING

the ONU connected to
Size (128)

the PON port. The

Optional

value is ONU_NAME,
MAC, LOID or ONU_
NUMBER.
(Optional) When
this parameter is

GETSVLAN

OCTET

TRUE

STRING

FALSE

-

set to TRUE, the
output parameter
is SVLAN and
SCOS.

Response Format
It complies with the query command response format in Response Message Format.

Version: 04

265

Northbound Interface TL1 User Manual

Output Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OLTID

OCTET STRING

Size (128)
Size (128)

PONID

OCTET STRING

Rack - shelf - slot port number

ONUID

OCTET STRING

Size (128)

Description
The input parameter will be
returned.
The input parameter will be
returned.
The input parameter will be
returned.
The input parameter will be
returned.
MG identifier, used for uniquely

MGID

INTEGER

0 to 16

identifying the MG module on the
ONU.

PT

OCTET STRING

Size (32)

Voice protocol type (H.248, SIP)

EID

OCTET STRING

Size (64)

SIPREGDM

OCTET STRING

Size (64)

SIP register server

VLAN

INTEGER

0 to 4095

Voice VLAN

PRI

INTEGER

0 to 7

Voice priority

IPMODE

OCTET STRING

Size (64)

IPADDRESS

OCTET STRING

Size (64)

IP address

IPMASK

OCTET STRING

Size (64)

IP address mask

IPGATEWAY

OCTET STRING

Size (64)

Gateway address

MGCIP1

OCTET STRING

Size (64)

IP address of the active softswitch

MGCIP2

OCTET STRING

Size (64)

IP address of the standby softswitch

SVLAN

INTEGER

0 to 4095

SCOS

INTEGER

0 to 7

MG gateway domain name in the
H248 configuration

IP obtaining mode: DHCP, PPPOE
and STATIC

(Optional) Outer VLAN of the
voice service
(Optional) Outer service priority

Example
Example 1: Query the MG interface information of the ONU (having no management IP
address) with ONUID being whdx04. The ONU is connected to PON port 1 in slot 4 on
shelf 0 of the OLT whose IP address is 10.250.18.102.
u

266

Command issued

Version: 04

7 Integrated Query Interface

LST-MG::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 11:06:36
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP OLTID

PONID ONUID

VLAN

IPMODE

PRI

MGID PT

IPADDRESS

EID SIPREGDM

IPMASK

IPGATEWAY MGCIP1

MGCIP2
-- 10.250.18.102

NA-1-4-1

1515

222.222.222.4

255

--

whdx04

0

H.248

255.255.255.0

a1
0.0.0.0

222.222.222.222
-----------------------------------------------------------

Example 2: Query the MG interface information of the ONU (having a management IP
address) whose IP address is 10.250.18.121.
u

Command issued

LST-MG::ONUIP=10.250.18.121:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 10:54:21
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP OLTID

PONID

ONUID

VLAN

IPMODE

IPADDRESS

PRI

MGID

PT

EID

IPMASK

SIPREGDM

IPGATEWAY MGCIP1

MGCIP2
10.250.18.121
-- 1515

7

--

--

STATIC

--

0

H.248

222.222.222.3

222.222.222.3 255.255.255.0

0.0.0.0

222.222.222.222
-----------------------------------------------------------

Related Command
LST-MGCFG
LST-MGINFO

Version: 04

267

Northbound Interface TL1 User Manual

7.2.2

Querying the Voice Port Information (LST-POTS)

Function Description
This command is used for querying the voice port information of a specified device.

Command Format
LST-POTS::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;

Input Parameter
Parameter

ONUIP

Data Type

OCTET
STRING

Value Range

Size (128)

Description

Remark

IP address or name

Required for an

of the ONU that has

ONU that has a

a management IP

management IP

address

address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address or name

ONU that has no

of the OLT

management IP
address

PON port location
information. Locate
Size (128)
PONID

OCTET

Rack - shelf -

STRING

slot - PON port
number

a port through rack shelf - slot - PON
port number. Enter
NA for the
corresponding

If input parameters
exclude the ONUID,
the PONID is
optional.

unspecified
information.

ONUIDTYPE

268

OCTET
STRING

ONU_NAME,
Size (128)

MAC, LOID and

Optional

ONU_NUMBER

Version: 04

7 Integrated Query Interface

Parameter

Data Type

Value Range

Description

Remark

ONU identifier, used
for uniquely
identifying the ONU
ONUID

OCTET
STRING

connected to the

Size (128)

PON port. The value

Optional

is ONU_NAME,
MAC, LOID or
ONU_NUMBER.
Locate a card port
through rack - shelf -

Size (128)
ONUPORT

OCTET

Rack - shelf -

STRING

slot - port
number

slot - port number.
Enter NA for the

Optional

corresponding
unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.

Output Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OLTID

OCTET STRING

Size (128)
Size (128)

PONID

OCTET STRING

Rack - shelf - slot - port
number

ONUID

OCTET STRING

Size (128)

Description
The input parameter
will be returned.
The input parameter
will be returned.
The input parameter
will be returned.
The input parameter
will be returned.
Locate a port through

Size (128)
ONUPORT

OCTET STRING

Rack - shelf - slot - port
number

rack - shelf - slot - port
number. Enter NA for
the corresponding
unspecified
information.

Version: 04

269

Northbound Interface TL1 User Manual

Data Type

Parameter

Value Range

Description
MG identifier, used for

MGID

INTEGER

uniquely identifying the

0 to 16

MG module on the
ONU.

TID

OCTET STRING

Size (1 to 64)

PN

OCTET STRING

Size (1 to 32)

H248 user terminal
identifier
SIP telephone number
Username

SIPUSERNAME

OCTET STRING

Size (1 to 32)

corresponding to the
SIP user port
Password

SIPUSERPWD

OCTET STRING

Size (1 to 32)

corresponding to the
SIP user port

T30

String

FAXMODE

Fax mode

T38
NONE

String

CONTROLMODE

SS

Control mode

AUTOVBD

Example
Example 1: Query the information of POTS port 1 of the ONU (having no management IP
address) with ONUID being whdx04. The ONU is connected to PON port 1 in slot 4 on
shelf 0 of the OLT whose IP address is 10.250.18.102.
u

Command issued

LST-POTS::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 11:06:46
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

------------------------------------------------------ONUIP OLTID PONID ONUID

ONUPORT MGID

SIPUSERNAME

FAXMODE CONTROLMODE

SIPUSERPWD

-- 10.250.18.102

NA-1-4-1

0

T30

a1

a1

whdx04

TID

PN

NA-NA-NA-1

AUTOVBD

-------------------------------------------------------270

Version: 04

7 Integrated Query Interface

Example 2: Query the information of POTS port 1 in slot 2 on shelf 0 of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u

Command issued

LST-POTS::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 10:54:32
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP

OLTID PONID ONUID ONUPORT MGID

SIPUSERNAME
10.250.18.121
--

SIPUSERPWD
--

--

TID

PN

FAXMODE CONTROLMODE
--

NA-NA-2-1

0

--

-----------------------------------------------------------

Related Command
LST-POTSINF
LST-POTSINFO

7.2.3

Querying the Multicast Service Information (LST-IPTV)

Function Description
This command is used for querying the multicast service information of a specified device.
If the query result is empty, an empty list will be returned.

Command Format
LST-IPTV::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;

u

Query the multicast service information of the ONU that has a management IP address:

LST-IPTV::ONUIP=onu-name[,ONUPORT=onu-port]:CTAG::;

u

Query the multicast service information of the ONU that has no management IP
address:

LST-IPTV::(OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;

Version: 04

271

Northbound Interface TL1 User Manual

Input Parameter
Parameter

ONUIP

Data Type

OCTET
STRING

Value Range

Description
IP address or name of the

Size (128)

ONU that has a
management IP address

Remark
Required for an
ONU that has a
management IP
address
Required for an

OLTID

OCTET
STRING

Size (128)

IP address or name of the

ONU that has no

OLT

management IP
address

PON port location

PONID

Size (128)

information. Locate a port

OCTET

Rack - shelf - slot

through rack - shelf - slot

STRING

- PON port

- PON port number. Enter

number

NA for the corresponding

If input parameters
exclude ONUID,
PONID is optional.

unspecified information.
ONUID-

OCTET

TYPE

STRING

ONU_NAME, MAC,
Size (128)

LOID and ONU_

Optional

NUMBER
ONU identifier, used for
uniquely identifying the

ONUID

OCTET
STRING

ONU connected to the
Size (128)

PON port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card port

ONUPORT

OCTET
STRING

Size (128)

through rack - shelf - slot

Rack - shelf - slot

- port number. Enter NA

- port number

for the corresponding

Optional

unspecified information.

Response Format
It complies with the query command response format in Response Message Format.

Output Parameter

272

Parameter

Data Type

Value Range

Description

ONUIP

OCTET STRING

Size (128)

The input parameter will be returned.

OLTID

OCTET STRING

Size (128)

The input parameter will be returned.

Version: 04

7 Integrated Query Interface

Data Type

Parameter

Value Range

Description

Size (128)
PONID

OCTET STRING

Rack - shelf - slot -

The input parameter will be returned.

port number
ONUID

OCTET STRING

ONUPORT

OCTET STRING

Size (128)

The input parameter will be returned.

Size (128)

Locate a port through rack - shelf - slot

Rack - shelf - slot -

- port number. Enter NA for the

port number

corresponding unspecified information.

MVLAN

INTEGER

0 to 4095

Multicast VLAN

VPI

INTEGER

0 to 65535

VPI. Optional (DSL multicast service)

VCI

INTEGER

0 to 65535

VCI. Optional (DSL multicast service)
VLAN at user side. Optional (multicast

UV

INTEGER

service VLAN accessed through a home

0 to 4095

gateway)
Fast leave mode:
FLMODE

OCTET STRING

Size (32)

Enabled
Disabled
Maximum number of multicast

MAXGRP

INTEGER

programs that a port can join

0 to 255

simultaneously.

Example
Example 1: Query the multicast service information of the ONU (having no management IP
address) with ONUID being whdx04. The ONU is connected to PON port 1 in slot 4 on
shelf 0 of the OLT whose IP address is 10.250.18.102.
u

Command issued

LST-IPTV::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response message
FH_10.250.18.133 2010-11-04 11:06:56

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP OLTID PONID ONUID ONUPORT MVLAN
FLMODE

Version: 04

-- 10.250.18.102

NA-1-4-1

--

--

--

VPI

VCI

UV

MAXGRP
123

--

whdx04

NA-NA-NA-1

432

273

Northbound Interface TL1 User Manual

-----------------------------------------------------------

Example 2: Query the multicast service information of the ONU (having a management IP
address) whose IP address is 10.250.18.121.
u

Command issued

LST-IPTV::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 10:54:41
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP OLTID PONID ONUID ONUPORT MVLAN
FLMODE

VPI

VCI

UV

569

--

--

MAXGRP

10.250.18.121

--

--

--

--

--

-- NA-NA-4-1

-----------------------------------------------------------

Related Command
LST-IPTVCFG

7.2.4

Querying the LAN Port Information (LST-LANPORT)

Function Description
This command is used for querying the LAN port information of a specified OLT or ONU.

Command Format
LST-LANPORT::ONUIP=onu-name|(OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index])[,PORTID=port_index]:CTAG::;

u

Query the uplink port information of an OLT:

LST-LANPORT::OLTID=olt-name[,PORTID=port_index]:CTAG::;

u

Query the LAN port information of an ONU that has a management IP address:

LST-LANPORT::ONUIP=onu-name[,PORTID=port_index]:CTAG::;

u

Query the LAN port information of an ONU that has no management IP address:

LST-LANPORT::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index[,PORTID=port_index]:CTAG::;
274

Version: 04

7 Integrated Query Interface

Input Parameter
Parameter

ONUIP

Data Type

OCTET
STRING

Value Range

Description
IP address or name of

Size (128)

the ONU that has a
management IP address

Remark
Required for an
ONU that has a
management IP
address
Required for the

OLTID

OCTET
STRING

Size (128)

IP address or name of
the OLT

OLT or the ONU
that has no
management IP
address

PON port location

PONID

OCTET
STRING

Size (128)
Rack - shelf - slot PON port number

information. Locate a

If input

port through rack - shelf

parameters

- slot - PON port

exclude the

number. Enter NA for

ONUID, the

the corresponding

PONID is

unspecified

optional.

information.
ONU identifier type:
ONUID-

OCTET

TYPE

STRING

Size (128)

ONU_NAME, MAC,
LOID, ONU_

Optional

NUMBER
ONU identifier, used for
uniquely identifying the
ONUID

OCTET
STRING

ONU connected to the
Size (128)

PON port. The value is

Optional

ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a port through

PORTID

OCTET
STRING

Size (128)
Rack - shelf - slot port number

rack - shelf - slot - port
number. Enter NA for
the corresponding

Optional

unspecified
information.

Response Format
It complies with the query command response format in Response Message Format.

Version: 04

275

Northbound Interface TL1 User Manual

Output Parameter
Parameter

Data Type

Value Range

Description

ONUIP

OCTET STRING

Size (128)

The input parameter will be returned.

OLTID

OCTET STRING

Size (128)

The input parameter will be returned.

Size (128)
PONID

OCTET STRING

Rack - shelf - slot -

The input parameter will be returned.

port number
ONUID

OCTET STRING

Size (128)
Size (128)

PORTID

OCTET STRING

Rack - shelf - slot port number

ADMINSTATUS

OCTET STRING

1. UP
2. DOWN

The input parameter will be returned.
Locate a port through rack - shelf slot - port number. Enter NA for the
corresponding unspecified
information.
Management status

1. Full
2. Half
DUPLEX

OCTET STRING

3. Auto

Working mode

4. Auto-Full
5. Auto-Half
Auto
10M
100M
SPEED

INTEGER

1000M

Port rate

Auto-10M
Auto-100M
Auto-1000M
RateLimitUs

INTEGER

0 to 1000000

RateLimitDs

INTEGER

0 to 1000000

Uplink rate limit
Unit: Kbps
Downlink rate limit
Unit: Kbps

Example
Example 1: Query the Ethernet port information of the ONU (having no management IP
address) with ONUID being whdx04. The ONU is connected to PON port 1 in slot 4 on
shelf 0 of the OLT whose IP address is 10.250.18.102.
u

Command issued

LST-LANPORT::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;

276

Version: 04

7 Integrated Query Interface

u

Response message

FH_10.250.18.133 2010-11-04 11:07:05
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP

OLTID

PONID

RateLimitUs
--

10.250.18.102

Full 100M

ONUID

PORTID ADMINSTATUS

DUPLEX

SPEED

RateLimitDs
--

NA-1-4-1

whdx04

NA-NA-NA-1

DOWN

--

-----------------------------------------------------------

Example 2: Query the Ethernet port information of the ONU (having a management IP
address) whose IP address is 10.250.18.121.
u

Command issued

LST-LANPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;

u

Response message
FH_10.250.18.133 2010-11-04 10:55:00

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP OLTID PONID
RateLimitUs
10.250.18.121
--

ONUID

PORTID ADMINSTATUS

DUPLEX

SPEED

RateLimitDs
--

--

--

NA-NA-4-1

--

--

--

--

-----------------------------------------------------------

Related Command
None

7.2.5

Querying the DSL Port Information (LST-DSLPORT)

Function Description
This command is used for querying the DSL port information of a specified set of
equipment.

Version: 04

277

Northbound Interface TL1 User Manual

Command Format
LST-DSLPORT::ONUIP=onu-name|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::;

At present, the FiberHome equipment only supports the command of the following format:
LST-DSLPORT::ONUIP=onu-name[,ONUPORT=onu-port]:CTAG::;

Supported Equipment
AN5006-15, AN5006-16, AN5006-20.

Input Parameter
Parameter
Name

ONUIP

OLTID

PONID

Data Type

OCTET
STRING

OCTET
STRING

Value
Range

Size (128)

Description

IP address or name of the ONU
that has a management IP address.

OLT IP address or name.

Cabinet

Locate through the approach of

OCTET

rack - shelf

cabinet rack - shelf - slot - PON

STRING

- slot - PON

port number. Enter NA if the

port

corresponding information is not

number

specified.

TYPE

STRING

management IP
address. Required.

has no management
IP address. Required.

PON port information location.

OCTET

The ONU that has a

OLT or the ONU that
Size (128)

Size (128)

ONUID-

Remark

Size (128)

The ONU that has
no management IP
address. Required.

ONU identifier type (ONU_

The ONU that has

NAME, MAC, LOID, ONU_

no management IP

NUMBER).

address. Required.

ONU identifier, used for uniquely
ONUID

OCTET
STRING

Size (128)

identifying the ONU connected to

The ONU that has

the PON port. The value is ONU_

no management IP

NAME, MAC, LOID or ONU_

address. Required.

NUMBER.

ONUPORT

278

OCTET
STRING

Size (128)

Locates through the approach of

Cabinet

cabinet rack - shelf - slot - port

rack - shelf

number. Enter NA if the

- slot - port

corresponding information is not

number

specified.

Optional.

Version: 04

7 Integrated Query Interface

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter
Name

Data Type
OCTET

ONUIP

STRING
OCTET

OLTID

STRING

Value Range

Description

Size (128)

The input parameter will be returned.

Size (128)

The input parameter will be returned.

Size (128)
PONID

OCTET

Cabinet rack -

STRING

shelf - slot -

The input parameter will be returned.

port number
OCTET

ONUID

STRING

Size (128)

The input parameter will be returned.

Size (128)
ONUPORT

OCTET

Cabinet rack -

STRING

shelf - slot -

Locates card port through the approach of cabinet rack
- shelf - slot - port number. NA is displayed if no
information is located.

port number
ADMINSTATUS

STRING

UP

Management status.

DOWN

Example
For example, query the information of the No. 2 DSL port located in the No. 3 slot of the
ONU whose IP address is 10.250.18.121.
u

Command

LST-DSLPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-2:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 10:54:50
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------ONUIP

OLTID

10.250.18.121

PONID

ONUID

ONUPORT ADMINSTATUS

--

--

--

NA-NA-3-2

--

----------------------------------------------------------Version: 04

279

Northbound Interface TL1 User Manual

Related Command
None

7.2.6

Querying the Port VLAN Information (LST-PORTVLAN)

Function Description
This command is used for querying the port VLAN information of a specified ONU.

Command Format
LST-PORTVLAN::ONUIP=onu-name|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::;

u

Query the port VLAN information of the ONU that has a management IP address:

LST-PORTVLAN::ONUIP=onu-name[,ONUPORT=onu-port]:CTAG::;

u

Query the port VLAN information of the ONU that has no management IP address:

LST-PORTVLAN::(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter
Name
ONUIP

OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Size (128)

Size (128)
Size (128)

PONID

OCTET
STRING

Cabinet rack shelf - slot PON port
number

280

ONUID-

OCTET

TYPE

STRING

Size (128)

Description
IP address or name of the ONU that has a
management IP address.
OLT IP address or name.
PON port information location. Locate through the
approach of cabinet rack - shelf - slot - port number.
Enter NA if the corresponding information is not
specified.
ONU identifier type (ONU_NAME, MAC, LOID,
ONU_NUMBER).

Version: 04

7 Integrated Query Interface

Parameter
Name

ONUID

Data Type

OCTET
STRING

Value Range

ONU identifier, used for uniquely identifying the
Size (128)

ONU connected to the PON port. The value is
ONU_NAME, MAC, LOID or ONU_NUMBER.

Size (128)
ONUPORT

Description

OCTET

Cabinet rack -

STRING

shelf - slot port number

Locates through the approach of cabinet rack - shelf
- slot - port number. Enter NA if the corresponding
information is not specified.
Locates the card through the approach of cabinet

Size (128)
PORTID

OCTET

Cabinet rack -

STRING

shelf - slot port number

rack - shelf - slot - port number. Enter NA if the
corresponding information is not specified. To only
specify the shelf number, enter it in format of NA-0NA-NA. To specify the card, enter it in format of
NA-0-6-NA. To specify the port number, enter it in
format of NA-0-6-5.

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter
Name
ONUIP
OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Description

Size (128)

The input parameter will be returned.

Size (128)

The input parameter will be returned.

Size (128)
PONID

OCTET

Cabinet rack -

STRING

shelf - slot -

The input parameter will be returned.

port number
ONUID

OCTET
STRING

Size (128)
Size (128)

ONUPORT

OCTET

Cabinet rack -

STRING

shelf - slot port number

Version: 04

The input parameter will be returned.

Locates card port through the approach of cabinet
rack - shelf - slot - port number. NA is displayed if no
information is located.

SVLAN

INTEGER

0 - 4095

SVLAN

CVLAN

INTEGER

0 - 4095

CVLAN

VPI

INTEGER

0 - 65535

VPI
281

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

VCI

INTEGER

0 - 65535

VCI

UV

INTEGER

0 - 4095

VLAN at user side

Name

Example
Example 1, query the VLAN information of the No. 1 port on the ONU (having no
management IP address) with ONUID being whdx04. The ONU is connected to the shelf 0
- slot 4- PON 1 port of the OLT whose IP address is 10.250.18.102.
u

Command

LST-PORTVLAN::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 11:07:15
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=2

----------------------------------------------------------ONUIP OLTID

PONID

ONUID

ONUPORT SVLAN

CVLAN

VPI

whdx04

NA-NA-NA-1

--

NA-1-4-1 whdx04

NA-NA-NA-1

VCI

UV
--

10.250.18.102

123

--

--

10.250.18.102

--

--

---

NA-1-4-1

123
--

--

-----------------------------------------------------------

Example 2, query the service port information of the LAN 1 port on the ONU (having a
management IP address) whose IP address is 10.250.18.121. The ONU is connected to the
shelf 0 - slot 4 - port 1 of the OLT.
u

Command

LST-PORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 10:55:10
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

----------------------------------------------------------282

Version: 04

7 Integrated Query Interface

ONUIP OLTID PONID ONUID ONUPORT SVLAN

CVLAN

VPI

VCI

UV
10.250.18.121
--

--

--

--

NA-NA-4-1

569

--

--

--

-----------------------------------------------------------

Related Command
None

7.2.7

Querying the VLAN Information (LST-VLAN)

Function Description
This command is used for querying the VLAN information.

Command Format
LST-VLAN::ONUIP=onu-name|OLTID=olt-name:CTAG::[VLAN=vlanid];

Input Parameter
Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OLTID

OCTET STRING

Size (128)

IP address or name of the OLT

VLAN

INTEGER

0 to 4094

VLANID

Description
IP address or name of the ONU that
has a management IP address

Response Format
It complies with the query command response format in Response Message Format.

Output Parameter

Version: 04

Parameter

Data Type

Value Range

ONUIP

OCTET STRING

Size (128)

OLTID

OCTET STRING

Size (128)

VLAN

INTEGER

0 to 4094

Description
The input parameter will be
returned.
The input parameter will be
returned.
VLAN ID

283

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

DESC

OCTET STRING

Size (128)

VLAN alias

COMMON
VLANMODE

STACKING

OCTET STRING

VLAN attribute

QINQ
PORTLIST
MVLANFLAG
MVLANPRI

Rack - shelf - slot -

OCTET STRING

Port list

port number

Indicates whether it is a multicast

INTEGER

-

INTEGER

0 to 7

VLAN or non-multicast VLAN.
Priority of the IGMP message

HSI (Internet access)
SERVICE

IPTV (unicast)

OCTET STRING

Service type of the VLAN

VOIP (voice)

Example
Query the VLAN information of the OLT whose IP address is 10.78.200.200 (the ONU has
no management IP address).
u

Command issued

LST-VLAN::OLTID=10.78.200.200:CTAG::;

u

Response message

FH_10.98.12.1 2014-06-13 14:33:36
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=38

------------------------------------------------------ONUIP OLTIP VLAN DESC VLANMODE PORTLIST MULANFLAG MVLANPRI SERVICE

284

--

10.78.200.200

2

--

-- 1-1-19-1

0

0

HSI

--

10.78.200.200

3

--

--

--

0

0

HSI

--

10.78.200.200

50

--

-- 1-1-19-1

0

0

HSI

--

10.78.200.200

122

--

10.78.200.200

224

--

-- 1-1-19-1

--

10.78.200.200

225

--

--

--

0

0

IPTV

--

10.78.200.200

226

--

--

--

0

0

IPTV

--

10.78.200.200

333

--

-- 1-1-19-1

--

10.78.200.200

1111

--

-- 1-1-19-1

0

0

VOIP

--

10.78.200.200

2006

--

-- 1-1-19-1

0

0

VOIP

--

-- 1-1-19-1

0

0

0

HSI

0

0

IPTV

0

HSI

Version: 04

7 Integrated Query Interface

--

10.78.200.200

2008

--

-- 1-1-19-1

--

10.78.200.200

2222

--

-- 1-1-19-1

0

0

HSI

--

10.78.200.200

2223

--

--

0

0

HSI

--

10.78.200.200

3333

--

-- 1-1-19-1

0

0

VOIP

--

10.78.200.200

3334

--

-- 1-1-19-1

0

0

HSI

--

10.78.200.200

3997

--

-- 1-1-19-1

0

0

VOIP

--

10.78.200.200

3998

--

-- 1-1-19-1

0

0

--

--

10.78.200.200

3999

--

-- --

--

10.78.200.200

4001

--

-- 1-1-19-1

--

10.78.200.200

4002

--

-- --

0

0

HSI

--

10.78.200.200

4003

--

-- --

0

0

HSI

--

10.78.200.200

4004

--

-- --

0

0

HSI

--

10.78.200.200

4005

--

-- --

0

0

HSI

--

10.78.200.200

4006

--

-- --

0

0

HSI

--

10.78.200.200

4007

--

-- --

0

0

HSI

--

10.78.200.200

4008

--

-- --

0

0

HSI

--

10.78.200.200

4009

--

-- --

0

0

HSI

--

10.78.200.200

4010

--

-- --

0

0

--

10.78.200.200

4011

--

-- 1-1-19-1

--

10.78.200.200

4012

--

-- --

0

0

IPTV

--

10.78.200.200

4013

--

-- --

0

0

IPTV

--

10.78.200.200

4014

--

-- --

0

0

IPTV

--

10.78.200.200

4015

--

-- --

0

0

IPTV

--

10.78.200.200

4016

--

-- --

0

0

IPTV

--

10.78.200.200

4017

--

-- --

0

0

IPTV

--

10.78.200.200

4018

--

-- --

0

0

IPTV

--

10.78.200.200

4019

--

-- --

0

0

IPTV

--

10.78.200.200

4020

--

-- --

0

0

IPTV

--

0

0

0

0

VOIP

--

0

0

HSI

HSI
0

0

IPTV

------------------------------------------------;
---------

Related Command
None

Version: 04

285

Northbound Interface TL1 User Manual

7.2.8

Querying the ONU Port Service Information (LSTONUSERVICESTATUS)

Function Description
This command is used for querying the broadband and voice services configured on a
specified ONU.

Command Format
LST-ONUSERVICESTATUS::ONUIP=onu-name|OLTID=oltname,
PONID=ponport_location,ONUIDTYPE=onuid-type,ONUID=onu-index:CTAG::;

Supported Equipment
u

OLT: AN5516 series, AN5116 series.

u

ONU: AN5006 series, AN5506 series, HG series.

Input Parameter
Parameter

Data Type

Name
ONUIP
OLTID

OCTET
STRING
OCTET
STRING

Value
Range
Size (128)
Size (128)

Description

IP address or name of the ONU that has a management IP
address.
OLT IP address or name.

Size (128)
PONID

OCTET
STRING

Cabinet rack

PON port information location. Locate through the

- shelf - slot -

approach of cabinet rack - shelf - slot - PON port number.

PON port

Enter NA if the corresponding information is not specified.

number
ONUID-

OCTET

TYPE

STRING

ONUID

OCTET
STRING

Size (128)

ONU_NAME, MAC, LOID, ONU_NUMBER
ONU identifier. The value is ONU_NAME, MAC, LOID or

Size (128)

ONU_NUMBER. It is used for uniquely identifying the
ONU connected to the PON port.

Response Format
It complies with the query-command response format in Response Message Format.

286

Version: 04

7 Integrated Query Interface

Output Parameter
Parameter
Name
ONUIP
OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Description

Size (128)

The input parameter will be returned.

Size (128)

The input parameter will be returned.

Size (128)
PONID

OCTET

Cabinet rack -

STRING

shelf - slot - port

The input parameter will be returned.

number
ONUID
DATASERVICE
VOICESERVICE

OCTET

Size (128)

The input parameter will be returned.

INTEGER

0 - 24

Number of broadband services

INTEGER

0 - 24

Number of voice services

STRING

Example
For example, query the port service information of the ONU (having no management IP
address) with ONUID being FHTT01e821a0. The ONU is connected to the shelf 0 - slot 7 PON 4 port of the OLT whose IP address is 10.78.200.200.
u

Command

LST-ONUSERVICESTATUS::OLTID=10.78.200.200,PONID=NA-NA-7-4,
ONUIDTYPE=MAC,ONUID=FHTT01e821a0:CTAG::;

u

Response Message
FH_10.78.12.155 2014-07-15 18:54:10

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

list of ONU service status:
------------------------------------------------------ONUIP OLTIP PONID ONUID DATASERVICE VOICESERVICE
-Version: 04

10.78.200.200

1-1-7-4

FHTT01e821a0

0

0
287

Northbound Interface TL1 User Manual

------------------------------------------------------;

Related Command
None

7.2.9

Querying the VLAN Service Port (LST-SERVICEPORT)

Function Description
This command is used for querying the VLAN service port.

Command Format
LST-SERVICEPORT::OLTID=olt-name:CTAG::[VLAN=cvlan,][SVLAN=svlan,]
[PORTTYPE=porttype];

Input Parameter
Value

Parameter

Data Type

OLTID

OCTET STRING

Size (128)

CVLAN

INTEGER

0 to 4095

Inner VLAN

Optional

SVLAN

INTEGER

0 to 4095

Outer VLAN

Optional

Range

Description
IP address or name of
the OLT

Remark
Required

Port type
PORTTYPE

OCTET STRING

Size (128)

FXS: voice user port

(Optional) The default

LAN: data user port

value is FXS.

ALL: all user ports

Response Format
It complies with the query command response format in Response Message Format.

288

Version: 04

7 Integrated Query Interface

Output Parameter
Parameter

Data Type

Value Range

Description

OLTID

OCTET STRING

Size (128)

IP address or name of the OLT
PON port location information.

PONID

OCTET STRING

Size (128)

Locate a port through rack - shelf -

Rack - shelf - slot -

slot - PON port number. Enter NA

PON port number

for the corresponding unspecified
information.

ONUID

INTEGER

0 to 512

ONU authorization number

ONUPORT

INTEGER

0 to 512

ONU port number

CVLAN

INTEGER

0 to 4095

Inner VLAN

SVLAN

INTEGER

0 to 4095

Outer VLAN. "–" is displayed for
single-tagged VLAN configuration
scenario.
Port type
PORTTYPE

OCTET STRING

Size (128)

FXS: voice port
LAN: data port

Example
Query the information of the VLAN service port of the OLT with the IP address
172.29.215.4.
u

Command issued

LST-SERVICEPORT::OLTID=172.29.215.4:CTAG::VLAN=3333;

u

Response message
FH_172.29.215.4 2015-03-06 15:42:18

M CTAG COMPLD
total_blocks=1
block_number=1
block_records=3
OLTID PONID ONUIDTYPE ONUNO PORTID VLANID PORTTYPE
172.29.215.4 1-1-1-7 MAC 1 1-1-1-1 3333 FXS
172.29.215.4 1-1-1-7 MAC 2 1-1-1-1 3333 FXS
172.29.215.4 1-1-1-7 MAC 3 1-1-1-2 3333 FXS

Related Command
None
Version: 04

289

Northbound Interface TL1 User Manual

7.2.10

Querying the Flow Policy (LST-PORTPVCFLOWPOLICY)

Function Description
This command is used for querying the PORTPVCFLOWPOLICY information.

Command Format
LST-PORTPVCFLOWPOLICY::ONUIP=|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::;

Supported Equipment
ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter
Name
ONUIP

OLTID

PONID

Data Type
OCTET
STRING
OCTET

Size (128)

IP address or name of the ONU that has a
management IP address.
OLT IP address or name.

Size (128)

PON port information location. Locate through the

OCTET

Cabinet rack -

approach of cabinet rack - shelf - slot - port

STRING

shelf - slot - PON

number. Enter NA if the corresponding

port number

information is not specified.

OCTET

TYPE

STRING
OCTET
STRING

Size (128)

ONU identifier type (ONU_NAME, MAC, LOID,
ONU_NUMBER).
ONU identifier, used for uniquely identifying the

Size (128)

ONU connected to the PON port. The value is
ONU_NAME, MAC, LOID or ONU_NUMBER.

Size (128)
ONUPORT

Description

Size (128)

STRING

ONUID-

ONUID

Value Range

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

Locates through the approach of cabinet rack shelf - slot - port number. Enter NA if the
corresponding information is not specified.
Locates the card through the approach of cabinet

Size (128)
PORTID

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

rack - shelf - slot - port number. Enter NA if the
corresponding information is not specified. To
only specify the shelf number, enter it in format of
NA-0-NA-NA. To specify the card, enter it in
format of NA-0-6-NA. To specify the port number,
enter it in format of NA-0-6-5.

290

Version: 04

7 Integrated Query Interface

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter
Name
ONUIP
OLTID
VLAN
DESC

Data Type
OCTET
STRING
OCTET
STRING
INTEGER
OCTET
STRING

VLAN-

OCTET

MODE

STRING

PORTLIST

MVLANFLAG
MVLANPRI

Value Range

Description

Size (128)

The input parameter will be returned.

Size (128)

The input parameter will be returned.

0 - 4094

VLANID

Size (128)

VLAN alias

COMMON
STACKING
QINQ

OCTET

Cabinet rack - shelf

STRING

- slot - port number
0: Non-multicast

INTEGER

VLAN
1: Multicast VLAN

INTEGER

VLAN attribute.

0-7

Port list.

Indicates whether it is a multicast VLAN or nonmulticast VLAN.
Priority level of the IGMP message.

HSI (Internet
SERVICE

OCTET

access)

STRING

IPTV (unicast)

Service type of the VLAN

VOIP (voice)

Example
For example,
u

Command

LST-PORTPVCFLOWPOLICY::ONUIP=172.28.148.58,ONUPORT=1-1-2-63:CTAG::;

u

Response Message

FH_10.62.165.42 2015-03-19 01:55:32
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=8
Version: 04

291

Northbound Interface TL1 User Manual

list of port pvc flow policy
-------------------------------------------------------------------------------PVCNO UPFLOWPOLICYID DOWNFLOWPOLICYID CIRUP CIRDOWN
0 ubrPcr_1024K ubrPcr_1024K 1024 1024
1 ubrPcr_1024K ubrPcr_1024K 1024 1024
2 -- -- -- -3 -- -- -- -4 -- -- -- -5 -- -- -- -6 -- -- -- -7 -- -- -- ---------------------------------------------------------------------------------

Related Command
None

7.2.11

Querying the Template Information (RTRV-TEMPLATEALL)

Function Description
This command is used for querying the PORTPVCFLOWPOLICY information.

Command Format
RTRV-TEMPLATE-ALL::ONUIP=onu-name|OLTID=olt-name:CTAG::;

Supported Equipment
ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter
Name
ONUIP
OLTID

292

Data Type
OCTET
STRING
OCTET
STRING

Value
Range
Size (128)
Size (128)

Description
IP address or name of the ONU that has a management
IP address.
OLT IP address or name.

Version: 04

7 Integrated Query Interface

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter
Name
ONUIP
OLTID

Data Type
OCTET
STRING
OCTET
STRING

Value Range

Description

Size (128)

The input parameter will be returned.

Size (128)

The input parameter will be returned.

Example
For example,
u

Command

RTRV-TEMPLATE-ALL::ONUIP=172.28.148.58:CTAG::;

u

Response Message

FH_10.62.165.42 2015-03-19 01:58:44
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=48

-------------------------------------------------------------------------------TEMPLATENAME DOWNMAXBW UPMAXBW CHANNELMODE
NULL 0 0 0
P_03584_1024 3584 1024 0
P_05120_1280 5120 1280 0
P_05632_1024 5632 1024 0
P_07168_1280 7168 1280 0
P_07680_1536 7680 1536 0
P_100M_50M 102400 51200 0
P_1024_256 1024 256 0
P_1024_512 1024 512 0
P_10M_2M 10240 2048 0
.....

Version: 04

293

Northbound Interface TL1 User Manual

Related Command
None

7.2.12

Querying the Port Template Information (RTRVTEMPLATE-PORT)

Function Description
This command is used for querying the port template information of a specified device.

Command Format
RTRV-TEMPLATE-PORT::ONUIP=onu-name|(OLTID=oltname,
PONID=ponport_location,ONUIDTYPE=onuid-type,ONUID=onu-index)[,
ONUPORT=onuport]:CTAG::;

Supported Equipment
ONU: AN5006-20, AN5006-30.

Input Parameter
Parameter
Name
ONUIP

OLTID

PONID

OCTET
STRING
OCTET

Value Range

Size (128)

Description
IP address or name of the ONU that has a
management IP address.

Size (128)

OLT IP address or name.

Size (128)

PON port information location. Locate through

OCTET

Cabinet rack -

the approach of cabinet rack - shelf - slot - port

STRING

shelf - slot - PON

number. Enter NA if the corresponding

port number

information is not specified.

STRING

ONUID-

OCTET

TYPE

STRING

ONUID

294

Data Type

OCTET
STRING

Size (128)

ONU identifier type (ONU_NAME, MAC, LOID,
ONU_NUMBER).
ONU identifier, used for uniquely identifying the

Size (128)

ONU connected to the PON port. The value is
ONU_NAME, MAC, LOID or ONU_NUMBER.

Version: 04

7 Integrated Query Interface

Parameter
Name

Data Type

Value Range
Size (128)

ONUPORT

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

Description
Locates through the approach of cabinet rack shelf - slot - port number. Enter NA if the
corresponding information is not specified.
Locates the card through the approach of cabinet

Size (128)
PORTID

OCTET

Cabinet rack -

STRING

shelf - slot - port
number

rack - shelf - slot - port number. Enter NA if the
corresponding information is not specified. To
only specify the shelf number, enter it in format of
NA-0-NA-NA. To specify the card, enter it in
format of NA-0-6-NA. To specify the port
number, enter it in format of NA-0-6-5.

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter
Name
ONUIP
OLTID
VLAN
DESC

VLANMODE

PORTLIST

MVLANFLAG
MVLANPRI

SERVICE

Version: 04

Data Type
OCTET
STRING
OCTET
STRING
INTEGER
OCTET
STRING
OCTET
STRING

Value Range

Description

Size (128)

The input parameter will be returned.

Size (128)

The input parameter will be returned.

0 - 4094

VLANID

Size (128)

VLAN alias

COMMON
STACKING

OCTET

Cabinet rack - shelf -

STRING

slot - port number
0: Non-multicast

INTEGER

VLAN
1: Multicast VLAN

INTEGER
OCTET
STRING

VLAN attribute.

QINQ

0-7

Port list.

Indicates whether it is a multicast VLAN or
non-multicast VLAN.
Priority level of the IGMP message.

HSI (Internet access)
IPTV (unicast)

Service type of the VLAN

VOIP (voice)

295

Northbound Interface TL1 User Manual

Example
Command
RTRV-TEMPLATE-PORT::ONUIP=172.28.148.55,ONUPORT=1-1-2-4:CTAG::;

Response Message
FH_10.62.165.42 2015-03-19 02:00:52
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

-------------------------------------------------------------------------------TEMPLATENAME DOWNMAXBW UPMAXBW CHANNELMODE
P_03584_1024 3584 1024 0
--------------------------------------------------------------------------------

Related Command
ADD-FLOWPOLICY
LST-POTSINFO

7.3

Resource Change Notification
The following introduces the command and example for resource change notification.

7.3.1

Registering the Resource Change Notification
(SUBSCRIBE)

Function Description
This command is used for registering the resource change notification after the TCP
connection is successfully established. After the register successes, the FiberHome EMS
will report the change notification of the physical resources (device, subracks, cards, etc.) to
the OSS automatically.

296

Version: 04

7 Integrated Query Interface

Command Format
SUBSCRIBE:::CTAG::FLAG=flag;

Input Parameter
Data Type

Parameter

Value Range

Description
RES indicates registering the

FLAG

OCTET STRING

RES

reporting of resource change
notification.

Response Format
It complies with the response format in Resource Change Notification Format.

Output Parameter
None

Example
For example, register the resource change notification for the current user.
u

Command issued

SUBSCRIBE:::CTAG::FLAG=RES;

u

Response message

FH_10.250.18.133 2010-11-04 11:45:19
M

CTAG COMPLD
EN=0

ENDESC=No error

Related Command
UNSUBSCRIBE

Version: 04

297

Northbound Interface TL1 User Manual

7.3.2

Deregistering the Resource Change Notification
(UNSUBSCRIBE)

Function Description
After deregistering the resource change notification successfully, the FiberHome EMS will
not report the change notification of the physical resources (device, subracks, cards, etc.) to
the OSS automatically.

Command Format
UNSUBSCRIBE:::CTAG::FLAG=flag;

Input Parameter
Data Type

Parameter

Value Range

Description
RES indicates

FLAG

OCTET STRING

RES

registering the reporting
of resource change
notification.

Response Format
It complies with the response format in Resource Change Notification Format.

Output Parameter
None

Example
For example, deregister the resource change notification.
u

Command issued

UNSUBSCRIBE:::CTAG::FLAG=RES;

u

Response message
FH_10.250.18.133 2010-11-04 11:44:11

M

CTAG COMPLD
EN=0

298

ENDESC=No error

Version: 04

7 Integrated Query Interface

Related Command
SUBSCRIBE

7.3.3

Querying the Resource Change Notification (LSTRESNOTIFY)

Function Description
This command is used for querying the resource change notification reported.

Command Format
LST-RESNOTIFY:::CTAG::BEGINTIME=initial-time[,ENDTIME=last-time];

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

Start time in the format of
BEGINTIME

String

Size (32)

YYYY-MM-DD HH-MM-SS

Required

(Beijing time).
End time in the format of
ENDTIME

String

Size (32)

YYYY-MM-DD HH-MM-SS

Optional

(Beijing time).

Response Format
It complies with the response format in Resource Change Notification Format.

Output Parameter
Parameter

Data Type

Value Range

HAPPENTIME

OCTET STRING

Size (128)

Description
Resource change time in the
format of YYYY-MM-DD HH:
MM:SS.

ADD
MARK

OCTET STRING

DEL

Resource change cause

MOD

Version: 04

299

Northbound Interface TL1 User Manual

Data Type

Parameter

Value Range

Description

OLT
OBJECT

ONU

OCTET STRING

Resource object type

SHELF
BOARD

Resource change information.
INFO

See the Resource Change

Size (512)

OCTET STRING

Notification for the format of
returned information.

Example
Query the resource change notification information in a specified period of time.
u

Command issued

LST-RESNOTIFY:::2::BEGINTIME=2010-12-30 07-34-00,ENDTIME=2010-12-30 1000-00;

u

Response message

FH_10.250.18.133 2010-11-04 11:44:22
M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=12

list resource notify
----------------------------------------------------------HAPPENTIME MARK OBJECT
2010-11-01 11:15:18

INFO

ADD BOARD ONUIP=10.250.18.121

OLTID=0.0.0.0

PONID=-- ONUID=0 BOARDID=2-1-4

BOARDTYPE=ETH

BSERVICE=ETH

2010-11-01 11:15:34
OLTID=0.0.0.0

PWD=--

ADD

ONU

HWVER=--

OLTID=10.250.18.102

ONUNO=1 NAME=AN5006-10B DESC=-- ONUTYPE=AN5006-10B

AUTH=LOID MAC=544b10406b60

LOID=whdx10b

SWVER=--

2010-11-01 11:22:36 ADD

ONU

OLTID=10.250.18.102

PONID=3-1-4-1

ONUNO=2 NAME=AN5006-04

IP=0.0.0.0

AUTH=LOID

PWD=--

HWVER=--

ADD BOARD ONUIP=10.250.18.121

BSERVICE=-- PNUM=0 SWVER=--

2010-11-01 11:22:36
IP=0.0.0.0

SWVER=--

PONID=-- ONUID=0 BOARDID=2-1-801

BOARDTYPE=HCU-20
PONID=3-1-4-1

PNUM=16

DESC=-- ONUTYPE=AN5006-04

MAC=544b400c79a8 LOID=whdx04

SWVER=--

-----------------------------------------------------------

300

Version: 04

7 Integrated Query Interface

Related Command
SUBSCRIBE

7.3.4

Resource Change Notification Interface

Function Description
The resource change notification interface reports the notification messages upon adding /
modifying / deleting a device, adding / deleting a shelf as well as adding / deleting a card.

Command Format
None

Input Parameter
None

Response Format
It complies with the response format in Resource Change Notification Format.

Output Parameter
u

OLT adding / modifying / deleting notification: The resource change notification will
be reported only when the name of the OLT is changed.

Parameter

Data Type

Value Range

Description

DEVNAME

OCTET STRING

Size (128)

Device name

DEVIP

OCTET STRING

Size (128)

Device IP address

DT

OCTET STRING

Size (128)

Device model

DEVER

OCTET STRING

Size (128)

Software version

u

ONU adding / modifying / deleting notification: The resource change notification will
be reported only when the ONU name, description, authentication mode or
authentication information is changed.

Version: 04

301

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

OLTID

OCTET STRING

Size (128)

OLT IP address

Size (128)
PONID

OCTET STRING

Rack - shelf - slot port number

Locate a card through rack - shelf slot - port number. Enter NA for the
corresponding unspecified
information.

ONUNO

INTEGER

Size (128)

ONU authorization number

NAME

OCTET STRING

Size (128)

ONU name

DESC

OCTET STRING

Size (128)

ONU description information

ONUTYPE

SWVER

OCTET STRING

ONU type

IP

OCTET STRING

Size (128)

Management IP address of the ONU

MAC

Authentication mode. When no

LOID

authentication mode is specified, a

HYBRID

dash (–) will be returned.

AUTH

OCTET STRING

MAC

OCTET STRING

Size (128)

LOID

OCTET STRING

Size (64)

PWD

OCTET STRING

Size (128)

The registered MAC information of
the ONU.
When the MAC authentication is
adopted, a dash (–) will be returned.
LOID password. If no password is
specified, a dash (–) will be
returned.

SWVER

u

OCTET STRING

Size (128)

Software version

Shelf adding / deleting notification: The resource change notification will be reported
only when a shelf is added or deleted.

Parameter

Data Type

Value Range

Description
IP address of the ONU. When the

ONUIP

OCTET STRING

Size (128)

ONU has no IP address, the
OLTID, PONID and ONUID will
be reported.

OLTID

OCTET STRING

Size (128)
Size (128)

PONID

OCTET STRING

Rack - shelf - slot - port
number

ONUID

302

OCTET STRING

Size (128)

OLT IP address
Locate a card through rack - shelf slot - port number. Enter NA for the
corresponding unspecified
information.
ONU authorization number

Version: 04

7 Integrated Query Interface

Parameter

Data Type

Value Range

Description
Locate a shelf through rack - shelf

SHELFID

OCTET STRING

Size (128)

number. Enter NA for the

Rack - shelf number

corresponding unspecified
information.

SHELFTYPE

u

OCTET STRING

Size (128)

Shelf type

Card adding / deleting notification: The resource change notification will be reported
only when a card is added or deleted.

Parameter

Data Type

Value Range

Description
IP address of the ONU. When

ONUIP

OCTET STRING

Size (128)

the ONU has no IP address, the
OLTID, PONID and ONUID
will be reported.

OLTID

OCTET STRING

Size (128)
Size (128)

PONID

OCTET STRING

Rack - shelf - slot - port
number

ONUID

OCTET STRING

Size (128)

OLT IP address
Locate a card through rack shelf - slot - port number. Enter
NA for the corresponding
unspecified information.
ONU authorization number
Locate a card through rack shelf - slot. Enter NA for the

BOARDID

OCTET STRING

Size (128)

corresponding unspecified

Rack - shelf - slot

information. To only specify
the shelf number, enter NA-0NA.

BOARDTYPE

OCTET STRING

Size (128)

Card type

Power
ETH
ADSL
VDSL
POTS
BSERVICE

OCTET STRING

E1

Card service type

GPON
EPON
Control (main control
unit)
Other
PNUM

Version: 04

INTEGER

0 to 64

Number of ports

303

Northbound Interface TL1 User Manual

Parameter

Data Type

Value Range

Description

SWVER

OCTET STRING

Size (255)

Software version

HWVER

OCTET STRING

Size (255)

Hardware version

Example
Example 1: When the device with the IP address being 10.78.11.102 is added, the
corresponding resource change notification will be received.
u

Command issued
None

u

Response message
FH_10.98.11.77 2011-02-21 10:32:07

A

2 REPT RES ADD_OLT

DEVNAME=system 9

DEVIP=10.78.11.102

DT=AN5116-06B

DEVER=--

Example 2: When the ONU with ONUID being 123 is added, the corresponding resource
change notification will be received.
u

Command issued
None

u

Response message
FH_10.98.11.77 2011-02-21 10:35:42

A

9 REPT RES ADD_ONU

OLTID=10.78.11.118

PONID=4-1-14-1

DESC=-- ONUTYPE=AN5506-04-B
PWD=--

ONUNO=6 NAME=PON[1]-AN5506-04B[6]

IP=0.0.0.0 AUTH=HYBRID MAC=-- LOID=123

SWVER=--

Example 3: When a shelf is added for the OLT with the IP address being 10.78.11.102, the
corresponding resource change notification will be received.
u

Command issued
None

u

Response message

A

3 REPT RES ADD_SHELF

FH_10.98.11.77 2011-02-21 10:32:07
ONUIP=0.0.0.0

OLTID=10.78.11.102

PONID=-

ONUID=0 SHELFID=9-1

SHELFTYPE=AN5116-06B_NODE

304

Version: 04

7 Integrated Query Interface

Example 4: When a card is added in slot 9 of the OLT whose IP address is 10.78.11.102, the
corresponding resource change notification will be received.
u

Command issued
None

u

Response message

FH_10.98.11.77 2011-02-21 10:27:17
A

1 REPT RES ADD_BOARD

ONUIP=0.0.0.0

OLTID=10.78.11.102 PONID=--

7-1-9 BOARDTYPE=HSWA

BSERVICE=SCU PNUM=0

ONUID=--

SWVER=--

BOARDID=
HWVER=--

Related Command
SUBSCRIBE

7.4

Resource Data Full Export
The following introduces the command and example for full export of resource data.

7.4.1

Resource Full Export Interface (DUMP-RESOURCEINFO)

Function Description
This command is used for exporting the device information and service configuration
information in the entire network The exported file is named in format of
DUMP_RES_YYYY-MM-DD-HH-MM-SS.xml.

Command Format
DUMP-RESOURCEINFO:::CTAG::[RESTYPE=resource-type];

Input Parameter
Parameter

Data Type

Value Range

Description

Remark

Resource type
RESTYPE

OCTET STRING

PHY

PHY: device information

Optional

SRV

SRV: service configurations

Default value:

ALL

ALL: all device and service

ALL

configurations

Version: 04

305

Northbound Interface TL1 User Manual

Response Format
It complies with the response format in Resource Change Notification.

Output Parameter
Parameter

Data Type

Value Range

Description

FILENAME

OCTET STRING

Size (128)

File name

RESULT

OCTET STRING

Success
Failure

Export result

Example
When the physical resources in the entire network are exported, the corresponding
notification will be received, indicating the resource file is exported successfully.
u

Command issued

DUMP-RESOURCEINFO:::CTAG::;

u

Response message
FH_10.98.11.77 2010-11-21 09:48:21

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

dump resource info
----------------------------------------------------------FILENAME
DUMP_RES_2010-11-21-09-48-21.xml
-----------------------------------------------------------

Related Command
SUBSCRIBE
DUMP-RESOURCEINFO

7.4.2

Resource Full Export Notification

Function Description
It indicates the message notifying the export result of the reported data files.

306

Version: 04

7 Integrated Query Interface

Command Format
None

Input Parameter
None

Response Format
It complies with the response format in Resource Change Notification.

Output Parameter
Parameter

Data Type

Value Range

Description

FILENAME

OCTET STRING

Size (128)

File name.

RESULT

OCTET STRING

Success
Failure

Export result.

Example
For example, report the export result.
u

Command issued
None

u

Response message
FH_10.98.11.77 2010-11-21 09:48:58

A

-- REPT RES DUMP_FILE

FILENAME=DUMP_RES_2010-11-21-09-48-21.xml

RESULT=Success

Related Command
DUMPRE-RESNOTIFY

Version: 04

307

8

Integrated Alarm Interface
The following introduces the commands for subscribing to the alarm, setting alarm filter
conditions, obtaining alarms, confirming alarms and clearing alarms.

8.1

Subscribing to Alarms (SUBSCRIBE)

Function Description
This command is used for subscribing to alarms after the TCP connection is successfully
established. After the subscription successes, the FiberHome EMS will receive alarms
automatically and report them to the OSS in real time.
For supported alarms, see The List of Alarms.

Command Format
SUBSCRIBE:::CTAG::;

Input Parameter
None

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, subscribe to the alarm.
u

Command issued

SUBSCRIBE:::CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 09:50:30
308

Version: 04

8 Integrated Alarm Interface

M

CTAG COMPLD

EN=0

ENDESC=No error

Related Command
None

8.2

Enabling the Alarm Filter (ACT-ALARM-FILTER)

Function Description
This command is used for enabling the alarm filter function.

Note:
To enable the alarm filter function, first execute the "CHG-ALARM-FILTER"
command to configure the alarm filter conditions and then execute the "ACTALARM-FILTER" command to make the alarm filter conditions take effect.
Command Format
ACT-ALARM-FILTER:::CTAG::;

Input Parameter
None

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
Success or failure.

Example
For example, enable the alarm filter conditions.
u

Command issued

ACT-ALARM-FILTER:::CTAG::;
Version: 04

309

Northbound Interface TL1 User Manual

u

Response message
FH_10.250.18.133 2010-11-04 10:31:47

M

CTAG COMPLD
EN=0

ENDESC=No error

Related Command
DACT-ALARM-FILTER

8.3

Disabling the Alarm Filter (DACT-ALARMFILTER)

Function Description
This command is used for disabling the alarm filter function.

Command Format
DACT-ALARM-FILTER:::CTAG::;

Input Parameter
None

Response Format
It complies with the operation-command response format in Response Message Format.

Output Parameter
None

Example
For example, disable the alarm filter conditions.
u

Command issued

DACT-ALARM-FILTER:::CTAG::;

u

Response message
FH_10.250.18.133 2010-11-04 09:50:38

M

CTAG COMPLD
EN=0

310

ENDESC=No error
Version: 04

8 Integrated Alarm Interface

Related Command
ACT-ALARM-FILTER

8.4

Modifying the Alarm Filter Configuration (CHGALARM-FILTER)

Function Description
This command is used for modifying the alarm filter conditions and configure the alarms to
be reported.

Note:
After executing this command, it is required to execute the "ACT-ALARMFILTER" command to make the alarm filter conditions take effect.
Command Format
CHG-ALARM-FILTER:::CTAG::[ALARMID=alarmcode][,SEVERITY=alarm-severity];

Supported Equipment
u

Equipment type: all

u

Equipment version: all

Input Parameter
Parameter

Data

Name

Type

Value Range

Parameter Description

Critical
SEVERITY

String

Major

Alarm level. Multiple alarm levels can be configured

Minor

and should be separated by vertical bars.

Warning
ALARMID

String

Size (0 to 1000)

Alarm ID. Multiple alarm IDs can be configured and
should be separated by vertical bars.

Response Format
It complies with the operation-command response format in Response Message Format.
Version: 04

311

Northbound Interface TL1 User Manual

Output Parameter
Success or failure.

Example
For example, modify the alarm filter conditions to only query and subscribe to the alarm
whose ID is 310009.
u

Command

CHG-ALARM-FILTER:::CTAG:: ALARMID=310009;

u

Response Message
FH_10.250.18.133 2010-11-04 09:50:47

M

CTAG COMPLD
EN=0

ENDESC=No error

Related Command
ACT-ALARM-FILTER

8.5

Viewing the Alarm Filter Configuration (LSTALARM-FILTER)

Function Description
This command is used for viewing the current alarm filter conditions.

Command Format
LST-ALARM-FILTER:::CTAG::;

Supported Equipment
u

Equipment type: all

u

Equipment version: all

Input Parameter
None

312

Version: 04

8 Integrated Alarm Interface

Response Format
It complies with the query-command response format in Response Message Format.

Output Parameter
Parameter

Data

Value

Name

Type

Range

ENABLE

String

True

Description

Enable / Disable.

false
Critical

SEVERITY

String

Major

Alarm level. Multiple alarm levels can be configured and

Minor

should be separated by vertical bars.

Warning
ALARMCODE

String

Size (0 -

Alarm ID. Multiple alarm IDs can be configured and

1000)

should be separated by vertical bars.

Example
For example, view the current alarm filter conditions.
u

Command

LST-ALARM-FILTER:::CTAG::;

u

Response Message
FH_10.250.18.133 2010-11-04 09:51:00

M

CTAG COMPLD
total_blocks=1
block_number=1
block_records=1

Alarm Filter
ENABLE

SEVERITY

false

ALARMCODE
-

310009

Related Command
CHG-ALARM-FILTER

Version: 04

313

Northbound Interface TL1 User Manual

8.6

Querying Alarms (LST-ALARM)

Function Description
This command is used for querying the alarm information in the specified time of period
(including the recovered or unrecovered alarms).
For supported alarms, see The List of Alarms.

Command Format
LST-ALARM::[ONUIP=onu-name]|([OLTID=olt-name][,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu-index]):CTAG::BEGINTIME=begin-time[,
ENDTIME=end-time][,FAULTFLAG=flag];

u

Query the ONU

4 The ONU that has a management IP address:
LST-ALARM::ONUIP=onu-name:CTAG::BEGINTIME=begin-time[,ENDTIME=end-time]
[,FAULTFLAG=flag];

4 The ONU that has no management IP address:
LST-ALARM::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=id-type,
ONUID=onu-index:CTAG::BEGINTIME=begin-time[,ENDTIME=end-time][,
FAULTFLAG=flag] ;

4 The OLT PON port:
LST-ALARM::OLTID=olt-name,PONID=ponport_location:CTAG::BEGINTIME=begintime[,ENDTIME=end-time][,FAULTFLAG=flag];

u

Query the OLT:

LST-ALARM::OLTID=olt-name:CTAG::BEGINTIME=begin-time[,ENDTIME=end-time]
[,FAULTFLAG=flag];

u

Query all:

LST-ALARM:::CTAG::BEGINTIME=begin-time[,ENDTIME=end-time][,
FAULTFLAG=flag];

Supported Equipment

314

u

Equipment type: all

u

Equipment version: all

Version: 04

8 Integrated Alarm Interface

Input Parameter
Parameter
Name

Data Type

Value Range

Description

Remark
It is required when

ONUIP

OCTET
STRING

Size (128)

IP address, name or ID of the ONU that
has a management IP address.

querying the ONU
that has no
management IP
address.
It is required when

OLTID

OCTET
STRING

querying the OLT or
Size (128)

OLT IP address, name or ID.

the ONU that has no
management IP
address.

PONID

Size (128)

PON port information location. Locating

OCTET

Cabinet rack -

through the approach of cabinet rack - shelf

STRING

shelf - slot - PON

- slot - PON port number. NA is displayed

port number

if no information is located.

OCTET

MAC

ONU identifier type (ONU_NAME, MAC,

STRING

LOID

LOID, ONU_NUMBER).

ONU_NUMBER

ONUID

STRING

Size (128)

identifying the ONU connected to the PON
port. The value is ONU_NAME, MAC,
LOID or ONU_NUMBER.

BEGINTIME

String

Size (32)

ENDTIME

String

Size (32)

FAULTFLAG

STRING

Fault-Only
ALL

that has no
management IP
address.
querying the ONU
that has no
management IP
address.

ONU identifier, used for uniquely
OCTET

querying the ONU

It is required when

ONU_NAME
ONUIDTYPE

It is required when

The format of start time (Beijing time):
YYYY-MM-DD HH-MM-SS.
The format of end time (Beijing time):
YYYY-MM-DD HH-MM-SS.

It is required when
querying the ONU
that has no
management IP
address.
Required.
Optional.

Alarm status. Default value is Fault-Only.
Fault-Only contains events and does not

Optional.

contain recovered alarms.

Response Format
It complies with the query-command response format in Response Message Format.

Version: 04

315

Northbound Interface TL1 User Manual

Output Parameter
Parameter

Data Type

Value Range

Required / Optional

Description

SERIALID

String

Size (0 - 100)

Required.

Alarm ID.

ALARMNAME

String

Size (0 - 256)

Required.

DIP

String

IP address

Required.

NE IP address.

DNAME

String

Size (0 - 100)

Required.

NE name.

DTYPE

String

Size (0 - 100)

Required.

NE type.

Name

RACK: rackid

RACK: rack

SLOT: slotid

SHELF: shelf

PORT: portid

SLOT: slot

ONUNUM:

PORT: port number

onunumber
POSITION

String

onuname

code parameter (ALARMID).

The position that triggers the alarm.

SHELF: shelfid

ONUNAME:

Alarm name, corresponding to the alarm

ONUNUM: ONU number
Required.

ONUNAME: ONU name
ONUPORTTYPE: ONU port type (LAN,

ONUPORTTYPE:

E1, DSL, POTS and PON)

onuporttype

ONUPORT: ONU port number

ONUPORT:

EMUNUM: environment monitoring unit

onuportid

AUTHINFO: ONU authentication

EMUNUM:

information (MAC or LOID)

emunum
Critical
SEVERITY

String

Major
Minor

Required.

Alarm Level

Required.

Alarm status

Warning
Fault
FaultFlag

String

Recovery
Event

HAPPENTIME
RECOVERTIME

316

String

Size (0 - 32)

Required.

String

Size (0 - 32)

Optional.

Alarm generation time. Format: YYYYMM-DD HH:MM:SS.
Alarm recovery time. Format: YYYY-MMDD HH:MM:SS.

Version: 04

8 Integrated Alarm Interface

Parameter
Name

Data Type

Value Range

Required / Optional

Description

Required.

Alarm type.

communicationsAlarm,
qualityOfServiceAlarm,
ALARMTYPE

processingErrorA-

String

larm,
equipmentAlarm
and
environmentalAlarm.

Additional information, describing

AditionalInfo

String

Size (0 - 256)

Optional.

ALARMID

Integer

-

Optional.

String

Size (0 - 256)

Optional.

Alarm reason.

Integer

-

Optional.

Alarm reason code.

String

Size (0 - 512)

Optional.

Handling suggestion.

PROBABLE_
CAUSE _DESC
PROBABEL_
CAUSE_CODE
PROPOSED_
ADVISE

additional information related to the alarm.
Alarm code, corresponding to the alarm
name parameter (ALARMDESC).

Example
For example, query all the alarms and events occurred after 2014-09-09 00:00:00 (for the
response messages, only some of them are listed as as example).
u

Command

LST-ALARM:::CTAG::BEGINTIME=2010-12-28 01-00-00,FAULTFLAG=ALL;

u

Response Message

FH_10.250.18.133 2010-11-04 09:51:13
M

CTAG COMPLD
total_blocks=2
block_number=1
block_records=3

Alarm
-

Version: 04

SERIALID

ALARMNAME

DIP

DNAME

SEVERITY

FaultFlag

HAPPENTIME

DTYPE

POSITION

RECOVERTIME

317

Northbound Interface TL1 User Manual

ALARMTYPE

ADITIONALINFO

EVENT_CODE

PROBABLE_CAUSE_DESC
135 ONU H.248 broken link

10.250.18.100

system1

AN5516_01

RACK:NA,SHELF:NA,SLOT:3,PORT:1,ONUNUM:5,ONUNAME:AN5006-04
Critical

Faul2010-11-01 14:51:51

CommunicationAlarm

--

320001

--

ONU H.248 broken link

6 OLT PON pot has no optical signal 10.250.18.100

AN5006-04[1] system1

RACK:NA,SHELF:NA,SLOT:3,PORT:1,ONUNUM:1,ONUNAME:AN5006-04[1]
Critical

Recovery

2010-10-28 15:02:17 2010-11-03

00:15:39

CommunicationAlarm

--

310004

(1)Backbone fiber breaks

Related Command
CHG-ALARM-FILTER
ACT-ALARM-FILTER

8.7

Confirming an Alarm (ACK-ALARM)

Function Description
Confirming an alarm means the alarm is already processed or is to be processed. When an
alarm is confirmed, it changes from the unconfirmed status into the confirmed status.

Command Format
ACK-ALARM::ALARMID=alarm-ID:CTAG::;

Supported Equipment
u

Equipment type: all

u

Equipment version: all

Input Parameter
Parameter
Name
ALARMID

Data Type

String

Value
Range
Size (0 - 32)

Description
Alarm ID, corresponding to the returned field ALARMID
of the LST-ALARM command.

Response Format
It complies with the operation-command response format in Response Message Format.
318

Version: 04

8 Integrated Alarm Interface

Output Parameter
Success or failure.

Example
For example, confirm the alarm whose ID is 95.
u

Command

ACK-ALARM::ALARMID=95:CTAG::;

u

Response Message

FH_10.250.18.133 2010-11-04 09:50:30
M

CTAG COMPLD

EN=0

ENDESC=No error

Related Command
UNACK-ALARM

8.8

Canceling the Confirmation for an Alarm
(UNACK-ALARM)

Function Description
This command is used for canceling the confirmation operation performed on an alarm so
as to re-focus on the alarm. After the cancellation, the alarm changes from the confirmed
status to the unconfirmed status.

Command Format
UNACK-ALARM::SERIALID=SERIAL-ID:CTAG::;

Input Parameter
Parameter

Data Type

Value Range

SERIALID

String

Size (0 to 32)

Description
Alarm ID, corresponding to the
returned field SERIALID of the
"LST-ALARM" command.

Version: 04

319

Northbound Interface TL1 User Manual

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
Success or failure.

Example
Cancel the confirmation performed on the alarm whose ID is 12429.
u

Command issued

UNACK-ALARM::SERIALID=12429:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 09:50:30
M

CTAG COMPLD

EN=0

ENDESC=No error

Related Command
ACK-ALARM

8.9

Clearing an Alarm (CLR-ALARM)

Function Description
This command is used to delete alarms manually when the alarms cannot be automatically
cleared or they no longer exist on the NE.

Prerequisite
Make sure the failure resulting in the alarm is eliminated before executing the command.

Command Format
CLR-ALARM:: SERIALID =SERIAL-ID:CTAG::;

320

Version: 04

8 Integrated Alarm Interface

Input Parameter
Parameter

Data Type

Value Range

SERIALID

String

Size (0 to 32)

Description
Alarm ID, corresponding to the
returned field SERIALID of the
"LST-ALARM" command.

Response Format
It complies with the operation command response format in Response Message Format.

Output Parameter
Success or failure.

Example
Clear the alarm whose ID is 107.
u

Command issued

CLR-ALARM::SERIALID=107:CTAG::;

u

Response message

FH_10.250.18.133 2010-11-04 09:53:29
M

CTAG COMPLD
EN=0

ENDESC=No error

Related Command
None

Version: 04

321

9

Common Error Codes
Error Code

Error Type

Meaning

IRNE

INPUT

The resource does not exist.

IRAE

INPUT

The resource already exists.

IRC
(ONUID/ONUNO/NA-

Resource conflict. The specific
INPUT

ME/PWD/SVLAN/CVLAN)

322

conflicting items are shown in
parenthesis.

IANE

INPUT

The alarm does not exist.

IMP

INPUT

The parameter is missing.

IIPF

INPUT

IIPE

INPUT

DDNS

DEVICE

DDOF

DEVICE

Device operation failure

DDB

DEVICE

The device is busy.

SENS

SYSTEM

SEOF

SYSTEM

EEEH

EXCEPTION

EMS exception

TUB

TEST

The user is busy.

TUT

TEST

The user is testing.

TTMB

TEST

The testing module is busy.

A parameter is in wrong format or not
entered.
Parameter value error
The operation is not supported by the
device.

The operation is not supported by the
EMS.
EMS operation failure, possibly because
the user has not logged in.

Version: 04

10

The List of Parameters
u

Impedance parameter

Parameter
Name

Impedance

u

Data Type

INTEGER

Value

Description

1

200+680|| 100nf: Bureau machine in China ()

2

200+560|| 100nf: User machine in China

3

600-ohm

Outer line test conclusion parameter

Parameter
Name

Conclusion

Data Type

INTEGER

Value

Description

0

Normal

11

Abnormal AC voltage.

12

Abnormal DC voltage.

13

Abnormal loop current.

14

Abnormal loop resistance.

15

Abnormal insulation resistance.

16

Abnormal capacitance.

17

Abnormal impedance.

21

Bad line insulation.

22

23

u

line breakage).
Mixed line (including intra-office and extra-office
mixed line).

24

Bad line ground.

25

Line interfere.

26

Electricity leakage.

27

Not hooked on.

Incoming / outgoing call emulation test conclusion parameter

Parameter
Name
Conclusion

Version: 04

Line breakage (including intra-office and extra-office

Data Type

INTEGER

Value

Description

1

Successful

2

Failed.

323

Northbound Interface TL1 User Manual

Parameter
Name

Data Type

Value

3

u

Name

FailReason

Name

Data Type

INTEGER

Value

Description

1

No signaling interaction.

2

The called party hooks off, but SS does not respond the
off-hook signaling.

3

MG internal reason.

4

Others.

Data Type

Value

Description

1

The SS off-hook response signaling is not received.

2

The SS dial tone sending signaling is not received.

3
FailReason

INTEGER

The dialed telephone number is not consistent with that
reported to SS.

4

The ring back tone is not received.

5

The other party has not hooked off.

6

Establishing the channel failed.

7

SS has not responded the on-hook signaling.

8

Others.

DSL transfer mode parameter

Parameter
Name

FailReason

324

personnel has not confirmed the call connection status.

Outgoing call emulation failure reason parameter

Parameter

u

The call connection is established, but the testing

Incoming call emulation failure reason parameter

Parameter

u

Description

Data Type

INTEGER

Value

Description

1

Regional Std. (ANSI T1.413)

2

Regional Std. (ETSI DTS/TM06006)

3

G.992.1 POTS non-overlapped

4

G.992.1 POTS overlapped

5

G.992.1 ISDN non-overlapped

6

G.992.1 ISDN overlapped

7

G.992.1 TCM-ISDN non-overlapped
Version: 04

10 The List of Parameters

Parameter
Name

Data Type

Value

Description

8

G.992.1 TCM-ISDN overlapped

9

G.992.1 TCM-ISDN symmetric

10

G.992.2 POTS non-overlapped

11

G.992.2 POTS overlapped

12

G.992.2 with TCM-ISDN non-overlapped

13

G.992.2 with TCM-ISDN overlapped

14

G.992.3 POTS non-overlapped

15

G.992.3 POTS overlapped

16

G.992.3 ISDN non-overlapped

17

G.992.3 ISDN overlapped

18

G.992.3 Annex I All-Digital non-overlapped

19

G.992.3 Annex I All-Digital overlapped

20

G.992.3 Annex J All-Digital non-overlapped

21

G.992.3 Annex J All-Digital overlapped

22
23

Version: 04

G.992.3 Annex L POTS non-overlapped, mode 1, wide
U/S
G.992.3 Annex L POTS non-overlapped, mode 2, narrow
U/S

24

G.992.3 Annex L POTS overlapped, mode 3, wide U/S

25

G.992.3 Annex L POTS overlapped, mode 4, narrow U/S

26

G.992.3 Annex M POTS non-overlapped

27

G.992.3 Annex M POTS overlapped

28

G.992.4 POTS non-overlapped

29

G.992.4 POTS overlapped

30

G.992.4 Annex I All-Digital non-overlapped

31

G.992.4 Annex I All-Digital overlapped

32

G.992.5 POTS non-overlapped

33

G.992.5 POTS overlapped

34

G.992.5 ISDN non-overlapped

35

G.992.5 ISDN overlapped

36

G.992.5 Annex I All-Digital non-overlapped

37

G.992.5 Annex I All-Digital overlapped

38

G.992.5 Annex J All-Digital non-overlapped

39

G.992.5 Annex J All-Digital overlapped

40

G.992.5 Annex M POTS non-overlapped
325

Northbound Interface TL1 User Manual

Parameter
Name

326

Data Type

Value

Description

41

G.992.5 Annex M POTS overlapped

42

G.993.1

43

G.993.2 Annex A POTS

44

G.993.2 Annex A ISDN

45

G.993.2 Annex B POTS

46

G.993.2 Annex B ISDN

47

G.993.2 Annex C POTS

48

G.993.2 Annex C ISDN

Version: 04

11

The List of Alarms
The list of alarms reported by the integrated alarm system is as follows:
u

Alarm definition list (OLT)

Alarm Type

Alarm Level

Alarm ID

Alarm Name

Alarm Reason

Equipment event

Critical alarm

110001

OLT-START

The OLT is cold-started / hot-started.

Equipment alarm

Critical alarm

110002

OLT-BOARD-OFF-LINE

The OLT card is off-line.
The OLT card status is abnormal,

Equipment alarm

Critical alarm

110003

OLT-BOARD-STATEABNORMAL

including abnormal running, the card
not being activated, and card type
being inconsistent with the configured
type.

ILEGAL_ONU_

Equipment alarm

Major alarm

110004

Equipment alarm

Major alarm

110005

Equipment alarm

Minor alarm

110006

Equipment alarm

Critical alarm

110007

LASER_ALWAYS_ON

Equipment alarm

Critical alarm

110008

ONU_Power_Fail

Equipment event

Major alarm

Equipment event

Communication
alarm
Communication
alarm
Communication
alarm
Communication
alarm
Version: 04

Major alarm

110009

110010

Critical alarm

310001

Critical alarm

310002

Critical alarm

Critical alarm

310003

310004

REGISTE

An invalid ONU tries to register.

OLT-REMOTE-ONU-

The OLT failed to send the

CONFIG-FAILURE

configuration to the ONU.

CPU_USAGE_OVER_

The CPU usage exceeds the preset

THRESHOLD

threshold.

BOARD_INVERSION_
SUCCESSFUL
PORT_INVERSION_
SUCCESSFUL

A certain ONU connected to the OLT
constantly emits light.
The OLT detects a certain connected
ONU is powered off.
The active / standby switching occurs
on the SCU and PON cards of the
OLT.
The active / standby switching occurs
on the uplink and PON ports of the
OLT.

OLT_PON_Optical_

The optical module of the EPON OLT

Module_Fail

PON port fails.

OLT_Uplink_Optical_

The optical module of the EPON OLT

Module_Fail

uplink port fails.

NO_OPTICS_SIGNAL
(uplink port)

The optical path between the Tx part
of the EPON uplink OLT and the Rx
part of the OLT uplink port fails.

NO_OPTICS_SIGNAL

(1) The trunk optical fiber is cut.

(optical port)

(2) The splitter fails.
327

Northbound Interface TL1 User Manual

Alarm Type

Alarm Level

Alarm ID

Alarm Name

Alarm Reason
The probable reasons include: (1) The

Communication
alarm

Critical alarm

310005

ONU_OFF_LINE

optical path between the splitter and
the ONU is abnormal. (2) The ONU
works abnormally.

Communication
alarm

Critical alarm

310006

OLT_OFF_Adminis

The EMS cannot communicate with
the OLT.
The Rx optical power of the OLT
uplink port exceeds the threshold. The

Communication
alarm

RX_POWER_ALARM
Major alarm

310007

(for the optical module of
the OLT uplink port)

probable reasons include: (1) The
Ethernet optical module of the
equipment uplinked with the OLT is
abnormal. (2) The optical path
between the equipment uplinked with
the OLT and the OLT Rx end fails.
The Tx optical power of the OLT

Communication
alarm

TX_POWER_ALARM
Major alarm

310008

(for the optical module of
the OLT uplink port)

uplink port exceeds the threshold. The
probable reasons include: (1) The
optical module of the OLT uplink port
works abnormally. (2) The OLT
uplink card or port is abnormal.
The Rx optical power of the OLT

Communication
alarm

Major alarm

310009

RX_POWER_ALARM
(for the OLT PON port)

PON port is abnormal. The probable
reasons include: (1) The optical power
exceeds the threshold.(2) The ONU
PON optical module is abnormal.
The Tx optical power of the OLT

Communication
alarm

Major alarm

310010

TX_POWER_ALARM
(for the OLT PON port)

PON port is abnormal. The probable
reasons include: (1) The optical power
exceeds the threshold. (2) The ONU
PON optical module is abnormal.
The optical path between the OLT and
the ONU is abnormal. The probable
reasons include: (1) The optical path

Communication
alarm

Major alarm

310011

ONU_Uplink_Error-

between the OLT and the splitter is

Frame_Too_Many

abnormal. (2) The optical path
between the splitter and a certain
ONU is abnormal. (3) The ONU PON
module is abnormal.

Communication
alarm

328

Warning alarm

310012

LACP_LINK_Failure

The LACP link fails.

Version: 04

11 The List of Alarms

Alarm Type
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm

Alarm Level

Alarm ID

Alarm Name

Critical alarm

210001

OLT_POWER_FAILURE

Critical alarm

210002

Major alarm

210003

Critical alarm

210004

Critical alarm

210005

Critical alarm

210006

Major alarm

Alarm Reason
The OLT power supply card is
abnormal.

OLT_ POWER_OFF_

The OLT power supply card is off-

LINE

line.

LOCAL_INPUT_
POWER_FAILURE

The local subrack power input fails.

TEMP_HIGH_ALARM

The temperature of the core switch

(the core switch card)

card is too high.

TEMP_HIGH_ALARM

The temperature of an OLT card is too

(the OLT card)

high.

TEMP_LOW_ALARM

The temperature of an OLT card is too

(the OLT card)

low.

210007

AC Failure

The AC power supply fails.

Major alarm

210008

Battery Failure

The circuit of the battery group fails.

Major alarm

210009

LOADFUSE

The load fuse is blown.

Major alarm

210010

Rectifier Module Failure

The rectifier module fails.

Major alarm

210011

FANFAIL

The ONU fan is abnormal.

Major alarm

210012

FAN_OFF_LINE

The OLT fan is off-line.

Critical alarm

210013

TEMP_ ALARM (the

The OLT optical module works

OLT optical module)

abnormally.

Major alarm

210014

MEMORY_USAGE_

The working load of the system is

OVER_THRESHOLD

excessive.
The external environment alarms,

Environment
alarm

including the abnormality of the
Critical alarm

210015

Dry_CONTACT_Alarm

access control system, the power
supply, the temperature, the humidity,
etc.

QoS alarm

QoS alarm

Version: 04

Major alarm

Major alarm

410001

410002

ETH_STATISTICS_
TRAFFIC_OVER_LIMIT

The number of traffic cross-threshold
times of the statistics gathered based
on the Ethernet.

ETH_STATISTICS_

The number of conflict cross-

CONFLICT_OVER_

threshold times of the statistics

LIMIT

gathered based on the Ethernet.

329

Northbound Interface TL1 User Manual

Alarm Type

Alarm Level

Alarm ID

QoS alarm

Warning alarm

410003

Alarm Name
ONU-OPTICALSIGNALDEGRADATION

QoS alarm

Major alarm

u

410004

ETH_CRC_ERROR_
OVER_LIMIT

Alarm Reason
The ONU optical channel generates
errors.
The number of CRC errors occurred
on the OLT Ethernet port exceeds the
threshold.

Alarm definition list (FTTB ONU)

Alarm Type

Alarm Level

Alarm ID

Equipment alarm

Critical alarm

120000

Alarm Name

Alarm Reason

ONU-BOARD-OFF-

The card connected with the ONU is

LINE

off-line.
The status of the card connected with

Equipment alarm

Critical alarm

120001

ONU-BOARD-STATEABNORMAL

the ONU is abnormal, including
abnormal running, the card not being
activated, and card type being
inconsistent with the configured type.

Equipment alarm

Major alarm

120002

ETH_PORT_LOOP

Equipment alarm

Major alarm

120003

DoS_ATTACK

Equipment alarm

Minor alarm

120004

Critical alarm

320001

Critical alarm

320002

Critical alarm

320003

Communication
alarm
Communication
alarm
Communication
alarm

alarm

Major alarm

320004

alarm
Communication
alarm
Communication
alarm
Environment
alarm

330

port.
The CPU usage exceeds the preset

THRESHOLD

threshold.

ONU_H248_
BREAKOUT
ONU_MGCP_
BREAKOUT
ONU_SIP_BREAKOUT

MONITOR_UNIT_
COMMUNICATION_
FAILURE

Communication

A DoS attack is detected on the user

CPU_USAGE_OVER_

ENVIRONMENT_
Communication

A loop is detected on the user port.

The ONU H.248 link fails.
The ONU MGCP link fails.
The SIP link fails.
The connection between the external
environment monitoring unit and the
ONU is abnormal.

RX_POWER_ALARM

The Rx optical power of the ONU

(for the ONU PON port)

PON port is abnormal.

TX_POWER_ALARM

The Tx optical power of the ONU

(for the ONU PON port)

PON port is abnormal.

Major alarm

320005

Major alarm

320006

Major alarm

320007

ONU_OFF_Adminis

Critical alarm

220001

AC Failure (ONU)

The EMS cannot communicate with
the ONU.
The AC power supply of the ONU
fails.

Version: 04

11 The List of Alarms

Alarm Type
Environment
alarm
Environment
alarm
Environment
alarm
Environment
alarm

Alarm Level

Alarm ID

Alarm Name

Alarm Reason

Critical alarm

220002

Critical alarm

220003

TEMP_ALARM (ONU)

The ONU temperature is abnormal.

Critical alarm

220004

FANFAIL (ONU)

The ONU fan is abnormal.

Critical alarm

220005

TEMP_ALARM (ONU

The optical module temperature is

optical module)

abnormal.

BATTERY_VOLTAGE_
LOW (ONU)

The ONU backup battery runs out.

The external environment alarms,
Environment
alarm

including the abnormality of the
Critical alarm

Dry_CONTACT_Alarm

220006

access control system, the power
supply, the temperature, the humidity,
etc.

u
Alarm Type
Equipment
alarm
Equipment
alarm
Equipment
alarm
Equipment
alarm
Equipment
alarm
Equipment
alarm

Version: 04

Alarm definition list (EMS)

Alarm Level

Alarm ID

Alarm Name

Alarm Reason

Major alarm

130001

SERVER_EXCEPTION

The EMS internal process is abnormal.

Major alarm

130002

CPU_OVER_

The CPU usage of the EMS network

THRESHOLD

management server is too high.

Major alarm

130003

MEM_OVER_

The memory usage of the EMS network

THRESHOLD

management server is too high.

Major alarm

130004

HD_OVER_

The hard disk usage of the EMS network

THRESHOLD

management server is too high.

Major alarm

130005

DBSPACE_OVER_

The database usage of the EMS server is too

THRESHOLD

high.

Major alarm

130006

LIC_OVER_

The EMS license agreement usage is too

THRESHOLD

high.

331

12

332

Abbreviations
BOSS

Business Operation Supporting System

CPE

Customer-premises Equipment

DSL

Digital Subscriber Line

DSLAM

Digital Subscriber Line Access Multiplexer

EMS

Element Management System

EPON

Ethernet Passive Optical Network

FTTB

Fiber to the Building

FTTC

Fiber to the Curb

FTTH

Fiber to the Home

FTTO

Fiber to the Office

FTTX

Fiber to the X

HGU

Home Gateway Unit

LAN

Local Area Network

MDU

Multi-Dwelling Unit

MTU

Multi-Tenant Unit

MSAN

Multiple Service Access Network

ITMS

Integrated Terminal Management System

IPTV

IP Television

OAM

Operation, Administration & Maintenance

OLT

Optical Line Terminal

ONT

Optical Network Terminal

ONU

Optical Network Unit

SBU

Single Business Unit

SFU

Single Family Unit

SNI

Service Network Interface

STB

Set Top Box

UNI

User Network Interface

VoIP

Voice over IP

Version: 04

