Web Service Interface Function Description

Web Service Interface Function
Description
1 Create an Onu ................................................................................................................................ 4
1.1 AddVlan .............................................................................................................................. 4
1.2 GetUnRegOnuInfo .............................................................................................................. 5
1.3 AddOnu ............................................................................................................................... 6
1.4 AddWanService ................................................................................................................... 7
1.5 AddWifiService ................................................................................................................. 11
1.6 AddVoiceService ............................................................................................................... 14
1.7 AddOnuBandwidth............................................................................................................ 16
1.8 AddPonVlan ...................................................................................................................... 17
2 Onu BW profile modification ...................................................................................................... 19
2.1 DelPonVlan ....................................................................................................................... 19
2.2 AddPonVlan ...................................................................................................................... 20
2.3 AddOnuBandwidth............................................................................................................ 20
3 Delete an Onu .............................................................................................................................. 22
3.1 DelPonVlan ....................................................................................................................... 22
3.2 DelOnu .............................................................................................................................. 23
4 Activate Onu Services .................................................................................................................. 24
4.1 ActivateWanService .......................................................................................................... 24
4.2 ActivateVoicePort.............................................................................................................. 24
5 Deactivate Onu Services .............................................................................................................. 26
5.1 DeactivateWanService ...................................................................................................... 26
5.2 DeactivateVoicePort .......................................................................................................... 26
6 Reset Onu ..................................................................................................................................... 28
6.1 ResetOnu ........................................................................................................................... 28
7 Onu Inventory .............................................................................................................................. 29
7.1 GetOnuRunningState ........................................................................................................ 29
8 Onu BW Profile Inventory ........................................................................................................... 31
8.1 GetOnuBandWidth ............................................................................................................ 31
9 Other functions............................................................................................................................. 33
9.1 DelVlan ............................................................................................................................. 33
9.2 DelVoiceService ................................................................................................................ 33
9.3 GetOnuList ........................................................................................................................ 34
9.4 GetOnuStatus .................................................................................................................... 35
9.5 GetOnuRttValue ................................................................................................................ 37
9.6 GetOnuOMDDM .............................................................................................................. 38
9.7 GetOnuLanPortInfo .......................................................................................................... 39
9.10 GetOnuWifiStatus ........................................................................................................... 41
9.11 GetOnuVoiceServiceStatus ............................................................................................. 43
9.12 GetOnuMacTable ............................................................................................................ 45
9.13 SetOnuDhcpServerInfo ................................................................................................... 46
9.14 GetOnuDhcpServerInfo .................................................................................................. 48
9.15 ReplaceFaultyOnu ........................................................................................................... 49
9.16 CfgOnuLanService.......................................................................................................... 50
9.17 CfgGponServiceBandWidth............................................................................................ 52
9.18 ModifyWanBindProfile ................................................................................................... 53
9.19 Activate Port.................................................................................................................... 54
9.20 DeactivatePort ................................................................................................................. 55
1 Create an Onu
This action is used to add a Onu to the Olt, provision the Internet and
VoIP service, bind a vlan translation profile and the BW profile
contracted by the client.
1.1 AddVlan
Function name in xml: AddVlan
Function Description:
This command is used for creating a VLAN on Olt. It’s optional in
creating an ONU.
Input Parameter:
Attributes Type Description Remark
strOltIp OCTET STRING OLT IP address, name. Mandatory
nVlanid INTEGER VLANID（Range:1~4085） Mandatory
strServiceName OCTET STRING Service Name Optional
strPortList OCTET STRING a list of uplink ports that 1、Mandatory
allows the VLAN to pass 2、It can be a list
through of uplink ports,
eparated
by vertical
bars,for example,
NA-
0-19-0| NA-0-19-
1| NA-0-20-0.
TagFlag OCTET STRING untag 1、Mandatory

