导航

OneMSTM Version 6 TR-069 Enabled Device Remote Management Specification

Posted on 2017-06-18 20:30  Young哥哥  阅读(527)  评论(0)    收藏  举报

 

 

                    

 

OneMSTM Version 6 TR-069 Enabled Device Remote Management Specification

 

 

 

Document No. : D-OMR005-B34-005

VERSION: 1.0, 11/4/2009

 

 

 

 

 

 

 

World Headquarters

 

Works Systems, Inc.

7291 Coronado Drive, Suite 2
San Jose, CA 95129
USA

 

http://www.workssys.com

 

Tel: +1-408-777-2967 (main)

Tel: +86-22-5839-7112 (support)

Fax: +86-22-8371-9375

 

 

 

 

Disclaimers

The information contained in this document is the proprietary and exclusive property of Works Systems, Inc. except as otherwise indicated.  No part of this document, in whole or in part, may be reproduced, stored, transmitted, or used for design purposes without the prior written permission of Works Systems, Inc..

The information contained in this document is subject to change without notice.

The information in this document is provided for informational purposes only.  Works Systems, Inc. specifically disclaims all warranties, express or limited, including, but not limited, to the implied warranties of merchantability and fitness for a particular purpose, except as provided for in a separate software license agreement.

Privacy Information

This document may contain information of a sensitive nature. This information should not be given to persons other than those who are involved in theproject or who will become involved during the lifecycle

 

Version History

 

REVISION CHART

Date

Version

Author

Description

10/15/2009

0.1

Grace

Initialize the document

11/04/2009

1.0

Cerys
  1. Add session scenarios and flow steps
  2. Add TR parameters required status

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Table of Contents

1.    General Description.. 2

1.1      Terminology. 2

2.    Management and Maintenance Requirements. 2

3.    Data Model Cross References. 2

3.1      TR-069 Baseline Profile. 2

3.2      WAN Connection Profile. 2

3.3      ADSL Profile. 2

3.4      Security Profile. 2

3.5      LAN Profile. 2

3.6      Wireless LAN Profile. 2

3.7      Diagnostics Profile for IGD.. 2

3.8      Diagnostics Profile for Device. 2

3.9      VoIP Profile. 2

3.10       IP Phone Button Profile. 2

3.11       Statistics Profile. 2

3.12       Time Profile. 2

4.    Appendix A. Interface and Flow Definitions. 2

4.1      CPE Initiated Secure Connection Flow.. 2

4.1.1       Scenario. 2

4.1.2       Required RPC Methods Calling. 2

4.1.3       Required Parameters. 2

4.1.4       Interface Sequence and Description. 2

4.2      ACS Initiated Secure Connection Flow.. 2

4.2.1       Scenario. 2

4.2.2       Required RPC Methods Calling. 2

4.2.3       Required Parameters. 2

4.2.4       Interface Sequence and Description. 2

4.3      Get Parameter Attribute Flow.. 2

4.3.1       Scenario. 2

4.3.2       Required RPC Methods Calling. 2

4.3.3       Required Parameters. 2

4.3.4       Interface Sequence and Description. 2

4.4      Set Parameter Attribute Flow.. 2

4.4.1       Scenario. 2

4.4.2       Required RPC Methods Calling. 2

4.4.3       Required Parameters. 2

4.4.4       Interface Sequence and Description. 2

4.5      Download Device Configuration File Flow.. 2

4.5.1       Scenario. 2

4.5.2       Required RPC Methods Calling. 2

4.5.3       Required Parameters. 2

4.5.4       Interface Sequence and Description. 2

4.6      Upload Device Configuration File Flow.. 2

4.6.1       Scenario. 2

4.6.2       Required RPC Methods Calling. 2

4.6.3       Required Parameters. 2

4.6.4       Interface Sequence and Description. 2

4.7      Upload Device Log File Flow.. 2

4.7.1       Scenario. 2

4.7.2       Required RPC Methods Calling. 2

4.7.3       Required Parameters. 2

4.7.4       Interface Sequence and Description. 2

4.8      Get Parameter Value Flow.. 2

4.8.1       Scenario. 2

4.8.2       Required RPC Methods Calling. 2

4.8.3       Required Parameters. 2

4.8.4       Interface Sequence and Description. 2

4.9      Value Changed Notify Flow.. 2

4.9.1       Scenario. 2

4.9.2       Required RPC Methods Calling. 2

4.9.3       Required Parameters. 2

4.9.4       Interface Sequence and Description. 2

4.10       Device Reboot Flow.. 2

4.10.1     Scenario Description. 2

4.10.2     Related RPC Method Calling. 2

4.10.3     Related Parameters. 2

4.10.4     Interface Sequence and Description. 2

4.11       Device Factory Reset Flow.. 2

4.11.1     Scenario Description. 2

4.11.2     Related RPC Method Calling. 2

4.11.3     Related Parameters. 2

4.11.4     Interface Sequence and Descriptions. 2

4.12       Device Firmware Upgrade Flow.. 2

4.12.1     Scenario Description. 2

4.12.2     Related RPC Method Calling. 2

4.12.3     Related Parameters. 2

4.12.4     Interface Sequence and Descriptions. 2

4.13       IP Ping. 2

4.13.1     Scenario Description. 2

4.13.2     Related RPC Method Calling. 2

4.13.3     Related Parameters. 2

4.13.4     Interface Sequence and Descriptions. 2

4.14       Trace Route. 2

4.14.1     Scenario Description. 2

4.14.2     Related RPC Method Calling. 2

4.14.3     Related Parameters. 2

4.14.4     Interface Sequence and Descriptions. 2

4.15       Download Performance. 2

4.15.1     Scenario Description. 2

4.15.2     Related RPC Method Calling. 2

4.15.3     Related Parameters. 2

4.15.4     Interface Sequence and Descriptions. 2

4.16       Upload Performance. 2

4.16.1     Scenario Description. 2

4.16.2     Related RPC Method Calling. 2

4.16.3     Related Parameters. 2

4.16.4     Interface Sequence and Descriptions. 2

4.17       ATMF5 Loopback. 2

4.17.1     Scenario Description. 2

4.17.2     Related RPC Method Calling. 2

4.17.3     Related Parameters. 2

4.17.4     Interface Sequence and Descriptions. 2

4.18       DSL Loopback. 2

4.18.1     Scenario Description. 2

4.18.2     Related RPC Method Calling. 2

4.18.3     Related Parameters. 2

4.18.4     Interface Sequence and Descriptions. 2

 

 

1.   General Description

This specification is defined for ADSL2/2+ Home Gateway (HG) remote management by leveraging TR-069. It is mainly used to specify the remote management parameters of ADSL HG and the interface and operation flow between HG and ACS.

 

 

 

