Professional Documents
Culture Documents
rnet
ISDN
DSL
-in
WLA
Plug
er
Pow
Ethe
rnet
Thomson Gateway
Thomson Gateway
TR-069 Configuration Guide
R7.4 and higher
Copyright
Copyright 1999-2008 Thomson. All rights reserved.
Distribution and copying of this document, use and communication of its contents is not permitted without written authorization
from Thomson. The content of this document is furnished for informational use only, may be subject to change without notice,
and should not be construed as a commitment by Thomson. Thomson assumes no responsibility or liability for any errors or
inaccuracies that may appear in this document.
Thomson Telecom Belgium
Prins Boudewijnlaan, 47
B-2650 Edegem
Belgium
http://www.thomson-broadband.com
Trademarks
The following trademarks may be used in this document:
Apple and Mac OS are registered trademarks of Apple Computer, Incorporated, registered in the United States and
other countries.
Bluetooth word mark and logos are owned by the Bluetooth SIG, Inc.
Ethernet is a trademark of Xerox Corporation.
Wi-Fi, WMM and the Wi-Fi logo are registered trademarks of the Wi-Fi Alliance. "Wi-Fi CERTIFIED", "Wi-Fi ZONE",
"Wi-Fi Protected Access", "Wi-Fi Multimedia", "Wi-Fi Protected Setup", WPA", WPA2" and their respective logos are trademarks of the Wi-Fi Alliance.
Microsoft, MS-DOS, Windows, Windows NT and Windows Vista are either registered trademarks or trademarks
of Microsoft Corporation in the United States and/or other countries.
Adobe, the Adobe logo, Acrobat and Acrobat Reader are trademarks or registered trademarks of Adobe Systems, Incorporated, registered in the United States and/or other countries.
Other brands and product names may be trademarks or registered trademarks of their respective holders.
Document Information
Status: v1.0 (May 2008)
Reference: E-DOC-CTC-20071119-0003
Short Title: Config Guide: TR-069 R7.4 and higher
Contents
Introduction.................................................................................. 3
1.1
1.2
1.3
2.1
2.1.1
2.1.2
2.2
Configuring CWMP........................................................................................ 18
2.2.1
2.2.2
2.2.3
2.2.4
2.2.5
2.3
3.1
Firmware Upgrade......................................................................................... 32
3.1.1
3.1.2
3.1.3
3.1.4
3.2
3.2.1
3.2.2
STS Files................................................................................................................................................ 44
3.2.3
4.1
4.2
Diagnostics ................................................................................................... 50
4.3
E-DOC-CTC-20071119-0003 v1.0
Contents
4.4
4.5
5.1
5.2
5.3
5.4
Service Provisioning.................................................................. 69
6.1
VoIP............................................................................................................... 70
6.2
WLAN ............................................................................................................ 73
6.3
Time .............................................................................................................. 76
6.4
6.5
6.6
6.7
Access Rights................................................................................................ 85
6.8
6.9
6.10
6.11
6.12
E-DOC-CTC-20071119-0003 v1.0
ii
A caution warns you about potential problems or specific precautions that need to be taken.
Terminology
Generally, the Thomson Gateway123 will be referred to as Wireless USB Adaptor in this TR-069 Configuration
Guide.
Typographical Conventions
Following typographical convention is used throughout this manual:
Sample text indicates a GUI element (commands on menus and buttons, dialog box elements, file
names, paths and folders).
Example: On the File menu, click Open to open a file.
E-DOC-CTC-20071119-0003 v1.0
Overview
This TR-069 Configuration Guide provides technical information on TR-069 and how this relates to the
various Thomson Gateway products. In the first chapter, a brief introduction to the TR-069 CWMP protocol
and the TR-098 IGD data model is presented. The following chapter gives detailed information on the
configuration of CWMP on the Thomson Gateway using CLI commands. The last chapters focus on the
different use cases that are currently supported using CWMP.
This document is structured as follows:
Topic
Page
1 Introduction
13
31
47
5 WAN Connections
59
6 Service Provisioning
69
7 Zero-Provisioning
101
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
Introduction
Introduction
This chapter provides a short introduction to the TR-069 CWMP protocol and the TR-098 IGD data model.
Overview
This chapter is structured as follows:
Topic
Page
10
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
1.1
Technical Report TR-069 - CPE WAN Management Protocol, DSL Forum, May 2004.
Technical Report TR-069 Amendment 1 - CPE WAN Management Protocol, DSL Forum, November
2006.
Technical Report TR-098 - Internet Gateway Device Version 1.1 Data Model for TR-069, DSL Forum,
September 2005.
Technical Report TR-098 Amendment 1 - Internet Gateway Device data model for TR-069, DSL Forum,
November 2006.
Related documents
Several DSL-Forum documents are related to TR-069 and TR-098, specifying data models for devices other
than an IGD (for example STB, PCs, NAS), or specifying extensions of the IGD data model.
Following specifications are relevant to this configuration guide:
TR-064 LAN-side DSL CPE configuration, May 2004: this document provides a standard interface for
PC-based (LAN-side) install applications. It defines LAN-side CPE configuration.
TR-104 Provisioning parameters for VoIP CPE, September 2005: this document defines a generic
VoiceService data model for provisioning of VoIP CPEs, for example an Integrated Access Device (IAD) or
an Analogue Telephone Adapter (ATA). The model supports SIP, MGCP and H323 signalling protocols.
TR-106 Amendment 1 Data model template for TR-069 enabled devices, November 2006: this
document defines a Device data model for any TR-069 enabled LAN device that is not an IGD. This model
supports the DeviceSummary parameter.
TR-111 Applying TR-069 to remote management of home networking devices, December 2005: this
document defines two mechanisms that extend TR-069 with remote management of LAN devices behind
an Internet Gateway.
LAN Device-gateway association: this mechanism allows an ACS managing a LAN device to identify
the associated gateway through which that device is connected. The gateway and LAN device
exchange their device identity (OUI-product class-serial number) via DHCP option 125.
Connection Request via NAT gateway: this mechanism allows an ACS to initiate a TR-069 session
with a LAN device that is operating behind a NAT gateway. STUN (Simple Traversal of UDP through
NAT) is used between the LAN device and the ACS.
In addition, extensions to the Device and InternetGatewayDevice data models are defined.
WT-107 Internet Gateway Device data model (TR-098 issue 2), September 2006: this document extends
the IGD data model with DHCP conditional serving, HPNAv3, MoCA, 802.1X,...
WT-135 Data model for TR-069 enabled STB: this document defines a STBDevice data model for a STB
(Set-Top Box) CPE as an extension of TR-069.
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
WT-140 TR-069 data model for storage service enabled devices: this document defines a
StorageService data model for a device that maintains a storage service, such as a Network Attached
Storage (NAS) device, as an extension of TR-069.
PD-128 version 6 Interoperability test plan for TR-069 plugfests, June 2006: this document defines
TR-069 tests and their expected outcome. These tests are used during the TR-069 plugfests as tests to
perform. The DSL Forum regularly organizes TR-069 plugfest test events where all participating CPE
devices can test against all participating ACS servers. The document is also the de facto reference for
TR-069 testing by customers and ACS vendors.
Thomson firmware is interoperability tested with and by ACS partners.
Architecture
Following illustration shows the location of the specifications in the CWMP architecture:
TR-064
LAN CPE Auto-Configuration
CPE
WT-135
STB Model
CPE
TR-106 CWMP enabled
device model template
TR-098 (Am.1)
IGD Model
Provider
IP
Network
Access
Network
ACS
TR-111 CWMP
for home devices
CPE
DSLAM
BRAS
ACS
E-DOC-CTC-20071119-0003 v1.0
CPE
TR-104
VoIP Model
Helpdesk
1| Introduction
1.2
The CPE maintains a TCP connection (persistent HTTP connection) for the duration of the session.
Session establishment
All transaction sessions are established by the CPE, by sending an Inform RPC to the ACS.
We distinguish two types of transaction sessions:
Asynchronous ACS initiated sessions: the CPE establishes a transaction session to the ACS after receipt
of a Connection Request from the ACS.
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
Inform events
The Inform RPC contains the Inform event argument, to indicate the cause(s) of the transaction session
establishment.
Following table gives an overview of the different Inform events and their use:
Event
Description
0 BOOTSTRAP
1 BOOT
2 PERIODIC
3 SCHEDULED
4 VALUE CHANGE
InternetGatewayDevice.DeviceInfo.SoftwareVersion
InternetGatewayDevice.DeviceInfo.ProvisioningCode
InternetGatewayDevice.ManagementServer.ConnectionRequestURL
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{j}.
WAN{*}Connection.{k}.ExternalIPAddress
6 CONNECTION REQUEST
7 TRANSFER COMPLETE
8 DIAGNOSTICS COMPLETE
M <method name>
Reboot
Download
ScheduleInform
Upload (optional)
Initial handshake
The initial handshake between the CPE and the ACS takes place when the CPE contacts the ACS for the very
first time or due to a change of the ACS URL.
Following actions are taken during the initial handshake:
The CPE sends an initial Inform RPC with the 0 BOOTSTRAP event.
The ACS requests the list of methods that are supported by the CPE using the GetRPCMethods RPC.
The ACS activates the required services on the CPE, according to the activation policies. For example,
the ACS configures the voice service and wireless service.
Forced reboot
The Reboot RPC causes the CPE to reboot. This forced reboot might be desired to restart the Thomson
Gateway clearing all state.
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
When the CPE receives a Reboot RPC from the ACS, following steps are executed:
1
The ongoing transaction session is finalized. This means that all outstanding requests are sent and all
responses are received. After finalization, the ongoing transaction session is closed.
The CommandKey argument of the Reboot message must be remembered across the reboot via either:
Writing it to the memory prozone. This is a memory protected zone that is not reinitialized after a
warm reboot.
Writing it to the configuration file (user.ini).
Session re-establishment
In some cases, the TCP connection is closed before the transaction session is completed. For example, the
session is interrupted by the ACS. If necessary, the CPE re-establishes the TCP connection to the ACS.
In this case, the Inform RPC contains:
Inform event: if the session is re-established because of a pending TransferComplete RPC to be sent to
the ACS, the Inform event is 7 TRANSFER COMPLETE. In other cases, the Inform message contains the
undelivered Inform events from the interrupted session.
Cookie: the Inform message includes the transaction Cookie (if received from the ACS during the
transaction session) as HTTP header field.
Factory reset
The FactoryReset RPC resets the CPE to its factory default state. When a problem occurs and the cause is not
found, a reset to (pre-provisioned) ISP defaults via the FactoryReset RPC triggers the zero-provisioning use
case. Although some user configuration might be lost, a reset to factory defaults guarantees autoconfiguration and service activation as described in the Zero-provisioning use case.
When the CPE receives a FactoryReset RPC from the ACS, following steps are executed:
1
The ongoing transaction session is finalized. This means that all outstanding requests are sent and all
responses are received. After finalization, the ongoing transaction session is closed.
A configuration load is performed: in absence of the user configuration file, the service provider
defaults (ISP.def) are loaded. In absence of these service provider defaults, factory defaults are
loaded.
Download
The Download RPC may be used by an ACS to cause the CPE to download a specified file from the designated
location.
When the CPE receives a Download RPC from the ACS, following steps are executed:
A DownloadResponse RPC is sent with Status argument set to 1 (the download is not yet completed).
Whether or not steps are executed before the file transfer, depends on the FileType argument of the
Download RPC. For more information, see 3.1 Firmware Upgrade on page 32 and 3.2 Configuration
Update on page 41.
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
File transfer is initiated: a HTTP GET message is sent by the CPE to the file server.
A new transaction session to send the TransferComplete RPC is established after loading the downloaded
configuration file or firmware image. The exact steps depend on the FileType argument of the Download
RPC. For more information, see 3.1 Firmware Upgrade on page 32 and 3.2 Configuration Update on
page 41.
The Download RPC can also be triggered from the CLI. To this end, use the CLI command
:software download and provide the requested Download RPC parameters (filetype, url,
username, password, filesize, targetfilename).
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
1.3
InternetGatewayDevice
DeviceInfo
Service
ManagementServer
Service
DeviceConfig
Service
WANDevice
WANCommonInterfaceConfig
Service
WAN***InterfaceConfig
Service
WANConnectionDevice
WAN*LinkConfig
Service
WAN**Connection Service
Time
Service
UserInterface
Service
LANDevice
Layer3Forwarding
Service
Layer2Bridging
Service
LANHostConfigManagement
LANDevice
Service
LAN****InterfaceConfig Service
Hosts
Service
QueueManagement
Service
WLANConfiguration Service
IPPingDiagnostics
Service
X_000E50_AccessRights
Service
X_000E50_Firewall
Service
X_000E50_Connection
Service
Services
X_000E50_NATApplicationList
Service
X_000E50_DynamicDNS
Service
X_000E50_RemoteAccess
Service
VoiceService
Capabilities
Service
VoiceProfile Service
X_000E50_UAMapping
Service
X_000E50_ParentalControl
Service
PhyInterface Service
*
**
***
****
10
DSL, Ethernet
IP, PPP
DSL, Ethernet
Ethernet, USB
E-DOC-CTC-20071119-0003 v1.0
1| Introduction
Path names
To identify a parameter or object in the data model, path names are used. Both complete and partial path
names are supported:
Partial path name: a partial path name ends with a . (dot) and is the name of an object. If multiple
instances of an object can exist, the object name is followed by the place holder {i}.. To identify a single
object instance, this place holder must be replaced by an instance number.
For example InternetGatewayDevice.DeviceInfo. or InternetGatewayDevice.WANDevice.{i}..
To identify the full data model tree, use the partial path name InternetGatewayDevice..
Following illustration shows some examples:
InternetGatewayDevice.DeviceInfo.SoftwareVersion
Object
Object
Parameter
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.1.WANPPPConnection.1.ExternalIPAddress
Object
Object instance
Object instance
Object instance
Parameter
E-DOC-CTC-20071119-0003 v1.0
11
1| Introduction
12
E-DOC-CTC-20071119-0003 v1.0
Introduction
This chapter describes in detail the configuration of CWMP on the Thomson Gateway using CLI commands.
This includes the configuration of the TLS/SSL client and certificates, the CWMP service manager and
daemon, and the state checks to detect service activity.
CWMP is not configurable via the GUI (Graphical User Interface).
Overview
This chapter is structured as follows:
Topic
Page
14
18
28
E-DOC-CTC-20071119-0003 v1.0
13
2.1
Configuring TLS
Introduction
The use of TLS/SSL is optional.
Whether or not to use TLS/SSL is derived form the ACS URL scheme or file URL scheme:
To display the transport protocol and port used by the HTTP and HTTPS services, execute following
commands:
=>:service system list name=HTTP
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 HTTP
tcp
80
enabled
=>:service system list name=HTTPs
Idx Name
Protocol
SrcPort DstPort Group
State
--------------------------------------------------------------------------------1 HTTPs
tcp
443
enabled
Overview
This section is structured as follows:
Topic
14
Page
15
16
E-DOC-CTC-20071119-0003 v1.0
2.1.1
TLS Client
:
:
:
:
enabled
enabled
disabled
disabled
State: this parameter indicates the state of the TLS client. By default, the TLS client is enabled.
Auth-serv: if this parameter is enabled, the TLS client (Thomson Gateway) requests authentication of the
TLS server (ACS). By default, this parameter is enabled.
Valid-date: if this parameter is enabled, the TLS client checks the validity of the date of a received
certificate.
Valid-domain: if this parameter is enabled, the TLS client checks the domain of a received certificate.
E-DOC-CTC-20071119-0003 v1.0
15
2.1.2
TLS Certificates
Client authentication: if the Thomson Gateway (TLS client) is requested by the ACS (TLS server) to send
its certificate, the Thomson Gateway must reply with its own certificate. Client authentication may be
useful if the ACS needs to send sensitive data to the Thomson Gateway.
Server authentication: the Thomson Gateway (TLS client) is responsible for checking the ACS (TLS
server) identity. Requesting the ACS to authenticate makes sure the Thomson Gateway connects to a
trusted ACS. This avoids malicious people to connect to the Thomson Gateway and reconfigure the
whole device.
Server authentication requires ACS certificate validation: the Thomson Gateway receives a server
certificate and validates this with a pre-provisioned CA (Certificate Authority) certificate.
TLS authentication via certificate validation is not supported for TLS/SSL between the Thomson Gateway and
the file server.
16
E-DOC-CTC-20071119-0003 v1.0
Index: if this parameter is used, the displayed list is restricted to the certificate with the corresponding
certificate index.
Expand: if this parameter is enabled, more information is displayed. A base64 dump of each displayed
certificate is shown.
=>:tls acs-client cert list expand=enabled
Put the certificate on the Thomson Gateway. The command put <filename> transfers the file
with name <filename> from the PC directory C:\Documents and Settings\<Username>\ to the
Thomson Gateway directory /dl.
Customization: usually, the Thomson Gateway is pre-provisioned with the correct ACS certificates using
a customized build. The process of embedding the correct certificates in a software build is executed by
Thomson during customization, prior to delivery.
Currently, these certificates are not customizable using the customization wizard, but must be added
manually to the software build by Thomson.
E-DOC-CTC-20071119-0003 v1.0
17
2.2
Configuring CWMP
Introduction
The implementation of CWMP on the Thomson Gateway is split up in two parts:
CWMP daemon: use the daemon to configure all other aspects of the CWMP protocol, including:
Operational mode.
Use of Periodic Inform RPCs.
Use of Connection Requests.
Session termination.
Authentication user names and passwords.
Overview
This section is structured as follows:
Topic
18
Page
19
21
24
25
26
E-DOC-CTC-20071119-0003 v1.0
2.2.1
Introduction
CWMP services consist of two services:
CWMP-C: the CWMP client service. The CWMP client is responsible for establishing connections to the
ACS and for sending Inform RPCs. The CWMP client has a state machine to track RPCs and report their
result (for example via a TransferComplete RPC).
CWMP-S: the CWMP connection request server service. The CWMP connection request server listens on
a TCP port for connection requests, performs HTTP authentication and triggers the CWMP client to
establish a connection to the ACS.
CWMP client
To display the attribute values of the CWMP client service, execute following command:
=>:service system list name=CWMP-C expand=enabled
Idx Name
Protocol
SrcPort DstPort Group
--------------------------------------------------------------------------------1 CWMP-C
tcp
Description................ CPE Wan Management Protocol Client
Properties................. client
Attributes................. state port srcip qoslabel routelabel
User Managed Attributes..... state qoslabel routelabel
Attribute Values :
State...................... (administratively) disabled
Port....................... 0
Source Ip Selection........ auto
QOS Label.................. Management
Route Label................ None
Qoslabel: the Thomson Gateway supports application-based QoS label assignment. If the value of this
attribute differs from none, all CWMP client originated data automatically has a QoS label assigned. This
QoS label determines the internal QoS class of the data.
To assign a specific QoS label to all data, for example the label Interactive, execute following
command:
=>:service system modify name=CWMP-C qoslabel=Interactive
Routelabel: the Thomson Gateway supports application-based Route label assignment. If the value of
this attribute differs from none, all CWMP client originated data automatically has a route label assigned.
This route label can be used for IP forwarding. This enables forwarding all CWMP traffic over a particular
IP interface.
To assign a specific route label to all data, for example the label Interactive, execute following
command:
=>:service system modify name=CWMP-C routelabel=Interactive
E-DOC-CTC-20071119-0003 v1.0
19
Port: this attribute is the port on which the connection request server listens for connection requests. The
default port is 51005.
To assign another port number to the port, execute following command:
=>:service system modify name=CWMP-S port=51006
Log: this attribute is used to enable or disable service logging in the syslog message buffer. By default,
logging is disabled.
To enable logging of the service, execute following command:
=>:service system modify name=CWMP-S log=enabled
Natpmweight: the NAT portmap weight for the service. By default, this attribute has value 30.
To change the value of this attribute, execute following command:
=>:service system modify name=CWMP-S natpmweight=30
20
E-DOC-CTC-20071119-0003 v1.0
2.2.2
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
disabled
full
2
60
180
51005
enabled
43200 s
disabled
000E50-CP0452JT03Y
********
digest
12
0 s
disabled
disabled
disabled
Parameter description
To modify the configuration of the CWMP daemon as seen from the ACS, execute the command
:cwmp config and specify one or several of following optional parameters:
State: if this parameter is enabled, remote management of the Thomson Gateway by an ACS is allowed.
By default, remote management by CWMP is disabled.
This parameter has the same value as the attribute state of the CWMP client service. For
more information, see 2.2.1 CWMP Service Manager on page 19.
PeriodicInform: if this parameter is enabled, the CWMP client establishes a connection to the ACS
periodically. This means that the CWMP client sends an Inform RPC with a configurable frequency. The
frequency is defined by the parameter periodicInfInt.
By default, this parameter is enabled.
PeriodicInfInt: if the parameter periodicInform is enabled, the value of this parameter specifies the
time in seconds (s) between two connection establishments.
By default, the parameter is set to 43200 s. This means that the CWMP client establishes a connection to
the ACS once every 12 hours.
E-DOC-CTC-20071119-0003 v1.0
21
SessionTimeout: this parameter is a number that specifies the HTTP session time-out in seconds (s).
When the CWMP client has received no HTTP messages from the ACS for this time period, the HTTP
session is closed.
By default, this time period is set to 60 s.
NoIpTimeout: this parameter is a number, specifying a time period in seconds (s). After the upload of a
new configuration file, it is possible that the modem can not reach the ACS any more. This means that
the IP connection is down. If this connection is not restored during the configured time period, a roll-back
mechanism is started and the initial configuration file is restored.
By default, the time period is set to 180 s (three minutes).
For more information on the roll-back mechanism, see 3.2.1 Configuration Update
Mechanism on page 42.
MaxEnvelopes: this parameter specifies the maximum number of SOAP envelopes that the CPE accepts
in a single HTTP response. The value of this parameter can be 1 or 2.
By default, the number of SOAP envelopes sent within one HTTP response is limited to 2.
ConnectionRequest: if this parameter is enabled, the CWMP client establishes a connection to the ACS
when it successfully receives a Connection Request notification. These Connection Request notifications
also use HTTP. However, in this case, the ACS acts as the HTTP client and the Thomson Gateway acts as
the HTTP server.
By default, this parameter is disabled.
This parameter has the same value as the attribute state of the CWMP connection request
server service. For more information, see 2.2.1 CWMP Service Manager on page 19.
ConnectionReqPath: this parameter specifies the path the ACS can use to reach the CWMP daemon on
the Thomson Gateway, for example for connection requests. It is used as last part of the
InternetGatewayDevice.ManagementServer.ConnectionRequestURL which is included in the
ParameterList of an Inform RPC.
The value of this parameter is only relevant if the parameter ConnectionRequest is enabled.
ConnectionReqUserName: this parameter specifies a text string that must be used by the ACS as
username to log in. The value of this parameter is only relevant if the parameter ConnectionRequest
is enabled.
The default username is <OUI> - <serial number>. This can be achieved using CLI environment variable
concatenation. To retrieve this information, execute following commands:
=>:env get var=_OUI
000E50
=>:env get var=_PROD_SERIAL_NBR
CP0452JT03Y
ConnectionReqPsswd: this parameter specifies a text string that must be used by the ACS as password to
log in. The value of this parameter is only relevant if the parameter ConnectionRequest is enabled.
ConnectionReqAuth: both HTTP basic and digest authentication can be used for connection requests.
The value of this parameter is only relevant if the parameter ConnectionRequest is enabled. This
parameter is used to select the authentication method to be supported.
None: the ACS asynchronous connection requests are not authenticated.
Basic: HTTP basic authentication is used.
Digest: HTTP digest authentication is used.
By default, HTTP digest authentication is selected.
22
E-DOC-CTC-20071119-0003 v1.0
Qos-class: this parameter specifies the internal QoS class of Thomson Gateway originated CWMP data.
The Thomson Gateway uses 16 internal QoS classes, numbered from 0 (low priority) through 15 (high
priority). With QoS enabled, this makes sure that upstream CWMP data is mapped into the desired QoS
queue, allowing prioritization or guaranteeing a minimum bandwidth.
By default, the assigned internal QoS class is 12.
This parameter is still available for backwards compatibility. However, it is recommended to
use the attribute qoslabel of the CWMP client service. For more information, see
2.2.1 CWMP Service Manager on page 19.
Bootdelayrange: the CWMP client establishes a connection to the ACS on power up. In order to avoid that
several gateways contact the ACS simultaneously after a power failure, a boot delay range can be
specified. This way, excessive network load and ACS load after a power failure is avoided.
If the value of this parameter is larger than 0 seconds (s), a random value is calculated within this range
when the gateway starts up. This value is then used as wait period before connecting to the ACS. The
Inform RPC (with BOOT event) is only sent after this random number of seconds.
This parameter has a value within the range from 0 s through 1024 s. By default, the value of the
parameter is set to 0 s. This means that no wait period is used.
Upgradedelay: the CPE firmware upgrade process can contain several service interrupting steps, for
example if a reboot is required. If this parameter is enabled, the upgrade process is extended with state
checks. If these checks result in a service ongoing boolean parameter, service activity is detected and
the service interrupting steps can be delayed.
For more information on activity checks, see 2.3 Configuring State Checks on page 28.
Am1Termination: session termination is configurable via CLI to be according to the original TR-069
specification or according to the TR-069 Amendment 1 specification.
If this parameter is disabled, session termination according to TR-069 is used. This means that the
CPE terminates a transaction session when all of the following conditions are met:
The ACS has no further requests to send to the CPE. The CPE can conclude this from one of the
following: the most recent ACS HTTP response contains no SOAP envelopes or the most recent
SOAP envelope received from the ACS contains a NoMoreRequests header element equal to 1.
The CPE has received all outstanding response messages from the ACS.
The CPE has sent all outstanding response messages to the ACS.
If this parameter is enabled, session termination according to TR-069 Amendment 1 is used. This
session termination differs from the original TR-069 specification in two aspects:
NoMoreRequests header element is deprecated. This header element will not be used any more.
The ACS concludes that the CPE has no further requests to send if the CPE has sent an empty
HTTP POST during the session (while HoldRequests is false). While according to the original
TR-069, the ACS concludes that the CPE has no further requests to send if the most recent HTTP
POST sent by the CPE is empty (while HoldRequests is false).
PersistentSubscription: this parameter indicates whether or not persistent subscriptions are supported. If
the ACS has a persistent subscription for a specific parameter, the instance number of the corresponding
MBUS object is not changed after a reboot, for example when objects with a lower instance number are
deleted.
By default, this parameter is disabled.
E-DOC-CTC-20071119-0003 v1.0
23
2.2.3
: http://acs-server.com
: 000E50-CP0452JT03Y
: ********
Parameter description
To modify the configuration of the CWMP daemon towards the ACS, execute the command
:cwmp server config and specify one or more of the following optional parameters:
Username: this parameter defines the username for authentication of the Thomson Gateway at the ACS.
The ACS default username is <OUI> - <serial number>. This can be achieved using CLI environment
variable concatenation. To retrieve this information, execute the following commands:
=>:env get var=_OUI
000E50
=>:env get var=_PROD_SERIAL_NBR
CP0452JT03Y
24
Password: this parameter defines the password for authentication of the Thomson Gateway at the ACS.
E-DOC-CTC-20071119-0003 v1.0
2.2.4
Notification Rules
Introduction
The ParameterList argument of an Inform message contains a list of informational parameters and their
values.
The list includes:
Changed parameters: these parameters are sent in the Inform message to announce that the value of
these parameters changed since the previous Inform message was sent.
Notification rules
Each notification rule defines the notification behaviour of a specific parameter.
Notification rules can be used to:
Specify the behaviour of the CPE when the value of a specific parameter changes.
Name: this is the name of the parameter, i.e. a complete path name.
For example, execute following command to sent the PPP user name to the ACS at the start of every
transaction session:
=>:cwmp notification rule
name=InternetGatewayDevice.WANDevice.1.WANConnectionDevice.1.WANPPPConnection.1.Username
notification=inform
E-DOC-CTC-20071119-0003 v1.0
25
2.2.5
Runtime Variables
: 7.4.2.2
: no
:
:
Software Version
This variable indicates which firmware image is installed on the CPE. It has the value of the
InternetGatewayDevice.DeviceInfo.SoftwareVersion parameter.
The CPE sends the value of this variable to the ACS in the ParameterList argument of Inform RPCs.
Bootstrapped
This variable indicates the BOOTSTRAP event state.
If this event state is set to yes, the first Inform RPC sent to the ACS includes the Bootstrap event. On
receiving an InformResponse, this event is considered delivered and the event state is set to no.
This variable is set to yes if the ACS URL is reconfigured.
CmdKey
CmdKey has the value of the CommandKey argument of a received Reboot, Download or ScheduleInform
RPC. The CPE stores the value persistently and sends this value back to the ACS as follows:
Reboot: the value of CmdKey is used as CommandKey for the M Reboot EventCode in the first Inform
RPC sent after the reboot.
Download: the value of CmdKey is used as CommandKey for the TransferComplete RPC or
GetQueuedTransfersResponse RPC.
ScheduleInform: the value of CmdKey is used as CommandKey for the M ScheduleInform EventCode
in the Inform RPC sent at the scheduled time.
Parameterkey
Parameterkey has the same value as the InternetGatewayDevice.ManagementServer.ParameterKey
parameter.
Following RPCs contain a ParameterKey argument:
SetParameterValues
AddObject
DeleteObject
If one of these RPCs is applied successfully, the CPE updates the value of the
InternetGatewayDevice.ManagementServer.ParameterKey parameter with the value of the ParameterKey
argument.
26
E-DOC-CTC-20071119-0003 v1.0
E-DOC-CTC-20071119-0003 v1.0
27
2.3
Introduction
If the state check module is enabled, the module periodically performs a number of parameter checks. Each
parameter check results in a Check boolean set to 1 or 0.
The parameter checks are grouped in different groups. First, the check results within a single group are
combined (ANDed or ORed) in a Group boolean for that group. Then, the group results are combined
(ANDed or ORed) in a final Active boolean.
If the Active boolean has value 1, the service interrupting steps of the upgrade process are delayed. As
soon as the Active boolean has value 0, the upgrade process continues.
The state check module is enabled if the upgradedelay parameter is enabled. For more
infomation, see 2.2.2 CWMP Daemon as seen from the ACS on page 21.
Timeout: after this time (in seconds), the state check module stops performing checks and sets the Active
parameter to 0. As a result, this is also the maximum delay time of the upgrade process.
By default, the timeout value is set to 3600 seconds (1 hour).
Groupop: this parameter indicates whether the Group booleans are ANDed or ORed.
By default, the Group booleans are ORed.
Dmtree: this parameter indicates whether the IGD data model or the atomic data model is used.
By default, the atomic data model is used.
Creating a group
To create a group, execute the command :statecheck groupadd and specify following parameter:
Checkop: this parameter indicates whether the Check booleans within this group are ANDed or ORed.
By default, the Check booleans are ANDed.
28
E-DOC-CTC-20071119-0003 v1.0
Deleting a group
To delete a group, execute the command :statecheck groupdelete and specify following parameter:
Creating a check
To create a check, execute the command :statecheck checkadd and specify following parameters:
Match: the match value. The parameter value is compared to the match value depending on the match
type.
//dmtree=igd is used
Deleting a check
To delete a check, execute the command :statecheck checkdelete and specify following parameter:
E-DOC-CTC-20071119-0003 v1.0
29
30
E-DOC-CTC-20071119-0003 v1.0
Introduction
For the use cases described in this chapter, we make following assumptions:
Overview
This chapter includes following use cases:
Topic
Page
32
41
E-DOC-CTC-20071119-0003 v1.0
31
3.1
Firmware Upgrade
Overview
This section is structured as follows:
Topic
32
Page
33
35
37
39
E-DOC-CTC-20071119-0003 v1.0
3.1.1
Firmware images
For a remote firmware upgrade, one of the following file types can be used:
Description
This use case mainly covers the automatic remote upgrade of a firmware image. At any point in time, the
ACS can trigger the CPE to upgrade its firmware image. The ACS sends an asynchronous connection request
triggering the CPE to establish a transaction session to receive a Download method to upgrade its firmware.
CPE: the actions taken by the CPE itself depend on the firmware upgrade mechanism, which is not
defined by TR-069. This is indicated by the CPE firmware upgrade process in following illustration. The
different firmware upgrade mechanisms are described in different subsections.
E-DOC-CTC-20071119-0003 v1.0
33
Message flow
The message flow between the CPE and ACS is identical for all firmware upgrade mechanisms.
Following illustration shows the message flow for the Firmware Upgrade use case (we assume that the
MaxEnvelopes argument of the first Inform RPC has value 1):
File Server
CPE
ACS
1) Schedule firmware upgrade
2) HTTP GET to
ConnectionRequestURL
3) 401 Unauthorized (Challenge)
4) HTTP GET to
ConnectionRequestURL
with authentication info
5) 200 OK
6) Close connection
7) Inform (Event Connection Request)
8) 401 Unauthorized (Challenge)
9) Inform (Event Connection Request)
with authentication info
10) InformResponse
HoldRequests = 1
11) HTTP POST (Empty)
12) Download (CommandKey,
Firmware Upgrade Image, File URL)
HoldRequests = 1
13) DownloadResponse (Status = 1)
14) 200 OK (Empty)
34
E-DOC-CTC-20071119-0003 v1.0
3.1.2
Introduction
All Thomson Gateway residential RTEMS devices have a single memory bank (Flash).
Description
First, the CPE receives a Download RPC from the ACS. If the FileType argument is set to 1 Firmware Upgrade
Image, a firmware upgrade is started.
A single memory bank firmware upgrade process includes following steps:
1
After downloading the first 125 bytes of the file to SDRAM (volatile memory), the new firmware image
header is checked for integrity.
Using a reasonably small buffer, parts of the new firmware image are downloaded (over TCP) and written
to Flash (= flashed).
When completed, a reboot is initiated to load and run the new firmware.
Finally, the completion (success or failures) of the firmware upgrade is indicated to the ACS
(TransferComplete RPC).
Image*
BL
BL
BL
Erase image
in Flash
E-DOC-CTC-20071119-0003 v1.0
Firmware*
Firmware
Image*
BL
Upgrade
Complete
Firmware
Firmware
Download
Image
Image
Flash
SDRAM
Upgrade
Command
Flash
image
Reboot/Load
new firmware
35
Conclusion
The firmware upgrade process has following characteristics:
36
Service interruption: step 4, when the Thomson Gateway reboots to load and run the new firmware, is
the service interrupting step. Up till that point, all services are running and active.
E-DOC-CTC-20071119-0003 v1.0
3.1.3
Introduction
Some Thomson Gateway business RTEMS devices have a dual memory bank (Flash).
Description
First, the CPE receives a Download RPC from the ACS. If the FileType argument is set to 1 Firmware Upgrade
Image, a firmware upgrade is started.
A dual memory bank firmware upgrade process includes following steps:
1
A switch-over is performed: the new firmware image is now the active image and the old firmware
image becomes the passive image.
Finally, the completion (success or failures) of the firmware upgrade is indicated to the ACS
(TransferComplete RPC).
Firmware 3
Img 1 Img 3
Firmware 1
Img 1 Img 3
Firmware 1
Upgrade
Complete
Img 1
Firmware 1
Download
Image
Img 1 Img 2
Flash
SDRAM
Upgrade
Command
BL
BL
BL
BL
E-DOC-CTC-20071119-0003 v1.0
37
Conclusion
The firmware upgrade process has following characteristics:
38
Service interruption: step 4, when the Thomson Gateway reboots to load and run the new firmware, is
the service interrupting step. Up till that point, all services are running and active.
E-DOC-CTC-20071119-0003 v1.0
3.1.4
Introduction
Some Thomson Gateway GoLinux devices can reboot in reduced memory mode.
Description
First, the CPE receives a Download RPC from the ACS. If the FileType argument is set to 1 Firmware Upgrade
Image, a firmware upgrade is started.
A firmware upgrade process with reduced memory mode includes following steps:
1
The Thomson Gateway reboots in reduced memory mode (setting a flag in prozone). The reduced
memory mode is a reboot of the CPE where less services are started. This way, SDRAM has enough free
memory to hold the new firmware image.
The Thomson Gateway reboots (setting a flag in prozone). The Bootloader detects that the new firmware
image is still in SDRAM and writes the new firmware image to Flash. Prior to this, the Bootloader checks
whether the new firmware image is valid. This step relies on the fact that the contents in SDRAM are
preserved after a warm reboot.
Finally, the completion (success or failures) of the firmware upgrade is indicated to the ACS
(TransferComplete RPC).
Firmware*
Image*
Image*
Image*
Image*
FW
Image
FW
Upgrade
Complete
Image
Firmware
Download
Image
Image
Flash
SDRAM
Upgrade
Command
BL
BL
BL
BL
BL
Restart in
Download
reduced mode
image
E-DOC-CTC-20071119-0003 v1.0
Restart &
Flash
image
Load new
firmware
39
Conclusion
The firmware upgrade process has following characteristics:
40
Robustness: this upgrade mechanism is not robust. Unplugging the CPE during the flash process makes
it only recoverable with a rescue CDROM.
Service interruption: step 1, when the Thomson Gateway reboots in reduced memory mode, is the
service interrupting step. Up till that point, all services are running and active.
E-DOC-CTC-20071119-0003 v1.0
3.2
Configuration Update
Overview
This section is structured as follows:
Topic
Page
42
44
46
E-DOC-CTC-20071119-0003 v1.0
41
3.2.1
File types
For a configuration update, one of the following file types can be used:
The dot .
Description
First, the CPE receives a Download RPC from the ACS. If the FileType argument is set to 3 Vendor
Configuration File, a configuration update is started.
A configuration update includes following steps:
1
The CPE downloads the file at the File URL and locally saves it on Flash in the /dl directory.
The CPE establishes a new transaction session with the ACS sending an Inform with at least the Transfer
Complete event.
If the CPE can connect to the ACS and the ACS responds with an InformResponse:
1
If the CPE cannot connect to the ACS or authentication of the CPE fails or the ACS does not respond
with an InformResponse, a roll-back mechanism is started:
1
The user.ini file is loaded to undo the configuration changes performed by the downloaded file.
This corresponds to CLI command :config load filename=user.ini.
42
The CPE establishes a new transaction session with the ACS. In this case, the TransferComplete
method reports a fault. The TransferComplete method is used by the ACS to learn whether or not
the configuration file was applied.
E-DOC-CTC-20071119-0003 v1.0
Message flow
The message flow between the CPE and ACS is identical for configuration files and script files.
Following illustration shows the message flow for the Configuration Update use case (we assume that the
MaxEnvelopes argument of the first Inform RPC has value 2):
File Server
CPE
ACS
1) Schedule configuration update
2) Inform (Event Periodic)
NoMoreRequests = 1
3) 401 Unauthorized (Challenge)
4) Inform (Event Periodic)
NoMoreRequests = 1
with authentication info
5) InformResponse,
Download (CommandKey, Vendor
Configuration File, File URL)
6) DownloadResponse (Status = 1)
7) 200 OK (Empty)
8 ) Close connection
9) HTTP GET
10) 401 Unauthorized (Challenge)
11) HTTP GET
with authentication info
12) 200 OK File Transfer
13) Config validation and upgrade
14) Inform (Event Transfer Complete,
Value Change, M Download)
15) 401 Unauthorized (Challenge)
16) Inform (Event Transfer Complete,
Value Change, M Download)
with authentication info
17) InfomResponse
18) TransferComplete (CommandKey)
NoMoreRequests = 1
19) TransferCompleteResponse
20) HTTP POST (Empty)
21) 200 OK (Empty)
22) Close connection
Configuration versions
It is the responsibility of the configuration file editors to implement configuration version management. For
example, the downloaded file includes the CLI command :env set var=CONF_VERSION
value=1.1.1.
No reboot
No intentional reboot is done after downloading and loading a configuration file or script file. Although, it is
possible that a :system reboot CLI command is present in the downloaded file. However, if an intentional
reboot is required, it is recommended to use the Reboot RPC instead.
E-DOC-CTC-20071119-0003 v1.0
43
3.2.2
STS Files
An STS file can be used to make specific configuration changes and still preserve the value of other
configuration parameters. A configuration file (user.ini) contains also authentication parameters, for
example PPP username and password, WLAN SSID and WEP keys... A configuration update using such a
configuration file overrides the original value of these parameters, even if you do not want to change
them.
A TR-069 file download of an STS file allows the configuration of parameters that are not (yet)
implemented in the supported IGD data model.
If the execution of CLI commands in an STS file results in errors, these errors are not reported
to the ACS. Hence, the use of CWMP RPCs (e.g. the SetParameterValues RPC) is preferred if the
parameters are implemented in the IGD data model.
STS file
Header line:
An STS file contains a header line with following two space-separated fields:
TPVERSION=x: this is the tag-parser version. It indicates the CLI syntax version. The tag-parser
version is checked for exact match against the tag-parser environment variable.
44
E-DOC-CTC-20071119-0003 v1.0
BOARD_NAME=y: this is the hardware platform mnemonic. The board name is checked for exact
match against the board name environment variable. The feature set and CLI commands may differ
between business and residential products.
Before starting sequential execution of all STS script CLI commands, this header line is checked. A file
without this header line is rejected as invalid STS file.
Examples
Example of a configuration file:
[ xdsl.ini ]
debug traceconfig level=0
config adslmultimode=adsl2plus detect-lop=enabled syslog=disabled
[ cac.ini ]
config port=dsl0 state=enabled
config port=dsl1 state=enabled
...
An STS file should always be closed with a \CR (Carriage Return). Otherwise the last line in the STS
file will not be executed.
Upload the STS file to the file system of the CPE. The file must be placed in the /dl directory.
For example, you can use an FTP session as follows:
Set up a telnet session from your PC to the CPE and run the CLI command :config load
echo=enabled filename=test.sts.
5
The CPE executes one by one the CLI commands as specified in the STS file and prints the output of the
commands to the telnet prompt.
E-DOC-CTC-20071119-0003 v1.0
45
3.2.3
The eSTS file must be embedded in the folder archive/active/ of the software build.
Flag
An eSTS file is loaded once and only once after the firmware upgrade. To this end a flag is used:
After loading the upgrade.sts file, a flag is written to Flash to indicate that the file was loaded.
When the same firmware image is loaded twice, the eSTS file is loaded only once (the first time).
The old user.ini file is loaded. This file preserved the user configuration and previous TR-69 configuration.
If no user.ini file exists, the factory defaults are loaded.
The upgrade.sts file is loaded if an upgrade.sts file exists and if the flag is not present in Flash.
This corresponds to CLI command :config load filename=upgrade.sts.
46
E-DOC-CTC-20071119-0003 v1.0
Introduction
In this chapter, we describe several use cases that can be used by the help desk to obtain information on the
home network and its network connections.
As CWMP is a protocol on top of IP, the use cases assume IP connectivity between the Thomson Gateway and
the ACS.
Overview
This chapter includes following use cases:
Topic
Page
48
4.2 Diagnostics
50
54
56
57
E-DOC-CTC-20071119-0003 v1.0
47
4.1
Introduction
The IGD data model on the Thomson Gateway contains the object
InternetGatewayDevice.LANDevice.1.Hosts..
This hosts table provides a list of all devices that are connected via the local network. For each device, the list
contains information on:
IP address
Address source
MAC address
Host name
Interface type
Active status
Message flow
Following illustration shows the expected message flow to obtain the hosts table:
CPE
ACS
Transaction session
...
1) GetParameterValues
2) GetParameterValuesResponse
...
Obtaining information on the hosts table: to retrieve the hosts table, the GetParameterValues RPC
(message 1 in preceding illustration) contains following ParameterNames argument:
Entry
Value
InternetGatewayDevice.LANDevice.1.Hosts.
48
Name
Value
InternetGatewayDevice.LANDevice.1.Hosts.HostNumberOfEntries
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.IPAddress
192.168.1.64
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.AddressSource
DHCP
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.LeaseTimeRemaining
86315
E-DOC-CTC-20071119-0003 v1.0
Name
Value
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.MACAddress
00:0f:1f:83:d7:5b
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.HostName
thomson-2cfa009
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.InterfaceType
thomson-2cfa009
InternetGatewayDevice.LANDevice.1.Hosts.Host.1.Active
E-DOC-CTC-20071119-0003 v1.0
49
4.2
Diagnostics
Introduction
Basic connection diagnostics can be done via retrieving IGD data model parameters.
Connection diagnostics are for example:
DSL statistics
WLAN statistics
Message flow
Following illustration shows the expected message flow to obtain diagnostics:
CPE
ACS
Transaction session
...
1) GetParameterValues
2) GetParameterValuesResponse
...
DLS statistics
The object InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig. is relevant to the DSL statistics.
This object on the Thomson Gateway contains following vendor specific parameters:
Stats.Showtime.X_000E50_LossOfSignal: number of times that a loss of signal occurred since the most
recent DSL showtime.
Stats.Showtime.X_000E50_LossOfPower: number of times that a loss of power occurred since the most
recent DSL showtime.
To retrieve the DSL statistics, the GetParameterValues RPC (message 1 in preceding illustration) contains
following ParameterNames argument:
50
Entry
Value
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.
E-DOC-CTC-20071119-0003 v1.0
Name
Value
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.Enable
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.Status
Up
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.UpstreamCurrRate
832
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.DownstreamCurrRate
8128
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.UpstreamMaxRate
1024
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.DownstreamMaxRate
8224
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.UpstreamNoiseMargin
60
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.DownstreamNoiseMargin
78
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.UpstreamAttenuation
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.DownstreamAttenuation
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.ShowtimeStart
19760
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.X_000E50_NumberOfResets
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.Stats.ShowTime.
X_000E50_LossOfSignal
InternetGatewayDevice.WANDevice.1.WANDSLInterfaceConfig.Stats.ShowTime.
X_000E50_LossOfPower
WLAN statistics
The object InternetGatewayDevice.LANDevice.1.WLANConfiguration.1. is relevant to the WLAN statistics.
This object on the Thomson Gateway contains following vendor specific parameters:
X_000E50_ChannelMode: this parameter can be used to request automatic selection of the channel. The
parameter has one of the following values:
Entry
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Status
Up
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BSSID
00:14:7f:0e:14:fc
E-DOC-CTC-20071119-0003 v1.0
51
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.MaxBitRate
Auto
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Channel
11
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.
X_000E50_ChannelMode
Auto
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID
SpeedTouchEF5A50
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BeaconType
None
Entry
Value
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.
52
Name
Value
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.DHCPServerEnable
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.DHCPRelay
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.MinAddress
192.168.1.64
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.MaxAddress
192.168.1.253
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.SubnetMask
255.255.255.0
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.DomainName
lan
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPRouters
192.168.1.254
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.DHCPLeaseTime
86400
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.
IPInterfaceNumberOfEntries
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1.
IPInterfaceIPAddress
10.0.0.138
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1.
IPInterfaceSubnetMask
255.255.255.0
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.2.
IPInterfaceIPAddress
192.168.1.254
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.2.
IPInterfaceSubnetMask
255.255.255.0
E-DOC-CTC-20071119-0003 v1.0
Entry
Value
InternetGatewayDevice.X_000E50_Connection.Stats.
Name
Value
InternetGatewayDevice.X_000E50_Connection.Stats.Multicast
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.TCP
112
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.UDP
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.ICMP
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.Other
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.TCP.TCPOpen
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.TCP.TCPEstablished
InternetGatewayDevice.X_000E50_Connection.Stats.Protocol.TCP.TCPClosing
112
E-DOC-CTC-20071119-0003 v1.0
53
4.3
Introduction
The IGD data model contains the object InternetGatewayDevice.IPPingDiagnostics..
This object provides access to an IP ping diagnostics test. Using TR-069, the ACS can initiate the test on the
CPE. Afterwards, the CPE reports the completion of the test to the ACS. This allows the ACS to ask for the
results of the test.
Message flow
Following illustration shows a possible message flow for the IP ping diagnostics test:
CPE
ACS
Transaction session
...
1) SetParameterValues
2) Apply changes
3) SetParameterValuesResponse
...
4) Close connection
5) IP ping diagnostics test
6) Inform
(Event 8 Diagnostics Complete)
7) InformResponse
8) HTTP POST (empty)
9) GetParameterValues
10) GetParameterValuesResponse
...
54
Starting the test: the SetParameterValues RPC (message 1 in preceding illustration) contains following
name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.IPPingDiagnostics.Interface
InternetGatewayDevice.
LANDevice.1.
LANHostConfigManagement.
IPInterface.2
InternetGatewayDevice.IPPingDiagnostics.Host
192.168.1.64
InternetGatewayDevice.IPPingDiagnostics.NumberOfRepetitions
InternetGatewayDevice.IPPingDiagnostics.Timeout
5 (milliseconds)
InternetGatewayDevice.IPPingDiagnostics.DataBlockSize
32 (bytes)
E-DOC-CTC-20071119-0003 v1.0
Name
Value
InternetGatewayDevice.IPPingDiagnostics.DSCP
InternetGatewayDevice.IPPingDiagnostics.DiagnosticsState
Requested
Obtaining the test results: to retrieve the results of the test, the GetParameterValues RPC (message 9 in
preceding illustration) contains following ParameterNames argument:
Entry
Value
InternetGatewayDevice.IPPingDiagnostics.
Name
Value
InternetGatewayDevice.IPPingDiagnostics.DiagnosticsState
Complete
InternetGatewayDevice.IPPingDiagnostics.SuccessCount
InternetGatewayDevice.IPPingDiagnostics.FailureCount
InternetGatewayDevice.IPPingDiagnostics.AverageResponseTime
1 (milliseconds)
InternetGatewayDevice.IPPingDiagnostics.MinimumResponseTime
1 (milliseconds)
InternetGatewayDevice.IPPingDiagnostics.MaximumResponseTime
1 (milliseconds)
E-DOC-CTC-20071119-0003 v1.0
55
4.4
Introduction
The IGD data model contains the DeviceLog parameter, which is located within the object
InternetGatewayDevice.DeviceInfo.. When the ACS asks for the device log of the CPE, it receives the
upper 32 Kbyte of the syslog message buffer contents.
Message flow
Following illustration shows a possible message flow for the retrieval of the device log:
CPE
ACS
Transaction session
...
1) GetParameterValues
2) GetParameterValuesResponse
...
56
Entry
Value
InternetGatewayDevice.DeviceInfo.DeviceLog
E-DOC-CTC-20071119-0003 v1.0
4.5
Event Subscription
Introduction
The ACS can subscribe to particular parameter change events. When the value of such a parameter changes,
the CPE must notify the change to the ACS.
Two types of event subscription exist:
Passive change notification: whenever the parameter value changes, the CPE must include the new value
in the ParameterList argument of the Inform message that is sent the next time a session is established to
the ACS. For example, a periodic Inform or an Inform due to a Connection request.
Active change notification: whenever the parameter value changes, the CPE must initiate a session to the
ACS and include the new value in the ParameterList argument of the sent Inform message.
GetParameterAttributes RPC: the ACS can use this RPC to learn the event subscriptions associated with
one or more CPE parameters. The ParameterNames argument is a list of the names of the requested
parameters.
Example of the ParameterNames argument:
Entry
Value
SetParameterAttributes RPC: the ACS can use this RPC to modify the event subscriptions associated with
one or more CPE parameters. The ParameterList argument contains the list of changes to the event
subscriptions.
Example of the ParameterList argument:
Entry
E-DOC-CTC-20071119-0003 v1.0
Field
Value
Name
InternetGatewayDevice.Layer2Bridging.
NotificationChange
1 (true)
Notification
1 (passive)
Name
InternetGatewayDevice.DeviceInfo.SerialNumber
NotificationChange
1 (true)
Notification
2 (active)
57
ACS
Transaction session
...
1) GetParameterAttributes
2) GetParameterAttributesResponse
3) Verify event subscriptions,
decide to reconfigure
4) SetParameterAttributes
5) SetParameterAttributesResponse
6) 200 OK (Empty)
7) Close connection
...
8) Parameter change event
...
9) Inform (Event 2 Periodic,
4 Value Change)
10) InformResponse
...
ACS
Transaction session
...
1) GetParameterAttributes
2) GetParameterAttributesResponse
4) SetParameterAttributes
5) SetParameterAttributesResponse
6) 200 OK (Empty)
7) Close connection
...
8) Parameter change event
9) Inform (Event 4 Value Change)
10) InformResponse
...
58
E-DOC-CTC-20071119-0003 v1.0
5| WAN Connections
WAN Connections
Introduction
The IGD data model on the Thomson Gateway contains the object
InternetGatewayDevice.WANDevice.1.WANConnectionDevice..
This object can be used to create a:
PPPoE connection
PPPoA connection
IPoA connection
The IGD data model on the Thomson Gateway contains the object
InternetGatewayDevice.Layer3Forwarding.Forwarding.. This object can be used to create forwarding
entries.
Message flow
Following illustration shows a possible message flow for the creation and configuration of a WAN
connection:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
3) AddObjectResponse
4) SetParameterValues
5) Apply changes
6) SetParameterValuesResponse
7) AddObject
8) Apply changes
9) AddObjectResponse
10) SetParameterValues
11) Apply changes
12) SetParameterValuesResponse
13) GetParameterValues
14) GetParameterValuesResponse
15) AddObject
16) Apply changes
17) AddObjectResponse
18) SetParameterValues
19) Apply changes
20) SetParameterValuesResponse
...
E-DOC-CTC-20071119-0003 v1.0
59
5| WAN Connections
Overview
Following steps must be performed to create a WAN connection:
60
Create and configure a WAN connection device. See 5.1 WAN Connection Device on page 61.
Create and configure a WAN PPP or IP connection. See 5.2 WAN PPP or IP Connection on page 62.
Create and configure a forwarding entry. See 5.4 Forwarding Entries on page 66.
E-DOC-CTC-20071119-0003 v1.0
5| WAN Connections
5.1
Creating a WAN connection device: the AddObject RPC (message 1 in preceding illustration) contains for
the ObjectName argument the value InternetGatewayDevice.WANDevice.1.WANConnectionDevice..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 2.
Configuring the WAN connection device: to create and configure the ATM PVC, the SetParameterValues
RPC (message 4 in preceding illustration) contains following name-value pairs in its ParameterList
argument:
Name
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANDSLLinkConfig.LinkType
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANDSLLinkConfig.DestinationAddress
8/35 (VP/VC)
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANDSLLinkConfig.ATMEncapsulation
LLC or VCMUX
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANDSLLinkConfig.Enable
WAN connection
Link type
PPPoE
EoA
IP
EoA
PPPoA
PPPoA
IPoA
IPoA
E-DOC-CTC-20071119-0003 v1.0
61
5| WAN Connections
5.2
Introduction
Before, configuring your WAN PPP or IP connection, make sure that you created and configured a WAN
connection device. For more information, see 5.1 WAN Connection Device on page 61.
Creating a PPPoE connection: the AddObject RPC (message 7 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the PPPoE connection: the SetParameterValues RPC (message 10 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.NATEnabled
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Username
<username>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Password
<password>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Name
Internet
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Enable
The parameter Name is mandatory. This means that the parameter must be set before the
WANPPPConnection object is internally created.
Creating a PPPoA connection: the AddObject RPC (message 7 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
62
E-DOC-CTC-20071119-0003 v1.0
5| WAN Connections
Configuring the PPPoA connection: the SetParameterValues RPC (message 10 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.NATEnabled
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Username
<username>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Password
<password>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Name
Internet
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANPPPConnection.1.Enable
The parameter Name is mandatory. This means that the parameter must be set before the
WANPPPConnection object is internally created.
Creating an IP connection: the AddObject RPC (message 7 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANIPConnection..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the IP connection with a static IP address: the SetParameterValues RPC (message 10 in
preceding illustration) contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.AddressingType
Static
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.ExternalIPAddress
<ipaddress>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.SubnetMask
<mask>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.Name
Video
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.Enable
The parameter Name is mandatory. This means that the parameter must be set before the
WANIPConnection object is internally created.
E-DOC-CTC-20071119-0003 v1.0
63
5| WAN Connections
Creating an IP connection: the AddObject RPC (message 7 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANIPConnection..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the IP connection with DHCP: the SetParameterValues RPC (message 10 in preceding
illustration) contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.AddressingType
DHCP
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.Name
Video
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.Enable
The parameter Name is mandatory. This means that the parameter must be set before the
WANIPConnection object is internally created.
Creating an IPoA connection: the AddObject RPC (message 7 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANIPConnection..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the IPoA connection: the SetParameterValues RPC (message 10 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.AddressingType
Static
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.ExternalIPAddress
<ipaddress>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.SubnetMask
<subnetmask>
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.Name
Video
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.
WANIPConnection.1.Enable
The parameter Name is mandatory. This means that the parameter must be set before the
WANIPConnection object is internally created.
64
E-DOC-CTC-20071119-0003 v1.0
5| WAN Connections
5.3
Connection Information
PPP connection
To obtain information on the connection status, the assigned external IP address and forwarding entries, the
GetParameterValues RPC (message 13 in preceding illustration) contains following ParameterNames
arguments:
Entry
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1
InternetGatewayDevice.Layer3Forwarding.Forwarding
IP connection
To obtain information on the connection status, the assigned external IP address and the forwarding entries,
the GetParameterValues RPC (message 13 in preceding illustration) contains following ParameterNames
arguments:
Entry
Value
InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANIPConnection.1
InternetGatewayDevice.Layer3Forwarding.Forwarding
E-DOC-CTC-20071119-0003 v1.0
65
5| WAN Connections
5.4
Forwarding Entries
PPP connection
For example, following parameter values can be used:
Creating an entry: to add a forwarding entry, the AddObject RPC (message 15 in preceding illustration)
contains for the ObjectName argument the value
InternetGatewayDevice.Layer3Forwarding.Forwarding..
The AddObjectResponse (message 17 in preceding illustration) contains for the InstanceNumber
argument for example value 3.
Configuring the entry: the SetParameterValues RPC (message 18 in preceding illustration) contains
following name-value pairs in its ParameterList argument, for example to add a default route:
Name
Value
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.DestIPAddres
s
0.0.0.0
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.
DestSubnetMask
0.0.0.0
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.
Interface
IGD.WANDevice.1.
WANConnectionDevice.2.
WANPPPConnection.1
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.
ForwardingMetric
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.
GatewayIPAddress
<ipaddress_Interface>
The parameters DestIPAddress, Interface and GatewayIPAddress are mandatory. This means
that these parameters must be set before the Forwarding object is internally created.
IP connection
For example, following parameter values can be used:
Creating an entry: to add a forwarding entry, the AddObject RPC (message 15 in preceding illustration)
contains for the ObjectName argument the value
InternetGatewayDevice.Layer3Forwarding.Forwarding..
The AddObjectResponse (message 17 in preceding illustration) contains for the InstanceNumber
argument for example value 3.
66
Configuring the entry: the SetParameterValues RPC (message 18 in preceding illustration) contains
following name-value pairs in its ParameterList argument, for example to add a default route:
Name
Value
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.DestIPAddres
s
0.0.0.0
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.DestSubnet
Mask
0.0.0.0
E-DOC-CTC-20071119-0003 v1.0
5| WAN Connections
Name
Value
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.Interface
IGD.WANDevice.1.
WANConnectionDevice.2.
WANIPConnection.1
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.Forwarding
Metric
InternetGatewayDevice.Layer3Forwarding.Forwarding.3.GatewayIPAd
dress
<ipaddress_Interface>
The parameters DestIPAddress, Interface and GatewayIPAddress are mandatory. This means
that these parameters must be set before the Forwarding object is internally created.
E-DOC-CTC-20071119-0003 v1.0
67
5| WAN Connections
68
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Service Provisioning
Introduction
Service activation based on the data model can be part of the zero-provisioning use case or can be used at
any point in time. For example, the user has a VoIP-capable Thomson Gateway but only after an amount of
time decides to subscribe to the VoIP service.
For more information on the non vendor specific parameters in the data model, see TR-098.
Overview
This chapter includes following use cases:
Topic
Page
6.1 VoIP
70
6.2 WLAN
73
6.3 Time
76
77
79
81
85
87
90
93
95
97
E-DOC-CTC-20071119-0003 v1.0
69
6| Service Provisioning
6.1
VoIP
Introduction
Because any configuration problem might lead to VoIP service unavailability and help-desk calls, remote
management of VoIP parameters (SIP URI, server addresses, authentication) ensures a fluent VoIP service
activation.
The VoiceService data model of the Thomson Gateway provides support for the SIP, MGCP and H.323
signalling protocols.
For more information on the VoiceService data model, see TR-104 Provisioning parameters for
VoIP CPE, September 2005.
70
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Message flow
Following illustration shows a possible message flow for voice service provisioning:
CPE
ACS
Transaction session
...
1) GetParameterValues
2) GetParameterValuesResponse
3) SetParameterValues
4) Apply changes
5) SetParameterValuesResponse
6) SetParameterValues
7) Apply changes
8) SetParameterValuesResponse
9) AddObject
10) Apply changes
11) AddObjectResponse
Create a Line
12) SetParameterValues
13) Apply changes
14) SetParameterValuesResponse
...
Checking the current configuration: to obtain information on the current voice configuration, the
GetParameterValues RPC (message 1 in preceding illustration) contains following ParameterNames
argument:
Entry
Value
InternetGatewayDevice.Services.VoiceService.
Name
Value
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.SignalingProtocol
SIP
Configuring the voice profile: if necessary, modify the value of one or more parameters and finally enable
the VoiceProfile.1. object instance. The SetParameterValues RPC (message 3 in preceding illustration)
contains following name-value pair in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Enable
Enabled
E-DOC-CTC-20071119-0003 v1.0
71
6| Service Provisioning
Configuring the signalling protocol: if necessary, modify the value of one or more parameters. The
SetParameterValues RPC (message 6 in preceding illustration) contains following name-value pairs in its
ParameterList argument:
Name
Value
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.SIP.ProxyServer
<ip_address
>
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.SIP.ProxyServerPort
<port>
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.SIP.RegistrarServer
<ip_address
>
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.SIP.
RegistrarServerPort
<port>
Creating a voice account: the AddObject RPC (message 9 in preceding illustration) contains for the
ObjectName argument the value InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Line..
The AddObjectResponse (message 11 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the voice account: if necessary, modify the value of one or more parameters. To enable the
Line.1 object instance, following parameters must be modified (a PhyReferenceList value equal to 1
corresponds to the FXS1 port). The data model will not be updated as long as the PhyReferenceList
parameter (i.e. the voice port) is not set. The SetParameterValues RPC (message 12 in preceding
illustration) contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Line.1.Enable
Enabled
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Line.1.
PhyReferenceList
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Line.1.SIP.
AuthUserName
<user name>
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Line.1.SIP.
AuthPassword
<password>
InternetGatewayDevice.Services.VoiceService.1.VoiceProfile.1.Line.1.SIP.URI
<my voice
number>
The parameter PhyReferenceList is mandatory. This means that the parameter must be set
before the Line object is internally created.
72
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
6.2
WLAN
Introduction
Given the increasing deployment of wireless gateways and the known complexity of setting up a secure
wireless LAN network, remote management of wireless settings can lower the complexity for the end-user.
For example, remote management can configure or reset the SSID to a default value and configure the
security settings. The end-user does not need to manually configure the Thomson Gateway. Given a
broadcasted SSID and preconfigured security settings, the end-user must only configure the WEP or WPA key
on its PC. Remote management can also reset wireless settings to defaults that are provided to the end-user,
turn off security to allow the user to associate and configure again.
X_000E50_ChannelMode: this parameter can be used to request automatic selection of the channel. The
parameter has one of the following values:
Auto (default value)
Manual
Message flow
Following illustration shows a possible message flow for wireless service provisioning:
CPE
ACS
Transaction session
...
1) SetParameterValues
2) Apply changes
3) SetParameterValuesResponse
...
E-DOC-CTC-20071119-0003 v1.0
73
6| Service Provisioning
74
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Channel
<channel_id>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BeaconType
None
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID
<SSID>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable
Configuration in case of WEP: the SetParameterValues RPC (message 1 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.WEPKey.1.WEPKe
y
1234567890
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Channel
<channel_id>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BeaconType
Basic
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID
<SSID>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable
Configuration in case of WPA: the SetParameterValues RPC (message 1 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.PreSharedKey.1.
KeyPassphrase
abcdefgh
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Channel
<channel_id>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BeaconType
WPA
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID
<SSID>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.PreSharedKey.1.
KeyPassphrase
abcdefgh
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Channel
<channel_id>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BeaconType
11i
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID
<SSID>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Configuration in case of WPA and WPA2: the SetParameterValues RPC (message 1 in preceding
illustration) contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.PreSharedKey.1.
KeyPassphrase
abcdefgh
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Channel
<channel_id>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.BeaconType
WPAand11i
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.SSID
<SSID>
InternetGatewayDevice.LANDevice.1.WLANConfiguration.1.Enable
E-DOC-CTC-20071119-0003 v1.0
75
6| Service Provisioning
6.3
Time
Message flow
Following illustration shows a possible message flow for NTP service provisioning:
CPE
ACS
Transaction session
...
1) SetParameterValues
2) Apply changes
...
76
the SetParameterValues RPC (message 1 in preceding illustration) contains following name-value pairs
in its ParameterList argument:
Name
Value
InternetGatewayDevice.Time.NTPServer1
<hostname> or <ipaddress>
InternetGatewayDevice.Time.X_000E50_Enable
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
6.4
Message flow
Following illustration shows a possible message flow for the configuration of DHCP conditional serving:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
5) Apply changes
8) Apply changes
...
Creating a serving pool: the AddObject RPC (message 1 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.DHCPConditionalServingPool..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
E-DOC-CTC-20071119-0003 v1.0
77
6| Service Provisioning
Configuring the serving pool: the SetParameterValues RPC (message 4 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.Chaddr
00:0f:1f:83:d7:5b
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.MinAddress
192.168.1.70
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.MaxAddress
192.168.1.80
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.SubnetMask
255.255.255.0
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.IPRouters
192.168.1.254
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.DHCPLeaseTime
86400
Creating a DHCP option: the AddObject RPC (message 7 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.DHCPConditionalServingPool.1.
DHCPOption..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the DHCP option: the SetParameterValues RPC (message 10 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.DHCPOption.1.Tag
InternetGatewayDevice.LANDevice.1.LANHostConfigManagement
.DHCPConditionalServingPool.1.DHCPOption.1.Value
MTIzNDU2Nzg=
The parameters Tag and Value are mandatory. This means that these parameters must be set
before the DHCPOption object is internally created.
78
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
6.5
Queue Management
Classification.[i]
Queue.[i]
Message flow
Following illustration shows a possible message flow for QoS provisioning:
CPE
ACS
Transaction session
...
1) SetParameterValues
2) Apply changes
5) Apply changes
8) Apply changes
...
Configuring a queue table entry: the SetParameterValues RPC (message 1 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.QueueManagement.Queue.6.QueueInterface
WAN
E-DOC-CTC-20071119-0003 v1.0
79
6| Service Provisioning
Name
Value
InternetGatewayDevice.QueueManagement.Queue.6.DropAlgorithm
BLUE
InternetGatewayDevice.QueueManagement.Queue.6.SchedulerAlgorith
m
WFQ
InternetGatewayDevice.QueueManagement.Queue.6.QueueEnable
Creating a classification table entry: the AddObject RPC (message 4 in preceding illustration) contains for
the ObjectName argument the value InternetGatewayDevice.QueueManagement.Classification..
The AddObjectResponse (message 6 in preceding illustration) contains for the InstanceNumber
argument for example value 24.
Configuring the classification table entry: the SetParameterValues RPC (message 7 in preceding
illustration) contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.QueueManagement.Classification.24.Protocol
InternetGatewayDevice.QueueManagement.Classification.24.DSCPMark
-1
InternetGatewayDevice.QueueManagement.Classification.24.ForwardingPolicy
InternetGatewayDevice.QueueManagement.Classification.24.ClassQueue
InternetGatewayDevice.QueueManagement.Classification.24.ClassPolicer
-1
InternetGatewayDevice.QueueManagement.Classification.24.ClassificationEnable
Creating a policer table entry: the AddObject RPC (message 10 in preceding illustration) contains for the
ObjectName argument the value InternetGatewayDevice.QueueManagement.Policer..
The AddObjectResponse (message 12 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
80
Configuring the policer table entry: the SetParameterValues RPC (message 13 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.QueueManagement.Policer.1.PolicerEnable
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
6.6
Create and configure new security levels, e.g. to create an expert firewall service with 10 levels instead of
the default 3 levels.
Temporary update existing firewall chains and rules, e.g. to protect the network against new worms,
viruses or Trojans alerts.
Name
Type
InternetGatewayDevice.X_000E50_Firewall.
Object
Enable
Parameter
Read/Write
SelectedLevel
Parameter
Read/Write
LevelNumberOfEntries
Parameter
Read
ChainNumberOfEntries
Parameter
Read
Level.
Object
Add/Delete
Name
Parameter
Read/Write
Order
Parameter
Read/Write
Description
Parameter
Read/Write
ReadOnly
Parameter
Read/Write
DefaultPolicy
Parameter
Read/Write
Chain
Parameter
Read
RespondToPing
Parameter
Read/Write
Object
Add/Delete
Name
Parameter
Read/Write
Type
Parameter
Read
RuleNumberOfEntries
Parameter
Read
Rule.[i].
Object
Add/Delete
Status
Parameter
Read
Order
Parameter
Read/Write
Description
Parameter
Read/Write
Target
Parameter
Read/Write
TargetChain
Parameter
Read/Write
Chain.
E-DOC-CTC-20071119-0003 v1.0
Actions
81
6| Service Provisioning
Name
82
Type
Actions
SourceIP
Parameter
Read/Write
SourceIPMask
Parameter
Read/Write
SourceIPExclude
Parameter
Read/Write
DestinationIP
Parameter
Read/Write
DestinationIPMask
Parameter
Read/Write
DestinationIPExclude
Parameter
Read/Write
SourceInterface
Parameter
Read/Write
SourceInterfaceExclude
Parameter
Read/Write
DestinationInterface
Parameter
Read/Write
DestinationInterfaceExclude
Parameter
Read/Write
Protocol
Parameter
Read/Write
ProtocolExclude
Parameter
Read/Write
SourcePort
Parameter
Read/Write
SourcePortRangeEnd
Parameter
Read/Write
SourcePortExclude
Parameter
Read/Write
DestinationPort
Parameter
Read/Write
DestinationPortRangeEnd
Parameter
Read/Write
DestinationPortExclude
Parameter
Read/Write
TOS
Parameter
Read/Write
TOSExclude
Parameter
Read/Write
DSCP
Parameter
Read/Write
DSCPExclude
Parameter
Read/Write
SourceMACAddress
Parameter
Read/Write
SourceMACMask
Parameter
Read/Write
SourceMACExclude
Parameter
Read/Write
Enable
Parameter
Read/Write
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Message flow
Following illustration shows a possible message flow for the firewall configuration:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
5) Apply changes
Create a Rule
11) AddObjectResponse
12) SetParameterValues
...
Creating a security level: the AddObject RPC (message 1 in preceding illustration) contains for the
ObjectName argument the value InternetGatewayDevice.X_000E50_Firewall.Level..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 7.
Configuring the security level: the SetParameterValues RPC (message 4 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.X_000E50_Firewall.Level.7.Name
TestLevel
InternetGatewayDevice.X_000E50_Firewall.Level.7.Description
This is a test
The parameter Name is mandatory. This means that the parameter must be set before the
Level object is internally created.
E-DOC-CTC-20071119-0003 v1.0
83
6| Service Provisioning
Finding the new chain: the Thomson Gateway automatically creates a new chain that is used by the new
security level. The GetParameterValues RPC (message 7 in preceding illustration) contains following
ParameterNames argument:
Entry
Value
InternetGatewayDevice.X_000E50_Firewall.Level.7.Chain
Creating a rule: the AddObject RPC (message 9 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule..
The AddObjectResponse (message 11 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
84
Configuring the rule: the SetParameterValues RPC (message 12 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
Description
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
SourceInterface
InternetGatewayDevice.
LANDevice.1
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
Protocol
17 (6=TCP, 17=UDP,...)
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
DestinationPort
67
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
DestinationPortRangeEnd
67
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
DestinationPortExclude
0 (0=disabled, 1=enabled)
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
Target
InternetGatewayDevice.X_000E50_Firewall.Chain.20.Rule.1.
Enable
1 (1=enabled, 0=disabled)
Activating the security level: the SetParameterValues RPC (message 15 in preceding illustration)
contains following name-value pair in its ParameterList argument:
Name
Value
InternetGatewayDevice.X_000E50_Firewall.SelectedLevel
InternetGatewayDevice.
X_000E50_Firewall.Level.7
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
6.7
Access Rights
Name
Type
InternetGatewayDevice.X_000E50_AccessRights.
Object
Group.
Actions
Object
Add/Delete
Name
Parameter
Read/Write
GID
Parameter
Read
MaskPos
Parameter
Read/Write
Parent
Parameter
Read/Write
User.
Object
Add/Delete
Parameter
Read/Write
Object
Add/Delete
Name
Parameter
Read/Write
Password
Parameter
Read/Write
Hash2
Parameter
Read/Write
AdminGroup
Parameter
Read/Write
Description
Parameter
Read/Write
UID
Parameter
Read
User
User.
Message flow
Following illustration shows a possible message flow for user management:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
Create a User
3) AddObjectResponse
4) SetParameterValues
5) Apply changes
...
E-DOC-CTC-20071119-0003 v1.0
85
6| Service Provisioning
Creating a user: the AddObject RPC (message 1 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.X_000E50_AccessRights.User..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 3.
Configuring the user: the SetParameterValues RPC (message 4 in preceding illustration) contains
following name-value pair in its ParameterList argument:
Name
Value
InternetGatewayDevice.X_000E50_AccessRights.User.3.Name
TestUser
InternetGatewayDevice.X_000E50_AccessRights.User.3.
AdminGroup
9 (or InternetGatewayDevice.
X_000E50_AccessRights.Group.9)
InternetGatewayDevice.X_000E50_AccessRights.User.3.
Description
InternetGatewayDevice.X_000E50_AccessRights.User.3.
Password
testuser
The parameters Name and AdminGroup are mandatory. This means that these parameters
must be set before the User object is internally created.
86
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
6.8
Update the list of NAT applications. Each NAT application is defined by:
A user-friendly name.
The port(s) or port range(s) to map the port used on the WAN side to the port used on the LAN side.
The Thomson Gateway supports following proprietary NAT application list data model:
Name
Type
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Object
E-DOC-CTC-20071119-0003 v1.0
Actions
ApplicationNumberOfEntries
Parameter
Read
Application.
Object
Add/Delete
Name
Parameter
Read/Write
HostIPAddress
Parameter
Read/Write
RuleNumberOfEntries
Parameter
Read
Rule.
Object
Add/Delete
Protocol
Parameter
Read/Write
InternalPort
Parameter
Read/Write
ExternalPort
Parameter
Read/Write
ExternalPortRangeEnd
Parameter
Read/Write
87
6| Service Provisioning
Message flow
Following illustration shows a possible message flow for the configuration of the NAT application list:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
Create an Application
3) AddObjectResponse
4) SetParameterValues
5) Apply changes
8) Apply changes
...
Creating an application: the AddObject RPC (message 1 in preceding illustration) contains for the
ObjectName argument the value
InternetGatewayDevice.Services.X_000E50_NATApplicationList.Application..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 130.
Configuring the application: the SetParameterValues RPC (message 4 in preceding illustration) contains
following name-value pair in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Application.130.Name
<Name>
The parameter Name is mandatory. This means that the parameter must be set before the
Application object is internally created.
Creating a rule: the AddObject RPC (message 7 in preceding illustration) contains for the ObjectName
argument the value
InternetGatewayDevice.Services.X_000E50_NATApplicationList.Application.130.Rule..
The AddObjectResponse (message 9 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
88
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Name
Value
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Application.130.Rule.1.ExternalPort
<ExternalPort>
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Application.130.Rule.1.ExternalPortRangeEnd
<ExternalPortRangeEnd>
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Application.130.Rule.1.InternalPort
<InternalPort>
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Application.130.Rule.1.Protocol
TCP or UDP
The parameters ExternalPort and ExternalPortRangeEnd are mandatory. This means that the
parameter must be set before the Rule object is internally created.
Name
Value
InternetGatewayDevice.Services.X_000E50_NATApplicationList.
Application.130.HostIPAddress
<ipaddress>
To obtain the IP addresses of the local network devices, see 4.1 View on Home Network on
page 48.
E-DOC-CTC-20071119-0003 v1.0
89
6| Service Provisioning
6.9
Dynamic DNS
Name
Type
InternetGatewayDevice.Services.X_000E50_DynamicDNS.
Object
ServiceNumberOfEntries
Parameter
Read
ClientNumberOfEntries
Parameter
Read
Service.
Object
Name
Parameter
Read
Server
Parameter
Read/Write
Request
Parameter
Read/Write
ServerPort
Parameter
Read/Write
UpdateInterval
Parameter
Read/Write
RetryInterval
Parameter
Read/Write
MaxRetries
Parameter
Read/Write
Hidden
Parameter
Read/Write
Object
Add/Delete
Enable
Parameter
Read/Write
Status
Parameter
Read
LastError
Parameter
Read
Hidden
Parameter
Read/Write
Offline
Parameter
Read/Write
Username
Parameter
Read/Write
Password
Parameter
Read/Write
Interface
Parameter
Read/Write
Service
Parameter
Read/Write
HostNumberOfEntries
Parameter
Read
Hostname.
Object
Add/Delete
Name
Parameter
Read/Write
Status
Parameter
Read
Client.
90
Actions
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Message flow
Following illustration shows a possible message flow for configuration of the GnuDIP service:
CPE
ACS
Transaction session
...
1) SetParameterValues
2) Apply changes
5) Apply changes
Create a Client
6) AddObjectResponse
7) SetParameterValues
8) Apply changes
Create a Host
12) AddObjectResponse
13) SetParameterValues
...
Configuring the service: the SetParameterValues RPC (message 1 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Service.
6.Server
dns-atm.dyndns.sit
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Service.
6.Request
/gnudip/cgi-bin/gdipupdt.cgi
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Service.
6.ServerPort
80
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Service.
6.UpdateInterval
86000
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Service.
6.RetryInterval
Creating a client: the AddObject RPC (message 4 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client..
The AddObjectResponse (message 6 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
E-DOC-CTC-20071119-0003 v1.0
91
6| Service Provisioning
Configuring the client: the SetParameterValues RPC (message 7 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.
Username
<username>
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.
Password
<password>
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.
Interface
InternetGatewayDevice.
WANDevice.1.
WANConnectionDevice.1.
WANPPPConnection.1
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.
Service
InternetGatewayDevice.
Services.
X_000E50_DynamicDNS.
Service.6
Creating a host: the AddObject RPC (message 10 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.Hostname..
The AddObjectResponse (message 12 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the host: the SetParameterValues RPC (message 13 in preceding illustration) contains
following name-value pair in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.
Hostname.1.Name
<IPhostname>
The parameter Name is mandatory. This means that the parameter must be set before the
Hostname object is internally created.
92
Activating the client: the SetParameterValues RPC (message 16 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_DynamicDNS.Client.1.
Enable
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Name
Type
InternetGatewayDevice.Services.X_000E50_RemoteAccess.
Object
Actions
URL
Parameter
Read
Status
Parameter
Read
Secure
Parameter
Read/Write
Port
Parameter
Read/Write
Timeout
Parameter
Read/Write
ElapsedTime
Parameter
Read
Mode
Parameter
Read/Write
IPIntf
Parameter
Read/Write
RandomPassword
Parameter
Read/Write
RandomPort
Parameter
Read/Write
User
Parameter
Read/Write
Password
Parameter
Read
Group
Parameter
Read/Write
Enable
Parameter
Read/Write
Start
Parameter
Write
Message flow
Following illustration shows a possible message flow for the configuration of remote access:
CPE
ACS
Transaction session
...
1) SetParameterValues
2) Apply changes
...
E-DOC-CTC-20071119-0003 v1.0
93
6| Service Provisioning
94
Configuring temporary remote access: the SetParameterValues RPC (message 1 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Mode
Temporary
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Timeo
ut
20 (minutes)
InternetGatewayDevice.Services.X_000E50_RemoteAccess.IPIntf
InternetGatewayDevice.
WANDevice.1.
WANConnectionDevice.2.
WANPPPConnection.1
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Group
3 or InternetGatewayDevice.
X_000E50_AccessRights.Grou
p.3
InternetGatewayDevice.Services.X_000E50_RemoteAccess.User
2 or InternetGatewayDevice.
X_000E50_AccessRights.User.
2
InternetGatewayDevice.Services.X_000E50_RemoteAccess.
RandomPassword
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Start
Name
Value
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Mode
Permanent
InternetGatewayDevice.Services.X_000E50_RemoteAccess.IPIntf
InternetGatewayDevice.
WANDevice.1.
WANConnectionDevice.2.
WANPPPConnection.1
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Group
3 or InternetGatewayDevice.
X_000E50_AccessRights.Grou
p.3
InternetGatewayDevice.Services.X_000E50_RemoteAccess.User
2 or InternetGatewayDevice.
X_000E50_AccessRights.User.
2
InternetGatewayDevice.Services.X_000E50_RemoteAccess.
RandomPassword
InternetGatewayDevice.Services.X_000E50_RemoteAccess.Enable
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Name
Type
InternetGatewayDevice.Services.X_000E50_ParentalControl.
Object
Actions
Status
Parameter
Read/Write
ConnectErrorURL
Parameter
Read/Write
CategoryErrorURL
Parameter
Read/Write
MonitorInterceptURL
Parameter
Read/Write
UnauthorizedReqURL
Parameter
Read/Write
URLFilter.
Object
Enable
Parameter
Read/Write
RuleNumberOfEntries
Parameter
Read
Rule.
Object
Add/Delete
URL
Parameter
Read/Write
Action
Parameter
Read/Write
RedirectURL
Parameter
Read/Write
Order
Parameter
Read
Message flow
Following illustration shows a possible message flow for the configuration of web site filtering:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
Create a Rule
3) AddObjectResponse
4) SetParameterValues
5) Apply changes
...
E-DOC-CTC-20071119-0003 v1.0
95
6| Service Provisioning
Creating a rule: the AddObject RPC (message 1 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.Services.X_000E50_ParentalControl.URLFilter.Rule..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
Configuring the rule: the SetParameterValues RPC (message 4 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Services.X_000E50_ParentalControl.URLFilter.Rule.
1.URL
www.standaard.be
InternetGatewayDevice.Services.X_000E50_ParentalControl.URLFilter.Rule.
1.Action
Redirect
InternetGatewayDevice.Services.X_000E50_ParentalControl.URLFilter.Rule.
1.RedirectURL
www.humo.be
The parameters URL and Action are mandatory. This means that these parameters must be set
before the Rule object is internally created.
96
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Message flow
Following illustration shows a possible message flow for VLAN provisioning:
CPE
ACS
Transaction session
...
1) AddObject
2) Apply changes
Create a VLAN
3) AddObjectResponse
4) SetParameterValues
5) Apply changes
Create a Filter
11) AddObjectResponse
12) SetParameterValues
Create a Marking
20) AddObjectResponse
21) SetParameterValues
...
E-DOC-CTC-20071119-0003 v1.0
97
6| Service Provisioning
Creating a VLAN: the AddObject RPC (message 1 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.Layer2Bridging.Bridge..
The AddObjectResponse (message 3 in preceding illustration) contains for the InstanceNumber
argument for example value 3.
Configuring the VLAN: the SetParameterValues RPC (message 4 in preceding illustration) contains
following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Layer2Bridging.Bridge.3.BridgeName
video
InternetGatewayDevice.Layer2Bridging.Bridge.3.VLANID
The parameters BridgeName and VLANID are mandatory. This means that the parameters
must be set before the Bridge object is internally created.
Retrieving bridge and interface information: the GetParameterValues RPC (message 7 in preceding
illustration) contains following ParameterNames argument:
Entry
Value
InternetGatewayDevice.Layer2Bridging.Bridge.3.BridgeKey
InternetGatewayDevice.Layer2Bridging.AvailableInterface.
Creating a filter: the AddObject RPC (message 9 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.Layer2Bridging.Filter..
The AddObjectResponse (message 11 in preceding illustration) contains for the InstanceNumber
argument for example value 12.
Configuring port VLAN membership: the SetParameterValues RPC (message 12 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Layer2Bridging.Filter.12.FilterBridgeReference
2 (= BridgeKey)
InternetGatewayDevice.Layer2Bridging.Filter.12.FilterInterface
10001 (=
AvailableInterfaceKey)
The parameters FilterBridgeReference and FilterInterface are mandatory. This means that the
parameters must be set before the Filter object is internally created.
Configuring default port VID: the SetParameterValues RPC (message 15 in preceding illustration)
contains following name-value pair in its ParameterList argument:
Name
Value
InternetGatewayDevice.Layer2Bridging.Filter.12.ExclusivityOrder
Create a marking: the AddObject RPC (message 18 in preceding illustration) contains for the ObjectName
argument the value InternetGatewayDevice.Layer2Bridging.Marking..
The AddObjectResponse (message 20 in preceding illustration) contains for the InstanceNumber
argument for example value 1.
98
E-DOC-CTC-20071119-0003 v1.0
6| Service Provisioning
Configuring egress VLAN tagging: the SetParameterValues RPC (message 21 in preceding illustration)
contains following name-value pairs in its ParameterList argument:
Name
Value
InternetGatewayDevice.Layer2Bridging.Marking.1.MarkingBridgeReference
2 (= BridgeKey)
InternetGatewayDevice.Layer2Bridging.Marking.1.MarkingInterfac
e
10001 (=
AvailableInterfaceKey)
InternetGatewayDevice.Layer2Bridging.Marking.1.VLANIDUntag
E-DOC-CTC-20071119-0003 v1.0
99
6| Service Provisioning
100
E-DOC-CTC-20071119-0003 v1.0
7| Zero-Provisioning
Zero-Provisioning
Introduction
The zero-provisioning use case considers the auto-configuration of the CPE without any user interaction.
It is based on two assumptions:
Pre-provisioned connectivity
Pre-provisioned connectivity
It is assumed that the CPE is pre-provisioned with connectivity to an ACS.
This pre-provisioning includes following aspects:
ACS:
ACS URL: the host part of the ACS URL is resolved into the ACS IP address.
ACS authentication: user name/password only if needed. The ACS could accept first time
unauthorized access or e.g. CPE serial number as user name/password.
TLS certificates:
ACS-to-CPE authentication: a CA certificate (e.g. a server provider certificate) must be preprovisioned on the CPE.
CPE-to-ACS authentication: each CPE certificate is signed by e.g. a service provider CA or the ACS
trusts the CPE CA.
Pre-provisioning can be achieved via Thomson Gateway ISP defaults (ISP.def). This is a set of
defaults that is preserved even when the end-user or the ACS triggers a reset-to-factory-defaults.
After this action, the zero-provisioning use case is started again.
The relation is pre-configured: the relation between the CPE, subscriber and subscribed-to-services is
pre-configured (e.g. in a shop when buying the CPE).
The ACS learns the relation dynamically: based on the IP address of the CPE, the ACS learns from the
BRAS which DSL line-ID it was assigned to. Using the line-ID, the ACS can query the AAA database to
learn the subscriber credentials (PPP user name/password) and the subscribed-to-services (needed for
knowing which services to auto-provision).
E-DOC-CTC-20071119-0003 v1.0
101
7| Zero-Provisioning
Description
First, the Thomson Gateway connects to the (potentially walled garden) ACS that learns the subscriber
information and services.
Next, following actions can be taken:
Before any configuration changes are made, the ACS can be configured to start a firmware upgrade to
the most recent firmware version. This firmware would include the same ISP defaults (ISP.def) so after
the firmware upgrade, the Thomson Gateway connects to the ACS again.
For more information on firmware upgrades, see 3.1 Firmware Upgrade on page 32.
The ACS uses the data model to configure the Thomson Gateway via the SetParameterValues RPC. This
typically includes customer specific parameters (PPP user name/password, ACS URL, ACS connection
request authentication, wireless settings and optionally voice settings (e.g. SIP URI and authentication).
For more information on service provisioning, see 6 Service Provisioning on page 69.
The ACS can use a configuration file or script file download to configure all modules not (yet) supported
by the data model.
For more information on configuration updates, see 3.2 Configuration Update on page 41.
The case where only data model parameters are configured on top of the pre-provisioned settings (ISP.def) is
the most straightforward. The ACS sends a SetParameterValues RPC for the parameters that need to be
configured. These parameters are applied and saved persistent on the Thomson Gateway.
The walled garden ACS associates the CPE with the subscriber and configures the CPE with the proper
(user specific) connectivity parameters. So the difference with the zero-provisioning use case is that the
walled garden ACS is dedicated to configuring the CPE out of the walled garden.
The provider ACS does all of the per-subscriber-per-service provisioning. So once the provider ACS is
contacted, firmware upgrade, configuration update, service activation and remote intervention use cases
are supported.
Following illustration shows the message flow for the Minimal walled garden provisioning use case:
Walled garden
ACS
CPE
Provider
ACS
Pre-provisioned ISP.def
(default ACS, default auth)
1) Inform (Event Bootstrap)
NoMoreRequests = 1
2) Relate CPE to user/subscription
3) InformResponse,
SetParameterValues
PPP Username
PPP Password
ACS URL
ACS Username
ACS Password
4) Apply parameters
(and env variables)
5) SetParameterValuesResponse
6) 200 OK (Empty)
7) Close connection
8) Inform (Event Bootstrap)
NoMoreRequests = 1
9) InformResponse
10) HTTP POST (Empty)
11) 200 OK (Empty)
102
E-DOC-CTC-20071119-0003 v1.0
www.thomson-broadband.com
Thomson 2008. All rights reserved.
E-DOC-CTC-20071119-0003 v1.0.