FiberHome Element Management System-Northbound Interface (TL1) - User Manual-B
FiberHome Element Management System-Northbound Interface (TL1) - User Manual-B
FiberHome Element Management System-Northbound Interface (TL1) - User Manual-B
System
User Manual
Version: B
Code: MN000004255
Feb 2021
Thank you for choosing our products.
Related Documentation
Document Description
I
Document Description
II
Version
Version Description
A Initial version
B Include commands of V2R11SPC0200.
Intended Readers
u Commissioning engineers
u Application developers
III
Conventions
Terminology Conventions
Terminology Convention
FiberHome e-Fim ANM2000 Broadband Access Network
ANM2000
Management System
Symbol Conventions
Cascading
→ Connects multi-level menu options.
menu
Bidirectional
↔ The service signal is bidirectional.
service
Unidirectional
→ The service signal is unidirectional.
service
IV
Contents
Preface...................................................................................................................I
Version ..........................................................................................................III
Conventions ................................................................................................. IV
3 Command Format.........................................................................................10
12 Abbreviations..............................................................................................645
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.
Network Diagram
Protocols Used
Management Function
Security Mechanism
Performance Specifications
Version: B 1
FiberHome Element Management System Northbound Interface (TL1) User Manual
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.
2 Version: B
1 TL1 Northbound Interface Overview
Version: B 3
FiberHome Element Management System Northbound Interface (TL1) User Manual
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.
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.
4 Version: B
1 TL1 Northbound Interface Overview
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.
Version: B 5
FiberHome Element Management System Northbound Interface (TL1) User Manual
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:
Table 1-1 describes the performance specifications of the TL1 northbound interface.
Maximum quantity of
32
concurrent TCP connections
u Each connection supports more than two service
provisioning / deletion work orders per minute.
Service provisioning
u Each connection supports more than four service
interface
suspension / recovery / modification work orders per
minute.
u The result is returned within one minute for the internal line
test, external line test, SELT, DELT and incoming / outgoing
Integrated testing interface call emulation tests.
u The result for a query command is returned within five
seconds.
6 Version: B
1 TL1 Northbound Interface Overview
Version: B 7
2 TL1 Northbound Interface
Installation
The following introduces how to install and run the TL1 northbound interface on
Windows operating system.
8 Version: B
2 TL1 Northbound Interface Installation
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.
The following introduces how to start / stop the TL1 northbound interface service.
Version: B 9
3 Command Format
The following introduces the command format and response message format of the
TL1 northbound interface.
Format Overview
Command Format
10 Version: B
3 Command Format
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 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:
Response Format
Response format indicates the format of the message returned after a command is
executed.
Annotation Symbols
Annotation
Description
Symbol
Version: B 11
FiberHome Element Management System Northbound Interface (TL1) User Manual
Annotation
Description
Symbol
cr A carriage return
lf A line feed
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).
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>:
12 Version: B
3 Command Format
Parameters
Parameter Description
acknowledgment_code ctag<
acknowledgment_code:
IP:In Progress
NA:No acknowledgment
RL:Repeat Later system busy
Version: B 13
FiberHome Element Management System Northbound Interface (TL1) User Manual
<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=error-
description>)
terminator::=<cr><lf>(;|>)
<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=error-
description>)|(<cr><lf>^^^<quoted line>))
quoted line::=<total_blocks=total-count><cr><lf>^^^<block_number=block-
num><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.
14 Version: B
3 Command Format
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.
Version: B 15
FiberHome Element Management System Northbound Interface (TL1) User Manual
The following introduces the resource change notification format and parameters of
the TL1 northbound interface.
<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>(;|>)
16 Version: B
3 Command Format
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
header value is as follows:
u HW_IP
u ZTE_IP
u FH_IP
Version: B 17
FiberHome Element Management System Northbound Interface (TL1) User Manual
The error codes returned by the TL1 northbound interface are as shown in
Table 3-2.
18 Version: B
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.
Version: B 19
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
Name
UN OCTET STRING Size (20) User Name -
Response Format
Output Parameter
None
20 Version: B
4 Session Control
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
Log out of the FiberHome EMS and disconnect the TCP connection with the TL1
northbound interface.
Command Format
LOGOUT:::CTAG::;
Input Parameter
None
Response Format
Output Parameter
None
Version: B 21
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
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
Response Format
Output Parameter
None
22 Version: B
4 Session Control
Example
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: B 23
5 Service Commissioning Interface
The following introduces the commands for the provisioning of the IPTV, broadband
and VOIP services in the FTTx scenario.
VoIP Service
VLAN Service
24 Version: B
5 Service Commissioning Interface
The following introduces how to add, delete and configure an optical network unit
(ONU) of the FTTH type.
Function Description
This command is used for adding an ONU on the optical line terminal (OLT). During
initial service provisioning, 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=auth-
type], password][, > DESC=onu description], type[,BANDTYPE = BandWidthType];
Input Parameter
Version: B 25
FiberHome Element Management System Northbound Interface (TL1) User Manual
1G/1G
10G/1G
Bandwidth type; set it according to the actual
BANDTYPE OCTET STRING 10G/10G
requirement.
2.5G/1.25G
10G/2.5G
Response Format
Output Parameter
None
Example
Example 1: Add an ONU for PON port 2 in slot 1 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; the ONU authorization number is 10; the ONU description is
Test_ONU2; the ONU authentication mode is LOID.
u Command issued
ADD-ONU::OLTID=10.78.11.102,PONID=NA-NA-1-2:CTAG::AUTHTYPE=LOID,
> >
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 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: the MAC address is 54-4B-
40-04-2C-1F; the ONU authentication mode is MAC.
u Command issued
26 Version: B
5 Service Commissioning Interface
ADD-ONU::OLTID=10.78.11.102,PONID=NA-NA-15-2:CTAG::AUTHTYPE=MAC,
> >
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
Function Description
This command is used for modifying the ONU authentication mode and
authentication ID information when replacing an ONU.
Command Format
CFG-ONU::OLTID=olt-name,PONID=ponport_location, > >
Input Parameter
Version: B 27
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Configure the ONU connected to PON port 1 in slot 3 of the OLT with the ID
10.250.18.100. The information of the ONU is as follows: ONUID is Test0001; the
authentication mode is LOID, which is test0002.
u Command issued
CFG-ONU::OLTID=10.250.18.100,PONID=NA-NA-3-1, > 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
28 Version: B
5 Service Commissioning Interface
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.
Command Format
CFG-ONUBW:: > > DOWNBW=onu-down-bandwidth];
Input Parameter
OCTET
UPBW Size (32) Uplink DBA bandwidth template name
STRING
OCTET
DOWNBW Size (32) Downlink bandwidth template name
STRING
Version: B 29
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response 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 Command issued
CFG-ONUBW::OLTID=10.71.227.56,PONID=NA-NA-3-1, > >
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
Note:
Deleting an ONU will simultaneously delete the services that the ONU
bears. To re-provision such services, add and configure them again.
Function Description
This command is used for deleting the ONU authorized by the OLT.
30 Version: B
5 Service Commissioning Interface
Command Format
DEL-ONU::OLTID=olt-name,PONID=ponport_location:CTAG:: > type,>
Input Parameter
Response Format
Output Parameter
None
Example
Example 1: Delete an ONU from 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; its
authentication mode is LOID.
u Command issued
DEL-ONU::OLTID=10.250.18.100,PONID=NA-NA-3-1:CTAG:: > >
u Response message
Version: B 31
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example 2: Delete an ONU from PON port 2 in slot 15 of the OLT whose IP address
is 10.250.18.100. The information of the ONU is as follows: its MAC address is 54-
4B-40-04-2C-1F; its authentication mode is MAC.
u Command issued
DEL-ONU::OLTID=10.250.18.100,PONID=NA-NA-15-2: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
ADD-ONU
Function Description
This command is used for configuring the limit of MAC addresses for a LAN port of
an ONU.
Command Format
CFG-LANPORTMACLIMIT::OLTID=olt-name,PONID=ponport_location,
> COUNT=count_num;
32 Version: B
5 Service Commissioning Interface
Input Parameter
Response Format
Version: B 33
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
Example
Set the quantity limit of MAC addresses to 14 on port 1 of the ONU with the ID
FHTT030B3908. The ONU is connected to PON port 6 in slot 7 of the OLT with the
IP address 10.190.40.156.
u Command issued
CFG-LANPORTMACLIMIT::OLTID=10.190.40.156,PONID=NA-NA-7-6, > >
u Response message
FH_10.78.12.155 2019-03-16 11:25:31
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function
This command configures a Wi-Fi service for the ONU authorized by an OLT. You
can add an SSID and set a key as needed.
Command Format
CFG-WIFISERVICE:: > > AREA=area,WILESS-CHANNEL=channel,WILESS-STANDARD=standard,WORKING-
FREQUENCY=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,FREQUENCY-
BANDWIDTH=bandwidth][,RADIUS-SERVER=server,RADIUS-PORT=port,RADIUS-
KEY=key][,WEP-ENCRYPTIONLEVEL=level,WEP-KEYINDEX=index,WEP-KEY1=key1,
WEPKEY2=key2,WEPKEY3=key3,WEPKEY4=key4,MAX-WIFIMAC-COUNT=4,
PUBLICSSID=No,KICKSTATIONSWITCH=0,LOWERTHRESHOLD=-75];
34 Version: B
5 Service Commissioning Interface
Input Parameter
Required for
ONU identifier type an ONU that
OCTET
ONUIDTYPE Size (128) (ONU_NAME, MAC, has no
STRING
LOID or ONU_NUMBER) management
IP address
ONU identifier, used for
Required for
uniquely identifying an
an ONU that
OCTET ONU connected to a
ONUID Size (128) has no
STRING PON port. The value is
management
ONU_NAME, MAC, LOID
IP address
or ONU_NUMBER.
Version: B 35
FiberHome Element Management System Northbound Interface (TL1) User Manual
36 Version: B
5 Service Commissioning Interface
Optional.
When other
SSID
parameters
are set, this
SSID index, the keyword
parameter is
of the secondary table,
SSID INTEGER 1 to 4 required as
used for locating a
the index for
specific SSID entry.
searching for
the SSID
configuration
to be
modified.
Enable or not
SSID-ENABLE INTEGER 0, 1 0: disable Optional
1: enable
OCTET
SSID-NAME Size (32) SSID name Optional
STRING
Version: B 37
FiberHome Element Management System Northbound Interface (TL1) User Manual
20/40 MHz
20 MHz
FREQUENCY- OCTET 40 MHz
Frequency bandwidth Optional
BANDWIDTH STRING 80 MHz
160 MHz
80+80 MHz
RADIUS- OCTET
STRING (128) RADIUS server Optional
SERVER STRING
OCTET
RADIUS-PORT STRING (2) RADIUS server port Optional
STRING
OCTET
RADIUS-KEY STRING (32) RADIUS-KEY Optional
STRING
38 Version: B
5 Service Commissioning Interface
Optional. The
MAX-WIFIMAC- Number of Wi-Fi
INTEGER 0 to 32 default value
COUNT connections
is 0.
Optional. The
OCTET No
PUBLICSSID Public SSID default value
STRING Yes
is "No".
Optional. The
default value
is 0.
If the value is
KICKSTA- 1: true Switch for kicking a
INTEGER set to 0, the
TIONSWITCH 0: false wireless device offline
parameter
LOWER-
THRESHOLD
is invalid.
Optional. The
default value
is -75.
If the signal
Threshold for kicking a intensity of a
LOWER-
INTEGER -100 to 0 wireless device offline wireless
THRESHOLD
Unit: dBm device is
lower than this
threshold, the
device will be
kicked offline.
Response Format
Version: B 39
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
Example
Configure a Wi-Fi service for the ONU with the ID 1 connected to PON port 16 in
slot 8 on the OLT with the IP address 10.171.0.31. Set the ONU authentication
mode to WPAPSK, the WLAN encryption type to AES, the frequency bandwidth to
20/40 MHz, and the number of Wi-Fi connections to 31.
u Command issued
CFG-WIFISERVICE::OLTID=10.171.0.31,PONID=NA-NA-8-16,
> CHANNEL=0,WILESS-STANDARD=802.11bgn,WORKING-FREQUENCY=2.4GHZ,T-
POWER=100,SSID=1,SSID-ENABLE=1,SSID-NAME=wifi-fiberhome2,SSID-
VISIBALE=1,AUTH-MODE=WPA2PSK,ENCRYP-TYPE=AES,FREQUENCY-BANDWIDTH=20/
40MHZ,WEP-ENCRYPTIONLEVEL=1,WEP-KEYINDEX=1,WEPKEY1=123451111,
WEPKEY2=12345ABCDEFGH,WEPKEY3=12345FEAB1,
WEPKEY4=1234567890ABCDEF0987654321,MAX-WIFIMAC-COUNT=31,PUBLICSSID=No,
KICKSTATIONSWITCH=1,LOWERTHRESHOLD=-75;
u Response message
FH_10.170.200.54 2021-01-07 10:22:26
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
Function
This command modifies Wi-Fi service parameters, including the parameters in the
primary and secondary tables.
Command Format
MODIFY-WIFISERVICE::OLTID=olt-ip,PONID=pon-id, > >
40 Version: B
5 Service Commissioning Interface
WORKINGFREQUENCY=frequency,FREQUENCYBANDWIDTH=bandwidth,
WILESSAREA=area,WILESSCHANNEL=channel,TPOWER=tpower,SSID=ssid,
SSIDENABLE=ssidenable,SSIDNAME=name,SSIDVISIBALE=visibale,
AUTHMODE=mode,ENCRYPTYPE=type,PRESHARED-KEY=key[,PUBLICSSID=No];
Input Parameter
u enable
ENABLE OCTET STRING Enable or disable Optional
u disable
802.11b
802.11g
802.11b/g
802.11n
802.11bgn
WILESS-
OCTET STRING 802.11a Wireless standard Optional
STANDARD
802.11an
802.11ac
802.11ax
802.11b/g/n/ax
802.11a/n/ac/ax
Version: B 41
FiberHome Element Management System Northbound Interface (TL1) User Manual
20/40 MHz
20 MHz
FREQUEN-
40 MHz
CYBAND- OCTET STRING Frequency bandwidth Optional
80 MHz
WIDTH
160 MHz
80+80 MHz
Wireless area. The value will
be converted to the
WILESSAR-
INTEGER 0 to 24 corresponding area name Optional
EA
displayed in the UNM2000
window.
WILES-
INTEGER 0 to 13 Wireless channel number Optional
SCHANNEL
20, 40, 60, 80, 100,
TPOWER INTEGER 120, 140, 160, 180, Wi-Fi power control Optional
200
42 Version: B
5 Service Commissioning Interface
Version: B 43
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Modify the frequency bandwidth of the ONU with the ID 1 connected to PON port 3
in slot 14 on the OLT with the IP address 10.171.0.34. Set the wireless standard to
"802.11bgn", the working frequency to 2.4 GHz, the WPA pre-shared key to
"aaaaaaaaa", and the public SSID to "Yes".
u Command issued
MODIFY-WIFISERVICE::OLTID=10.171.0.34,PONID=NA-NA-14-3,
> WILESSSTANDARD=802.11bgn,WORKINGFREQUENCY=2.4GHZ,FREQUENCYBANDWIDTH=20/
40MHZ,WILESSAREA=0,WILESSCHANNEL=0,TPOWER=100,SSID=1,SSIDENABLE=1,
SSIDNAME=CMCC-K9he,SSIDVISIBALE=0,AUTHMODE=WPAPSK,ENCRYPTYPE=AES,
PRESHARED-KEY=aaaaaaaaa,PUBLICSSID=Yes;
u Response message
FH_10.170.200.54 2021-01-05 20:14:38
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
Function Description
This command is used for configuring a Wi-Fi service for the ONU authorized by
OLT. It is allowed to add SSID and configure it with different keys.
44 Version: B
5 Service Commissioning Interface
Command Format
CFG-WIFISERVICE:: > > WILESSAREA=area,WILESSCHANNEL=channel,WILESSSTANDARD=standard,
WORKINGFREQUENCY=frequency,T-POWER=tpower,SSID=ssid,
SSIDENABLE=SSIDENABLE,SSIDNAME=name,SSIDVISIBALE=visible,AUTHMODE=mode,
ENCRYPTYPE=type[,PRESHAREDKEY=key,UPDATEKEYINTERVAL=interval,
FREQUENCYBANDWIDTH=bandwidth][,RADIUSSERVER=server,RADIUSPORT=port,
RADIUSKEY=key][,WEPENCRYPTIONLEVEL=level,WEPKEYINDEX=index,
WEPKEY1=key1,WEPKEY2=key2,WEPKEY3=key3,WEPKEY4=key4];
Input Parameter
Version: B 45
FiberHome Element Management System Northbound Interface (TL1) User Manual
46 Version: B
5 Service Commissioning Interface
WEPENCRYP- 1: 40 bit
INTEGER WEP key length Optional
TIONLEVEL 2: 104 bit
WEPKEYIN-
INTEGER [1, 4] Key index Optional
DEX
WEPKEY1 OCTET STRING STRING (64) WEP key 1 Optional
Version: B 47
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Configure the TKIP encryption mode for the ONU with the ID FHTT01E84310
connected to the PON port 1 in slot 7 of the OLT whose IP address is 10.171.0.22.
The ONU is authenticated by physical ID.
u Command issued
CFG-WIFISERVICE::OLTID=10.171.0.22,PONID=NA-NA-7-1, > > WILESSSTANDARD=802.11n,WORKINGFREQUENCY=2.4GHZ,T-POWER=140,SSID=2,
SSIDENABLE=0,SSIDNAME=brisa-81805,SSIDVISIBALE=1,AUTHMODE=WPAPSK,
ENCRYPTYPE=TKIP,PRESHAREDKEY=naotemsenha12,UPDATEKEYINTERVAL=3600,
FREQUENCYBANDWIDTH=20/40MHZ
u Response message
FH_10.78.20.120 2017-03-16 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-WIFISERVICE
48 Version: B
5 Service Commissioning Interface
Function Description
This command is used to modify the Wi-Fi service parameters, including the
parameters in the primary table and secondary table.
Command Format
MODIFY-WIFISERVICE::OLTID=olt-ip,PONID=pon-id, > > WORKINGFREQUENCY=frequency,F-REQUENCY-BANDWIDTH=bandwidth,
WILESSAREA=area,WILESSCHANNEL=channel,T-POWER=tpower,SSID=ssid,
SSIDENABLE=SSIDENABLE,SSIDNAME=name,SSID-VISIBALE=visibale,
AUTHMODE=mode,ENCRYPTYPE=type,PRESHAREDKEY=key;
Input Parameter
Version: B 49
FiberHome Element Management System Northbound Interface (TL1) User Manual
FREQUEN-
20/40MHz, 20MHz,
CYBAND- OCTET STRING Frequency bandwidth Optional
40MHz, 80MHz
WIDTH
Wireless area. The value
will be converted to the
WILESSAR-
INTEGER 0 to 23 corresponding area name Optional
EA
and displayed on the EMS
GUI.
50 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Version: B 51
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Modify the frequency bandwidth of the ONU with the ID FHTT09378c68, which is
connected to PON port 1 in slot 4 on the OLT device with the IP address
10.190.42.3.
u Command issued
MODIFY-WIFISERVICE::OLTID=10.190.42.3,PONID=NA-NA-4-1, > > POWER=140,SSID=3,SSIDENABLE=0,SSIDNAME=brisa-81808,SSID-VISIBALE=1,
AUTHMODE=WPAPSK,ENCRYPTYPE=TKIP,PRESHAREDKEY=naotemsenha1234,UPDATEKEY-
INTERVAL=3600,WILESSSTANDARD=802.11n,WORKINGFREQUENCY=2.4GHZ,
FREQUENCYBANDWIDTH=20/40MHZ;
u Response message
FH_10.170.163.1122017-02-1916:08:07
MCTAGCOMPLD
EN=0ENDESC=Noerror
;
Related Command
CFG-WIFISERVICE
Function Description
This command is used for deleting an SSID entry under a working frequency band
in the Wi-Fi service configuration.
Command Format
DEL-WIFISERVICE:: > > WORKINGFREQUENCY=workingfrequency,SSIDNO=ssidno;
52 Version: B
5 Service Commissioning Interface
Input Parameter
Version: B 53
FiberHome Element Management System Northbound Interface (TL1) User Manual
Required
u The single-
frequency ONU
(working band being
2.4 GHz) does not
SSID sequence number, support deleting the
the keyword of the entry with the SSID
SSIDNO INTEGER 0 to 4 secondary table, used for being 1.
locating a specific SSID u The dual-frequency
entry ONU (working band
being 2.4 GHz/5 GHz)
does not support
deleting any entry
corresponding to an
SSID.
Response Format
Output Parameter
None
Example
Delete the entry with the SSID 2 in the working band 2.4 GHz from the WIFI service
configurations of the ONU with the ID FHTT09378c68, which is connected to PON
port 1 in slot 4 of the OLT device with the IP address 10.190.42.3.
u Command issued
DEL-WIFISERVICE::OLTID=10.190.42.3,PONID=NA-NA-4-1, > >
u Response message
FH_10.170.163.1122019-02-1916:08:07
MCTAGCOMPLD
54 Version: B
5 Service Commissioning Interface
EN=0ENDESC=Noerror
;
Related Command
CFG-WIFISERVICE
Function Description
This command is used for configuring WAN connections for the ONU authorized by
OLT.
Command Format
SET-WANSERVICE:: > > CONNTYPE=connecttype[,VLAN=vlan][,COS=cos][,QOS=qos][,NAT=nat][,
IPMODE=ipmode][,WANIP=wanip][,WANMASK=mask][,WANGATEWAY=gateway][,
MASTERDNS=maskdns][,SLAVEDNS=slavedns][,IPSTACKMODE=ipstackmode][,
IP6SRCTYPE=ip6srctype][,IP6PREFIXSRCTYPE=ip6prefixsrctype][,
IP6ADDRESS=ip6address][,IP6GATEWAY=ip6gateway][,
IP6MASTERDNS=ip6masterdns][,IP6SLAVEDNS=ip6masterdns][,
IP6STATICPREFIX=ip6staticprefix][,PPPOEPROXY=proxy][,
PPPOEUSER=pppoeusername][,PPPOEPASSWD=pppoepassword][,
PPPOENAME=pppoename][,PPPOEAUTHMODE=pppoeauthmode][,
PPPOEMODE=pppoemode][,PPPOEIDLETIME=pppoeidletime][,UPORT=uport][,
SSID=ssidno][,WANSVC=1][,VLANMODE=vlanmode][,TRANSSTATE=transstate][,
TRANSVALUE=transvalue][,TRANSCOS=transcos][,QINQSTATE=qinqstate][,
TPID=tpid][,SVLAN=svlan][,QINQCOS=qoscos][,DHCPREMOTEID=dhcppermodeid]
[,UPNP=0][,ACTIVATION=0][,GEMPORT=4];
Input Parameter
Version: B 55
FiberHome Element Management System Northbound Interface (TL1) User Manual
u 1: configure
STATUS INTEGER 1 or 2 Required
u 2: delete
WAN connection mode:
u 1: TR069
u 2: INTERNET
u 3: TR069_INTERNET
u 4: multicast
u 5: VOIP
MODE INTEGER 1-9, 100 Required
u 6: VOIP_INTERNET
u 7: IPTV
u 8: RADIUS
u 9:
RADIUS_INTERNET
u 100: Other
WAN connection type
CONNTYPE INTEGER 1 or 2 u 1: bridge Required
u 2: route
VLAN ID of the WAN
VLAN INTEGER 1 to 4085 Optional
connection
56 Version: B
5 Service Commissioning Interface
Indicates whether to
enable the QoS function for
(Optional) Enabled by
QoS INTEGER 1 or 2 a WAN connection.
default
u 1: enable
u 2: disable
Indicates whether to
enable the NAT. (Optional) Enabled by
NAT INTEGER 1 or 2
u 1: enable default
u 2: disable
IP address obtaining mode
of a WAN connection
IPMODE INTEGER 1 to 3 u 1: DHCP -
u 2: STATIC
u 3: PPPOE
Static IP address of a WAN
WANIP OCTET STRING Size (16) connection, which should -
be valid.
Subnet mask of a WAN
connection. It must be a
valid IP address, in format
WANMASK OCTET STRING Size (16) -
of dotted decimal notation.
It is valid only when
IPMODE is set to STATIC.
Default gateway of a WAN
connection. It must be a
valid IP address, in format
WANGATEWAY OCTET STRING Size (16) -
of dotted decimal notation.
It is valid only when
IPMODE is set to STATIC.
Primary DNS of a WAN
connection. It must be a
valid IP address, in format
MASTERDNS OCTET STRING Size (16) -
of dotted decimal notation.
It is valid only when
IPMODE is set to STATIC.
Version: B 57
FiberHome Element Management System Northbound Interface (TL1) User Manual
58 Version: B
5 Service Commissioning Interface
Version: B 59
FiberHome Element Management System Northbound Interface (TL1) User Manual
Translation status
TRANSSTATE INTEGER 0 or 1 u 0: disable Optional
u 1: enable
TRANSVALUE INTEGER 1 to 4085 VID after translation Optional
QinQ state
QINQSTATE INTEGER 0 or 1 u 0: disable Optional
u 1: enable
TPID INTEGER 0-0xfffe Tag protocol identifier Optional
60 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
u Command issued
SET-WANSERVICE::OLTID=172.30.18.84,PONID=NA-NA-13-2, > > QOS=2,NAT=1,IPMODE=3,PPPOEPROXY=2,PPPOEUSER=test,PPPOEPASSWD=test,
PPPOENAME=test,PPPOEMODE=1,QINQSTATE=1,SVLAN=2241,QINQCOS=1,UPORT=0;
u Response message
FH_10.78.20.1202019-06-1314:36:03
M CATG COMPLD
EN=0 ENDESC=No error
;
Version: B 61
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command issued
SET-WANSERVICE::OLTID=172.30.18.84,PONID=NA-NA-13-2, > CONNTYPE=2,VLAN=3,COS=4,QOS=2,
NAT=1,IPMODE=1,UPORT=0,WANSVC=1;
u Response message
FH_10.78.12.1552019-06-1318:47:53
M CATG COMPLD
EN=0 ENDESC=No error
;
u Command issued
SET-WANSERVICE::OLTID=172.30.18.84,PONID=NA-NA-13-2, > > QOS=2,NAT=1,IPMODE=3,PPPOEPROXY=2,PPPOEUSER=test,PPPOEPASSWD=test,
PPPOENAME=test,PPPOEMODE=1,QINQSTATE=1,SVLAN=2241,QINQCOS=1,SSID=1;
u Response message
FH_10.78.12.1552019-06-1310:44:51
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
SET-WANSERVICE::( > > CONNTYPE=conntype][,VLAN=vlan_id][,COS=cos_value][,UPORT=port_id][,
SSID=ssid];
62 Version: B
5 Service Commissioning Interface
Input Parameter
Version: B 63
FiberHome Element Management System Northbound Interface (TL1) User Manual
64 Version: B
5 Service Commissioning Interface
Response Format
Version: B 65
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
u Command issued
SET-WANSERVICE::OLTID=10.10.6.28,PONID=NA-NA-8-2, > >
u Response message
FH_10.78.20.120 2019-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
u Command issued
SET-WANSERVICE::OLTID=10.10.6.28,PONID=NA-NA-8-2, > >
u Response message
FH_10.78.20.120 2019-02-21 13:45:32
M CATG COMPLD
EN=0 ENDESC=No error
;
u Command issued
SET-WANSERVICE::OLTID=10.10.6.28,PONID=NA-NA-8-2, > >
u Response message
FH_10.78.20.120 2019-02-21 13:46:15
M CATG COMPLD
EN=0 ENDESC=No error
;
u Command issued
ET-WANSERVICE::OLTID=10.10.6.28,PONID=NA-NA-8-2, STATUS=2,
>
u Response message
FH_10.78.20.120 2019-02-21 13:49:04
66 Version: B
5 Service Commissioning Interface
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to configure the bandwidth template and the GPON service
bandwidth template of an ONU.
Command Format
CFG-ONUBWPROFILE::OLTID=olt_name,PONID=ponport_location, > type,>
Input Parameter
Version: B 67
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Configure the bandwidth template and the GPON service bandwidth template of the
ONU with the ID 1, which is connected to PON port 5 in slot 4 on the OLT device
with the IP address 10.171.0.16.
u Command issued
CFG-ONUBWPROFILE::OLTID=10.171.0.16,PONID=1-1-4-5, > >
u Response message
FH_10.78.20.1202011-02-2113:50:24
MCTAGCOMPLD
EN=0ENDESC=Noerror
;
Related Command
UNBIND-ONUBWPROFILE
68 Version: B
5 Service Commissioning Interface
Function Description
This command is used to unbind the bandwidth template and the GPON service
bandwidth template from an ONU.
Command Format
UNBIND-ONUBWPROFILE::OLTID=olt_name,PONID=ponport_location,
>
Input Parameter
Response Format
Output Parameter
None
Version: B 69
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Unbind the bandwidth template and the GPON service bandwidth template from the
ONU with the ID 1, which is connected to PON port 5 in slot 4 on the OLT with the IP
address 10.171.0.16.
u Command issued
UNBIND-ONUBWPROFILE::OLTID=10.171.0.16,PONID=1-1-4-5,
>
u Response message
FH_10.78.20.1202011-02-2113:50:24
MCTAGCOMPLD
EN=0ENDESC=Noerror
;
Related Command
CFG-ONUBWPROFILE
Function Description
Command Format
CFG-LT-BWPROFILE::OLTID=olt_name,PONID=ponport_location, > type, WANINDEX=wan_index,
UPBWPROFILE=up_bwprofile,DOWNBWPROFILE=down_bwprofile;
Input Parameter
OLTID OCTET STRING Size (128) IP address, name or ID of the OLT Required
70 Version: B
5 Service Commissioning Interface
DOWNBWPRO-
OCTET STRING Size (64) Downlink bandwidth template Required
FILE
Response Format
Output Parameter
None
Example
u Command issued
CFG-LT-BWPROFILE::OLTID=172.30.18.84,PONID=NA-NA-13-2, > > UPBWPROFILE=GPON_DN_60_UP_30M,DOWNBWPROFILE=GPON_DN_60_UP_30M;
u Response message
FH_10.170.162.232019-06-1115:34:18
M CATG COMPLD
EN=0 ENDESC=No error
;
u Command issued
Version: B 71
FiberHome Element Management System Northbound Interface (TL1) User Manual
CFG-LT-BWPROFILE::OLTID=172.30.18.84,PONID=NA-NA-13-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
Function Description
Command Format
CFG-PORTBINDFLOWPOLICY:: > PONID=ponport_location, > port:CTAG::IngressPolicy=Ingress_Policy, EgressPolicy=Egress_Policy,
IngressRule=Ingress_Rule,EgressRule=Egress_Rule;
Input Parameter
72 Version: B
5 Service Commissioning Interface
MAC
LOID ONU identifier type (NAME,
ONUIDTYPE OCTET STRING Required
ONU_Number MAC, LOID, ONU_Number).
ONU_NAME
OLTv4.x version.
IngressRule OCTET STRING Size (20) Uplink rule
Required.
OLTv4.x version.
EgressRule OCTET STRING Size (20) Downlink rule
Required.
Response Format
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
Version: B 73
FiberHome Element Management System Northbound Interface (TL1) User Manual
CFG-PORTBINDFLOWPOLICY::OLTID=10.171.0.16,PONID=NA-NA-16-1,
> 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
Function Description
Prerequisite
Command Format
SET-UPLINKTRUNK::ONUIP|OLTID=olt_name:ctag::TRUNKNO=trunk_no,
MASTERPORT=NA-NA-12-2,MEMBERPORT=NA-NA-NA-NA;
Input Parameter
74 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Configure the Trunk port link aggregation on the OLT with the IP address
10.171.0.22.
u Command issued
SET-UPLINKTRUNK::OLTID=10.171.0.22:ctag::TRUNKNO=2,MASTERPORT=NA-NA-19-
2,MEMBERPORT=NA-NA-20-5;
u Response message
FH_10.170.163.1122017-02-1516:55:52
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: B 75
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
LST-TRUNKINFO::>
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
76 Version: B
5 Service Commissioning Interface
Output Parameter
1 to 12
AN5220: For MCXA:
3: GE1
4: GE2
5: GE3
MASTERPORT OCTET STRING 6: GE4 Main port number of the Trunk group
For MCXB:
1: XE1
2: XE2
3: GE1
4: GE2
1 to 12
AN5220:
For MCXA:
3: GE1
4: GE2
5: GE3
MEMBERPORT OCTET STRING Member port number of the TRUNK group
6: GE4
For MCXB:
1: XE1
2: XE2
3: GE1
4: GE2
Example
Query the TRUNK port link aggregation of the OLT with the IP address 10.171.0.22.
u Command issued
LST-TRUNKINFO::OLTID=10.171.0.22:ctag::;
u Response message
FH_127.0.0.12016-05-0910:50:27
MctagCOMPLD
total_blocks=1
block_number=1
block_records=2
LstOfTrunkInfo
------------------------------------
Version: B 77
FiberHome Element Management System Northbound Interface (TL1) User Manual
TRUNKNOMASTERPORTMEMBERPORT
11-1-19-21-1-19-3
21-1-20-11-1-20-2|1-1-20-3
------------------------------------
Related Command
SET-UPLINKTRUNK
Function Description
Command Format
CFG-MANAGEVLAN::OLTID=olt_name,PONID=ponport_location, > > SVLAN=svlan_id,CVLAN=cvlan_id,IP=ip,MASK=mask,GATEWAY=gateway;
Input Parameter
78 Version: B
5 Service Commissioning Interface
Size (16)
Management VLAN
Numbers, letters and
NAME OCTET STRING name, which must be Required
underscores. It cannot be
unique.
null.
0: all ports
1: PON port
PORTNO INTEGER 0 to 3 Optional
2: GE1
3: GE2
0: untag
VLANMODE OCTET STRING 0, 1 Required
1: tag
Management IP address
IP OCTET STRING Size (16) Required
of the ONU
MASK OCTET STRING Size (16) Mask Required
Response Format
Output Parameter
None
Example
Configure the management VLAN for the ONU with the ID 3 connected to PON port
4 in slot 4 of the OLT whose IP address is 10.171.0.41.
u Command issued
Version: B 79
FiberHome Element Management System Northbound Interface (TL1) User Manual
CFG-MANAGEVLAN::OLTID=10.171.0.41,PONID=NA-NA-4-4, > > IP=10.171.0.167,MASK=255.255.255.0,GATEWAY=10.171.0.254;
u Response message
FH_10.170.95.191 2019-09-300 18:36:23
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
LST-MANAGEVLAN
Function Description
Command Format
LST-MANAGEVLAN::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
OLTID OCTET STRING Size (128) IP address, name or ID of the OLT Required
80 Version: B
5 Service Commissioning Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Example
Query the management VLAN of the ONU with the ID 7 connected to PON port 2 in
slot 3 of the OLT whose IP address is 10.171.0.22.
u Command issued
LST-MANAGEVLAN::OLTID=10.171.0.22,PONID=NA-NA-3-2, > >
Version: B 81
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
Related Command
CFG-MANAGEVLAN
Function Description
Command Format
ACT-ONU::OLTID=olt_name,PONID=ponport_location, > >
Input Parameter
82 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Activate the ONU with the ID 3 connected to PON port 1 in slot 3 of the OLT whose
IP address is 10.171.0.22.
u Command issued
ACT-ONU::OLTID=10.171.0.22,PONID=1-1-3-1, > CTAG::;
u Response message
FH_10.170.3.76 2018-04-10 18:36:23
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEACT-ONU
Version: B 83
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
DEACT-ONU::OLTID=olt_name,PONID=ponport_location, > >
Input Parameter
Response Format
Output Parameter
None
84 Version: B
5 Service Commissioning Interface
Example
Deactivate the ONU with the ID 3 connected to PON port 1 in slot 3 of the OLT
whose IP address is 10.171.0.22.
u Command issued
DEACT-ONU::OLTID=10.171.0.22,PONID=1-1-3-1, > >
u Response message
FH_10.170.3.76 2018-04-10 18:55:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ACT-ONU
Function Description
Command Format
SET-ONUSWITCH:: > >
Input Parameter
Version: B 85
FiberHome Element Management System Northbound Interface (TL1) User Manual
ONU switch
ONUSWITCH INTEGER Size (128) 1: enable Required
0: disable
Response Format
Output Parameter
None
Example
Enable the ONU with the ID 2 connected to PON port 1 in slot 3 of the OLT whose IP
address is 10.171.0.16.
u Command issued
SET-ONUSWITCH::OLTID=10.171.0.16,PONID=NA-NA-3-1, > >
u Response message
FH_10.170.3.76 2018-05-11 16:36:23
M CTAG COMPLD
EN=0 ENDESC=No error
86 Version: B
5 Service Commissioning Interface
Related Command
ACT-ONU
DEACT-ONU
Function Description
Command Format
RST-BOARD::OLTID=olt_name,BOARDID=board_id:CTAG::;
Input Parameter
Response Format
Output Parameter
None
Example
Reset the line card in slot 1 of the OLT whose IP address is 10.190.40.216.
u Command issued
Version: B 87
FiberHome Element Management System Northbound Interface (TL1) User Manual
RST-BOARD::OLTID=10.190.40.216,BOARDID=NA-NA-1:CTAG::;
u Response message
FH_10.170.163.215 2018-05-11 14:26:23
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to configure the traffic policy template bound with a port.
Command Format
ADD-PORTBINDFLOWPOLICY:: > PONID=ponport_location, > > EGRESSPOLICY=gegresspolicy,INGRESSRULE=ingressrule,
EGRESSRULE=egressrule;
Input Parameter
88 Version: B
5 Service Commissioning Interface
Required. Corresponds to
EGRESSPOLI- the policy name in the
OCTET STRING Size (128) Downlink traffic policy ID
CY specific traffic policy
template.
Required. Corresponds to
INGRESS-
OCTET STRING Size (128) Uplink rule ID the name of the specific
RULE
traffic classification rule.
Required. Corresponds to
EGRESS-
OCTET STRING Size (128) Downlink rule ID the name of the specific
RULE
traffic classification rule.
Version: B 89
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Bind a traffic policy template and a traffic classification rule to PON port 2 in slot 1 of
the OLT with the IP address 10.190.40.216.
u Command issued
ADD-PORTBINDFLOWPOLICY::OLTID=10.190.40.216,PONID=NA-NA-1-2:CTAG::
INGRESSPOLICY=test3,EGRESSPOLICY=test4,INGRESSRULE=de_rule_7,
EGRESSRULE=de_rule_8;
u Response message
FH_10.170.163.215 2018-05-11 14:44:16
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
MODIFY-PORTBINDFLOWPOLICY
Function Description
This command is used to modify the traffic policy template bound with a port.
Command Format
MODIFY-PORTBINDFLOWPOLICY:: > PONID=ponport_location, > > EGRESSPOLICY=egresspolicy,INGRESSRULE=ingressrule,
EGRESSRULE=egressrule;
90 Version: B
5 Service Commissioning Interface
Input Parameter
Required. Corresponds to
EGRESSPOLI- the policy name in the
OCTET STRING Size (128) Downlink traffic policy ID
CY specific traffic policy
template.
Version: B 91
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Modify the traffic policy template and the traffic classification rule bound to PON port
2 in slot 1 of the OLT with the IP address 10.190.40.216.
u Command issued
MODIFY-PORTBINDFLOWPOLICY::OLTID=10.190.40.216,PONID=NA-NA-1-2:CTAG::
INGRESSPOLICY=test3,EGRESSPOLICY=test4,INGRESSRULE=de_rule_7,
EGRESSRULE=de_rule_8;
u Response message
FH_10.170.163.215 2018-05-11 15:26:35
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-PORTBINDFLOWPOLICY
92 Version: B
5 Service Commissioning Interface
Function Description
This command is used to modify the xDSL spectrum template bound with a port.
Command Format
BIND-DSLSPECPROFILE:: > PONID=ponport_location, > >
Input Parameter
IP address, name or ID of
OLTID OCTET STRING Size (128) Required for MSAN
the OLT
PON port location
information. Locate a port
Size (128) through the information rack
PONID OCTET STRING Rack - shelf - slot - - shelf - slot - PON port Required for MSAN
PON port number number. If any part of the
information is unavailable,
enter NA instead.
Required for an ONU
that has no
ONU identifier type (ONU_
management IP
ONUIDTYPE OCTET STRING Size (128) NAME, MAC, LOID, ONU_
address; optional for
NUMBER)
the MSAN public
platform card
Version: B 93
FiberHome Element Management System Northbound Interface (TL1) User Manual
PROFILE-
STRING Size (0 to -20) Template name -
NAME
Response Format
Output Parameter
None
Example
Modify the xDSL spectrum template to ppp123 for PON port 1 in slot 2 of the OLT
with the IP address 10.170.4.72.
u Command issued
BIND-DSLSPECPROFILE::OLTID=10.170.4.72,PONID=NA-NA-2-1:CTAG::
PROFILENAME=ppp123;
u Response message
FH_10.170.3.76 2018-08-7 16:36:23
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
94 Version: B
5 Service Commissioning Interface
Function Description
This command is used to modify the vDSL service template / xDSL rate template
bound with a port.
Command Format
BIND-XDSLSERVICEPROFILE:: > PONID=ponport_location, > >
Input Parameter
IP address, name or ID of
OLTID OCTET STRING Size (128) Required for MSAN
the OLT
PON port location
information. Locate a port
through the information
Size (128)
rack - shelf - slot - PON
PONID OCTET STRING Rack - shelf - slot - Required for MSAN
port number. If any part of
PON port number
the information is
unavailable, enter NA
instead.
Required for an ONU that
ONU identifier type (ONU_ has no management IP
ONUIDTYPE OCTET STRING Size (128) NAME, MAC, LOID, ONU_ address; optional for the
NUMBER) MSAN public platform
card
ONU identifier, used for
Required for an ONU that
uniquely identifying an
has no management IP
ONU connected to a PON
ONUID OCTET STRING Size (128) address; optional for the
port. The value can be
MSAN public platform
ONU_NAME, MAC, LOID
card
or ONU_NUMBER.
Version: B 95
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Modify the xDSL rate template to "hhh" for PON port 2 in slot 2 of the OLT with the
IP address 10.170.4.72.
u Command issued
BIND-XDSLSERVICEPROFILE::OLTID=10.170.4.72,PONID=NA-NA-2-2:CTAG::
PROFILENAME=hhh;
u Response message
FH_10.170.3.76 2018-08-07 20:47:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
96 Version: B
5 Service Commissioning Interface
Function Description
This command is used to bind the VDSL extended function template with a port.
Command Format
BIND-VDSLEXPROFILE:: > PROFILENAME=profile-name;
Input Parameter
Response Format
Output Parameter
None
Example
Bind the VDSL extended function template "tt" to PON port 1 in slot 2 of the OLT
with the IP address 10.171.0.31.
u Command issued
Version: B 97
FiberHome Element Management System Northbound Interface (TL1) User Manual
BIND-VDSLEXPROFILE::OLTID=10.171.0.31,PONID=NA-NA-2-1:CTAG::
PROFILENAME=tt;
u Response message
FH_10.170.3.76 2018-08-08 15:49:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
CFG-LINEIDENTIFIER:: > PONID=ponport_location, > ENABLE=enable,PPPOEENABLE=enable,
ACCESSNODEIDENTIFIER=IDENTIFIER,SUBOPTION=option,ACCESSTYPE=type,
IDTYPE=type,FORMATTYPE=type,USERDEFINEDFORMAT=format;
Input Parameter
98 Version: B
5 Service Commissioning Interface
1: ATM
ACCESSTYPE INTEGER Access type Required
2: ETH
1: line ID (circuit-id)
IDTYPE INTEGER 2: remote ID (remote- ID type Required
id)
Version: B 99
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
On PON port 1 in slot 2 of the OLT with the IP address 10.170.4.72, enable the
Option82 and PPPoE+, set the sub-option of the line ID format to dhcp-option82
and the access type to ATM, and define the line ID to rackrack.
u Command issued
CFG-LINEIDENTIFIER::OLTID=10.170.4.72,PONID=NA-NA-2-1:CTAG::
OPTION82ENABLE=enable,PPPOEENABLE=enable,
ACCESSNODEIDENTIFIER=IDENTIFIER,SUBOPTION=dhcp-option82,ACCESSTYPE=ATM,
IDTYPE=1,FORMATTYPE=3,USERDEFINEDFORMAT="rack"rack;
u Response message
FH_10.170.3.76 2018-08-13 15:19:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
100 Version: B
5 Service Commissioning Interface
Function Description
Command Format
BIND-DSLPVCPROFILE:: > PROFILENAME=profile-name;
Input Parameter
IP address, name or ID of
OLTID OCTET STRING Size (128) Required for MSAN
the OLT
PON port location
information. Locate a port
Size (128) through the information
Rack - shelf - slot rack - shelf - slot - PON
PONID OCTET STRING Required for MSAN
- PON port port number. If any part of
number the information is
unavailable, enter NA
instead.
Required for an ONU that
ONU identifier type (ONU_
has no management IP
ONUIDTYPE OCTET STRING Size (128) NAME, MAC, LOID, ONU_
address; optional for the
NUMBER)
MSAN public platform card
Version: B 101
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Bind the PVC template DEFPVC.PRF1 to PON port 1 in slot 2 of the OLT with the IP
address 10.170.4.72.
u Command issued
BIND-DSLPVCPROFILE::OLTID=10.170.4.72,PONID=NA-NA-2-1:CTAG::
PROFILENAME=DEFPVC.PRF1
u Response message
FH_10.170.3.76 2018-08-07 10:09:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
102 Version: B
5 Service Commissioning Interface
Function Description
This command is used for configuring or modifying the subscriber service ID.
Command Format
u ONU:
CFG-SUBSCRIBERNO::OLTID=olt-name,PONID=ponport_location,
> SUBSCRIBERNO=ID[,DESCRIPTION=userNO];
u MDU:
CFG-SUBSCRIBERNO:: > SUBSCRIBERNO=ID[,DESCRIPTION=userNO];
Input Parameter
Version: B 103
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1: Set the subscriber service ID to ASD on port 1 of the ONU with the ID 2,
which is connected to PON port 8 in slot 12 of the OLT with the IP address
10.190.40.239.
104 Version: B
5 Service Commissioning Interface
u Command issued
CFG-SUBSCRIBERNO::OLTID=10.190.40.239,PONID=NA-NA-12-8,
>
u Response message
FH_127.0.0.1 2019-02-28 14:15:00 M CATG COMPLD EN=0 ENDESC=No error ;
Example 2: Set the subscriber service ID to QWER on port 8 in slot 1 of the ONU
equipment AN5006-20 with the IP address 10.171.0.32.
u Command issued
CFG-SUBSCRIBERNO:: > SUBSCRIBERNO=QWER;
u Response message
FH_127.0.0.1 2019-02-28 14:16:12
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
CFG-ONUNAMEANDDESC::OLTID=olt-name,PONID=ponport_location,
> [>
Version: B 105
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
(Optional) ONU
ONUNAME OCTET STRING Size (128) ONU name name after
modification
ONU description. Chinese (Optional) ONU
ONUDESC OCTET STRING Size (128) characters should not be description after
contained. modification
Response Format
Output Parameter
None
Example
Modify the name and description of the ONU under PON port 1 in slot 7 of the OLT
equipment whose IP address is 10.171.0.31, altering the ONU name from test123
to test123456, and altering the ONU description to hello.
106 Version: B
5 Service Commissioning Interface
u Command issued
CFG-ONUNAMEANDDESC::OLTID=10.171.0.31,PONID=NA-NA-7-1, > >
u Response message
FH_10.170.3.76 2018-08-11 09:19:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
CFG-CARD:: > CARDTYPE=cardtype;
Input Parameter
OCTET
CARDTYPE Size (128) Card type Required
STRING
Version: B 107
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Authorize the EC4B card in slot 6 of the OLT equipment whose IP address is
10.190.40.11.
u Command issued
CFG-CARD::OLTID=10.190.40.11,BOARDID=NA-NA-6:CTAG::CARDTYPE=EC4B;
u Response message
FH_10.170.3.76 2018-08-11 09:19:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
BIND-ONUPROFILE::OLTID=olt-name,PONID=ponport_location, > type,>
108 Version: B
5 Service Commissioning Interface
Input Parameter
Response Format
Output Parameter
None
Example
Bind the template AAA to the ONU with the ID FHTT03317f08, which is connected
to PON port 1 in slot 6 of the OLT with the IP address 10.171.0.28.
u Command issued
BIND-ONUPROFILE::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-08-30 11:04:20
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: B 109
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
Command Format
CFG-MUF::OLTID=olt-name,VLANID=VLANID,VLANMODE=unknown-flood[,Rate Limit
=1000]:CTAG::;
Input Parameter
unknown-flood: flooding
of unknown multicast
u unknown-flood packets
VLANMODE OCTET STRING Required
u unknown-drop unknown-drop: dropping
unknown multicast
packets
Response Format
Output Parameter
None
110 Version: B
5 Service Commissioning Interface
Example
Configure or modify flooding of unknown multicast packets for the OLT equipment
whose IP address is 10.171.0.29.
Note:
If no flooding is configured for VLAN 1234, you can use the command to
add one; if flooding has been configured, you can use the command to
modify the configuration.
u Command issued
CFG-MUF::OLTID=10.171.0.29,VLANID=1234,VLANMODE=unknown-flood,
RATELIMIT=1000:CTAG::;
u Response message
FH_10.170.3.76 2018-08-11 09:19:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
LST-MUF
Function Description
This command is used to query the result of unknown multicast packet flooding.
Command Format
LST-MUF::OLTID=olt-name[,VLANID=VLAN ID]:CTAG::;
Version: B 111
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
Example
Query all the configured unknown multicast packet flooding for the OLT equipment
whose IP address is 10.171.0.29.
u Command issued
LST-MUF::OLTID=10.171.0.29:CTAG::;
u Response message
FH_127.0.0.1 2019-04-03 15:52:01
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Multicast unknown flood/drop Info:
-------------------------------------------------------
OLTID VLANIDVLANMODE RATELIMIT
10.171.0.29 1234unknown-flood1000
-------------------------------------------------------
112 Version: B
5 Service Commissioning Interface
Related Command
CFG-MUF
Function Description
This command is used for configuring the QinQ rate limit for an ONU.
Command Format
CFG-QINQLIMIT:: > > [UV=uv][,BW=band width name]:CTAG::;
Input Parameter
Version: B 113
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
114 Version: B
5 Service Commissioning Interface
Output Parameter
None
Example
Configure a rate limit for the ONU with the ID FHTT033466f8 connected to PON port
2 in slot 12 of the OLT equipment whose IP address is 10.171.0.106 via the test
bandwidth profile.
u Command issued
CFG-QINQLIMIT::OLTID=10.171.0.106,PONID=NA-NA-12-2, > >
u Response message
FH_10.170.3.76 2018-08-01 08:14:43
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
MODIFY-QINQLIMIT
LST-QINQLIMIT
Function Description
This command is used for modifying the QinQ rate limit of an ONU.
Command Format
MODIFY-QINQLIMIT:: > > [UV=uv][,BW=band width name]:CTAG::;
Version: B 115
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
None
116 Version: B
5 Service Commissioning Interface
Example
For the ONU with the ID FHTT033466f8 connected to PON port 2 in slot 12 of the
OLT equipment whose IP address is 10.171.0.106, query the QinQ domain name
and service sequence number based on the CVLAN ID 1000, and modify the
service rate limit via the test bandwidth profile.
u Command issued
MODIFY-QINQLIMIT::OLTID=10.171.0.106,PONID=NA-NA-12-2, > >
u Response message
FH_10.170.3.76 2018-08-02 10:22:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for querying the QinQ rate limit for an ONU.
Command Format
LST-QINQLIMIT:: > >
Input Parameter
Version: B 117
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
118 Version: B
5 Service Commissioning Interface
Example
Query the QinQ rate limit configured for the ONU with the ID FHTT033466f8
connected to PON port 1 in slot 3 of the OLT whose IP address is 10.171.0.16.
u Command issued
LST-QINQLIMIT::OLTID=10.171.0.16,PONID=NA-NA-3-1, > >
u Response message
Related Command
CFG-QINQLIMIT
MODIFY-QINQLIMIT
Version: B 119
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
CFG-ONUPORTDESCRIPTION:: > PONID=ponport_location, > >
Input Parameter
120 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Set the description of port 2 in slot 2 of the ONU whose IP address is 10.190.47.236
to "hello123".
u Command issued
CFG-ONUPORTDESCRIPTION:: > DESCRIPTION=hello123:CTAG::;
u Response message
FH_10.170.159.1082019-10-1517:07:14
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
LST-ONUPORTDESCRIPTION
Version: B 121
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used to query the description of a specific port on the AN5006-20 /
AN5006-30.
Command Format
LST-ONUPORTDESCRIPTION:: > PONID=ponport_location, > >
Input Parameter
122 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
Required for an
IP address, name or ID ONU that has no
OLTID OCTET STRING Size (128)
of the OLT management IP
address
PON port location
information. Locate a
port through the
Required for an
Size (128) information rack-shelf-
ONU that has no
PONID OCTET STRING Rack-shelf-slot-PON slot-PON port number.
management IP
port number If any part of the
address
information is
unavailable, enter NA
instead.
Version: B 123
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
LST-ONUPORTDESCRIPTION::>
u Response message
FH_10.170.159.1082019-10-1517:10:17
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
124 Version: B
5 Service Commissioning Interface
Related Command
CFG-ONUPORTDESCRIPTION
Function Description
Command Format
CFG-PORTISOLATION::OLTID=olt-name,PONID=ponport_location,
>
Input Parameter
Version: B 125
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1: Disable port isolation for ONU 1 connected to PON port 1 in slot 8 of the
OLT equipment whose IP address is 10.171.0.39.
u Command issued
CFG-PORTISOLATION::OLTID=10.171.0.39,PONID=NA-NA-8-1,
>
u Response message
FH_127.0.0.12019-03-2810:28:36
MCTAGCOMPLD
EN=0ENDESC=Noerror
Example 2: Enable port isolation for ONU 1 connected to PON port 1 in slot 8 of the
OLT equipment whose IP address is 10.171.0.39.
u Command issued
CFG-PORTISOLATION::OLTID=10.171.0.39,PONID=NA-NA-8-1,
>
u Response message
FH_127.0.0.12019-03-2810:36:41
MCTAGCOMPLD
EN=0ENDESC=Noerror
;
Related Command
None
126 Version: B
5 Service Commissioning Interface
Function Description
Command Format
CFG-CATVPORT:: > >
Input Parameter
Version: B 127
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Configure a service at the CATV port of ONU 4 connected to PON port 1 in slot 4 of
the OLT equipment whose IP address is 10.190.5.217, setting the output level
adjustment value to -20.
u Command issued
CFG-CATVPORT::OLTID=10.190.5.217,PONID=NA-NA-4-1, > >
u Response message
FH_127.0.0.12019-03-0610:40:41
MCTAGCOMPLD
EN=0ENDESC=Noerror
;
Related Command
None
128 Version: B
5 Service Commissioning Interface
Function Description
This command is used for querying the information about a service configured for an
ONU's CATV port.
Command Format
LST-CATVPORT:: > >
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Version: B 129
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Indicates whether to
activate a port. When
Y delivered, the setting is
ENABLE OCTET STRING Required
N converted into the integer 1
or 0 by default. The default
value is Y.
OUTPUT
INT -127 to 127 - Required
OFFSET
Example
Query the information about the service configured for the CATV port of ONU 4
connected to PON port 1 in slot 4 of the OLT whose IP address is 10.190.5.217.
u Command issued
LST-CATVPORT::OLTID=10.190.5.217,PONID=NA-NA-4-1, > >
u Response message
FH_127.0.0.12019-03-0614:10:24
MCTAGCOMPLD
130 Version: B
5 Service Commissioning Interface
total_blocks=1
block_number=1
block_records=1
Related Command
None
Function Description
Command Format
CFG-WPS::OLTID=olt-name,PONID=ponport_location, > >
Input Parameter
OLTID OCTET STRING Size (128) IP address, name or ID of the OLT Required
Version: B 131
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Disable the WPS function for the ONU with the MAC address 000000000007
connected to PON port 1 in slot 6 of the OLT equipment whose IP address is
10.171.0.34.
u Command issued
CFG-WPS::OLTID=10.171.0.34,PONID=NA-NA-6-1, > >
u Response message
FH_127.0.0.12019-03-2710:40:41
MCTAGCOMPLD
EN=0ENDESC=Noerror
;
Related Command
None
Function Description
132 Version: B
5 Service Commissioning Interface
Command Format
LST-WPS::OLTID=olt-name,PONID=ponport_location, > >
Input Parameter
OLTID OCTET STRING Size (128) IP address, name or ID of the OLT Required
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Version: B 133
FiberHome Element Management System Northbound Interface (TL1) User Manual
0: disable
2.4GEnable INTEGER Enables or disables 2.4G.
1: enable
0: disable
5GEnable INTEGER Enables or disables 5G.
1: enable
Example
Query the WPS status of the ONU with the MAC address 000000000007 connected
to PON port 1 in slot 6 of the OLT equipment whose IP address is 10.171.0.34.
u Command issued
LST-WPS::OLTID=10.171.0.34,PONID=NA-NA-6-1, > >
u Response message
FH_127.0.0.12019-03-2809:59:55
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
Function Description
Command Format
CFG-PORTFORWARDING::OLTID=olt-name,PONID=ponport_location,
>
134 Version: B
5 Service Commissioning Interface
Input Parameter
Required
The end public port
PUBLICPOR-
INTEGER 1 to 65535 End public port number number is greater than
TEND
or equal to the start
public port number.
Required
IP address An IPv4 address is
IP OCTETSTRING Size (32)
General IP address format supported only, and no
mask is required.
Version: B 135
FiberHome Element Management System Northbound Interface (TL1) User Manual
Required
The end private port
PRIVATEPOR-
INTEGER 1 to 65535 End private port number number is greater than
TEND
or equal to the start
private port number.
1: TCP
PROTOCOL-
INTEGER 2: UDP Protocol Optional
TYPE
3: ALL
0: disable
ENABLE INTEGER Switch Optional
1: enable
Response Format
Output Parameter
None
Example
Configure port forwarding parameters for ONU 1 connected to PON port 3 in slot 8
of the OLT equipment whose IP address is 10.171.0.39.
u Command issued
CFG-PORTFORWARDING::OLTID=10.171.0.39,PONID=NA-NA-8–3,
> PUBLICPORTEND=10,IP=10.10.10.10,PRIVATEPORTSTART=2,PRIVATEPORTEND=5,
PROTOCOLTYPE=3,ENABLE=0;
u Response message
FH_127.0.0.12019-04-0219:10:36
MCTAGCOMPLD
EN=0ENDESC=Noerror
136 Version: B
5 Service Commissioning Interface
Related Command
None
Function Description
Command Format
LST-PORTFORWARDING::OLTID=olt-name,PONID=ponport_location,
>
Input Parameter
OLTID OCTET STRING Size (128) IP address, name or ID of the OLT Required
Response Format
It complies with the query command response format in Response Message Format.
Version: B 137
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
PRIVATEPORT-
INTEGER 1 to 65535 Start private port number
START
PRIVATEPOR-
INTEGER 1 to 65535 End private port number
TEND
1: TCP
PROTOCOL-
INTEGER 2: UDP Protocol
TYPE
3: ALL
0: disable
ENABLE INTEGER Switch
1: enable
Example
None
Related Command
None
138 Version: B
5 Service Commissioning Interface
Function Description
This command is used for configuring the local management interface of an ONU.
Command Format
CFG-ONULOCALMANAGEINTERFACE::OLTID=olt-name,PONID=ponport_location,
> TELNETUNI=0,WEBUNI=1,WEBSERVICEPORT=80,WEBANI=0,TELNETANI=0,WEBADMIN=0
[,ICMPANI=0,ICMPUNI=0,SSHANI=0,SSHUNI=0,SNMPANI=0,SNMPUNI=0,TFTPANI=0,
TFTPUNI=0,FTPANI=0,FTPUNI=0];
Input Parameter
Version: B 139
FiberHome Element Management System Northbound Interface (TL1) User Manual
0: disable
CONSOLE INTEGER Serial port Required
1: enable
0: disable
TELNETUNI INTEGER Telnet user side Required
1: enable
0: disable
WEBUNI INTEGER Web user side Required
1: enable
WEBSERVI- 1024-65535, 80,
INTEGER Web service port Required
CEPORT 0
0: disable
WEBANI INTEGER Web network side Required
1: enable
0: disable
TELNETANI INTEGER Telnet network side Required
1: enable
0: disable Web administrator account
WEBADMIN INTEGER Required
1: enable switch
0: disable
ICMPANI INTEGER ICMP network side (Optional) Test requirement
1: enable
0: disable
ICMPUNI INTEGER ICMP user side (Optional) Test requirement
1: enable
0: disable
SSHANI INTEGER SSH network side (Optional) Test requirement
1: enable
0: disable
SSHUNI INTEGER SSH user side (Optional) Test requirement
1: enable
0: disable
SNMPANI INTEGER SNMP network side (Optional) Test requirement
1: enable
0: disable
SNMPUNI INTEGER SNMP user side (Optional) Test requirement
1: enable
0: disable
TFTPANI INTEGER TFTP network side (Optional) Test requirement
1: enable
0: disable
TFTPUNI INTEGER TFTP user side (Optional) Test requirement
1: enable
140 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Configure a local management interface for ONU 1 connected to PON port 3 in slot
8 of the OLT equipment whose IP address is 10.171.0.39.
u Command issued
CFG-ONULOCALMANAGEINTERFACE::OLTID=10.171.0.39,PONID=NA-NA-8–3,
> TELNETUNI=0,WEBUNI=1,WEBSERVICEPORT=11111,WEBANI=0,TELNETANI=0,
WEBADMIN=0[,ICMPANI=0,ICMPUNI=0,SSHANI=0,SSHUNI=0,SNMPANI=0,SNMPUNI=1,
TFTPANI=1,TFTPUNI=1,FTPANI=1,FTPUNI=1];
u Response message
FH_127.0.0.12019-04-0219:53:00
MCTAGCOMPLD
EN=0ENDESC=Noerror
Related Command
None
Version: B 141
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
LST-ONULOCALMANAGEINTERFACE::OLTID=olt-name,PONID=ponport_location,
>
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
142 Version: B
5 Service Commissioning Interface
Output Parameter
0: disable
CONFIGENABLE INTEGER Enable or disable the configuration.
1: enable
0: disable
CONSOLE INTEGER Serial port
1: enable
0: disable
TELNETUNI INTEGER Telnet user side
1: enable
0: disable
WEBUNI INTEGER Web user side
1: enable
WEBSERVICE- 0: disable
INTEGER Web service port
PORT 1: enable
0: disable
WEBANI INTEGER Web network side
1: enable
0: disable
TELNETANI INTEGER Telnet network side
1: enable
0: disable
WEBADMIN INTEGER Web administrator account switch
1: enable
0: disable
ICMPANI INTEGER ICMP network side
1: enable
0: disable
ICMPUNI INTEGER ICMP user side
1: enable
0: disable
SSHANI INTEGER SSH network side
1: enable
0: disable
SSHUNI INTEGER SSH user side
1: enable
0: disable
SNMPANI INTEGER SNMP network side
1: enable
Version: B 143
FiberHome Element Management System Northbound Interface (TL1) User Manual
0: disable
SNMPUNI INTEGER SNMP user side
1: enable
0: disable
TFTPANI INTEGER TFTP network side
1: enable
0: disable
TFTPUNI INTEGER TFTP user side
1: enable
0: disable
FTPANI INTEGER FTP network side
1: enable
0: disable
FTPUNI INTEGER FTP user side
1: enable
Example
Query the local management interface of ONU 1 connected to PON port 3 in slot 8
of the OLT equipment whose IP address is 10.171.0.39.
u Command issued
LST-ONULOCALMANAGEINTERFACE::OLTID=10.171.0.39,PONID=NA-NA-8-3,
>
u Response message
Related Command
None
144 Version: B
5 Service Commissioning Interface
Function Description
Command Format
AUTOACTIVE-ONUVOICE::OLTID=olt-name,PONID=ponport_location,
> SVLAN=outer_vlan,CVLAN=inner_VLAN;
Supported Device
Input Parameter
Version: B 145
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Configure the voice service for voice port 1 of the ONU (having no management IP
address) connected to PON port 1 in slot 5 of the OLT whose IP address is
10.171.0.16. The information of the ONU is as follows: ONUID is 54-4b-40-76-6c-
28; the authentication mode is MAC.
u Command issued
AUTOACTIVE-ONUVOICE::OLTID=10.171.0.16,PONID=NA-NA-5-1, > >
u Response message
FH_10.170.162.31 2018-05-30 09:42:53
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
146 Version: B
5 Service Commissioning Interface
Function Description
This command is used for binding the digitmap with the ONU.
Command Format
BIND-DIGITMAPPROFILE::OLTID=olt-name,PONID=ponport_location,
> DIGITMAP=DigitMap]:CTAG::;
Input Parameter
Response Format
Version: B 147
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
Example
u Command issued
BIND-DIGITMAPPROFILE::OLTID=172.27.16.234,PONID=NA-NA-13-2,
> DIGITMAPPROFILE=centrex4;
u Response message
FH_10.170.162.31 2019-05-30 19:53:41
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
UNBIND-DIGITMAPPROFILE
Function Description
This command is used for unbinding the digitmap from the ONU.
Command Format
UNBIND-DIGITMAPPROFILE::OLTID=olt-name,PONID=ponport_location,
> CTAG::;
148 Version: B
5 Service Commissioning Interface
Input Parameter
Response Format
Output Parameter
None
Example
u Command issued
UNBIND-DIGITMAPPROFILE::OLTID=172.26.48.106,PONID=NA-NA-1-6,
> DIGITMAPPROFILE=centrex4;
u Response message
FH_10.170.162.31 2019-05-31 09:41:52
M CTAG COMPLD
EN=0 ENDESC=No error
Version: B 149
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
BIND-DIGITMAPPROFILE
The following introduces how to configure the broadband and IPTV services of a
LAN port.
Function Description
This command is used for activating a LAN port of the ONU to enable it.
Command Format
ACT-LANPORT:: > >
Supported Device
Input Parameter
150 Version: B
5 Service Commissioning Interface
Response 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 Command issued
ACT-LANPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
Version: B 151
FiberHome Element Management System Northbound Interface (TL1) User Manual
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::>
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
Function Description
This command is used for deactivating a LAN port of the ONU to disable it.
Command Format
DACT-LANPORT:: > >
Supported Device
152 Version: B
5 Service Commissioning Interface
Input Parameter
Response Format
Output Parameter
None
Version: B 153
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
DACT-LANPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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::>
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
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.
154 Version: B
5 Service Commissioning Interface
Command Format
CFG-LANPORT:: > > width][,VLANMOD=mode][,PVID=vlan id][,PCOS=port qos];
Supported Device
Input Parameter
Version: B 155
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
u Command issued
156 Version: B
5 Service Commissioning Interface
CFG-LANPORT::OLTID=10.78.11.102,PONID=NA-NA-15-2, > > 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
;
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::>
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
Function Description
This command is used for configuring the bandwidth for a LAN port.
Prerequisite
Before using the command, ensure the bandwidth template is configured on the OLT.
Command Format
CFG-LANPORTBW:: > > [BW=bandwidth];
Version: B 157
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Device
Input Parameter
158 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Bind the bandwidth template "rrr" to LAN port 1 of the ONU (having no management
IP address) connected to PON port 1 in slot 5 of the OLT whose IP address is
10.171.0.16. The information of the ONU is as follows: ONUID is 54-4b-40-76-6c-
28; the authentication mode is MAC.
u Command issued
CFG-LANPORTBW::OLTID=10.171.0.16,PONID=NA-NA-5-1, > >
u Response message
FH_10.170.162.31 2018-05-29 13:30:32
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: B 159
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used for configuring the VLAN information for an OLT PON port.
Command Format
ADD-PONVLAN::OLTID=olt-name,PONID=ponport_location, > > SCOS=outerqos][,CCOS=innerqos][,UCOS=ucos][,SERVICETYPE=servicetype][,
SVCMODPROFILE=servicemodelprofile][,GEMPORT=0];
Input Parameter
160 Version: B
5 Service Commissioning Interface
Version: B 161
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
162 Version: B
5 Service Commissioning Interface
Example
Configure the VLAN information for port 1 of the ONU with the MAC address 54-4B-
40-04-2C-1E connected to PON port 1 in slot 3 of the OLT equipment whose IP
address is 10.250.18.100.
u Command issued
ADD-PONVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
FH_10.170.162.31 2018-05-29 13:50:32
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
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, > type,>
Input Parameter
Version: B 163
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response 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, > >
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
164 Version: B
5 Service Commissioning Interface
Function Description
This command is used for configuring the VLAN information of a LAN port.
Command Format
CFG-LANPORTVLAN:: > > [SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan][,SCOS=outer qos][,
CCOS=inner qos];
Input Parameter
Version: B 165
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
u Command issued
CFG-LANPORTVLAN::OLTID=172.16.84.58,PONID=NA-NA-5-6, > >
u Response message
FH_10.98.100.16 2014-06-12 15:45:15
166 Version: B
5 Service Commissioning Interface
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
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, > type,>
Input Parameter
Version: B 167
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response 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, > >
u Response message
FH_10.78.20.120 2011-02-22 15:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
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:: > CCOS=3;
168 Version: B
5 Service Commissioning Interface
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
Function Description
This command is used for configuring the IPTV service of a LAN port.
Command Format
CFG-LANIPTVPORT:: > > [FLMODE=iptv-fastleave-mode][,MAXGRP=Max-group-number];
Supported Device
Input Parameter
Version: B 169
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1: Configure a multicast service with the fast leave mode being enabled
and MAXGRP being 23 for LAN port 1 of the ONU (having no management IP
address) with ONUID being 54-4B-40-04-2C-1E. The ONU is connected to PON
port 1 in slot 3 of the OLT whose IP address is 10.250.18.100. The ONU is
authenticated by MAC address.
u Command issued
CFG-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1, > > MAXGRP=23;
170 Version: B
5 Service Commissioning Interface
u Response message
FH_10.78.20.120 2011-02-22 09:17:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2: Configure a multicast service for 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
CFG-LANIPTVPORT:: > FLMODE=Enabled,MAXGRP=32;
u Response message
FH_10.78.20.1202011-02-2209:17:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-LANIPTVPORT
DEL-LANIPTVPORT
Function Description
This command is used for adding a LAN port into a multicast VLAN.
Command Format
ADD-LANIPTVPORT:: > > vlan][,MVLAN=mvlan] [,UCOS=ucos] [,MCOS=mcos][,SVCMODPROFILE=svc mod
profile][,GEMPORT=0];
Version: B 171
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Required. Specified
MVLAN INTEGER 1 to 4085 Associated multicast VLAN multicast VLAN for
service provisioning
172 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Add port 2 of the ONU with the MAC address FHTT02CEE2B0 to the multicast
VLAN. The ONU is connected to PON port 14 in slot 5 of the OLT whose IP address
is 172.16.84.58.
u Command issued
ADD-LANIPTVPORT::OLTID=172.16.84.58,PONID=NA-NA-5-14, > >
Version: B 173
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
FH_10.98.100.16 2019-06-13 15:45:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for deleting a LAN port from a multicast VLAN.
Command Format
DEL-LANIPTVPORT:: > > [UV=uservlan][,MVLAN=mvlan];
Input Parameter
174 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Delete port 4 of the ONU with the MAC address FHTT92524528 from the multicast
VLAN. The ONU is connected to PON port 5 in slot 5 of the OLT whose IP address
is 172.25.81.18.
u Command issued
DEL-LANIPTVPORT::OLTID=172.25.81.18,PONID=NA-NA-5-5, > >
Version: B 175
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
FH_10.78.12.155 2018-09-16 09:31:05
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
CFG-NONOMCIMPATHCONFIG::OLTID=olt-name,PONID=ponport_location,
> ManageCVlanId=9][,ManageCVlanCos=7];
Supported Device
Input Parameter
176 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
u Command issued
CFG-NONOMCIMPATHCONFIG::OLTID=10.78.200.200,PONID=NA-NA-4-2,
> ManageCVlanCos=3;
u Response message
FH_10.78.20.1202011-02-2114:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: B 177
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
CFG-VEIPSERVICE::OLTID=olt-name,PONID=ponport_location, > type, > CVLANID=cvlan-id][,CCOS=ccos][,TVLANID=tvlan][,TCOS=tcos][,
ServiceType=ServiceType][,UpAssuredRateLimit=xxx][,
DownAssuredRateLimit=xxx][,ServiceModelProfile=xxx][,GEMPORT=0];
Input Parameter
178 Version: B
5 Service Commissioning Interface
(Optional) Corresponds
to "CVLAN ID" in the
CVLANID INTEGER - CVLAN ID
VEIP data service
configuration.
Version: B 179
FiberHome Element Management System Northbound Interface (TL1) User Manual
180 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Configure the VEIP data service at port 1 of the ONU with the LOID "test123"
connected to PON port 1 in slot 7 of the OLT equipment whose IP address is
10.171.0.31.
u Command issued
Version: B 181
FiberHome Element Management System Northbound Interface (TL1) User Manual
CFG-VEIPSERVICE::OLTID=10.171.0.31,PONID=NA-NA-7-1, > > UpAssuredRateLimit=111,DownAssuredRateLimit=222,
ServiceModelProfile=666,ServiceType=VOIP;
u Response message
FH_10.98.100.16 2019-06-13 15:50:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
MODIFY-VEIPSERVICE::OLTID=olt-name,PONID=ponport_location,
> [ServiceId=1][,CVLANID=cvlan-id][,CCOS=ccos][,TVLANID=tvlan][,
TCOS=tcos][,ServiceType=service-type][,UpAssuredRateLimit=xxx][,
DownAssuredRateLimit=xxx][,ServiceModelProfile=xxx][,GEMPORT=0];
Input Parameter
182 Version: B
5 Service Commissioning Interface
Version: B 183
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
184 Version: B
5 Service Commissioning Interface
Example
Modify parameters of the VEIP data service at port 1 of the ONU with the LOID
"test123" connected to PON port 1 in slot 7 of the OLT equipment whose IP address
is 10.171.0.31.
u Command issued
MODIFY-VEIPRATELIMIT::OLTID=10.171.0.31,PONID=NA-NA-7-1, > > UpAssuredRateLimit=333,DownAssuredRateLimit=444,ServiceType=IPTV;
u Response message
FH_10.98.100.16 2019-06-13 15:51:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to unbind a bandwidth template from a VEIP data service on
a LAN port.
Command Format
UNBIND-VEIPSERVICE:: > > ServiceId=service-id;
Version: B 185
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
None
186 Version: B
5 Service Commissioning Interface
Example
Unbind a bandwidth template from a VEIP data service of LAN port 1 on the ONU
with the ID 1, which is connected to PON port 5 in slot 4 on the OLT device with the
IP address 10.171.0.16.
u Command issued
UNBIND-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,
>
u Response message
FH_10.78.20.1202011-02-2114:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Function Description
This command is used to delete a VEIP data service configuration of a LAN port.
Command Format
DEL-VEIPSERVICE:: > > ServiceId=service-id:CTAG::;
Input Parameter
Version: B 187
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Delete the VEIP data service at port 1 of the ONU with the LOID "test123"
connected to PON port 1 in slot 7 of the OLT equipment whose IP address is
10.171.0.31.
u Command issued
DEL-VEIPSERVICE::OLTID=10.171.0.31,PONID=NA-NA-7-1, > >
u Response message
FH_10.98.100.16 2019-06-13 15:55:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
188 Version: B
5 Service Commissioning Interface
Function Description
Command Format
LST-VEIPSERVICE:: > > [ServiceId=service-id];
Input Parameter
OLTID OCTET STRING Size (128) IP address, name or ID of the OLT Required
Response Format
It complies with the query command response format in Response Message Format.
Version: B 189
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
Query the VEIP data service at port 5 of the ONU with the MAC address
FHTT92f44368 connected to PON port 9 in slot 12 of the OLT equipment whose IP
address is 10.171.0.106.
u Command issued
LST-VEIPSERVICE::OLTID=10.171.0.106,PONID=NA-NA-12-9, > >
u Response message
FH_10.170.95.55 2019-10-09 12:16:51
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=0
190 Version: B
5 Service Commissioning Interface
Related Command
None
Function Description
This command is used to configure or modify the three parameters (i.e., auto-
negotiation, flow rate and duplex) of a service at a LAN port when the OLT uses a
core switch card with the version 4.0 or later.
Command Format
CFG-LANSERVICEPARAM::OLTID=olt-name,PONID=ponport_location,
> [AUNEGO=AUGEO,SPEED=speed,DUPLEX=duplex];
Input Parameter
Version: B 191
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
192 Version: B
5 Service Commissioning Interface
Example
u Command issued
CFG-LANSERVICEPARAM::OLTID=10.171.0.106,PONID=NA-NA-12-1,
> SPEED=10M,DUPLEX=half;
u Response message
FH_10.168.20.45 2019-01-09 17:07:14
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to query the three parameters (i.e., auto-negotiation, flow
rate and duplex) of a service at a LAN port when the OLT uses a core switch card
with the version 4.0 or later.
Command Format
LST-LANSERVICEPARAM::OLTID=olt-name,PONID=ponport_location,
>
Version: B 193
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
194 Version: B
5 Service Commissioning Interface
Example
Query parameters of the service at port 1 of ONU 1 connected to PON port 1 in slot
12 of the OLT equipment whose IP address is 10.171.0.106.
u Command issued
LST-LANSERVICEPARAM::OLTID=10.171.0.106,PONID=NA-NA-12-1,
>
u Response message
FH_10.168.20.45 2019-01-09 17:13:03
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
Version: B 195
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
SET-LOOPDETECT::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
196 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Set the loop detection status for voice port 1 of the ONU (having no management IP
address) connected to PON port 1 in slot 5 of the OLT whose IP address is
10.171.0.16. The information of the ONU is as follows: ONUID is 54-4b-40-76-6c-
28; the authentication mode is MAC.
u Command issued
AUTOACTIVE-ONUVOICE::OLTID=10.171.0.16,PONID=NA-NA-5-1, > >
u Response message
FH_10.170.162.31 2018-05-29 14:05:26
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: B 197
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used to query the ONU status data, i.e., the test status of the port
loop detection.
Command Format
LST-LOOPDETECT::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
198 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
Related Command
None
Version: B 199
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
ACT-DSLPORT:: > >
Supported Device
Input Parameter
200 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
u Command issued
ACT-DSLPORT::>
u Response message
FH_10.78.20.120 2011-02-22 17:13:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DACT-DSLPORT
Version: B 201
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
DACT-DSLPORT:: > >
Supported Device
Input Parameter
202 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
u Command issued
DACT-DSLPORT::>
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
Version: B 203
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Note:
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:: > > BW=bandwidth;
Input Parameter
204 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Configure the bandwidth of DSL port 2 of the ONU with MAC address being
FHTT92f44368. The ONU is connection to PON port 9 in slot 12 of the OLT whose
IP address is 10.171.0.106.
u Command issued
CFG-DSLPORTBW::OLTID=10.171.0.106,PONID=NA-NA-12-9, > >
u Response message
FH_10.170.95.55 2019-10-09 14:25:48
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: B 205
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for configuring the VLAN information of a DSL port.
Command Format
CFG-DSLPORTVLAN:: > > [,VCI=vci][,SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan][,
CVLANMODE=cvlanmode];
Note:
Input Parameter
206 Version: B
5 Service Commissioning Interface
SERVICE-
STRING Size (128) ServiceID (Malaysia) Optional
TAG
Oman customized
1: TAG requirement UNM2000 V2R7
CVLAN- (Optional) The default value is
STRING 2: translation 1: tag;
MODE 3.
3: transparent 2: translation
3: transparent
Response Format
Output Parameter
None
Example
Set the VLAN of DSL port 1 of the ONU whose IP address is 10.171.0.47 to 4050.
u Command issued
CFG-DSLPORTVLAN::>
Version: B 207
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
FH_10.170.95.55 2019-10-10 11:03:08
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for deleting the VLAN information of a DSL port.
Command Format
DEL-DSLPORTVLAN:: > > [,VCI=vci][,SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan];
Input Parameter
208 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Delete the VLAN information of the DSL port 1 of the ONU whose IP address is
10.171.0.47.
u Command issued
DEL-DSLPORTVLAN::>
u Response message
FH_10.170.95.55 2019-10-10 11:04:24
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: B 209
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for adding a multicast user for a DSL port.
Command Format
ADD-DSLIPTVPORT:: > > [UV=uservlan][VPI=vpi][,VCI=vci][,MVLAN=mvlan];
Input Parameter
210 Version: B
5 Service Commissioning Interface
SERVICE-
STRING Size (128) ServiceID (Malaysia) Optional
TAG
Response Format
Output Parameter
None
Example
Add a multicast user for DSL port 3 of the ONU whose IP address is 10.190.47.236.
u Command issued
ADD-DSLIPTVPORT::>
u Response message
FH_10.170.95.55 2019-10-10 10:51:48
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: B 211
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used for deleting the multicast service of a DSL port.
Command Format
DEL-DSLIPTVPORT:: > > [,VCI=vci][UV=user vlan][,MVLAN=mvlan];
Input Parameter
Parame-
Data Type Value Range Description Remark
ter
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address
OCTET IP address, name or ID of the Required for an ONU that has no
OLTID Size (128)
STRING OLT management IP address
212 Version: B
5 Service Commissioning Interface
Parame-
Data Type Value Range Description Remark
ter
Locate a card port through the
Size (128)
information rack - shelf - slot -
ONU- OCTET Rack - shelf -
port number. If any part of the Required
PORT STRING slot - port
information is unavailable, enter
number
NA instead.
Optional. It is required for ADSL
VPI INTEGER - Vpi
or VDSL working in ADSL mode.
Response 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.
u Command issued
DEL-DSLIPTVPORT:: > 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
;
Version: B 213
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
ADD-DSLIPTVPORT
Function Description
This command is used for configuring the IPTV service of a DSL port.
Command Format
CFG-DSLIPTVPORT:: > > FLMODE][,MAXGRP=Max-group-number];
Input Parameter
Parame-
Data Type Value Range Description Remark
ter
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address
OCTET IP address, name or ID of the Required for an ONU that has no
OLTID Size (128)
STRING OLT management IP address
214 Version: B
5 Service Commissioning Interface
Parame-
Data Type Value Range Description Remark
ter
Locate a card port through the
Size (128)
information rack - shelf - slot -
ONU- OCTET Rack - shelf -
port number. If any part of the Required
PORT STRING slot - port
information is unavailable, enter
number
NA instead.
Optional. Applicable to the MSAN
UV INTEGER - Port signaling VLAN card port parameter protocol. The
default value is 0.
Fast leave mode:
OCTET
FLMODE Size (32) Enabled Optional
STRING
Disabled
Maximum number of multicast
MAXGRP INTEGER - programs that a port can join Optional
simultaneously.
Response 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:: > 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: B 215
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
DEL-DSLIPTVPORT
ADD-DSLIPTVPORT
Function Description
Command Format
REST-DSLPORT::OLTID=olt_name,PONID=ponport_locationREST-DSLPORT:CTAG::;
Input Parameter
Response Format
Output Parameter
None
Example
u Command issued
REST-DSLPORT::OLTID=10.182.1.105,PONID=NA-NA-11-02:CTAG::;
216 Version: B
5 Service Commissioning Interface
u Response message
FH_10.170.110.27 2019-01-08 07:07:14
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to modify the DSL line template bound with a port.
Command Format
CHG-PORT-TEMPLATE:: > PONID=ponport_location, > >
Response Format
Output Parameter
None
Example
Modify the DSL line template bound with the DSL port connected to PON port 1 in
slot 7 of the OLT whose IP address is 10.190.47.236.
u Command issued
CHG-PORT-TEMPLATE::OLTID=10.190.47.236,PONID=NA-NA-7-1:CTAG::
TEMPLATENAME=adsl;
u Response message
Version: B 217
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
The following introduces how to activate / deactivate a VoIP port, and configure /
delete the voice service of the VoIP port.
Function Description
Command Format
ACT-VOIPPORT:: > >
Supported Device
Input Parameter
218 Version: B
5 Service Commissioning Interface
Response 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, > >
u Response message
Version: B 219
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command issued
ACT-VOIPPORT::>
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
Function Description
Command Format
DACT-VOIPPORT:: > >
Supported Device
220 Version: B
5 Service Commissioning Interface
Input Parameter
Response Format
Output Parameter
None
Version: B 221
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
DACT-VOIPPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
FH_10.78.20.120 2011-02-21 18:11:12
M CTAG COMPLD
EN=0 ENDESC=No error
;
u Command issued
DACT-VOIPPORT::>
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
Function Description
The command is used for configuring the voice service of a VoIP port.
222 Version: B
5 Service Commissioning Interface
Command Format
CFG-VOIPSERVICE:: > > [PHONENUMBER=phone number][,PT=protocol type][,SLVAN=voip outer vlan][,
VOIPVLAN=voip inner vlan][,SCOS=outer qos][,CCOS=inner qos][,EID=equipment
id][TID=Terminal-ID][SIPREGDM=sip register domain][,SIPUSERNAME=sip user
name][,SIPUSERPWD=sip user password][MGCIP1=active bac ip][,MGCIP2=standby
bac ip][,IPMODE=ip mode][,IP=ip address,IPMASK=ip mask,IPGATEWAY=ip
gateway][,PPPOEUSER=pppoe user,PPPOEPWD=pppoe password],
VOICECODEC=voice;
Input Parameter
Version: B 223
FiberHome Element Management System Northbound Interface (TL1) User Manual
OCTET
SIPREGDM Size (1 to 32) SIP register server Optional
STRING
SIPUSER- OCTET Username corresponding to Optional. It is required for the
Size (1 to 32)
NAME STRING the SIP user port SIP protocol.
224 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
u Command issued
CFG-VOIPSERVICE::OLTID=172.16.84.58,PONID=NA-NA-5-14, > > PT=SIP,SIPREGDM=brisanet.net,SIPUSERNAME=8821444681,
SIPUSERPWD=yyrbdlxlimia,IPMODE=DHCP,CCOS=3,VOIPVLAN=2708,SIPPROXY-
SERVER=Voip;
u Response message
FH_10.98.100.16 2019-06-12 15:45:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: B 225
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
The command is used for deleting the voice service of a VoIP port.
Command Format
DEL-VOIPSERVICE::OLTID=olt-name,PONID=ponport_location,
>
Supported Device
Input Parameter
Response Format
226 Version: B
5 Service Commissioning Interface
Output Parameter
None
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, > >
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:: > 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
Version: B 227
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for configuring the NGN uplink interface parameters,
including the uplink MGC and SIP server information.
Command Format
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_server-
ipaddress,SIPPROPORT=sip_proxy_server_port,SIPEXP=sip_expires,
STATUS=enable;
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_server-
ipaddress,SIPPROPORT=sip_proxy_server_port,SIPEXP=sip_expires],
STATUS=status;
Input Parameter
228 Version: B
5 Service Commissioning Interface
1 to 65535
SLAVEDNS OCTET STRING Standby DNS server -
(sample:lefefefe)
SIPPROSER-
STRING Size (0 to 64) SIP proxy server address -
VER
SIPPROPORT INTEGER 1 to 65535 SIP proxy server port -
1: create 1: create
STATUS INTEGER -
2: delete 2: delete
Response 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
Version: B 229
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
FH_10.78.12.155 2014-07-16 14:00:31
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to modify the voice code of a VOIP port voice service.
Command Format
MODIFY-ONUVOIPSERVICE:: > PONID=ponport_location, > >
Supported Device
230 Version: B
5 Service Commissioning Interface
Input Parameter
Version: B 231
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example1: Modify the voice code of a voice service on voice port 1 of the ONU
(having no management IP address) with the ID FHTT03317f00, which is connected
to PON port 1 in slot 6 of the OLT with the IP address 110.190.47.223. The ONU
authentication mode is MAC.
u Command issued
MODIFY-ONUVOIPSERVICE::OLTID=10.190.47.223,PONID=NA-NA-6-1,
> VOICECODEC=G.729;
u Response message
FH_10.170.162.232017-02-1514:34:14
M CTAG COMPLD
EN=0 ENDESC=No error
;
Function Description
This command is used to modify the CVLAN configured for the ONU voice VLAN.
Command Format
MODIFY-ONUVOICEVLAN::OLTID=olt_name,PONID=ponport_location,
>
232 Version: B
5 Service Commissioning Interface
Input Parameter
Parameter
(Recom- Data Type Value Range Description Remark
mended)
OCTET
OLTID Size (128) OLT IP address, name or ID Required
STRING
Size (128) PON port location information. Locate
Cabinet rack - a port through the information rack -
OCTET
PONID shelf - slot - shelf - slot - PON port number. If any Required
STRING
PON port part of the information is unavailable,
number enter NA instead.
ONUID- OCTET ONU identifier type (ONU_NAME,
Size (128) Required
TYPE STRING MAC, LOID, ONU_NUMBER)
Response Format
Output Parameter
None
Example
Modify the CVLAN of the voice VLAN configuration of the ONU with MAC address
being FHTT92f44368 to 100. The ONU is connected to PON port 9 in slot 12 of the
OLT whose IP address is 10.171.0.106.
u Command issued
MODIFY-ONUVOICEVLAN::OLTID=10.171.0.106,PONID=NA-NA-12-9, > >
u Response message
FH_10.170.95.55 2019-10-09 16:45:22
M CTAG COMPLD
Version: B 233
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used to modify the ONU voice port service parameters.
Command Format
MODIFY-ONUVOICESERVICEPARAM:: > PONID=ponport_location, > > SlienceSwitch=slienceswitch][, EchoCancel=echocancel][,
InputGain=inputgain][,OutputGain=outputgain][, DTMFMode=dtmfmode];
Input Parameter
234 Version: B
5 Service Commissioning Interface
OutputGain
INTEGER - Input gain Optional
(DB)
OCTET
DTMFMode Transparent, RFC2833 DTMF mode Optional
STRING
Response Format
Output Parameter
None
Version: B 235
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Modify the service parameters of voice port 1 of the ONU with MAC address being
FHTT10988618. The ONU is connected to PON port 6 in slot 7 of the OLT whose IP
address is 10.190.40.156.
u Command issued
MODIFY-ONUVOIPSERVICE::OLTID=10.190.40.156,PONID=NA-NA-7-6,
> VOICECODEC=G.711A;
u Response message
FH_10.98.100.16 2019-06-12 14:31:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
The command is used for configuring the voice service of a VoIP port (Oman
customized requirement, UNM2000V2R7).
Command Format
MODIFY-VOIPSERVICE:: > PONID=ponport_location, > number][,PT=protocol type][,
SLVAN=voip outer vlan][,VOIPVLAN=voip inner vlan][,SCOS=outer qos][,
CCOS=inner qos][,EID=equipment id][TID=Terminal-ID][SIPREGDM=sip register
domain][,SIPUSERNAME=sip user name][,SIPUSERPWD=sip user password]
[MGCIP1=active bac ip][,MGCIP2=standby bac ip][,IPMODE=ip mode][,IP=ip
address,IPMASK=ip mask,IPGATEWAY=ip gateway][,PPPOEUSER=pppoe user,
PPPOEPWD=pppoe password],VOICECODEC=voice;
236 Version: B
5 Service Commissioning Interface
Input Parameter
OCTET
SIPREGDM Size (1 to 32) SIP register server Optional
STRING
Version: B 237
FiberHome Element Management System Northbound Interface (TL1) User Manual
238 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Configure the VoIP voice service on port 1 of the ONU with LOID being rliulogi1.
The ONU is connected to PON port 1 in slot 6 of the OLT whose IP address is
10.171.0.28.
u Command issued
CFG-VOIPSERVICE::OLTID=10.171.0.28,PONID=NA-NA-6-1, > > EID=eid,TID=tid1,IPMODE=DHCP,MGCIP1=1.1.1.254;
u Response message
FH_10.98.100.16 2019-06-10 12:51:16
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to configure the SIP user calling configuration template
bound with the voice port of the ONU.
Version: B 239
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
CFG-SIPUSERCONFIGPROFILE::OLTID=olt-name,PONID=ponport_location,
> SIPUSERCONFIGPROFILE=SIP User Call Config Profile;
Input Parameter
Response Format
240 Version: B
5 Service Commissioning Interface
Output Parameter
None
Example
Bind the SIP user calling configuration template with port 1 of ONU 4 on PON port 1
in slot 13 of the OLT whose IP address is 10.190.40.44.
u Command issued
CFG-SIPUSERCONFIGPROFILE::OLTID=10.190.40.44,PONID=NA-NA-13-1,
> SIPUSERCONFIGPROFILE=Default;
u Response message
FH_10.98.100.16 2019-06-11 10:51:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for querying the SIP user calling configuration template
bound with the voice port of the ONU.
Command Format
LST-SIPUSERCONFIGPROFILE::OLTID=olt-name,PONID=ponport_location,
>
Version: B 241
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
OCTET
OLTID Size (128) IP address, name or ID of the OLT
STRING
Size (128)
Cabinet rack - PON port location information. Locate a port through the
OCTET
PONID shelf - slot - information rack - shelf - slot - PON port number. If any
STRING
PON port part of the information is unavailable, enter NA instead.
number
OCTET ONU identifier type (ONU_NAME, MAC, LOID or ONU_
ONUIDTYPE Size (128)
STRING NUMBER)
242 Version: B
5 Service Commissioning Interface
Size (128)
Locate a card port through the information rack - shelf - slot
OCTET Cabinet rack -
ONUPORT - port number. If any part of the information is unavailable,
STRING shelf - slot -
enter NA instead.
port number
SIPUSERCON- OCTET
Size (128) Name of the SIP user calling configuration template
FIGPROFILE STRING
Example
None
Related Command
None
Function Description
This command is used for configuring the ONU voice port hotline.
Command Format
CFG-VOIPHOTLINE::OLTID=olt-name,PONID=ponport_location, > type, linetype[,
HOTLINENUMBER=00ab,HOTLINEDELAYTIME=5];
Version: B 243
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Hotline number
This parameter is decided
Only supports 0 to 9, a (or
HOTLINE- OCTET by HOTLINETYPE. It is
Size (128) A), b (or B), c (or C), d (or
NUMBER STRING required for delayed hotline
D), *, #. Other characters
and immediate hotline.
are illegal.
244 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Configure the voice port hotline mode to immediate hotline for PON port 1 in slot 13
of the OLT whose IP address is 10.190.40.44.
u Command issued
CFG-VOIPHOTLINE::OLTID=10.190.40.44,PONID=NA-NA-13-1,
> HOTLINENUMBER=00ab,HOTLINEDELAYTIME=5;
u Response message
FH_127.0.0.1 2019-03-27 14:48:34
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for querying the ONU voice port hotline.
Command Format
LST-VOIPHOTLINE::OLTID=olt-name,PONID=ponport_location, > type,>
Version: B 245
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
246 Version: B
5 Service Commissioning Interface
Output Parameter
OCTET
OLTID Size (128) IP address, name or ID of the OLT
STRING
Size (128)
PON port location information. Locate a port through the
OCTET Cabinet rack - shelf -
PONID information rack - shelf - slot - PON port number. If any
STRING slot - PON port
part of the information is unavailable, enter NA instead.
number
ONUID- OCTET ONU identifier type (ONU_NAME, MAC, LOID or ONU_
Size (128)
TYPE STRING NUMBER)
Hotline number
HOTLINE- OCTET
Size (128) Only supports 0 to 9, a (or A), b (or B), c (or C), d (or D), *, #.
NUMBER STRING
Other characters are illegal.
HOTLINE-
DELAY- INTEGER 0 to 255 -
TIME
Example
Query the hotline configuration of PON port 1 in slot 13 of the OLT whose IP
address is 10.190.40.44.
u Command issued
LST-VOIPHOTLINE::OLTID=10.190.40.44,PONID=NA-NA-13-1,
>
u Response message
FH_127.0.0.1 2019-03-27 14:50:38
M CTAG COMPLD
total_blocks=1
Version: B 247
FiberHome Element Management System Northbound Interface (TL1) User Manual
block_number=1
block_records=1
Related Command
None
Function Description
Command Format
CFG-ONUPORTCALL::OLTID=olt-name,PONID=ponport_location, > type, > CALLCONFERENCE=0,CALLWAITING=0,REVERSEPOLARITY=1,PBXDIALING=0,
NUMBER=Number for PBX Dialing,SIPNAME=SIP Displayname];
Input Parameter
248 Version: B
5 Service Commissioning Interface
Version: B 249
FiberHome Element Management System Northbound Interface (TL1) User Manual
OCTET
SIPNAME Size (20) - Optional
STRING
Response Format
Output Parameter
None
Example
Enable the calling configuration, set PBX dialing number to 1234 and set SIP
display name to CC for PON port 1 in slot 7 of the OLT whose IP address is
10.190.40.120.
u Command issued
CFG-ONUPORTCALL::OLTID=10.190.40.120,PONID=NA-NA-7-1, > > CALLCONFERENCE=1,CALLWAITING=0,REVERSEPOLARITY=1,PBXDIALING=1,
NUMBER=1234,SIPNAME=CC;
u Response message
FH_127.0.0.1 2019-04-18 09:37:23
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
250 Version: B
5 Service Commissioning Interface
Function Description
This command is used for querying the ONU port calling configurations.
Command Format
LST-ONUPORTCALL::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
Parame-
Data Type Value Range Description Remark
ter
OCTET IP address, name or ID of the Required for an ONU that has no
OLTID Size (128)
STRING OLT management IP address
Response Format
Version: B 251
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
252 Version: B
5 Service Commissioning Interface
Example
Enable the calling configuration, set the PBX dialing number to 1234 and SIP
display name to CC for PON port 1 in slot 7 of the OLT whose IP address is
10.190.40.120.
u Command issued
LST-ONUPORTCALL::OLTID=10.190.40.120,PONID=NA-NA-7-1, > >
u Response message
Related Command
None
The following introduces how to create and delete the VLAN service.
Function Description
Version: B 253
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
ADD-VLAN:: > alias],VLANMODE=vlan-type[,PORTLIST=port-list][,MVLANFLAG=mvlan-flag][,
MVLANPRI=mvlan-priority][,SERVICE=service];
Supported Device
Input Parameter
Value
Parameter Data Type Description Remark
Range
OCTET
DESC Size (128) VLAN alias Optional
STRING
VLAN attribute.
SINGLE: Switches the outer
VLAN tag or adds a VLAN tag to
the untagged message in the
uplink direction.
SINGLE STACKING: Switches the inner
VLAN- OCTET
QINQ VLAN tag and adds the outer Required
MODE STRING
STACKING VLAN tag, or adds the outer and
inner 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.
254 Version: B
5 Service Commissioning Interface
Value
Parameter Data Type Description Remark
Range
Response 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
;
Version: B 255
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
DEL-VLAN
Function Description
Command Format
DEL-VLAN:: >
Input Parameter
Parame- Value
Data Type Description Remark
ter Range
IP address, name or
OCTET ID of the ONU that
ONUIP Size (128) -
STRING has a management
IP address
OCTET IP address, name or Required for an ONU that has
OLTID Size (128)
STRING ID of the OLT no management IP address
Response 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;
256 Version: B
5 Service Commissioning Interface
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
Function Description
Command Format
ADD-PORTSPEEDLIMITPROFILE:: > 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
Version: B 257
FiberHome Element Management System Northbound Interface (TL1) User Manual
0 to 1000000
DPCIR INTEGER The AN5006-20 / 30: Assured downlink port rate Optional
64 to1000000
DSPIR INTEGER 0 to 16777215 Downlink peak cell rate Optional
Response 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:: > USPOLICINGSTATUS=1,UPCIR=200,USCBS=111,USEBS=222,DSPOLICINGSTATUS=1,
DPCIR=400,DSPIR=444;
258 Version: B
5 Service Commissioning Interface
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
Function Description
Command Format
DEL-PORTSPEEDLIMITPROFILE:: > PROFILENAME=profile name;
Supported Device
Input Parameter
Version: B 259
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response 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::>
u Response message
FH_0.0.0.0 2010-11-04 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
ADD-PORTSPEEDLIMITPROFILE
The following introduces the command and example for configuring the bandwidth
template.
Function Description
Command Format
ADD-BWPROFILE:: > 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];
260 Version: B
5 Service Commissioning Interface
Supported Device
Input Parameter
Required for an
ONU that has
OCTET IP address, name or ID of
OLTID Size (128) no
STRING the OLT
management
IP address
PROFILE- OCTET Name of the bandwidth
Size (128) Required
NAME STRING template
Response Format
Output Parameter
None
Example
Add the bandwidth template for the OLT whose IP address is 10.171.0.33.
Version: B 261
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
Function Description
Command Format
DEL-BWPROFILE:: PROFILENAME=profile
name;
Supported Device
262 Version: B
5 Service Commissioning Interface
Input Parameter
Required for an
ONU that has
OCTET IP address, name or ID of
OLTID Size (128) no
STRING the OLT
management
IP address
PROFILE- OCTET Name of the bandwidth
Size (128) Required
NAME STRING template
Response Format
Output Parameter
None
Example
u Command issued
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
Version: B 263
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
LST-BANDWIDTHPROFILE::ONUIP|OLTID=olt_name:CTAG::;
Input Parameter
Optional /
Parameter Data Type Value Range Description
Required
IP address or
name of the
ONUIP OCTET STRING Size (128) Required ONU that has a
management IP
address
OLT IP address
OLTID OCTET STRING Size (128) Required
or name
Response Format
Output Parameter
Minimum assured
UPMINGUARAN-
INTEGER 0 to 10000000 uplink bandwidth
TEEDBANDWIDTH
(Kbps)
Maximum allowed
UPMAXALLOWED-
INTEGER 256 to 10000000 uplink bandwidth
BANDWIDTH
(Kbps)
Minimum assured
DOWNMINGUARAN-
INTEGER 0 to 10000000 downlink bandwidth
TEEDBANDWIDTH
(Kbps)
264 Version: B
5 Service Commissioning Interface
Maximum allowed
DOWNMAXALLO-
INTEGER 256 to 10000000 downlink bandwidth
WEDBANDWIDTH
(Kbps)
Example
u Command issued
LST-BANDWIDTHPROFILE::>
u Response message
u Command issued
LST-BANDWIDTHPROFILE::OLTID=AN5516-01-10.171.0.16:CTAG::;
Version: B 265
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
Related Command
None
Function Description
This command is used for querying the GPON service bandwidth template.
Command Format
LST-GPONSERBWPROFILE::ONUIP|OLTID=olt_name:CTAG::;
Input Parameter
Optional /
Parameter Data Type Value Range Description
Required
Response Format
266 Version: B
5 Service Commissioning Interface
Output Parameter
PROFILE- OCTET
Size(20) Template Name
NAME STRING
1: IPTV
2: data
3: Voice
4: TDM
5: Integrated service
6: data2
SERVICE- 7: data3
INTEGER Service type
TYPE 8: data4
9: COM service
10: data5
11: data6
12: data7
13: data8
14: Manage service
Example
Example 1: Query the GPON service bandwidth template (one template) of the OLT
whose IP address is 10.171.0.31.
u Command issued
Version: B 267
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-GPONSERVICEBANDWIDTHPROFILE::OLTID=10.171.0.31:CTAG::;
u Response message
u Command issued
LST-GPONSERVICEBANDWIDTHPROFILE::OLTID=10.171.0.31:CTAG::;
u Response message
Related Command
None
Function Description
Command Format
LST-ONUCONFIGE::OLTID=olt_name,PONID=ponport_location, > type,>
268 Version: B
5 Service Commissioning Interface
Input Parameter
Response Format
Version: B 269
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Size (128)
Cabinet rack - shelf -
PONID OCTET STRING Cabinet rack - shelf - slot
slot - PON port number
- PON port number
BANDWIDTH-
OCTET STRING Size (80) Bandwidth template
PROFILENAME
GPONSERVICE-
GPON service bandwidth
BANDWIDTH- OCTET STRING Size (80)
template
PROFILENAME
Example
Query the configuration of PON port 1 in slot 5 of the OLT whose IP address is
10.171.0.31.
u Command issued
LST-CONFIG::OLTID=10.171.0.31,PONID=NA-NA-5–1, > >
u Response message
Related Command
None
270 Version: B
5 Service Commissioning Interface
The following introduces the FLOWPOLICY command and example for adding /
deleting a flow policy.
Function Description
Command Format
ADD-FLOWPOLICY:: > 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
Required for an
ONU that has
OCTET IP address, name or ID of
OLTID Size (128) no
STRING the OLT
management
IP address
PROFILE- OCTET
Size (20) Name of the traffic policy Required
NAME STRING
OCTET Name of the traffic
RULENAME Size (128) Required
STRING classification rule
PRECE-
INTEGER 1 to 12 Policy priority Required
DENCE
Indicates whether to
enable the ACL.
ACL INTEGER 0 or 1 Optional
0: disable
1: enable
Version: B 271
FiberHome Element Management System Northbound Interface (TL1) User Manual
Indicates whether to
enable the queue
QUEUEEN-
INTEGER 0 or 1 mapping function. Optional
ABLE
0: disable
1: enable
QUEUEMAP INTEGER 0 to 7 Mapping queue Optional
Indicates whether to
enable the re-marking
COSRE-
INTEGER 0 or 1 function. Optional
MARK
0: disable
1: enable
COS INTEGER 0 to 7 Priority label Optional
Indicates whether to
enable the re-marking
DSCPRE-
INTEGER 0 or 1 function. Optional
MARK
0: disable
1: enable
DSCP INTEGER 0 to 63 DSCP Optional
Port mirroring
PMENABLE INTEGER 0 or 1 0: disable Optional
1: enable
MPORTNO INTEGER 1 to 100 Port number Optional
272 Version: B
5 Service Commissioning Interface
Response 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:: > 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
Function Description
Command Format
DEL-FLOWPOLICY:: PROFILENAME=profile
name;
Version: B 273
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Device
Input Parameter
Required for an
ONU that has
OCTET IP address, name or ID of
OLTID Size (128) no
STRING the OLT
management
IP address
PROFILE- OCTET
Size (128) Name of the traffic policy Required
NAME STRING
Response 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::>
u Response message
FH_0.0.0.0 2015-11-04 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
;
274 Version: B
5 Service Commissioning Interface
Related Command
ADD-FLOWPOLICY
ADD-PORTPVCFLOWPOLICY
Function Description
Command Format
ADD-PORTPVCFLOWPOLICY:: > > UPPOLICYID=ubrPcr_1024K,DOWNPOLICYID=ubrPcr_1024K;
Supported Device
Input Parameter
OCTET
OLTID Size (128) OLT IP address or name
STRING
Size (128)
PON port location information. Locate a port
Cabinet rack -
OCTET through the information rack - shelf - slot -
PONID shelf - slot -
STRING PON port number. If any part of the
PON port
information is unavailable, enter NA instead.
number
ONUID- OCTET ONU identifier type (ONU_NAME, MAC,
Size (128)
TYPE STRING LOID, ONU_NUMBER).
Version: B 275
FiberHome Element Management System Northbound Interface (TL1) User Manual
Size (128)
Locate a port through cabinet rack - shelf -
OCTET Cabinet rack -
ONUPORT slot - port number. Enter NA if the
STRING shelf - slot -
corresponding information is not specified.
port number
Response Format
Example
Command issued
ADD-PORTPVCFLOWPOLICY:: > PVCNO=1,UPPOLICYID=ubrPcr_1024K,DOWNPOLICYID=ubrPcr_1024K;
Response message
None
Related Command
ADD-FLOWPOLICY
DEL-FLOWPOLICY
Function Description
This command is used for querying a traffic policy bound with the AN5006-20.
276 Version: B
5 Service Commissioning Interface
Command Format
LST-FLOWPOLICY::OLTID=oltname:CTAG::;
Supported Device
Input Parameter
Value
Parameter Data Type Description Remark
Range
Response Format
Output Parameter
Example
Query the traffic policy of the OLT whose IP address is 10.171.0.28. The ONU has
no independent management IP address.
u Command issued
LST-FLOWPOLICY::OLTID=10.171.0.28:CTAG::;
u Response message
FH_10.170.162.31 2018-06-20 09:15:21
M CTAG COMPLD
Version: B 277
FiberHome Element Management System Northbound Interface (TL1) User Manual
total_blocks=1
block_number=1
block_records=2
——————————————————————————————————-
——————————————————————————————————-
——————
POLICYNAME RULEIDCIR
default de_rule_single 0
default1 de_rule_single 0
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Function
Command Format
CFG-ONUWIFI::OLTID=olt-name,PONID=ponport_location, > type, > BANDSTEERINGENABLE=enable][,WILESS-CHANNEL=channel][,WILESS-
STANDARD=standard],WORKING-FREQUENCY=frequency[,FREQUENCY-
BANDWIDTH=bandwidth][,SSID=ssid,SSID-ENABLE=ssid-enable,SSID-
VISIBALE=visible,AUTH-MODE=mode,ENCRYP-TYPE=type,PRESHARED-KEY=key];
278 Version: B
5 Service Commissioning Interface
Input Parameter
Version: B 279
FiberHome Element Management System Northbound Interface (TL1) User Manual
0: auto
1: 20 MHz
FREQUENCY- OCTET 2: 40 MHz Optional. Default
Frequency bandwidth
BANDWIDTH STRING 3: 80 MHz value: auto
4: 160 MHz
5: 80+80 MHz
Optional. When
other SSID
parameters are
set, this
SSID index, the keyword of
parameter is
the secondary table, used for
SSID INTEGER 1 to 4 required as the
locating a specific SSID
index for
entry.
searching for the
SSID
configuration to
be modified.
Optional. The
default value is
1.
0: disable If the value is set
SSIDENABLE INTEGER Enables or disables SSIDs.
1: enable to 0 (disable), all
the following
parameters are
invalid.
280 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Version: B 281
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Configure a Wi-Fi service for the ONU with the ID FHTT92589600. The ONU is
connected to the PON port 8 in slot 4 on the OLT with the IP address 10.182.32.10.
u Command issued
CFG-ONUWIFI::OLTID=10.182.32.10,PONID=NA-NA-4-8, > > WILESSCHANNEL=0,WILESSSTANDARD=802.11bgn,WORKINGFREQUENCY=2.4GHz,
FREQUENCYBANDWIDTH=auto,SSID=1,SSIDENABLE=1,SSIDVISIBALE=0,
AUTHMODE=WPA2PSK,ENCRYPTYPE=AES,PRESHAREDKEY=wlana769ff;
u Response message
FH_10.182.32.97 2021-01-06 16:54:56
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function
This command modifies parameters of Wi-Fi services (mesh and bandsteering) for
ONUs with dual-frequency Wi-Fi capability set, including the parameters in the
primary and secondary tables.
Command Format
MODIFY-ONUWIFI::OLTID=olt-name,PONID=ponport_location, > type, > BANDSTEERINGENABLE=enable][,WILESS-CHANNEL=channel][,WILESS-
STANDARD=standard],WORKING-FREQUENCY=frequency[,FREQUENCY-
BANDWIDTH=bandwidth][,SSID=ssid,SSID-ENABLE=ssid-enable,SSID-
VISIBALE=visible,AUTH-MODE=mode,ENCRYP-TYPE=type,PRESHARED-KEY=key];
282 Version: B
5 Service Commissioning Interface
Input Parameter
Version: B 283
FiberHome Element Management System Northbound Interface (TL1) User Manual
Optional
When other
SSID
0: auto parameters are
1: 20 MHz set, this
FREQUENCY- OCTET 2: 40 MHz parameter is
Frequency bandwidth
BANDWIDTH STRING 3: 80 MHz required as the
4: 160 MHz index for
5: 80+80 MHz searching for the
SSID
configuration to
be modified.
SSID index, the keyword of
the secondary table, used for
SSID INTEGER 1 to 4 Optional
locating a specific SSID
entry.
Optional. The
default value is
1.
0: disable If the value is set
SSIDENABLE INTEGER Enables or disables SSIDs.
1: enable to 0 (disable), all
the following
parameters are
invalid.
284 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Modify the Wi-Fi service of the ONU with the ID FHTT92589600 connected to PON
port 8 in slot 4 on the OLT with the IP address 10.182.32.10. Specifically, enable Wi-
Fi mesh, and modify the wireless standard to "802.11bgn", the working frequency to
2.4 GHz, the frequency bandwidth to "auto", the WLAN authentication mode to
"WPA2PSK", the WLAN encryption type to "AES", and the WPA pre-shared key to
"wlana769ff".
u Command issued
MODIFY-ONUWIFI::OLTID=10.182.32.10,PONID=NA-NA-4-8, > >
Version: B 285
FiberHome Element Management System Northbound Interface (TL1) User Manual
WILESSCHANNEL=0,WILESSSTANDARD=802.11bgn,WORKINGFREQUENCY=2.4GHz,
FREQUENCYBANDWIDTH=auto,SSID=1,SSIDENABLE=1,SSIDVISIBALE=0,
AUTHMODE=WPA2PSK,ENCRYPTYPE=AES,PRESHAREDKEY=wlana769ff;
u Response message
FH_10.182.32.97 2021-01-06 16:59:02
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
Function
This command queries Wi-Fi services (mesh and bandsteering) of ONUs with dual-
frequency Wi-Fi capability set.
Command Format
LST-ONUWIFI::OLTID=olt-name,PONID=ponport_location][, > >
Input Parameter
286 Version: B
5 Service Commissioning Interface
Response Format
Output Parameter
0: disable
MESHENABLE OCTET STRING Enables or disables Wi-Fi mesh.
1: enable
BANDSTEERIN- 0: disable Enables or disables Wi-Fi
OCTET STRING
GENABLE 1: enable bandsteering.
Version: B 287
FiberHome Element Management System Northbound Interface (TL1) User Manual
0: disable
SSIDENABLE OCTET INTEGER Enables or disables SSIDs.
1: enable
0: available
SSIDVISIBALE OCTET INTEGER Indicates whether to hide SSIDs.
1: not available
1: OPEN
6: WPA2PSK
AUTHMODE OCTET STRING WLAN authentication mode
12: WPA3SAE
13: WPA2PSK/WPA3SAE
1: NONE
ENCRYPTYPE OCTET STRING WLAN encryption type
4: AES
PRESHAREDKEY OCTET STRING STRING (64) WPA pre-shared key
Example
Query the Wi-Fi service of the ONU with the ID 1 connected to PON port 16 in slot 8
on the OLT with the IP address 10.171.0.31. The query result shows that Wi-Fi
mesh is disabled, the wireless standard is 802.11bgn, the working frequency is 2.4
GHz, the frequency bandwidth is 20 MHz, and the WPA pre-shared key is
"wlan049c07".
u Command issued
LST-ONUWIFI::OLTID=10.171.0.31,PONID=NA-NA-8-16, > >
u Response message
FH_10.170.200.54 2021-01-06 14:33:23
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=2
288 Version: B
5 Service Commissioning Interface
Related Command
Function
Command Format
CFG-ONUDOWNLOADTEST::OLTID=olt-name,PONID=ponport_location,
> WANINDEX=wanindex][,INTERFACE=wanname][,DOWNLOADURL=url];
Input Parameter
Version: B 289
FiberHome Element Management System Northbound Interface (TL1) User Manual
To start a test, at
least one of
WANINDEX and
WAN connection index.
INTERFACE
When this parameter is
should be
WANINDEX INTEGER 1 to 8 delivered, it is mapped to the
specified. For
corresponding WAN
stopping a test,
connection name.
these two
parameters
cannot be set.
To start a test, at
least one of
WANINDEX and
Interface name format: INTERFACE
OCTET number_keyword_bridging Interface used by a download should be
INTERFACE
STRING or routing mode_PVC / test specified.
VLAN information For stopping a
test, these two
parameters
cannot be set.
The URL should comply Required for
DOWNLOA- OCTET with the format of common starting a test.
URL used by a download test
DURL STRING addresses, FTP addresses Unavailable for
or TFTP addresses. stopping a test.
Response Format
Output Parameter
None
290 Version: B
5 Service Commissioning Interface
Example
Start a download speed test on the ONU with the ID 1 connected to PON port 16 in
slot 8 on the OLT with the IP address 10.171.0.31. Set the number of the interface
and the URL used for the download test to TR069 and ftp://10.170.159.25
respectively.
u Command issued
CFG-ONUDOWNLOADTEST::OLTID=10.171.0.31,PONID=NA-NA-8-16,
> INTERFACE=TR069_R_VID_1,DOWNLOADURL=ftp://10.170.159.25;
u Response message
FH_10.170.200.54 2021-01-06 14:31:47
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function
Command Format
LST-ONUDOWNLOADTEST::OLTID=olt-name,PONID=ponport_location,
>
Version: B 291
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
292 Version: B
5 Service Commissioning Interface
Example
Query a download speed test on the ONU with the ID 1 connected to PON port 16 in
slot 8 on the OLT with the IP address 10.171.0.31. The query result shows that the
ONU is idle, with a download speed of 0 Kbit/s.
u Command issued
LST-ONUDOWNLOADTEST::OLTID=10.171.0.31,PONID=NA-NA-8-16,
>
u Response message
FH_10.170.200.54 2021-01-06 14:28:36
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
Version: B 293
6 Integrated Testing Interface
The following introduces the testing commands for related resources of the PON
line, voice service, xDSL port and LAN port.
294 Version: B
6 Integrated Testing Interface
The following introduces the PING command and the related example to use it.
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:: name|OLTID=OLT_name[,PONID=ponport_location,ONUIDTYPE
=id-type,>
Input Parameter
Required for an
OCTET IP address, name or ID of ONU that has no
OLTID Size (128)
STRING the OLT management IP
address
PON port location
information. Locate a port If input
Size (128) through the information parameters
OCTET Rack - shelf - rack - shelf - slot - PON exclude the
PONID
STRING slot - PON port port number. If any part of ONUID, the
number the information is PONID is
unavailable, enter NA optional.
instead.
ONU identifier type: ONU_
ONUID- OCTET
Size (128) NAME, MAC, LOID, ONU_ Optional
TYPE STRING
NUMBER
Version: B 295
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Example
296 Version: B
6 Integrated Testing Interface
u Command issued
PING::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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
-----------------------------------------------------------
;
u Command issued
PING::>
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 AvgDelay
2 2 0 0 0 0 0
-----------------------------------------------------------
;
Related Command
None
The following introduces the commands and examples for querying the equipment
information.
Version: B 297
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used to query the device model, software version, memory, CPU
and temperature of the NE (OLT and ONU).
Command Format
LST-DEVINFO:: > >
Input Parameter
Response Format
298 Version: B
6 Integrated Testing Interface
Output Parameter
OCTET
DEVNAME Size (128) Device name
STRING
OCTET
DEVIP Size (128) Device IP address
STRING
OCTET
DT Size (255) Device model
STRING
OCTET
DEVER Size (255) Software version
STRING
Memory usage
MEM INTEGER 0 to 100
Unit: %
CPU usage
CPU INTEGER 0 to 100
Unit: %
TEMPERA- Temperature
INTEGER -50 to 100
TURE Unit: ℃
Optional. It indicates the topology location of
the device, which uses / to separate layer
OCTET information and describes the information from
TOPOLOC Size (255)
STRING the root node to the node where the device is
located, such as Root/shanghai/MA5600T or
Root/shanghai/MA5600T/ODN-15-2.
Example
u Command issued
LST-DEVINFO::OLTID=10.250.18.100:CTAG::;
u Response message
FH_10.250.18.133 2010-11-01 10:09:57
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
List of Device Info
-----------------------------------------------------------
DEVNAME DEVIP DT DEVER MEM CPU TEMPERATURE
Version: B 299
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used to query the type, status and version of the card.
Command Format
LST-BRDINFO:: > >
Input Parameter
300 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
Parame-
Data Type Value Range Description Remark
ter
Locate the card connected with
Size (128) the ONU through cabinet rack
OCTET
BOARDID Cabinet rack - shelf - slot number. Enter NA -
STRING
- shelf - slot if the corresponding information
is not specified.
Normal
OCTET
BSTAT Fault Card status -
STRING
Offline
BOARD- OCTET
Size (128) Card type -
TYPE STRING
Version: B 301
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parame-
Data Type Value Range Description Remark
ter
Power
ETH
ADSL
VDSL
BSER- OCTET POTS Card service type (such as
-
VICE STRING E1 ADSL2P and SHDSL)
GPON
EPON
SCU
Other
PNUM INTEGER 0 to 64 Number of ports -
OCTET
SWVER Size (255) Software version -
STRING
OCTET
HWVER Size (255) Hardware version -
STRING
Memory usage
MEM INTEGER 0 to 100 -
Unit: %
CPU usage
CPU INTEGER 0 to 100 -
Unit: %
Example
u Command issued
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 BOARDTYPE BSERVICE PNUM SWVER HWVER MEM CPU
NA-1-3 Normal EC4B EPON 4 RP0121 WKE2.119.318R2A 38.88 2.73
-----------------------------------------------------------
;
302 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used to query the card authorization status based on the
granularity of NE.
Command Format
LST-BOARD-AUTHINFO:: > slotno]:CTAG::;
Input Parameter
Response Format
Version: B 303
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
u Command issued
LST-BOARD-AUTHINFO::>
u Response message
FH_10.170.162.31 2018-05-30 11:06:13
M CTAG COMPLD
total_blocks=1
block_number=1
304 Version: B
6 Integrated Testing Interface
block_records=24
——————————————————————————————————-
——————————————————————————————————-
——————
–10.171.0.16 1-1-1 –
–10.171.0.16 1-1-2 –
–10.171.0.16 1-1-3 –
–10.171.0.16 1-1-4 –
–10.171.0.16 1-1-5 –
–10.171.0.16 1-1-6 –
–10.171.0.16 1-1-7 –
–10.171.0.16 1-1-8 –
–10.171.0.16 1-1-9 –
–10.171.0.16 1-1-10–
–10.171.0.16 1-1-11–
–10.171.0.16 1-1-12–
–10.171.0.16 1-1-13–
–10.171.0.16 1-1-14–
–10.171.0.16 1-1-15–
–10.171.0.16 1-1-16–
–10.171.0.16 1-1-17–
–10.171.0.16 1-1-18–
–10.171.0.16 1-1-19–
–10.171.0.16 1-1-20–
–10.171.0.16 1-1-21–
–10.171.0.16 1-1-22–
–10.171.0.16 1-1-23–
Version: B 305
FiberHome Element Management System Northbound Interface (TL1) User Manual
–10.171.0.16 1-1-801 –
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
The following introduces the commands and examples for querying the PON
information.
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
306 Version: B
6 Integrated Testing Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
OCTET UP
AdminState Management status
STRING DOWN
OCTET UP
OperState Operating status
STRING DOWN
Example
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 OperState
UP UP
-----------------------------------------------------------
Related Command
None
Version: B 307
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying the local PON port information, including the
PON port type, PON port rate, PON port running status and management status.
Command Format
LST-PONPORTINFO::OLTID=olt-name[,PONID=pon_name]:CTAG::;
Input Parameter
Response Format
308 Version: B
6 Integrated Testing Interface
Output Parameter
UP
AdminState OCTET STRING Management status
DOWN
UP
OperState OCTET STRING Operating status
DOWN
Example
Configure the information of the PON port on the OLT whose IP address is
10.171.0.16. The ONU has no independent management IP address.
u Command issued
LST-PONPORTINFO::OLTID=10.171.0.16:CTAG::;
u Response message
FH_10.170.162.31 2018-05-30 11:09:47
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=32
——————————————————————————————————-
——————————————————————————————————-
——————
Version: B 309
FiberHome Element Management System Northbound Interface (TL1) User Manual
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
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.
Command Format
LST-PONPERF:: > >
310 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
Output Parameter
Version: B 311
FiberHome Element Management System Northbound Interface (TL1) User Manual
UnderSi-
DOUBLE 0 - 1.85E19 Number of received undersized packets
zePkts
OverSi-
DOUBLE 0 - 1.85E19 Number of received oversized packets
zePkts
InErrors DOUBLE 0 - 1.85E19 Number of received error packets
InUni-
DOUBLE 0 - 1.85E19 Number of received unicast packets
castPkts
InMulti-
DOUBLE 0 - 1.85E19 Number of received multicast packets
castPkts
InBroad-
DOUBLE 0 - 1.85E19 Number of received broadcast packets
castPkts
OutUni-
DOUBLE 0 - 1.85E19 Number of sent unicast packets
castPkts
OutMulti-
DOUBLE 0 - 1.85E19 Number of sent multicast packets
castPkts
OutBroad-
DOUBLE 0 - 1.85E19 Number of sent broadcast packets
castPkts
Uplink rate. This parameter only supports
performance code 756 of GPON ONU and
UpSpeed DOUBLE 0 - 1.85E19
XGPON ONU (Thailand 3BB).
Unit: Mbps
Curr15Mi-
Uplink peak rate of the current 15 minutes
nUPMax- FLOAT 0 - 1.85E19
(Thailand TRUE)
Speed
Curr15Min-
Downlink peak rate of the current 15 minutes
DownMax- FLOAT 0 - 1.85E19
(Thailand TRUE)
Speed
312 Version: B
6 Integrated Testing Interface
Curr15Mi-
Uplink peak bandwidth usage of the current 15
nUPMaxPro- FLOAT 0 - 1.85E19
minutes (Thailand TRUE)
portion
Curr15Min-
Downlink peak bandwidth usage of the current
DownMax- FLOAT 0 - 1.85E19
15 minutes (Thailand TRUE)
Proportion
RealUPMax-
FLOAT 0 - 1.85E19 Real-time uplink peak rate (Thailand TRUE)
Speed
RealDown-
Real-time downlink peak bandwidth usage
MaxPropor- FLOAT 0 - 1.85E19
(Thailand TRUE)
tion
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
PON port 1 in slot 3 of the NE whose IP address is 10.250.18.100.
u Command issued
LST-PONPERF::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
FH_10.250.18.133 2010-10-27 11:05:41
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of pon port performance
-----------------------------------------------------------
OutPkts InPkts OutOctets InOctets CRC UnderSizePkts
OverSizePkts InErrors OutErrors InDiscards
OutDiscards InUnicastPkts InMulticastPkts InBroadcastPkts OutUnicastPkts
OutMulticastPkts OutBroadcastPkts
2832 411 240431 29259 -- -- -- -- 0
0 0 47 8 364 542 885 1405
-----------------------------------------------------------
Version: B 313
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 issued
LST-PONPERF::>
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 InOctets CRC UnderSizePkts OverSizePkts
InErrors OutErrors InDiscards
OutDiscards InUnicastPkts InMulticastPkts InBroadcastPkts
OutUnicastPkts OutMulticastPkts OutBroadcastPkts
4409 1385 450601 202533 -- -- -- --
0 0 0 1295 8 90 667 926 2816
-----------------------------------------------------------
Related Command
None
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, > >
314 Version: B
6 Integrated Testing Interface
Input Parameter
OCTET
OLTID Size (128) OLT IP address, name or ID
STRING
Size (128)
PON port location information. Locate a port
Cabinet rack -
OCTET through the information rack - shelf - slot -
PONID shelf - slot -
STRING PON port number. If any part of the
PON port
information is unavailable, enter NA instead.
number
ONUID- OCTET ONU identifier type: ONU_NAME, MAC, LOID,
Size (128)
TYPE STRING ONU_NUMBER
Response Format
Output Parameter
Admin- OCTET UP
Management status
State STRING DOWN
UP
OCTET
OperState Power-Off Running status
STRING
LOS
MAC
AUTH- OCTET
LOID Authentication mode
TYPE STRING
LOIDONCEON
Authentication information.
If AUTHTYPE is set to MAC, AUTHINFO is
AUTHIN- OCTET
Size (64) MAC address.
FO STRING
If AUTHTYPE is set to LOID, AUTHINFO is
LOID.
Optical fiber length
Length DOUBLE 0 to 100
Unit: km
Version: B 315
FiberHome Element Management System Northbound Interface (TL1) User Manual
Down- OCTET
Size (128) Bandwidth template name
Stream STRING
Example
u Command issued
LST-ONUCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
FH_10.250.18.133 2010-10-27 11:03:08
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of ONU info
-----------------------------------------------------------
AdminState OperState AUTH AUTHINFO Length
UsFixedBw UsAssuredBw UsMaxBw DsMaxBw
UP UP LOID aaa_bbb_ccc_111_222 0 0 0
1000 1000
-----------------------------------------------------------
Related Command
None
316 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-ONUSTATE::OLTID=olt-name,PONID=ponport_location[, > >
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Version: B 317
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
LASTOFF-
OCTET STRING - ONU offline time
TIME
ACTIVES- Active ONU activation status. Whether the field will be
OCTET STRING
TATE Deactive returned depends on the switch.
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, > >
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
318 Version: B
6 Integrated Testing Interface
Related Command
None
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.
Command Format
LST-PORTMACADDRESS:: > PONID=ponport_location][, > PORTID=uniport_index][,VLAN=vlan_value]:CTAG::;
Input Parameter
Input
Data Type Value Range Description Remark
Parameter
IP address, name or ID of
OCTET
ONUIP Size (128) the ONU that has a -
STRING
management IP address
Version: B 319
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input
Data Type Value Range Description Remark
Parameter
PON port location
information. Locate a port
Size (128) through the information If the parameter entered
OCTET Cabinet rack - rack - shelf - slot - PON does not include the
PONID
STRING shelf - slot - PON port number. If any part of ONUID, the PONID is
port number the information is optional.
unavailable, enter NA
instead.
ONU identifier type: ONU_
OCTET
ONUIDTYPE Size (128) NAME, MAC, LOID, ONU_ Optional
STRING
NUMBER
ONU identifier, used for
uniquely identifying the
OCTET ONU connected to the PON
ONUID Size (128) Optional
STRING port. The value is ONU_
NAME, MAC, LOID or
ONU_NUMBER.
Response Format
Output Parameter
320 Version: B
6 Integrated Testing Interface
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 PON port 1 in slot 3 of the OLT whose IP address is 10.250.18.100.
u Command issued
LST-PORTMACADDRESS::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
FH_10.250.18.133 2010-10-27 11:06:25
M CTAG COMPLD
total_blocks=1
block_number=1
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 issued
LST-PORTMACADDRESS::>
u Response message
FH_10.250.18.133 2010-11-02 09:45:19
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of MAC Address
-----------------------------------------------------------
VLAN MAC
2114
-----------------------------------------------------------
Related Command
None
Version: B 321
FiberHome Element Management System Northbound Interface (TL1) User Manual
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:: > > PEERFLAG=flag]:CTAG::;
Input Parameter
322 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
Version: B 323
FiberHome Element Management System Northbound Interface (TL1) User Manual
Normal
CurrTx- OCTET
High Indicates whether the bias current is normal.
BiasR STRING
Low
Tempera- OCTET Temperature
-45, 90
ture STRING Unit: ℃
Normal
Temperatur- OCTET
High Indicates whether the temperature is normal.
eR STRING
Low
OCTET Power supply voltage
Voltage 0, 6.55
STRING Unit: V
Normal
OCTET Indicates whether the supply voltage is
VoltageR High
STRING normal.
Low
Tx optical power of the peer end. A dash –
OCTET will be returned if no Tx optical signals are
PTxPower -40, 10
STRING detected.
Unit: dB
Rx optical power of the peer end. A dash –
will be returned if no Rx optical signals are
OCTET detected. (It requires correcting the
PRxPower -40, 10
STRING calculation logic and displays Rx optical
power of the remote ONU actually queried).
Unit: dBm
Example
u Command issued
LST-OMDDM::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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
-----------------------------------------------------------
324 Version: B
6 Integrated Testing Interface
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 issued
LST-OMDDM::>
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
List of Optical Power Info
-----------------------------------------------------------
ONUID RxPower RxPowerR TxPower TxPowerR CurrTxBias
CurrTxBiasR Temperature TemperatureR Voltage VoltageR
PTxPower PRxPower
2 -13.44 Normal 2.64 Normal 20.00 Normal 41.41
Normal 3.26 Normal -- --
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the status of the unregistered ONU of an OLT
PON port.
Command Format
Version: B 325
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-UNREGONU::OLTID=olt-name:CTAG::;
u Query the information of the unauthorized ONUs with the specified MAC
address under the OLT:
LST-UNREGONU::OLTID=olt-name,MAC=physicID:CTAG::;
u Query the information of unregistered ONUs with the specified MAC address
under the specified PON port:
LST-UNREGONU::OLTID=olt-name,PONID=pon_name,MAC=physicID:CTAG::;
Input Parameter
Response Format
326 Version: B
6 Integrated Testing Interface
Output Parameter
OCTET
OLTID Size (128) IP address, name or ID of the OLT
STRING
SLOTNO int32 - Slot number
PONNO int32 - PON port number
OCTET
MAC Size (128) MAC address of an EPON ONU or SN of an GPON ONU
STRING
OCTET When the MAC authentication is adopted, a dash (–) will be
LOID Size (64)
STRING returned.
OCTET LOID/GPON password. A dash – will be returned if there is no
PWD Size (128)
STRING password.
Example
u Command issued
Version: B 327
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-UNREGONU::OLTID=172.30.15.58,PONID=NA-NA-11-3:CTAG::;
u Response message
FH_10.99.2.201 2019-06-12 16:29:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=0
--------------------------------------------------------------
Related Command
None
Function
Command Format
LST-WIFISERVICE:: > [,>
328 Version: B
6 Integrated Testing Interface
Input Parameter
ONU_NAME
Required for an
MAC ONU identifier type:
ONU that has no
ONUID TYPE OCTET STRING LOID ONU_NAME, MAC, LOID or
management IP
ONU Number ONU_NUMBER
address
NUMBER
ONU identifier, used for
Required for an
uniquely identifying an ONU
ONU that has no
ONUID OCTET STRING Size (128) connected to a PON port. The
management IP
value is ONU_NAME, MAC,
address
LOID or ONU_NUMBER.
Response Format
Output Parameter
Version: B 329
FiberHome Element Management System Northbound Interface (TL1) User Manual
20/40 MHz
20 MHz
FREQBAND 40 MHz
OCTET STRING Frequency bandwidth
WIDTH 80 MHz
160 MHz
80+80 MHz
0: Europe (ETSI)
1: North America (FCC)
2: Thailand
3: Philippines
4: Indonesia
5: Brazil
6: India
7: Armenia
8: Malaysia
9: Pakistan
10: Russian Federation
11: China
WILESSAREA OCTET STRING 12: Chile Wi-Fi wireless area
13: United States
14: Myanmar
15: Ecuador
16: Colombia
17: Argentina
18: Sri Lanka
19: The Islamic Republic of Iran
20: Yemen
21: Saudi Arabia
22: Kuwait
23: Iraq
24: Vietnam
WILESSCHAN [0, 13] for wireless area = 0
INTEGER Wireless channel number
NEL [0, 11] for wireless area = 1
330 Version: B
6 Integrated Testing Interface
802.11b
802.11g
802.11b/g
802.11n
802.11bgn
WILESSSTAN
OCTET STRING 802.11a Wireless standard
DARD
802.11a/n
802.11a/n/ac
802.11ax
802.11b/g/n/ax
802.11a/n/ac/ax
TPOWER INTEGER [0, 20] Launched power
Version: B 331
FiberHome Element Management System Northbound Interface (TL1) User Manual
WEPENCRYP 1: 40 bits
INTEGER WEP key length
TIONLEVEL 2: 104 bits
WEPKEYINDEX INTEGER [1, 4] Key index
Example
Query the Wi-Fi service information of the ONU with the ID 7 connected to PON port
4 in slot 5 on the OLT with the IP address 10.171.0.34. The ONU has no
management IP address. The output result shows that MAX-WIFIMAC-COUNT is 1
and PUBLICSSID is "No".
u Command issued
LST-WIFISERVICE::OLTID=10.171.0.34,PONID=NA-NA-14-3,
>
u Response message
FH_10.170.159.109 2021-01-06 14:25:31
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------------------
332 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used for querying the Wi-Fi service information of an ONU.
Command Format
LST-WIFISERVICE:: > [,>
Input Parameter
Version: B 333
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
334 Version: B
6 Integrated Testing Interface
Indicates whether to
SSIDVISIBALE OCTET STRING Available, Not-Available
hide SSID.
OPEN, SHARED,
WEPAUTO, WPAPSK,
WLAN authentication
AUTHMODE OCTET STRING WPA, WPA2PSK,
mode
WPA2, WPA/WPA2
WPAPSK, WPA2PSK
NONE, WEP, TKIP,
ENCRYPTYPE OCTET STRING WLAN encryption type
AES, TKIPAES
PRESHARED-
OCTET STRING STRING (64) WPA pre-shared key
KEY
UPDATEKEYIN- WPA key update interval
INTEGER [0, 4194303]
TERVAL Unit: s
RADIUSSERVER OCTET STRING Size (128) RADIUS server
Version: B 335
FiberHome Element Management System Northbound Interface (TL1) User Manual
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, > >
u Response message
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 WEPKEY1 WEPKEY2
WEPKEY3 WEPKEY4
1 Enable 20MHz/40MHz USA 5 802.11g 15 Bgolas Disable
Not-Available WPA2PSK AES 1111111111 3600 -- -- --
40 bit 1 -- -- -- --
2 Enable 20MHz/40MHz USA 5 802.11g 15 eeeeea Disable
Available WPA2PSK AES ru83n55c 3600 -- -- -- 40 bit
1 -- -- -- --
3 Enable 20MHz/40MHz USA 5 802.11g 15 ghhhhhh Disable Available
OPEN AES -- 86400 -- -- -- 40 bit 1 -- -- -- --
4 Enable 20MHz/40MHz USA 5 802.11g 15 wwwwww Disable Available
WPA2PSK AES ru83n55c 3600 -- -- -- 40 bit 1 -- -- -- --
--------------------------------------------------------------------
;
Related Command
None
336 Version: B
6 Integrated Testing Interface
Function Description
This command is used for querying the WAN connection service information of an
ONU.
Command Format
LST-ONUWANSERVICECFG:: > PONID=ponport_location, > >
Input Parameter
Version: B 337
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
338 Version: B
6 Integrated Testing Interface
Version: B 339
FiberHome Element Management System Northbound Interface (TL1) User Manual
340 Version: B
6 Integrated Testing Interface
Translation status
TRANSSTATE INTEGER 0 to 1 1: enable
0: disable
TRANSVALUE INTEGER 1 to 4085 VID after translation
TRANSCOS INTEGER 0 to 7 PON priority or COS
QinQ status
QINQSTATE INTEGER 0 to 1 1: enable
0: disable
TPID INTEGER 0-0xfffe Tag protocol identifier
DHCP REMOTEID OCTET STRING STRING (10) DHCP remote tag address
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
PON port 4 in slot 18 of the OLT whose IP address is 10.78.191.100.
u Command issued
LST-ONUWANSERVICECFG::OLTID=10.78.191.100,PONID=NA-NA-18-4,
>
u Response message
FH_10.82.25.73 2013-02-05 16:52:02
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Version: B 341
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
Command Format
RESET-ONU:: > > [RESETTYPE=resettype];
Input Parameter
342 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
None
Version: B 343
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
RESET-ONU::OLTID=10.78.191.100,PONID=NA-NA-18-4, > >
u Response message
FH_10.82.25.73 2013-02-21 14:52:34
M CTAG COMPLD
EN=0 ENDESC=No error
;
u Command issued
RESET-ONU::OLTID=10.78.191.100,PONID=NA-NA-18-4, > >
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
Function Description
This command is used for querying the IP address or range allocated to a user by
Wi-Fi.
344 Version: B
6 Integrated Testing Interface
Command Format
LST-USERDHCPSERVER:: > PONID=ponport_location,>
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Version: B 345
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
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, > >
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
346 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used for modifying the IP address or range allocated to the user
by Wi-Fi.
Command Format
CFG-USERDHCPSERVER:: > PONID=ponport_location, > 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
Version: B 347
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
348 Version: B
6 Integrated Testing Interface
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.
u Command issued
CFG-USERDHCPSERVER::OLTID=10.78.191.100,PONID=NA-NA-18-4, > > 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
Function Description
This command is used for querying the username and password of the web
interface.
Command Format
LST-WEBADMINISTRATOR:: > PONID=ponport_location,>
Version: B 349
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
350 Version: B
6 Integrated Testing Interface
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,
>
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
Related Command
None
Function Description
This command is used for modifying the username and password of the web
interface.
Command Format
CFG-WEBADMINISTRATOR:: > PONID=ponport_location, > [WEBUSERNAME=user_name][,WEBPASSWORD=web_password];
Version: B 351
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Web username,
WEBUSER- OCTET containing the (Optional) Default value:
Size (128)
NAME STRING alphanumeric characters admin
and the symbols ., /, - or _.
Web password,
WEBPASS- OCTET containing the (Optional) Default value:
Size (128)
WORD STRING alphanumeric characters admin
and the symbols ., /, - or _.
Response Format
352 Version: B
6 Integrated Testing Interface
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,
> 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
;
Related Command
None
Function Description
Command Format
RESTORE-DEFAULTCFG:: > PONID=ponport_location,>
Supported Device
u ONU: AN5506-04-F1.
Version: B 353
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
None
Example
u Command issued
354 Version: B
6 Integrated Testing Interface
RESTORE-DEFAULTCFG::OLTID=10.78.191.100,PONID=NA-NA-18-4, > >
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
Function Description
This command is used to query the type of ports on the line card.
Command Format
LST-PORTTYPE::[ > >
u Query the port types of the ONU that has a management IP address:
LST-PORTTYPE::>
u Query all the port types of the ONU that does not have a management IP
address:
LST-PORTTYPE::OLTID=olt-name,PONID=ponport_location, > type,>
u Query the port types of all the OLT's slots or those of a specified slot:
LST-PORTTYPE:: OLTID=olt-name[,BOARDID=BOARD_location]:CTAG::;
Input Parameter
Version: B 355
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
356 Version: B
6 Integrated Testing Interface
Example
Query the port type of PON port 9 in slot 12 of the OLT whose IP address is
10.171.0.106.
u Command issued
LST-PORTTYPE::OLTID=10.171.0.106,PONID=NA-NA-12-9, > >
u Response message
FH_10.170.95.552019-10-0911:58:48
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=6
listofallonuportinfo:
--------------------------------------------------------------------------------
OLTIDPONIDONUIDPORTNUMPORTTYPE
10.171.0.106NA-NA-12-9FHTT033466f81LAN
10.171.0.106NA-NA-12-9FHTT033466f82LAN
10.171.0.106NA-NA-12-9FHTT033466f83LAN
10.171.0.106NA-NA-12-9FHTT033466f84LAN
10.171.0.106NA-NA-12-9FHTT033466f81FXS
10.171.0.106NA-NA-12-9FHTT033466f82FXS
--------------------------------------------------------------------------------
;
Related Command
None
Function Description
This command is used to query the information about an optical module at a PON
port.
Command Format
LST-OPTICALMODULEINFO::OLTID=olt_name,PONID=ponport_location:CTAG::;
Version: B 357
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
VENDOR-
STRING Size (16) Vendor name
NAME
VEN-
STRING Size (16) Vendor model number
DORPN
VEN-
STRING Size (16) Vendor serial number
DORSN
ONLINES-
INTEGER Size (1) On-line status
TATUS
Optical module type (indicating the optical
OPTMODU- module type, e.g. CLASS B/C plus,
INTEGER Size (2)
LETYPE contained in the optical module serial
number information)
TEMPERA-
FLOAT Size (2) Optical module temperature
TURE
358 Version: B
6 Integrated Testing Interface
BIASCUR-
FLOAT Size (2) Bias current
RENT
TXPOWER FLOAT Size (2) Tx optical power
Example
Query the optical module parameter information of the PON port 9 in slot 12 of the
OLT whose IP address is 10.171.0.106.
u Command issued
LST-OPTICALMODULEINFO::OLTID=10.171.0.106,PONID=NA-NA-12-9:CTAG::;
u Response message
FH_10.170.95.552019-10-0912:44:04
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=1
PonOpticalModuleSNInfo
----------------------------------------------------------
OLTIDPONIDPONTECHNICALSTANDARDVENDORNAMEVENDORPN
VENDORSNONLINESTATUSOPTMODULETYPETEMPERATURE VOLTAGE
BIASCURRENTTXPOWERDATECODE VENDORREV
10.171.0.1061-1-12-9--SUPERXONLTD. SOEB4366-PSGB
--2absent0.000.000.000.00
----------------------------------------------------------
;
Related Command
None
Version: B 359
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
LST-OLTUPLINKMAC::OLTID=olt_name:CTAG::;
Input Parameter
Parameter
Data Type Value Range Description Remark
(Recommended)
Response Format
Output Parameter
Parameter
Data Type Value Range Description Remark
(Recommended)
Indicates the
OLT IP address, name
OLTID OCTET STRING Size (128) parameter entered by
or ID
the user.
Port number
Uplink port, for
PORTID OCTET STRING Size (128) example, 19: 1 -
A Trunk group, for
example, trunk:X
360 Version: B
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
(Recommended)
Example
Query the MAC address table of the uplink port of the OLT whose IP address is
10.190.40.156.
u Command issued
LST-OLTUPLINKMAC::OLTID=10.190.40.156:CTAG::;
u Response message
Related Command
None
Version: B 361
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
LST-UPLINKMULTICASTINFO::OLTID=olt_name,PONID=port_id:CTAG::;
Input Parameter
Response Format
Output Parameter
OCTET
OLTID Size (128) OLT IP address, name or ID.
STRING
OCTET The slot number and PON port number of the
PORTID Size (64)
STRING uplink card
OCTET online
PortStatus Port status
STRING offline
OCTET normal
OpticStatus Optical path status
STRING fail
DownMulti-
FLOAT - Downlink multicast speed
castSpeed
362 Version: B
6 Integrated Testing Interface
Example
Query the uplink multicast information of the OLT whose IP address is 10.171.0.31.
u Command issued
LST-UPLINKMULTICASTINFO::OLTID=10.171.0.31:CTAG::;
u Response message
Related Command
None
Function Description
Command Format
LST-UPLINKUTILIZATION::OLTID=olt-ip,PID=NA-NA-slot-port:CTAG::;
Version: B 363
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Value
Parameter Data Type Description Remark
Range
Response Format
Output Parameter
364 Version: B
6 Integrated Testing Interface
Example
Query the usage of the uplink port located on PON port 1 in slot 20 of the OLT
whose IP address is 10.182.1.105.
u Command issued
LST-UPLINKUTILIZATION::OLTID=10.182.1.105,PONID=NA-NA-20-1:CTAG::;
u Response message
Related Command
None
Function Description
Command Format
LST-UPLINKPORTSTATE::OLTID=olt_name,PONID=ponport_location:CTAG::;
Input Parameter
Version: B 365
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
OCTET
OLTID Size (128) OLT IP address, name or ID
STRING
PON port location information. Locate a port through
Size (128)
OCTET the information rack - shelf - slot - PON port
PONID Cabinet rack - shelf - slot
STRING number. If any part of the information is unavailable,
- PON port number
enter NA instead.
OCTET online
PortStatus Online status
STRING offline
Example
Query the status of the uplink port connected to PON port 1 in slot 19 of the OLT
whose IP address is 10.171.0.31.
u Command issued
LST-UPLINKPORTSTATE::OLTID=10.171.0.31,PONID=NA-NA-19-1:CTAG::;
u Response message
Related Command
None
366 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-UPLINKPORTINFO::[ > PONID=ponport_location, > BOARDID=BOARD_location]]:CTAG::;
Input Parameter
Version: B 367
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
UPLINK- OCTET
Size (128) -
PORT STRING
ADMIN- OCTET disable
-
STATE STRING enable
NEGOTIA- OCTET disable
-
TION STRING enable
Auto
10M
OCTET
SPEED 100M -
STRING
1000M
10000M
Working mode
Full
Full: full duplex
Half
OCTET Half: half duplex
DUPLEX Auto
STRING Auto: auto-negotiation
Auto-Full
Auto-Full: auto-negotiation - full duplex
Auto-Half
Auto-Half: auto-negotiation - half duplex
368 Version: B
6 Integrated Testing Interface
Example
Query the information of the uplink port in slot 19 of the OLT whose IP address is
10.171.0.106.
u Command issued
LST-UPLINKPORTINFO::OLTID=10.171.0.106,BOARDID=NA-NA-19:CTAG::;
u Response message
FH_10.170.95.552019-10-0914:28:21
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=5
listofuplinkportinfo:
---------------------------------------------------------
UPLINKPORTADMINSTATENEGOTIATIONSPEEDDUPLEX
1-1-19-1EnableEnable10000Mfull
1-1-19-2EnableEnable1000Mfull
1-1-19-3EnableEnable1000Mfull
1-1-19-4EnableEnable1000Mfull
1-1-19-5EnableDisable1000Mfull
---------------------------------------------------------
;
Related Command
None
Function Description
This command is used to query the remaining DBA bandwidth and the maximum
assured bandwidth under a PON port of a GPON line card.
Command Format
LST-PONBW::OLTID=olt-name,PONID=ponport_location:CTAG::;
Version: B 369
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Data Value
Parameter Description Remark
Type Range
Response Format
Output Parameter
Example
Query the remaining DBA bandwidth and maximum assured bandwidth of PON port
9 in slot 12 of the OLT whose IP address is 10.171.0.106.
u Command issued
LST-PONBW::OLTID=10.171.0.106,PONID=NA-NA-12-9:CTAG::;
u Response message
370 Version: B
6 Integrated Testing Interface
FH_10.170.95.552019-10-0913:12:07
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=1
listofPON BWinfo:
-------------------------------------------------
OLTIDPONIDMAXGBLFGBW
10.171.0.106-- 120000119504
-------------------------------------------------
;
Related Command
None
Function Description
This command is used to query the MAC address of the subscriber under a single
PON port.
Command Format
LST-PONMACADDRESS::OLTID=olt_name,PONID=ponport_location:CTAG::;
Input Parameter
Version: B 371
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
OCTET
OLTID Size (128) OLT IP address, name or ID
STRING
Size (128)
PON port location information. Locate a port
Cabinet rack -
OCTET through the information rack - shelf - slot -
PONID shelf - slot -
STRING PON port number. If any part of the
PON port
information is unavailable, enter NA instead.
number
VLAN INTEGER 0 to 4095 VLAN
OCTET MAC address in the format of XX-XXXX-XX-
MAC Size (128)
STRING XX-XX
ONUID INTEGER 0 to 128, 0xffff ONU authorization number
Example
Query the MAC address of the subscriber under PON port 8 in slot 17 of the OLT
whose IP address is 10.190.41.70.
u Command issued
LST-PONMACADDRESS::OLTID=10.190.41.70,PONID=NA-NA-17-8:CTAG::;
u Response message
FH_127.0.0.1 2017-09-20 16:13:59
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=2
List of PON port MAC address
-----------------------------------------------------------
OLTID PONID MAC VLAN ONUID
10.190.41.70 1-1-17-8 02-10-00-02-24-08 65535 1
10.190.41.70 1-1-17-8 02-10-18-01-24-01 65535 2
-----------------------------------------------------------
;
372 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used to query the CATV Rx optical power at the ONU side.
Command Format
LST-CATVOPTPOWER:: > >
Input Parameter
Required for
querying the
OLT PON port
OCTET OLT IP address, name or
OLTID Size (128) or the ONU that
STRING ID
has no
management
IP address
PON port location
information. Locate a port If the parameter
Size (128) through the information entered does
OCTET Cabinet rack - rack - shelf - slot - PON not include the
PONID
STRING shelf - slot - PON port number. If any part ONUID, the
port number of the information is PONID is
unavailable, enter NA optional.
instead.
Version: B 373
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
Example
Query the CATV Rx optical power of PON port 9 in slot 12 of the OLT whose IP
address is 10.171.0.106.
374 Version: B
6 Integrated Testing Interface
u Command issued
LST-CATVOPTPOWER::OLTID=10.171.0.106,PONID=NA-NA-12-9, > >
u Response message
FH_10.170.95.552019-10-0914:31:10
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=1
listofCATVRXopticalpowerinfo:
----------------------------------------------------------
OLTIDPONIDONUIDTYPE ONUIDCATVRXOPTPOWER
10.171.0.1061-1-12-9MACFHTT91fbe7c0-40.00
----------------------------------------------------------
;
Related Command
None
Function Description
This command is used to query the relationship between the NGN uplink data and
local VLAN.
Command Format
LST-NGNUPLINKANDVLAN::[ > PONID=ponport_location, > BOARDID=BOARD_location]]:CTAG::;
Version: B 375
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
376 Version: B
6 Integrated Testing Interface
Output Parameter
Example
Query the relationship between the ONU NGN uplink data and local VLAN. The
ONU (having no management IP address) is connected to PON port 1 in slot 5 of
the OLT whose IP address is 10.171.0.16; the ONUID is 54-4b-40-76-6c-28; the
authentication mode is MAC.
u Command issued
LST-NGNUPLINKANDVLAN::OLTID=10.171.0.16,PONID=NA-NA-5-1, > >
u Response message
FH_10.170.162.31 2018-06-02 21:03:11
M CTAG COMPLD
total_blocks=2
block_number=1
block_records=50
——————————————————————————————————-
——————————————————————————————————-
——————
Version: B 377
FiberHome Element Management System Northbound Interface (TL1) User Manual
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Function Description
Command Format
LST-IGMPADDRTAB::[ > PONID=ponport_location, > BOARDID=BOARD_location]]:CTAG::;
378 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Version: B 379
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
IP address, name or ID of
GROUPADDR OCTET STRING Size (128) the ONU that has a
management IP address
GROUPMEMBER-
INTEGER - -
SLOT
GROUPMEMBER-
INTEGER - -
PORT
Example
Query the multicast address table of the ONU with the ID FHTT03317f08 connected
to PON port 1 in slot 6 of the OLT with the IP address 10.171.0.28. The ONU has no
independent management IP address, and is authenticated by MAC address.
u Command issued
LST-IGMPADDRTAB::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 09:06:08
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=0
——————————————————————————————————-
——————————————————————————————————-
——————
——————————————————————————————————-
——————————————————————————————————-
——————
380 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used to query the private IP address assigned to a user by the
ONU.
Command Format
LST-ONUASSIGNUSERIP:: > PONID=ponport_location][,>
Input Parameter
Version: B 381
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Example
Read the private IP address assigned to a user by the ONU with the ID
FHTT03317f08 connected to PON port 1 in slot 6 of the OLT with the IP address
10.171.0.28. The ONU has no independent management IP address, and is
authenticated by MAC address.
u Command issued
LST-ONUASSIGNUSERIP::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 09:11:42
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
382 Version: B
6 Integrated Testing Interface
——————————————————————————————————-
——————————————————————————————————-
——————
IPADDRESS
0.0.0.0
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Function Description
This command is used to query the list of MAC addresses of the device connected
to an ONU (MAC address learning table). The query is at the ONU level. For the
AN5006-20, the query can be at the NE level.
Command Format
LST-ONUMACADDRESS:: > ponno],>
Input Parameter
Version: B 383
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
384 Version: B
6 Integrated Testing Interface
Example
Query the list of MAC addresses of the devices under the ONU with the ID
FHTT03317f08 connected to PON port 1 in slot 6 of the OLT with the IP address
10.171.0.28. The ONU has no independent management IP address, and is
authenticated by the MAC address.
u Command issued
LST-ONUMACADDRESS::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 09:16:32
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
——————————————————————————————————-
——————————————————————————————————-
——————
-1bc-98-89-31-7f-08NA-NA-NA-1 –
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
6.3.32 Querying the QinQ Domain Bound with the PON Port
(GET-PON-VLAN)
Function Description
This command is used for querying the QinQ domain of the PON port.
Version: B 385
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
GET-PON-VLAN::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
386 Version: B
6 Integrated Testing Interface
Output Parameter
Example
Query the QinQ domain bound with the PON port of the ONU with the ID
FHTT03317f08 connected to PON port 1 in slot 6 of the OLT with the IP address
10.171.0.28. The ONU has no independent management IP address, and is
authenticated by MAC address.
u Command issued
GET-PON-VLAN::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 09:42:26
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
——————————————————————————————————-
——————————————————————————————————-
——————
Version: B 387
FiberHome Element Management System Northbound Interface (TL1) User Manual
10.171.0.28 1-1-6-1900 48 48
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Function Description
This command is used to query the ONU status data, i.e., the test status of the port
loop detection.
Command Format
LST-LOOPDETECT::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
388 Version: B
6 Integrated Testing Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Version: B 389
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the port loop detection status of the ONU with the ID FHTT03317f08
connected to PON port 1 in slot 6 of the OLT with the IP address 10.171.0.28. The
ONU has no independent management IP address, and is authenticated by MAC
address.
u Command issued
LST-LOOPDETECT::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 09:44:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=4
——————————————————————————————————-
——————————————————————————————————-
——————
1 ENABLE 20
2 ENABLE 20
3 ENABLE 20
4 ENABLE 20
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
390 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-ONUPORTDESCRIPTION:: > PONID=ponport_location[,>
Input Parameter
Version: B 391
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
392 Version: B
6 Integrated Testing Interface
Example
u Command issued
LST-ONUPORTDESCRIPTION::>
u Response message
FH_10.170.162.31 2018-06-20 10:35:11
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
——————————————————————————————————-
——————————————————————————————————-
——————
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Version: B 393
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used to query the information about the ports of all local-end line
cards on the OLT.
Command Format
LST-OLTPORT::OLTID=olt-name:CTAG::;
Input Parameter
Value
Parameter Data Type Description Remark
Range
Response Format
Output Parameter
IP address, name or ID of
OLTID OCTET STRING Size (128)
the OLT
Locate a port through
cabinet rack - shelf -
Size (128) slot - port number.
PORTID OCTET STRING Cabinet rack - shelf - Enter NA if the
slot - port corresponding
information is not
specified.
394 Version: B
6 Integrated Testing Interface
Example
Query the information about the ports of all local-end line cards on the OLT with the
IP address 10.171.0.28. The ONU has no independent management IP address.
u Command issued
LST-OLTPORT::OLTID=10.171.0.28:CTAG::;
u Response message
FH_10.170.162.31 2018-06-20 10:36:02
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=16
——————————————————————————————————-
——————————————————————————————————-
——————
Version: B 395
FiberHome Element Management System Northbound Interface (TL1) User Manual
——————————————————————————————————-
——————————————————————————————————-
—————
Related Command
None
Function Description
This command is used to query the port information of all the ONUs under the OLT.
Command Format
LST-ONUPORT:: > >
Input Parameter
396 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
IP address, name or
OLTID OCTET STRING Size (128)
ID of the OLT
PON port location
information. Locate a
port through the
Size (128)
information rack -
Cabinet rack - shelf -
PONID OCTET STRING shelf - slot - PON
slot - PON port
port number. If any
number
part of the information
is unavailable, enter
NA instead.
Version: B 397
FiberHome Element Management System Northbound Interface (TL1) User Manual
ONU authorization
ONUNO INTEGER 0 to 512
number
Locate the ONU port
through cabinet rack
Size (128) - shelf - slot - port
ONUPORT OCTET STRING Cabinet rack - shelf - number. Enter NA if
slot - port the corresponding
information is not
specified.
Example
Query the port information of the ONU with the ID FHTT03317f08 connected to
PON port 1 in slot 6 of the OLT with the IP address 10.171.0.28. The ONU has no
independent management IP address, and is authenticated by MAC address.
u Command issued
LST-ONUPORT::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 10:38:36
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=6
list of all onu port info:
-------------------------------------------------------
OLTID PONID ONUNO ONUPORT ONUPORTTYPE
Related Command
None
398 Version: B
6 Integrated Testing Interface
Function Description
This command is used for querying ONU information by ONU MAC / LOID.
Command Format
QUERY-ONUINFO::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Version: B 399
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
Query the information of the ONU connected to PON port 1 in slot 6 of the OLT with
the IP address 10.171.0.28. The ONU has no independent management IP address,
and is authenticated by MAC address.
u Command issued
QUERY-ONUINFO::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 10:41:23
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
400 Version: B
6 Integrated Testing Interface
——————————————————————————————————-
——————————————————————————————————-
——————
System OnuName OnuType SlotNo PonNo OnuAuthNo Mac Pwd Loid SnPwd
28NE[13172938]-SLOT[6]-PON[1]-AN5506-04-F1[1]AN5506-04-
F1611FHTT03317f08 – ——
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Function Description
This command is used for querying the template bound with an ONU.
Command Format
LST-ONUBINDPROFILE::OLTID=olt-name,PONID=ponport_location,
>
Input Parameter
Version: B 401
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
402 Version: B
6 Integrated Testing Interface
Example
Query the template bound with the ONU with the ID FHTT05040404 connected to
PON port 2 in slot 1 of the OLT with the IP address 10.171.0.29. The ONU has no
independent management IP address, and is authenticated by MAC address.
u Command issued
LST-ONUBINDPROFILE::OLTID=10.171.0.29,PONID=NA-NA-1-2, > >
u Response message
FH_10.170.162.31 2018-06-20 11:50:31
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
——————————————————————————————————-
——————————————————————————————————-
——————
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Version: B 403
FiberHome Element Management System Northbound Interface (TL1) User Manual
The following introduces the command and example for querying the LAN
information.
Function Description
This command is used for querying the LAN port status and configuration of an
ONU.
Command Format
LST-ONULANINFO:: > >
Input Parameter
404 Version: B
6 Integrated Testing Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
AdminSta- UP
OCTET STRING Management status
tus DOWN
UP
OperStatus - Operating status
DOWN
Full
Half
DUPLEX OCTET STRING Auto Working mode
Auto-Full
Auto-Half
VLAN ID. The default VLAN ID is
PVID OCTET STRING Integer (1-4094)
adopted.
Version: B 405
FiberHome Element Management System Northbound Interface (TL1) User Manual
Auto-negotiation
10M
100M
SPEED INTEGER 1000M Port rate
Auto-10M
Auto-100M
Auto-1000M
Example
u Command issued
LST-ONULANINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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 OperStatus DUPLEX PVID VLANPRIORITY SPEED
UP DOWN -- 4088 0 --
-----------------------------------------------------------
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::>
u Response message
F FH_10.250.18.133 2010-11-02 10:33:09
M CTAG COMPLD
total_blocks=1
block_number=1
406 Version: B
6 Integrated Testing Interface
block_records=1
list of lan port info
-----------------------------------------------------------
AdminStatus OperStatus DUPLEX PVID VLANPRIORITY SPEED
UP DOWN Auto-Half 4088 0 Auto-10M
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the uplink and downlink rate control of an ONU
LAN port.
Command Format
LST-LANCAR:: > >
Input Parameter
Version: B 407
FiberHome Element Management System Northbound Interface (TL1) User Manual
Locate a card
through rack - shelf
Size (128)
- slot - port number.
OCTET Rack - shelf -
ONUPORT Enter NA for the Optional
STRING slot - port
corresponding
number
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
408 Version: B
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, > >
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 RateLimitDs
1024 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::>
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 RateLimitDs
64 1024
----------------------------------------
Related Command
None
Version: B 409
FiberHome Element Management System Northbound Interface (TL1) User Manual
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:: > >
Input Parameter
410 Version: B
6 Integrated Testing Interface
Locate a card
through rack - shelf
Size (128)
- slot - port number.
OCTET Rack - shelf - OLT uplink port or
PORTID Enter NA for the
STRING slot - port ONU LAN port
corresponding
number
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Number of received
InPkts DOUBLE 0-1.85E19
packets
Number of received
UnderSizePkts DOUBLE 0-1.85E19
undersized packets
Number of received
OverSizePkts DOUBLE 0-1.85E19
oversized packets
Version: B 411
FiberHome Element Management System Northbound Interface (TL1) User Manual
Number of discarded
InDiscards DOUBLE 0-1.85E19
received packets
Number of received
InUnicastPkts DOUBLE 0-1.85E19
unicast packets
Number of received
InMulticastPkts DOUBLE 0-1.85E19
multicast packets
Number of received
InBroadcastPkts DOUBLE 0-1.85E19
broadcast packets
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 OutOctets InOctets CRC UnderSizePkts
412 Version: B
6 Integrated Testing Interface
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::>
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 OutOctets InOctets CRC UnderSizePkts
OverSizePkts InErrors OutErrors InDiscards
OutDiscards InUnicastPkts InMulticastPkts InBroadcastPkts
OutUnicastPkts OutMulticastPkts OutBroadcastPkts
StateChangeCounters
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0
-----------------------------------------------------------
Related Command
None
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: B 413
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
TEST-PPPOESIMULATION:: > PONID=ponport_location, > > PASSWORD=password[,VPI=vpi,VCI=vci][,UV=user vlan][,AUTHMODE=authmode]
[timeout=timeout];
Input Parameter
ONU_NAME
ONU identifier type: ONU_
MAC
ONUIDTYPE OCTET STRING NAME, MAC, LOID, ONU_ Optional
LOI
NUMBER
ONU_NUMBER
414 Version: B
6 Integrated Testing Interface
Optional. By default,
it is not specified
UV INTEGER 1 to 4094 User-side VLAN
(simulating the
UNTAG application).
AUTO
Optional. Default
AUTHMODE OCTET STRING CHAP Dial-up authentication mode
value: AUTO
PAP
TIMEOUT INTEGER 0 to 300 Testing time duration. Unit: s. 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.
Version: B 415
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
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, > > PASSWORD=y;(Start testing)
TEST-PPPOESIMULATION::OLTID=10.171.0.16,PONID=NA-NA-1-1, > > PASSWORD=y;(query status)
u Response message
FH_10.170.4.2372015-12-2509:52:06
M CTAG COMPLD
EN=0 ENDESC=No error
;
416 Version: B
6 Integrated Testing Interface
result of PPPoESimulation
---------------------------------------------------
State Conclusion FailReason
Test
-- end --
----------------------------------------------------
;
Related Command
None
The following introduces the command and example for querying the DSL
information.
Function Description
This command is used for querying the status and configuration information of the
ADSL port.
Command Format
LST-ADSLINFO:: > >
Version: B 417
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
418 Version: B
6 Integrated Testing Interface
Output Parameter
UP
OPERSTATUS String Operating status
DOWN
UP
ADMINSTATUS String Management status
DOWN
See the The List of
TM OCTET STRING Actual transfer mode
Parameters.
Fast
LineType OCTET STRING Line type
Interleaved
Fixed: Indicates
fixed rate.
AutoAdaptAtStartup:
Indicates
automatically
Atur rate adaptation
AturRateMode OCTET STRING adapting on startup.
mode
AutoAdaptAtRun-
ning: Indicates
automatically
adapting during
running.
Fixed: Indicates
fixed rate.
AutoAdaptAtStartup:
Indicates
automatically
Atuc rate adaptation
AtucRateMode OCTET STRING adapting on startup.
mode
AutoAdaptAtRun-
ning: Indicates
automatically
adapting during
running.
Version: B 419
FiberHome Element Management System Northbound Interface (TL1) User Manual
Maximum downlink
MAXSNRMGNDS INTEGER 0 to 310 noise tolerance
Unit: 0.1 dB
Minimum downlink
MINSNRMGNDS INTEGER 0 to 310 noise tolerance
Unit: 0.1 dB
Uplink target noise
TGTSNRMGNUS INTEGER 0 to 310 tolerance
Unit: 0.1 dB
Maximum uplink noise
MAXSNRMGNUS INTEGER 0 to 310 tolerance
Unit: 0.1 dB
Minimum uplink noise
MINSNRMGNUS INTEGER 0 to 310 tolerance
Unit: 0.1 dB
Minimum rate of the
FASTMINRATEDS INTEGER 32 to 32000 fast downlink channel.
Unit: kbit/s
Maximum rate of the
FASTMAXRATEDS INTEGER 32 to 32000 fast downlink channel
Unit: kbit/s
Minimum rate of the
FASTMINRATEUS INTEGER 32 to 32000 fast uplink channel
Unit: kbit/s
Maximum rate of the
FASTMAXRATEUS INTEGER 32 to 32000 fast uplink channel
Unit: kbit/s
Minimum rate of the
interleaved downlink
INTVMINRATEDS INTEGER 32 to 32000
channel
Unit: kbit/s
Maximum rate of the
interleaved downlink
INTVMAXRATEDS INTEGER 32 to 32000
channel
Unit: kbit/s
Minimum rate of the
interleaved uplink
INTVMINRATEUS INTEGER 32 to 32000
channel
Unit: kbit/s
420 Version: B
6 Integrated Testing Interface
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 issued
LST-ADSLINFO::>
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 MAXSNRMGNUS MINSNRMGNUS FASTMINRATEDS
FASTMAXRATEDS FASTMINRATEUS FASTMAXRATEUS INTVMINRATEDS
INTVMAXRATEDS INTVMINRATEUS INTVMAXRATEUS INTVDELAYDS
INTVDELAYUS
DOWN DOWN 3 Interleaved AutoAdaptAtStartup
AutoAdaptAtStartup 6.00 31 0 6.00 31 0 0
100000 0 100000 0 100000 0 100000 16 16
----------------------------------------------------------
Related Command
None
Version: B 421
FiberHome Element Management System Northbound Interface (TL1) User Manual
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:: > >
Input Parameter
422 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
Version: B 423
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the information of ADSL port 1 in slot 3 of the ONU whose IP address is
10.250.18.121.
u Command issued
LST-ADSLPERF::>
424 Version: B
6 Integrated Testing Interface
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 AtnDs
AtnUs OutputPwrDs OutputPwrUs ChanTxRateDs ChanTxRateUs
AttainableRateDs AttainableRateUs
0 1736 0 0 0 0 0 0 0 0 0 0
-----------------------------------------------------------
Related Command
None
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.
Command Format
LST-ADSLSTAT:: NUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
>
Version: B 425
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
ONU_NAME
ONU identifier type:
ONUID- OCTET MAC
ONU_NAME, MAC, Optional
TYPE STRING LOID
LOID, ONU_NUMBER
ONU_NUMBER
Response Format
426 Version: B
6 Integrated Testing Interface
Output Parameter
AtucPerfPrev1DayTi-
INTEGER 0 to 86400 Elapsed time of the past day
meElapsed
Version: B 427
FiberHome Element Management System Northbound Interface (TL1) User Manual
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.
u Command issued
LST-ADSLSTAT::>
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 Curr15MinInits Curr15MinAtucEss
Curr15MinAtucLoss Curr15MinAtucSes
AtucPerfCurr1DayTimeElapsed Curr1DayInits Curr1DayAtucEss
Curr1DayAtucLoss Curr1DayAtucSes AtucPerfPrev1DayTimeElapsed
Prev1DayInits Prev1DayAtucEss Prev1DayAtucLoss Prev1DayAtucSes
444 0 0 0 0 10746 -- 4.29497e+09
4.29497e+09 0 0 0 0 0 0
---------------------------------------------------------
Related Command
None
428 Version: B
6 Integrated Testing Interface
Function Description
This command is used for querying the status and configuration information of the
VDSL2 port.
Command Format
LST-VDSLINFO:: > >
Input Parameter
Version: B 429
FiberHome Element Management System Northbound Interface (TL1) User Manual
Locate a card
through rack - shelf
Size (128) - slot - port number.
OCTET
ONUPORT Rack - shelf - slot Enter NA for the Optional
STRING
- port number corresponding
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
UP
ADMINSTATUS OCTET STRING Management status
DOWN
UP
OPERSTATUS String Operating status
DOWN
Downlink pulse noise
INPDS OCTET STRING 0-16, 0.5 protection; unit:
symbol
430 Version: B
6 Integrated Testing Interface
ATM
Data channel mode of
ChannelTMode OCTET STRING PTM
channel 1
BOTH
Maximum uplink rate
MAXRATEUS INTEGER - of channel 1 (unit:
kbps)
Maximum downlink
MAXRATEDS INTEGER - rate of channel 1 (unit:
kbps)
Maximum downlink
MINRATEDS INTEGER - 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)
Version: B 431
FiberHome Element Management System Northbound Interface (TL1) User Manual
Maximum downlink
MAXSNRMGNDS INTEGER 0 to 310 noise tolerance (unit:
0.1dB)
Minimum downlink
MINSNRMGNDS INTEGER 0 to 310 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::>
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
-----------------------------------------------------------
ADMINSTATUS OPERSTATUS INPDS INPUS RateModeDs
RateModeUs ChannelTMode MAXRATEUS MINRATEUS
MAXRATEDS MINRATEDS INTVDELAYUS INTVDELAYDS
TGTSNRMGNDS MAXSNRMGNDS MINSNRMGNDS TGTSNRMGNUS
MAXSNRMGNUS MINSNRMGNUS
DOWN DOWN 0.00 0.00 AutoAdaptAtStartup
AutoAdaptAtStartup PTM 28000 64 128000 64 16
16 6.00 31.00 0.006.00 31.00 0.00
-----------------------------------------------------------
432 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used for querying VDSL link traffic and line real-time information.
Command Format
LST-VDSLPERF:: > >
Input Parameter
Version: B 433
FiberHome Element Management System Northbound Interface (TL1) User Manual
ONU identifier,
used for uniquely
identifying the ONU
OCTET connected to the
ONUID Size (128) Optional
STRING PON port. The
value is ONU_
NAME, MAC, LOID
or ONU_NUMBER.
Response Format
Output Parameter
Number of received
InOctets INTEGER 0 to 2147483647
bytes
Downlink noise
SnrMgnDs INTEGER -640 to 630 tolerance
Unit: 0.1 dB
Uplink noise tolerance
SnrMgnUs INTEGER -640 to 630
Unit: 0.1 dB
434 Version: B
6 Integrated Testing Interface
Downlink power
AtnDs INTEGER 0 to 1270 attenuation
Unit: 0.1 dB
Uplink power
AtnUs INTEGER 0 to 1270 attenuation
Unit: 0.1 dB
Downlink output power
OutputPwrDs FLOAT -310 to 310
Unit: 0.1 dBm
Uplink output power
OutputPwrUs FLOAT -310 to 310
Unit: 0.1 dBm
Channel - downlink
CH1ACTDATAR-
INTEGER 0 to 200000 rate
ATEDS
Unit: kbps
Channel - downlink
CH1ACTDE-
INTEGER 0 to 200 delay
LAYDS
Unit: ms
CH1ACTDE- Channel - uplink rate
INTEGER 0 to 200000
LAYDS Unit: kbps
Version: B 435
FiberHome Element Management System Northbound Interface (TL1) User Manual
Maximum downlink
transmission rate (i.e.
DownMaxTrans-
INTEGER 64 to 1000000 assured rate of the
mitRate
downlink port)
Unit: Kbit/s
Count of local-end
Floating-point number
LinkRetrain INTEGER initialization failures
(10B:0)
Unit: times
Floating-point number Downlink real-time rate
DownSpeed -
(10B:0) Unit: Mbit/s
Floating-point number Uplink real-time rate
UpSpeed -
(10B:0) Unit: Mbit/s
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 issued
LST-VDSLPERF::>
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 OutOctets SnrMgnDs SnrMgnUs AtnDs
AtnUs OutputPwrDs OutputPwrUs CH1ACTDATARATEDS
CH1ACTDELAYDS CH1ACTDATARATEUS CH1ACTDELAYUS
0 1860 0.00 0.00 0 0 0 0 0 0
0 0
-------------------------------------------------------
Related Command
None
436 Version: B
6 Integrated Testing Interface
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:: > >
Input Parameter
Version: B 437
FiberHome Element Management System Northbound Interface (TL1) User Manual
Locate a card
through rack -
Size (128) shelf - slot - port
OCTET Rack - shelf - number. Enter
ONUPORT Optional
STRING slot - port NA for the
number corresponding
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
438 Version: B
6 Integrated Testing Interface
xdsl2PMLHist1DMoni-
INTEGER 0 to 86400 Elapsed time of the past day
toredTime
xdsl2PMLHistinit1DFul- Initialization times over the
INTEGER 0 to 2147483647
lInits 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::>
Version: B 439
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
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 xdsl2PMLCurrInit1DayFullInits
xdsl2PMLCurr1DayEs xdsl2PMLCurr1DayLoss xdsl2PMLCurr1DaySes
xdsl2PMLCurrInit1DayFailedFullInits xdsl2PMLHist1DMonitoredTime
xdsl2PMLHistinit1DFullInits xdsl2PMLHistinit1DFailedFullInits
xdsl2PMLHist1DEs xdsl2PMLHist1DLoss xdsl2PMLHist1DSes
463 0 0 0 0 0 10714 0 -- 0
0 0 0 -- 0 0 0 0
-----------------------------------------------------------
Related Command
None
Function Description
The command is used for conducting the single-ended loop test on the ADSL2+ /
VDSL2 port.
Command Format
SELT:: > >
440 Version: B
6 Integrated Testing Interface
Input Parameter
ONU identifier
ONU_NAME
type (ONU_
OCTET MAC
ONUIDTYPE NAME, MAC, Optional
STRING LOID
LOID, ONU_
ONU_NUMBER
NUMBER).
Version: B 441
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
Open
LINE_STATUS String Status
Short
ATTAINABLE_ Attainable downlink
Integer -
XTUC_RATE rate (kbps).
442 Version: B
6 Integrated Testing Interface
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.
u Command issued
SELT::>
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 ATTAINABLE_XTUC_RATE ATTAINABLE_XTUR_RATE
3910 Short 8260 1264
-----------------------------------------------------------
Related Command
None
Function Description
The command is used for conducting the double-ended loop test on an ADSL2+ or
a VDSL2 port.
Command Format
DELT:: > >
Version: B 443
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
444 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
Uplink signal
XTUC_DELT_SATN OCTET STRING Size (128)
attenuation (dB)
Downlink signal
XTUR_DELT_SATN OCTET STRING Size (128)
attenuation (dB)
Uplink signal-to-noise
XTUC_DELT_SNRM OCTET STRING Size (128)
ratio margin (dB)
Downlink signal-to-
XTUR_DELT_SNRM OCTET STRING Size (128)
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::>
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 XTUC_DELT_SNRM XTUR_DELT_SNRM
0.00 0.00 0.00 0.00
-----------------------------------------------------------
Related Command
None
Version: B 445
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying the PVC information of an ADSL port.
Command Format
LST-PVCINFO:: > >
Input Parameter
446 Version: B
6 Integrated Testing Interface
Locate a card
through rack - shelf
Size (128)
- slot - port number.
OCTET Rack - shelf -
ONUPORT Enter NA if the Optional
STRING slot - port
corresponding
number
information is not
specified.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
UP
PVCOPERSTATUS OCTET STRING PVC running status.
DOWN
UP PVC management
PVCADMINSTATUS OCTET STRING
DOWN status.
VPI 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
Version: B 447
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-PVCINFO::>
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 VCI PVID VLANPRIORITY
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
DOWN DOWN 0 0 4088 0
-----------------------------------------------------------
Related Command
None
Function Description
This command is used to query the SHDSL line template bound with SHDSL ports.
Command Format
LST-SHDSLINFO:: > >
448 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
Version: B 449
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
EFM
Port Mode INTEGER ATM Port mode
TDM
PAM16(1)
Code Type INTEGER Encoding type of the line
PAM32(2)
Target SNR
INTEGER -10 to 21 Uplink target SNR margin
Margin Up
0: disable
Line Probe Enable INTEGER Line detection switch
1: Enable
Example
Query the information of the template bound with the SHDSL port. The SHDSL port
is connected to PON port 1 in slot 3 of the OLT whose IP address is 10.190.40.16.
u Command issued
LST-SHDSLINFO::OLTID=10.190.40.16,PONID=NA-NA-3-1:CTAG::;
u Response message
Related Command
None
450 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-LINEIDENTIFIRESTATE::OLTID=olt_name:CTAG::;
Input Parameter
Response Format
Output Parameter
enable
OPTION82 OCTET STRING Option82 switch
disable
enable
PPPOE+ OCTET STRING PPPoE+ switch
disable
Example
Query the line ID of the DSL port of the OLT device whose IP address is
10.182.1.105.
u Command issued
LST-LINEIDETIFIERSTATE::OLTID=10.182.1.105:CTAG::;
Version: B 451
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
Related Command
None
Function Description
Command Format
LST-DSLPORTUPTIME::ONUIP|OLTID=olt_name,PONID=ponport_location:CTAG::;
452 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
Output Parameter
Version: B 453
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the online duration of the DSL port connected to PON port 2 in slot 13 of the
OLT whose IP address is 10.182.1.105.
u Command issued
LST-DSLPORTUPTIME::OLTID=10.182.1.105,PONID=NA-NA-13-2:CTAG::;
u Response message
FH_10.170.163.118 2018-05-07 20:24:50
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
Function Description
This command is used to query the rate control template on the MSAN public
platform.
Command Format
LST-BW::OLTID=olt_name:CTAG::;
454 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
Output Parameter
Example
Query the rate control template information of the OLT whose IP address is
10.182.1.105.
u Command issued
LST-BW::OLTID=10.190.40.216:CTAG::;
u Response message
FH_10.170.163.215 2018-05-11 11:40:54
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=3
Version: B 455
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used to query the configuration information of the rate control
template bound with the DSL ports of the MSAN public platform.
Command Format
LST-DSLPORTBW:: > >
Input Parameter
456 Version: B
6 Integrated Testing Interface
ONU identifier,
used for uniquely
identifying the
ONU connected to Optional for the
OCTET
ONUID Size (128) the PON port. The MSAN public
STRING
options include platform card.
ONU_NAME,
MAC, LOID and
ONU_NUMBER.
Response Format
Output Parameter
IP address, name or ID of
OLTID OCTET STRING Size (128)
the OLT
MSAN card port / PON port
location information. Locate
Size (128)
a port through cabinet rack
Cabinet rack - shelf -
PONID OCTET STRING - shelf - slot - port number.
slot - PON port
Enter NA if the
number
corresponding information
is not specified.
Version: B 457
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the configuration of the rate control template bound with DSL port 1 in slot 1
of the ONU whose IP address is 10.171.0.131.
u Command issued
LST-DSLPORTBW::>
u Response message
FH_10.170.95.552019-10-0916:07:19
MCTAGCOMPLD
total_blocks=1
block_number=1
block_records=1
listofrate-limitinfo
---------------------------------------------
OLTIDPONIDRateLimitUsRateLimitDs
-- ---- --
---------------------------------------------
;
Related Command
None
Function Description
This command is used to query the traffic policy template bound with ports.
Command Format
LST-PORTFLOWPOLICY::OLTID=olt-name,PONID=NA-NA-slot-port:CTAG::;
458 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
Version: B 459
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
Query the traffic policy template information of PON port 1 in slot 1 of the OLT
whose IP address is 190.40.216.
u Command issued
LST-PORTFLOWPOLICY::OLTID=10.190.40.216,PONID=NA-NA-1-1:CTAG::;
460 Version: B
6 Integrated Testing Interface
u Response message
Related Command
None
Function Description
This command is used to query the status of the SHDSL ports on the specified
device.
Command Format
LST-SHDSLPORT:: > CTAG::;
Version: B 461
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
EFM
PortMode INTEGER ATM Port mode
TDM
1: NOT_CONFIG (idle; not
configured)
Portactivated- 2: CONFIG (idle; configured) Activation status of the
INTEGER
Status 3: INIT (being initialized) port
4: TRAINING
5: DATA
0: not bind
Binding status of the
M-PairStatus INTEGER 1: bind as master
port
2: bind as slaver
462 Version: B
6 Integrated Testing Interface
Example
Query the status of PON port 3 in slot 2 of the OLT whose IP address is 10.171.0.29.
u Command issued
LST-SHDSLPORT::OLTID=10.171.0.29,PONID=NA-NA-2-3:CTAG::;
u Response message
Version: B 463
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
Command Format
LST-ADSLPERF-EX:: > >
Input Parameter
Required for an
ONU that has
OCTET IP address, name or ID of
OLTID Size (128) no
STRING the OLT
management IP
address
PON port location
information. Locate a port If the parameter
Size (128) through cabinet rack - entered does
OCTET Cabinet rack - shelf - slot - PON port not include the
PONID
STRING shelf - slot - PON number. Enter NA if the ONUID, the
port number corresponding PONID is
information is not optional.
specified.
464 Version: B
6 Integrated Testing Interface
Response Format
Output Parameter
Version: B 465
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the port status of PON port 1 in slot 14 of the OLT whose IP address is
10.182.1.105.
u Command issued
LST-ADSLPERF::OLTID=10.182.1.105,PONID=114-1:CTAG::;
u Response message
Related Command
None
466 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-VDSLPERF-EX:: > >
Input Parameter
ONU_NAME
ONU identifier type
MAC
OCTET (ONU_NAME, MAC,
ONUIDTYPE LOID Optional
STRING LOID and ONU_
ONU_
NUMBER).
NUMBER
Version: B 467
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
Number of received
InOctets INTEGER 0 to 2147483647
bytes
468 Version: B
6 Integrated Testing Interface
Example
Query the port status of PON port 1 in slot 16 of the OLT whose IP address is
10.182.1.105.
u Command issued
LST-VDSLPERF::OLTID=10.182.1.105,PONID=16-1:CTAG::;
u Response message
Related Command
None
The following introduces the command and example for querying the VLAN
information.
Function Description
Version: B 469
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
LST-VLANFWDINFO:: > [,>
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,
>
Input Parameter
ONU_NAME
ONU identifier type: ONU_
MAC
ONUIDTYPE OCTET STRING NAME, MAC, LOID, ONU_
LOID
NUMBER
ONU_NUMBER
470 Version: B
6 Integrated Testing Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Number of uplink
FramesUs DOUBLE 0 to 2147483647
messages
Number of downlink
FramesDs DOUBLE 0 to 2147483647
messages
Number of uplink
OctetsUs DOUBLE 0 to 2147483647
bytes
Number of downlink
OctetsDs DOUBLE 0 to 2147483647
bytes
(Optional) Number of
DiscardsUs DOUBLE 0-1.85E19 discarded uplink
message
(Optional) Number of
DiscardsDs DOUBLE 0-1.85E19 discarded downlink
message
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, > >
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
Version: B 471
FiberHome Element Management System Northbound Interface (TL1) User Manual
-----------------------------------------------------------
FramesUs FramesDs OctetsUs OctetsDs DiscardsUs DiscardsDs
0 0 0 0 0 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::>
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
Function Description
Command Format
LST-PORTSERVICEVLAN::OLTID=olt-name,PONID=ponport_location:CTAG::;
472 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Version: B 473
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the port VLAN of the ONU connected to PON port 1 in slot 6 of the OLT with
the IP address 10.171.0.28. The ONU has no independent management IP address,
and is authenticated by MAC address.
u Command issued
LST-PORTSERVICEVLAN::OLTID=10.171.0.28,PONID=NA-NA-6-1:CTAG::;
u Response message
FH_10.170.162.31 2018-06-20 10:39:53
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
--------------------------------------------------------------
ONUIPOLTIDPONIDONUIDONUPORT SVLAN CVLANVPIVCIUV
--10.171.0.281-1-6-1 1NA-NA-NA-190047----47
--------------------------------------------------------------
;
Related Command
None
The following introduces the command and example for querying the IPTV
information.
474 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-IPTVCFG:: > > CTAG::;
Input Parameter
Version: B 475
FiberHome Element Management System Northbound Interface (TL1) User Manual
Locate a card
through rack -
Size (128) shelf - slot - port
OCTET Rack - shelf - number. Enter
ONUPORT Optional
STRING slot - port NA for the
number corresponding
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
476 Version: B
6 Integrated Testing Interface
Example
u Command issued
LST-IPTVCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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::>
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: B 477
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used to query the multicast mode, multicast version and multicast
VLAN.
Command Format
LST-IGMPINFO::OLTID=olt_name:CTAG::;
Input Parameter
Response Format
Output Parameter
(1) IGMP_V1/V2
(2) IGMP_V3
igmpversion OCTET STRING Multicast version
(3) MDL_V1
(4) MDL_V2
478 Version: B
6 Integrated Testing Interface
Example
Query the multicast mode, multicast version and multicast VLANID of the OLT
whose IP address is 10.182.1.105.
u Command issued
LST-IGMPINFO::OLTID=10.182.1.105:CTAG::;
u Response message
Related Command
None
Function Description
This section introduces the command and example for querying the multicast
protocol parameters for the AN5516/AN5116 series OLT V4.x devices.
Command Format
LST-IGMPPROTOPARAM::OLTID=olt_name:CTAG::;
Input Parameter
Version: B 479
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
Example
u Command issued
LST-IGMPPROTOPARAM::OLTID=10.182.1.105:CTAG::;
u Response message
Related Command
None
480 Version: B
6 Integrated Testing Interface
Function Description
Command Format
LST-BOARDIGMPADDRTABLE::OLTID=olt_name,BOARDID=board_id:CTAG::;
Input Parameter
Response Format
Output Parameter
Example
Query the multicast address table of the line card in slot 16 of the OLT whose IP
address is 10.182.1.105.
u Command issued
Version: B 481
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-BOARDIGMPADDRTABLE::OLTID=10.182.0.105,BOARDID=NA-NA-15:CTAG::;
u Response message
Related Command
None
Function Description
Command Format
LST-IGMPSSMIPRANGE::OLTID=olt_name:CTAG::;
Input Parameter
Response Format
482 Version: B
6 Integrated Testing Interface
Output Parameter
Example
Query the multicast SSM IP address range of the OLT whose IP address is
10.182.1.105.
u Command issued
LST-IGMPSSMIPRANGE::OLTID=10.182.1.105:CTAG::;
u Response message
Related Command
None
Function Description
Version: B 483
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
LST-IGMPProxyIP::OLTID=olt_name:CTAG::;
Input Parameter
Response Format
Output Parameter
Example
Query the multicast proxy IP address of the OLT whose IP address is 10.171.0.31.
u Command issued
LST-IGMPProxyIP::OLTID=10.171.0.31:CTAG::;
u Response message
Related Command
None
484 Version: B
6 Integrated Testing Interface
The following introduces the command and example for querying the VoIP
information.
Function Description
This command is used to query the voice quality statistics based on voice
subscribers.
Command Format
LST-VOIPINFO:: > >
Input Parameter
Version: B 485
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
486 Version: B
6 Integrated Testing Interface
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 port 1 of the OLT whose IP address is
10.250.18.100.
u Command issued
LST-VOIPINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
u Response message
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 issued
LST-VOIPINFO::>
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 TxPackets RxPackets MeanDelay
MeanJitter FractionLoss
1970-01-01 00:00:00 0 0 0 0 0
-----------------------------------------------------------
Version: B 487
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
Command Format
LST-MGCFG:: > >
Input Parameter
488 Version: B
6 Integrated Testing Interface
(Optional) MG If it is not
identifier, used specified, the
for uniquely configurations of
MGID INTEGER 0 to 16
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.
Output Parameter
MG identifier, used
for uniquely
MGID INTEGER 0 to 16
identifying the MG
module on the ONU.
Voice protocol type
PT OCTET STRING Size (1 to 32)
(H.248, SIP)
Version: B 489
FiberHome Element Management System Northbound Interface (TL1) User Manual
MG gateway domain
EID OCTET STRING Size (1 to 64) name in the H248
configuration
IP address of the
MGCIP1 OCTET STRING Size (32)
active softswitch
IP address of the
MGCIP2 OCTET STRING Size (32)
standby softswitch
Enabled
HEARTBEATMODE OCTET STRING Heartbeat mode
Disable
Heartbeat cycle
HEARTBEATCYCLE Integer 0 to 65535
Unit: s
Number of detected
HEARTBEATNUM Integer 1 to 3
heartbeats
Example
u Command issued
LST-MGCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
490 Version: B
6 Integrated Testing Interface
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
-----------------------------------------------------------
MGID PT EID SIPREGDM SVLAN VOIPVLAN IPMODE
IPADDRESS IPMASK IPGATEWAY PPPOEUSER PPPOEPWD
SCOS CCOSMGCIP1 MGCIP2 HEARTBEATMODE HEARTBEATCYCLE
HEARTBEATNUM
0 H.248 10.37.0.1 65535 1515 STATIC 10.37.0.1
255.255.255.0 10.37.0.254 65535 7
10.37.0.103 Enable 30 3
-----------------------------------------------------------
u Command issued
LST-MGCFG::>
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 EID SIPREGDM SVLAN VOIPVLAN IPMODE
IPADDRESS IPMASK IPGATEWAY PPPOEUSER PPPOEPWD
SCOS CCOSMGCIP1 MGCIP2 HEARTBEATMODE HEARTBEATCYCLE
HEARTBEATNUM
0 H.248 12345678 1515 STATIC 0.0.0.0
0.0.0.0 0.0.0.0 7 0 Enable 30 3
-----------------------------------------------------------
Related Command
None
Version: B 491
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying the running status of an access gateway
interface.
Command Format
LST-MGINFO:: > >
Input Parameter
492 Version: B
6 Integrated Testing Interface
(Optional) MG If it is not
identifier, used specified, the
for uniquely configurations of
MGID INTEGER 0 to 16
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.
Output Parameter
MGID INTEGER 0 to 16 -
Registering.
Registering
Registered
UP
successfully.
Fault
OperState OCTET STRING IAD failure.
Deregistered
Logout
Restarting
IAD restarting.
Other
Others
Version: B 493
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 Command issued
LST-MGINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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::>
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
494 Version: B
6 Integrated Testing Interface
Function Description
This command is used for querying the fax parameter of a POTS port.
Command Format
LST-FAXINFO:: > >
Input Parameter
Version: B 495
FiberHome Element Management System Northbound Interface (TL1) User Manual
Locate a card
through rack -
Size (128) shelf - slot - port
OCTET Rack - shelf - number. Enter
ONUPORT Optional
STRING slot - port NA for the
number corresponding
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
T30
FAXMODE String Fax mode
T38
Voice channel of the
NONE
control mode
CONTROLMODE String SS
Full control
AUTOVBD
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.
496 Version: B
6 Integrated Testing Interface
u Command issued
LST-FAXINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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::>
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
Function Description
This command is used for querying the POTS port information, including the line
status, service status, impedance and gain.
Version: B 497
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
LST-POTSINFO::onu_name|OLTID=olt_name[,PONID=ponport_location,
>
Input Parameter
498 Version: B
6 Integrated Testing Interface
Locate a card
through rack -
Size (128) shelf - slot - port
OCTET Rack - shelf - number. Enter
ONUPORT Optional
STRING slot - port NA for the
number corresponding
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Version: B 499
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Line status:
Registering
Registering port.
Idle
Port is idle.
Off-hook
Off-hook.
Dialing
Dialing.
Ringing
Ringing.
Ringing-back
LineState OCTET STRING Ringing back.
Connecting
Connecting.
Connected
Connected.
Releasing
Releasing the connection.
Register-failed
Registering port failed.
Deactived
The port is not activated.
Other
Others.
Service status:
endLocal: The service is
terminated by the local end
due to the port disabled by
the user.
EndLocal endRemote: The service is
EndRemote terminated by the far end
ServiceState OCTET STRING
EndAuto due to the command sent
Normal by MGC.
endAuto: The service is
terminated automatically
due to the MGC failure.
normal: The service is
normal.
Enabled
EchoCancel OCTET STRING Echo suppression
Disable
Enabled
ReversedPolarity OCTET STRING Polarity reversal signal
Disable
Receive gain
RxGain Float -20 to 20
Unit: dB
Send gain
TxGain Float -20 to 20
Unit: dB
PN OCTET STRING Size (1 to 32) SIP telephone number
500 Version: B
6 Integrated Testing Interface
Password corresponding
SIPUSERPWD OCTET STRING Size (1 to 32)
to the SIP user port
MG identifier, identifying
MGID INTEGER 0 to 16 the MG module being used
by the user.
Example
u Command issued
LST-POTSINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1, > >
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 ServiceState EchoCancel ReversedPolarity
RxGain TxGain PN TID SIPUSERNAME SIPUSERPWD
Idle Normal Enable Enable 0 0 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::>
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
-----------------------------------------------------------
Version: B 501
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
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:: > >
Input Parameter
502 Version: B
6 Integrated Testing Interface
Locate a card
through rack -
(Optional) Port
Size (128) shelf - slot - port
of the voice
OCTET Rack - shelf - number. Enter
ONUPORT service
STRING slot - port NA for the
corresponding to
number corresponding
the broadband
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Version: B 503
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
504 Version: B
6 Integrated Testing Interface
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, > >
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 DCAG DCBG DCAB RAG
RBG RAB CapAG CapBG CapAB
22 15 15 21 477 485 14 >10M
>10M >10M 1365005500 1365204625 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::>
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
-----------------------------------------------------------
Version: B 505
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
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:: > PONID=ponport_location, > >
Input Parameter
506 Version: B
6 Integrated Testing Interface
Locate a card
through rack -
(Optional) Port
Size (128) shelf - slot - port
of the voice
OCTET Rack - shelf - number. Enter
ONUPORT service
STRING slot - port NA for the
corresponding to
number corresponding
the broadband
unspecified
information.
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Version: B 507
FiberHome Element Management System Northbound Interface (TL1) User Manual
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, > >
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::>
u Response message
FH_10.250.18.133 2010-11-02 09:55:02
M CTAG COMPLD
total_blocks=1
508 Version: B
6 Integrated Testing Interface
block_number=1
block_records=1
list of pots inside line test
-----------------------------------------------------------
LoopCurrent FeedV RingV FeedVValue RingVValue LoopCurrentValue
Normal Normal Abnormal 39278 64314 22
-----------------------------------------------------------
Related Command
None
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:: > PONID=ponport_location, > ACTION=action-type[,TIMEOUT=timeout];
Version: B 509
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
510 Version: B
6 Integrated Testing Interface
Test time
TIMEOUT INTEGER 60 to 300 -
Unit: s
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.
Output Parameter
1 Succeeded
2 Failed
The call connection These two
Conclusion INTEGER is established, but parameters are
3 the tester has not returned when the
confirmed the call input parameter
connection status. "Action" is "Stop".
No signaling
FailReason INTEGER 1
interaction.
Version: B 511
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 Command issued
TEST-CALLEESIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
> ACTION=Start,TIMEOUT=60;
TEST-CALLEESIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
> 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 FailReason
6 2 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
512 Version: B
6 Integrated Testing Interface
TEST-CALLEESIMULATION:: > ACTION=Start,TIMEOUT=60;
TEST-CALLEESIMULATION:: > 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 FailReason
6 2 1
-----------------------------------------------------------
Related Command
None
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.
Version: B 513
FiberHome Element Management System Northbound Interface (TL1) User Manual
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:: > PONID=ponport_location, > > TIMEOUT=timeout];
Input Parameter
514 Version: B
6 Integrated Testing Interface
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.
Version: B 515
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Telephone number
DIALNUMBER OCTET STRING Size (32) -
dialed for testing.
516 Version: B
6 Integrated Testing Interface
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,
> ACTION=Start,TEL=1110,TIMEOUT=60;
TEST-CALLERSIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
> 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 TARGETNUMBER FAILEDSIG
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.
Version: B 517
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command issued
TEST-CALLERSIMULATION:: > ACTION=Start,TEL=1110,TIMEOUT=60;
TEST-CALLERSIMULATION:: > 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
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 simulate a user initiating the PPPoE dial-up so as to
verify whether the user dial-up service connection can be normally established.
Command Format
CFG-PPPOESIMULATION:: > PONID=ponport_location, > PPPOESWITCH=pppoe-test-switch[,USERNAME=username][,PASSWORD=password][,
VPI=vpi][,VCI=vci][,CVLAN=cvlan][,AUTHMODE=pppoe-authmode][,CCOS=cvlan-
cos][,SVLAN=svlan][,SCOS=svlan-cos][,TIMEOUT=test-time][,
REDIALTIMES=re-dail-times];
518 Version: B
6 Integrated Testing Interface
Input Parameter
ONU_NAME
ONU identifier type: ONU_
MAC
ONUIDTYPE OCTET STRING NAME, MAC, LOID or ONU_ -
LOI
NUMBER
ONU_NUMBER
AUTO
Optional. Default
AUTHMODE OCTET STRING CHAP Dial-up authentication mode
value: AUTO
PAP
Version: B 519
FiberHome Element Management System Northbound Interface (TL1) User Manual
Test time
TIMEOUT INTEGER 0 to 300 Optional
Unit: s
REDIALTIMES INTEGER - Number of re-dialing times Optional
Response Format
Output Parameter
None
Example
Simulate a user initiating the PPPoE dial-up on the ONU with the ID FHTT03317e78,
which is connected to PON port 6 in slot 7 of the OLT with the IP address
10.190.40.156. In this way, verify whether the user dial-up service connection can
be normally established.
u Command issued
CFG-PPPOESIMULATION::OLTID=10.190.40.156,PONID=NA-NA-7-6, > > PASSWORD=12345678;
u Response message
FH_10.170.3.76 2018-08-11 09:19:03
M CTAG COMPLD
EN=0 ENDESC=No error
;
520 Version: B
6 Integrated Testing Interface
Related Command
None
Function Description
This command is used for querying the AIS PPPoE emulation test result.
Command Format
LST-PPPOESIMULATION::[ > PONID=ponport_location, > BOARDID=BOARD_location]]:CTAG::;
Input Parameter
Version: B 521
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
522 Version: B
6 Integrated Testing Interface
ClientPrimar-
String dns -
yDNS
ClientSecondar-
String dns -
yDNS
Example
Read the AIS PPPoE emulation test result of the ONU with the ID FHTT03317f08
connected to PON port 1 in slot 6 of the OLT with the IP address 10.171.0.28. The
ONU has no independent management IP address, and is authenticated by MAC
address.
u Command issued
LST-PPPOESIMULATION::OLTID=10.171.0.28,PONID=NA-NA-6-1, > >
u Response message
FH_10.170.162.31 2018-06-20 09:12:50
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
——————————————————————————————————-
——————————————————————————————————-
——————
Version: B 523
FiberHome Element Management System Northbound Interface (TL1) User Manual
——————————————————————————————————-
——————————————————————————————————-
——————
Related Command
None
Function Description
Command Format
LST-NGNRESOURCE:: > >
524 Version: B
6 Integrated Testing Interface
Input Parameter
Response Format
Output Parameter
Version: B 525
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
LST-NGNRESOURCE::OLTID=172.30.15.58,PONID=NA-NA-11-5, > >
u Response message
FH_10.99.2.201 2019-06-17 11:46:26
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=2
Related Command
None
526 Version: B
6 Integrated Testing Interface
The following introduces the command and example for querying the alarm
information.
Function Description
Command Format
QUERY-ALARM:: > > ENDTIME=end-time][,FAULTFLAG=flag];
u Query an OLT:
QUERY-ALARM::OLTID=olt-name:CTAG::[BEGINTIME=begin-time][,ENDTIME=end-
time][,FAULTFLAG=flag];
Version: B 527
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
528 Version: B
6 Integrated Testing Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Version: B 529
FiberHome Element Management System Northbound Interface (TL1) User Manual
Critical
Major
SEVERITY String Alarm level
Minor
Warning
Fault
FaultFlag String Recovery Alarm status
Event
Alarm generation time.
HAPPENTIME String Size (0 to 32) Format: YYYY-MM-DD HH:
MM:SS.
Alarm recovery time.
RECOVERTIME String Size (0 to 32) Format: YYYY-MM-DD HH:
MM:SS.
communicationsAlarm
qualityOfServiceAlarm
ALARMTYPE String processingErrorAlarm Alarm type
equipmentAlarm
environmentalAlarm
Additional information,
describing additional
AditionalInfo String Size (0 to 256)
information related to the
alarm.
PROBABLE_CAUSE
String Size (0 to 256) Alarm cause
_DESC
530 Version: B
6 Integrated Testing Interface
PROBABEL_
Integer - Alarm cause code
CAUSE_CODE
PROPOSED_
String Size (0 to 512) Handling advice
ADVISE
Example
u Command issued
QUERY-ALARM::OLTID=10.78.200.200,PONID=NA-NA-15-1, > >
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 DTYPE POSITION
SEVERITY FaultFlag HAPPENTIME RECOVERTIME
ALARMTYPE ADITIONALINFO EVENT_CODE
PROBABLE_CAUSE_DESC
135 ONU_H248_BREAKOUT 10.250.18.100
AN5006-04 AN5006-04
RACK:NA,SHELF:NA,SLOT:3,PORT:1,ONUNUM:5,ONUNAME:AN5006-04
Critical Faul2010-11-01 14:51:51 -- CommunicationAlarm
-- 320001 ONU_H248_BREAKOUT99 ONU_H248_BREAKOUT 10.250.18.100
AN5006-04 AN5006-04
u Command issued
QUERY-ALARM::>
u Response message
FH_10.250.18.133 2010-11-02 10:34:38
M CTAG COMPLD
Version: B 531
FiberHome Element Management System Northbound Interface (TL1) User Manual
total_blocks=2
block_number=2
block_records=3
Alarm
-
SERIALID ALARMNAME DIP DNAME DTYPE POSITION
SEVERITY FaultFlag HAPPENTIME RECOVERTIME
ALARMTYPE ADITIONALINFO EVENT_CODE PROBABLE_CAUSE_DESC
2 ONU_H248_BREAKOUT 10.250.18.121 system 2 AN5006-20
RACK:NA,SHELF:NA,SLOT:5,PORT:0 Critical Recovery
2010-10-28 09:13:14 2010-11-01 09:48:13 CommunicationAlarm --
320001 ONU_H248_BREAKOUT3 OLT card status anomaly 10.250.18.121
system 2 AN5006-20 RACK:NA,SHELF:NA,SLOT:4 Critical Recovery
2010-11-01 11:06:42 2010-11-01 11:15:34 EquipmentAlarm --
110003 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 AN5006-20
RACK:NA,SHELF:NA,SLOT:4 Critical Recovery 2010-11-01
15:11:06 2010-11-01 15:19:14 EquipmentAlarm -- 110003
OLT card status anomaly, including (running anomaly, not activated,
inconsistent of the card and configuration type)-
Related Command
None
532 Version: B
7 Integrated Query Interface
The following introduces the commands for physical resource query, service
resource query, resource change notification and resource file export.
Version: B 533
FiberHome Element Management System Northbound Interface (TL1) User Manual
The following introduces the commands and examples for querying the equipment
information.
Function Description
This command is used for querying the information of a specified set or all sets of
OLT.
Command Format
LST-DEVICE::[OLTID=olt-name]:CTAG::;
Input Parameter
IP address or name
OLTID OCTET STRING Size (128)
of the OLT
Response Format
Output Parameter
534 Version: B
7 Integrated Query Interface
Alias name
ALIAS OCTET STRING Size (32)
Example
For example, query the information of the OLT whose IP address is 10.250.18.100.
u Command issued
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 DT DEVER
System 1 10.250.18.100 AN5516_01 RP0121
-----------------------------------------------------------
Related Command
LST-DEVINFO
Version: B 535
FiberHome Element Management System Northbound Interface (TL1) User Manual
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:: > >
Input Parameter
536 Version: B
7 Integrated Query Interface
Response Format
Output Parameter
Version: B 537
FiberHome Element Management System Northbound Interface (TL1) User Manual
ONU authorization
ONUNO INTEGER 0 to 512
number
NAME OCTET STRING Size (128) ONU name
ONU description
DESC OCTET STRING Size (128)
information.
ONUTYPE OCTET STRING Size (128) ONU type
The management IP
IP OCTET STRING Size (128)
address of the ONU.
MAC
LOID Authentication mode.
LOIDONCEON When no authentication
AUTHTYPE OCTET STRING
PASSWORD and mode is specified, a
PASSWORDONCEON dash (–) will be returned.
are added.
The registered MAC
MAC OCTET STRING Size (128)
information of the ONU.
When the MAC
authentication is
LOID OCTET STRING Size (64)
adopted, a dash (–) will
be returned.
LOID password. If no
PWD OCTET STRING Size (128) password is specified, a
dash (–) will be returned.
Example
u Command issued
538 Version: B
7 Integrated Query Interface
LST-ONU::OLTID=10.250.18.102,PONID=NA-NA-4-1, > >
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 NAME DESC ONUTYPE IP AUTH MAC
LOID PWD SWVER
10.250.18.102 NA-1-4-1 2 AN5006-04 --
AN5006-04 -- LOID 54-4b-40-0c-79-a8 whdx04 --
R4.05.60.25
-----------------------------------------------------------
u Command issued
LST-ONU::>
u Response message
FH_10.250.18.133 2010-11-04 10:53:54
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
--------------------------------------------------
OLTID PONID ONUNO NAME DESC ONUTYPE IP AUTH MAC
LOID PWD SWVER
10.250.18.100 NA-1-1-1 2 AN5006-20 --
AN5006-20 10.250.18.121 MAC 54-4b-17-00-00-80
whdx2020 -- b230
-----------------------------------------------------------
Related Command
LST-ONUCFG
Version: B 539
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying the ONU hardware / software version
information.
Command Format
LST-ONUVERSION::OLTID=olt-name,PONID=ponport_location, > type,>
Input Parameter
540 Version: B
7 Integrated Query Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
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
Version: B 541
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-ONUVERSION::OLTID=10.78.200.200,PONID=NA-NA-11-4, > >
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
Related Command
None
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::[ > >
542 Version: B
7 Integrated Query Interface
LST-SHELF::OLTID=olt-name,PONID=ponport_location, > >
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Version: B 543
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
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
544 Version: B
7 Integrated Query Interface
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID SHELFID SHELFTYPE
-- 10.250.18.100 -- -- 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::>
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 PONID ONUID SHELFID SHELFTYPE
10.250.18.121 10.250.18.100 NA-1-1-1 NA-1 AN5006-20
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the card information of a specified OLT or a
specified ONU or all sets of equipment in the entire network.
Command Format
LST-BOARD::[ > > CTAG::;
Version: B 545
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-BOARD::OLTID=olt-name[,BOARDID=BOARD_location]:CTAG::;
u Query the card information of the ONU that has a management IP address:
LST-BOARD::>
u Query the card information of the ONU that has no management IP address:
LST-BOARD::OLTID=olt-name,PONID=ponport_location, > >
Input Parameter
ONU_NAME, MAC,
OCTET LOID, ONU_
ONUIDTYPE Size (128) Optional
STRING NUMBER or
PASSWORD
546 Version: B
7 Integrated Query Interface
Response Format
Output Parameter
Version: B 547
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
LST-BOARD::>
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
548 Version: B
7 Integrated Query Interface
-----------------------------------------------------------
ONUIP OLTID PONID ONUID BOARDID BOARDTYPE BSERVICE
PNUM SWVER HWVER
-- 10.250.18.100 -- -- NA-1-1 EC4B EPON 4
RP0121 WKE2.119.318R1A
-- 10.250.18.100 -- -- NA-1-2 EC4B EPON 4
RP0121 WKE2.119.318R2A
-- 10.250.18.100 -- --NA-1-3 EC4B EPON 4
RP0121 WKE2.119.318R2A
-- 10.250.18.100 -- -- NA-1-9 HSWA SCU 3
RP0121 WKE2.115.334R1A
-- 10.250.18.100 -- -- NA-1-18 PUBA Other 2
RP0107 WKE2.167.177R1A
-- 10.250.18.100 -- -- NA-1-19 HU1A Other 5
RP0103 WKE2.170.846R3A
-- 10.250.18.100 -- --NA-1-20 HU1A Other 5
RP0103 WKE2.170.846R3A
-- 10.250.18.100 -- -- NA-1-21 FAN Other 2
-- --
-- 10.250.18.100 -- -- NA-1-22 FAN Other 2
-- --
-- 10.250.18.100 -- -- NA-1-23 FAN Other 2
-- --
-----------------------------------------------------------
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 issued
LST-BOARD::>
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 ONUID BOARDID BOARDTYPE BSERVICE
PNUM SWVER HWVER
10.250.18.121 -- -- -- NA-1-1 VD24 VDSL 24
RP0105 WKE2.170.853R2A
10.250.18.121 -- -- -- NA-1-2 POTS64-20 POTS
64 RP0104 WKE2.170.815R2A
10.250.18.121 -- -- -- NA-1-3 AD32-20 ADSL 32
Version: B 549
FiberHome Element Management System Northbound Interface (TL1) User Manual
RP0106 WKE2.170.814R2C
10.250.18.121 -- -- -- NA-1-4 ETH ETH 16
RP0100 WKE2.170.813R2A
10.250.18.121 -- -- -- NA-1-5 MCU SCU 3
RP0106 WKE2.119.372R2A
10.250.18.121 -- -- -- NA-1-6 PWR Power 1
-- --
10.250.18.121 -- -- -- NA-1-7 FAN-1 Other 2
-- --
-----------------------------------------------------------
Related Command
LST-BRDINFO
Function Description
This command is used to query the ONU distance values in a batch manner.
Prerequisite
Command Format
LST-ONUDISTANCE::OLTID=olt-name:CTAG::;
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
550 Version: B
7 Integrated Query Interface
Output Parameter
Example
Example 1: Query the distance values of all ONUs connected to the OLT with the IP
address 10.250.18.100.
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
--------------------------------------------------------------
Version: B 551
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used to query the service port attributes such as the unique
identifier, mark, and description.
Command Format
LST-SERVCIEPORTDATTR:: > PONID=ponport_location[,>
Input Parameter
552 Version: B
7 Integrated Query Interface
Response Format
Output Parameter
Version: B 553
FiberHome Element Management System Northbound Interface (TL1) User Manual
DESCRIP-
OCTET STRING Size (128) Port description
TION
SUBSCRI-
OCTET STRING Size (128) Unique port identifier
BERNO
Example
Query the attributes of PON port 9 in slot 12 of the OLT whose IP address is
10.171.0.106.
u Command issued
LST-SERVCIEPORTDATTR::OLTID=10.171.0.106,PONID=NA-NA-12-9,
>
u Response message
Related Command
None
Function Description
This command is used to query the information about the EMS platform of the
vendor.
554 Version: B
7 Integrated Query Interface
Command Format
LST-EMS-INFO:::CTAG::;
Input Parameter
None
Response Format
Output Parameter
Example
u Command issued
LST-EMS-INFO:::CTAG::;
Version: B 555
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response message
Related Command
None
Function Description
This command is used to query the information about the POS resources between
the OLT PON port and the ONU.
Command Format
LST-POS::OLTID=olt-name[,PONID=ponport_location]:CTAG::;
Input Parameter
Response Format
556 Version: B
7 Integrated Query Interface
Output Parameter
1:2
1:4
1:8
1:16
RATION OCTET STRING Split ratio
1:32
1:64
1:128
1:256
Layer where the optical splitter
LAYER INTEGER -
is located
TOPPOSID OCTET STRING Size (128) Upper-layer POS identifier
TOPPO-
OCTET STRING Size (128) Upper-layer POS port
SPORT
Example
Query the POS resource information between the ONU and PON port 9 in slot 12 of
the OLT whose IP address is 10.171.0.106.
u Command issued
LST-POS::OLTID=10.171.0.106,PONID=NA-NA-12-9:CTAG::;
u Response message
FH_10.170.95.552019-10-0916:27:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=0
listofPosInfo:
-----------------------------------------------------------
NAMEPOSIDRATIONLAYERTOPPOSIDTOPPOSPORT
-----------------------------------------------------------
;
Version: B 557
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used to query the information about the topology connection
between the OLT PON port and the ONU.
Command Format
LST-TOPOLINK::OLTID=olt_name[,PONID=pon_location]:CTAG::;
Input Parameter
Response Format
Output Parameter
558 Version: B
7 Integrated Query Interface
Example
Query the topology connection information between the ONU and PON port 9 in slot
12 of the OLT whose IP address is 10.171.0.106.
u Command issued
LST-TOPOLINK::OLTID=10.171.0.106,PONID=NA-NA-12-9:CTAG::;
u Response message
FH_10.170.95.552019-10-0916:31:19
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=0
listofTopoInfo:
-----------------------------------------------------------
PONIDNAMEAPOINTZPOINT
-----------------------------------------------------------
;
Version: B 559
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used to query the configuration information of the PON protection
group on the OLT.
Command Format
LST-PSG::OLTID=olt_name:CTAG::[PSGID=group-id];
Input Parameter
Response Format
Output Parameter
Remark
Setting Working
Setting Dual-
Value PON Port Status of
Parameter Data Type Description PON Port Uplink
Range Protection PON Port
Protection Protec-
Group Protection
Group tion
Mode Group
560 Version: B
7 Integrated Query Interface
Remark
Setting Working
Setting Dual-
Value PON Port Status of
Parameter Data Type Description PON Port Uplink
Range Protection PON Port
Protection Protec-
Group Protection
Group tion
Mode Group
Version: B 561
FiberHome Element Management System Northbound Interface (TL1) User Manual
Remark
Setting Working
Setting Dual-
Value PON Port Status of
Parameter Data Type Description PON Port Uplink
Range Protection PON Port
Protection Protec-
Group Protection
Group tion
Mode Group
Standby
port (the
Information of the second slot
PROTECT- OCTET Standby
Size (128) protecting number - -
MEMBER STRING port
termination point and PON
port
number)
Example
Query the configuration of the PON port protection group of the OLT whose IP
address is 10.171.0.106.
Command issued
LST-PSG::OLTID=10.171.0.106:CTAG::;
Response message
562 Version: B
7 Integrated Query Interface
Related Command
None
The following introduces the command and example for querying service resources.
Function Description
This command is used for querying the media gateway information of a specified
device.
Command Format
LST-MG:: > >
Input Parameter
Version: B 563
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
564 Version: B
7 Integrated Query Interface
Example
u Command issued
LST-MG::OLTID=10.250.18.102,PONID=NA-NA-4-1, > >
u Response message
FH_10.250.18.133 2010-11-04 11:06:36
M CTAG COMPLD
total_blocks=1
block_number=1
Version: B 565
FiberHome Element Management System Northbound Interface (TL1) User Manual
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID MGID PT EID SIPREGDM
VLAN PRI IPMODE IPADDRESS IPMASK IPGATEWAY MGCIP1
MGCIP2
-- 10.250.18.102 NA-1-4-1 whdx04 0 H.248 a1
1515 255 -- 222.222.222.4 255.255.255.0 0.0.0.0
222.222.222.222
-----------------------------------------------------------
u Command issued
LST-MG::>
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 MGID PT EID SIPREGDM
VLAN PRI IPMODE IPADDRESS IPMASK IPGATEWAY MGCIP1
MGCIP2
10.250.18.121 -- -- -- 0 H.248 222.222.222.3
-- 1515 7 STATIC 222.222.222.3 255.255.255.0 0.0.0.0
222.222.222.222
-----------------------------------------------------------
Related Command
LST-MGCFG
LST-MGINFO
Function Description
This command is used for querying the voice port information of a specified device.
566 Version: B
7 Integrated Query Interface
Command Format
LST-POTS:: > >
Input Parameter
Version: B 567
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
568 Version: B
7 Integrated Query Interface
MG identifier, used
for uniquely
MGID INTEGER 0 to 16
identifying the MG
module on the ONU.
H248 user terminal
TID OCTET STRING Size (1 to 64)
identifier
SIP telephone
PN OCTET STRING Size (1 to 32)
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
FAXMODE String Fax mode
T38
NONE
CONTROLMODE String SS Control mode
AUTOVBD
Example
u Command issued
LST-POTS::OLTID=10.250.18.102,PONID=NA-NA-4-1, > >
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 TID PN
SIPUSERNAME SIPUSERPWD FAXMODE CONTROLMODE
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1
0 a1 a1 T30 AUTOVBD
Version: B 569
FiberHome Element Management System Northbound Interface (TL1) User Manual
--------------------------------------------------------
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::>
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 TID PN
SIPUSERNAME SIPUSERPWD FAXMODE CONTROLMODE
10.250.18.121 -- -- -- NA-NA-2-1 0
-- --
-----------------------------------------------------------
Related Command
LST-POTSINF
LST-POTSINFO
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:: > >
u Query the multicast service information of the ONU that has a management IP
address:
LST-IPTV::>
u Query the multicast service information of the ONU that has no management IP
address:
570 Version: B
7 Integrated Query Interface
LST-IPTV::(OLTID=olt-name,PONID=ponport_location, > >
Input Parameter
ONU_NAME, MAC,
ONUID- OCTET
Size (128) LOID and ONU_ Optional
TYPE STRING
NUMBER
ONU identifier, used for
uniquely identifying the
ONU connected to the
OCTET
ONUID Size (128) PON port. The value is Optional
STRING
ONU_NAME, MAC,
LOID or ONU_
NUMBER.
Locate a card port
Size (128) through rack - shelf -
OCTET Rack - shelf - slot - port number.
ONUPORT Optional
STRING slot - port Enter NA for the
number corresponding
unspecified information.
Response Format
It complies with the query command response format in Response Message Format.
Version: B 571
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
u Command issued
LST-IPTV::OLTID=10.250.18.102,PONID=NA-NA-4-1, > >
u Response message
572 Version: B
7 Integrated Query Interface
u Command issued
LST-IPTV::>
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 VPI VCI UV
FLMODE MAXGRP
10.250.18.121 -- -- -- NA-NA-4-1 569 -- --
-- -- --
-----------------------------------------------------------
Related Command
LST-IPTVCFG
Function Description
This command is used for querying the LAN port information of a specified OLT or
ONU.
Version: B 573
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
LST-LANPORT:: > >
u Query the LAN port information of an ONU that has a management IP address:
LST-LANPORT::>
Input Parameter
574 Version: B
7 Integrated Query Interface
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Version: B 575
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
Uplink rate limit
RateLimitUs INTEGER 0 to 1000000
Unit: Kbps
Example
u Command issued
LST-LANPORT::OLTID=10.250.18.102,PONID=NA-NA-4-1, > >
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 ONUID PORTID ADMINSTATUS DUPLEX SPEED
RateLimitUs RateLimitDs
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1 DOWN
Full 100M -- --
-----------------------------------------------------------
Example 2: Query the Ethernet port information of the ONU (having a management
IP address) whose IP address is 10.250.18.121.
576 Version: B
7 Integrated Query Interface
u Command issued
LST-LANPORT::>
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 ONUID PORTID ADMINSTATUS DUPLEX SPEED
RateLimitUs RateLimitDs
10.250.18.121 -- -- -- NA-NA-4-1 -- -- --
-- --
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the DSL port information of a specified device.
Command Format
LST-DSLPORT:: > LST-DSLPORT::OLTID=OLT_IP[,PONID=ponport_location]:CTAG::;
Input Parameter
Version: B 577
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
578 Version: B
7 Integrated Query Interface
0x0001:8A
0x0002:8B
0x0004:8C
0x0008:8D
STANDARD- 0x0010:12A
INTEGER -
PROFILE 0x0020:12B
0x0040:17A
0x0080:30A
0x0100:35B
0xFFFF
Uplink signal-to-noise ratio
USSNRMAR-
Floating point type -64.0, 63.0 margin (dB)
GIN
Accuracy: 0.1
USATTAINA-
INTEGER 0 to 512000 Attainable uplink rate
BLEBITRATE
DSATTAINA-
INTEGER 0 to 512000 Attainable downlink rate
BLEBITRATE
Version: B 579
FiberHome Element Management System Northbound Interface (TL1) User Manual
USNETDATA-
INTEGER 0 to 512000 Uplink payload rate
RATE
DSNETDATA-
INTEGER 0 to 512000 Downlink payload rate
RATE
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 issued
LST-DSLPORT::>
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 PONID ONUID ONUPORT ADMINSTATUS
10.250.18.121 -- -- -- NA-NA-3-2 --
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the port VLAN information of a specified ONU.
Command Format
LST-PORTVLAN:: > >
u Query the port VLAN information of the ONU that has a management IP
address:
580 Version: B
7 Integrated Query Interface
LST-PORTVLAN::>
u Query the port VLAN information of the ONU that has no management IP
address:
LST-PORTVLAN::(OLTID=olt-name,PONID=ponport_location,
>
Input Parameter
Version: B 581
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
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 port 1 of the OLT whose IP address is 10.250.18.102.
u Command issued
LST-PORTVLAN::OLTID=10.250.18.102,PONID=NA-NA-4-1, > >
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
-----------------------------------------------------------
ONUID ONUPORT SVLAN CVLAN VPI VCI
UV
whdx04 NA-NA-NA-1 -- 123 -- --
123
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1 --
582 Version: B
7 Integrated Query Interface
-- -- -- --
-----------------------------------------------------------
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 issued
LST-PORTVLAN::>
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
-----------------------------------------------------------
ONUID ONUPORT SVLAN CVLAN VPI VCI
UV
-- NA-NA-4-1 569 -- --
-- --
-----------------------------------------------------------
Related Command
None
Function Description
Command Format
LST-VLAN::>
Version: B 583
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
It complies with the query command response format in Response Message Format.
Output Parameter
Indicates whether it is a
MVLANFLAG INTEGER - multicast VLAN or non-multicast
VLAN.
MVLANPRI INTEGER 0 to 7 Priority of the IGMP message
HSI (Internet
access)
SERVICE OCTET STRING Service type of the VLAN
IPTV (unicast)
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
584 Version: B
7 Integrated Query Interface
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
-- 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 -- -- 1-1-19-1 0 0 HSI
-- 10.78.200.200 224 -- -- 1-1-19-1 0 0 IPTV
-- 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 0 0 HSI
-- 10.78.200.200 1111 -- -- 1-1-19-1 0 0 VOIP
-- 10.78.200.200 2006 -- -- 1-1-19-1 0 0 VOIP
-- 10.78.200.200 2008 -- -- 1-1-19-1 0 0 VOIP
-- 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 -- -- -- 0 0 --
-- 10.78.200.200 4001 -- -- 1-1-19-1 0 0 HSI
-- 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 HSI
-- 10.78.200.200 4011 -- -- 1-1-19-1 0 0 IPTV
-- 10.78.200.200 4012 -- -- -- 0 0 IPTV
-- 10.78.200.200 4013 -- -- -- 0 0 IPTV
-- 10.78.200.200 4014 -- -- -- 0 0 IPTV
Version: B 585
FiberHome Element Management System Northbound Interface (TL1) User Manual
;
---------
Related Command
None
Function Description
Command Format
LST-ONUSERVICESTATUS:: > PONID=ponport_location,>
Input Parameter
586 Version: B
7 Integrated Query Interface
Response Format
Output Parameter
Example
Query the port service information of the ONU (having no management IP address)
with ONUID being FHTT01e821a0. The ONU is connected to shelf 0 - slot 7 - PON
port 4 of the OLT whose IP address is 10.78.200.200.
u Command issued
LST-ONUSERVICESTATUS::OLTID=10.78.200.200,PONID=NA-NA-7-4,
>
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
Version: B 587
FiberHome Element Management System Northbound Interface (TL1) User Manual
-------------------------------------------------------
FHTT01e821a0 0 0
-------------------------------------------------------
Related Command
None
Function Description
Command Format
LST-SERVICEPORT::OLTID=olt-name:CTAG::[VLAN=cvlan,][SVLAN=svlan,]
[PORTTYPE=porttype];
Input Parameter
Value
Parameter Data Type Description Remark
Range
IP address or name
OLTID OCTET STRING Size (128) Required
of the OLT
CVLAN INTEGER 0 to 4095 Inner VLAN Optional
Port type
FXS: voice user port (Optional) The
PORTTYPE OCTET STRING Size (128)
LAN: data user port default value is FXS.
ALL: all user ports
Response Format
It complies with the query command response format in Response Message Format.
588 Version: B
7 Integrated Query Interface
Output Parameter
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
Version: B 589
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
Command Format
LST-PORTPVCFLOWPOLICY:: > >
Input Parameter
590 Version: B
7 Integrated Query Interface
Response Format
Output Parameter
Uplink rule
CIRUP OCTET STRING Size (128) Displays the name of the
bound rule template.
Downlink rule
CIRDOWN OCTET STRING Size (128) Displays the name of the
bound rule template.
Version: B 591
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command issued
LST-PORTPVCFLOWPOLICY::>
u Response message
Related Command
None
Function Description
Command Format
RTRV-TEMPLATE-ALL::>
592 Version: B
7 Integrated Query Interface
Input Parameter
Response Format
Output Parameter
TEMPLATE-
String Size (0 to 20) Template name
NAME
Maximum downlink rate
DOWNMAXBW Integer 32, 32736
Unit: Kbit/s
Maximum uplink rate
UPMAXBW Integer 32, 8160
Unit: Kbit/s
Line type
0: Non-AD card
1: no channel
CHANNELMODE Integer 0, 5 2: fast channel
3: interleave channel
4: fast or interleave channel
5: fast and interleave channel
Example
u Command issued
RTRV-TEMPLATE-ALL::>
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
Version: B 593
FiberHome Element Management System Northbound Interface (TL1) User Manual
-------------------------------------------
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
.....
-------------------------------------------
Related Command
None
Function Description
This command is used for querying the port template information of a specified
device.
Command Format
RTRV-TEMPLATE-PORT:: > PONID=ponport_location, > >
Input Parameter
594 Version: B
7 Integrated Query Interface
Response Format
Output Parameter
Maximum downlink
DOWNMAXBW OCTET STRING Size (128)
bandwidth template
Version: B 595
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Command issued
RTRV-TEMPLATE-PORT::>
Response message
-------------------------------------------
TEMPLATENAME DOWNMAXBW UPMAXBW CHANNELMODE
P_03584_1024 3584 1024 0
-------------------------------------------
Related Command
ADD-FLOWPOLICY
LST-POTSINFO
Function Description
This command is used to query the rate control configuration for the Layer 3 service
bound to the ONU.
Command Format
LST-LT-BWPROFILE::OLTID=olt_name,PONID=ponport_location,
>
596 Version: B
7 Integrated Query Interface
Input Parameter
Response Format
Output Parameter
Version: B 597
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query the L3 service rate limiting configuration bound with PON port 1 in slot 7 of
the OLT whose IP address is 10.190.40.120.
u Command issued
LST-LT-BWPROFILE::OLTID=10.190.40.120,PONID=NA-NA-7-1, > >
u Response message
Related Command
None
The following introduces the command and example for resource change
notification.
598 Version: B
7 Integrated Query Interface
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.
Command Format
SUBSCRIBE:::CTAG::FLAG=flag;
Input Parameter
Response 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
Version: B 599
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
UNSUBSCRIBE
Function Description
Command Format
UNSUBSCRIBE:::CTAG::FLAG=flag;
Input Parameter
RES indicates
registering the
FLAG OCTET STRING RES
reporting of resource
change notification.
Response Format
Output Parameter
None
Example
u Command issued
UNSUBSCRIBE:::CTAG::FLAG=RES;
u Response message
FH_10.250.18.133 2010-11-04 11:44:11
600 Version: B
7 Integrated Query Interface
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
SUBSCRIBE
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
Response Format
Output Parameter
Version: B 601
FiberHome Element Management System Northbound Interface (TL1) User Manual
OLT
ONU
OBJECT OCTET STRING Resource object type
SHELF
BOARD
Resource change information.
See the Resource Change
INFO OCTET STRING Size (512)
Notification for the format of
returned information.
Example
u Command issued
LST-RESNOTIFY:::2::BEGINTIME=2010-12-30 07-34-00,ENDTIME=2010-12-30 10-
00-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 INFO
2010-11-01 11:15:18 ADD BOARD > OLTID=0.0.0.0 PONID=-- BOARDID=2-1-4
BOARDTYPE=ETH BSERVICE=ETH PNUM=16 SWVER=-- HWVER=--
2010-11-01 11:15:34 ADD BOARD > OLTID=0.0.0.0 PONID=-- BOARDID=2-1-801
BOARDTYPE=HCU-20 BSERVICE=-- PNUM=0 SWVER=-- HWVER=--
2010-11-01 11:22:36 ADD ONU OLTID=10.250.18.102
PONID=3-1-4-1 NAME=AN5006-10B DESC=-- > IP=0.0.0.0 AUTH=LOID MAC=544b10406b60 LOID=whdx10b
PWD=-- SWVER=--
2010-11-01 11:22:36 ADD ONU OLTID=10.250.18.102
PONID=3-1-4-1 NAME=AN5006-04 DESC=-- > IP=0.0.0.0 AUTH=LOID MAC=544b400c79a8 LOID=whdx04
PWD=-- SWVER=--
-----------------------------------------------------------
602 Version: B
7 Integrated Query Interface
Related Command
SUBSCRIBE
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
Output Parameter
Version: B 603
FiberHome Element Management System Northbound Interface (TL1) User Manual
604 Version: B
7 Integrated Query Interface
Power
ETH
ADSL
VDSL
POTS
BSERVICE OCTET STRING E1 Card service type
GPON
EPON
Control (main control
unit)
Other
PNUM INTEGER 0 to 64 Number of ports
Version: B 605
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 NAME=PON[1]-AN5506-04B[6]
DESC=-- IP=0.0.0.0 AUTH=HYBRID MAC=-- LOID=123
PWD=-- 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
FH_10.98.11.77 2011-02-21 10:32:07
A 3 REPT RES ADD_SHELF
OLTID=10.78.11.102 PONID=- SHELFID=9-1
SHELFTYPE=AN5116-06B_NODE
606 Version: B
7 Integrated Query Interface
u Command issued
None
u Response message
FH_10.98.11.77 2011-02-21 10:27:17
A 1 REPT RES ADD_BOARD
OLTID=10.78.11.102 PONID=-- BOARDID=
7-1-9 BOARDTYPE=HSWA BSERVICE=SCU PNUM=0 SWVER=-- HWVER=--
Related Command
SUBSCRIBE
The following introduces the command and example for full export of resource data.
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];
Version: B 607
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Value
Parameter Data Type Description Remark
Range
Resource type
PHY: device information
PHY Optional
SRV: service
RESTYPE OCTET STRING SRV Default value:
configurations
ALL ALL
ALL: all device and service
configurations
Response Format
Output Parameter
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
-----------------------------------------------------------
608 Version: B
7 Integrated Query Interface
Related Command
SUBSCRIBE
DUMP-RESOURCEINFO
Function Description
It indicates the message notifying the export result of the reported data files.
Command Format
None
Input Parameter
None
Response Format
Output Parameter
Example
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
Version: B 609
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
DUMPRE-RESNOTIFY
610 Version: B
8 Integrated Alarm Interface
This chapter introduces the commands related with the subscribed alarms, alarm
filtering, alarm query, alarm confirmation, alarm clearing, alarm synchronization and
performance data collection.
Version: B 611
FiberHome Element Management System Northbound Interface (TL1) User Manual
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.
Command Format
SUBSCRIBE:::CTAG::;
Input Parameter
None
Response Format
Output Parameter
None
Example
u Command issued
SUBSCRIBE:::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
None
612 Version: B
8 Integrated Alarm Interface
Note:
Command Format
ACT-ALARM-FILTER:::CTAG::;
Input Parameter
None
Response Format
Output Parameter
Success or failure.
Example
u Command issued
ACT-ALARM-FILTER:::CTAG::;
u Response message
FH_10.250.18.133 2010-11-04 10:31:47
M CTAG COMPLD
Version: B 613
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
DACT-ALARM-FILTER
Command Format
DACT-ALARM-FILTER:::CTAG::;
Input Parameter
None
Response Format
Output Parameter
None
Example
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 ENDESC=No error
614 Version: B
8 Integrated Alarm Interface
Related Command
ACT-ALARM-FILTER
This command is used for modifying the alarm filter conditions and configure the
alarms to be reported.
Note:
Command Format
CHG-ALARM-FILTER:::CTAG::[ALARMID=alarmcode][,SEVERITY=alarm-severity];
Input Parameter
Version: B 615
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
Success or failure.
Example
Modify the alarm filter conditions to only query and subscribe to the alarm whose ID
is 310009.
u Command issued
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
This command is used for viewing the current alarm filter conditions.
Command Format
LST-ALARM-FILTER:::CTAG::;
Input Parameter
None
616 Version: B
8 Integrated Alarm Interface
Response Format
Output Parameter
True
ENABLE String Enable/Disable
false
communicationsAlarm
processingErrorAlarm
ALARMTYPE OCTET STRING qualityOfServiceAlarm Alarm type
equipmentAlarm
environmentalAlarm
Alarm level. Multiple
Critical
alarm levels can be
Major
SEVERITY String configured and should
Minor
be separated by vertical
Warning
bars.
Alarm ID. Multiple alarm
IDs can be configured
ALARMCODE String Size (0 to 1000)
and should be separated
by vertical bars.
Example
u Command issued
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 ALARMCODE
false - 310009
Version: B 617
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
CHG-ALARM-FILTER
This command is used for querying the alarm information in the specified time of
period (including the recovered or unrecovered alarms).
Command Format
LST-ALARM::[ > > ENDTIME=end-time][,FAULTFLAG=flag];
u Querying ONUs
u Query all:
LST-ALARM:::CTAG::BEGINTIME=begin-time[,ENDTIME=end-time][,
FAULTFLAG=flag];
618 Version: B
8 Integrated Alarm Interface
Input Parameter
Version: B 619
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
620 Version: B
8 Integrated Alarm Interface
Critical
Major
SEVERITY String Alarm level
Minor
Warning
Fault
FaultFlag String Recovery Alarm status
Event
Alarm generation time. Format:
HAPPENTIME String Size (0 to 32)
YYYY-MM-DD HH:MM:SS.
RECOVER- Alarm recovery time. Format:
String Size (0 to 32)
TIME YYYY-MM-DD HH:MM:SS.
communicationsAlarm
qualityOfServiceAlarm
ALARMTYPE String processingErrorAlarm Alarm type
equipmentAlarm
environmentalAlarm
SA_UNKNOWN
SA_SERVICE_
SERVICEAF- OCTET Whether the alarm influences the
AFFECTING
FECT STRING service or not
SA_NON_SERVICE_
AFFECTING
Additional information, describing
AditionalInfo String Size (0 to 256) additional information related to
the alarm.
Alarm code, corresponding to the
ALARMID Integer - alarm name parameter
(ALARMDESC).
PROBABLE_
CAUSE String Size (0 to 256) Alarm cause
_DESC
probable- OCTET
- Possible cause of the alarm
Cause STRING
PROBABEL_
CAUSE_ Integer - Alarm cause code
CODE
PROPOSED_
String Size (0 to 512) Processing suggestion
ADVISE
TOPOLOC - - Logical domain
Version: B 621
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Query all the alarms and events occurred after 2010-12-28 00:00:00 (only part of
the response messages are listed here for reference).
u Command issued
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
-
SERIALID ALARMNAME DIP DNAME DTYPE POSITION
SEVERITY FaultFlag HAPPENTIME RECOVERTIME
ALARMTYPE ADITIONALINFO EVENT_CODE
PROBABLE_CAUSE_DESC
135 ONU H.248 disconnection 10.250.18.100 system 1 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 disconnection
6 OLT PON port LOS 10.250.18.100 AN5006-04[1] system 1
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)trunk optical fiber
disconnection
Related Command
CHG-ALARM-FILTER
ACT-ALARM-FILTER
622 Version: B
8 Integrated Alarm Interface
Command Format
ACK-ALARM::SERIALID=SERIAL-ID:CTAG::;
Input Parameter
Response Format
Output Parameter
Success or failure.
Example
u Command issued
ACK-ALARM::SERIALID=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
Version: B 623
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
UNACK-ALARM::SERIALID=SERIAL-ID:CTAG::;
Input Parameter
Response Format
Output Parameter
Success or failure.
Example
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
624 Version: B
8 Integrated Alarm Interface
Related Command
ACK-ALARM
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
Input Parameter
Response Format
Output Parameter
Success or failure.
Example
u Command issued
CLR-ALARM::SERIALID=107:CTAG::;
Version: B 625
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
This command is used to synchronize the historical alarms with the EMS.
Note:
The EMS generates the CSV file via the FTP file interface. To enhance
the interface data transmission efficiency, the files are compressed in the
zip or gzip format. The compressed files are not further divided into
volumes. The name of the compressed file comprises the original file
name plus the suffix name of the compressed file. Please refer to for
detailed information.
Example:
626 Version: B
8 Integrated Alarm Interface
Compressed File
File Type Original File Name Packaged File Name
Name
CMCC-PON-FM-V1.0. CMCC-PON-FM-V1.0. CMCC-PON-FM-V1.0.
Historical alarm 0-20140411-1602-P00. 0-20140411-1602.csv. 0-20140411-1602.csv.
csv tar/zip tar/zip.gz
Command Format
SYNC-HISALARM::[ > time[,ENDTIME=end-time][,EXCLUDEALARMID=exclude-alarm-id][,
EXCULDESEVERITY=exclude-severity];
Input Parameter
Response Format
Version: B 627
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
RACK:rackid
The position that triggers the
SHELF: shelfid
alarm.
SLOT: slotid
RACK: rack
PORT: portid
SHELF: shelf
ONUNUM:
SLOT: slot
onunumber
PORT: port number
ONUNAME:
ONUNUM: ONU number
onuname
POSITION OCTET STRING ONUNAME: ONU name
ONUPORTTYPE:
ONUPORTTYPE: ONU port type
onuporttype
(LAN, E1, DSL, POTS and PON)
ONUPORT:
ONUPORT: ONU port number
onuportid
EMUNUM: environment
EMUNUM:
monitoring unit
emunum
AUTHINFO: ONU authentication
AUTHINFO:
information (MAC or LOID)
authinfo
Alarm level. Multiple alarm levels
can be configured, separated by
Critical
vertical bars between them.
Major
SEVERITY OCTET STRING Critical
Minor
Major
Warning
Minor
Warning
Alarm status
Fault
Fault
FaultFlag OCTET STRING Recovery
Recovery
Event
Event
Alarm generation time. Format:
HAPPENTIME OCTET STRING Size (32)
YYYY-MM-DD HH:MM:SS.
RECOVER- Alarm recovery time. Format:
OCTET STRING Size (32)
TIME YYYY-MM-DD HH:MM:SS.
628 Version: B
8 Integrated Alarm Interface
Alarm Type
communicationsAlarm:
communication quality alarm
processingErrorAlarm: processing
error alarm, i.e., alarm for
communicationsA-
software processing error or
larm
exception
qualityOfServiceA-
qualityOfServiceAlarm: service
larm
quality alarm, i.e., alarm for
ALARMTYPE OCTET STRING processingErrorA-
service status and network
larm
service quality
equipmentAlarm
equipmentAlarm: device alarm, i.
environmentalA-
e., alarm for NE hardware failure
larm
environmentalAlarm: environment
alarm, i.e., alarm for the power
system and equipment room
environment (e.g. temperature,
humidity and access control)
SA_UNKNOWN
SA_SERVICE_
SERVICEAF- AFFECTING, Whether the alarm influences the
OCTET STRING
FECT SA_NON_ service or not
SERVICE_
AFFECTING
Additional information, describing
AditionalInfo OCTET STRING Size (256) additional information related to
the alarm.
Alarm code, corresponding to the
ALARMID INTEGER - alarm name parameter
(ALARMDESC).
PROBABLE_
CAUSE OCTET STRING Size (256) Alarm cause
_DESC
Version: B 629
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Related Command
None
The EMS automatically generates performance data files every 15 minutes and
saves them to the specified directory of the FTP / SFTP server. The NMS collects
the performance data files in the aforesaid directory at regular intervals.
Note:
Example:
Compressed File
File Type Original File Name Packaged File Name
Name
CMCC-PON-PM-
OLTPON-V1.0.0-
CMCC-PON-PM- CMCC-PON-PM-
20140411-1615-P00.
Performance OLTPON -V1.0.0- OLTPON -V1.0.0-
csv
History 20140411-1615.csv. 20140411-1615.csv.
CMCC-PON-PM-MIX-
tar/zip tar/zip.gz
V1.0.0-20140411-
1615-P00.csv
630 Version: B
8 Integrated Alarm Interface
1 OLT NE
2 SHELF Shelf
3 CARD Card
4 ONU Optical network unit
6 TL Topology connection
7 PG Protection group
Memory usage
Card
CPU usage
Tx optical power
Rx optical power
Bias current
Temperature
Voltage
Version: B 631
FiberHome Element Management System Northbound Interface (TL1) User Manual
Mean jitter
632 Version: B
8 Integrated Alarm Interface
Related Command
None
Version: B 633
9 Common Error Codes
634 Version: B
10 The List of Parameters
u Impedance parameter
Parameter
Data Type Value Description
Name
1 200+680|| 100nf: Bureau machine in China ()
Impedance INTEGER 2 200+560|| 100nf: User machine in China
3 600-ohm
Parameter
Data Type Value Description
Name
0 Normal
11 Abnormal AC voltage.
12 Abnormal DC voltage.
17 Abnormal impedance.
Conclusion INTEGER 21 Bad line insulation.
Line breakage (including intra-office and extra-
22
office line breakage).
25 Line interfere.
26 Electricity leakage.
Parameter
Data Type Value Description
Name
1 Successful
Conclusion INTEGER
2 Failed.
Version: B 635
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Description
Name
The call connection is established, but the testing
3 personnel has not confirmed the call connection
status.
Parameter
Data Type Value Description
Name
1 No signaling interaction.
3 MG internal reason.
4 Others.
Parameter
Data Type Value Description
Name
1 The SS off-hook response signaling is not received.
8 Others.
Parameter
Data Type Value Description
Name
1 Regional Std. (ANSI T1.413)
636 Version: B
10 The List of Parameters
Parameter
Data Type Value Description
Name
7 G.992.1 TCM-ISDN non-overlapped
Version: B 637
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Description
Name
38 G.992.5 Annex J All-Digital non-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
638 Version: B
11 The List of Alarms
Equipment ILEGAL_ONU_
Major alarm 110004 An invalid ONU tries to register.
alarm REGISTE
Equipment OLT-REMOTE-ONU- The OLT failed to send the
Major alarm 110005
alarm CONFIG-FAILURE configuration to the ONU.
Version: B 639
FiberHome Element Management System Northbound Interface (TL1) User Manual
640 Version: B
11 The List of Alarms
Version: B 641
FiberHome Element Management System Northbound Interface (TL1) User Manual
ONU-OPTICAL-
The ONU optical channel
QoS alarm Warning alarm 410003 SIGNALDEGRADA-
generates errors.
TION
The number of CRC errors
ETH_CRC_ERROR_
QoS alarm Major alarm 410004 occurred on the OLT Ethernet port
OVER_LIMIT
exceeds the threshold.
Equipment
Major alarm 120002 ETH_PORT_LOOP A loop is detected on the user port.
alarm
Equipment A DoS attack is detected on the
Major alarm 120003 DoS_ATTACK
alarm user port.
Communication ONU_H248_
Critical alarm 320001 The ONU H.248 link fails.
alarm BREAKOUT
Communication ONU_MGCP_
Critical alarm 320002 The ONU MGCP link fails.
alarm BREAKOUT
642 Version: B
11 The List of Alarms
Version: B 643
FiberHome Element Management System Northbound Interface (TL1) User Manual
644 Version: B
12 Abbreviations
IPTV IP Television
OAM Operation, Administration & Maintenance
Version: B 645
Product Documentation Customer Satisfaction Survey
Thank you for reading and using the product documentation provided by FiberHome. Please take a moment to
complete this survey. Your answers will help us to improve the documentation and better suit your needs. Your
responses will be confidential and given serious consideration. The personal information requested is used for
no other purposes than to respond to your feedback.
Name
Phone Number
Email Address
Company
To help us better understand your needs, please focus your answers on a single documentation or a complete
documentation set.
Documentation Name
Code and Version
12. Additional comments about our documentation or suggestions on how we can improve:
Thank you for your assistance. Please fax or send the completed survey to us at the contact information
included in the documentation. If you have any questions or concerns about this survey please email at
edit@fiberhome.com