Note:

The specification with “□” symbol is an option and may be selected in the procurement specification according to the requirements.

The specification with “■” symbol is a mandatory and must-have requirement.

 

1.1   Terminology

ACS

Auto-Configuration Server. This is a component in the broadband network responsible for auto-configuration of the CPE for advanced services.

CPE

Customer Premises Equipment; refers to any TR-069-compliant device and therefore covers both Internet Gateway Devices and LAN-side end devices.

Data Model

A hierarchical set of Parameters that define the managed objects accessible via TR-069 for a particular device or service.

TR-069

CPE Remote Management Protocol

TR-098

Internet Gateway Device Data Model for TR-069

TR-104

Provisioning Parameters for VoIP CPE

TR-106

Data Model Template for TR-069-Enabled Devices

2.   Management and Maintenance Requirements

To remotely manage CPE, the following requirement must be met by CPE:

■    Support TR-069 protocol to perform remote configuration and management.

■    For CPE identification purpose, the Serial Number in inform message and the MAC address maybe not in inform message, as well as keep unique if having the same OUI.

■    ACS server attributes SHOULD NOT be changed by end user.

■    In case of factory reset, CPE shall have the capability of reserving ACS server attributes, which include ACS URL, ACS authentication User Name/Password to keep the connectivity between ACS and CPE.

Object / Parameter Name

InternetGatewayDevice.ManagementServer.

URL

Username

Password

PeriodicInformEnable

PeriodicInformInterval

ConnectionRequestURL

ConnectionRequestUsername

ConnectionRequestPassword

■    After factory reset, CPE MUST reset “ProvisioningCode” to the default value.

Object / Parameter Name

InternetGatewayDevice.DeviceInfo.

ProvisioningCode

■    CPE shall be able to receive ACS’s remote control to perform firmware upgrade operation. If upgrade failed, it shall be able to restore to old version or connect to ACS to try again.

■    CPE shall support the digest authentication function for ACS to initiate HTTP/HTTPS session.

□    CPE shall support SSL 3.0 or TLS 1.0 protocol, encryption algorithms with key lengths shall be greater than or equal to 128 bits.

■    CPE shall provide provisioning status and firmware upgrade progress on its own web interface for operator understanding.

■    Shall support RPC responding and calling.

(1)   CPE-based RPC responding: shall at least support

 

GetRPCMethods

SetParameterValues

GetParameterValues

GetParameterNames

SetParameterAttributes

GetParameterAttributes

Reboot

Download

Upload

FactoryReset

 

(2)   ACS-based RPC calling: shall at least support

 

Inform

TransferComplete

 

3.   Data Model Cross References

The following signatures are used to denote the requirement level:

Mandatory: M

Preferred: P

3.1   TR-069 Baseline Profile

The following table defines the parameters required for any TR-069-enabled device.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.DeviceInfo.

M

Manufacturer

R; string(64)

Defined in TR-098
(Forced Inform)

M

M

ManufacturerOUI

R; string(6)

Defined in TR-098
(Forced Inform)

M

M

ModelName

R; string(64)

Defined in TR-098
(Forced Inform)

M

M

ProductClass

R; string(256)

Defined in TR-098

(Forced Inform)

M

M

SerialNumber

R; string(64)

Defined in TR-098, MAC address without colon.
(Forced Inform)

M

M

HardwareVersion

R; string(64)

Defined in TR-098
(Forced Inform)

M

M

SoftwareVersion

R; string(64)

Defined in TR-098, firmware version
(Forced Inform)

M

M

ProvisioningCode

RW; string(64)

Defined in TR-098

(Forced Inform)

M

M

UpTime

R; unsignedInt

Time in seconds since the CPE was last restarted. Defined in TR-098

(Preferred Inform)

P

InternetGatewayDevice.ManagementServer.

M

URL

RW; string(256)

Defined in TR-098

A default value shall be defined

M

M

Username

RW; string(256)

Defined in TR-098
admin (default)

M

M

Password

W; string(256)

Defined in TR-098
admin (default)

M

M

PeriodicInformEnable

RW; boolean

Defined in TR-098
disable (default)

M

M

PeriodicInformInterval

RW; unsignedInt

[1:]

Defined in TR-098
25200 sec. (default)

M

M

ConnectionRequestURL

R; string(256)

Defined in TR-098
(Forced Inform)

M

M

ConnectionRequestUsername

RW; string(256)

Defined in TR-098
admin (default)

M

M

ConnectionRequestPassword

W; string(256)

Defined in TR-098
admin (default)

M

3.2   WAN Connection Profile

If WAN interface is present in the CPE, there shall at least exist one of connection modes: WANIPConnection or WANPPPConnection.

 

The following table defines the parameters required for WANIPConnection or WANPPPConnection

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.

P

Enable

RW; boolean

Defined in TR-098

M

M

AddressingType

RW; string

Defined in TR-098

Enumeration of:

“DHCP” (default)

“Static”

M

M

ExternalIPAddress

RW; string

Defined in TR-098

M

M

SubnetMask

RW; string

Defined in TR-098

M

M

DefaultGateway

RW; string

Defined in TR-098

M

M

DNSServers

RW; string(64)

Defined in TR-098

P

InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.

P

Enable

RW; boolean

Defined in TR-098

M

M

Username

RW; string(256)

Defined in TR-098

M

M

Password

W; string(256)

Defined in TR-098

M

M

ConnectionTrigger

RW; string

Defined in TR-098

Enumeration of:

“OnDemand”

“AlwaysOn” (default)

“Manual”

P

M

ExternalIPAddress

R; string

Defined in TR-098

M

3.3   ADSL2/2+ Profile

The following table defines the parameters required for the CPE with ADSL2/2+ interface.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.WANDevice.{i}. WANDSLInterfaceConfig.

M

Status

R; string

Defined in TR-098

Enumeration of:

“Up”

“Initializing”

“EstablishingLink”

“NoSignal”

“Error” (OPTIONAL)

“Disabled”

M

M

ModulationType

R; string

Defined in TR-098

Enumeration of:

“ADSL_G.dmt”

“ADSL_G.lite”

“ADSL_G.dmt.bis”

“ADSL_re-adsl”

“ADSL_2plus”

“ADLS_four”

“ADSL_ANSI_T1.413”

“G.shdsl”

“IDSL”

“HDSL”

“SDSL”

“VDSL”

M

M

DataPath

R; string

Defined in TR-098

Enumeration of:

“Interleaved”

“Fast”

P

M

InterleaveDepth

R; unsignedInt

Defined in TR-098

M

M

UpstreamCurrRate