tag 2、The same
uplink port cannot
belong to multiple
VLANs in untag.
Service Type OCTET STRING HSI 1 、 The service
IPTV type
VOIP corresponding to
the VLAN.
2、Optional
3、Default:HSI
Output Parameter:
No Output for this function is needed.
1.2 GetUnRegOnuInfo
Function name in xml: GetUnRegOnuInfo
This command is used for querying the unauthorized ONU .
Input Parameter:
nSlotNo INTEGER Slot no. Mandatory
nPonNo INTEGER Port no. Mandatory
Output Parameter:
Parameter Name Type Description Remark
strOltIp OCTET STRING OLT IP address
nSlotNo INTEGER Slot no.
nPonNo INTEGER Port no
strMac OCTET STRING MAC
strLoid OCTET STRING LOID
strPsw OCTET STRING PASSWORD
strErrorInfo OCTET STRING Conflict、Unauth
strOnuType OCTET STRING Onu type
1.3 AddOnu
Function name in xml: AddOnu
This command is used for adding an ONU on the optical line terminal
(OLT).
Input Parameter:
strOnuIDType OCTET STRING ONU identifier type (MAC, 1、Mandatory
LOID,).
2、Default:MAC
stOnuId OCTET STRING ONU identifier, used for Mandatory
uniquely identifying the ONU
connected to the PON port.
The value is MAC, LOID or
ONU_NUMBER.
strOnuType OCTET STRING ONU type Mandatory
strOnuName OCTET STRING ONU Name Mandatory
iOnuNumber INTEGER ONU NO. Mandatory
Output Parameter:
1.4 AddWanService
Function name in xml: SetWanService
This command is used for configuring WAN connections for the ONU
authorized by OLT.
Input Parameter:
strOnuIDType OCTET STRING ONU identifier type (MAC, Mandatory
LOID,). Default:MAC
ONU_NUMBER.
strPortList OCTET STRING FE port. Value range is 1 – Mandatory
4,indicates all LAN ports. Default:1|2|3|4|10
Only one of the three
parameters UPORT, SSID and 1
WANSVC can be configured.
1|2|101
1:lan1
2:lan2
101:SSID1
102:SSID2...
nStatus INTEGER 1: adding; 2: deleting. Mandatory

nMode INTEGER WAN connection mode: Mandatory
1-TR069，
2-INTERNET,
3-TR069 INTERNET,
4-Other
5-multicast,
6-VOIP,
7-VOIP_INTERNET,
8-IPTV,
9-RADIUS,
10-RADIUS_INTERNET
nConnType INTEGER WAN connection type: 1 Mandatory

-bridge; 2 - route
nVlan INTEGER VLAN ID of the WAN Mandatory
connection. Default:50
Range:0-4085
nCos INTEGER VLAN COS of the WAN Mandatory
connection.
Range:1-7
nQosEnable INTEGER Indicates whether to enable Mandatory
the QoS function. 1: enable; Default:2
2:disable.
nNatEnable INTEGER Indicates whether to enable Mandatory
NAT. 1: enable; 2: disable.
nIpMode INTEGER IP obtaining mode of the Mandatory
WAN connection. 1: DHCP;
2:STATIC; 3: PPPOE.
strWanIp OCTET STRING Static IP of the WAN
connection. It must be a valid
IP address, in format of dotted
decimal notation. This
parameter is valid only
whenIPMODE is set to
STATIC.
strWanMask OCTET STRING Subnet mask of the WAN
STATIC.
strWanGateway OCTET STRING Default gateway of the WAN
parameter is valid only when
IPMODE is set to STATIC.
strMasterDns OCTET STRING Primary DNS of the WAN
parameter is valid only when
IPMODE is set to STATIC.
strSlaveDns OCTET STRING Secondary DNS of the WAN
STATIC.
iPPPOE_Proxy INTEGER 1enable， The field id valid
2disable when nIpMode is
PPPOE.Otherwise
invalid is null.
strPPPOE_Userna OCTET STRING The field id valid
me when nIpMode is
PPPOE.Otherwise
invalid is null.
strPPPOE_Passwo OCTET STRING The field id valid
rd when nIpMode is
PPPOE.Otherwise
invalid is null.
strPPPOE_NAME OCTET STRING The field id valid
when nIpMode is
PPPOE.Otherwise
invalid is null.
iPPPOE_MODE INTEGER 1：Auto connect 1、default: 1
2：connect when have payload 2 、 The field id
valid when
nIpMode is
PPPOE.Otherwise
invalid is null.
strUpProfile OCTET STRING Up bandwidth profile; Optional
This parament is valid when
WAN connection mode is
1：INTERNET
2：TR069_INTERNET
5：VOIP_INTERNET
strDownProfile OCTET STRING Down bandwidth profile Optional
This parament is valid whne
WAN connection mode is
1：INTERNET
2：TR069_INTERNET
5：VOIP_INTERNET
Output Parameter:
1.5 AddWifiService
Function name in xml: AddWifiService
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.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
iArea INTEGER Wireless area Mandatory
0 - Europe Default: 1
1 - USA
iStandard INTEGER 802.11b, 802.11g, 802. Mandatory
11b/g, 802.11n, 802.11bgn Default:802.11bg
n
iChannal INTEGER If wireless area is set to 0, the Mandatory
value range of Default:0
this parameter is [0, 13];if
wireless area is set to1, the
value range of this parameter
is [0, 11].
iTpower INTEGER Launched power Mandatory
Range:[20,200] Must be a
multiple of 20
Default:200
iWorkingFrequenc INTEGER 0: 2.4 Ghz Mandatory

