Thomson Gateway. Power. Plug-in ISDN DSL. Internet. Ethernet. TR-069 Configuration Guide. R7.4 and higher

Transcription

1 Thomson Gateway Power Ethernet WLAN Plug-in ISDN DSL Internet TR-069 Configuration Guide R7.4 and higher

2

3 Thomson Gateway TR-069 Configuration Guide R7.4 and higher

4 Copyright Copyright 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 Trademarks The following trademarks may be used in this document: DECT is a trademark of ETSI. 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. UPnP is a certification mark of the UPnP Implementers Corporation. 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. Apple and Mac OS are registered trademarks of Apple Computer, Incorporated, registered in the United States and other countries. UNIX is a registered trademark of UNIX System Laboratories, Incorporated. 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 Short Title: Config Guide: TR-069 R7.4 and higher

5 Contents About this TR-069 Configuration Guide Introduction References and Related Documents CWMP Transaction Sessions IGD Data model on the Thomson Gateway Configuring CWMP on the Thomson Gateway Configuring TLS TLS Client TLS Certificates Configuring CWMP CWMP Service Manager CWMP Daemon as seen from the ACS CWMP Daemon towards the ACS Notification Rules Runtime Variables Configuring State Checks Firmware Upgrade and Configuration Update Firmware Upgrade General Firmware Upgrade Mechanism Single Memory Bank Firmware Upgrade Dual Memory Bank Firmware Upgrade Firmware Upgrade with Reduced Memory Mode Configuration Update Configuration Update Mechanism STS Files Embedded STS (ests) Files Monitoring and Diagnostics View on Home Network Diagnostics IP Ping Diagnostics Test i

6 Contents 4.4 Retrieval of the Device Log Event Subscription WAN Connections WAN Connection Device WAN PPP or IP Connection Connection Information Forwarding Entries Service Provisioning VoIP WLAN Time DHCP Conditional Serving Queue Management Stateful Inspection Firewall Access Rights NAT Application List Dynamic DNS Remote Access (Remote Assistance) Parental Control VLAN Provisioning (Layer2Bridging) Zero-Provisioning ii

7 About this TR-069 Configuration Guide About this TR-069 Configuration Guide Used Symbols A note provides additional information about a topic. 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 hyperlink to a Web site. Example: For more information, visit us at Sample text indicates an internal cross-reference. Example: If you want to know more about guide, see 1 Introduction on page 7. Sample text indicates an important content-related word. Example: To enter the network, you must authenticate yourself. 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. Documentation and software updates Thomson continuously develops new solutions, but is also committed to improving its existing products. For more information on Thomson's latest technological innovations, documents and software releases, visit us at 1

8 About this TR-069 Configuration Guide 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 3 2 Configuring CWMP on the Thomson Gateway 13 3 Firmware Upgrade and Configuration Update 31 4 Monitoring and Diagnostics 47 5 WAN Connections 59 6 Service Provisioning 69 7 Zero-Provisioning 101 2

9 1 Introduction 1 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 1.1 References and Related Documents CWMP Transaction Sessions IGD Data model on the Thomson Gateway 10 3

10 1 Introduction 1.1 References and Related Documents TR-069: CPE WAN Management Protocol (CWMP) TR-069 specifies the CWMP protocol, which is used for remote management of CPE devices. The Thomson Gateway supports CWMP. This allows the Thomson Gateway to be configured and monitored from a management application running on a remote Auto-Configuration Server (ACS). For more information on CWMP, see: Technical Report TR CPE WAN Management Protocol, DSL Forum, May Technical Report TR-069 Amendment 1 - CPE WAN Management Protocol, DSL Forum, November TR-098: Internet Gateway Device (IGD) Data Model TR-098 specifies the InternetGatewayDevice data model for TR-069 enabled devices. The Thomson Gateway supports the IGD data model. This data model is a set of parameters, modelled in a tree structure, that can be managed using CWMP. For more information on the IGD data model, see: Technical Report TR Internet Gateway Device Version 1.1 Data Model for TR-069, DSL Forum, September Technical Report TR-098 Amendment 1 - Internet Gateway Device data model for TR-069, DSL Forum, November 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