R; unsignedInt

Defined in TR-098

M

M

DownstreamCurrRate

R; unsignedInt

Defined in TR-098

M

M

UpstreamMaxRate

R; unsignedInt

Defined in TR-098

M

M

DownstreamMaxRate

R; unsignedInt

Defined in TR-098

M

M

UpstreamNoiseMargin

R; int

Defined in TR-098

M

M

DownstreamNoiseMargin

R; int

Defined in TR-098

M

InternetGatewayDevice.WANDevice.{i}. WANDSLInterfaceConfig.Stats.Total.

M

ReceiveBlocks

R; unsignedInt

Defined in TR-098

P

M

TransmitBlocks

R; unsignedInt

Defined in TR-098

P

M

ReceiveBlocks

R; unsignedInt

Defined in TR-098

P

 

3.4   Security Profile

The following table defines the parameters required for any TR-069-enabled device.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.LANConfigSecurity.

M

ConfigPassword

W; string(64)

Defined in TR-098.

A password to allow LAN access to protected auto-configuration services.

P
         

3.5   LAN Profile

If LAN interface is present in the CPE, the following table defines the parameters required for LAN management.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.

P

DHCPServerEnable

RW; boolean

Defined in TR-098

P

M

DNSServers

RW; string(64)

Defined in TR-098

P

P

DomainName

RW; string(64)

Defined in TR-098

P

P

IPRouters

RW; string(64)

Defined in TR-098

P

M

MinAddress

RW; string

Defined in TR-098

P

M

MaxAddress

RW; string

Defined in TR-098

P

M

DHCPLeaseTime

RW; int(-1)

Defined in TR-098

P

InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}.

M

IPInterfaceIPAddress

RW; string

Defined in TR-098

M

M

IPInterfaceSubnetMask

RW; string

Defined in TR-098

M

InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.

P

Enable

RW; string

Defined in TR-098

P

P

Status

R; string

Defined in TR-098

Enumeration of:

“Up”

“NoLink”

“Error” (OPTIONAL)

“Disabled

M

P

MACAddress

R; string

Defined in TR-098

M

P

MaxBitRate

RW; string

Defined in TR-098

Enumeration of:

“10”

“100”

“1000”

“Auto”

P

P

DuplexMode

RW; string

Defined in TR-098

Enumeration of:

“Half”

“Full”

“Auto”

P

InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}.

P

IPAddress

R; string

Defined in TR-098

P

P

AddressSource

R; string

Defined in TR-098

Enumeration of:

“DHCP”

“Static”

”AutoIP”

P

P

LeaseTimeRemaining

R; int[-1:]

Defined in TR-098

P

P

MACAddress

R; string

Defined in TR-098

P

P

HostName

R; string(64)

Defined in TR-098

P

P

InterfaceType

R; string

Defined in TR-098

Enumeration of:

“Ethernet”

“USB”

“802.11”

“HomePNA”

“HomePlug”

“Other”

P

P

Active

R; boolean

Defined in TR-098

P

 

3.6   Wireless LAN Profile

If Wireless LAN interface is present in the CPE, the following table defines the parameters required for WiFi management.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.

M

BeaconType

RW; string

Defined in TR-098

Enumeration of:

“None”

“Basic”

“WPA”

“11i” (OPTIONAL)

“BasicandWPA” (OPTIONAL, OBSOLETED)

“Basicand11i’ (OPTIONAL, OBSOLETED)

“WPAand11i” (OPTIONAL)

“BasicandWPAand11i” (OPTIONAL,

OBSOLETED)

M

M

BasicEncryptionModes

RW; string(31)

Defined in TR-098

Enumeration of:

“None”

“WEPEncryption”

M

M

BSSID

R; string

Defined in TR-098

The MAC address of the interface

P

P

SSID

RW; string(32)

Defined in TR-098

M

M

MaxBitRate

RW; string(4)

Defined in TR-098

M

M

Enable

RW; boolean

Defined in TR-098

M

M

WEPKeyIndex

RW; unsignedint[1:4]

Defined in TR-098

M

InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WEPKey.{i}

M

WEPKey

W; string(128)

Defined in TR-098

M

InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey

M

PreSharedKey        

(if used for setting 8-63 char passphrase)

W; string(64)

Defined in TR-098

M

M

KeyPassphrase 

(if used for setting 8-63 char passphrase)

W; string(63)

Defined in TR-098

M
           

 

 

3.7   Diagnostics Profile for IGD

If the diagnostics function on IGD CPE is available for remote management, the following table defines the parameters required for diagnostics management.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.IPPingDiagnostics.

P

DiagnosticsState

RW; string

Defined in TR-098

Indicates availability of diagnostic data. One of:

“None”

“Requested”

“Complete”

“Error_Internal”

“Error_Other”

M

P

Interface

RW; string(256)

Defined in TR-098

M

P

Host

RW; string(256)

Defined in TR-098

M

P

NumberOfRepetitions

RW; unsignedInt[1:]

Defined in TR-098

M

P

Timeout

RW; unsignedInt[1:]

Defined in TR-098

M

P

DataBlockSize

RW; unsignedInt[1:65535]

Defined in TR-098

M

P

DSCP

RW; unsignedInt[0:63]

Defined in TR-098

M

P

SuccessCount

R; unsignedInt

Defined in TR-098

M

P

FailureCount

R; unsignedInt

Defined in TR-098

M

P

AverageResponseTime

R; unsignedInt

Defined in TR-098

M

P

MinimumResponseTime

R; unsignedInt

Defined in TR-098

M

P

MaximumResponseTime

R; unsignedInt

Defined in TR-098

M

InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANATMF5LoopbackDiagnostics.

(only available for ADSL2/2+ CPE)

P

DiagnosticsState

RW; string

Defined in TR-098

Indicates availability of diagnostic data. One of:

“None”

“Requested”

“Complete”

“Error_Internal”

“Error_Other”

M

P

NumberOfRepetitions

RW; unsignedInt[1:]

Defined in TR-098

M

P

Timeout

RW; unsignedInt[1:]

Defined in TR-098

M

P

SuccessCount

R; unsignedInt

Defined in TR-098

M

P

FailureCount

R; unsignedInt

Defined in TR-098

M

P

AverageResponseTime

R; unsignedInt

Defined in TR-098

M

P

MinimumResponseTime

R; unsignedInt

Defined in TR-098

M

P

MaximumResponseTime

R; unsignedInt

Defined in TR-098

M

InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics

(only available for xDSL CPE)

P

LoopDiagnosticsState

RW; string

Defined in TR-098

Indicates availability of diagnostic data. One of:

“None”

“Requested”

“Complete”

