Technical Bulletin 667

Using TR-069 with Mediatrix Gateways

June 28, 2011

Proprietary 2011 Media5 Corporation

Technical Bulletin 667

Table of Contents

Scope of this Document....................................................................................................................................... 3 Requirements ...................................................................................................................................................... 3 Gateway Configuration ........................................................................................................................................ 3 Fields Configuration ......................................................................................................................................... 4 Periodic Inform ................................................................................................................................................. 4 TR-106 Configuration ....................................................................................................................................... 4 Validating the Initial Configuration ................................................................................................................... 5 Performing Tasks Using TR-069 ......................................................................................................................... 6 Performing a Configuration File Download ...................................................................................................... 6 Performing a Firmware Upgrade or Downgrade .............................................................................................. 9 Annexes ............................................................................................................................................................. 10 List of Supported TR-069 Variables ............................................................................................................... 10 TR-069 Specification ...................................................................................................................................... 10

Page 2 of 10

Technical Bulletin 667

Scope of this Document

This document is targeted at technical personnel who wish to know how to configure the Mediatrix gateways for TR-069 operation. It provides a quick overview of the required steps for configuration script download and firmware upgrade. It is meant as a complement to the TR-069 documentation contained in the DGW v2.0 Software Configuration Guide.

Requirements
Your Mediatrix gateway must be able to run the DGW v2.0 firmware, and will need a firmware version 2.0.8.118 or higher. At the moment of this writing, the TR-069 feature can only be enabled by Mediatrix personnel and cannot be enabled in the field on already installed gateways.

Gateway Configuration
Access the TR-069 configuration via the web page Management -> CWMP (CPE WAN Management Protocol).

If the CWMP tab is not available, then verify: 1. That you have a firmware version of 2.0.8.118 or higher. 2. That the CWMP service is started. If the service is not available, then the feature has not been properly activated. Please contact Media5 Corporation.

Page 3 of 10

Technical Bulletin 667

Fields Configuration
Root element: Device and Internet Gateway Device (IGD) are both available. Device -> The Mediatrix unit uses the Device data model as defined in TR-106. Internet Gateway Device -> The Mediatrix unit uses the Internet Gateway Device data model as defined in TR-098. Configure the listening port. If you are using the default TR-069 port (7547), then leave it as 0. Set your ACS URL source to static or DHCP. Configure the URL if static was selected for the Config Source. HTTP and HTTPS are supported. If using authentication, then enter your Username and Password.

Periodic Inform
The Periodic Inform is a message sent by the unit to the ACS server to advertise its presence. It provides an update to the server on the modified variables since the last Inform message, and also allows obtaining configuration instructions. If enabled, the Periodic Inform is sent at the specified Periodic Inform Interval (in seconds). If the Periodic Inform is not enabled, the unit will nonetheless connect to the server once when the unit boots or when the CWMP service is restarted. This value could then be overridden and set to enabled by the server. Remember that TR-069 relies on the clients (e.g. units) to initiate the connections to the server in a NAT environment.

TR-106 Configuration
The TR-106 Configuration section allows you to set the network interface referred by the TR-106 LAN profile. If the field is empty, the Mediatrix unit uses the management interface configured in the Management / Misc page in the Network Interface drop-down menuError! Bookmark not defined.. If this management interface is set to All, the Mediatrix unit uses the network interface used for contacting the ACS.

Page 4 of 10

Technical Bulletin 667

Validating the Initial Configuration

If everything is configured correctly, you should see a TCP connection being established between your Mediatrix unit and the TR-069 server (from now on simply ACS). After the TCP connection has been established, the unit will send its first Inform message to the ACS, as seen below. Note that there will be more HTTP POST messages sent to the ACS (those can be empty) until the server returns a 204 No Content message.

Page 5 of 10

Technical Bulletin 667

Performing Tasks Using TR-069

Performing a Configuration File Download
As a first step, you will need to configure your ACS server to initiate a configuration script download request to the unit. In our server, we configure the download URL where the configuration file server is using a NAT address, then click Save.

Notes about the fields: URL: Full path of the script to install and execute. The script name, location, protocol and host are extracted from this path. The transfer protocol can be "http://", "https://", "ftp://" or "tftp://". Username: Username used for the firmware upgrade. Password: Password used for the firmware upgrade. The other fields are ignored by the application At the next Inform message sent from the Mediatrix unit to the ACS, the server will tell the unit to initiate a configuration script download by using the provided URL. Remember that your Inform message is most likely on a timer, so if you want to test this manually, you will need to restart the CWMP service. In this example, the script CustomScript.cfg simply sets a fake SIP username and friendly name, which we will be able to see in the webpage when the script has successfully executed. sipEp.UserAgent[EpId=Bri1].Username="55555555" sipEp.UserAgent[EpId=Bri1].FriendlyName="Test Script TR069" SipEp.registrationrefresh The whole TR-069 exchange can be seen in the following screenshots. 1) After the Inform from the Mediatrix unit, the server informs the unit to perform a Vendor Configuration File download, using the command key 9778. This is a tag, so that the server and client can exchange information about a particular transaction.

Page 6 of 10

Technical Bulletin 667

2) The unit responds with a status DownloadResponse of 1, meaning it will perform the requested operation. The following No Content message means the server has finished de livering its list of requests to the unit.

Page 7 of 10

Technical Bulletin 667

3) The unit performs the configuration script download and provides a status response to the ACS for command key 9778. Warning: this message only states that the requested operation is complete, it does not state if it has been successful or not.

4) In the next message, the unit provides more information about the status of the operation. In this case, the transfer is successful and the fault code is 0. If the fault code is anything else, there has been an error during the transfer attempt.

5) As a final step, the unit sends an empty HTTP POST message, and the server replies with 204 No Content, which puts an end to the dialog.

Page 8 of 10

Technical Bulletin 667

Performing a Firmware Upgrade or Downgrade

The process is roughly the same as the one outlined for the configuration file download. The only difference will be the tags sent to the unit inside the SOAP, as we will now be doing a firmware download. Also note that the path to the Dgw.mfp file must be given as the download URL.

Notes about the fields: URL: Full path to the file "Dgw.mfp" of the MFP to install. The firmware name, version, host, location and protocol to install are extracted from this path. The transfer protocol can be "http://", "https://", "ftp://" or "tftp://". Username: Username used for the firmware upgrade. Password: Password used for the firmware upgrade. The other fields are ignored by the application The ACS tells the Mediatrix unit to initiate a firmware upgrade/downgrade using the specified URL and command key 9787.

Using the mechanism described in the previous section, the unit tells the server the result of the operation (0 for successful) for the associated command key.

Page 9 of 10

Technical Bulletin 667

This is the end of the TR-069 exchange.

Annexes
List of Supported TR-069 Variables
For a full list of TR-069 variables, please see the DGW v2.0 Common Application Documentation, Software Configuration Guide: Chapter 42 - Supported TR-069 Methods and Parameters. http://www.media5corp.com/en/support/mediatrix--media5boss/downloads

TR-069 Specification
http://www.broadband-forum.org/technical/download/TR-069_Amendment-2.pdf

Page 10 of 10