11 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-111 CWMP for home devices TR-098 (Am.1) IGD Model CPE Access Network IP Network DSLAM BRAS ACS ACS Provider TR-069 CWMP (Am.1) WT-140 Network Storage Model CPE TR-104 VoIP Model Helpdesk 5

12 1 Introduction 1.2 CWMP Transaction Sessions What is a transaction session? TR-069 defines a transaction session as a sequence of Remote Procedure Calls (RPCs), both requests and responses. A transaction session is completed when both parties (CPE and ACS) have no messages left to send. The CPE has an important role: All transaction sessions are established by the CPE. The CPE maintains a TCP connection (persistent HTTP connection) for the duration of the session. The CPE is also responsible for closing a transaction 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: CPE initiated sessions Asynchronous ACS initiated sessions: the CPE establishes a transaction session to the ACS after receipt of a Connection Request from the ACS. 6

13 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 The first time that the CPE contacts the ACS. 1BOOT After a power up or reset of the CPE. 2 PERIODIC The session is established on a periodic Inform interval. 3 SCHEDULED Scheduled by a ScheduleInform RPC. 4 VALUE CHANGE The value of a parameter of the Inform ParameterList argument changed. This can be a parameter that is marked by the ACS for notification (either active or passive) or a change of one of following parameters: InternetGatewayDevice.DeviceInfo.SoftwareVersion InternetGatewayDevice.DeviceInfo.ProvisioningCode InternetGatewayDevice.ManagementServer.ConnectionRequestURL InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{j}. WAN{*}Connection.{k}.ExternalIPAddress 6 CONNECTION REQUEST The session is established due to an asynchronous connection request from the ACS. 7 TRANSFER COMPLETE Indicates the completion of a Download (or Upload). The TransferComplete RPC is called during this transaction session. 8 DIAGNOSTICS COMPLETE Completion of one or more diagnostics tests (e.g. IPPingDiagnostics) M <method name> The Inform RPC is triggered by another RPC method (M = Master): 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 CPE authenticates itself to the ACS. 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. 7

14 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. 2 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). 3 A warm reboot is triggered. 4 After reboot, an Inform message is sent. The Event argument contains: EventCode: 1 BOOT, M Reboot and possibly other EventCodes. CommandKey: the value of the CommandKey argument of the Reboot message is sent as CommandKey for the EventCode M Reboot. 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. 2 A reset to factory defaults is triggered. 1 The user configuration file (user.ini) is deleted. 2 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: 1 A DownloadResponse RPC is sent with Status argument set to 1 (the download is not yet completed). 2 The ongoing transaction session is closed. 3 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. 8

15 1 Introduction 4 File transfer is initiated: a HTTP GET message is sent by the CPE to the file server. 5 File transfer is completed (or an error occurred). 6 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). 9

16 1 Introduction 1.3 IGD Data model on the Thomson Gateway Data model overview Following illustration shows the IGD data model on the Thomson Gateway with (multiple instance) devices and services: InternetGatewayDevice DeviceInfo Service ManagementServer Service DeviceConfig Service WANDevice WANCommonInterfaceConfig Service WAN***InterfaceConfig Service WANConnectionDevice WAN*LinkConfig Service WAN**Connection Service Time Service UserInterface Service Layer3Forwarding Service Layer2Bridging Service LANDevice LANHostConfigManagement Service LANDevice Hosts Service LAN****InterfaceConfig Service QueueManagement Service WLANConfiguration Service IPPingDiagnostics Service X_000E50_AccessRights Service Services X_000E50_Firewall Service X_000E50_Connection Service 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 * DSL, Ethernet ** IP, PPP *** DSL, Ethernet **** Ethernet, USB 10

17 1 Introduction Objects and parameters The data model is a set of parameters, modelled in a tree structure. In this tree structure, an object is a container for other objects and/or parameters. Vendor specific objects and parameters The name of a vendor specific parameter or object, not contained within another vendor specific object, has the form X_<VENDOR>_VendorSpecificName. Names of parameters and objects within another vendor specific object must not be prefixed. <VENDOR> is a unique vendor identifier, which can be either an OUI (Organizationally Unique Identifier) or a domain name. This OUI or domain name must be assigned to the organization that defined the parameter, which is not necessarily the same as the vendor of the CPE or ACS. For vendor specific parameters of the Thomson Gateway, i.e. Thomson Gateway proprietary parameters, <VENDOR> has value 000E50. Path names To identify a parameter or object in the data model, path names are used. Both complete and partial path names are supported: Complete path name: a complete path name is the name of a parameter. For example InternetGatewayDevice.DeviceInfo.SoftwareVersion. 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 11