“Error_Internal”

“Error_Other”

M

P

ACTPSDds

R; int

Defined in TR-098

M

P

ACTPSDus

R; int

Defined in TR-098

M

P

ACTATPds

R; int

Defined in TR-098

M

P

ACTATPus

R; int

Defined in TR-098

M

P

HLINSCds

R; int

Defined in TR-098

M

P

HLINpsds

R; unsignedInt

Defined in TR-098

M

P

HLINSCus 

R; int

Defined in TR-098

M

P

HLINpsus 

R; unsignedInt

Defined in TR-098

M

P

QLNpsds

R; string

Defined in TR-098

M

P

SNRpsds

R; string

Defined in TR-098

M

P

BITSpsds

R; string

Defined in TR-098

M

P

GAINSpsds

R; string

Defined in TR-098

M

InternetGatewayDevice.TraceRouteDiagnostics.

P

DiagnosticsState

RW; string

Indicates availability of diagnostic data. One of:
”None”
”Requested”
”Complete”
”Error_CannotResolveHostName”
”Error_MaxHopCountExceeded”

M

P

Interface

RW; string

Defined in TR-098

M

P

Host

RW; string(256) 

Defined in TR-098

M

P

NumberOfTries

RW; unsignedInt [1:3] 

Defined in TR-098

M

P

Timeout

RW; unsignedInt [1:] 

1-3600000(ms)

M

P

DataBlockSize

RW; unsignedInt [1:65535] 

Defined in TR-098　

M

P

DSCP

RW; unsignedInt [0:63] 

default 0

M

P

MaxHopCount

RW; unsignedInt [1:64] 

Defined in TR-098　

M

P

ResponseTime

R; unsignedInt 

1-4294967295 (ms)

M

P

RouteHopsNumberOfEntries

R; unsignedInt 

Defined in TR-098　

M

InternetGatewayDevice.TraceRouteDiagnostics.TraceRouteDiagnostics.RouteHops.{i}.

P

HopHost

R; string

Host Name or resolved IP address

M

InternetGatewayDevice.Capabilities.PerformanceDiagnostic.

(only available for TR-143-enabled CPE)

P

DownloadTransports

R;string

“HTTP”
”FTP” (OPTIONAL)

P

InternetGatewayDevice.DownloadDiagnostics.

(only available for TR-143-enabled CPE)

P

 DiagnosticsState 

RW; string

“None”
”Requested”
”Completed”
”Error_InitConnectionFailed”
”Error_NoResponse”
”Error_TransferFailed”
”Error_PasswordRequestFailed”
”Error_LoginFailed”
”Error_NoTransferMode”
”Error_NoPASV”
”Error_IncorrectSize”
”Error_Timeout”

M

P

 Interface 

RW; string(256)

Can be empty

M

P

 DownloadURL 

RW; string(256)

Defined in TR-098　

M

P

 DSCP 

RW; unsignedInt [0:63] 

default 0

M

P

 EthernetPriority 

RW; unsignedInt [0:7] 

default 0

M

P

 ROMTime 

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.12345

M

P

 BOMTime 

R; dateTime

Begin of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 EOMTime 

R; dateTime

End of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 TestBytesReceived 

R; unsignedInt

Defined in TR-098　　

M

P

 TotalBytesReceived 

R; unsignedInt

Defined in TR-098　　

M

P

 TCPOpenRequestTime

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.123456

M

P

 TCPOenResponseTime

R; dateTime

Response time in UTC, which MUST be specified to microsecond precision.
For example: 2008-04-09T15:01:05.123456

M

InternetGatewayDevice.Capabilities. PerformanceDiagnostic.

P

UploadTransports

R; string

“HTTP”
”FTP” (OPTIONAL)

M

InternetGatewayDevice.UploadDiagnostics.

(only available for TR-143-enabled CPE)

P

 DiagnosticsState 

RW; string

“None”
”Requested”
”Completed”
”Error_InitConnectionFailed”
”Error_NoResponse”
”Error_TransferFailed”
”Error_PasswordRequestFailed”
”Error_LoginFailed”
”Error_NoTransferMode”
”Error_NoPASV”
”Error_IncorrectSize”
”Error_Timeout”

M

P

 Interface 

RW; string(256)

Can be empty

M

P

 UploadURL 

RW; string(256)

Defined in TR-098　

M

P

 DSCP 

RW; unsignedInt [0:63] 

default 0

M

P

 EthernetPriority 

RW; unsignedInt [0:7] 

default 0

M

P

 TestFileLength 

RW; unsignedInt

The size of the file (in bytes) to be uploaded to the server.
The max value is 4294967295

M

P

 ROMTime 

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.12345

M

P

 BOMTime 

R; dateTime

Begin of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 EOMTime 

R; dateTime

End of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 TotalBytesSent 

R; unsignedInt

Defined in TR-098　　

M

P

 TCPOpenRequestTime

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.123456

M

P

 TCPOenResponseTime

R; dateTime

Response time in UTC, which MUST be specified to microsecond precision.
For example: 2008-04-09T15:01:05.123456

M

 

3.8   Diagnostics Profile for Device

If the diagnostics function on non-IGD CPE is available for remote management, the following table defines the parameters required for diagnostics management.

 

Parameter Name

Type

Description

Device Support

Device.LAN.IPPingDiagnostics.

P

DiagnosticsState

RW; string

Indicates availability of diagnostic data. One of:
”None”
”Requested”
”Complete”
”Error_CannotResolveHostName”
”Error_Internal”
”Error_Other”

M

P

Host

RW; string(256)

IP or Domain Name

M

P

NumberOfRepetitions

RW; unsignedInt[1:]

Defined in TR-098

M

P

Timeout

RW; unsignedInt[1:]

Defined in TR-098

M

P

DataBlockSize

RW; unsignedInt[1:]

Defined in TR-098

M

P

DSCP

RW; unsignedInt[1:65535]

Defined in TR-098

M

P

SuccessCount

R; unsignedInt[0:63]

Defined in TR-098　

M

P

FailureCount

R; unsignedInt

Defined in TR-098　

M

P

AverageResponseTime

R; unsignedInt

Defined in TR-098

M

P

MinimumResponseTime

R; unsignedInt

Defined in TR-098

M

P

MaximumResponseTime

R; unsignedInt

Defined in TR-098

M

P

GAINSpsds

R; string

Defined in TR-098

M

Device.LAN.TraceRouteDiagnostics.

P

DiagnosticsState

RW; string

Indicates availability of diagnostic data. One of:
”None”
”Requested”
”Complete”
”Error_CannotResolveHostName”
”Error_MaxHopCountExceeded”
”Error_Internal”
”Error_Other”