y 1:5 Ghz Default: 0
iWifiSwitch INTEGER 0:disable Mandatory
1:enable Default: 1
iFrequencyBandwi INTEGER 0：20/40MHz Mandatory
dth 1：20MHz Default: 0
2: 40MHz
3: 80MHZ
iSsidNo INTEGER SSID index Mandatory
Default:1
strSsidName OCTET STRING SSID name Mandatory
iSsidEnable INTEGER Indicates whether to enable or Mandatory
not. 0indicates Disable and Default:1
1indicates Enable.
iSsidVisibale INTEGER Indicates whether tohide Mandatory
SSID. Default:0
0: unhide (Available) 1:hide
(Not Available)
iAuthMode OCTET STRING 1：OPEN Mandatory
2：SHARED Default:WPAPSK
3：WEPAUTO
4：WPAPSK /WPA2PSK
5：WPA
6：WPA2PSK
7：WPA2
8：WPA/WPA2
9：WPAPSK/WPA2PSK
10：WAIPSK
11：WAI
iEncrypType OCTET STRING NONE, WEP, TKIP,AES, Mandatory
TKIPAES Default:TKIPAES
strPresharedKey OCTET STRING WPA pre-shared key,range is Mandatory
between 8 and 63.
iUpdateKeyInterva INTEGER WPA key update interval Mandatory
l Unit: second Default:86400
strRadiusServer OCTET STRING RADIUS server The field is Valid
when iAuthMode
is WPA、WPA2、
WPA/WPA2
strRadiusPort OCTET STRING RADIUS server port The field is valid
when iAuthMode
is WPA、WPA2、
WPA/WPA2
strRadiusKey OCTET STRING RADIUS-KEY The field is valid
when iAuthMode
is WPA、WPA2、
WPA/WPA2
iEncryptionLevel INTEGER WEP key length The field is valid
1: 40 bit when
2: 104 bit
iEncrypType is
wep
iKeyIndex INTEGER Key index The field is valid
when
iEncrypType is
wep
strWepKey1 OCTET STRING WEP key 1 The field is valid
when
iEncrypType is
wep
when
iEncrypType is
wep
when
iEncrypType is
wep
when
iEncrypType is
wep
strWAPIASAddres OCTET STRING The field is valid
s when iAuthMode
is WAI
iWAPIASAddress INTEGER The field is valid
Port when iAuthMode
is WAI
iConnectionCount INTEGER Default:0
Output Parameter:
1.6 AddVoiceService
Function name in xml: AddVoiceService
The command is used for adding the voice service of a VoIP port.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
iPort INTEGER Mandatory
iPT INTEGER H.248、SIP Mandatory
Default:SIP
strPhoneNumber OCTET STRING 1、Optional
2、SIP
Mandatory
strUserName OCTET STRING 1、Optional
2、Mandatory
when iPT is SIP
strPassWord OCTET STRING 1、Optional
2、Mandatory
when iPT is SIP
strDomainUser OCTET STRING 1、Optional
2、Mandatory
when iPT is
H.248
strDomainName OCTET STRING 1、Optional
2、Mandatory
when iPT is
H.248
iIPMode OCTET STRING DHCP、PPPOE、STATIC Mandatory
strSIPREGDM OCTET STRING Optional
isvlan INTEGER SVLAN Mandatory
Default: -1
isvlancos INTEGER SVLAN COS Mandatory
Default: -1
icvlan INTEGER CVLAN 1 、 Range:0 ～
4095
2、default:51
3、Mandatory
icvlancos INTEGER CVLAN COS Mandatory
Default: -1
strIPMask OCTET STRING IPMask 1、Optional
2 、 Mandatory
when IPMode is
STATIC
strGateway OCTET STRING GateWay 1、Optional
2 、 Mandatory
when IPMode is
STATIC
strIPAddress OCTET STRING IPAddress 1、Optional
2 、 Mandatory
when IPMode is
STATIC
strPPPoeUser OCTET STRING PPPoeUser 1、Optional
2 、 Mandatory
when IPMode is
PPPOE
strPPPoePswd OCTET STRING PPPoePswd 1、Optional
2 、 Mandatory
when IPMode is
PPPOE
strMGCIP1 OCTET STRING MGCIP1 Optional
strMGCIP2 OCTET STRING MGCIP2 Optional
Output Parameter:
1.7 AddOnuBandwidth
Function name in xml: AddOnuBandwidth
This command is used for configuring the bandwidth
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
strOnuBandWidth OCTET STRING ONU Bandwidth Profile Mandatory
Profile
Output Parameter:
1.8 AddPonVlan
Function name in xml: BindOltQinqDomain
This command is used for binding olt qinq domain for ONU.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
strQinqDomainNa OCTET STRING OLT QINQ Domain name Mandatory
me
Output Parameter:

2 Onu BW profile modification
2.1 DelPonVlan
Function name in xml: UnBindOltQinqDomain
This command is used for unbinding olt qinq domain for ONU
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
me
Output Parameter:

2.2 AddPonVlan
Function name in xml: BindOltQinqDomain
This command is used for binding olt qinq domain for ONU.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
me
Output Parameter:
2.3 AddOnuBandwidth
Function name in xml: AddOnuBandwidth
This command is used for configuring the bandwidth.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
strOnuBandWidth OCTET STRING ONU Bandwidth Profile Mandatory
Profile
Output Parameter:

3 Delete an Onu
3.1 DelPonVlan
Function name in xml: UnBindOltQinqDomain
This command is used for unbinding olt qinq domain for ONU
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
me
Output Parameter:

3.2 DelOnu
Function name in xml: DelOnu
This command is used for deleting the ONU authorized by the OLT.
Input Parameter:
strOnuIDType OCTET STRING ONU identifier type (MAC, 3、Mandatory
LOID,).
4、Default:MAC
ONU_NUMBER.
Output Parameter:

4 Activate Onu Services
4.1 ActivateWanService
Function name in xml: ActivateWanService
This command is used for activate the Service for all the ports.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
Output Parameter:
4.2 ActivateVoicePort
Function name in xml: ActivateVoicePort
This command is used for activating the Voice port of the ONU.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
stPortInfo OnuPortInfo Mandatory
Output Parameter:

5 Deactivate Onu Services
5.1 DeactivateWanService
Function name in xml: DeactivateWanService
This command is used for deactivate the Service for all the ports.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
Output Parameter:
5.2 DeactivateVoicePort
Function name in xml: DeactivateVoicePort
This command is used for deactivating the Voice port of the ONU.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
stPortInfo OnuPortInfo Mandatory
Output Parameter:

6 Reset Onu
6.1 ResetOnu
Function name in xml: ResetOnu
This command is used for restarting an ONU.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
Output Parameter:

7 Onu Inventory
7.1 GetOnuRunningState
Function name in xml: DumpResource
This command is used for dumping Onu running state and Onu
bandwidth profile.
Input Parameter:
strFtpServer OCTET STRING FTP server ip address Mandatory
strFtpUserName OCTET STRING FTP username Mandatory
strFtpPassWord OCTET STRING FTP user password Mandatory
strFileFolder OCTET STRING File folder Mandatory
strDumpCmdType OCTET STRING Only RunState and Mandatory
BandWidth are valid. for dumping Onu
running state is
RunState
Output Parameter:

strOltIp OCTET STRING OLT IP address, name.
strFtpServer OCTET STRING FTP server ip address
strFileFolder OCTET STRING File folder
strDumpCmdType OCTET STRING DumpCmdType
strDumpFileName OCTET STRING DumpFileName
8 Onu BW Profile Inventory
8.1 DumpResource
Function name in xml: DumpResource
This command is used for dumping Onu running state and Onu
bandwidth profile.
Input Parameter:
strFtpServer OCTET STRING FTP server ip address Mandatory
strFtpUserName OCTET STRING FTP username Mandatory
strFtpPassWord OCTET STRING FTP user password Mandatory
strFileFolder OCTET STRING File folder Mandatory
strDumpCmdType OCTET STRING Only RunState and Mandatory
BandWidth are valid. for dumping Onu
bandwidth is
BandWidth
Output Parameter:

strOltIp OCTET STRING OLT IP address, name.
strFtpServer OCTET STRING FTP server ip address
strFileFolder OCTET STRING File folder
strDumpCmdType OCTET STRING DumpCmdType
strDumpFileName OCTET STRING DumpFileName
9 Other functions
9.1 DelVlan
Function name in xml: DelVlan
This command is used for deleting a VLAN.
Input Parameter:
nVlanid INTEGER VLANID（Range:1~4085） Mandatory
Output Parameter:
9.2 DelVoiceService
Function name in xml: DelVoiceService
The command is used for adding the voice service of a VoIP port.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
iPort INTEGER Mandatory
Output Parameter:
9.3 GetOnuList
Function name in xml: GetOnuList
This command is used for querying the information of a specified ONU
or all ONUs connected to the OLT.
Input Parameter:

strOltIp OCTET STRING OLT IP address Mandatory
strOnuIdType OCTET STRING ONU identifier type (MAC, 1,Mandatory
LOID,). 2,Default:MA
C
strOnuID OCTET STRING ONU identifier, used for uniquely Mandatory
identifying the ONU connected to
the PON port. The value is MAC,
LOID or ONU_NUMBER.
Output Parameter:

strOltIp INTEGER OLT IP address or name.
nSlotNo INTEGER Slot no
nPonNo INTEGER Pon port no
nOnuNo INTEGER ONU authorization code
strName OCTET STRING ONU name
strDesc OCTET STRING ONU descriptioninformation.
strOnuType OCTET STRING ONU type
strMac OCTET STRING The registered MAC information of
the ONU.
strLoid OCTET STRING When the MAC authentication is
adopted, a dash (--) will be
returned.
strPWD OCTET STRING LOID password. If no password is
specified, a dash (--) will be
returned.
strSWVER OCTET STRING Software version
9.4 GetOnuStatus
Function name in xml: GetOnuStatus
This command is used for querying the Status of the ONU.
Input Parameter:
C
LOID or ONU_NUMBER.
Output Parameter:

nPonNo INTEGER Port no.
strOnuIdType OCTET STRING ONU identifier type (MAC,
LOID,).
strOnuID OCTET STRING ONU identifier, used for uniquely
LOID or ONU_NUMBER.
strLastOnTime OCTET STRING The ONU last online time.
strLastOffTime OCTET STRING The ONU last off time.
strOperStatus OCTET STRING Operation State
str_HW_Version OCTET STRING Hardware Version of ONU.
str_SW_Version OCTET STRING Software Version of ONU.
9.5 GetOnuRttValue
Function name in xml: GetOnuRttValue
This command is used for querying the RTT value from ONU to the OLT.
Input Parameter:

C
LOID or ONU_NUMBER.
Output Parameter:

LOID,).
LOID or ONU_NUMBER.
iValue INTEGER RTT Value 1,Range:0~65
534
2,Unit:m
9.6 GetOnuOMDDM
Function name in xml: GetOnuOMDDM
This command is used for querying the information of the Optical module
of the ONU.
Input Parameter:

C
LOID or ONU_NUMBER.
Output Parameter:

LOID,).
LOID or ONU_NUMBER.
strType OCTET STRING The Optical module type. Unit:Km
strTemperature OCTET STRING The Optical module Temperature. 1,Range:-45
~90
2,Unit:℃
strVoltage OCTET STRING The Optical module Voltage. 1,Range:0~6
.55
2,Unit:V
strBiasCurrent OCTET STRING The Optical module Bias current. Unit:mA
strTxPower OCTET STRING The Optical module Tx_OptPower. 1,Range:-40

~10
2,Unit:dBm
strRxPower OCTET STRING The Optical module Rx_OptPower. 1,Range:-40
~10
2,Unit:dBm
strOltRxPower OCTET STRING OLT Rx_Power dBm
9.7 GetOnuLanPortInfo
Function name in xml: GetOnuLanPortInfo
This command is used for querying the information of the LAN Port of
the ONU.
Input Parameter:

C
LOID or ONU_NUMBER.
Output Parameter:

LOID,). 2,Default:M
AC
LOID or ONU_NUMBER.
iPort INTEGER ONU port
strLinkStatus OCTET STRING linked,
not linked
strFlowControl OCTET STRING disabled
enabled
strAdminState OCTET STRING disabled
enabled
strAuto_Negotiatio OCTET STRING disabled
nState enabled
strSpeed INTEGER Unit:M
strDuplex OCTET STRING Full
Half
Auto
Auto-Full
Auto-Half
strLookBackStatus OCTET STRING Normal
LoopBack
9.10 GetOnuWifiStatus
Function name in xml: GetOnuWifiStatus
This command is used for querying the information of the WiFi Service
Config.
Input Parameter:

C
LOID or ONU_NUMBER.
Output Parameter:

strOnuIdType OCTET STRING ONU identifier type (MAC, Default:MA
LOID,). C
LOID or ONU_NUMBER.
iWifiSwitch INTEGER 0:disable
1:enable
iWILESS-AREA INTEGER
iChanel INTEGER IGD_WLAN_CHANNEL iWILESS-A
REA=0,strC
hanel=[0,13]
;
iWILESS-A
REA=0=1,st
rChanel=[0,
11]
strTxPower INTEGER Range:[20,2
00]
strStandard OCTET STRING 802.11b,
802.11g,
802.11b/g,
802.11n
802.11bgn
strWorkFrequency OCTET STRING 2.4 Ghz
5 Ghz
strChanelBandwidt OCTET STRING 20/40MHz
h 20MHz
40MHz
80MHZ
strSsidName OCTET STRING SSID Name

strSsidNo INTEGER SSID Number
strAuthType OCTET STRING IGD_WLAN_AuthMode OPEN
SHARED
WEPAUTO
WPAPSK
WPA
WPA2PSK
WPA2
WPA/WPA2
WPAPSK
WPA2PSK
strEncryptionType OCTET STRING IGD_WLAN_EncrypTpe NONE
WEP
TKIP
AES
TKIPAES
strSsidPresharedke OCTET STRING IGD_WLAN_PresharedKey
y
9.11 GetOnuVoiceServiceStatus
Function name in xml: GetOnuVoiceServiceStatus
This command is used for querying the Voice Service Status of the ONU.
Input Parameter:
C
LOID or ONU_NUMBER.
Output Parameter:

LOID,).
LOID or ONU_NUMBER.
ONUPORT OCTET STRING
strSipUserStatus OCTET STRING Registered
Reg Fail
Registering
IAD
malfunction
unregister
IAD
rebooting
strSipUserName OCTET STRING

strPhoneNumber OCTET STRING
strSipPwd OCTET STRING
strRxGain INTEGER Input Gain Range:-32~32
Unit:dB
strTxGain INTEGER Output Gain Range:-32~32
Unit:dB
strReversePolarity OCTET STRING Enable
Disable
strIadIp OCTET STRING Iad IP Address
strMask OCTET STRING IP Mask
strGateway OCTET STRING Gateway
strDns OCTET STRING Master DNS
strDigitMap OCTET STRING
9.12 GetOnuMacTable
Function name in xml: GetOnuMacTable
This command is used for getting MAC address learning table .
Input Parameter:

C
LOID or ONU_NUMBER.
Output Parameter:
C
LOID or ONU_NUMBER.
ONUPORT OCTET STRING PON
LAN
2.4G_SSID
5G_SSID
strMac OCTET STRING XX-XX-XX-

XX-XX-XX
strIP OCTET STRING
9.13 SetOnuDhcpServerInfo
Function name in xml: SetOnuDhcpServerInfo
This command is used for config DHCP Server Information of the ONU.
Input Parameter:
C
LOID or ONU_NUMBER.
strMgmtIp OCTET STRING IP address 1,Mandatory
2,Support
Mask
strLeaseTime OCTET STRING Lease time 1,Mandatory
2,Default:0
3,Range:0-31
622399
4,Unit:s
strAdminStatus OCTET STRING Enable/Disable the device DHCP 1,Mandatory
switch 2,Range:Enab
le/Disable
3,Default:Ena
ble
strIpStart OCTET STRING DHCP Pool Start 1,Optional
2,strIpStart
must less than
strIpEnd
strIpEnd OCTET STRING DHCP Pool End Optional
strPrimaryDns OCTET STRING The primary DNS server for Optional
DHCP
strSecondaryDns OCTET STRING The secondary DNS server for Optional
DHCP
strGateway OCTET STRING The default gateway for DHCP Optional
Output Parameter:
9.14 GetOnuDhcpServerInfo
Function name in xml: GetOnuDhcpServerInfo
This command is used for querying DHCP Server Information of the
ONU.
Input Parameter:

C
LOID or ONU_NUMBER.
Output Parameter:
LOID,).
LOID or ONU_NUMBER.
strMgmtIp OCTET STRING IP address
strLeaseTime OCTET STRING Lease time
strAdminStatus OCTET STRING Enable/Disable the device DHCP
switch
strIpStart OCTET STRING DHCP Pool Start
strIpEnd OCTET STRING DHCP Pool End
strPrimaryDns OCTET STRING The primary DNS server for
DHCP
strSecondaryDns OCTET STRING The secondary DNS server for
DHCP
strGateway OCTET STRING The default gateway for DHCP
9.15 ReplaceFaultyOnu
Function name in xml: ReplaceFaultyOnu
This command is used for replacing the ONU.
Input Parameter:

C
LOID or ONU_NUMBER.
nNewOnuIdType OCTET STRING MAC 1,Mandatory
LOID 2,Default:MA
LOIDONCEON
C
strNewOnuID OCTET STRING Mandatory
Output Parameter:
9.16 CfgOnuLanService
Function name in xml: CfgOnuLanService
This command is used for configuring the service of the LAN Port of the
ONU.
Input Parameter:

LOID,). 2,Default:MAC
strOnuID OCTET STRING ONU identifier, used for Mandatory
connected to the PON port. The
value is MAC, LOID or
ONU_NUMBER.
iPort INTEGER ONU port Mandatory
SVLAN INTEGER SVLAN 1,Optional

2,Mandatory
when double
vlan service
3,Range:0~4095
Default: -1
CVLAN INTEGER CVLAN 1,Mandatory
2,Range:0~4095
UV INTEGER User side VLAN 1,Mandatory
2,Range:0~4095
Default:-1
SCOS INTEGER SVLAN COS 1, Mandatory
2,Range:0~7
Default:-1
CCOS INTEGER CVLAN COS 1, Mandatory
2,Range:0~7
Default:-1
Output Parameter:
9.17 CfgGponServiceBandWidth
Function name in xml: CfgGponServiceBandWidth
This command is used for configuring ONU Service Bandwidth for
different service type.
Input Parameter:

strOltIp OCTET STRING OLT IP address, name or ID. Mandatory
LOID,). 2,Default:M
AC
LOID or ONU_NUMBER.
iService type OCTET STRING 1:IPTV Mandatory
2:DATA
3:VOICE
INTEGRATED
iFixed Bandwidth INTEGER Fixed Bandwidth
Mandatory
iAssured INTEGER Assured Bandwidth