18 1 Introduction 12

19 2 Configuring CWMP on the Thomson Gateway 2 Configuring CWMP on the Thomson Gateway 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 2.1 Configuring TLS Configuring CWMP Configuring State Checks 28 13

20 2 Configuring CWMP on the Thomson Gateway 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: If the URL scheme starts with TLS/SSL is used. If the URL scheme starts with TLS/SSL is not used. 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 HTTP tcp 80 enabled =>:service system list name=https Idx Name Protocol SrcPort DstPort Group State HTTPs tcp 443 enabled Overview This section is structured as follows: Topic Page TLS Client TLS Certificates 16 14

21 2 Configuring CWMP on the Thomson Gateway TLS Client Displaying the TLS client configuration To display the configuration of the TLS client, execute following command: =>:tls acs-client config SSL/TLS client for ACS state Request server authentication Check certificate validity date Check certificate domain : enabled : enabled : disabled : disabled Configuring the TLS client To configure the TLS client, execute the command :tls acs-client config and specify one or more of following parameters: 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. For example, configure the TLS client as follows: =>:tls acs-client config state=enabled auth-serv=enabled valid-date=enabled valid-domain=enabled 15

22 2 Configuring CWMP on the Thomson Gateway TLS Certificates TLS certificate validation The Thomson Gateway supports two types of TLS/SSL authentication via certificate validation: 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. Listing Thomson Gateway certificate information Only one certificate is used for client authentication. This certificate can only be altered through file upload (using FTP or TR-069). If no certificate is found when the Thomson Gateway is booting, it generates its own certificate and private/public key pair. The Thomson Gateway signs the certificate using its own private key. To display the certificate of the Thomson Gateway, execute following command: =>:tls self cert list expand=enabled 1- Subject : /CN=SpeedTouch 780/O=THOMSON/OU=0639JT008 Not Before : Jan 1 00:00: GMT Not After : Dec 31 00:00: GMT Issuer : /CN=SpeedTouch 780/O=THOMSON/OU=0639JT008 Key Strength : 1024 bit Certificate : /dl/tls/cert0001.pem -----BEGIN CERTIFICATE----- MIIB9TCCAV6gAwIBAgIEirL3QTANBgkqhkiG9w0BAQUFADA/MRcwFQYDVQQDEw5T cgvlzfrvdwnoidc4mdeqma4ga1uechmhvehptvnptjesmbaga1uecxmjmdyzoupu MDA4MB4XDTA1MDEwMTAwMDAwMFoXDTI0MTIzMTAwMDAwMFowPzEXMBUGA1UEAxMO U3BlZWRUb3VjaCA3ODAxEDAOBgNVBAoTB1RIT01TT04xEjAQBgNVBAsTCTA2MzlK VDAwODCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAzzFG44ShTLd8mq8iGrsG adtkkvjlgal0diykw4tq++hanq6or0xvb51vjn3spuvckztvomt+nzg9b8xajp1v v5gqcnfv3lmeb7x0gcfcf5ccsgflq+eq7olh3a9nvo0bpx3wcsbz3hcxjtrapzcu r6kw3ave/3jrle9muzhkztscaweaatanbgkqhkig9w0baqufaaobgqcu7j7l7n/c Pony41ik6c7kXubwSsg0MRFxLVtkIlcVAc0rcY3CWA0Qd5l9ofP9+bkLeOTE8b54 3f94bsydlIUmh/8xBgcRxOSH9Ws06Dhp3RMwgmTzotl0KSwSAIJRM9gV/uPlrZgx CLYxODvcT5KyJlKIISVPhWVjYU3yTo0lLw== -----END CERTIFICATE