M

P

Host

RW; string(256) 

Defined in TR-098　

M

P

Timeout

RW; unsignedInt [1:] 

1-3600000(ms)

M

P

DataBlockSize

RW; unsignedInt [1:65535] 

Defined in TR-098　

M

P

DSCP

RW; unsignedInt [0:63] 

Defined in TR-098

M

P

MaxHopCount

RW; unsignedInt [1:64] 

Defined in TR-098　

M

P

ResponseTime

R; unsignedInt 

Defined in TR-098

M

P

NumberOfRouteHops

R; unsignedInt 

Defined in TR-098　

M

Device.LAN.TraceRouteDiagnostics.RouteHops.{i}.

P

HopHost

R; string

Host Name or resolved IP address

M

Device.Capabilities. PerformanceDiagnostic.

(only available for TR-143-enabled CPE)

P

DownloadTransports

R;string

“HTTP”
”FTP” (OPTIONAL)

P

Device.DownloadDiagnostics.

(only available for TR-143-enabled CPE)

P

 DiagnosticsState 

RW; string

“None”
”Requested”
”Completed”
”Error_InitConnectionFailed”
”Error_NoResponse”
”Error_TransferFailed”
”Error_PasswordRequestFailed”
”Error_LoginFailed”
”Error_NoTransferMode”
”Error_NoPASV”
”Error_IncorrectSize”
”Error_Timeout”

M

P

 Interface 

RW; string(256)

Can be empty

M

P

 DownloadURL 

RW; string(256)

Defined in TR-098　

M

P

 DSCP 

RW; unsignedInt [0:63] 

default 0

M

P

 EthernetPriority 

RW; unsignedInt [0:7] 

default 0

M

P

 ROMTime 

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.12345

M

P

 BOMTime 

R; dateTime

Begin of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 EOMTime 

R; dateTime

End of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 TestBytesReceived 

R; unsignedInt

Defined in TR-098　　

M

P

 TotalBytesReceived 

R; unsignedInt

Defined in TR-098　　

M

P

 TCPOpenRequestTime

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.123456

M

P

 TCPOenResponseTime

R; dateTime

Response time in UTC, which MUST be specified to microsecond precision.
For example: 2008-04-09T15:01:05.123456

M

Device.Capabilities. PerformanceDiagnostic.

(only available for TR-143-enabled CPE)

P

UploadTransports

R; string

“HTTP”
”FTP” (OPTIONAL)

P

Device.UploadDiagnostics.

(only available for TR-143-enabled CPE)

P

 DiagnosticsState 

RW; string

“None”
”Requested”
”Completed”
”Error_InitConnectionFailed”
”Error_NoResponse”
”Error_TransferFailed”
”Error_PasswordRequestFailed”
”Error_LoginFailed”
”Error_NoTransferMode”
”Error_NoPASV”
”Error_IncorrectSize”
”Error_Timeout”

M

P

 Interface 

RW; string(256)

Can be empty

M

P

 UploadURL 

RW; string(256)

Defined in TR-098　

M

P

 DSCP 

RW; unsignedInt [0:63] 

default 0

M

P

 EthernetPriority 

RW; unsignedInt [0:7] 

default 0

M

P

 TestFileLength 

RW; unsignedInt

The size of the file (in bytes) to be uploaded to the server.
The max value is 4294967295

M

P

 ROMTime 

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.12345

M

P

 BOMTime 

R; dateTime

Begin of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 EOMTime 

R; dateTime

End of transmission time in UTC, which MUST be specified to microsecond precision
For example:
2008-04-09T15:01:05.123456

M

P

 TotalBytesSent 

R; unsignedInt

Defined in TR-098　　

M

P

 TCPOpenRequestTime

R; dateTime

Request time in UTC, which MUST be specified to microsecond precision.
For example:
2008-04-09T15:01:05.123456

M

P

 TCPOenResponseTime

R; dateTime

Response time in UTC, which MUST be specified to microsecond precision.
For example: 2008-04-09T15:01:05.123456

M
               

 

3.9   VoIP Profile

The following table defines the parameters required for VoIP-enabled device management.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.

M

Enable

RW; boolean

Defined in TR-104

M

M

Reset

W; boolean

Defined in TR-104

P

M

NumberOfLines

R; unsignedInt

Defined in TR-104

P

M

SignalingProtocol

RW; string(64)

Defined in TR-104

P

M

DTMFMethod

RW; string(64)

Defined in TR-104

Enumeration of:

“InBand”
“RFC2833”

“SIPInfo”

P

M

DTMFMethodG711

RW; string(64)

Defined in TR-104

P

M

STUNEnable

RW; boolean

Defined in TR-104

P

M

STUNServer

RW; string(256)

Defined in TR-104

P

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.Line.{i}.

M

Enable

RW; string

Enumeration of:

“Disabled”

“Quiescent”

“Enabled”

M

M

DirectoryNumber

RW; string(32)

Directory number associated with this line.  May be used to identify the line to the user.

In case of H.323 signaling, this MUST be an E.164 number.

M

M

Status

R; string

Defined in TR-104

Enumeration of:

“Up”

“Initializing”

“Registering”

“Unregistering”

“Error”

“Testing”

“Quiescent”

“Disabled”

P

M

Callstate

R; string

Defined in TR-104

Enumeration of:
“Idle”
“Calling”
“Ringing”
“Connecting”
“InCall”
“Hold”
“Disconnecting”

P

M

PhyReferenceList

RW; string(32)

Defined in TR-104

A comma separated list of Physical Interface Identifiers that this Line is associated with.

P

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.Line.{i}.SIP.

M

AuthUserName

RW; string(128)

Defined in TR-104

M

M

AuthPassword

W; string(128)

Defined in TR-104

M

M

URI

RW; string(389)

Defined in TR-104

M

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Codec.

M

TransmitCodec

R; string(64)

Defined in TR-104

P

M

ReceiveCodec

R; string(64)

Defined in TR-104

P

.Services.VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Codec.List.{i}.

M

EntryID

R; unsignedInt[1:]

Defined in TR-104

P

M

Codec

R; string(64)

Defined in TR-104

Enumeration of:

“G.711MuLaw”

“G.711ALaw”

“G.729a”

“G.723.1”

P

P

BitRate

R, unsignedInt

Defined in TR-104

P

M

PacketizationPeriod

RW; string(64)

Defined in TR-104

P

M

SilenceSuppression

RW; boolean

Defined in TR-104

P

M

Enable

RW; boolean

Defined in TR-104

True (default)

P

M

Priority

RW; unsignedInt

[1:]

Defined in TR-104

P

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.RTP.

M

LocalPortMin

