Unm PDF
Unm PDF
Unm PDF
System
User Manual
Version: C
Code: MN000000542
February 2017
Thank you for choosing our products.
Related Documentation
Document Description
I
Document Description
II
Version
Version Description
A Initial version.
B Updates some command descriptions.
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..............................................................................................364
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: C 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: C
1 TL1 Northbound Interface Overview
Version: C 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: C
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: C 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:
Maximum concurrent
32
TCP connections
u Each connection supports the service provisioning and service
Service provisioning deletion work orders for more than 2 users.
interface u Each connection supports work order suspending, resuming
and modifying for more than 4 users.
u The result will be returned within 1 minute for the inner line test,
outer line test, SELT, DELT and incoming / outgoing emulation
Integrated testing
tests.
interface
u The result will be returned within 5 seconds for a query
command.
6 Version: C
1 TL1 Northbound Interface Overview
Version: C 7
2 TL1 Northbound Interface
Installation
The following introduces how to install and run the TL1 northbound interface on
Windows operating system.
8 Version: C
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: C 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: C
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
Description
Symbol
Encapsulates an English letter. For example, “a” indicates the English letter
""
a instead of a variable identifier.
Version: C 11
FiberHome Element Management System Northbound Interface (TL1) User Manual
Annotation
Description
Symbol
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: C
3 Command Format
Parameter Description
Parameter
Description
Name
Command code, indicating the operation to be performed. The format is as
follows:
<verb>[-<modifier>[-<modifier>]]
command_
u verb: required parameter, identifying the name of the command.
code
Commonly it is a simple verb or an abbreviation describing an action.
u modifier: command modifier. verb can be followed by two optional
modifiers, separated from each other by -.
acknowledgment_code ctag<
acknowledgment_code:
IP:In Progress
NA:No acknowledgment
RL:Repeat Later system busy
Version: C 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>(;|>)
14 Version: C
3 Command Format
Message header, the public part of all response message 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. Value range is FH_IP.
The following introduces the resource change notification format and parameters of
the TL1 northbound interface.
Version: C 15
FiberHome Element Management System Northbound Interface (TL1) User Manual
<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>(;|>)
Message header, the public part of all response message and automatic reported messages,
including equipment ID (sid), date and time.
sid: manufacturer name abbreviation_network management server IP. The value is as follows:
header
u HW_IP
u ZTE_IP
u FH_IP
16 Version: C
3 Command Format
The error codes returned by the TL1 northbound interface are as shown in
Table 3-2.
Version: C 17
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.
18 Version: C
4 Session Control
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
Version: C 19
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
20 Version: C
4 Session Control
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
Version: C 21
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
22 Version: C
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
Version: C 23
FiberHome Element Management System Northbound Interface (TL1) User Manual
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). Upon
initial service installation, you can send this command to the PON port that has not
been fully configured after configuring the OLT.
Command Format
ADD-ONU::OLTID=olt-name,PONID=ponport_location:CTAG::[AUTHTYPE=auth-
type],ONUID=onu-index[,PWD=onu password][,ONUNO=onu-no][,NAME=name][,
DESC=onu description],ONUTYPE=onu type;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OLTID OCTET STRING Size (128) OLT IP address, name or ID.
24 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description
Name
Authentication information. If
AUTHTYPE is set to MAC,
ONUID OCTET STRING Size (64) ONUID is MAC address. If
AUTHTYPE is set to LOID,
ONUID is LOID.
PWD OCTET STRING Size (128) LOID PASSWORD
ONUNO INTEGER 1 - 512 ONU authorization code
NAME OCTET STRING Size (128) ONU name
ONU description. When the
FiberHome EMS description
DESC OCTET STRING Size (64) and equipment description are
required to be consistent, this
parameter cannot be Chinese.
Response Format
Output Parameter
None
Example
Example 1, add an ONU for the slot 1 - PON 2 port of the OLT whose IP address is
10.78.11.102. The information of the ONU is as follows: ONUID is Test00002; PWD
is Password2; ONU authorization code is 10; description is Test_ONU2; ONU
authentication mode is LOID.
u Command
ADD-ONU::OLTID=10.78.11.102,PONID=NA-NA-1-2:CTAG::AUTHTYPE=LOID,
ONUID=Test00002,PWD=Password2,ONUNO=10,NAME=Test2,DESC=Test_ONU2,
ONUTYPE=AN5006-04;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
Version: C 25
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example 2, add an ONU for the slot 15 - PON 2 port of the OLT whose IP address is
10.78.11.102. The information of the ONU is as follows: MAC address is 54-4B-40-
04-2C-1F; ONU authentication mode is MAC.
u Command
ADD-ONU::OLTID=10.78.11.102,PONID=NA-NA-15-2:CTAG::AUTHTYPE=MAC,
ONUID=54-4B-40-04-2C-1F,ONUNO=11,NAME=Test3,DESC=Test_ONU3,
ONUTYPE=AN5006-04;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-ONU
Function Description
This command is used for modifying the ONU authentication mode and
authentication ID information when replacing the ONU.
Command Format
CFG-ONU::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-type,
ONUID=onu-index:CTAG::AUTHTYPE=auth-type[,AUTHINFO=onu-index];
Supported Equipment
26 Version: C
5 Service Commissioning Interface
Input Parameter
Parameter
Data Type Value Range Description
Name
OLTID OCTET STRING Size (128) OLT IP address, name or ID.
PON port information
location. Locate through the
Size (128)
approach of cabinet rack -
Cabinet rack - shelf -
PONID OCTET STRING shelf - slot - PON port
slot - PON port
number. Enter NA if the
number
corresponding information is
not specified.
Response Format
Version: C 27
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
Example
For example, configure the ONU connected to the slot 3 - PON 1 port of the OLT
whose OLTID is 10.250.18.100. The information of the ONU is as follows: ONUID is
Test0001; authentication mode is LOID; LOID is test0002.
u Command
CFG-ONU::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001:CTAG::AUTHTYPE=LOID,AUTHINFO= test0002;
u Response Message
FH_10.78.20.120 2011-02-21 13:51:24
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-ONU
DEL-ONU
Function Description
This command is used for configuring the uplink and downlink bandwidth 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 bandwidth.
Command Format
CFG-ONUBW::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]:CTAG::UPBW=onu-up-bandwidth[,
DOWNBW=onu-down-bandwidth];
28 Version: C
5 Service Commissioning Interface
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
IP address, name or ID of the ONU
ONUIP OCTET STRING Size (128)
that has a management IP address.
Response Format
Output Parameter
None
Version: C 29
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
For example, configure the uplink bandwidth template BW_UP and the downlink
bandwidth template BW_DOWN for the ONU (ONUID being Test0001) connected to
the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
CFG-ONUBW::OLTID=10.71.227.56,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001:CTAG::UPBW=BW_UP,DOWNBW=BW_DOWN;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-ONU
DEL-ONU
Note:
Deleting an ONU will simultaneously delete the services that the ONU
bears. To re-activate the services on the ONU, add and configure the
services again.
Function Description
This command is used for deleting the ONU authorized by the OLT.
Command Format
DEL-ONU::OLTID=olt-name,PONID=ponport_location:CTAG::ONUIDTYPE=onuid-
type,ONUID=onu-index;
30 Version: C
5 Service Commissioning Interface
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OLT IP address, name or
OLTID OCTET STRING Size (128)
ID.
PON port information
location. Locate through the
Size (128)
approach of cabinet rack -
Cabinet rack - shelf -
PONID OCTET STRING shelf - slot - PON port
slot - PON port
number. Enter NA if the
number
corresponding information is
not specified.
MAC
LOID ONU identifier type (NAME,
ONUIDTYPE OCTET STRING
ONU_Number MAC, LOID, ONU_Number).
ONU_NAME
Response Format
Output Parameter
None
Version: C 31
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
For example, delete an ONU from the slot 3 - PON 1 port of the OLT whose IP
address is 10.250.18.100. The information of the ONU is as follows: ONUID is
Test0001; authentication mode is LOID.
u Command
DEL-ONU::OLTID=10.250.18.100,PONID=NA-NA-3-1:CTAG::ONUIDTYPE=LOID,
ONUID=Test0001;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
For example, delete the ONU from the slot 15 - PON 2 port of the OLT whose IP
address is 10.250.18.100. The information of the ONU is as follows: MAC address
is 54-4B-40-04-2C-1F; authentication mode is MAC.
u Command
DEL-ONU::OLTID=10.250.18.100,PONID=NA-NA-15-2:CTAG::ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1F
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-ONU
Function Description
This command is used for configuring the limit of MAC addresses for a LAN port of
the ONU.
32 Version: C
5 Service Commissioning Interface
Command Format
CFG-LANPORTMACLIMIT::OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
COUNT=count_num;
Supported Equipment
Input Parameter
MAC
LOID
The ONU that has
ONUID- OCTET ONU_ ONU identifier type (NAME,
no management IP
TYPE STRING Number MAC, LOID, ONU_Number).
address. Required.
ONU_
NAME
ONU identifier, used for
uniquely identifying the ONU
The ONU that has
OCTET connected to the PON port.
ONUID Size (128) no management IP
STRING The value is ONU_NAME,
address. Required.
MAC, LOID or ONU_
NUMBER.
Version: C 33
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Related Command
None
Function Description
This command is used for configuring the Wi-Fi service for the ONU authorized by
OLT. It is allowed to add SSIP and configure it with different keys.
Command Format
CFG-WIFISERVICE::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]:CTAG::WILESS-AREA=area,WILESS-
CHANNEL=channel,WILESS-STANDARD=standard,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][,
RADIUS-SERVER=server,RADIUS-PORT=port,RADIUS-KEY=key][,WEP-
ENCRYPTIONLEVEL=level,WEP-KEYINDEX=index,WEPKEY1=key1,WEPKEY2=key2,
WEPKEY3=key3,WEPKEY4=key4];
34 Version: C
5 Service Commissioning Interface
Supported Equipment
u ONU: AN5506-04-F1.
Input Parameter
Parameter
Data Type Value Range Description
Name
OLTID OCTET STRING Size (128) OLT IP address, name or ID.
PON port information location. Locate
Size (128) through the approach of cabinet rack -
PONID OCTET STRING Cabinet rack - shelf - slot - PON shelf - slot - PON port number. Enter NA
port number if the corresponding information is not
specified.
MAC
LOID ONU identifier type (NAME, MAC, LOID,
ONUIDTYPE OCTET STRING
ONU_Number ONU_Number).
ONU_NAME
0 - Europe
WILESS-AREA INTEGER Wireless area
1 - USA
If wireless area is set to 0, the
value range of this parameter is
WILESS-
INTEGER [0, 13]; if wireless area is set to Wireless channel number
CHANNEL
1, the value range of this
parameter is [0, 11].
Version: C 35
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
OPEN SHARED WEPAUTO
WPAPSK WPA WPA2PSK
AUTH-MODE OCTET STRING WLAN authentication mode
WPA2 WPA/WPA2 WPAPSK
WPA2PSK
NONE, WEP, TKIP, AES,
ENCRYP-TYPE OCTET STRING WLAN encryption type
TKIPAES
PRESHARED-
OCTET STRING STRING (64) WPA pre-shared key
KEY
UPDATEKEY- WPA key update interval
INTEGER [0, 4194303]
INTERVAL Unit: second
RADIUS-
OCTET STRING Size (128) RADIUS server
SERVER
RADIUS-PORT OCTET STRING STRING (2) RADIUS server port
Response Format
Output Parameter
None
Example
For example, configure the WEP encryption mode for the ONU connected to the slot
3 - PON 1 port of the OLT whose IP address is 10.250.18.100. The information of
the ONU is as follows: ONUID is 999999999997; authentication mode is physical ID.
36 Version: C
5 Service Commissioning Interface
u Command
CFG-WIFISERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=999999999997:CTAG::WILESS-AREA=1,WILESS-CHANNEL=0,WILESS-
STANDARD=802.11b,T-POWER=1,SSID=1,SSID-ENABLE=1,SSID-NAME=fiberhome,
SSID-VISIBALE=0,AUTH-MODE=WEPAUTO,ENCRYP-TYPE=WEP,WEP-
ENCRYPTIONLEVEL=1,WEP-KEYINDEX=1,WEPKEY1=12345,WEPKEY3=34567;
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 modifying the Wi-Fi service for the ONU authorized by the
OLT. It is allowed to add SSIP and configure it with different keys.
Command Format
MODIFY-WIFISERVICE::OLTID=olt-ip,PONID=pon-id,ONUIDTYPE=onuidtype,
ONUID=onuid:CTAG::Enable=xxx,WILESS-AREA=xxx,WILESS-CHANNEL=xxx,T-
POWER=xxx,SSID=xxx,SSID-ENABLE=xxx,SSID-NAME=xxx,SSID-VISIBALE=xxx,
AUTH-MODE=xxx,ENCRYP-TYPE=xxx,PRESHARED-KEY=xxx,IgdWlanStandard=xxx,
WorkingFrequency=xxx,FrequencyBandwidth=xxx;
Supported Equipment
u ONU: AN5506-04-F1.
Version: C 37
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
MAC
ONU identifier type (NAME, The ONU that has no
ONUID- OCTET LOID
MAC, LOID, ONU_ management IP address.
TYPE STRING ONU_Number
Number). Required.
ONU_NAME
OCTET u enable
Enabled Enable or disable Optional
STRING u disable
WILESS-
INTEGER Wireless area 0 to 13 Optional
AREA
WILESS- Wireless channel
INTEGER 0 to 13 Optional
CHANNEL number
20, 40, 60, 80, 100, 120,
T-POWER INTEGER Wi-Fi power control Optional
140, 160, 180, 200
If other SSID parameters
need to be configured, you
SSID INTEGER SSID index SSID index need to configure the index
first, which is used to locate
the SSID item.
SSID- 0: disable
INTEGER 0 and 1 Optional
ENABLE 1: enable
SSID- OCTET
Size (32) SSID name Optional
NAME STRING
38 Version: C
5 Service Commissioning Interface
Response Format
Example
For example: Modify the band bandwidth of the ONU with ID FHTT09378c68 on the
PON port 1 in slot 4 on the OLT device with IP 10.190.42.3.
u Command
MODIFY-WIFISERVICE::OLTID=10.171.0.22,PONID=NA-NA-7-1,ONUIDTYPE=MAC,
ONUID=FHTT01E84310:CTAG::Enable=enable,WILESS-AREA=2,WILESS-CHANNEL=2,
T-POWER=140,SSID=1,SSID-ENABLE=0,SSID-NAME=brisa-81808,SSID-VISIBALE=1,
AUTH-MODE=WPAPSK,ENCRYP-TYPE=TKIP,PRESHARED-KEY=naotemsenha1234,
IgdWlanStandard=802.11g,WorkingFrequency=2.4Ghz,FrequencyBandwidth=20/
40MHZ;
Version: C 39
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response Message
FH_10.170.163.112 2017-02-19 16:08:07
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
CFG-WIFISERVICE
Function Description
This command is used for configuring WAN connections for the ONU authorized by
OLT.
Command Format
SET-WANSERVICE::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]:CTAG::STATUS=status,MODE=mode,
CONNTYPE=connecttype[,VLAN=vlan][,COS=cos][,QOS=qos][,NAT=nat[,
IPMODE=ipmode][,WANIP=wanip,WANMASK=mask,WANGATEWAY=gateway,
MASTERDNS=maskdns,SLAVEDNS=slavedns][[,PPPOEPROXY=proxy],
PPPOEUSER=pppoeusername,PPPOEPASSWD=pppoepassword,PPPOENAME=pppoename[,
PPPOEMODE=pppoemode]]],[UPORT=uport,SSID=ssidno,WANSVC=1];
Supported Equipment
Input Parameter
40 Version: C
5 Service Commissioning Interface
MAC
LOID ONU identifier type (NAME, MAC, LOID, ONU_
ONUIDTYPE OCTET STRING
ONU_Number Number).
ONU_NAME
1 - add
STATUS INTEGER 1: adding; 2: deleting.
2 - delete
WAN connection mode: 1-TR069, 2-INTERNET, 3-
TR069 INTERNET, 4-Other.
MODE INTEGER 1 to 4
In bridge connection type, the WAN connection
mode can only be set to 2-INTERNET or 4-Other.
Version: C 41
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1, configure the TR069 WAN connection for the ONU connected to the slot
3 - PON 1 port of the OLT whose IP address is 10.250.18.100. The information of
the ONU is as follows: ONUID is 999999999997; authentication mode is physical ID.
Command
42 Version: C
5 Service Commissioning Interface
SET-WANSERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=999999999997:CTAG::STATUS=1,MODE=1,CONNTYPE=2,VLAN=88,NAT=2,
IPMODE=2,WANIP=43.43.43.43,WANMASK=255.255.255.0,
WANGATEWAY=43.43.43.43,MASTERDNS=3.3.3.3,SLAVEDNS=4.4.4.4,WANSVC=1;
Response Message
Example 2, configure a WAN connection with the INTERNET connection mode and
Route connection type for all the LAN ports of the ONU connected to the slot 7 -
PON 4 port of the OLT whose IP address is 10.78.200.200. The information of the
ONU is as follows: ONUID is FHTT01e821a; authentication mode is physical ID.
Command
SET-WANSERVICE::OLTID=10.78.200.200,PONID=NA-NA-7-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::STATUS=1,MODE=2,CONNTYPE=2,VLAN=88,COS=1,
NAT=2,IPMODE=1,UPORT=0;
Response Message
Related Command
ADD-ONU
Function Description
Version: C 43
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
SET-WANSERVICE::OLTID=olt_name,PONID=ponport_location,ONUIDTYPE=id-
type,ONUID=onu_index:CTAG::STATUS=status,MODE=mode,CONNTYPE=conntype,
VLAN=vlan_id,COS=cos_value,UPORT=port_id;
Supported Equipment
u ONU: AN5506-04-F1.
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of The ONU that has a
OCTET
ONUIP Size (128) the ONU that has a management IP address.
STRING
management IP address. Required.
ONU_NAME, MAC, ONU identifier type (ONU_ The ONU that has no
OCTET
ONUIDTYPE LOID, ONU_ NAME, MAC, LOID, ONU_ management IP address.
STRING
NUMBER NUMBER ). Required.
44 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
u 1: TR069
u 2: INTEGER
MODE INTEGER u 3: TR069 WAN connection mode. Required.
INTEGER
u 4: Other
u 1: bridge
CONNTYPE INTEGER WAN connection type. Required.
u 2: route
VLAN ID of the WAN
VLAN INTEGER 1 - 4085 Required.
connection
Priority level of 802.1p of
COS INTEGER 0-7 Required.
the WAN connection.
Binding LAN port
u When UPORT is set
to 1- 4, it indicates
LAN1 - LAN4.
UPORT INTEGER 1 - 4, 101 - 104 Required.
u When UPORT is set
to 101 - 104, it
indicates SSID1 -
SSID4.
Response Format
Output Parameter
None
Example
For example, delete the WAN connection of the ONU (MAC address being
FHTT01e821a0) connected to the slot 18 - PON 4 port of the OLT whose IP address
is 10.78.191.100.
u Command
SET-WANSERVICE::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::STATUS=2,MODE=2,CONNTYPE=2,VLAN=88,COS=3,
UPORT=1;
Version: C 45
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 to configure the bandwidth profile and the GPON service
bandwidth profile of the ONU.
Command Format
CFG-ONUBWPROFILE::OLTID=olt_name,PONID=ponport_location,ONUIDTYPE=id-
type,ONUID=onu_index:CTAG::BW=bandwidth,GPONSERVICEBW=gpon-service-bw;
Supported Equipment
Input Parameter
46 Version: C
5 Service Commissioning Interface
OCTET
BW Size (32) Bandwidth profile name. Configure at
STRING
least one
GPONSER- OCTET
Size (32) Name of the GPON service bandwidth profile parameter
VICEBW STRING
Response Format
Output Parameter
None
Example
For example: configure the bandwidth profile and the GPON service bandwidth
profile of the ONU with ID 1, which is in the PON port 5 in slot 4 on the OLT device
with IP 10.171.0.16.
u Command
CFG-ONUBWPROFILE::OLTID=10.171.0.16,PONID=1-1-4-5,ONUIDTYPE=ONU_NUMBER,
ONUID=1:CTAG::BW=1,GPONSERVICEBW=xldan;
u Response Message
FH_10.78.20.120 2011-02-21 13:50:24
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
UNBIND-ONUBWPROFILE
Version: C 47
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used to unbind the bandwidth profile and the GPON service
bandwidth profile of the ONU.
Command Format
UNBIND-ONUBWPROFILE::OLTID=olt_name,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index:CTAG::;
Supported Equipment
Input Parameter
OCTET
OLTID Size (128) OLT IP address, name or ID.
STRING
Size (128)
PON port information location. Locate through cabinet rack -
OCTET Cabinet rack - shelf -
PONID shelf - slot - PON port number. Enter NA if the corresponding
STRING slot - PON port
information is not specified.
number
ONU_NAME, MAC,
ONUID- OCTET ONU identifier type (ONU_NAME, MAC, LOID, ONU_
LOID, ONU_
TYPE STRING NUMBER ).
NUMBER
ONU identifier, used for uniquely identifying the ONU
OCTET
ONUID Size (128) connected to the PON port. The value is ONU_NAME, MAC,
STRING
LOID or Nonmember.
Response Format
Output Parameter
None
48 Version: C
5 Service Commissioning Interface
Example
For example: unbind the bandwidth profile and the GPON service bandwidth profile
of the ONU with ID 1, which is in the PON port 5 in slot 4 on the OLT device with IP
10.171.0.16.
u Command
UNBIND-ONUBWPROFILE::OLTID=10.171.0.16,PONID=1-1-4-5,
ONUIDTYPE=ONU_NUMBER,ONUID=1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 13:50:24
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
CFG-ONUBWPROFILE
Function Description
Command Format
CFG-LT-BWPROFILE::OLTID=olt_name,PONID=ponport_location,ONUIDTYPE=id-
type,ONUID=onu_index:CTAG::WANNAME=wan_name,WANINDEX=wan_index,
UPBWPROFILE=up_bwprofile,DOWNBWPROFILE=down_bwprofile;
Supported Equipment
Version: C 49
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
UPBWPRO- OCTET
Size (64) Uplink bandwidth template Required.
FILE STRING
DOWN-
OCTET
BWPRO- Size (64) Downlink bandwidth template Required.
STRING
FILE
Response Format
Output Parameter
None
Example
For example, bind the rate-control uplink and downlink bandwidth profile to the L3
service on the ONU with the ID FHTT03317f00, which is on the PON port 1 in slot 6
on the OLT device with IP 10.190.47.223.
50 Version: C
5 Service Commissioning Interface
u Command
CFG-LT-BWPROFILE::OLTID=10.190.47.223,PONID=NA-NA-6-1,ONUIDTYPE=MAC,
ONUID=FHTT03317f00:CTAG::WANNAME=1_INTERNET_B_VID_100,UPBWPROFILE=123,
DOWNBWPROFILE=test;
u Response Message
FH_10.170.162.23 2017-02-15 15:34:18
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used to bind the flow policy to the ONU port.
Command Format
CFG-PORTBINDFLOWPOLICY::ONUIP=onu-name|OLTID=olt_name,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index,ONUPORT=onu-
port:CTAG::IngressPolicy=Ingress_Policy,EgressPolicy=Egress_Policy,
IngressRule=Ingress_Rule,EgressRule=Egress_Rule;
Supported Equipment
Version: C 51
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
MAC
OCTET LOID ONU identifier type (NAME, MAC, LOID,
ONUIDTYPE Required.
STRING ONU_Number ONU_Number).
ONU_NAME
OCTET
IngressPolicy Size (20) Uplink flow policy Required.
STRING
OCTET
EgressPolicy Size (20) Downlink flow policy Required.
STRING
OCTET OLTv4.x version.
IngressRule Size (20) Uplink rule
STRING Required.
Response Format
52 Version: C
5 Service Commissioning Interface
Output Parameter
None
Example
Example: configure the flow policy on the PON port 1 in slot 16 on the OLT
equipment with the IP 10.171.0.16.
u Command
CFG-PORTBINDFLOWPOLICY::OLTID=10.171.0.16,PONID=NA-NA-16-1,
ONUIDTYPE=MAC,ONUID=1111aaaa3333,ONUPORT=NA-NA-NA-1:CTAG::
IngressPolicy=test,EgressPolicy=default1,IngressRule=de_rule_4,
EgressRule=de_rule_5;
u Response Message
FH_10.170.163.112 2017-02-15 15:55:52
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Prerequisite
Command Format
SET-UPLINKTRUNK::OLTID=olt_name:ctag::TRUNKNO=trunk_no,MASTERPORT=NA-
NA-2,MEMBERPORT=NA-NA-NA-NA;
Version: C 53
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Equipment
Input Parameter
MASTER- OCTET
1 to 12 Main port number of the TRUNK group Required.
PORT STRING
MEMBER- OCTET
1 to 12 Member port number of the TRUNK group Required.
PORT STRING
Response Format
Output Parameter
None
Example
Example: Configure the TRUNK port link aggregation on the OLT equipment with
the IP 10.171.0.22.
u Command
SET-UPLINKTRUNK::OLTID=10.171.0.22:ctag::TRUNKNO=2,MASTERPORT=NA-NA-19-
2,MEMBERPORT=NA-NA-20-5;
u Response Message
FH_10.170.163.112 2017-02-15 16:55:52
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
54 Version: C
5 Service Commissioning Interface
Function Description
This command is used to query the port of the TRUNK port link aggregation.
Command Format
LST-UPLINKTRUNK::OLTID=olt_name:ctag::;
Supported Equipment
Input Parameter
OLTID OCTET STRING Size (128) OLT IP address, name or ID. Required.
Response Format
Output Parameter
OCTET
MASTERPORT 1 to 12 Main port number of the TRUNK group
STRING
OCTET
MEMBERPORT 1 to 12 Member port number of the TRUNK group
STRING
Example
Example: query the TRUNK port link aggregation of the OLT equipment with the IP
10.171.0.22.
u Command
LST-TRUNKINFO::OLTID=10.171.0.22:ctag::;
u Response Message
Version: C 55
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
SET-UPLINKTRUNK
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::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;
Supported Equipment
56 Version: C
5 Service Commissioning Interface
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP address.
STRING
Required.
Response Format
Output Parameter
None
Version: C 57
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, activate the LAN 1 port of the ONU (having no management IP address)
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
The information of the ONU is as follows: ONUID is Test0001; authentication mode
is LOID.
u Command
ACT-LANPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Example 2, activate the LAN 1 port located in the No. 4 slot of the ONU (having a
management IP address) whose IP address is 10.250.18.20.
u Command
ACT-LANPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
DACT-LANPORT
Function Description
This command is used for deactivating a LAN port of the ONU to disable it.
Command Format
DACT-LANPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;
58 Version: C
5 Service Commissioning Interface
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET IP address, name or ID of the ONU
ONUIP Size (128) -
STRING that has a management IP address.
Response Format
Output Parameter
None
Version: C 59
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, deactivate the LAN 1 port of the ONU (having no management IP address)
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
The information of the ONU is as follows: ONUID is Test0001; authentication mode
is LOID.
u Command
DACT-LANPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001,ONUPORT=NA-NA-NA-1:CTAG::
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Example 2, deactivate the LAN 1 port located in the No. 4 slot of the ONU (having a
management IP address) whose IP address is 10.250.18.20.
u Command
DACT-LANPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ACT-LANPORT
Function Description
This command is used for configuring the bandwidth, default VLAN and default
priority level of a LAN port.
Prerequisite
Before using the command, ensure the bandwidth template is configured on the OLT.
60 Version: C
5 Service Commissioning Interface
Command Format
CFG-LANPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[BW=band
width][,VLANMOD=mode][,PVID=vlan id][,PCOS=port qos];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the ONU that
ONUIP OCTET STRING Size (128) -
has a management IP address.
Version: C 61
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
Required. It can be
a list of multiple
ports, separated by
vertical bars, for
Size (128) Locates card port through the approach
example, NA-NA-
Cabinet rack - of cabinet rack - shelf - slot - port
ONUPORT OCTET STRING NA-0| NA-NA-NA-1.
shelf - slot - port number. Enter NA if the corresponding
Entering multiple
number information is not specified.
ports means these
ONU ports will be
configured
simultaneously.
Response Format
62 Version: C
5 Service Commissioning Interface
Output Parameter
None
Example
Example 1, configure the bandwidth template BW_UP, default VLAN102 and priority
level 1 for the LAN 2 port of the ONU (having no management IP address)
connected to the slot 15 - PON 2 port of the OLT whose IP address is 10.78.11.102.
The information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E;
authentication mode is MAC.
u Command
CFG-LANPORT::OLTID=10.78.11.102,PONID=NA-NA-15-2,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-2:CTAG::BW=BW_UP,VLANMOD=Tag,
PVID=102,PCOS=1;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Example 2, configure the bandwidth template BW_2M for the LAN 1 port located in
the No. 1 slot of the ONU (having a management IP address) whose IP address is
10.250.18.20.
u Command
CFG-LANPORTBW::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::BW=BW_2M
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: C 63
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for configuring the VLAN information of the OLT PON port.
Note:
Command Format
ADD-PONVLAN::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-
type,ONUID=onu-index:CTAG::[SVLAN=outer vlan,]CVLAN=Inner vlan[,UV=user-
vlan][,SCOS=outer qos][,CCOS=inner qos];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP
STRING
address. Required.
64 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
The ONU that has no
OCTET ONU identifier type (ONU_NAME,
ONUIDTYPE Size (128) management IP
STRING MAC, LOID, ONU_NUMBER ).
address. Required.
Optional. It is required
SVLAN INTEGER 0 - 4095 SVLAN for stacked VLAN
service.
CVLAN INTEGER 0 - 4095 CVLAN Required.
Response Format
Output Parameter
None
Example
For example, configure the VLAN information for the No. 1 port of the ONU
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
The information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E;
authentication mode is MAC.
u Command
ADD-PONVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E:CTAG::SVLAN=100,CVLAN=78,UV=98,SCOS=5,CCOS=4;
Version: C 65
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-PONVLAN
Function Description
This command is used for deleting the VLAN information of an ONU PON port.
Command Format
DEL-PONVLAN::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-
type,ONUID=onu-index:CTAG::[,UV=user-vlan];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP address.
STRING
Required.
66 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
uniquely identifying the ONU The ONU that has no
OCTET
ONUID Size (128) connected to the PON port. The management IP address.
STRING
value is ONU_NAME, MAC, Required.
LOID or ONU_NUMBER.
Response Format
Output Parameter
None
Example
For example, delete the VLAN information of the No. 1 port of the ONU connected to
the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100. The
information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E; authentication
mode is MAC.
u Command
DEL-PONVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E:CTAG::[,UV=98];
u Response Message
FH_10.78.20.120 2011-02-21 15:57:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-PONVLAN
Version: C 67
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for configuring the VLAN information of a LAN port.
Command Format
CFG-LANPORTVLAN::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan][,SCOS=outer qos][,
CCOS=inner qos];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP
STRING
address. Required.
68 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for uniquely
identifying the ONU connected to The ONU that has no
OCTET
ONUID Size (128) the PON port. The value is ONU_ management IP
STRING
NAME, MAC, LOID or ONU_ address. Required.
NUMBER.
Required. It can be a
list of multiple ports,
Locates card port through the separated by vertical
Size (128)
approach of cabinet rack - shelf - bars, for example, NA-
OCTET Cabinet rack -
ONUPORT slot - port number. Enter NA if the NA-NA-0| NA-NA-NA-1.
STRING shelf - slot - port
corresponding information is not Entering multiple ports
number
specified. means these ONU
ports will be configured
simultaneously.
Response Format
Output Parameter
None
Example
Example 1, configure the CVLAN 21 and priority level 3 for the LAN 1 port of the
ONU (having no management IP address) connected to the slot 3 - PON 1 port of
the OLT whose IP address is 10.250.18.100. The information of the ONU is as
follows: ONUID is 54-4B-40-04-2C-1E; authentication mode is MAC.
Version: C 69
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
CFG-LANPORTVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::CVLAN=21,CCOS=3;
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, configure the CVLAN 21 for the LAN 2 port located in the No. 2 slot of
the ONU (having a management IP address) whose IP address is 10.250.18.121.
u Command
CFG-LANPORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-2:CTAG::CVLAN=21,
CCOS=3;
u Response Message
FH_10.78.20.120 2011-02-21 13:51:33
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-LANPORTVLAN
Function Description
This command is used for deleting the VLAN information of an ONU LAN port.
Command Format
DEL-LANPORTVLAN::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-
type,ONUID=onu-index,ONUPORT=onu-port:CTAG::[,UV=user-vlan];
Supported Equipment
70 Version: C
5 Service Commissioning Interface
Input Parameter
Response Format
Output Parameter
None
Version: C 71
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, delete the VLAN information of the LAN 1 port of the ONU (that as no
management IP) connected to the slot 3 - PON 1 port of the OLT whose IP address
is 10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B-40-04-
2C-1E; authentication mode is MAC.
u Command
DEL-LANPORTVLAN::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.78.20.120 2/22/2011 15:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, delete the VLAN configuration of the PON 10 port located in the No. 4
slot of the ONU (having a management IP address) whose IP address is
10.78.11.115.
u Command
DEL-LANPORTVLAN::ONUIP=10.78.11.115,ONUPORT=NA-NA-4-10:CTAG::CVLAN=21,
CCOS=3;
u Response Message
FH_10.78.20.120 2/22/2011 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.
72 Version: C
5 Service Commissioning Interface
Command Format
CFG-LANIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[FLMODE=iptv-fastleave-mode][,MAXGRP=Max-group-number];
Supported Equipment
Input Parameter
Version: C 73
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1, (the ONU has no independent management IP) Set the quick leaving
mode of the multicast service to Enabled, set the maximum multicast program
quantity to 23 and set the ONU authentication mode to MAC for the No. 1 LAN port
of the ONU connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B-40-04-
2C-1E; authentication mode is MAC.
u Command
CFG-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::FLMODE=Enabled,
MAXGRP=23;
u Response Message
FH_10.78.20.120 2/22/2011 09:17:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, configure the multicast service for the LAN 1 port located in the No. 4
slot of the ONU (having a management IP address) whose IP address is
10.250.18.20.
u Command
74 Version: C
5 Service Commissioning Interface
CFG-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::
FLMODE=Enabled,MAXGRP=32;
u Response Message
FH_10.78.20.120 2011-02-21 13:59:14
M CATG 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::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[UV=user
vlan][,MVLAN=mvlan] [,CCOS=ccos] [,SVCMODPROFILE=svc mod profile];
Supported Equipment
Input Parameter
Version: C 75
FiberHome Element Management System Northbound Interface (TL1) User Manual
Optional. Specified
MVLAN INTEGER 0 to 4095 Associated multicast VLAN multicast VLAN for
service provisioning.
SVCMOD- OCTET
Size (20) Service model template name Optional
PROFILE STRING
Response Format
Output Parameter
None
76 Version: C
5 Service Commissioning Interface
Example
Example 1, add the LAN 1 port of the ONU (having no management IP address) into
the MVLAN. The ONU is connected to the slot 3 - PON 1 port of the OLT whose IP
address is 10.250.18.100. The information of the ONU is as follows: ONUID is 54-
4B-40-04-2C-1E; authentication mode is MAC.
u Command
ADD-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::UV=109,MVLAN=88;
u Response Message
FH_10.78.20.120 2011-02-21 14:56:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, bind the No. 1 LAN port located in the No. 4 slot of the ONU (having an
independent management IP address) whose IP address is 10.250.18.20 to the
MVLAN88 (multicast VLAN).
u Command
ADD-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::UV=100,
MVLAN=88;
u Response Message
FH_10.78.20.120 2011-02-21 13:59:14
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-LANIPTVPORT
Function Description
This command is used for configuring the IPTV service of a LAN port.
Version: C 77
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
CFG-LANIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[FLMODE=iptv-fastleave-mode][,MAXGRP=Max-group-number];
Supported Equipment
Input Parameter
78 Version: C
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Example 1, delete the multicast service with the fast leave mode being enabled and
MAXGRP being 23 of the LAN 1 port of the ONU (having no management IP address)
with ONUID being 54-4B-40-04-2C-1E and ONU authentication mode being MAC.
The ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100.
u Command
CFG-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::FLMODE=Enabled,
MAXGRP=23;
u Response Message
FH_10.78.20.120 2/22/2011 9:17:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, configure the multicast service for the LAN 1 port located in the No. 4
slot of the ONU (having a management IP address) whose IP address is
10.250.18.20.
u Command
Version: C 79
FiberHome Element Management System Northbound Interface (TL1) User Manual
CFG-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::
FLMODE=Enabled,MAXGRP=32;
u Response Message
FH_10.78.20.120 2/22/2011 9:18:14
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-LANIPTVPORT
DEL-LANIPTVPORT
Function Description
This command is used for deleting a LAN port from a multicast VLAN.
Command Format
DEL-LANIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[UV=user
vlan][,MVLAN=mvlan];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has
OCTET
OLTID Size (128) OLT IP address, name or ID. no management IP
STRING
address. Required.
80 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
PON port information location.
Size (128) Locate through the approach of
The ONU that has
OCTET Cabinet rack - shelf cabinet rack - shelf - slot - PON
PONID no management IP
STRING - slot - PON port port number. Enter NA if the
address. Required.
number corresponding information is not
specified.
Optional. It is
required when the
UV INTEGER 0 - 4095 VLAN at user side multicast service is
accessed through a
home gateway.
Response Format
Output Parameter
None
Version: C 81
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, delete the multicast service with the fast leave mode being enabled and
MAXGRP being 23 of the LAN 1 port of the ONU (having no management IP address)
with ONUID being 54-4B-40-04-2C-1E and ONU authentication mode being MAC.
The ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100.
u Command
DEL-LANIPTVPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::UV=109,MVLAN=88;
u Response Message
FH_10.78.20.120 2011-02-21 15:18:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, delete the LAN 1 port from the MVLAN88 (multicast VLAN). The LAN 1
port locates in the No. 4 slot of the ONU (having a management IP address) whose
IP address is 10.250.18.20.
u Command
DEL-LANIPTVPORT::ONUIP=10.250.18.20,ONUPORT=NA-NA-4-1:CTAG::UV=100,
MVLAN=88;
u Response Message
FH_10.78.20.120 2011-02-21 08:59:14
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-LANIPTVPORT
Function Description
82 Version: C
5 Service Commissioning Interface
Command Format
CFG-NONOMCIMPATHCONFIG::OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index:CTAG::ChannelEnable=1[,
ManageCVlanId=9][,ManageCVlanCos=7];
Supported Equipment
Input Parameter
Response Format
Version: C 83
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
Example
u Command
CFG-NONOMCIMPATHCONFIG::OLTID=10.78.200.200,PONID=NA-NA-4-2,
ONUIDTYPE=ONU_NUMBER,ONUID=1:CTAG::ChannelEnable=0,ManageCVlanId=2,
ManageCVlanCos=3;
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Function Description
This command is used to configure the VEIP data service of the LAN port.
Command Format
CFG-VEIPSERVICE::ONUIP=onu-ip|OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
ServiceId=service-id,CVLANID=cvlanid,CCOS=ccos,TVLANID=T-vlan,TCOS=T-
cos,UpAssuredRateLimit=up-bandwidth profile,DownAssuredRateLimit=down-
bandwidth-profile,ServiceModelProfile=service-model-profile,
ServiceType=service-type;
Supported Equipment
84 Version: C
5 Service Commissioning Interface
Input Parameter
UpAssure- OCTET
Size (20) Uplink bandwidth profile name. Optional
dRateLimit STRING
DownAssure- OCTET
Size (20) Downlink bandwidth profile name. Optional
dRateLimit STRING
ServiceMo- OCTET
Size (20) Service model template name Required.
delProfile STRING
NONE
DATA
OCTET
ServiceType IPTV Service Type Optional
STRING
MANAGEMENT
VOIP
Response Format
Version: C 85
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
None
Example
Example 1, configure the VEIP data service of the LAN port 1 on the ONU with ID 1,
which is in the PON port 5 in slot 4 on the OLT device with IP 10.171.0.16.
u Command
CFG-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,ONUIDTYPE=ONU_NUMBER,
ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::ServiceId=1,CVLANID=500,CCOS=0,
UpAssuredRateLimit=1,DownAssuredRateLimit=2,ServiceModelProfile=1,
ServiceType=VOIP;
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Function Description
This command is used to modify the VEIP data service of the LAN port.
Command Format
MODIFY-VEIPSERVICE::ONUIP=onu-ip|OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
CVLANID=cvlanid,UpAssuredRateLimit=up-bandwidth-profile,
DownAssuredRateLimit=down-bandwidth-profile,ServiceType=service-type;
Supported Equipment
86 Version: C
5 Service Commissioning Interface
Input Parameter
UpAssure- OCTET
Size (20) Uplink bandwidth profile name. Optional
dRateLimit STRING
DownAssur- OCTET
Size (20) Downlink bandwidth profile name. Optional
edRateLimit STRING
NONE
DATA
OCTET
ServiceType IPTV Service Type Optional
STRING
MANAGEMENT
VOIP
Version: C 87
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1, modify the VEIP data service of the LAN port 1 on the ONU with ID 1,
which is in the PON port 5 in slot 4 on the OLT device with IP 10.171.0.16.
u Command
MODIFY-VEIPRATELIMIT::OLTID=10.171.0.16,PONID=1-1-4-5,
ONUIDTYPE=ONU_NUMBER,ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::CVLANID=500,
UpAssuredRateLimit=2,DownAssuredRateLimit=1,ServiceType=IPTV;
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Function Description
This command is used to unbind the bandwidth template in the VEIP data service
configuration of the LAN port.
Command Format
UNBIND-VEIPSERVICE::ONUIP=onu-ip|OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
ServiceId=service-id;
Supported Equipment
88 Version: C
5 Service Commissioning Interface
Input Parameter
Response Format
Output Parameter
None
Version: C 89
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, unbind the bandwidth template of the VEIP data service of the LAN port
1 on the ONU with ID 1, which is in the PON port 5 in slot 4 on the OLT device with
IP 10.171.0.16.
u Command
UNBIND-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,
ONUIDTYPE=ONU_NUMBER,ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::ServiceId=1;
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Function Description
This command is used to delete the VEIP data service configuration of the LAN port.
Command Format
UNBIND-VEIPSERVICE::OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index,ONUPORT=onu-port:CTAG::
ServiceId=service-id;
Supported Equipment
Input Parameter
90 Version: C
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
Example 1, delete the VEIP data service of the LAN port 1 on the ONU with ID 1,
which is in the PON port 5 in slot 4 on the OLT device with IP 10.171.0.16.
u Command
DEL-VEIPSERVICE::OLTID=10.171.0.16,PONID=1-1-4-5,ONUIDTYPE=ONU_NUMBER,
ONUID=1,ONUPORT=NA-NA-NA-1:CTAG::ServiceId=1;
u Response Message
FH_10.78.20.120 2011-02-21 14:55:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: C 91
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
ACT-DSLPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management -
STRING
IP address.
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP address.
STRING
Required.
92 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
uniquely identifying the ONU
The ONU that has no
OCTET connected to the PON port.
ONUID Size (128) management IP address.
STRING The value is ONU_NAME,
Required.
MAC, LOID or ONU_
NUMBER.
Locates card port through the
Size (128)
approach of cabinet rack -
OCTET Cabinet rack -
ONUPORT shelf - slot - port number. Required.
STRING shelf - slot - port
Enter NA if the corresponding
number
information is not specified.
Response Format
Output Parameter
None
Example
Example 2, activate the DSL 1 port located in the No. 3 slot of the ONU whose IP
address is 10.250.18.121.
u Command
ACT-DSLPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
u Response Message
FH_10.78.20.120 2/22/2011 17:13:17
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DACT-DSLPORT
Version: C 93
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
DACT-DSLPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
ONUIP OCTET STRING Size (128) ONU that has a management -
IP address.
The ONU that has
no management IP
OLTID OCTET STRING Size (128) OLT IP address, name or ID.
address.
Required.
94 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
The ONU that has
uniquely identifying the ONU
no management IP
ONUID OCTET STRING Size (128) connected to the PON port.
address.
The value is ONU_NAME,
Required.
MAC, LOID or ONU_NUMBER.
Response Format
Output Parameter
None
Example
For example, deactivate the No. 1 DSL port located in the No. 3 slot of the ONU
whose IP address is 10.250.18.121.
u Command
DACT-DSLPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
u Response Message
FH_10.78.20.120 2/22/2011 17:14:19
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ACT-DSLPORT
Version: C 95
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for configuring the bandwidth of a DSL port. Before using the
command, ensure the ONU is bound with the DSL line template and the bandwidth
template is correctly configured.
Command Format
CFG-DSLPORTBW::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::BW=band
width;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has
OCTET
OLTID Size (128) OLT IP address, name or ID. no management IP
STRING
address. Required.
96 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
uniquely identifying the ONU The ONU that has
OCTET
ONUID Size (128) connected to the PON port. The no management IP
STRING
value is ONU_NAME, MAC, address. Required.
LOID or ONU_NUMBER.
Response Format
Output Parameter
None
Example
For example: configure the bandwidth template for the No. 1 DSL port located in the
No. 3 slot of the ONU whose IP address is 10.250.18.121.
u Command
CFG-DSLPORTBW::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::BW=BW_2M
u Response Message
FH_10.78.20.120 2/22/2011 17:17:19
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Version: C 97
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::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][,SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan];
Supported Equipment
Input Parameter
98 Version: C
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
For example, configure the VLAN information for the No. 1 DSL port located in the
No. 3 slot of the ONU whose IP address is 10.250.18.121.
u Command
CFG-DSLPORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::VPI=0,
VCI=35,CVLAN=261;
u Response Message
FH_10.78.20.120 2011-02-22 17:19:01
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-DSLPORTVLAN
Version: C 99
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for deleting the VLAN information of a DSL port.
Command Format
DEL-DSLPORTVLAN::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][,SVLAN=outer vlan],CVLAN=Inner vlan[,UV=user-vlan];
Supported Equipment
Input Parameter
100 Version: C
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
For example, delete the VLAN information of the No. 1 DSL port located in the No. 3
slot of the ONU whose IP address is 10.250.18.121.
u Command
DEL-DSLPORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::VPI=0,
VCI=35,CVLAN=261;
u Response Message
FH_10.78.20.120 2/22/2011 18:13:38
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
CFG-DSLPORTVLAN
Version: C 101
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::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[UV=user
vlan][VPI=vpi][,VCI=vci][,MVLAN=mvlan];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management -
STRING
IP address.
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP address.
STRING
Required.
102 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
Locates card port through the
Size (128)
approach of cabinet rack - shelf
OCTET Cabinet rack -
ONUPORT - slot - port number. Enter NA if Required.
STRING shelf - slot - port
the corresponding information
number
is not specified.
Optional. It is required
UV INTEGER 0 - 4095 VLAN at user side when VDSL works in
VDSL mode.
Optional. Specified
MVLAN INTEGER Size (32) Associated multicast VLAN multicast VLAN for
service provisioning.
Response Format
Output Parameter
None
Example
For example, add a multicast user for the DSL 1 port located in the No. 3 slot of the
ONU whose IP address is 10.250.18.121.
u Command
ADD-DSLIPTVPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::UV=100,
VPI=0,VCI=35,MVLAN=88;
u Response Message
FH_10.78.20.120 2/22/2011 18:15:38
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: C 103
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
DEL-DSLIPTVPORT
Function Description
This command is used for deleting the multicast service of a DSL port.
Command Format
DEL-DSLIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][UV=user vlan][,MVLAN=mvlan];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has
OCTET
OLTID Size (128) OLT IP address, name or ID. no management IP
STRING
address. Required.
104 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for uniquely
identifying the ONU connected to The ONU that has
OCTET
ONUID Size (128) the PON port. The value is ONU_ no management IP
STRING
NAME, MAC, LOID or ONU_ address. Required.
NUMBER.
Locates card port through the
Size (128)
approach of cabinet rack - shelf -
OCTET Cabinet rack -
ONUPORT slot - port number. Enter NA if the Required.
STRING shelf - slot - port
corresponding information is not
number
specified.
Optional. It is
required when ADSL
VPI INTEGER 0 - 4095 Vpi
or VDSL works in
ADSL mode.
Optional. It is
required when ADSL
VCI INTEGER 32 - 65535 Vci
or VDSL works in
ADSL mode.
Optional. It is
required when VDSL
UV INTEGER 0 - 4095 VLAN at user side
works in VDSL
mode.
Optional. Specified
MVLAN INTEGER Size (32) Associated multicast VLAN multicast VLAN for
service provisioning.
Response Format
Output Parameter
None
Example
For example, delete the multicast service of the DSL 1 port located in the No. 3 slot
of the ONU whose IP address is 10.250.18.121.
Version: C 105
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
DEL-DSLIPTVPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::VPI=0,
VCI=35,UV=100,MVLAN=88;
u Response Message
FH_10.78.20.120 2/22/2011 18:17:31
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-DSLIPTVPORT
Function Description
This command is used for configuring the IPTV service of a DSL port.
Command Format
CFG-DSLIPTVPORT::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::[VPI=vpi]
[,VCI=vci][,FLMODE=iptv-fastleave-mode][,MAXGRP=Max-group-number];
Supported Equipment
Input Parameter
106 Version: C
5 Service Commissioning Interface
Optional. It is
required when
VPI INTEGER 0 - 4095 Vpi ADSL or VDSL
works in ADSL
mode.
Optional. It is
required when
VCI INTEGER 32 - 65535 Vci ADSL or VDSL
works in ADSL
mode.
Optional. It is
required when
UV INTEGER 0 - 4095 VLAN at user side
VDSL works in
VDSL mode.
Fast leave mode:
OCTET
FLMODE Size (32) Enabled Optional.
STRING
Disabled
Maximum number of multicast
MAXGRP INTEGER 0 - 255 programs that a port can join Optional.
simultaneously.
Version: C 107
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
For example, configure the multicast service of the No. 1 DSL port located in the No.
3 slot of the ONU whose IP address is 10.250.18.121.
u Command
CFG-DSLIPTVPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::
FLMODE=Enabled,MAXGRP=20;
u Response Message
FH_10.78.20.120 2/22/2011 18:17:31
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-DSLIPTVPORT
ADD-DSLIPTVPORT
The following introduces how to activate / deactivate a VoIP port, and configure /
delete the voice service of the VoIP port.
Function Description
108 Version: C
5 Service Commissioning Interface
Command Format
ACT-VOIPPORT::ONUIP=onu-name|[OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;
Supported Equipment
Input Parameter
Version: C 109
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1, activate the No. 1 voice port of the ONU (that has no management IP
address) connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18. The information of the ONU is as follows: ONUID is 54-4B-40-04-2C-1E;
authentication mode is MAC.
u Command
ACT-VOIPPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 18:09:11
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, activate 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
ACT-VOIPPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 19:01:47
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
DACT-VOIPPORT
110 Version: C
5 Service Commissioning Interface
Function Description
Command Format
DACT-VOIPPORT::ONUIP=onu-name|[OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management -
STRING
IP address.
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP
STRING
address. Required.
Version: C 111
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
uniquely identifying the ONU
The ONU that has no
OCTET connected to the PON port.
ONUID Size (128) management IP
STRING The value is ONU_NAME,
address. Required.
MAC, LOID or ONU_
NUMBER.
Locates card port through the
Size (128)
approach of cabinet rack -
OCTET Cabinet rack -
ONUPORT shelf - slot - port number. Enter Required.
STRING shelf - slot - port
NA if the corresponding
number
information is not specified.
Response Format
Output Parameter
None
Example
Example 1, deactivate the No. 1 voice port of the ONU (having no management IP
address) connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100. The information of the ONU is as follows: ONUID is 54-4B-40-04-
2C-1E; authentication mode is MAC.
u Command
DACT-VOIPPORT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 18:11:12
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, deactivate 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.
112 Version: C
5 Service Commissioning Interface
u Command
DACT-VOIPPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.78.20.120 2011-02-21 19:01:57
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ACT-VOIPPORT
Function Description
The command is used for configuring the voice service of a VoIP port.
Command Format
CFG-VOIPSERVICE::ONUIP=onu-name|[OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index],ONUPORT=onu-port:CTAG::
[PHONENUMBER=phonenumber][,PT=protocoltype][,SLVAN=voipoutervlan][,
VOIPVLAN=voipinnervlan][,SCOS=outerqos][,CCOS=innerqos][,
EID=equipmentid][TID=Terminal-ID][SIPREGDM=sipregisterdomain][,
SIPUSERNAME=sipusername][,SIPUSERPWD=sipuserpassword]
[MGCIP1=activebacip][,MGCIP2=standbybacip][,IPMODE=ipmode][,
IP=ipaddress,IPMASK=ipmask,IPGATEWAY=ipgateway][,PPPOEUSER=pppoeuser,
PPPOEPWD=pppoepassword],VOICECODEC=voice;
Supported Equipment
Version: C 113
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
OCTET
SIPREGDM Size (1 to 32) SIP register server Optional
STRING
SIPUSER- OCTET Username corresponding Optional. It is required for
Size (1 to 32)
NAME STRING to the SIP user port the SIP protocol.
114 Version: C
5 Service Commissioning Interface
Response Format
Output Parameter
None
Version: C 115
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, configure the voice service for No. 1 voice port of the ONU (having no
management IP address) connected to the slot 3 - PON 1 port of the OLT whose IP
address is 10.250.18.100. The information of the ONU is as follows: ONUID is 54-
4B-40-04-2C-1E; authentication mode is MAC.
u Command
CFG-VOIPSERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::PHONENUMBER=77777777,
PT=H.248,VOIPVLAN=1645,CCOS=0,EID=eid,TID=tid,IPMODE=STATIC,
IP=14.14.14.7,IPMASK=255.255.0.0,IPGATEWAY=14.14.14.1;
u Response Message
FH_10.78.20.120 2011-02-21 18:56:13
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, configure the voice service for the POTS 4 port located in the No. 1 slot
of the ONU (having a management IP address) whose IP address is 10.78.11.115.
u Command
CFG-VOIPSERVICE::ONUIP=10.78.11.115,ONUPORT=NA-NA-1-4:CTAG::PT=H.248,
VOIPVLAN=3111,CCOS=0,EID=AAA,TID=12365478;
u Response Message
FH_10.78.20.120 2011-02-21 13:41:37
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ACT-VOIPPORT
DEL-VOIPSERVICE
Function Description
The command is used for deleting the voice service of a VoIP port.
116 Version: C
5 Service Commissioning Interface
Command Format
DEL-VOIPSERVICE::OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index,ONUPORT=onu-port:CTAG::;
Supported Equipment
Input Parameter
OLTID OCTET STRING Size (128) OLT IP address, name or ID. Required
Response Format
Output Parameter
None
Version: C 117
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, delete the voice service of No. 1 voice port of the ONU (having no
management IP address) connected to the slot 3 - PON 1 port of the OLT whose IP
address is 10.250.18.100. The information of the ONU is as follows: ONUID is 54-
4B-40-04-2C-1E; authentication mode is MAC.
u Command
DEL-VOIPSERVICE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=MAC,
ONUID=54-4B-40-04-2C-1E,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.78.20.120 2/21/2011 19:06:14
M CTAG COMPLD
EN=0 ENDESC=No error
;
Example 2, delete the voice service of the POTS 4 port located in the No. 1 slot of
the ONU (having a management IP address) whose IP address is 10.78.11.115.
u Command
DEL-VOIPSERVICE::ONUIP=10.78.11.115,ONUPORT=NA-NA-1-4:CTAG::PT=H.248,
VOIPVLAN=3111,CCOS=0,EID=AAA,TID=12365478;
u Response Message
FH_10.78.20.120 2011-02-22 19:08:09
M CATG COMPLD
EN=0 ENDESC=No error
;
Related Command
ACT-VOIPPORT
CFG-VOIPSERVICE
Function Description
This command is used for configuring the NGN uplink interface parameters,
including the uplink MGC and SIP server information.
118 Version: C
5 Service Commissioning Interface
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;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET
OLTID Size (128) OLT IP address, name or ID. Required.
STRING
SVCNAME STRING Size (0 - 30) Signaling service name. Required.
0 - MGCP
NGNPROTO-
INTEGER 1 - H.248 NGN uplink protocol -
COL
2 - SIP
1 - 65535
MASTERDNS INTEGER Primary DNS server -
(sample: lefefefe)
1 - 65535
SLAVEDNS INTEGER Secondary DNS server -
(sample: lefefefe)
Version: C 119
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
DHCP INTEGER 0-1 A switch to enable DHCP -
SIPREGSER-
STRING Size (0 - 64) SIP register server address -
VER
SIPREGPORT INTEGER 1 - 65535 SIP register server port -
SIPPROSER-
STRING Size (0 - 64) SIP proxy server address -
VER
SIPPROPORT INTEGER 1 - 65535 SIP proxy server port -
1: create 1: create
STATUS INTEGER -
2: add 2: add
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
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,
120 Version: C
5 Service Commissioning Interface
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 the VOIP port voice service.
Command Format
MODIFY-ONUVOIPSERVICE::ONUIP=onu-ip|OLTID=olt-name,
PONID=ponport_location,ONUIDTYPE=onuid-type,ONUID=onu-index,
ONUPORT=onu-port:CTAG::VOICECODEC=voice;
Supported Equipment
Input Parameter
Version: C 121
FiberHome Element Management System Northbound Interface (TL1) User Manual
Size (128)
This item is optional. The
G.711U
default setting is G.711A.
VOICECO- OCTET G.711A
Voice encoding protocol Enter the corresponding
DEC STRING G.723
voice encoding protocol
G.729
name directly to modify.
G.722
Response Format
Output Parameter
None
Example
Example1: (The ONU has no independent management IP) Modify the voice code
of the voice service on the voice port 1 of the ONU with the ID FHTT03317f00,
which is under the PON port 1 in slot 6 on the OLT device with the IP
110.190.47.223. The ONU authentication mode is MAC.
122 Version: C
5 Service Commissioning Interface
u Command
MODIFY-ONUVOIPSERVICE::OLTID=10.190.47.223,PONID=NA-NA-6-1,
ONUIDTYPE=MAC,ONUID=FHTT03317f00,ONUPORT=NA-NA-NA-1:CTAG::
VOICECODEC=G.729;
u Response Message
FH_10.170.162.23 2017-02-15 14:34:14
M CTAG COMPLD
EN=0 ENDESC=No error
;
The following introduces how to create and delete the VLAN service.
Function Description
Command Format
ADD-VLAN::ONUIP=onu-name|OLTID=olt-name:CTAG::VLAN=vlanid[,DESC=vlan-
alias],VLANMODE=vlan-type[,PORTLIST=port-list][,MVLANFLAG=mvlan-flag][,
MVLANPRI=mvlan-priority][,SERVICE=service];
Supported Equipment
Input Parameter
Version: C 123
FiberHome Element Management System Northbound Interface (TL1) User Manual
OCTET
DESC Size (128) VLAN alias Optional.
STRING
VLAN attribute.
SINGLE: Switches the outer VLAN
tag or add the VLAN tag to the
untagged messages uplinked.
STACKING: Switches the inner
SINGLE
OCTET VLAN tag and add the outer VLAN
VLANMODE QINQ Required.
STRING tag, or add the outer and inner
STACKING
VLAN tags to the untagged
messages.
QINQ: Adds a VLAN tag to the
messages uplinked, mainly for the
private line application.
Optional. It can be a
list of uplink ports,
OCTET NA-NA-NA- a list of uplink ports that allows the separated by vertical
PORTLIST
STRING NA VLAN to pass through bars, for example, NA-
0-19-0| NA-0-19-1|
NA-0-20-0.
0: Non-
multicast
Indicates whether it is a multicast Optional.
MVLANFLAG INTEGER VLAN
VLAN or non-multicast VLAN. Default value: 0
1: Multicast
VLAN
Optional
MVLANPRI INTEGER 0-7 Priority level of the IGMP message.
Default Value: 6
Optional.
Default value: HSI
HSI (Internet
(This parameter can
OCTET access)
SERVICE Service type of the VLAN contain the meaning of
STRING IPTV (unicast)
MVLANFLAG. Adding
VOIP (voice)
a parameter value
indicates multicast.)
Response Format
124 Version: C
5 Service Commissioning Interface
Output Parameter
None
Example
For 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
ADD-VLAN::OLTID=10.78.200.200:CTAG::VLAN=101,VLANMODE=STACKING,
PORTLIST=NA-NA-19-1;
u Response Message
FH_10.98.100.16 2014-06-12 15:45:15
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-VLAN
Function Description
Command Format
DEL-VLAN:: ONUIP=onu-name|OLTID=olt-name:CTAG::VLAN=vlanid;
Supported Equipment
Version: C 125
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter Value
Data Type Description Remark
Name Range
IP address, name or ID of
OCTET
ONUIP Size (128) the ONU that has a -
STRING
management IP address.
Response Format
Output Parameter
None
Example
For example, delete the VLAN with VLAN ID being 101 of the OLT (the ONU has a
management IP address) whose IP address is 10.78.200.200.
u Command
DEL-VLAN::OLTID=10.78.200.200:CTAG::VLAN=101;
u Response Message
FH_10.98.100.16 2014-06-12 16:03:26
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-VLAN
126 Version: C
5 Service Commissioning Interface
Function Description
Command Format
ADD-PORTSPEEDLIMITPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG::
PROFILENAME=profile name, [USPOLICINGSTATUS=status,UMABW=uplink maximum
allowed bandwidth,UPCIR=UsPolicingCIR,USCBS=us cbs,USEBS=us ebs,
DSPOLICINGSTATUS=status,SDBW=servicedownlinkbandwidth,
DPCIR=DsPolicingCIR,DSPIR=ds pir];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
Version: C 127
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
Uplink policing status
USPOLICING-
INTEGER 0-1 0: disable Optional.
STATUS
1: enable
UMABW INTEGER 0 - 1000000 Maximum service uplink bandwidth Optional.
0 - 1000000
64 - 1000000 for
UPCIR INTEGER the AN5006-20 Assured uplink port rate Optional.
and AN5006-30
devices.
USCBS INTEGER 0 - 4294967294 Uplink committed burst size Optional.
0 - 16777215
64- 1000000 for
DPCIR INTEGER the AN5006-20 Assured downlink port rate Optional.
and AN5006-30
devices.
DSPIR INTEGER 0 - 16777215 Downlink peak cell rate Optional.
Response Format
Output Parameter
None
Example
Example 1: Add a rate limiting profile named as hello for the ONU whose IP address
is 10.171.0.38, and set the rate limiting parameters.
u Command
128 Version: C
5 Service Commissioning Interface
ADD-PORTSPEEDLIMITPROFILE::ONUIP=10.171.0.38:CTAG::PROFILENAME=hello,
USPOLICINGSTATUS=1,UPCIR=200,USCBS=111,USEBS=222,DSPOLICINGSTATUS=1,
DPCIR=400,DSPIR=444;
u Response Message
FH_0.0.0.0 2010-11-04 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
DEL-PORTSPEEDLIMITPROFILE
Function Description
Command Format
DEL-PORTSPEEDLIMITPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG::
PROFILENAME=profile name;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET
PROFILENAME Size (128) Name of the port rate limiting template Required.
STRING
Version: C 129
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
Example 1: Delete the rate limiting profile hello on the ONU 10.171.0.38.
u Command
DEL-PORTSPEEDLIMITPROFILE::ONUIP=10.171.0.38:CTAG::PROFILENAME=hello;
u Response Message
FH_0.0.0.0 2010-11-04 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
ADD-PORTSPEEDLIMITPROFILE
The following introduces the BWPROFILE command and example for adding /
deleting a bandwidth template.
Function Description
Command Format
ADD-BWPROFILE::ONUIP=onu-name|OLTID=olt-name:CTAG::PROFILENAME=profile
name [,UPMGBW=Up MIN Guaranteed Bandwidth,UMABW=uplink maximum allowed
bandwidth, DMGBW=Down MIN Guaranteed Bandwidth,DMABW=Down MAX Allowed
Bandwidth, UFBW=Upstream Fixed Bandwidth];
130 Version: C
5 Service Commissioning Interface
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
Response Format
Output Parameter
None
Example
u Command
ADD-BWPROFILE::OLTID=10.171.0.33:CTAG::PROFILENAME=hello,UPMGBW=100,
UMABW=11111,DMGBW=2222,DMABW=3333,UFBW=4444;
Version: C 131
FiberHome Element Management System Northbound Interface (TL1) User Manual
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::ONUIP=onu-name|OLTID=olt-name:CTAG:: PROFILENAME=profile
name;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
PROFILE- OCTET
Size (128) Name of the port rate limiting template Required.
NAME STRING
132 Version: C
5 Service Commissioning Interface
Response Format
Output Parameter
None
Example
u Command
DEL-BWPROFILE::OLTID=10.171.0.33:CTAG::PROFILENAME=hello;
u Response Message
FH_0.0.0.0 11/4/2015 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-BWPROFILE
The following introduces the FLOWPOLICY command and example for adding /
deleting a flow policy.
Function Description
Version: C 133
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
AADD-FLOWPOLICY::ONUIP=onu-name|OLTID=olt-name:CTAG::
PROFILENAME=profile name ,RULENAME=rule name,PRECEDENCE=Precedence[,
ACL=acl enable,RATELIMIT= rate limit, CIR=cir,CBS=cbs,
QUEUEENABLE=QueueEnable,QUEUEMAP=Queue Mapped, COSREMARK=cos remark,
COS=cos, DSCPREMARK=dscp remark,DSCP=dscp,RTC= Remark traffic class,TC=
Traffic class,REPORTENABLE=RePortEnable,REPORTNO=port no,
PMENABLE=PortMirrorEnable,MPORTNO=port no];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET
RULENAME Size (128) Name of the flow classification rule Required.
STRING
134 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description Remark
Name
Indicates whether to enable the
queue mapping function.
QUEUEENABLE INTEGER 0-1 Optional.
0: disable
1: enable
Port mirroring
PMENABLE INTEGER 0-1 0: disable Optional.
1: enable
Response Format
Output Parameter
None
Version: C 135
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1: Add a flow policy named hello for the ONU 10.171.0.39.
u Command
ADD-FLOWPOLICY::ONUIP=10.171.0.39:CTAG::PROFILENAME=hello,
RULENAME=nimei,PRECEDENCE=2,ACL=1,RATELIMIT=1,CIR=1111,CBS=2222,
QUEUEENABLE=1,QUEUEMAP=1,COSREMARK=1,COS=2,DSCPREMARK=1,DSCP=3,RTC=1,
TC=4,REPORTENABLE=1,REPORTNO=5,PMENABLE=1,MPORTNO=6;
u Response Message
FH_0.0.0.0 11/4/2015 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
DEL-FLOWPOLICY
ADD-PORTPVCFLOWPOLICY
Function Description
Command Format
DEL-FLOWPOLICY::ONUIP=onu-name|OLTID=olt-name:CTAG:: PROFILENAME=profile
name;
Supported Equipment
136 Version: C
5 Service Commissioning Interface
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET
PROFILENAME Size (128) Name of the port rate limiting template Required.
STRING
Response Format
Output Parameter
None
Example
u Command
DEL-FLOWPOLICY::ONUIP=10.171.0.39:CTAG::PROFILENAME=hello;
u Response Message
FH_0.0.0.0 11/4/2015 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
ADD-FLOWPOLICY
ADD-PORTPVCFLOWPOLICY
Version: C 137
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
ADD-PORTPVCFLOWPOLICY::ONUIP=|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::PVCNO=0,
UPPOLICYID=ubrPcr_1024K,DOWNPOLICYID=ubrPcr_1024K;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET IP address or name of the ONU that has a
ONUIP Size (128)
STRING management IP address.
OCTET
OLTID Size (128) OLT IP address or name.
STRING
PON port information location. Locate through the
Size (128)
OCTET approach of cabinet rack - shelf - slot - port number.
PONID Cabinet rack - shelf - slot
STRING Enter NA if the corresponding information is not
- PON port number
specified.
138 Version: C
5 Service Commissioning Interface
Parameter
Data Type Value Range Description
Name
Size (128) Locates through the approach of cabinet rack -
OCTET
ONUPORT Cabinet rack - shelf - slot shelf - slot - port number. Enter NA if the
STRING
- port number corresponding information is not specified.
Response Format
Example
Response Message
None
Related Command
ADD-FLOWPOLICY
DEL-FLOWPOLICY
Version: C 139
6 Integrated Testing Interface
The following introduces the testing commands for related resources of the PON
line, voice service, xDSL port and LAN port.
140 Version: C
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 equipment corresponding to the IP address.
Command Format
PING::ONUIP=onu name|OLTID=OLT_name[,PONID=ponport_location,ONUIDTYPE
=id-type,ONUID=onu_index]:CTAG::IP=ip-address;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET IP address, name or ID of the ONU
ONUIP Size (128) -
STRING that has a management IP address.
Version: C 141
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
Size (128)
ONU identifier type
ONU_NAME
ONU_NAME The ONU that has no
OCTET MAC
ONUIDTYPE MAC management IP
STRING LOID
LOID address. Required.
ONU_
ONU_NUMBER
NUMBER
ONU identifier, used for uniquely
identifying the ONU connected to The ONU that has no
OCTET
ONUID Size (128) the PON port. The value is ONU_ management IP
STRING
NAME, MAC, LOID or ONU_ address. Required.
NUMBER.
OCTET The destination IP address of the
IP Size (20) Required.
STRING PING command.
Response Format
Output Parameter
Parameter
Data Type Value Range Description Remark
Name
TxPkts INTEGER 0 - 10 Number of sent packets. -
142 Version: C
6 Integrated Testing Interface
Example
u Command
PING::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=Test0001:CTAG::IP=10.250.18.100;
u Response Message
FH_10.250.18.133 2010-10-27 10:56:34
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Ping from ONU
-----------------------------------------------------------
TxPkts RxPkts LostPkts LostPktRatio MinDelay MaxDelay AvgDelay
4 4 0 0 1 1 1
-----------------------------------------------------------
;
u Command
PING::ONUIP=10.250.18.121:CTAG::IP=10.250.18.100;
u Response Message
FH_10.250.18.133 2010-11-02 09:42:08
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Ping from ONU
-----------------------------------------------------------
TxPkts RxPkts LostPkts LostPktRatio MinDelay MaxDelay AvgDelay
2 2 0 0 0 0 0
-----------------------------------------------------------
;
Version: C 143
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
The following introduces the commands and examples for querying the equipment
information.
Function Description
This command is used to query the equipment model, software version, memory,
CPU and temperature of the NE (OLT and ONU).
Command Format
LST-DEVINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport-location,
ONUIDTYPE=id-type,ONUID=onu-index]:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the ONU
OCTET
ONUIP Size (128) that has a management IP -
STRING
address.
OCTET
OLTID Size (128) OLT IP address, name or ID. -
STRING
144 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
Name
PON port information location.
Size (128)
Locate through the approach of
Cabinet rack - The ONU that has no
OCTET cabinet rack - shelf - slot - PON
PONID shelf - slot - management IP
STRING port number. Enter NA if the
PON port address. Required.
corresponding information is not
number
specified.
ONU_NAME
MAC
OCTET ONU identifier type (ONU_NAME,
ONUIDTYPE LOID -
STRING MAC, LOID, ONU_NUMBER).
ONU_NUMBER
ER
ONU identifier, used for uniquely
identifying the ONU connected to The ONU that has no
OCTET
ONUID Size (128) the PON port. The value is ONU_ management IP
STRING
NAME, MAC, LOID or ONU_ address. Required.
NUMBER.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
DEVNAME OCTET STRING Size (128) Equipment name
Version: C 145
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command
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
1 10.250.18.100 AN5516_01 RP0121 68.98 5.57 30
-----------------------------------------------------------
Related Command
None
Function Description
This command is sued for querying the type, status and version of the card.
Command Format
LST-BRDINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index][,BOARDID=board-name]:CTAG::;
Supported Equipment
146 Version: C
6 Integrated Testing Interface
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
OCTET
OLTID Size (128) OLT IP address, name or ID. -
STRING
PON port information location.
It is required when
Size (128) Locate through the approach of
querying the ONU
OCTET Cabinet rack - shelf cabinet rack - shelf - slot - PON
PONID that has no
STRING - slot - PON port port number. Enter NA if the
management IP
number corresponding information is not
address.
specified.
ONU_NAME,
ONU identifier type (ONU_
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ -
STRING LOID
NUMBER).
ONU_NUMBER
Response Format
Version: C 147
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Parameter
Data Type Value Range Description Remark
Name
Locates the information of the card
Size (128) connected with the ONU through the
OCTET
BOARDID Cabinet rack - approach of cabinet rack - shelf - slot -
STRING
shelf - slot number. Enter NA if the corresponding
information is not specified.
Normal
OCTET
BSTAT Fault Card status -
STRING
Offline
OCTET
BOARDTYPE Size (128) Card Type -
STRING
Power
ETH
ADSL
VDSL
OCTET POTS Card service type (such as ADSL2P and SCU: main
BSERVICE
STRING E1 SHDSL) control unit
GPON
EPON
SCU
Other
PNUM INTEGER 0 - 64 Number of ports -
OCTET
SWVER Size (255) Software version -
STRING
OCTET
HWVER Size (255) Hardware Version -
STRING
Memory usage
MEM INTEGER 0 - 100 -
Unit: %
CPU usage
CPU INTEGER 0 - 100 -
Unit: %
Example
u Command
LST-BRDINFO::OLTID=10.250.18.100,BOARDID=NA-NA-3:CTAG::;
u Response Message
148 Version: C
6 Integrated Testing Interface
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 information and configuration
information of the OLT PON port.
Command Format
LST-PONINFO::OLTID=olt-name,PONID=pon_name:CTAG::;
Supported Equipment
Version: C 149
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET
OLTID Size (128) OLT IP address, name or ID. -
STRING
Size (128)
PON port information location. Locate through
Cabinet rack -
OCTET the approach of cabinet rack - shelf - slot -
PONID shelf - slot - -
STRING PON port number. Enter NA if the
PON port
corresponding information is not specified.
number
Response Format
Output Parameter
Example
For example, query the status of the No. 1 PON port located in the No. 3 slot of the
NE equipment whose IP address is 10.250.18.100.
u Command
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
150 Version: C
6 Integrated Testing Interface
-----------------------------------------------------------
AdminState OperState
UP UP
-----------------------------------------------------------
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::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location[,
ONUIDTYPE=id-type,ONUID=onu-index]):CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management -
STRING
IP address.
It is required when
querying the OLT
OCTET PON port or the
OLTID Size (128) OLT IP address, name or ID.
STRING ONU that has no
management IP
address.
Version: C 151
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
PON port information location. It is required when
Size (128) Locate through the approach querying the OLT
OCTET Cabinet rack - shelf - of cabinet rack - shelf - slot - PON port or the
PONID
STRING slot - PON port PON port number. Enter NA if ONU that has no
number the corresponding information management IP
is not specified. address.
ONU identifier type: It is required when
ONU_NAME
ONU_NAME querying the ONU
OCTET MAC
ONUIDTYPE MAC that has no
STRING LOID
LOID management IP
ONU_NUMBER
ONU_NUMBER address.
ONU identifier, used for
It is required when
uniquely identifying the ONU
querying the ONU
OCTET connected to the PON port.
ONUID Size (128) that has no
STRING The value is ONU_NAME,
management IP
MAC, LOID or ONU_
address.
NUMBER.
Response Format
Output Parameter
152 Version: C
6 Integrated Testing Interface
Example
Example 1, query the PON link status of the ONU (having no management IP
address) with ONUID being aa_bbb_ccc_111_222. The ONU is connected to the
slot 3 - PON 1 port of the NE whose IP address is 10.250.18.100.
u Command
LST-PONPERF::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 11:05:41
M CTAG COMPLD
total_blocks=1
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
-----------------------------------------------------------
Example 2, query the PON link status of the ONU (having a management IP address)
whose IP address is 10.250.18.121.
u Command
LST-PONPERF::ONUIP=10.250.18.121:CTAG::;
Version: C 153
FiberHome Element Management System Northbound Interface (TL1) User Manual
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,ONUIDTYPE=id-type,
ONUID=onu-index:CTAG::;
Supported Equipment
154 Version: C
6 Integrated Testing Interface
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET
OLTID Size (128) OLT IP address, name or ID.
STRING
PON port information location. Locate
Size (128)
through the approach of cabinet rack -
OCTET Cabinet rack - shelf
PONID shelf - slot - PON port number. Enter NA
STRING - slot - PON port
if the corresponding information is not
number
specified.
ONU_NAME
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE
STRING LOID, ONU_ MAC, LOID, ONU_NUMBER).
NUMBER
ONU identifier, used for uniquely
OCTET identifying the ONU connected to the
ONUID Size (128)
STRING PON port. The value is ONU_NAME,
MAC, LOID or ONU_NUMBER.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET UP
AdminState Administration status
STRING DOWN
UP
OCTET
OperState Power-Off Running status
STRING
LOS
MAC
OCTET
AUTHTYPE LOID Authentication mode
STRING
LOIDONCEON
Version: C 155
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
Authentication information. If
OCTET AUTHTYPE is set to MAC, AUTHINFO
AUTHINFO Size (64)
STRING is MAC address. If AUTHTYPE is set to
LOID, AUTHINFO is LOID.
Optical fiber length
Length DOUBLE 0 - 100
Unit: km
Fixed uplink bandwidth
UsFixedBw INTEGER 0 - 40000
Unit: Mbit/s
Guaranteed uplink bandwidth
UsAssuredBw INTEGER 0 - 40000
Unit: Mbit/s
Maximum uplink bandwidth
UsMaxBw INTEGER 0 - 40000
Unit: Mbit/s
Maximum downlink bandwidth
DsMaxBw INTEGER 0 - 40000
Unit: Mbit/s
Example
For example, query the configuration information of the ONU with ONUID being
aa_bbb_ccc_111_222. The ONU is connected to the slot 3 - PON 1 port of the OLT
whose IP address is 10.250.18.100.
u Command
LST-ONUCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 11:03:08
M 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
-----------------------------------------------------------
156 Version: C
6 Integrated Testing Interface
Related Command
None
Function Description
Command Format
LST-ONUSTATE::OLTID=olt-name,PONID=ponport_location[,ONUIDTYPE=id-type,
ONUID=onu-index]:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET OLT IP address, name or
OLTID Size (128) -
STRING ID.
PON port information
Size (128) location. Locate through the
Cabinet rack - approach of cabinet rack -
OCTET
PONID shelf - slot - shelf - slot - PON port -
STRING
PON port number. Enter NA if the
number corresponding information
is not specified.
Version: C 157
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
Optional. If it
is not
ONU identifier type: specified, it
ONU_NAME
ONU_NAME indicates
OCTET MAC
ONUIDTYPE MAC querying the
STRING LOID
LOID status of all
ONU_NUMBER
ONU_NUMBER ONUs on the
OLT PON
port.
Optional. If it
is not
ONU identifier, used for
specified, it
uniquely identifying the
indicates
OCTET ONU connected to the PON
ONUID Size (128) querying the
STRING port. The value is ONU_
status of all
NAME, MAC, LOID or
ONUs on the
ONU_NUMBER.
OLT PON
port.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
ONU identifier type, used for uniquely
OCTET
ONUID Size (128) identifying the ONU on the PON port. The
STRING
value is ONU_Number.
OCTET UP
AdminState Administration status
STRING DOWN
UP
OCTET
OperState Power-Off Running status
STRING
LOS
OCTET MAC
AUTH Authentication mode
STRING LOID
158 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description
Name
Authentication information. If AUTHTYPE is
OCTET set to MAC, AUTHINFO is MAC address. If
AUTHINFO Size (64)
STRING AUTHTYPE is set to LOID, AUTHINFO is
LOID.
OCTET
ONUIP - ONU management IP address
STRING
OCTET
LASTOFFTIME - ONU offline time
STRING
Example
Example 1, query the status of the ONU with ONUID being aaa_bbb. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-ONUSTATE::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 11:03:48
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of ONU state
-----------------------------------------------------------------
ONUID AdminState OperStat AUTH AUTHINFO ONUIP LASTOFFTIME
5 UP UP LOID aaa_bbb -- 0000-00-00 00:00:00
-----------------------------------------------------------------
Related Command
None
Version: C 159
FiberHome Element Management System Northbound Interface (TL1) User Manual
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::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location][,ONUIDTYPE=id-type,ONUID=onu_index][,
PORTID=uniport_index][,VLAN=vlan_value]:CTAG::;
Supported Equipment
Input Parameter
160 Version: C
6 Integrated Testing Interface
Response Format
Output Parameter
Example
Example 1, query the MAC address table of the UNI port of the ONU (having no
management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-PORTMACADDRESS::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,PORTID=NA-NA-NA-1,VLAN=2114:CTAG::;
Version: C 161
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
LST-PORTMACADDRESS::ONUIP=10.250.18.121,PORTID=NA-NA-4-1,VLAN=2114:
CTAG::;
u Response Message
FH_10.250.18.133 11/2/2010 9:45:19
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of MAC Address
-----------------------------------------------------------
VLAN MAC
2114
-----------------------------------------------------------
Related Command
None
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.
162 Version: C
6 Integrated Testing Interface
Command Format
LST-OMDDM::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location][,
ONUIDTYPE=id-type,ONUID=onu-index][,PORTID=lanport_index][,
PEERFLAG=flag]:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
It is required when
querying the OLT PON
OCTET optical module or the
OLTID Size (128) OLT IP address, name or ID.
STRING ONU that has no
management IP
address.
PON port information location. It is required when
Size (128)
Locate through the approach of querying the OLT PON
Cabinet rack -
OCTET cabinet rack - shelf - slot - PON optical module or the
PONID shelf - slot -
STRING port number. Enter NA if the ONU that has no
PON port
corresponding information is not management IP
number
specified. address.
ONU_NAME It is required when
ONU identifier type (ONU_
OCTET MAC querying the ONU that
ONUIDTYPE NAME, MAC, LOID, ONU_
STRING LOID has no management IP
NUMBER).
ONU_NUMBER address.
ONU identifier, used for uniquely
It is required when
identifying the ONU connected to
OCTET querying the ONU that
ONUID Size (128) the PON port. The value is ONU_
STRING has no management IP
NAME, MAC, LOID or ONU_
address.
NUMBER.
Version: C 163
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
Locates the card through the
Size (128)
approach of cabinet rack - shelf - Optional. It is used for
OCTET Cabinet rack -
PORTID slot - port number. Enter NA if the querying the OLT uplink
STRING shelf - slot - port
corresponding information is not port.
number
specified.
Response Format
Output Parameter
OCTET
RxPower -40 to 10 Received optical power. Unit: dBm.
STRING
Normal
OCTET
RxPowerR High Indicates whether the received optical power is normal.
STRING
Low
OCTET
TxPower -40 to 10 Sent optical power. Unit: dBm.
STRING
Normal
OCTET
TxPowerR High Indicates whether the sent optical power is normal.
STRING
Low
OCTET
CurrTxBias 0 to 131 Bias current. Unit: mA.
STRING
164 Version: C
6 Integrated Testing Interface
Normal
OCTET
CurrTxBiasR High indicates whether the bias current is normal.
STRING
Low
OCTET
Temperature -45 to 90 Temperature. Unit: ℃.
STRING
Normal
OCTET
TemperatureR High Indicates whether the temperature is normal.
STRING
Low
OCTET
Voltage 0 to 6.55 Supply voltage. Unit: V.
STRING
Normal
OCTET
VoltageR High Indicates whether the supply voltage is normal.
STRING
Low
OCTET Far-end sent optical power. Unit: dBm. A dash (–) will be
PTxPower -40 to 10
STRING returned if no optical power is sent.
OCTET Far-end received optical power. Unit: dBm. A dash (–) will
PRxPower -40 to 10
STRING be returned if no optical power is received.
Example
u Command
LST-OMDDM::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 11:05:05
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
List of Optical Power Info
-----------------------------------------------------------
ONUID RxPower RxPowerR TxPower TxPowerR CurrTxBias
CurrTxBiasR Temperature TemperatureR Voltage VoltageR
PTxPower PRxPower
5 -9.76 Normal 1.76 Normal 15.80 Normal 62.37
Normal 3.40 Normal -- --
Version: C 165
FiberHome Element Management System Northbound Interface (TL1) User Manual
-----------------------------------------------------------
Example 2, query the optical module information of the ONU (having a management
IP address) whose IP address is 10.250.18.121.
u Command
LST-OMDDM::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:47:44
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
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 a OLT
PON port.
Command Format
LST-UNREGONU::OLTID=olt-name,PONID=pon_name:CTAG::;
Supported Equipment
166 Version: C
6 Integrated Testing Interface
Input Parameter
Parameter
Data Type Value Range Description
Name
OLTID OCTET STRING Size (128) OLT IP address, name or ID.
PON port information location. Locate through
Size (128)
the approach of cabinet rack - shelf - slot -
PONID OCTET STRING Cabinet rack - shelf - slot -
PON port number. Enter NA if the
PON port number
corresponding information is not specified.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
MAC Size (128) MAC address of the EPON ONU or SN of the 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
PWD Size (128)
STRING no password.
OCTET
DT Size (255) ONU equipment model. Optional.
STRING
Example
For example, query the status information of the unregistered ONU (having no
management IP address). The ONU is connected to the slot 7 - PON 1 port of the
OLT whose IP address is 10.78.200.200.
Version: C 167
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
LST-UNREGONU::OLTID=10.78.200.200,PONID=NA-NA-7-1:CTAG::;
u Response Message
FH_10.98.100.16 2014-06-12 16:29:21
M CTAG COMPLD
total_blocks=0
block_number=0
block_records=0
--------------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the Wi-Fi service information of an ONU.
Command Format
LST-WIFISERVICE::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location]
[,ONUIDTYPE=id-type,ONUID=onu-index]:CTAG::;
Supported Equipment
u ONU: AN5506-04-F1.
168 Version: C
6 Integrated Testing Interface
Input Parameter
ONU_NAME
ONU identifier type It is required when querying
OCTET MAC
ONUIDTYPE (ONU_NAME, MAC, the ONU that has no
STRING LOID
LOID, ONU_NUMBER). management IP address.
ONU_NUMBER
Response Format
Version: C 169
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
170 Version: C
6 Integrated Testing Interface
Example
For example, query the Wi-Fi service information of the ONU (having no
management IP address) with MAC being FHTT01e821a0. The ONU is connected
to the slot 18 - PON 4 port of the OLT whose IP address is 10.78.191.100.
u Command
LST-WIFISERVICE::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;
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 WIFIENABLE FREQBANDWIDTH 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 -- -- -- --
--------------------------------------------------------------------
;
Version: C 171
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used for querying the WAN connection service information of an
ONU.
Command Format
LST-ONUWANSERVICECFG::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index][,
ONUPORT=port-id]:CTAG::;
Supported Equipment
u ONU: AN5506-04-F1.
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the The ONU that has a
OCTET
ONUIP Size (128) ONU that has a management IP management IP
STRING
address. address. Required.
172 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
Name
ONU_NAME, The ONU that has no
OCTET ONU identifier type (ONU_NAME,
ONUIDTYPE MAC, LOID, management IP
STRING MAC, LOID, ONU_NUMBER ).
ONU_NUMBER address. Required.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
SVCNAME Size (128) Name of the WAN connection
STRING
1: TR069
2: INTERNET
CONNMODE INTEGER WAN connection mode
3: TR069INTERNE
4: Other
1: bridge
CONNTYPE INTEGER WAN connection type
2: route
VLANID INTEGER 1 - 4085. It can be null. VLAN ID of the WAN connection
VLANCOS INTEGER 0 - 7. It can be null. VLAN ID of the WAN connection
Version: C 173
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
1: Enable Indicates whether to enable NAT for the WAN
NATFLAG INTEGER
2: Disable connection
1: DHCP
IPOBTAINTYPE INTEGER 2: Static IP obtaining mode of the WAN connection
3: PPPOE
It is valid only when
STATICIPAD- OCTET IPOBTAINTYPE is set to
Static IP address of the WAN connection
DRESS STRING Static. Otherwise, it is
disabled.
It is valid only when
STATICIPSUB- OCTET IPOBTAINTYPE is set to
Subnet mask of the WAN connection
NET STRING Static. Otherwise, it is
disabled.
It is valid only when
STATICGATE- OCTET IPOBTAINTYPE is set to
Default gateway of the WAN connection
WAY STRING Static. Otherwise, it is
disabled.
It is valid only when
OCTET IPOBTAINTYPE is set to
MASTERDNS Primary DNS of the WAN connection
STRING Static. Otherwise, it is
disabled.
It is valid only when
OCTET IPOBTAINTYPE is set to
SLAVEDNS Secondary DNS of the WAN connection
STRING Static. Otherwise, it is
disabled.
PPPOEPROXY- 1: Enable Indicates whether to enable PPPoE Proxy for the
INTEGER
FLAG 2: Disable WAN connection.
It is valid only when
PPPOEUSER- OCTET IPOBTAINTYPE is set to
Username of the PPPoE connection.
NAME STRING PPPoE. Otherwise, it is
disabled.
It is valid only when
PPPOE- OCTET IPOBTAINTYPE is set to
Password of the PPPoE connection.
PASSWD STRING PPPoE. Otherwise, it is
disabled.
It is valid only when
PPPOESVC- OCTET IPOBTAINTYPE is set to
PPPoE service name
NAME STRING PPPoE. Otherwise, it is
disabled.
174 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description
Name
It is valid only when
IPOBTAINTYPE is set to
PPPoE. Otherwise, it is
PPPOEMODE INTEGER disabled. PPPoE dial-up mode
1: Auto connect
2. Connect when traffic
is deleted
1: Enable Indicates whether to enable the QoS function for
QOSFLAG INTEGER
2: Disable the WAN connection.
1 - 4 indicates LAN1 to
LAN4; 101 - 104
BINDPORTNO INTEGER Binding LAN port
indicates SSID1 to
SSID4.
Example
For example, query the WAN connection service information of the ONU (having no
management IP address) with MAC address being FHTT01e821a0. The ONU is
connected to the slot 18 - PON 4 port of the OLT whose IP address is 10.78.191.100.
u Command
LST-ONUWANSERVICECFG::OLTID=10.78.191.100,PONID=NA-NA-18-4,
ONUIDTYPE=MAC,ONUID=FHTT01e821a0:CTAG::;
u Response Message
FH_10.82.25.73 2013-02-05 16:52:02
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Version: C 175
FiberHome Element Management System Northbound Interface (TL1) User Manual
-------------------------------------------------------------
;
Related Command
None
Function Description
Command Format
RESET-ONU::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index][,portid=port-id]:CTAG::
[RESETTYPE=resettype];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that has
OCTET IP address, name or ID of the ONU
ONUIP Size (128) a management IP
STRING that has a management IP address.
address. Required.
176 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
Name
ONU_NAME, The ONU that has
OCTET ONU identifier type (ONU_NAME,
ONUIDTYPE MAC, LOID, no management IP
STRING MAC, LOID, ONU_NUMBER ).
ONU_NUMBER address. Required.
Response Format
Output Parameter
None
Example
Example 1, restart the ONU (having no management IP address) with MAC address
being FHTT01e821a0. The ONU is connected to the slot 18 - PON 4 port of the OLT
whose IP address is 10.78.191.100.
u Command
RESET-ONU::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;
Version: C 177
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response Message
FH_10.82.25.73 2013-02-21 14:52:34
M CTAG COMPLD
EN=0 ENDESC=No error
;
u Command
RESET-ONU::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;
u Response Message
FH_10.82.25.73 2013-02-21 14:52:34
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for querying the IP address or range allocated to the user by
Wi-Fi.
Command Format
LST-USERDHCPSERVER::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::;
Supported Equipment
u ONU: AN5506-04-F1.
178 Version: C
6 Integrated Testing Interface
Input Parameter
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
The value (IP address) should be in the same network
OCTET
LANIP Size (128) segment as the DHCPPOOLSTART and
STRING
DHCPPOOLEND.
OCTET Size (128)
ENABLE Indicates whether to enable the configured IP address.
STRING Enable; Disable
Version: C 179
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
DHCPPOOL- OCTET Start IP address of DHCP, which should be smaller than
Size (128)
START STRING the end IP address of DHCP.
DHCPPOO- OCTET
Size (128) End IP address of DHCP.
LEND STRING
OCTET
DHCPPRIDNS Size (128) Primary DNS server of DHCP.
STRING
OCTET
DHCPSECDNS Size (128) Secondary DNS server of DHCP.
STRING
OCTET
DHCPGATEWAY Size (128) DHCP default gateway.
STRING
Example
For example, query the IP address or range allocated to the user by Wi-Fi of the
ONU (having no management IP address) with MAC being FHTT01e821a0. The
ONU is connected to the slot 18 - PON 4 port of the OLT whose IP address is
10.78.191.100.
u Command
LST-USERDHCPSERVER::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;
u Response Message
FH_10.82.25.73 2013-02-22 17:03:25
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
180 Version: C
6 Integrated Testing Interface
Function Description
This command is used for modifying the IP address or range allocated to the user
by Wi-Fi.
Command Format
CFG-USERDHCPSERVER::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::
LANIP=lan_ip,ENABLE=enable_value,DHCPPOOLSTART=dhcp_start_value,
DHCPPOOLEND=dhcp_end_value,DHCPPRIDNS=pri_dns,DHCPSECDNS=sec_dns,
DHCPGATEWAY=gateway_value,DHCPMASK=mask_value;
Supported Equipment
u ONU: AN5506-04-F1.
Input Parameter
Version: C 181
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
None
Example
For example, modify the IP address or range allocated to the user by Wi-Fi of the
ONU (having no management IP address) with MAC being FHTT01e821a0. The
ONU is connected to the slot 18 - PON 4 port of the OLT whose IP address is
10.78.191.100.
182 Version: C
6 Integrated Testing Interface
u Command
CFG-USERDHCPSERVER::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::LANIP=10.78.11.6,ENABLE=true,
DHCPPOOLSTART=10.78.11.3,DHCPPOOLEND=10.78.11.9,DHCPPRIDNS=6.6.6.6,
DHCPSECDNS=5.5.5.5,DHCPGATEWAY=10.78.11.1,DHCPMASK=255.255.0.0;
u Response Message
FH_10.82.25.73 2013-02-22 17:05:44
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
This command is used for querying the username and password of the web
interface.
Command Format
LST-WEBADMINISTRATOR::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::;
Supported Equipment
u ONU: AN5506-04-F1.
Version: C 183
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that has a
OCTET IP address, name or ID of the ONU
ONUIP Size (128) management IP
STRING that has a management IP address.
address. Required.
Response Format
Output Parameter
Size (128)
GROUP OCTET STRING Admin indicates the administrator.
Admin
184 Version: C
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 the slot 18 - PON 4 port of the OLT whose IP address is 10.78.191.100.
u Command
LST-WEBADMINISTRATOR::OLTID=10.78.191.100,PONID=NA-NA-18-4,
ONUIDTYPE=MAC,ONUID=FHTT01e821a0:CTAG::;
u Response Message
FH_10.82.25.73 2013-02-22 17:07:31
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
Function Description
This command is used for modifying the username and password of the web
interface.
Command Format
CFG-WEBADMINISTRATOR::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::
[WEBUSERNAME=user_name][,WEBPASSWORD=web_password];
Version: C 185
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Equipment
u ONU: AN5506-04-F1.
Input Parameter
Response Format
186 Version: C
6 Integrated Testing Interface
Output Parameter
None
Example
For 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 the slot 18 - PON 4 port of the OLT whose IP address is 10.78.191.100.
u Command
CFG-WEBADMINISTRATOR::OLTID=10.78.191.100,PONID=NA-NA-18-4,
ONUIDTYPE=ONU_NUMBER,ONUID=1:CTAG::WEBUSERNAME=user_name,
WEBPASSWORD=web_password;
u Response Message
FH_10.82.25.73 2013-02-22 17:07:42
M CTAG COMPLD
EN=0 ENDESC=No error
;
Related Command
None
Function Description
Command Format
RESTORE-DEFAULTCFG::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index]:CTAG::;
Supported Equipment
u ONU: AN5506-04-F1.
Version: C 187
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that has
OCTET IP address, name or ID of the ONU
ONUIP Size (128) a management IP
STRING that has a management IP address.
address. Required.
Response Format
Output Parameter
None
Example
u Command
RESTORE-DEFAULTCFG::OLTID=10.78.191.100,PONID=NA-NA-18-4,ONUIDTYPE=MAC,
ONUID=FHTT01e821a0:CTAG::;
188 Version: C
6 Integrated Testing Interface
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
The following introduces the command and example for querying the LAN
information.
Function Description
Command Format
LST-ONULANINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=lanport_index:CTAG::;
Supported Equipment
Version: C 189
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
ONU_NAME
ONU identifier type The ONU that has no
MAC
ONUIDTYPE OCTET STRING (ONU_NAME, MAC, management IP
LOID
LOID, ONU_NUMBER). address. Required.
ONU_NUMBER
Response Format
190 Version: C
6 Integrated Testing Interface
Output Parameter
UP
AdminStatus OCTET STRING Administration status
DOWN
UP
OperStatus - Running 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.
Auto-negotiation
10M
100M
SPEED INTEGER 1000M Port rate
Auto-10M
Auto-100M
Auto-1000M
Example
Example 1, query the LAN 1 port information of the ONU (having no management IP
address) with ONUID being aa_bbb_ccc_111_222. The ONU is connected to the
slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-ONULANINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-01 10:37:58
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of lan port info
Version: C 191
FiberHome Element Management System Northbound Interface (TL1) User Manual
-----------------------------------------------------------
AdminStatus OperStatus DUPLEX PVID VLANPRIORITY SPEED
UP DOWN -- 4088 0 --
-----------------------------------------------------------
Example 2, query the information of the LAN 1 port located in the No. 4 slot of the
ONU (having a management IP address) whose IP address is 10.250.18.121.
u Command
LST-ONULANINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
F FH_10.250.18.133 2010-11-02 10:33:09
M CTAG COMPLD
total_blocks=1
block_number=1
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 the ONU
LAN port.
Command Format
LST-LANCAR::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=lanport_index:CTAG::;
Supported Equipment
192 Version: C
6 Integrated Testing Interface
Input Parameter
ONU_NAME
ONU identifier type (ONU_ The ONU that has no
MAC
ONUIDTYPE OCTET STRING NAME, MAC, LOID, ONU_ management IP
LOID
NUMBER). address. Required.
ONU_NUMBER
Response Format
Version: C 193
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
Example 1, query the rate control information of the LAN 1 port of the ONU (having
no management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-LANCAR::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-01 10:40:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of LAN port rate-limit info
-----------------------------------------------
RateLimitUs RateLimitDs
1024 2048
-----------------------------------------------
Example 2, query the rate control information of the LAN 1 port located in the No. 4
slot of the ONU (having a management IP address) whose IP address is
10.250.18.121.
u Command
LST-LANCAR::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 10:33:28
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of LAN port rate-limit info
----------------------------------------
RateLimitUs RateLimitDs
194 Version: C
6 Integrated Testing Interface
64 1024
----------------------------------------
Related Command
None
Function Description
This command is used for querying the ETH performance of the OLT uplink port or
ONU LAN port.
Command Format
LST-LANPERF::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],PORTID=lanport_index:CTAG::;
Supported Equipment
Input Parameter
Version: C 195
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
196 Version: C
6 Integrated Testing Interface
Output Parameter
Parameter
Data Type Value Range Description Remark
Name
OutPkts DOUBLE 0 - 1.85E19 Number of sent packets. -
Example
Example 1, query the performance information of the No. 1 uplink port located in the
No. 29 slot of the OLT whose IP address is 10.250.18.102.
u Command
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
Version: C 197
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
LST-LANPERF::ONUIP=10.250.18.121,PORTID=NA-NA-4-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:44:54
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
List of Ethenet performance
-----------------------------------------------------------
OutPkts InPkts 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
198 Version: C
6 Integrated Testing Interface
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.
Command Format
TEST-PPPOESIMULATION::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=post_index:CTAG::ACTION=action-type,USERNAME=username,
PASSWORD=password[,VPI=vpi,VCI=vci][,UV=user vlan][,AUTHMODE=authmode]
[timeout=timeout];
Supported Equipment
Input Parameter
OCTET
OLTID Size (128) OLT IP address, name or ID. -
STRING
PON port information location. Locate
Size (128) The ONU that has
through cabinet rack - shelf - slot - PON
OCTET Cabinet rack - no management
PONID port number. Enter NA if the
STRING shelf - slot - PON IP address.
corresponding information is not
port number Required.
specified.
ONU_NAME
OCTET MAC ONU identifier type (ONU_NAME, MAC,
ONUIDTYPE -
STRING LOI LOID, ONU_NUMBER).
ONU_NUMBER
Version: C 199
FiberHome Element Management System Northbound Interface (TL1) User Manual
Optional. By
default, it is not
specified
UV INTEGER 1 to 4094 VLAN at user side
(simulating the
UNTAG
application).
AUTO
OCTET Optional. Default
AUTHMODE CHAP Dial-up authentication mode
STRING 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.
200 Version: C
6 Integrated Testing Interface
Output Parameter
Example
For example, conduct the outgoing call emulation test on the No. 1 POTS port of the
ONU (has no management IP address) with ONUID being aaa_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
TEST-PPPOESIMULATION::OLTID=10.171.0.16,PONID=NA-NA-1-1,ONUIDTYPE=MAC,
ONUID=FHTT03317368,ONUPORT=NA-NA-NA-1:CTAG::ACTION=Start,USERNAME=t,
PASSWORD=y;(Start testing)
TEST-PPPOESIMULATION::OLTID=10.171.0.16,PONID=NA-NA-1-1,ONUIDTYPE=MAC,
ONUID=FHTT03317368,ONUPORT=NA-NA-NA-1:CTAG::ACTION=Query,USERNAME=t,
PASSWORD=y;(query status)
u Response Message
FH_10.170.4.237 2015-12-25 09:52:06
M CTAG COMPLD
EN=0 ENDESC=No error
;
Version: C 201
FiberHome Element Management System Northbound Interface (TL1) User Manual
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::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;
Supported Equipment
202 Version: C
6 Integrated Testing Interface
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
OCTET IP address, name or ID of the ONU
ONUIP Size (128) -
STRING that has a management IP address.
ONU_NAME
The ONU that has
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE no management IP
STRING LOID MAC, LOID, ONU_NUMBER).
address. Required.
ONU_NUMBER
Response Format
Version: C 203
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
UP
OPERSTATUS String Running status
DOWN
UP
ADMINSTATUS String Administration status
DOWN
OCTET
TM See the The List of Parameters. Actual transfer mode.
STRING
OCTET Fast
LineType Line type.
STRING Interleaved
Fixed: Indicates fixed rate.
AutoAdaptAtStartup: Indicates
automatically adapting on
OCTET
AturRateMode startup. Atur rate adaptation mode.
STRING
AutoAdaptAtRunning: Indicates
automatically adapting during
running.
204 Version: C
6 Integrated Testing Interface
Example
For example, query the information of the No. 1 ADSL port located in the No. 3 slot
of the ONU whose IP address is 10.250.18.121.
u Command
LST-ADSLINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 13:54:42
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of adsl port info
-----------------------------------------------------------
OPERSTATUS ADMINSTATUS TM LineType AturRateMode
Version: C 205
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used for querying the ADSL link traffic and line real-time
information. Before using the command, ensure the ONU is online and the ADSL
port is enabled.
Command Format
LST-ADSLPERF::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;
Supported Equipment
206 Version: C
6 Integrated Testing Interface
Input Parameter
ONU_NAME
ONU identifier type (ONU_ The ONU that has no
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ management IP
STRING LOID
NUMBER). address. Required.
ONU_NUMBER
Response Format
Version: C 207
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Example
For example, query the information of the No. 1 ADSL port located in the No. 3 slot
of the ONU whose IP address is 10.250.18.121.
u Command
LST-ADSLPERF::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 13:54:51
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of adsl port performance
-----------------------------------------------------------
208 Version: C
6 Integrated Testing Interface
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,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
ONUIP OCTET STRING Size (128) ONU that has a management -
IP address.
The ONU that has
OLTID OCTET STRING Size (128) OLT IP address, name or ID. no management IP
address. Required.
Version: C 209
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
PON port information location.
Size (128) Locate through the approach of
The ONU that has
Cabinet rack - shelf cabinet rack - shelf - slot - PON
PONID OCTET STRING no management IP
- slot - PON port port number. Enter NA if the
address. Required.
number corresponding information is
not specified.
ONU_NAME
ONU identifier type (ONU_ The ONU that has
MAC
ONUIDTYPE OCTET STRING NAME, MAC, LOID, ONU_ no management IP
LOID
NUMBER). address. Required.
ONU_NUMBER
Response Format
Output Parameter
AtucPerfCurr15MinTimeE-
INTEGER 0 - 900 Elapsed time of the current 15 minutes.
lapsed
210 Version: C
6 Integrated Testing Interface
Curr1Day Inits INTEGER 0 - 2147483647 Initialization times over the current day.
AtucPerfPrev1DayTimeE-
INTEGER 0 - 86400 Elapsed time of the past day
lapsed
Prev1Day Inits INTEGER 0 - 2147483647 Initialization times over the past day.
Example
For example, query the performance statistics information over the current 15
minutes, the current day and the past day of the No. 1 ADSL port located in the No.
3 slot of the ONU whose IP address is 10.250.18.121.
u Command
LST-ADSLSTAT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 13:55:02
M CTAG COMPLD
total_blocks=1
block_number=1
Version: C 211
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
Function Description
This command is used for querying the status and configuration information of the
VDSL2 port.
Command Format
LST-VDSLINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;
Supported Equipment
212 Version: C
6 Integrated Testing Interface
Input Parameter
Response Format
Version: C 213
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
UP
AdminStatus OCTET STRING Administration status
DOWN
UP
OPERSTATUS String Running status
DOWN
Downlink pulse noise protection. Unit:
INPDS OCTET STRING 0 - 16, 0.5
symbol.
ATM
ChannelTMode OCTET STRING PTM Data channel mode of channel 1
BOTH
Maximum uplink rate of channel 1. Unit:
MAXRATEUS INTEGER -
kbps.
214 Version: C
6 Integrated Testing Interface
Example
For example, query the information of the No. 1 VDSL port located in the No. 1 slot
of the ONU whose IP address is 10.250.18.121.
u Command
LST-VDSLINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 13:55:14
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of vdsl port info
-----------------------------------------------------------
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
-----------------------------------------------------------
Related Command
None
Version: C 215
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying VDSL link traffic and line real-time information.
Command Format
LST-VDSLPERF::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=vdslport_num:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the ONU
OCTET
ONUIP Size (128) that has a management IP -
STRING
address.
The ONU that has
OCTET
OLTID Size (128) OLT IP address, name or ID. no management IP
STRING
address. Required.
ONU_NAME
The ONU that has
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE no management IP
STRING LOID MAC, LOID, ONU_NUMBER).
address. Required.
ONU_NUMBER
216 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for uniquely
identifying the ONU connected to The ONU that has
OCTET
ONUID Size (128) the PON port. The value is ONU_ no management IP
STRING
NAME, MAC, LOID or ONU_ address. Required.
NUMBER.
Locates the card through the
Size (128)
approach of cabinet rack - shelf -
OCTET Cabinet rack -
ONUPORT slot - port number. Enter NA if the -
STRING shelf - slot - port
corresponding information is not
number
specified.
Response Format
Output Parameter
Version: C 217
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
For example, query the information of the No. 1 VDSL port located in the No. 1 slot
of the ONU whose IP address is 10.250.18.121.
u Command
LST-VDSLPERF::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 13:55:22
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of vdsl port performance
-------------------------------------------------------
InOctets 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
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 as well as the past day.
218 Version: C
6 Integrated Testing Interface
Command Format
LST-VDSLSTAT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUID=onu_index],ONUPORT=vdslport_num:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management -
STRING
IP address.
The ONU that has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP
STRING
address. Required.
ONU_NAME
ONU identifier type (ONU_ The ONU that has no
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ management IP
STRING LOID
NUMBER). address. Required.
ONU_NUMBER
Version: C 219
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
xdsl2PMLCurr15MTimeE-
INTEGER 0 - 900 Elapsed time of the current 15 minutes.
lapsed
xdsl2PMLCurrInit15MFullI-
INTEGER 0 - 2147483647 Initialization times over the current 15 minutes.
nits
Curr15MinAtucEss INTEGER 0 - 900 Errored seconds over the current 15 minutes.
xdsl2PMLCurrInit15MFai-
INTEGER 0 - 2147483647 Initialization failures over the current 15 minutes.
ledFullInits
xdsl2PMLCurr1DayTimeE-
INTEGER 0 - 86400 Elapsed time of the current day.
lapsed
xdsl2PMLCurrInit1DayFullI-
INTEGER 0 - 2147483647 Initialization times over the current day.
nits
xdsl2PMLCurr1DayEs INTEGER 0 - 86400 Errored seconds over the current day.
xdsl2PMLCurr1DaySes INTEGER 0 - 86400 Severely errored seconds over the current day.
xdsl2PMLCurrInit1DayFai-
INTEGER 0 - 2147483647 Initialization failures over the current day.
ledFullInits
xdsl2PMLHist1DMonitored-
INTEGER 0 - 86400 Elapsed time of the past day
Time
xdsl2PMLHistinit1DFullInits INTEGER 0 - 2147483647 Initialization times over the past day.
xdsl2PMLHistinit1DFailed-
INTEGER 0 - 2147483647 Initialization failures over the past day.
FullInits
220 Version: C
6 Integrated Testing Interface
xdsl2PMLHist1DSes INTEGER 0 - 86400 Severely errored seconds over the past day.
Example
For example, query the performance statistics information over the current 15
minutes, the current day and the past day of the No. 1 VDSL port located in the No.
1 slot of the ONU whose IP address is 10.250.18.121.
u Command
LST-VDSLSTAT::ONUIP=10.250.18.121,ONUPORT=NA-NA-1-1:CTAG::;
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
Version: C 221
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
The command is used for conducting the single-ended loop test on the ADSL2+ /
VDSL2 port.
Command Format
SELT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=dslport_num:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of
OCTET
ONUIP Size (128) the ONU that has a -
STRING
management IP address.
222 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
The ONU that
uniquely identifying the
has no
OCTET ONU connected to the
ONUID Size (128) management
STRING PON port. The value is
IP address.
ONU_NAME, MAC, LOID
Required.
or ONU_NUMBER.
Response Format
Output Parameter
OCTET
LINE_LENGTH - Line length. Unit: m.
STRING
Open
LINE_STATUS String Status
Short
ATTAINABLE_
Integer - Attainable downlink rate (kbps).
XTUC_RATE
ATTAINABLE_
Integer - Attainable uplink rate (kbps).
XTUR_RATE
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
SELT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
Version: C 223
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 the ADSL2+ /
VDSL2 port.
Command Format
DELT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=dslport_num:CTAG::;
Supported Equipment
224 Version: C
6 Integrated Testing Interface
Input Parameter
Parame-
ter Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management -
STRING
IP address.
The ONU that
has no
OCTET
OLTID Size (128) OLT IP address, name or ID. management IP
STRING
address.
Required.
Response Format
Version: C 225
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Parameter
Data Type Value Range Description
Name
XTUC_DELT_ OCTET
Size (128) Uplink signal attenuation (dB).
SATN STRING
XTUR_DELT_ OCTET
Size (128) Downlink signal attenuation (dB).
SATN STRING
XTUC_DELT_ OCTET
Size (128) Uplink signal-to-noise ratio margin (dB)
SNRM STRING
XTUR_DELT_ OCTET Downlink signal-to-noise ratio margin
Size (128)
SNRM STRING (dB)
Example
For example, conduct the double-ended loop test on the No. 2 ADSL port located in
the No. 3 slot of the ONU whose IP address is 10.250.18.121.
u Command
DELT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-2:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 14:03:01
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
result of delt test
-----------------------------------------------------------
XTUC_DELT_SATN XTUR_DELT_SATN XTUC_DELT_SNRM XTUR_DELT_SNRM
0.00 0.00 0.00 0.00
-----------------------------------------------------------
Related Command
None
226 Version: C
6 Integrated Testing Interface
Function Description
This command is used for querying the PVC information of the ADSL port.
Command Format
LST-PVCINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=adslport_num:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of
OCTET
ONUIP Size (128) the ONU that has a -
STRING
management IP address.
The ONU
that has no
OCTET OLT IP address, name or
OLTID Size (128) management
STRING ID.
IP address.
Required.
The ONU
ONU_NAME
ONU identifier type (ONU_ that has no
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ management
STRING LOID
NUMBER). IP address.
ONU_NUMBER
Required.
Version: C 227
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for
The ONU
uniquely identifying the
that has no
OCTET ONU connected to the
ONUID Size (128) management
STRING PON port. The value is
IP address.
ONU_NAME, MAC, LOID
Required.
or ONU_NUMBER.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
PVCOPER- OCTET UP
PVC running status.
STATUS STRING DOWN
PVCADMIN- OCTET UP
PVC management status.
STATUS STRING DOWN
VPI INTEGER - VPI
VCI INTEGER - VCI
PVID INTEGER - VLAN ID
VLANPRIOR- OCTET
Integer (0 - 7) VLAN default priority level.
ITY STRING
Example
For example, query the PVC 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
228 Version: C
6 Integrated Testing Interface
LST-PVCINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 14:03:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=8
list of PVC info
-----------------------------------------------------------
PVCOPERSTATUS PVCADMINSTATUS VPI 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
The following introduces the command and example for querying the VLAN
information.
Function Description
Command Format
LST-VLANFWDINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport-location]
[,ONUIDTYPE=id-type,ONUID=onu-id],VLANID=svlan-id:CTAG::;
Version: C 229
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Gather statistics of the ONU uplink VLAN tag forwarding on OLT (the ONU has
no management IP address):
LST-VLANFWDINFO::OLTID=olt-name,PONID=ponport-location,
ONUIDTYPE=idtype,ONUID=onu-id,VLANID=svlan-id:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET IP address, name or ID of the ONU that
ONUIP Size (128)
STRING has a management IP address.
OCTET
OLTID Size (128) OLT IP address, name or ID.
STRING
PON port information location. Locate
Size (128)
through the approach of cabinet rack -
OCTET Cabinet rack -
PONID shelf - slot - PON port number. Enter NA if
STRING shelf - slot - PON
the corresponding information is not
port number
specified.
ONU_NAME
OCTET MAC ONU identifier type (ONU_NAME, MAC,
ONUIDTYPE
STRING LOID LOID, ONU_NUMBER).
ONU_NUMBER
230 Version: C
6 Integrated Testing Interface
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
0-
FramesUs DOUBLE Number of uplink messages.
2147483647
0-
FramesDs DOUBLE Number of downlink messages.
2147483647
0-
OctetsUs DOUBLE Number of uplink bytes.
2147483647
0-
OctetsDs DOUBLE Number of downlink bytes.
2147483647
Number of discarded uplink message.
DiscardsUs DOUBLE 0 - 1.85E19
Optional.
Example
Example 1, query the VLAN 321 forwarding information of the ONU (having no
management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-VLANFWDINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1,VLANID=321:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-28 12:01:50
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of VLAN forward info
-----------------------------------------------------------
FramesUs FramesDs OctetsUs OctetsDs DiscardsUs DiscardsDs
Version: C 231
FiberHome Element Management System Northbound Interface (TL1) User Manual
0 0 0 0 0 0
-----------------------------------------------------------
Example 2, query the VLAN 1 forwarding information of the PON port located in the
No. 4 slot of the ONU (having a management IP address) whose IP address is
10.250.18.121.
u Command
LST-VLANFWDINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1,VLANID=1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 10:37:30
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of VLAN forward info
-----------------------------------------------------------
FramesUs FramesDs OctetsUs OctetsDs DiscardsUs DiscardsDs
-- -- -- -- -- --
-----------------------------------------------------------
Related Command
None
The following introduces the command and example for querying the IPTV
information.
Function Description
Command Format
LST-IPTVCFG::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index][,ONUPORT=port_index][,UV=user-vlan]:
CTAG::;
232 Version: C
6 Integrated Testing Interface
Supported Equipment
Input Parameter
Parameter Value
Data Type Description Remark
Name Range
ONU_
The ONU that
NAME
ONU identifier type (ONU_ has no
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ management
STRING LOID
NUMBER). IP address.
ONU_
Required.
NUMBER
ONU identifier, used for
The ONU that
uniquely identifying the ONU
has no
OCTET connected to the PON port.
ONUID Size (128) management
STRING The value is ONU_NAME,
IP address.
MAC, LOID or ONU_
Required.
NUMBER.
Size (128) Locates the card through the
Cabinet rack approach of cabinet rack -
OCTET
ONUPORT - shelf - slot shelf - slot - port number. -
STRING
- port Enter NA if the corresponding
number information is not specified.
Version: C 233
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
INTE-
MVLAN - Multicast VLAN
GER
INTE- VLAN at user side. Optional (multicast service
VLANID -
GER VLAN accessed through a home gateway).
INTE-
VPI - VPI. Optional (DSL multicast service).
GER
INTE-
VCI - VCI. Optional (DSL multicast service).
GER
Example
u Command
LST-IPTVCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-28 11:58:45
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of IPTV configuration
-----------------------------------------------------------
MVLAN VLANID VPI VCI
321 123 -- --
-----------------------------------------------------------
234 Version: C
6 Integrated Testing Interface
Example 2, query the multicast user information of the No. 1 port located in the No.
4 slot of the ONU (having a management IP address) whose IP address is
10.250.18.121.
u Command
LST-IPTVCFG::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 10:33:57
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of IPTV configuration
-----------------------------------------------------------
MVLAN VLANID VPI VCI
2525 -- -- --
-----------------------------------------------------------
Related Command
None
The following introduces the command and example for querying the VoIP
information.
Function Description
This command is used for querying the voice quality statistics information of the
voice user.
Command Format
LST-VOIPINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT= pots_num:CTAG::;
Version: C 235
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Equipment
Input Parameter
ONU_NAME
ONU identifier type (ONU_ The ONU that has
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ no management IP
STRING LOID
NUMBER). address. Required.
ONU_NUMBER
Response Format
236 Version: C
6 Integrated Testing Interface
Output Parameter
Example
Example 1, query the quality statistics information of the No. 1 voice port of the ONU
(having no management IP address) with ONUID being aa_bbb_ccc_111_222. The
ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100.
u Command
LST-VOIPINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u 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
LST-VOIPINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
Version: C 237
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
None
Function Description
This command is used for querying the configuration information of the access
gateway interface.
Command Format
LST-MGCFG::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu-index][,MGID=mg-id]:CTAG::;
Supported Equipment
Input Parameter
238 Version: C
6 Integrated Testing Interface
ONU_NAME
ONU identifier type (ONU_ The ONU that has no
OCTET MAC
ONUIDTYPE NAME, MAC, LOID, ONU_ management IP
STRING LOID
NUMBER). address. Required.
ONU_NUMBER
Response Format
Output Parameter
Version: C 239
FiberHome Element Management System Northbound Interface (TL1) User Manual
IPMODE OCTET STRING Size (1 - 64) IP obtaining mode: DHCP, PPPOE, STATIC.
HEARTBEAT- Enabled
OCTET STRING Heartbeat mode.
MODE Disable
HEARTBEAT-
Integer 0 to 65535 Heartbeat cycle. Unit: s.
CYCLE
HEARTBEATNUM Integer 1 to 3 Number of detected heartbeats
Example
u Command
LST-MGCFG::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 14:45:56
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of MG port configuration
-----------------------------------------------------------
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
240 Version: C
6 Integrated Testing Interface
10.37.0.103 Enable 30 3
-----------------------------------------------------------
u Command
LST-MGCFG::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:52:03
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of MG port configuration
-----------------------------------------------------------
MGID PT 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
Function Description
This command is used for querying the running status of the access gateway
interface.
Command Format
LST-MGINFO::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu-index][,MGID=mg-id]:CTAG::;
Version: C 241
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Equipment
Input Parameter
ONU_NAME
The ONU that has
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE no management IP
STRING LOID MAC, LOID, ONU_NUMBER).
address. Required.
ONU_NUMBER
If it is not specified,
MG identifier, used for uniquely it indicates querying
MGID INTEGER 0 to 16 identifying the MG module on the the configurations of
ONU. Optional. all MG modules in
use.
Response Format
242 Version: C
6 Integrated Testing Interface
Output Parameter
MGID INTEGER 0 to 16 -
Registering Registering.
UP Registered successfully.
OCTET Fault IAD failure.
OperState
STRING Deregistered Logout
Restarting IAD restarting.
Other Others
Example
Example 1, query the status of the MGID 0 on 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
LST-MGINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,MGID=0:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 14:46:12
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of MG port info
-----------------------------------------------------------
MGID OperState
0 UP
-----------------------------------------------------------
Example 2, query the running status of the MG on the ONU (having a management
IP address) whose IP address is 10.250.18.121.
u Command
LST-MGINFO::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:52:14
M CTAG COMPLD
total_blocks=1
block_number=1
Version: C 243
FiberHome Element Management System Northbound Interface (TL1) User Manual
block_records=1
list of MG port info
-----------------------------------------------------------
MGID OperState
0 Fault
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for querying the fax parameter of the POTS port.
Command Format
LST-FAXINFO::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=pots_num:CTAG::;
Supported Equipment
Input Parameter
244 Version: C
6 Integrated Testing Interface
Response Format
Output Parameter
T30
FAXMODE String Fax mode
T38
Control mode
NONE
Voice channel
CONTROLMODE String SS
Full control
AUTOVBD
Auto-negotiation
Version: C 245
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, query the fax parameter of the ONU (having no management IP address)
with ONUID being aa_bbb_ccc_111_222. The ONU is connected to the slot 3 - PON
1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-FAXINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 14:46:39
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of ONU pots info
-----------------------------------------------------------
FAXMODE CONTROLMODE
T30 NONE
-----------------------------------------------------------
Example 2, query the fax parameter of the ONU (having a management IP address)
whose IP address is 10.250.18.121.
u Command
LST-FAXINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:52:25
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of ONU pots info
-----------------------------------------------------------
FAXMODE CONTROLMODE
T30 AUTOVBD
-----------------------------------------------------------
Related Command
None
246 Version: C
6 Integrated Testing Interface
Function Description
This command is used for querying the POTS port information, including the line
status, service status, impedance and gain.
Command Format
LST-POTSINFO::onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=pots_num:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has
OCTET no management
OLTID Size (128) OLT IP address, name or ID.
STRING IP address.
Required.
Version: C 247
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
ONU identifier, used for uniquely
The ONU that has
identifying the ONU connected to
OCTET no management
ONUID Size (128) the PON port. The value is ONU_
STRING IP address.
NAME, MAC, LOID or ONU_
Required.
NUMBER.
Locates the card through the
Size (128) approach of cabinet rack - shelf -
OCTET
ONUPORT Cabinet rack - shelf - slot - port number. Enter NA if the -
STRING
slot - port number corresponding information is not
specified.
Response Format
248 Version: C
6 Integrated Testing Interface
Output Parameter
Line status:
Registering
Registering port.
Idle
Port is idle.
Off-hook
Off-hook,
Dialing
Dialing.
Ringing
Ringing.
Ringing-back
LineState OCTET STRING Ring back.
Connecting
Connecting.
Connected
Connected.
Releasing
Releasing the connection.
Register-failed
Registering port failed.
Deactived
Port is not activated.
Other
Others.
Service status:
endLocal: The service is terminated by the local
EndLocal end due to the port disabled by the user.
EndRemote endRemote: The service is terminated by the far
ServiceState OCTET STRING
EndAuto end due to the command sent by MGC.
Normal 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 - 20
Unit: dB.
Send gain.
TxGain Float -20 - 20
Unit: dB.
PN OCTET STRING Size (1 - 32) SIP telephone number.
SIPUSERNAME OCTET STRING Size (1 - 32) Username corresponding to the SIP user port
SIPUSERPWD OCTET STRING Size (1 - 32) Password corresponding to the SIP user port
Version: C 249
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, query the No. 1 POTS port information of the ONU (having no
management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
LST-POTSINFO::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 14:47:14
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of pots info
-----------------------------------------------------------
LineState ServiceState EchoCancel ReversedPolarity
RxGain TxGain PN TID SIPUSERNAME SIPUSERPWD
Idle Normal Enable Enable 0 0 a1
-----------------------------------------------------------
Example 2, query the information of the No. 1 POTS port located in the No. 2 slot of
the ONU (having a management IP address) whose IP address is 10.250.18.121.
u Command
LST-POTSINFO::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:52:36
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of pots info
-----------------------------------------------------------
LineState ServiceState EchoCancel ReversedPolarity
RxGain TxGain PN TID SIPUSERNAME SIPUSERPWD
Register-failed EndAuto Enable Disable 0 0 --
-----------------------------------------------------------
Related Command
None
250 Version: C
6 Integrated Testing Interface
Function Description
This command is used for testing the outer line of the voice or DSL user to detect
whether line errors occur.
Command Format
MELT::ONUIP=onu_name|OLTID=olt_name[,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu_index],ONUPORT=fttbpost_index:CTAG::;
Supported Equipment
Input Parameter
Version: C 251
FiberHome Element Management System Northbound Interface (TL1) User Manual
Response Format
Output Parameter
T568A-pair-to-ground voltage.
ACAG INTEGER -
Unit: mV.
T568B-pair-to-ground AC voltage.
ACBG INTEGER -
Unit: mV.
T568A/T568B AC voltage.
ACAB INTEGER -
Unit: mV.
T568A-pair-to-ground DC voltage.
DCAG INTEGER -
Unit: mV.
T568B-pair-to-ground DC voltage.
DCBG INTEGER -
Unit: mV.
T568A/T568B DC voltage.
DCAB INTEGER -
Unit: mV.
T568A-pair-to-ground resistance.
RAG INTEGER -
Unit: ohm.
T568B-pair-to-ground resistance.
RBG INTEGER -
Unit: ohm.
T568A/T568B resistance.
RAB INTEGER -
Unit: ohm.
252 Version: C
6 Integrated Testing Interface
T568A-pair-to-ground capacitance.
CapAG INTEGER -
Unit: nF.
T568B-pair-to-ground capacitance.
CapBG INTEGER -
Unit: nF.
T568A/T568B capacitance.
CapAB INTEGER -
Unit: nF.
Example
Example 1, test the outer line of the No. 1 POTS port of the ONU (having no
management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
MELT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 14:52:26
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of outside line test
-----------------------------------------------------------
Conclusion ACAG ACBG ACAB 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 outer line of the No. 1 POTS 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
MELT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:53:59
M CTAG COMPLD
total_blocks=1
block_number=1
Version: C 253
FiberHome Element Management System Northbound Interface (TL1) User Manual
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
-----------------------------------------------------------
Related Command
None
Function Description
This command is used for testing the inner line of the voice or DSL user to detect
whether line errors occur.
Command Format
TEST-POTSCIRCUIT::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=fttbpost_index:CTAG::;
Supported Equipment
Input Parameter
254 Version: C
6 Integrated Testing Interface
ONU_NAME
The ONU that has
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE no management IP
STRING LOID MAC, LOID, ONU_NUMBER).
address. Required.
ONU_NUMBER
Response Format
Output Parameter
Normal
LoopCurrent OCTET STRING indicates whether the loop current is normal.
Abnormal
Normal
FeedV OCTET STRING Indicates whether the feed voltage is normal.
Abnormal
Normal
RingV OCTET STRING Indicates whether the ring voltage is normal.
Abnormal
Feed voltage
FeedVValue INTEGER -
Unit: mV.
Ring voltage
RingVValue INTEGER -
Unit: mV.
Loop current
LoopCurrentValue INTEGER -
Unit: mA.
Version: C 255
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
Example 1, test the inner line of the No. 1 POTS port of the ONU (having no
management IP address) with ONUID being aa_bbb_ccc_111_222. The ONU is
connected to the slot 3 - PON 1 port of the OLT whose IP address is 10.250.18.100.
u Command
TEST-POTSCIRCUIT::OLTID=10.250.18.100,PONID=NA-NA-3-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-10-27 14:52:52
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of pots inside line test
-----------------------------------------------------------
LoopCurrent FeedV RingV FeedVValue RingVValue LoopCurrentValue
Normal Normal Normal 48444 58557 18
-----------------------------------------------------------
Example 2, test the inner line of the No. 1 POTS 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
TEST-POTSCIRCUIT::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-02 09:55:02
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
list of pots inside line test
-----------------------------------------------------------
LoopCurrent FeedV RingV FeedVValue RingVValue LoopCurrentValue
Normal Normal Abnormal 39278 64314 22
-----------------------------------------------------------
Related Command
None
256 Version: C
6 Integrated Testing Interface
Function Description
This command is used for conducting the incoming call emulation test.
The incoming call emulation test simulates an incoming call during which a program
acts as the called party and automatically completes all the operations that should
be responded by the called party to the caller. The testing personnel will check
whether the ringing of the called party can be heard so as to verify whether the
called port is ringing and being called normally.
Note: If the system does not send the ending test command after a certain period of
time since the sending of the starting test command, the test will be automatically
ended.
Command Format
TEST-CALLEESIMULATION::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=pots_num:CTAG:: ACTION=action-type[,TIMEOUT=timeout];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address, name or ID of the
OCTET
ONUIP Size (128) ONU that has a management IP -
STRING
address.
The ONU that has
OCTET no management
OLTID Size (128) OLT IP address, name or ID.
STRING IP address.
Required.
Version: C 257
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
PON port information location.
Size (128) Locate through the approach of The ONU that has
OCTET Cabinet rack - shelf - cabinet rack - shelf - slot - PON no management
PONID
STRING slot - PON port port number. Enter NA if the IP address.
number corresponding information is not Required.
specified.
Returned status of
the call upon
query:
1. The port is idle.
Start: starting the test.
2. Off-hook.
OCTET Stop: ending the test.
ACTION Testing type. 3. Ringing.
STRING Query: querying the
4. Call connected.
test.
5. Busy tone.
6. On-hook.
7. Testing is
ended.
258 Version: C
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.
Output Parameter
1 Successful
2 Failed.
The call connection is
Conclusion INTEGER
established, but the testing These two
3
personnel has not confirmed the parameters are
call connection status. returned when
1 No signaling interaction. the input
The called party hooks off, but SS parameter
3 MG internal reason.
4 Others.
Example
Example 1, conduct the incoming call emulation test on the No. 1 POTS port on the
ONU (has no management IP address) with ONUID being aaa_bbb_ccc_111_222.
The ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100.
u Command
Version: C 259
FiberHome Element Management System Northbound Interface (TL1) User Manual
TEST-CALLEESIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Start,TIMEOUT=60;
TEST-CALLEESIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Stop,TIMEOUT=60;
u Response Message
FH_10.250.18.133 2010-10-27 14:54:09
M CTAG COMPLD
EN=0 ENDESC=No error
FH_10.250.18.133 2010-10-27 14:55:42
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
result of callin simulation
-----------------------------------------------------------
STATE Conclusion FailReason
6 2 1
-----------------------------------------------------------
Example 2, conduct the incoming call emulation test on the No. 1 POTS 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
TEST-CALLEESIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Start,TIMEOUT=60;
TEST-CALLEESIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CT AG::
ACTION=Stop,TIMEOUT=60;
u Response Message
FH_10.250.18.133 11/2/2010 15:11:04
M CTAG COMPLD
EN=0 ENDESC=No error
FH_10.250.18.133 11/2/2010 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
260 Version: C
6 Integrated Testing Interface
-----------------------------------------------------------
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
responded by the caller to the called party. After the call is connected, the testing
personnel will check whether the ringing of the caller can be heard so as to verify
whether the calling emulation port is ringing and calling normally.
Note: If the system does not send the 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-CALLERSIMULATION::ONUIP=onu_name|OLTID=olt_name[,
PONID=ponport_location,ONUIDTYPE=id-type,ONUID=onu_index],
ONUPORT=post_index:CTAG::ACTION=action-type,TEL=tel-number[,
TIMEOUT=timeout];
Supported Equipment
Version: C 261
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
ONU_NAME
ONU identifier type (ONU_
MAC
ONUIDTYPE OCTET STRING NAME, MAC, LOID, ONU_ -
LOID
NUMBER).
ONU_NUMBER
262 Version: C
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.
Output Parameter
Version: C 263
FiberHome Element Management System Northbound Interface (TL1) User Manual
8 Others.
Example
Example 1, conduct the outgoing call emulation test on the No. 1 POTS port of the
ONU (has no management IP address) with ONUID being aaa_bbb_ccc_111_222.
The ONU is connected to the slot 3 - PON 1 port of the OLT whose IP address is
10.250.18.100.
u Command
TEST-CALLERSIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Start,TEL=1110,TIMEOUT=60;
TEST-CALLERSIMULATION::OLTID=10.250.18.100,PONID=NA-NA-3-1,
ONUIDTYPE=LOID,ONUID=aaa_bbb_ccc_111_222,ONUPORT=NA-NA-NA-1:CTAG::
ACTION=Stop,TEL=1110,TIMEOUT=60;
u Response Message
FH_10.250.18.133 2010-10-27 14:56:53
M CTAG COMPLD
EN=0 ENDESC=No error
FH_10.250.18.133 2010-10-27 14:57:02
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
result of call out simulation
-----------------------------------------------------------
STATE DIALNUMBER TARGETNUMBER FAILEDSIG
Conclusion FailReason
10 1110 port_register_failed 2 8
-----------------------------------------------------------
264 Version: C
6 Integrated Testing Interface
Example 2, conduct the outgoing call emulation test on the No. 1 POTS 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
TEST-CALLERSIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Start,TEL=1110,TIMEOUT=60;
TEST-CALLERSIMULATION::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::
ACTION=Stop,TEL=1110,TIMEOUT=60;
u Response Message
FH_10.250.18.133 2010-11-02 15:11:27
M CTAG COMPLD
EN=0 ENDESC=No error
FH_10.250.18.133 2010-11-02 15:11:40
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
result of call out simulation
-----------------------------------------------------------
STATE DIALNUMBER TARGETNUMBER FAILEDSIG
Conclusion FailReason
10 1110 no response from ss 2 1
-----------------------------------------------------------
Related Command
None
The following introduces the command and example for querying the alarm
information.
Function Description
The command is used for querying the recovered / unrecovered alarms of the
specified NE.
Version: C 265
FiberHome Element Management System Northbound Interface (TL1) User Manual
Command Format
QUERY-ALARM::ONUIP=onu-name|OLTID=olt-name[,PONID=ponport_location][,
ONUIDTYPE=id-type,ONUID=onu-index]:CTAG::[BEGINTIME=begin-time][,
ENDTIME=end-time][,FAULTFLAG=flag];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
It is required when
querying the ONU
OCTET IP address, name or ID of the ONU
ONUIP Size (128) that has no
STRING that has a management IP address.
management IP
address.
It is required when
querying the ONU
OCTET
OLTID Size (128) OLT IP address, name or ID. that has no
STRING
management IP
address.
266 Version: C
6 Integrated Testing Interface
Parameter
Data Type Value Range Description Remark
Name
PON port information location. Locate It is required when
Size (128)
through the approach of cabinet rack - querying the ONU
OCTET Cabinet rack -
PONID shelf - slot - PON port number. Enter that has no
STRING shelf - slot - PON
NA if the corresponding information is management IP
port number
not specified. address.
It is required when
ONU_NAME
querying the ONU
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE that has no
STRING LOID MAC, LOID, ONU_NUMBER).
management IP
ONU_NUMBER
address.
It is required when
ONU identifier, used for uniquely
querying the ONU
OCTET identifying the ONU connected to the
ONUID Size (128) that has no
STRING PON port. The value is ONU_NAME,
management IP
MAC, LOID or ONU_NUMBER.
address.
Format of start time (Beijing time)
BEGINTIME String Size (32) Optional.
YYYY-MM-DD HH-MM-SS
Format of end time (Beijing time)
ENDTIME String Size (32) Optional.
YYYY-MM-DD HH-MM-SS
Alarm status. Default value: Fault-
Fault-Only Only.
FAULTFLAG STRING Optional.
ALL Fault-Only contains events and does
not contain recovered alarms.
Response Format
Output Parameter
Version: C 267
FiberHome Element Management System Northbound Interface (TL1) User Manual
RACK: rackid
The position that triggers the alarm.
SHELF: shelfid
RACK: rack
SLOT: slotid
SHELF: shelf
PORT: portid
SLOT: slot
ONUNUM:
PORT: port number
onunumber
ONUNUM: ONU number
POSITION String ONUNAME: Required.
ONUNAME: ONU name
onuname
ONUPORTTYPE: ONU port type
ONUPORTTYPE:
(LAN, E1, DSL, POTS and PON)
onuporttype
ONUPORT: ONU port number
ONUPORT:
EMUNUM: environment monitoring
onuportid
unit
EMUNUM: emunum
Critical
Major
SEVERITY String Alarm Level Required.
Minor
Warning
Fault
FaultFlag String Recovery Alarm status Required.
Event
Alarm generation time. Format:
HAPPENTIME String Size (0 - 32) Required.
YYYY-MM-DD HH:MM:SS.
Alarm recovery time. Format: YYYY-
RECOVERTIME String Size (0 - 32) Optional.
MM-DD HH:MM:SS.
communicationsA-
larm,
qualityOfServiceA-
larm,
ALARMTYPE String Alarm type. Required.
processingErrorA-
larm,
equipmentAlarm,
environmentalAlarm.
Additional information, describing
AditionalInfo String Size (0 - 256) additional information related to the Optional.
alarm.
Alarm code, corresponding to the
EVENT_CODE Integer - alarm name parameter Optional.
(ALARMDESC).
268 Version: C
6 Integrated Testing Interface
PROBABEL_
Integer - Alarm reason code. Optional.
CAUSE_CODE
PROPOSED_
String Size (0 - 512) Handling suggestion. Optional.
ADVISE
Example
u Command
QUERY-ALARM::OLTID=10.78.200.200,PONID=NA-NA-15-1,ONUIDTYPE=LOID,
ONUID=aaa_bbb_ccc_111_222:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-01 15:31:06
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=14
Alarm
-
SERIALID ALARMNAME DIP DNAME DTYPE POSITION
SEVERITY FaultFlag HAPPENTIME RECOVERTIME
ALARMTYPE ADITIONALINFO EVENT_CODE
PROBABLE_CAUSE_DESC
135 ONU H.248 broken link 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 H.248 broken link 99 ONU H.248 broken link 10.250.18.100
AN5006-04 AN5006-04
u Command
QUERY-ALARM::ONUIP=10.78.200.203:CTAG::;
Version: C 269
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Response Message
FH_10.250.18.133 2010-11-02 10:34:38
M CTAG COMPLD
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 H.248 broken link 10.250.18.121 system2 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 H.248 broken link3 Abnormal OLT card status 10.250.18.121 system2
AN5006-20 RACK:NA,SHELF:NA,SLOT:4 Critical Recovery
2010-11-01 11:06:42 2010-11-01 11:15:34 EquipmentAlarm --
110003 Abnormal OLT card status, including (running abnormally,
not activated, inconsistency between card and configured type.)4
Abnormal OLT card status 10.250.18.121 system2 AN5006-20
RACK:NA,SHELF:NA,SLOT:4 Critical Recovery 2010-11-01
15:11:06 2010-11-01 15:19:14 EquipmentAlarm -- 110003
Abnormal OLT card status, including (running abnormally, not activated,
inconsistency between card and configured type.)-
Related Command
None
270 Version: C
7 Integrated Query Interface
The following introduces the commands for physical resource query, service
resource query, resource change notification and resource file export.
Version: C 271
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
OTL equipment.
Command Format
LST-DEVICE::[OLTID=olt-name]:CTAG::;
Supported Equipment
Input Parameter
OLT IP address or
OLTID OCTET STRING Size (128)
name.
Response Format
Output Parameter
Equipment IP
DEVIP OCTET STRING Size (128)
address
DT OCTET STRING Size (255) Equipment model
272 Version: C
7 Integrated Query Interface
Example
For example, query the information of the OLT whose IP address is 10.250.18.100.
u Command
LST-DEVICE::OLTID=10.250.18.100:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:37:35
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
DEVNAME DEVIP DT DEVER
system1 10.250.18.100 AN5516_01 RP0121
-----------------------------------------------------------
Related Command
LST-DEVINFO
Function Description
This command is used for querying the information of a specified ONU or all ONUs
connected to the OLT.
Command Format
LST-ONU::ONUIP=onu-name|(OLTID=olt-name[,PONID=ponport_location[,
ONUIDTYPE=onuidtype,ONUID=onu-index]]):CTAG::;
Version: C 273
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-ONU::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuid-type,
ONUID=onuindex:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
IP address or name of
The ONU that has a
OCTET the ONU that has a
ONUIP Size (128) management IP
STRING management IP
address. Required.
address.
OLT or the ONU that
OCTET OLT IP address or
OLTID Size (128) has no management
STRING name.
IP address. Required.
Response Format
274 Version: C
7 Integrated Query Interface
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Locates the card through the
Size (128) approach of cabinet rack - shelf -
OCTET
PONID Cabinet rack - shelf - slot slot - port number. Enter NA if the
STRING
- port number corresponding information is not
specified.
Example
u Command
Version: C 275
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-ONU::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 11:06:08
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
OLTID PONID ONUNO 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
LST-ONU::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:53:54
M CTAG COMPLD
total_blocks=1
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
276 Version: C
7 Integrated Query Interface
Function Description
This command is used for querying the ONU hardware / software version
information.
Command Format
LST-ONUVERSION::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=id-
type,ONUID=onu-index:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that
IP address or name of
has a
OCTET the ONU that has a
ONUIP Size (128) management IP
STRING management IP
address.
address.
Required.
Version: C 277
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
The ONU that
ONU_NAME, MAC, has no
OCTET
ONUIDTYPE Size (128) LOID, ONU_ management IP
STRING
NUMBER. address.
Optional.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Locates the card through the
Size (128) approach of cabinet rack - shelf -
OCTET
PONID Cabinet rack - shelf - slot - port number. Enter NA if the
STRING
slot - port number corresponding information is not
specified.
278 Version: C
7 Integrated Query Interface
Example
For 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 the shelf
0 - slot 11 - PON 4 port of the OLT whose IP address is 10.78.200.200.
u Command
LST-ONUVERSION::OLTID=10.78.200.200,PONID=NA-NA-11-4,ONUIDTYPE=MAC,
ONUID=54-4B-70-03-FB-98:CTAG::;
u Response Message
FH_10.98.30.151 2014-07-07 14:32:20
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Related Command
None
Function Description
This command is used for querying the shelf information of a specified OLT, a
specified ONU or all sets of equipment in the entire network.
Command Format
LST-SHELF::[ONUIP=onu-name]|[OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]]:CTAG::;
u Query the shelf information of all sets of equipment in the entire network:
Version: C 279
FiberHome Element Management System Northbound Interface (TL1) User Manual
LST-SHELF:::CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
The ONU that
IP address or name of
has a
OCTET the ONU that has a
ONUIP Size (128) management IP
STRING management IP
address.
address.
Required.
280 Version: C
7 Integrated Query Interface
Parameter
Data Type Value Range Description Remark
Name
The ONU that
ONU_NAME, MAC, has no
ONUID- OCTET
Size (128) LOID, ONU_ management IP
TYPE STRING
NUMBER. address.
Required.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
When querying a single ONU, the input
parameter will be returned (when
OCTET querying all ONUs in the entire network,
ONUIP Size (128)
STRING the ONUIP will be returned if the ONUIP
exists; otherwise, the OLTID, PONID or
ONUID will be returned).
Version: C 281
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
Locates the shelf through the approach of
Size (128)
OCTET cabinet rack - shelf number. Enter NA if
SHELFID Cabinet rack -
STRING the corresponding information is not
shelf
specified.
SHELF- OCTET
Size (128) Shelf type.
TYPE STRING
Example
Example 1, query the information of all the shelves of the OLT whose IP address is
10.250.18.100.
u Command
LST-SHELF::OLTID=10.250.18.100:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:37:54
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID SHELFID SHELFTYPE
-- 10.250.18.100 -- -- NA-1 AN5116-06B
-----------------------------------------------------------
Example 2, query the information of all the shelves of the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u Command
LST-SHELF::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:54:02
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID SHELFID SHELFTYPE
10.250.18.121 10.250.18.100 NA-1-1-1 NA-1 AN5006-20
-----------------------------------------------------------
282 Version: C
7 Integrated Query Interface
Related Command
None
Function Description
This command is used for querying the shelf information of a specified OLT or a
specified ONU or all sets of equipment in the entire network.
Command Format
LST-BOARD::[ONUIP=onu-name]|[[OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index]][,BOARDID=BOARD_location]]:
CTAG::;
u Query the card information of all sets of equipment in the entire network:
LST-BOARD:::CTAG::;
u Query the card information of the ONU that has a management IP address:
LST-BOARD::ONUIP=onu-name[,BOARDID=BOARD_location]:CTAG::;
u Query the card information of the ONU that has no management IP address:
LST-BOARD::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index[,BOARDID=BOARD_location]:CTAG::;
Supported Equipment
Version: C 283
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parame-
Value
ter Data Type Description Remark
Range
Name
IP address or name of the ONU The ONU that has
OCTET
ONUIP Size (128) that has a management IP a management IP
STRING
address. address. Required.
Response Format
284 Version: C
7 Integrated Query Interface
Output Parameter
Version: C 285
FiberHome Element Management System Northbound Interface (TL1) User Manual
OCTET
SWVER Size (255) Software version
STRING
OCTET
HWVER Size (255) Hardware Version
STRING
Example
u Command
LST-BOARD::ONUIP=10.250.18.100:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:38:05
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=10
-----------------------------------------------------------
ONUIP OLTID PONID ONUID BOARDID BOARDTYPE 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
286 Version: C
7 Integrated Query Interface
-- --
-----------------------------------------------------------
Example 2, query the information of a card connected with the ONU (having a
management IP address) whose IP address is 10.250.18.121.
u Command
LST-BOARD::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:54:12
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=7
-----------------------------------------------------------
ONUIP OLTID PONID 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
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
Version: C 287
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Prerequisite
Command Format
LST-ONUDISTANCE::OLTID=olt-name:CTAG::;
Supported Equipment
Input Parameter
Response Format
Output Parameter
Parame- Value
Data Type Parameter Description
ter Range
288 Version: C
7 Integrated Query Interface
Parame- Value
Data Type Parameter Description
ter Range
OCTET
MAC Size (128) The registered MAC information of the ONU.
STRING
OCTET When the MAC authentication is adopted, a dash – will
LOID Size (128)
STRING be returned.
OCTET LOID password. If no password is specified, a dash –
PWD Size (128)
STRING will be returned.
Optical fiber length (i.e. the ONU distance value). The
Length DOUBLE 0 to 100
unit is km.
Example
Example 1: query the distance value of all the ONUs on the OLT with the IP address
of 10.250.18.100.
u Command
LST-ONUDISTANCE::OLTID=10.190.42.3:CTAG::;
u Response Message
FH_10.170.162.23 2017-02-17 10:35:34
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=2
list of onu distance
--------------------------------------------------------------
OLTID PONID ONUNO NAME MAC LOID PWD Length
10.190.42.3 1-1-4-1 1 -- -- -- -- 0.000
10.190.42.3 1-1-14-1 3 PON[1]-AN5506-07-A1[3] FHTT0002010f -- -- 0.000
--------------------------------------------------------------
The following introduces the command and example for querying service resources.
Version: C 289
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying the media gateway information of a specified set
of equipment.
Command Format
LST-MG::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=idtype,ONUID=onu-index):CTAG::;
Supported Equipment
Input Parameter
Parameter Value
Data Type Description Remark
Name Range
290 Version: C
7 Integrated Query Interface
Parameter Value
Data Type Description Remark
Name Range
Response Format
Output Parameter
Parameter Value
Data Type Description
Name Range
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
OCTET Cabinet rack
PONID The input parameter will be returned.
STRING - shelf - slot -
port number
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
MG identifier, used for uniquely identifying the
MGID INTEGER 0 - 16
MG module on the ONU.
OCTET
PT Size (32) Voice protocol type (H.248, SIP)
STRING
OCTET
SIPREGDM Size (64) SIP register server
STRING
VLAN INTEGER 0 - 4095 Voice VLAN
Version: C 291
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter Value
Data Type Description
Name Range
OCTET
IPMODE Size (64) IP obtaining mode: DHCP, PPPOE, STATIC.
STRING
IPAD- OCTET
Size (64) IP address
DRESS STRING
OCTET
IPMASK Size (64) IP address mask
STRING
IPGATE- OCTET
Size (64) Gateway address
WAY STRING
OCTET
MGCIP1 Size (64) IP address of the active softswitch
STRING
OCTET
MGCIP2 Size (64) IP address of the standby softswitch
STRING
Example
u Command
LST-MG::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 11:06:36
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID 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
-----------------------------------------------------------
292 Version: C
7 Integrated Query Interface
u Command
LST-MG::ONUIP=10.250.18.121:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:54:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID 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 set of
equipment.
Command Format
LST-POTS::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;
Supported Equipment
Version: C 293
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter Value
Data Type Description Remark
Name Range
Response Format
294 Version: C
7 Integrated Query Interface
Output Parameter
Para-
meter Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
OCTET Cabinet rack -
PONID The input parameter will be returned.
STRING shelf - slot -
port number
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
Size (128)
Locates card port through the approach of cabinet
ONU- OCTET Cabinet rack -
rack - shelf - slot - port number. NA is displayed if no
PORT STRING shelf - slot -
information is located.
port number
Example
Example 1, query the POTS 1 port information of the ONU (having no management
IP address) with ONUID being whdx04. The ONU is connected to the shelf 0 - slot
4- port 1 of the OLT whose IP address is 10.250.18.102.
Version: C 295
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
LST-POTS::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 11:06:46
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-------------------------------------------------------
ONUIP OLTID PONID ONUID ONUPORT MGID TID PN
SIPUSERNAME SIPUSERPWD FAXMODE CONTROLMODE
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1
0 a1 a1 T30 AUTOVBD
--------------------------------------------------------
Example 2, query the POTS 1 port information on the shelf 0 - slot 2 - port 1 of the
ONU whose IP address is 10.250.18.121.
u Command
LST-POTS::ONUIP=10.250.18.121,ONUPORT=NA-NA-2-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:54:32
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID ONUPORT MGID TID PN
SIPUSERNAME SIPUSERPWD FAXMODE CONTROLMODE
10.250.18.121 -- -- -- NA-NA-2-1 0
-- --
-----------------------------------------------------------
Related Command
LST-POTSINF
LST-POTSINFO
296 Version: C
7 Integrated Query Interface
Function Description
This command is used for querying the multicast service information of a specified
set of equipment. It the query result is null, a null list will be returned.
Command Format
LST-IPTV::ONUIP=onu-name|(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;
u Query the multicast service information of the ONU that has a management IP
address:
LST-IPTV::ONUIP=onu-name[,ONUPORT=onu-port]:CTAG::;
u Query the multicast service information of the ONU that has no management IP
address:
LST-IPTV::(OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;
Supported Equipment
Input Parameter
Para-
Value
meter Data Type Description Remark
Range
Name
IP address or name of the ONU The ONU that has a
OCTET
ONUIP Size (128) that has a management IP management IP
STRING
address. address. Required.
Version: C 297
FiberHome Element Management System Northbound Interface (TL1) User Manual
Para-
Value
meter Data Type Description Remark
Range
Name
The ONU that has
ONUID- OCTET ONU_NAME, MAC, LOID,
Size (128) no management IP
TYPE STRING ONU_NUMBER.
address. Required.
Response Format
Output Parameter
Parame-
Data Type Value Range Description
ter Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
OCTET Cabinet rack -
PONID The input parameter will be returned.
STRING shelf - slot - port
number
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
Size (128)
Locates card port through the approach of
ONU- OCTET Cabinet rack -
cabinet rack - shelf - slot - port number. NA is
PORT STRING shelf - slot - port
displayed if no information is located.
number
MVLAN INTEGER 0 - 4095 Multicast VLAN.
VPI INTEGER 0 - 65535 VPI. Optional (DSL multicast service).
298 Version: C
7 Integrated Query Interface
Parame-
Data Type Value Range Description
ter Name
VLAN at user side. Optional (multicast service
UV INTEGER 0 - 4095
VLAN accessed through a home gateway).
Example
u Command
LST-IPTV::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 11:06:56
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID ONUPORT MVLAN VPI VCI UV
FLMODE MAXGRP
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1 432
-- -- 123 -- --
-----------------------------------------------------------
u Command
LST-IPTV::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:54:41
M CTAG COMPLD
total_blocks=1
Version: C 299
FiberHome Element Management System Northbound Interface (TL1) User Manual
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.
Command Format
LST-LANPORT::ONUIP=onu-name|(OLTID=olt-name[,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index])[,PORTID=port_index]:CTAG::;
u Query the LAN port information of the ONU that has a management IP address:
LST-LANPORT::ONUIP=onu-name[,PORTID=port_index]:CTAG::;
u Query the LAN port information of the ONU that has no management IP
address:
LST-LANPORT::OLTID=olt-name,PONID=ponport_location,ONUIDTYPE=onuidtype,
ONUID=onu-index[,PORTID=port_index]:CTAG::;
Supported Equipment
300 Version: C
7 Integrated Query Interface
Input Parameter
Parameter Value
Data Type Description Remark
Name Range
Response Format
Version: C 301
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Parameter Value
Data Type Description
Name Range
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
Cabinet rack
OCTET
PONID - shelf - slot The input parameter will be returned.
STRING
- port
number
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
Size (128)
Cabinet rack Locates card port through the approach of cabinet
OCTET
PORTID - shelf - slot rack - shelf - slot - port number. NA is displayed if
STRING
- port no information is located.
number
ADMINSTA- OCTET 1. UP
Management status.
TUS STRING 2. DOWN
3. Full
4. Half
OCTET
DUPLEX 5. Auto Working mode
STRING
6. Auto-Full
7. Auto-Half
Auto
10M
100M
SPEED INTEGER 1000M Port rate.
Auto-10M
Auto-100M
Auto-1000M
RateLimitUs INTEGER 0 - 1000000 Uplink rate control. Unit: kbps.
Example
Example 1, query the Ethernet port information of the ONU (having no management
IP address) with ONUID being whdx04. The ONU is connected to the shelf 0 - slot
4- PON 1 port of the OLT whose IP address is 10.250.18.102.
302 Version: C
7 Integrated Query Interface
u Command
LST-LANPORT::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 11:07: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.
u Command
LST-LANPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:55:00
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID PORTID ADMINSTATUS DUPLEX SPEED
RateLimitUs RateLimitDs
10.250.18.121 -- -- -- NA-NA-4-1 -- -- --
-- --
-----------------------------------------------------------
Related Command
None
Version: C 303
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for querying the DSL port information of a specified set of
equipment.
Command Format
LST-DSLPORT::ONUIP=onu-name|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::;
At present, the FiberHome equipment only supports the command of the following
format:
LST-DSLPORT::ONUIP=onu-name[,ONUPORT=onu-port]:CTAG::;
Supported Equipment
Input Parameter
304 Version: C
7 Integrated Query Interface
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
OCTET Cabinet rack -
PONID The input parameter will be returned.
STRING shelf - slot -
port number
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
Size (128)
Locates card port through the approach of cabinet
OCTET Cabinet rack -
ONUPORT rack - shelf - slot - port number. NA is displayed if
STRING shelf - slot -
no information is located.
port number
ADMINSTA- UP
STRING Management status.
TUS DOWN
Version: C 305
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
For example, query the information of the No. 2 DSL port located in the No. 3 slot of
the ONU whose IP address is 10.250.18.121.
u Command
LST-DSLPORT::ONUIP=10.250.18.121,ONUPORT=NA-NA-3-2:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:54:50
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID 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::ONUIP=onu-name|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::;
u Query the port VLAN information of the ONU that has a management IP
address:
LST-PORTVLAN::ONUIP=onu-name[,ONUPORT=onu-port]:CTAG::;
u Query the port VLAN information of the ONU that has no management IP
address:
LST-PORTVLAN::(OLTID=olt-name,PONID=ponport_location,
ONUIDTYPE=onuidtype,ONUID=onu-index)[,ONUPORT=onu-port]:CTAG::;
306 Version: C
7 Integrated Query Interface
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET IP address or name of the ONU that has a
ONUIP Size (128)
STRING management IP address.
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Size (128)
PON port information location. Locate through
Cabinet rack -
OCTET the approach of cabinet rack - shelf - slot - port
PONID shelf - slot -
STRING number. Enter NA if the corresponding
PON port
information is not specified.
number
ONUID- OCTET ONU identifier type (ONU_NAME, MAC, LOID,
Size (128)
TYPE STRING ONU_NUMBER).
Size (128)
Locates through the approach of cabinet rack -
OCTET Cabinet rack -
ONUPORT shelf - slot - port number. Enter NA if the
STRING shelf - slot -
corresponding information is not specified.
port number
Response Format
Version: C 307
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
OCTET Cabinet rack -
PONID The input parameter will be returned.
STRING shelf - slot -
port number
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
Size (128)
Locates card port through the approach of
OCTET Cabinet rack -
ONUPORT cabinet rack - shelf - slot - port number. NA is
STRING shelf - slot -
displayed if no information is located.
port number
Example
Example 1, query the VLAN information of the No. 1 port on the ONU (having no
management IP address) with ONUID being whdx04. The ONU is connected to the
shelf 0 - slot 4- PON 1 port of the OLT whose IP address is 10.250.18.102.
u Command
LST-PORTVLAN::OLTID=10.250.18.102,PONID=NA-NA-4-1,ONUIDTYPE=LOID,
ONUID=whdx04,ONUPORT=NA-NA-NA-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 11:07:15
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=2
-----------------------------------------------------------
ONUIP OLTID PONID ONUID ONUPORT SVLAN CVLAN VPI VCI
308 Version: C
7 Integrated Query Interface
UV
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1 --
123 -- -- 123
-- 10.250.18.102 NA-1-4-1 whdx04 NA-NA-NA-1 --
-- -- -- --
-----------------------------------------------------------
Example 2, query the service port information of the LAN 1 port on the ONU (having
a management IP address) whose IP address is 10.250.18.121. The ONU is
connected to the shelf 0 - slot 4 - port 1 of the OLT.
u Command
LST-PORTVLAN::ONUIP=10.250.18.121,ONUPORT=NA-NA-4-1:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:55:10
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-----------------------------------------------------------
ONUIP OLTID PONID ONUID ONUPORT SVLAN CVLAN VPI VCI
UV
10.250.18.121 -- -- -- NA-NA-4-1 569 -- --
-- --
-----------------------------------------------------------
Related Command
None
Function Description
Command Format
LST-VLAN::ONUIP=onu-name|OLTID=olt-name:CTAG::[VLAN=vlanid];
Version: C 309
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET IP address or name of the ONU that has a
ONUIP Size (128)
STRING management IP address.
OCTET
OLTID Size (128) OLT IP address or name.
STRING
VLAN INTEGER 0 - 4094 VLANID
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
VLAN INTEGER 0 - 4094 VLANID
OCTET
DESC Size (128) VLAN alias
STRING
COMMON
VLAN- OCTET
STACKING VLAN attribute.
MODE STRING
QINQ
Cabinet rack -
OCTET
PORTLIST shelf - slot - port Port list.
STRING
number
0: Non-multicast
MVLAN- VLAN Indicates whether it is a multicast VLAN or
INTEGER
FLAG 1: Multicast non-multicast VLAN.
VLAN
310 Version: C
7 Integrated Query Interface
Parameter
Data Type Value Range Description
Name
MVLANPRI INTEGER 0-7 Priority level of the IGMP message.
HSI (Internet
OCTET access)
SERVICE Service type of the VLAN
STRING IPTV (unicast)
VOIP (voice)
Example
For 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
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 --
Version: C 311
FiberHome Element Management System Northbound Interface (TL1) User Manual
-- 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
-- 10.78.200.200 4015 -- -- -- 0 0 IPTV
-- 10.78.200.200 4016 -- -- -- 0 0 IPTV
-- 10.78.200.200 4017 -- -- -- 0 0 IPTV
-- 10.78.200.200 4018 -- -- -- 0 0 IPTV
-- 10.78.200.200 4019 -- -- -- 0 0 IPTV
-- 10.78.200.200 4020 -- -- -- 0 0 IPTV
-------------------------------------------------
;
---------
Related Command
None
Function Description
This command is used for querying the broadband and voice services configured on
a specified ONU.
Command Format
LST-ONUSERVICESTATUS::ONUIP=onu-name|OLTID=oltname,
PONID=ponport_location,ONUIDTYPE=onuid-type,ONUID=onu-index:CTAG::;
312 Version: C
7 Integrated Query Interface
Supported Equipment
Input Parameter
Parame-
Value
ter Data Type Description
Range
Name
OCTET IP address or name of the ONU that has a
ONUIP Size (128)
STRING management IP address.
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Size (128)
PON port information location. Locate through the
Cabinet
OCTET approach of cabinet rack - shelf - slot - PON port
PONID rack - shelf -
STRING number. Enter NA if the corresponding information is
slot - PON
not specified.
port number
ONUID- OCTET
Size (128) ONU_NAME, MAC, LOID, ONU_NUMBER
TYPE STRING
ONU identifier. The value is ONU_NAME, MAC, LOID
OCTET
ONUID Size (128) or ONU_NUMBER. It is used for uniquely identifying
STRING
the ONU connected to the PON port.
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Size (128)
OCTET Cabinet rack -
PONID The input parameter will be returned.
STRING shelf - slot -
port number
Version: C 313
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
OCTET
ONUID Size (128) The input parameter will be returned.
STRING
DATASER-
INTEGER 0 - 24 Number of broadband services
VICE
VOICESER-
INTEGER 0 - 24 Number of voice services
VICE
Example
For example, query the port service information of the ONU (having no
management IP address) with ONUID being FHTT01e821a0. The ONU is
connected to the shelf 0 - slot 7 - PON 4 port of the OLT whose IP address is
10.78.200.200.
u Command
LST-ONUSERVICESTATUS::OLTID=10.78.200.200,PONID=NA-NA-7-4,
ONUIDTYPE=MAC,ONUID=FHTT01e821a0:CTAG::;
u Response Message
FH_10.78.12.155 2014-07-15 18:54:10
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
-------------------------------------------------------
Related Command
None
314 Version: C
7 Integrated Query Interface
Function Description
Command Format
LST-SERVICEPORT::OLTID=olt-name:CTAG::[VLAN=cvlan,][SVLAN=svlan,]
[PORTTYPE=porttype];
Supported Equipment
u OLT: AN5116-06B.
Input Parameter
Parame- Value
Data Type Parameter Description Remark
ter Range
OCTET
OLTID Size (128) OLT IP address or name. Required.
STRING
CVLAN INTEGER 0 to 4095 Inner VLAN. Optional
Port Type
PORT- OCTET FXS: voice user port Optional. The default value
Size (128)
TYPE STRING LAN: data user port is FXS.
ALL: all user ports
Response Format
Version: C 315
FiberHome Element Management System Northbound Interface (TL1) User Manual
Output Parameter
Parame-
Data Type Value Range Parameter Description Remark
ter
OCTET
OLTID Size (128) OLT IP address or name. Required.
STRING
Size (128) PON port information location.
Cabinet rack Locate through cabinet rack -
OCTET
PONID - shelf - slot - shelf - slot - PON port number. Required.
STRING
PON port Enter NA if the corresponding
number information is not specified.
Required.
The port number
should be the
ONU- sequence number
INTEGER 0 to 512 ONU port number
PORT on the ONU
numbered
according to the
pot type.
Required. "–" is
allowed for single
SVLAN INTEGER 0 to 4095 Outer VLAN. VLAN
configuration
scenario.
Port Type
PORT- OCTET
Size (128) FXS: voice port Required.
TYPE STRING
LAN: data port
Example
For example,
Command
LST-SERVICEPORT::OLTID=172.29.215.4:CTAG::VLAN=3333;
Response Message
316 Version: C
7 Integrated Query Interface
total_blocks=1
block_number=1
block_records=3
Related Command
None
Function Description
Command Format
LST-PORTPVCFLOWPOLICY::ONUIP=|(OLTID=oltname,PONID=ponport_location,
ONUIDTYPE=onuid-type,ONUID=onu-index)[,ONUPORT=onuport]:CTAG::;
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET IP address or name of the ONU that has a
ONUIP Size (128)
STRING management IP address.
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Size (128)
PON port information location. Locate through
Cabinet rack -
OCTET the approach of cabinet rack - shelf - slot - port
PONID shelf - slot -
STRING number. Enter NA if the corresponding
PON port
information is not specified.
number
Version: C 317
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
ONUID- OCTET ONU identifier type (ONU_NAME, MAC, LOID,
Size (128)
TYPE STRING ONU_NUMBER).
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
VLAN INTEGER 0 - 4094 VLANID
OCTET
DESC Size (128) VLAN alias
STRING
COMMON
VLAN- OCTET
STACKING VLAN attribute.
MODE STRING
QINQ
Cabinet rack -
OCTET
PORTLIST shelf - slot - port Port list.
STRING
number
318 Version: C
7 Integrated Query Interface
Parameter
Data Type Value Range Description
Name
0: Non-multicast
MVLAN- Indicates whether it is a multicast VLAN or
INTEGER VLAN
FLAG non-multicast VLAN.
1: Multicast VLAN
MVLANPRI INTEGER 0-7 Priority level of the IGMP message.
HSI (Internet
OCTET access)
SERVICE Service type of the VLAN
STRING IPTV (unicast)
VOIP (voice)
Example
For example,
u Command
LST-PORTPVCFLOWPOLICY::ONUIP=172.28.148.58,ONUPORT=1-1-2-63:CTAG::;
u Response Message
Related Command
None
Version: C 319
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
Command Format
RTRV-TEMPLATE-ALL::ONUIP=onu-name|OLTID=olt-name:CTAG::;
Supported Equipment
Input Parameter
Parameter Value
Data Type Description
Name Range
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
Example
For example,
u Command
320 Version: C
7 Integrated Query Interface
RTRV-TEMPLATE-ALL::ONUIP=172.28.148.58:CTAG::;
u Response Message
FH_10.62.165.42 2015-03-19 01:58:44
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=48
--------------------------------------------------------------------------------
TEMPLATENAME DOWNMAXBW UPMAXBW CHANNELMODE
NULL 0 0 0
P_03584_1024 3584 1024 0
P_05120_1280 5120 1280 0
P_05632_1024 5632 1024 0
P_07168_1280 7168 1280 0
P_07680_1536 7680 1536 0
P_100M_50M 102400 51200 0
P_1024_256 1024 256 0
P_1024_512 1024 512 0
P_10M_2M 10240 2048 0
.....
Related Command
None
Function Description
This command is used for querying the port template information of a specified
device.
Command Format
RTRV-TEMPLATE-PORT::ONUIP=onu-name|(OLTID=oltname,
PONID=ponport_location,ONUIDTYPE=onuid-type,ONUID=onu-index)[,
ONUPORT=onuport]:CTAG::;
Version: C 321
FiberHome Element Management System Northbound Interface (TL1) User Manual
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description
Name
OCTET IP address or name of the ONU that has a
ONUIP Size (128)
STRING management IP address.
OCTET
OLTID Size (128) OLT IP address or name.
STRING
Size (128)
PON port information location. Locate through
Cabinet rack -
OCTET the approach of cabinet rack - shelf - slot -
PONID shelf - slot -
STRING port number. Enter NA if the corresponding
PON port
information is not specified.
number
ONUID- OCTET ONU identifier type (ONU_NAME, MAC,
Size (128)
TYPE STRING LOID, ONU_NUMBER).
Response Format
322 Version: C
7 Integrated Query Interface
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
ONUIP Size (128) The input parameter will be returned.
STRING
OCTET
OLTID Size (128) The input parameter will be returned.
STRING
VLAN INTEGER 0 - 4094 VLANID
OCTET
DESC Size (128) VLAN alias
STRING
COMMON
OCTET
VLANMODE STACKING VLAN attribute.
STRING
QINQ
OCTET Cabinet rack - shelf
PORTLIST Port list.
STRING - slot - port number
0: Non-multicast
Indicates whether it is a multicast VLAN
MVLANFLAG INTEGER VLAN
or non-multicast VLAN.
1: Multicast VLAN
MVLANPRI INTEGER 0-7 Priority level of the IGMP message.
HSI (Internet
OCTET access)
SERVICE Service type of the VLAN
STRING IPTV (unicast)
VOIP (voice)
Example
Command
RTRV-TEMPLATE-PORT::ONUIP=172.28.148.55,ONUPORT=1-1-2-4:CTAG::;
Response Message
--------------------------------------------------------------------------------
TEMPLATENAME DOWNMAXBW UPMAXBW CHANNELMODE
Version: C 323
FiberHome Element Management System Northbound Interface (TL1) User Manual
Related Command
ADD-FLOWPOLICY
LST-POTSINFO
The following introduces the command and example for resource change
notification.
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 (equipment,
subracks, cards, etc.) to the OSS automatically.
Command Format
SUBSCRIBE:::CTAG::FLAG=flag;
Supported Equipment
Input Parameter
Parameter Value
Data Type Description
Name Range
324 Version: C
7 Integrated Query Interface
Response Format
Output Parameter
None
Example
For example, register the resource change notification for the current user.
u Command
SUBSCRIBE:::CTAG::FLAG=RES;
u Response Message
FH_10.250.18.133 2010-11-04 11:45:19
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
UNSUBSCRIBE
Function Description
Command Format
UNSUBSCRIBE:::CTAG::FLAG=flag;
Supported Equipment
Version: C 325
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter Value
Data Type Description
Name Range
Response Format
Output Parameter
None
Example
u Command
UNSUBSCRIBE:::CTAG::FLAG=RES;
u Response Message
FH_10.250.18.133 2010-11-04 11:44:11
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];
326 Version: C
7 Integrated Query Interface
Supported Equipment
Input Parameter
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
HAPPEN- OCTET Resource change time. Format: YYYY-MM-DD
Size (128)
TIME STRING HH:MM:SS.
ADD
OCTET
MARK DEL Resource change reason.
STRING
MOD
OLT
OCTET ONU
OBJECT Resource object type.
STRING SHELF
BOARD
Resource change information. See the Resource
OCTET
INFO Size (512) Change Notification for the format of returned
STRING
information.
Example
u Command
Version: C 327
FiberHome Element Management System Northbound Interface (TL1) User Manual
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 ONUIP=10.250.18.121
OLTID=0.0.0.0 PONID=-- ONUID=0 BOARDID=2-1-4
BOARDTYPE=ETH BSERVICE=ETH PNUM=16 SWVER=-- HWVER=--
2010-11-01 11:15:34 ADD BOARD ONUIP=10.250.18.121
OLTID=0.0.0.0 PONID=-- ONUID=0 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 ONUNO=1 NAME=AN5006-10B DESC=-- ONUTYPE=AN5006-10B
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 ONUNO=2 NAME=AN5006-04 DESC=-- ONUTYPE=AN5006-04
IP=0.0.0.0 AUTH=LOID MAC=544b400c79a8 LOID=whdx04
PWD=-- SWVER=--
-----------------------------------------------------------
Related Command
SUBSCRIBE
Function Description
The resource change notification interface reports the notification messages upon
adding / modifying / deleting a set of equipment, adding / modifying / deleting a shelf
as well as adding / modifying / deleting a card.
328 Version: C
7 Integrated Query Interface
Command Format
None
Supported Equipment
Input Parameter
None
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
DEVNAME Size (128) Equipment name
STRING
OCTET
DEVIP Size (128) Equipment IP address
STRING
OCTET
DT Size (255) Equipment model
STRING
OCTET
DEVER Size (255) Software version
STRING
Version: C 329
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter Value
Data Type Description
Name Range
OCTET
OLTID Size (128) OLT IP address.
STRING
Size (128)
Locates the card through the approach of cabinet
OCTET Cabinet rack
PONID rack - shelf - slot - port number. Enter NA if the
STRING - shelf - slot -
corresponding information is not specified.
port number
OCTET
NAME Size (128) ONU name
STRING
OCTET
DESC Size (128) ONU description information.
STRING
OCTET
ONUTYPE SWVER ONU type
STRING
OCTET
IP Size (128) The management IP address of the ONU.
STRING
MAC
OCTET Authentication mode. When no authentication
AUTH LOID
STRING mode is specified, a dash (–) will be returned.
HYBRID
OCTET
MAC Size (128) The registered MAC information of the ONU.
STRING
OCTET
SWVER Size (128) Software version
STRING
Parameter
Data Type Value Range Description
Name
IP address of the ONU. When the ONU has no
OCTET
ONUIP Size (128) management IP address, the OLTID, PONID
STRING
and ONUID will be reported.
OCTET
OLTID Size (128) OLT IP address.
STRING
330 Version: C
7 Integrated Query Interface
Parameter
Data Type Value Range Description
Name
Size (128) Locates the card through the approach of
OCTET Cabinet rack - cabinet rack - shelf - slot - port number. Enter
PONID
STRING shelf - slot - NA if the corresponding information is not
port number specified.
OCTET
ONUID Size (128) ONU authorization code
STRING
OCTET
SHELFTYPE Size (128) Shelf type.
STRING
Parameter
Data Type Value Range Description
Name
IP address of the ONU. When the ONU
OCTET has no management IP address, the
ONUIP Size (128)
STRING OLTID, PONID and ONUID will be
reported.
OCTET
OLTID Size (128) OLT IP address.
STRING
Locates the card through the approach
Size (128)
OCTET of cabinet rack - shelf - slot - port
PONID Cabinet rack - shelf
STRING number. Enter NA if the corresponding
- slot - port number
information is not specified.
OCTET
ONUID Size (128) ONU authorization code
STRING
Locates the card through the approach
Size (128) of cabinet rack - shelf - slot. Enter NA if
OCTET
BOARDID Cabinet rack - shelf the corresponding information is not
STRING
- slot specified. To only specify the shelf
number, enter it in format of NA-0-NA.
BOARD- OCTET
Size (128) Card Type
TYPE STRING
Version: C 331
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description
Name
Power
ETH
ADSL
VDSL
POTS
OCTET
BSERVICE E1 Card service type.
STRING
GPON
EPON
Control (main
control unit)
Other
OCTET
SWVER Size (255) Software version
STRING
OCTET
HWVER Size (255) Hardware Version
STRING
Example
Example 1, when the equipment with the IP address being 10.78.11.102 is added,
the corresponding resource change notification will be received.
u Command
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
None
u Response Message
FH_10.98.11.77 2011-02-21 10:35:42
A 9 REPT RES ADD_ONU
332 Version: C
7 Integrated Query Interface
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
None
u Response Message
FH_10.98.11.77 2011-02-21 10:32:07
A 3 REPT RES ADD_SHELF
ONUIP=0.0.0.0 OLTID=10.78.11.102 PONID=- ONUID=0 SHELFID=9-1
SHELFTYPE=AN5116-06B_NODE
Example 4, when a card is added in the No. 9 slot of the OLT whose IP address is
10.78.11.102, the corresponding resource change notification will be received.
u Command
None
u Response Message
FH_10.98.11.77 2011-02-21 10:27:17
A 1 REPT RES ADD_BOARD
ONUIP=0.0.0.0 OLTID=10.78.11.102 PONID=-- ONUID=-- 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.
Version: C 333
FiberHome Element Management System Northbound Interface (TL1) User Manual
Function Description
This command is used for exporting the equipment information and service
configuration information in the entire network to an XML file. The file is named in
format of DUMP_RES_YYYY-MM-DD-HH-MM-SS.xml.
Command Format
DUMP-RESOURCEINFO:::CTAG::[RESTYPE=resource-type];
Supported Equipment
Input Parameter
Parameter Value
Data Type Description Remark
Name Range
Resource type.
PHY PHY: equipment information Optional.
OCTET
RESTYPE SRV SRV: service configurations Default value:
STRING
ALL ALL: all equipment information ALL.
and service configurations
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
OCTET
FILENAME Size (128) File name.
STRING
OCTET Success
RESULT Export result.
STRING Failure
334 Version: C
7 Integrated Query Interface
Example
For 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
DUMP-RESOURCEINFO:::CTAG::;
u Response Message
FH_10.98.11.77 2010-11-21 09:48:21
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
dump resource info
-----------------------------------------------------------
FILENAME
DUMP_RES_2010-11-21-09-48-21.xml
-----------------------------------------------------------
Related Command
SUBSCRIBE
DUMP-RESOURCEINFO
Function Description
It indicates the message notifying the export result of the reported data files.
Command Format
None
Supported Equipment
Version: C 335
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
None
Response Format
Output Parameter
Parameter
Data Type Value Range Description
Name
FILENAME OCTET STRING Size (128) File name.
Success
RESULT OCTET STRING Export result.
Failure
Example
u Command
None
u Response Message
FH_10.98.11.77 2010-11-21 09:48:58
A -- REPT RES DUMP_FILE
FILENAME=DUMP_RES_2010-11-21-09-48-21.xml RESULT=Success
Related Command
DUMPRE-RESNOTIFY
336 Version: C
8 Integrated Alarm Interface
The following introduces the commands for subscribing to the alarm, setting alarm
filter conditions, obtaining alarms, confirming alarms and clearing alarms.
Version: C 337
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::;
Supported Equipment
Input Parameter
None
Response Format
Output Parameter
None
Example
u Command
SUBSCRIBE:::CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 09:50:30
M CTAG COMPLD
EN=0 ENDESC=No error
338 Version: C
8 Integrated Alarm Interface
Related Command
None
Note:
Command Format
ACT-ALARM-FILTER:::CTAG::;
Supported Equipment
Input Parameter
None
Response Format
Output Parameter
Success or failure.
Version: C 339
FiberHome Element Management System Northbound Interface (TL1) User Manual
Example
u Command
ACT-ALARM-FILTER:::CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 10:31:47
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
DACT-ALARM-FILTER
Command Format
DACT-ALARM-FILTER:::CTAG::;
Supported Equipment
Input Parameter
None
Response Format
340 Version: C
8 Integrated Alarm Interface
Output Parameter
None
Example
u Command
DACT-ALARM-FILTER:::CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 9:50:38
M CTAG COMPLD
EN=0 ENDESC=No error
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];
Supported Equipment
Version: C 341
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Parameter Data
Value Range Parameter Description
Name Type
Critical
Alarm level. Multiple alarm levels can be
Major
SEVERITY String configured and should be separated by vertical
Minor
bars.
Warning
Response Format
Output Parameter
Success or failure.
Example
For example, modify the alarm filter conditions to only query and subscribe to the
alarm whose ID is 310009.
u Command
CHG-ALARM-FILTER:::CTAG:: ALARMID=310009;
u Response Message
FH_10.250.18.133 2010-11-04 09:50:47
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
ACT-ALARM-FILTER
342 Version: C
8 Integrated Alarm Interface
This command is used for viewing the current alarm filter conditions.
Command Format
LST-ALARM-FILTER:::CTAG::;
Supported Equipment
Input Parameter
None
Response Format
Output Parameter
True
ENABLE String Enable / Disable.
false
Critical
Major Alarm level. Multiple alarm levels can be configured
SEVERITY String
Minor and should be separated by vertical bars.
Warning
ALARM- Size (0 - Alarm ID. Multiple alarm IDs can be configured and
String
CODE 1000) should be separated by vertical bars.
Example
Version: C 343
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
LST-ALARM-FILTER:::CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 09:51:00
M CTAG COMPLD
total_blocks=1
block_number=1
block_records=1
Alarm Filter
ENABLE SEVERITY ALARMCODE
false - 310009
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::[ONUIP=onu-name]|([OLTID=olt-name][,PONID=ponport_location,
ONUIDTYPE=id-type,ONUID=onu-index]):CTAG::BEGINTIME=begin-time[,
ENDTIME=end-time][,FAULTFLAG=flag];
344 Version: C
8 Integrated Alarm Interface
LST-ALARM::OLTID=olt-name,PONID=ponport_location:CTAG::BEGINTIME=begin-
time[,ENDTIME=end-time][,FAULTFLAG=flag];
u Query all:
LST-ALARM:::CTAG::BEGINTIME=begin-time[,ENDTIME=end-time][,
FAULTFLAG=flag];
Supported Equipment
Input Parameter
Parameter
Data Type Value Range Description Remark
Name
It is required when
querying the ONU
OCTET IP address, name or ID of the ONU that
ONUIP Size (128) that has no
STRING has a management IP address.
management IP
address.
It is required when
querying the OLT or
OCTET
OLTID Size (128) OLT IP address, name or ID. the ONU that has
STRING
no management IP
address.
It is required when
Size (128) PON port information location. Locating
querying the ONU
OCTET Cabinet rack - through the approach of cabinet rack -
PONID that has no
STRING shelf - slot - PON shelf - slot - PON port number. NA is
management IP
port number displayed if no information is located.
address.
It is required when
ONU_NAME
querying the ONU
OCTET MAC ONU identifier type (ONU_NAME,
ONUIDTYPE that has no
STRING LOID MAC, LOID, ONU_NUMBER).
management IP
ONU_NUMBER
address.
Version: C 345
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Range Description Remark
Name
It is required when
ONU identifier, used for uniquely
querying the ONU
OCTET identifying the ONU connected to the
ONUID Size (128) that has no
STRING PON port. The value is ONU_NAME,
management IP
MAC, LOID or ONU_NUMBER.
address.
The format of start time (Beijing time):
BEGINTIME String Size (32) Required.
YYYY-MM-DD HH-MM-SS.
The format of end time (Beijing time):
ENDTIME String Size (32) Optional.
YYYY-MM-DD HH-MM-SS.
Alarm status. Default value is Fault-
Fault-Only Only.
FAULTFLAG STRING Optional.
ALL Fault-Only contains events and does
not contain recovered alarms.
Response Format
Output Parameter
Parameter Required /
Data Type Value Range Description
Name Optional
346 Version: C
8 Integrated Alarm Interface
Parameter Required /
Data Type Value Range Description
Name Optional
RACK: rackid
SHELF: shelfid The position that triggers the alarm.
SLOT: slotid RACK: rack
PORT: portid SHELF: shelf
ONUNUM: SLOT: slot
onunumber PORT: port number
ONUNAME: ONUNUM: ONU number
POSITION String onuname Required. ONUNAME: ONU name
ONUPORT- ONUPORTTYPE: ONU port type (LAN,
TYPE: E1, DSL, POTS and PON)
onuporttype ONUPORT: ONU port number
ONUPORT: EMUNUM: environment monitoring unit
onuportid AUTHINFO: ONU authentication
EMUNUM: information (MAC or LOID)
emunum
Critical
Major
SEVERITY String Required. Alarm Level
Minor
Warning
Fault
FaultFlag String Recovery Required. Alarm status
Event
Alarm generation time. Format: YYYY-
HAPPENTIME String Size (0 - 32) Required.
MM-DD HH:MM:SS.
RECOVER- Alarm recovery time. Format: YYYY-MM-
String Size (0 - 32) Optional.
TIME DD HH:MM:SS.
communication-
sAlarm,
qualityOfServi-
ceAlarm,
processingError-
ALARMTYPE String Required. Alarm type.
Alarm,
equipmentAlarm
and
environmentalA-
larm.
Additional information, describing
AditionalInfo String Size (0 - 256) Optional. additional information related to the
alarm.
Version: C 347
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter Required /
Data Type Value Range Description
Name Optional
PROBABLE_
CAUSE String Size (0 - 256) Optional. Alarm reason.
_DESC
PROBABEL_
Integer - Optional. Alarm reason code.
CAUSE_CODE
PROPOSED_
String Size (0 - 512) Optional. Handling suggestion.
ADVISE
Example
For example, query all the alarms and events occurred after 2014-09-09 00:00:00
(for the response messages, only some of them are listed as as example).
u Command
LST-ALARM:::CTAG::BEGINTIME=2010-12-28 01-00-00,FAULTFLAG=ALL;
u Response Message
FH_10.250.18.133 2010-11-04 09:51:13
M CTAG COMPLD
total_blocks=2
block_number=1
block_records=3
Alarm
-
SERIALID ALARMNAME DIP DNAME DTYPE POSITION
SEVERITY FaultFlag HAPPENTIME RECOVERTIME
ALARMTYPE ADITIONALINFO EVENT_CODE
PROBABLE_CAUSE_DESC
135 ONU H.248 broken link 10.250.18.100 system1 AN5516_01
RACK:NA,SHELF:NA,SLOT:3,PORT:1,ONUNUM:5,ONUNAME:AN5006-04
Critical Faul2010-11-01 14:51:51 --
CommunicationAlarm -- 320001 ONU H.248 broken link
6 OLT PON pot has no optical signal 10.250.18.100 AN5006-04[1] system1
RACK:NA,SHELF:NA,SLOT:3,PORT:1,ONUNUM:1,ONUNAME:AN5006-04[1]
Critical Recovery 2010-10-28 15:02:17 2010-11-03
00:15:39 CommunicationAlarm -- 310004 (1)Backbone fiber breaks
348 Version: C
8 Integrated Alarm Interface
Related Command
CHG-ALARM-FILTER
ACT-ALARM-FILTER
Command Format
ACK-ALARM::ALARMID=alarm-ID:CTAG::;
Supported Equipment
Input Parameter
Parameter Value
Data Type Description
Name Range
Response Format
Output Parameter
Success or failure.
Example
Version: C 349
FiberHome Element Management System Northbound Interface (TL1) User Manual
u Command
ACK-ALARM::ALARMID=95:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 09:50:30
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
UNACK-ALARM
Command Format
UNACK-ALARM:: SERIALID=SERIAL-ID:CTAG::;
Supported Equipment
Input Parameter
Parameter Value
Data Type Description
Name Range
Response Format
350 Version: C
8 Integrated Alarm Interface
Output Parameter
Success or failure.
Example
For example, cancel the confirmation performed on the alarm whose ID is 12429.
u Command
UNACK-ALARM::SERIALID=12429:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 09:50:30
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
ACK-ALARM
This command is used for deleting alarms manually when the alarms cannot be
automatically cleared or they are confirmed no longer existing on the NE.
Prerequisite
Make sure the failure resulting in the alarm is eliminated before executing the
command.
Command Format
Supported Equipment
Version: C 351
FiberHome Element Management System Northbound Interface (TL1) User Manual
Input Parameter
Response Format
Output Parameter
Success or failure.
Example
u Command
CLR-ALARM::SERIALID=107:CTAG::;
u Response Message
FH_10.250.18.133 2010-11-04 9:53:29
M CTAG COMPLD
EN=0 ENDESC=No error
Related Command
None
352 Version: C
9 Common Error Codes
Error
Error Code Meaning
Type
IRC
(ONUID/O-
Resource conflict. The specific conflicting items are shown in
NUNO/NA- INPUT
parenthesis.
ME/PWD/SV-
LAN/CVLAN)
Operating the EMS failed, possibly because the user has not
SEOF SYSTEM
logged in.
EXCEP-
EEEH EMS abnormal.
TION
TUB TEST The user is busy.
Version: C 353
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.
354 Version: C
10 The List of Parameters
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)
Version: C 355
FiberHome Element Management System Northbound Interface (TL1) User Manual
Parameter
Data Type Value Description
Name
7 G.992.1 TCM-ISDN non-overlapped
356 Version: C
10 The List of Parameters
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
Version: C 357
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.
358 Version: C
11 The List of Alarms
Version: C 359
FiberHome Element Management System Northbound Interface (TL1) User Manual
360 Version: C
11 The List of Alarms
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
Version: C 361
FiberHome Element Management System Northbound Interface (TL1) User Manual
362 Version: C
11 The List of Alarms
Version: C 363
12 Abbreviations
IPTV IP Television
OAM Operation, Administration & Maintenance
364 Version: C
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
[email protected]