23 2 Configuring CWMP on the Thomson Gateway Listing ACS certificate information The Thomson Gateway uses pre-provisioned certificates for server authentication. To list the pre-provisioned certificates on the Thomson Gateway, execute the command :tls acsclient cert list. Optionally, two parameters can be specified: 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 Pre-provisioning ACS certificates The Thomson Gateway can receive the pre-provisioned certificates for server authentication as follows: File upload: through file upload (using FTP or TR-069). Proceed as follows when using FTP: 1 Set up an FTP session from your PC to the Thomson Gateway. 2 Go to the /dl directory with the command cd /dl. 3 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. 4 Close the FTP session with the command bye. 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. Configuring the list of trusted ACS certificates To add a certificate to the list of trusted certificates, execute following command: =>:tls acs-client cert add filename=<filename> To delete a certificate from the list of trusted certificates: =>:tls acs-client cert delete index=<filename> 17

24 2 Configuring CWMP on the Thomson Gateway 2.2 Configuring CWMP Introduction The implementation of CWMP on the Thomson Gateway is split up in two parts: CWMP service manager: use the service manager to: Enable or disable the CWMP client. Assign a specific QoS label and route label to traffic originated by the CWMP client. Enable or disable the CWMP connection request server. Configure the port used by the CWMP connection request server to receive connection requests. Enable or disable logging of the CWMP connection request server. Configure the NAT portmap weight of the CWMP connection request server. 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 Page CWMP Service Manager CWMP Daemon as seen from the ACS CWMP Daemon towards the ACS Notification Rules Runtime Variables 26 18

25 2 Configuring CWMP on the Thomson Gateway CWMP Service Manager 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 CWMP-C tcp Description... CPE Wan Management Protocol Client Properties... client Attributes... state port srcip qoslabel routelabel User Managed Attributes... state qoslabel routelabel Attribute s : State... (administratively) disabled Port... 0 Source Ip Selection... auto QOS Label... Management Route Label... None You can configure the value of following attributes: State: by default, the CWMP client service is disabled. To enable the service, execute following command: =>:service system modify name=cwmp-c state=enabled 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 19

26 2 Configuring CWMP on the Thomson Gateway CWMP connection request server To display the default attribute values of the CWMP connection request server service, execute following command: =>:service system list name=cwmp-s expand=enabled Idx Name Protocol SrcPort DstPort Group CWMP-S tcp Description... CPE Wan Management Protocol Server Properties... server Attributes... state port aclip aclif aclifgroup map log qoslabel routelabel natpmweight User Managed Attributes... state port log natpmweight Attribute s : State... (administratively) disabled Port QOS Label... None Route Label... None NAT Portmap Weight Ip Access List... any Interface Access List... any Interface Group Access List any Map List Logging... disabled You can configure the value of following attributes: State: by default, the CWMP connection request server service is disabled. To enable the service, execute following command: =>:service system modify name=cwmp-s state=enabled Port: this attribute is the port on which the connection request server listens for connection requests. The default port is 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

27 2 Configuring CWMP on the Thomson Gateway CWMP Daemon as seen from the ACS Displaying configuration information To obtain an overview of the CWMP daemon configuration as seen from the ACS, execute following command: =>:cwmp config State : disabled Mode : full Max Envelopes : 2 Session Timeout : 60 No Ip Timeout : 180 Connection Request Port : Periodic Inform : enabled Periodic Inform Interval : s Connection Request : disabled Connection Request UserName : 000E50-CP0452JT03Y Connection Request PassWord : ******** Connection Request Path : Connection Request Authentication : digest Qos class : 12 Boot delay range between 0 and : 0 s Amendment 1 Session Termination : disabled Upgrade delay : disabled Persistent Subscriptions : 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 CWMP Service Manager on page 19. Mode: one of two operational modes can be selected: Read-only: if the operational mode is set to read-only, only read RPC methods are allowed. A read-only mode is provided for customers that do not want to actively manage the CPE and do not want to take any security risk. The read-only mode still allows building an inventory of the installbase CPE. Full: to enable both read and write RPC methods, the operational mode must be set to full. This is the default mode. As more operators are performing TR-069 tests and become ready to deploy it, there is less use and request for a read-only mode. 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 s. This means that the CWMP client establishes a connection to the ACS once every 12 hours. 21

28 2 Configuring CWMP on the Thomson Gateway 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 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 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

29 2 Configuring CWMP on the Thomson Gateway 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 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 no further requests to send to the ACS. 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). By default, the parameter is disabled. 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. 23