RW; unsignedInt[0:65535]

Defined in TR-104

P

M

LocalPortMax

RW; unsignedInt[0:65535]

Defined in TR-104

P

M

DSCPMark

RW; unsignedInt[0:63]

Defined in TR-104

P

M

VLANIDMark  

RW; unsignedInt[0:128]

Defined in TR-104

P

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.SIP.

M

ProxyServer

RW; string(256)

Defined in TR-104

M

M

ProxyServerPort

unsignedInt [0:65535]

Defined in TR-104

5060 (default)

M

M

RegistrarServer

RW; string(256)

Defined in TR-104

M

M

RegistrarServerPort

RW; unsignedInt [0:65535]

Defined in TR-104

5060 (default)

M

M

UserAgentDomain

RW; string(256)

Defined in TR-104

M

M

UserAgentPort

RW; unsignedInt [0:65535]

Defined in TR-104

5060 (default)

M

M

OutboundProxy

RW; string(256)

Defined in TR-104

P

M

OutboundProxyPort

RW; unsignedInt

[0:65535]

Defined in TR-104

5060 (default)

P

M

RegistrationPeriod

RW; ungignedInt[1:]

Defined in TR-104

P

M

RegisterExpires

RW; unsignedInt [1:]

Defined in TR-104

P

M

Organization

RW; string(256)

Defined in TR-104

P

P

UseCodecPriorityInSDPResponse

RW; boolean

Defined in TR-104

P

P

DSCPMark

RW; unsignedInt [0:63]

Defined in TR-104

0 (default)

P

P

VLANIDMark  

RW; int[-1:]

Defined in TR-104

P

P

EthernetPriorityMark  

RW; int[-1:]

Defined in TR-104

P

3.10      Statistics Profile

The following table defines the parameters required for device statistics management.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.

M

WANAccessType

R; string

Defined in TR-098

Enumeration of:

“DSL”

“Ethernet”

“POTS”

“X_WIMAXFORUM_WiMAX”

P

M

TotalPacketsSent

R; unsignedInt

The cumulative counter for total number of packets (IP or PPP) sent upstream across all connection service instances on the WAN device.

Defined in TR-098

P

M

TotalPacketsReceived

R; unsignedInt

The cumulative counter for total number of packets (IP or PPP) received downstream across all connection service instances on the WAN device.

Defined in TR-098

P

InternetGatewayDevice.Services.VoiceService.{i}.VoiceProfile.{i}.Line.{i}.Stats.

M

PacketsSent

R; unsignedInt

Total number of RTP packets sent for this line, device erases the value while next call receives. Defined in TR-104

P

M

PacketsReceived

R; unsignedInt

Total number of RTP packets received for this line, device erases the value while next call receives.

Defined in TR-104

P

M

PacketsLost

R; unsignedInt

Total number of RTP packets that have been lost for this line, device erases the value while next call receives.

Defined in TR-104

P

3.11      Time Profile

If Time/NTP/SNTP function is present in the CPE, the following table defines the parameters required for Time management.

 

Parameter Name

Type

Description

Device Support

InternetGatewayDevice.Time.

M

Enable

RW; boolean

Defined in TR-098

P

M

Status

R; string

Defined in TR-098

Enumeration of:
"Disabled"
"Unsynchronized"
"Synchronized"
"Error_FailedToSynchronize"

P

M

NTPServer1

RW; string(64)

Defined in TR-098

P

M

LocalTimeZone

RW; string(6)

Defined in TR-098

The local time offset from UTC in the form:
+hh:mm
-hh:mm

P

 

4.   Appendix A. Interface and Flow Definitions

This section specifies the Interface and Flow between OneMS ACS and CPE.

4.1   CPE Initiated Secure Connection Flow 

4.1.1 Scenario

The device initiates the connection to ACS.

4.1.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

4.1.3 Required Parameters

SetParameterValues

GetParameterValues

 

 

 

 

4.1.4 Interface Sequence and Description

 

Step 1             CPE sends inform to ACS.

Step 2             ACS sends the challenge for authentication.

Step 3             CPE sends authentication information with inform to ACS.

Step 4             ACS sends inform response to CPE.

Step 5             The device sends an empty HTTP Post to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

 

 

4.2   ACS Initiated Secure Connection Flow

4.2.1 Scenario

Every time ACS initials session to notify CPE.

4.2.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

4.2.3 Required Parameters

None

4.2.4 Interface Sequence and Description

 

Step 1             ACS sends connection request to CPE.

Step 2             CPE sends the challenge for authentication.

Step 3             ACS sends connection request authentication information to CPE.

Step 4             CPE sends inform to ACS.

Step 5             ACS sends the challenge for authentication.

Step 6             CPE sends authentication information with inform to ACS.

Step 7             ACS sends inform response to CPE.

Step 8             The device sends an empty HTTP Post to ACS.

Step 9             ACS sends an empty HTTP Post to end this session.

 

4.3   Get Parameter Attribute Flow

4.3.1 Scenario

OneMS sends the request to a specific device for getting the parameter attributes.

4.3.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

GetParameterAttributesResponse

GetParameterAttributes

4.3.3 Required Parameters

Any available parameters

4.3.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method of GetParameterAttributes to CPE.

Step 5             CPE sends GetParameterAttributesResponse to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

 

4.4   Set Parameter Attribute Flow

4.4.1 Scenario

OneMS sends the request to a specific device for setting the parameter attributes.

4.4.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterAttributesResponse

SetParameterAttributes

4.4.3 Required Parameters

Any available parameters

 

4.4.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method of SetParameterAttributes to CPE.

Step 5             CPE sends SetParameterAttributesResponse to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

4.5   Download Device Configuration File Flow

4.5.1 Scenario

OneMS sends the request to a specific device for downloading device configuration file.

4.5.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

DownloadResponse

Download

TransferCompleteResponse

TransferComplete

4.5.3 Required Parameters

None

4.5.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls Download method for device to download configuration file.

Step 5             The device sends download response to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

Step 7             The device download configuration files from File Server.

Step 8             In the next session, the device sends inform with EventCode TRANSFER COMPLETE to ACS.

Step 9             ACS sends inform response to device.

Step 10          The device sends TransferComplete package to ACS.

Step 11          ACS sends TransferCompleteResponse package to device.

Step 12          The Device sends an empty HTTP Post.

Step 13          ACS sends an empty HTTP Post to end this session.

 

 

 

4.6   Upload Device Configuration File Flow

4.6.1 Scenario

OneMS sends the request to a specific device for uploading device configuration file.

4.6.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

UploadResponse

Upload

TransferCompleteResponse

TransferComplete

4.6.3 Required Parameters

None