Bandwidth Mandatory
iMax Bandwidth INTEGER Max Bandwidth Mandatory

Output Parameter:
9.18 ModifyWanBindProfile
Function name in xml: ModifyWanBindProfile
This command is used for modifying the profile for WANService
Input Parameter:

C
LOID or ONU_NUMBER.
iWanIndex INTEGER Wan Index Mandatory
strUpProfile OCTET STRING Up bandwidth profile; Mandatory
This parament is valid whne WAN
connection mode is
INTERNET
TR069_INTERNET
VOIP_INTERNET
strDownProfile OCTET STRING Down bandwidth profile Mandatory
This parament is valid whne WAN
connection mode is
INTERNET
TR069_INTERNET
VOIP_INTERNET
Output Parameter:
9.19 Activate Port
Function name in xml: ActivatePort
This command is used for activating the LAN port of the ONU.
Input Parameter:
C
LOID or ONU_NUMBER.
iPort INTEGER Onu lan port Mandatory
Output Parameter:
9.20 DeactivatePort
Function name in xml: ActivatePort
This command is used for activating the LAN port of the ONU.
Input Parameter:
C
LOID or ONU_NUMBER.
iPort INTEGER Onu lan port Mandatory
Output Parameter:
9.21 GetOnuBandWidth
Function name in xml: GetOnuBandWidth
This command is used for querying the bandwidth of a specified ONU.
Input Parameter:
LOID,). Default:MAC
ONU_NUMBER.
Output Parameter:

stOnuId OnuIdInfo
strOnuName OCTET STRING
iOnuNumber INTEGER
strOnuBandWidth OCTET STRING ONU Bandwidth Profile
Profile

Web Service Interface Function Description

Uploaded by

Copyright:

Available Formats

You might also like

Web Service Interface Function Description

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Web Service Interface Function Description

Uploaded by

Copyright:

Available Formats

Web Service Interface Function

VoIP service, bind a vlan translation profile and the BW profile

contracted by the client.

Function name in xml: AddVlan

TagFlag OCTET STRING untag 1、Mandatory

No Output for this function is needed.

Function name in xml: GetUnRegOnuInfo

Function name in xml: AddOnu

No Output for this function is needed.

Function name in xml: SetWanService

nStatus INTEGER 1: adding; 2: deleting. Mandatory

nConnType INTEGER WAN connection type: 1 Mandatory

Function name in xml: AddWifiService

authorized by OLT. It is allowed to add SSIP and configure it with

iWorkingFrequenc INTEGER 0: 2.4 Ghz Mandatory

No Output for this function is needed.

Function name in xml: AddVoiceService

No Output for this function is needed.

Function name in xml: AddOnuBandwidth

No Output for this function is needed.

Function name in xml: BindOltQinqDomain

No Output for this function is needed.

Function name in xml: UnBindOltQinqDomain

No Output for this function is needed.

Function name in xml: BindOltQinqDomain

No Output for this function is needed.

Function name in xml: AddOnuBandwidth

No Output for this function is needed.

Function name in xml: UnBindOltQinqDomain

No Output for this function is needed.

Function name in xml: DelOnu

No Output for this function is needed.

Function name in xml: ActivateWanService

No Output for this function is needed.

Function name in xml: ActivateVoicePort

No Output for this function is needed.

Function name in xml: DeactivateWanService

No Output for this function is needed.

Function name in xml: DeactivateVoicePort

No Output for this function is needed.

Function name in xml: ResetOnu

No Output for this function is needed.

Function name in xml: DumpResource

Attributes Type Description Remark

Function name in xml: DumpResource

Attributes Type Description Remark

Function name in xml: DelVlan

No Output for this function is needed.

Function name in xml: DelVoiceService

No Output for this function is needed.

Function name in xml: GetOnuList

or all ONUs connected to the OLT.

Parameter Name Type Description Remark

Parameter Name Type Description Remark

Function name in xml: GetOnuStatus

Attributes Type Description Remark

Function name in xml: GetOnuRttValue