30 2 Configuring CWMP on the Thomson Gateway CWMP Daemon towards the ACS Displaying configuration information To obtain an overview of the CWMP daemon configuration towards the ACS, execute following command: =>:cwmp server config The parameters and their default values are displayed as follows: ACS url : ACS username : 000E50-CP0452JT03Y ACS password : ******** 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: Url: this parameter specifies the HTTP URL of the ACS. 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 Password: this parameter defines the password for authentication of the Thomson Gateway at the ACS. 24

31 2 Configuring CWMP on the Thomson Gateway Notification Rules Introduction The ParameterList argument of an Inform message contains a list of informational parameters and their values. The list includes: Required parameters: these parameters must be sent in each Inform message. 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: Add non-standard parameters to the list of required parameters. Specify the behaviour of the CPE when the value of a specific parameter changes. Creating a notification rule To create a notification rule, execute the command :cwmp notification rule and specify one or more of following optional parameters: Name: this is the name of the parameter, i.e. a complete path name. Notification: this parameter defines the notification behaviour. Off (change notification off): the CPE does not need to inform the ACS of a change of the parameter. Passive (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 (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. Forced: the parameter value must be sent in each Inform message. In addition, active change notification is used. Inform: the parameter value must be sent in each Inform message. Keystring: this is the keystring_id of the notification rule. 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 25

32 2 Configuring CWMP on the Thomson Gateway Runtime Variables Listing runtime variables The values of the runtime variables cannot be changed and can only be listed. To list the CWMP runtime variables, execute following command: =>:cwmp runtimevar Software Version : Bootstrapped : no CmdKey : Parameterkey : 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: SetParameters 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

33 2 Configuring CWMP on the Thomson Gateway At each point in time, InternetGatewayDevice.ManagementServer.ParameterKey has the value of the ParameterKey argument of the most recent applied RPC. The ACS can check the ParameterKey value to identify parameter updates, object creations or object removals. 27

34 2 Configuring CWMP on the Thomson Gateway 2.3 Configuring State Checks 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 CWMP Daemon as seen from the ACS on page 21. Configure the state check module To configure the state check module, execute the command :statecheck config and specify following parameters: Interval: this is the interval (in seconds) between checks. By default, the interval value is set to 30 seconds. 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). Optionally, following parameters can be specified: 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. For example, configure the state check module as follows: =>:statecheck config interval=30 timeout=3600 groupop=or dmtree=igd Creating a group To create a group, execute the command :statecheck groupadd and specify following parameter: Name: the name of the group. Optionally, following parameter can be specified: Checkop: this parameter indicates whether the Check booleans within this group are ANDed or ORed. By default, the Check booleans are ANDed. For example, create a new group as follows: =>:statecheck groupadd name=dslactivity checkop=and 28

35 2 Configuring CWMP on the Thomson Gateway Deleting a group To delete a group, execute the command :statecheck groupdelete and specify following parameter: Name: the name of the group to be deleted. For example, delete a group as follows: =>:statecheck groupdelete name=dslactivity Creating a check To create a check, execute the command :statecheck checkadd and specify following parameters: Group: the check will be part of this group. Name: the name of the check to be created. Object: the object to be checked. Use the keystringpath of the object. To obtain this keystringpath, execute following command in MBUS: :mbus client exec cmd getvalues flags=keystrpath. Paramname: the parameter to be checked. Paramtype: the parameter type: String: a string. The value of the parameter is text. Uint: an integer. The value of the parameter is a number. Bool: a boolean. The value of the parameter can be 0 or 1. Matchtype: the match type: Equal: the check sets its Check boolean to 1 if the parameter value equals the match value. Differ: the check sets its Check boolean to 1 if the parameter value differs from the match value. Statdelta: the check sets its Check boolean to 1 if the parameter value increments more than a threshold, which is specified by the match value. Match: the match value. The parameter value is compared to the match value depending on the match type. For example, create a new check as follows: =>:statecheck checkadd group=dslactivity name=downstream object=internetgatewaydevice.wandevice.dsl.wandslinterfaceconfig paramname=downstreamcurrrate paramtype=uint matchtype=statdelta match=50 //dmtree=igd is used Deleting a check To delete a check, execute the command :statecheck checkdelete and specify following parameter: Name: the name of the check to be deleted. For example, delete a check as follows: =>:statecheck checkdelete name=downstream 29