4.6.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls Upload method for device to upload configuration file.

Step 5             The device sends upload response to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

Step 7             The device upload configuration files to File Server.

Step 8             In the next session, the device sends inform with EventCode TRANSFER COMPLETE to ACS.

Step 9             ACS sends inform response to device.

Step 10          The device sends TransferComplete package to ACS.

Step 11          ACS sends TransferCompleteResponse package to device.

Step 12          The Device sends an empty HTTP Post.

Step 13          ACS sends an empty HTTP Post to end this session.

 

 

4.7   Upload Device Log File Flow

4.7.1 Scenario

OneMS sends the request to a specific device for uploading device log file.

4.7.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

UploadResponse

Upload

TransferCompleteResponse

TransferComplete

4.7.3 Required Parameters

None

4.7.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls Upload method for device to upload log file.

Step 5             The device sends upload response to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

Step 7             The device upload log files to File Server.

Step 8             In the next session, the device sends inform with EventCode TRANSFER COMPLETE to ACS.

Step 9             ACS sends inform response to device.

Step 10          The device sends TransferComplete package to ACS.

Step 11          ACS sends TransferCompleteResponse package to device.

Step 12          The Device sends an empty HTTP Post.

Step 13          ACS sends an empty HTTP Post to end this session.

 

4.8   Get Parameter Value Flow

4.8.1 Scenario

OneMS sends the request to a specific device for getting parameter values.

4.8.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

GetParameterValuesResponse

GetParameterValues

4.8.3 Required Parameters

Any available parameters

4.8.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method of GetParameterValues to device.

Step 5             The device sends GetParameterValuesResponse to ACS.

Step 6             ACS sends an empty HTTP Post to end this session.

 

4.9   Value Changed Notify Flow

4.9.1 Scenario

OneMS sends the request to a specific device for setting parameter attributes to 1 or 2, and device will notify OneMS when the parameter values are changed.

4.9.2 Required RPC Methods Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterAttributesResponse

SetParameterAttributes

4.9.3 Required Parameters

Any available parameters

4.9.4 Interface Sequence and Description

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method of SetParameterAttributes to device.

Step 5             The device sends SetParameterAttributesResponse to ACS.

Step 6             ACS sends Empty HTTP Packet to device to end this session.

Step 7             If the parameter value is changed, device sends inform with EventCode “4 VALUE CHANGE” to ACS.

Step 8             ACS sends inform response to device.

Step 9             The device sends an empty HTTP Post to ACS.

Step 10          ACS sends an empty HTTP Post to end this session.

 

4.10      Device Reboot Flow

4.10.1          Scenario Description

OneMS sends the request to a specific device for rebooting it.

4.10.2          Related RPC Method Calling

e

Device Calling

OneMS Calling

Inform

InformResponse

RebootResponse

Reboot

 家终端

4.10.3          Related Parameters

None

 ITMS

4.10.4          Interface Sequence and Description

 

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method Reboot.

Step 5             The Device responses RebootResponse, and do rebooting.

Step 6             The device sends inform，and EventCode includes BOOT and M Reboot at least.

Step 7             ACS sends inform response to device.

Step 8             The device sends an empty HTTP Post to ACS.

Step 9             ACS sends an empty HTTP Post to end this session.

 

4.11      Device Factory Reset Flow

4.11.1          Scenario Description

OneMS sends the request to a specific device for doing factory reset.

4.11.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

FactoryResetResponse

FactoryReset

 家终端

4.11.3          Related Parameters

None

4.11.4          Interface Sequence and Descriptions

 

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method FactoryReset.

Step 5             The Device responses FactoryResetResponse.

Step 6             ACS sends an empty HTTP Post to end this session.

Step 7             In the next session, the devices sends inform with EventCode BOOTSTRAP at least.

Step 8             ACS sends inform response to device.

Step 9             The device sends an empty HTTP Post to ACS.

Step 10          ACS sends an empty HTTP Post to end this session.

 

 

4.12      Device Firmware Upgrade Flow

4.12.1          Scenario Description

OneMS sends the request to a specific device for firmware upgrading.

4.12.2          Related RPC Method Calling

e

Device Calling

OneMS Calling

Inform

InformResponse

DownloadResponse

Download

TransferComplete

TransferCompleteResponse

 家终端

4.12.3          Related Parameters

None

4.12.4          Interface Sequence and Descriptions

 

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST.

Step 2             ACS responses Inform.

Step 3             The Device sends an empty HTTP Post.

Step 4             ACS calls RPC method Download.

Step 5             The Device responses DownloadResponse

Step 6             ACS sends an empty HTTP Post to end this session.

Step 7             The Device downloads f/w file from file server

Step 8             In the next session, the device send inform with EventCode TransferComplete at least.

Step 9             ACS sends inform response.

Step 10          Then device sends RPC method TransferComplete

Step 11          ACS sends TransferCompleteResponse

Step 12          Device sends an empty HTTP Post to end the session.

Step 13          In the next session, the device send inform

Step 14          ACS sends inform response.

Step 15          The Device sends an empty HTTP Post.

Step 16          ACS sends an empty HTTP Post to end this session.

 

 

 

Note:

If you set upgradeBeforeTransferComplete=true in OneMS DD file, OneMS will check the inform with 7 TransferComplete and deal with the empty response in step 12 to do the following tasks. Or it will wait the next inform to do the following tasks, session as step 13-16.

 

4.13      IP Ping

4.13.1          Scenario Description

OneMS sends the ping request to test device connection with servers or other devices.

4.13.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterValuesResponse

SetParameterValues

GetParameterValuesResponse

GetParameterValues

 家终端

4.13.3          Related Parameters

SetParameterValues

GetParameterValues

DiagnosticsState

SuccessCount

Interface

FailureCount

Host

AverageResponseTime

NumberOfRepetitions

MinimumResponseTime

Timeout

MaximumResponseTime

DataBlockSize

 

DSCP

 

 

4.13.4          Interface Sequence and Descriptions

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST

Step 2             ACS responses Inform

Step 3             The Device sends an empty HTTP Post

Step 4             ACS calls RPC method SetParameterValues of IP Ping Diagnostics

Step 5             The Device responses SetParameterValuesResponse, and ping the host you set

Step 6             The device sends inform，and EventCode includes Diagnostics Complete

Step 7             ACS response inform

Step 8             The Device sends an empty HTTP Post

Step 9             ACS calls RPC method GetParameterValues of IP Ping Diagnostics

Step 10          The Device responses GetParameterValuesResponse

Step 11          ACS sends an empty HTTP Post to end this session

 

4.14      Trace Route

4.14.1          Scenario Description

