3.14. TR-069 WAN Management Protocol http://www.jungo.com/openrg/doc/4.8/evaluation_guide/html/html_eval...

3.14. TR-069 WAN Management Protocol

Chapter 3. Evaluating OpenRG

3.14. TR-069 WAN Management Protocol

This section describes how to set up TR-069 communication between OpenRG and a third-party
Auto-Configuration Server (ACS) server.

3.14.1. Hardware Requirements

To perform this evaluation you will need the following:

A gateway running OpenRG

Access to a Dimark ACS server

A LAN computer

Ethernet cables

3.14.2. List of Acronyms

ACS Auto-Configuration Server

CPE Customer Premise Equipment
RPC Remote Procedure Call
DPS Dimark Provisioning Server
OUI Organizational Unique Identifier

3.14.3. Feature Overview

TR-069 is a WAN management protocol intended for communication between Customer Premise Equipment
(CPE) and an Auto-Configuration Server (ACS). It defines a mechanism that encompasses secure auto
configuration of a CPE, and also incorporates other CPE management functions into a common framework.
In simpler terms, TR-069 is a protocol that enables remote server management of a CPE running OpenRG
(see Figure 3.210). Such a protocol is useful, for example, for remotely and securely controlling OpenRG by
the CPE provider.

Figure 3.210. TR-069 CPE WAN Management Protocol

The TR-069 protocol allows an ACS to provision a CPE or collection of CPE based on a variety of criteria. The
provisioning mechanism includes specific provisioning parameters and a general mechanism for adding
vendor-specific provisioning capabilities as needed. The provisioning mechanism allows CPE provisioning at
the time of initial connection to the broadband access network, and the ability to re-provision at any
subsequent time. This includes support for asynchronous ACS-initiated re-provisioning of a CPE. TR-069
defines several Remote Procedure Call (RPC) methods, as well as a large number of parameters, which may
be set or read. Some of these methods and parameters are defined as mandatory.

3.14.4. Evaluating a TR-069 Connection

1 of 6 1/7/2009 6:16 PM
3.14. TR-069 WAN Management Protocol http://www.jungo.com/openrg/doc/4.8/evaluation_guide/html/html_eval...

TR-069 refers to an ACS as the server on the ISP side. In the following example, the third-party ACS server
is the Dimark Provisioning Server (DPS). This ACS allows you to send arbitrary RPC commands to OpenRG
and watch OpenRG response.

3.14.4.1. Dimark Provisioning Server (DPS) Operation

1. Start DPS.

2. Browse to http://dps:8080/dps .

3. In the login screen enter: username: dps, password: dps

DPS will wait for the connection from OpenRG. Upon connection, OpenRG sends Inform RPC , which
contains the following data:
Manufacturer Organizational Unique Identifier (OUI) (6 hex digits which are also used in Ethernet
MAC)

Model ID

Serial number
This information can be viewed in the DPS Web-based management, in the "Devices That Have Been
Detected" table (see Figure 3.211).

Figure 3.211. DPS Detected Devices Screen

DPS uses the manufacturer OUI and the Model ID to find a suitable configuration. The configuration contains
a collection of commands that is used to:
Get parameters.

Set parameters to specific values.

Download an OpenRG software image or configuration file.

When a suitable configuration is found, DPS checks if this is the first time this particular OpenRG connected
(using its serial number). If this is the first connection, DPS sends all commands to perform the above
actions. If this OpenRG had connected before, the only action DPS performs is sending the commands that
get OpenRG's parameters. When using DPS, the OpenRG device entry on which the set and download
commands are to be performed, must be deleted from the DPS list of recognized devices. This is done from
the DPS Web-based management as follows:
1. Press the Device link.

2. In the device table, press the relevant device.

3. At the bottom of the device's page, press the "Delete CPE Information From the DPS Database" link.

3.14.4.2. Connecting OpenRG to DPS

The connection between OpenRG and the ACS server can only be initiated by OpenRG. OpenRG connects to
DPS in the following cases:
Upon boot.

When commanded from CLI with the following command: cwmp session_start .

When a connection request is received. A connection request is done by any authenticated HTTP
request made to the OpenRG connection request URL. The connection request URL can be viewed in
the DPS Web-based management as follows:

2 of 6 1/7/2009 6:16 PM
3.14. TR-069 WAN Management Protocol http://www.jungo.com/openrg/doc/4.8/evaluation_guide/html/html_eval...

Click the Device link.

In the device table, click the relevant device.

The URL appears in the section "CPE Parameters Reported on Inform", as parameter
InternetGatewayDevice.ManagementServer.ConnectionRequestURL . The connection request URL
can also be obtained by: http://<OpenRG WAN IP>:4567/<conn_req_url> where <conn_req_url> is the
OpenRG configuration value in cwmp/conn_req_url .

Periodically, when set. OpenRG can be configured to connect to DPS periodically, either by setting the
relevant TR-069 parameters on DPS, or by setting OpenRG's configuration entries.

For the complete list of supported TR-069 parameters, please refer to the 'TR-069
Parameters' chapter in the Programmer's Guide.

Set the following TR-069 parameters on DPS:

InternetGatewayDevice.ManagementServer.PeriodicInformInterval Period, in seconds.

InternetGatewayDevice.ManagementServer.PeriodicInformEnable Set to 'true' to

enable.

InternetGatewayDevice.ManagementServer.PeriodicInformTime May be used to set

base for periodic connections. If set, all periodic connections will start from this time.

Alternatively, set the following OpenRG configuration entries:

cwmp/periodic_inform/interval Same as DPS parameter.

cwmp/periodic_inform/enabled Set to 1 to enable.

cwmp/periodic_inform/time Same as DPS parameter.

3.14.4.3. OpenRG's TR-069 Configuration Entries

manufacturer/hardware/serial_num The serial number. Default rg_factory value is 222.

manufacturer/vendor_oui Default rg_factory value is 12ab78.
manufacturer/model_number Default rg_factory value is 34.5.
cwmp/enabled General enable flag for TR-069. Default rg_default value is 1.
cwmp/acs_url The URL of the ACS. Default rg_factory value is http://acs:1234/acs_path. This value must
be set to the actual URL, using the conf set CLI command. When using Dimark, set it to http://dps:8080
/dps/TR069 (replace "dps" with actual DPS IP address).

cwmp/username, cwmp/password The username and password used for connecting to the ACS. Since
Dimark's DPS does not support this yet, it may be left in this example with the default values. Default
rg_factory value is cpe (for both).
cwmp/conn_req_username, cwmp/conn_req_password The username and password used for
authenticating ACS during a connection request. Default rg_factory value is acs (for both).

3.14.4.4. Using DPS

Configuring DPS to get OpenRG's parameters is performed by calling the GetParametersValue method.

1. In the left column of the DPS Web-based management, select "Configuration Specific Polling".

2. Click the "Create a New Parameter to be Polled For This Configuration" link.

3. Choose a Default configuration.

4. Enter a full parameter name, for example InternetGatewayDevice.DeviceInfo.ProvisioningCode .

5. Press the Save button.

6. Initiate (or wait for) an OpenRG connection.

7. Browse to Device under DPS and select your board.

8. Verify that under "Device Statistics" you have an entry of the parameter used, with the correct value.

3 of 6 1/7/2009 6:16 PM
3.14. TR-069 WAN Management Protocol http://www.jungo.com/openrg/doc/4.8/evaluation_guide/html/html_eval...

9. The actual value of InternetGatewayDevice.DeviceInfo.ProvisioningCode may be read using the

CLI command: openrg> conf print /cwmp/provisioning_code

Configuring DPS to set OpenRG's parameters is performed by calling the SetParametersValue method.

1. Delete OpenRG's entry as described above.

2. In the left column of the DPS Web-based management, under "General CPE Configuration", select
"Create a New Configuration Parameter".

3. Click the "Create a New Configuration Parameter" link and fill in the following fields:
Name: InternetGatewayDevice.DeviceInfo.ProvisioningCode

Value: newProvCode

Type: String(64)

Required: Yes

Read Only: No

Description: Prov code // OPTIONAL

Configuration Code: DEFAULT -1.0

4. Initiate (or wait for) an OpenRG connection.

The parameter may be now be queried using the get procedure.

3.14.5. Remotely Configuring OpenRG Over a TR-069 Connection

The TR-069 protocol can be used to perform remote tasks by the ACS on the CPE. Following are DPS
configuration examples for performing such tasks. The first demonstrates the set parameters capability, by
changing OpenRG's DHCP settings from afar. The second illustrates the ability to induce OpenRG to perform a
remote update, by downloading a new software image or configuration file.

3.14.5.1. Changing OpenRG's DHCP Settings

In order to configure DPS to set OpenRG's DHCP settings, it is necessary to obtain the respective parameter
name, as listed in DPS when OpenRG connects. This is the DHCPServerEnable parameter, which is device-
specific, and can be found in the "Device Parameters as Reported by CPE" list under the device entry.

Figure 3.212. Obtaining the DHCPServerEnable Parameter

1. Delete OpenRG's entry as described above.

2. Disconnect OpenRG from the WAN and restore its defaults.

3. When OpenRG loads again, verify that its IP Address Distribution is set to DHCP Server (see
Figure 3.213). To do so, browse to OpenRG's Web-based management, and:

1. Press the 'Network Connection' button on the sidebar.

2. Click the LAN Bridge or LAN Ethernet link.

4 of 6 1/7/2009 6:16 PM
3.14. TR-069 WAN Management Protocol http://www.jungo.com/openrg/doc/4.8/evaluation_guide/html/html_eval...

3. Press the Settings button.

Figure 3.213. IP Address Distribution

4. In the left column of the DPS Web-based management, under "General CPE Configuration", select
"Create a New Configuration Parameter".

5. Click the "Create a New Configuration Parameter" link and fill in the following fields:
Name: InternetGatewayDevice.LANDevice.1. LANHostConfigManagement.DHCPServerEnable

Value: 0

Type: Boolean

Required: Yes

Read Only: No

Description: Disabling DHCP Server

Configuration Code: DEFAULT -1.0

6. Reconnect OpenRG to the WAN, and initiate (or wait for) a connection.
The setting change should occur as soon as the connection between OpenRG and DPS is established. Verify
this change by browsing to OpenRG's LAN Configuration screen, as depicted above.

3.14.5.2. Remote Update

The remote update feature described in Section 3.11 can also be initiated by an ACS. A CPE provider can
automatically update all its clients with newer software images or configuration files the next time they
restart their OpenRG. To configure DPS to remotely update OpenRG:
1. Delete OpenRG's entry as described above.

2. In the DPS left column select "Configuration Files".

3. Create a new entry with the following fields:

Name: a description of the file.

Size: any value may be used as this is not used in OpenRG.

Target Name: any value may be used as this is not used in OpenRG.

URL: For OpenRG's image download: http://<image-server-ip>/openrg.rmt . For OpenRG's

configuration file download: http://<rg_conf-server-ip>/OPENRG.conf .

File Type: select Firmware Image or Vendor Configuration File, respectively.

Configuration DEFAULT - 1.0.

4. Initiate (or wait for) an OpenRG connection.

As soon as OpenRG connects to DPS, it will download the image or the configuration file. When the download
and connection with DPS complete, OpenRG will reboot. It will then reconnect to DPS and send the download
results. You may observe the following in the DPS Web-based management, in the device page (see
Figure 3.214):

The following entry should appear in "The Last 20 CPE Log Entries" section: 7 TRANSFER COMPLETE.

If an OpenRG image was downloaded - in "CPE Parameters Reported on Inform" section, the
InternetGatewayDevice.DeviceInfo.SoftwareVersion parameter should contain the new version.

If an OpenRG configuration file had been downloaded, other configuration parameters may need to be

5 of 6 1/7/2009 6:16 PM
3.14. TR-069 WAN Management Protocol http://www.jungo.com/openrg/doc/4.8/evaluation_guide/html/html_eval...

checked.

Figure 3.214. DPS Presenting OpenRG's Download Results

© 1998-2008 Jungo Software Technologies Ltd.

3.13. Simple Network Management 3.15. TR-064 LAN Management Protocol

Protocol

6 of 6 1/7/2009 6:16 PM