OneMS sends the trace route request to test the route connection with servers or other devices.

 

4.14.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterValuesResponse

SetParameterValues

GetParameterValuesResponse

GetParameterValues

E 家终端

4.14.3          Related Parameters

SetParameterValues

GetParameterValues

DiagnosticsState

ResponseTime 

Interface

RouteHopsNumberOfEntries 

Host

HopHost 

NumberOfRepetitions

 

Timeout

 

DataBlockSize

 

DSCP

 

MaxHopCount 

 

 

4.14.4          Interface Sequence and Descriptions

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST

Step 2             ACS responses Inform

Step 3             The Device sends an empty HTTP Post

Step 4             ACS calls RPC method SetParameterValues of TraceRoute Diagnostics

Step 5             The Device responses SetParameterValuesResponse, and trace routes to the host you set

Step 6             The device sends inform, and EventCode includes Diagnostics Complete

Step 7             ACS response inform

Step 8             The Device sends an empty HTTP Post

Step 9             ACS calls RPC method GetParameterValues of TraceRoute Diagnostics

Step 10          The Device responses GetParameterValuesResponse

Step 11          ACS sends an empty HTTP Post to end this session

 

 

4.15      Download Performance

4.15.1          Scenario Description

OneMS sends the request to a specific device to test the download streaming capabilities and responses of the CPE and the WAN connection.

4.15.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterValuesResponse

SetParameterValues

GetParameterValuesResponse

GetParameterValues

E 家终端

4.15.3          Related Parameters

SetParameterValues

GetParameterValues

DownloadTransports

ROMTime 

DiagnosticsState

BOMTime 

Interface

EOMTime 

DownloadURL 

TestBytesReceived 

DSCP 

TotalBytesReceived 

EthernetPriority 

TCPOpenRequestTime

 

TCPOenResponseTime

 

4.15.4          Interface Sequence and Descriptions

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST

Step 2             ACS responses Inform

Step 3             The Device sends an empty HTTP Post

Step 4             ACS calls RPC method SetParameterValues of Download Diagnostics

Step 5             The Device responses SetParameterValuesResponse, and download files from the interface you set

Step 6             The device sends inform, and EventCode includes Diagnostics Complete

Step 7             ACS response inform

Step 8             The Device sends an empty HTTP Post

Step 9             ACS calls RPC method GetParameterValues of Download Diagnostics

Step 10          The Device responses GetParameterValuesResponse

Step 11          ACS sends an empty HTTP Post to end this session

 

 

4.16      Upload Performance

4.16.1          Scenario Description

OneMS sends the request to a specific device to test the upload streaming capabilities and responses of the CPE and the WAN connection.

4.16.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterValuesResponse

SetParameterValues

GetParameterValuesResponse

GetParameterValues

E 家终端

4.16.3          Related Parameters

SetParameterValues

GetParameterValues

UploadTransports

ROMTime 

DiagnosticsState

BOMTime 

Interface

EOMTime 

UploadURL 

TotalBytesSent 

DSCP 

TCPOpenRequestTime

EthernetPriority 

TCPOenResponseTime

TestFileLength

 

 

4.16.4          Interface Sequence and Descriptions

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST

Step 2             ACS responses Inform

Step 3             The Device sends an empty HTTP Post

Step 4             ACS calls RPC method SetParameterValues of Upload Diagnostics

Step 5             The Device responses SetParameterValuesResponse, and upload files from the interface you set

Step 6             The device sends inform, and EventCode includes Diagnostics Complete

Step 7             ACS response inform

Step 8             The Device sends an empty HTTP Post

Step 9             ACS calls RPC method GetParameterValues of Upload Diagnostics

Step 10          The Device responses GetParameterValuesResponse

Step 11          ACS sends an empty HTTP Post to end this session

 

4.17      ATMF5 Loopback

4.17.1          Scenario Description

OneMS sends the request to a specific device to provide access to an ATM-layer F5 OAM loopback test.

4.17.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterValuesResponse

SetParameterValues

GetParameterValuesResponse

GetParameterValues

E 家终端

4.17.3          Related Parameters

SetParameterValues

GetParameterValues

DiagnosticsState

SuccessCount

NumberOfRepetitions

FailureCount

Timeout

AverageResponseTime

 

MinimumResponseTime

 

MaximumResponseTime

 

4.17.4          Interface Sequence and Descriptions

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST

Step 2             ACS responses Inform

Step 3             The Device sends an empty HTTP Post

Step 4             ACS calls RPC method SetParameterValues of ATM F5 Loopback  Diagnostics

Step 5             The Device responses SetParameterValuesResponse, and do the testing

Step 6             The device sends inform, and EventCode includes Diagnostics Complete

Step 7             ACS response inform

Step 8             The Device sends an empty HTTP Post

Step 9             ACS calls RPC method GetParameterValues of ATM F5 Loopback Diagnostics

Step 10          The Device responses GetParameterValuesResponse

Step 11          ACS sends an empty HTTP Post to end this session

 

4.18      DSL Loopback

4.18.1          Scenario Description

OneMS sends the request to a specific device for testing the DSL interface of it.

4.18.2          Related RPC Method Calling

Device Calling

OneMS Calling

Inform

InformResponse

SetParameterValuesResponse

SetParameterValues

GetParameterValuesResponse

GetParameterValues

E 家终端

4.18.3          Related Parameters

SetParameterValues

GetParameterValues

LoopDiagnosticsState

ACTPSDds 

 

ACTPSDus 

 

ACTATPds 

 

ACTATPus 

 

HLINSCds 

 

HLINSCus 

 

HLINpsds 

 

HLINpsus 

 

QLNpsds

 

SNRpsds

 

BITSpsds

 

GAINSpsds

 

4.18.4          Interface Sequence and Descriptions

 

 

Step 1             The Device sends inform, which includes EventCode CONNECTIONREQUST

Step 2             ACS responses Inform

Step 3             The Device sends an empty HTTP Post

Step 4             ACS calls RPC method SetParameterValues of DSL Loopback Diagnostics

Step 5             The Device responses SetParameterValuesResponse, and do the testing

Step 6             The device brings down the DSL connection while testing, then establishes a new connection

Step 7             The device sends inform, and EventCode includes Diagnostics Complete

Step 8             ACS response inform

Step 9             The Device sends an empty HTTP Post

Step 10          ACS calls RPC method GetParameterValues of DSL Loopback Diagnostics

Step 11          The Device responses GetParameterValuesResponse

Step 12          ACS sends an empty HTTP Post to end this session

 

 

Note:

  1. The session must be end by device sending empty HTTP package.
  2. The device sending inform with CONNECTIONREQUST must be notified by OneMS.