TR-069 Guide – Documentation Center

What is TR-069?

It is a protocol for communication between CPE (Customer Premise Equipment) and an ACS (Auto Configuration Server) that provides secure auto-configuration as well as other CPE management functions within a common framework.

TR-069 stands for a “Technical Report” defined by the Broadband Forum that specifies the CWMP “CPE WAN Management Protocol”. It commonly uses HTTP or HTTPS as transport for communication between CPE and the ACS. The message exchange is using SOAP (XML_RPC) for configuration and management of the device.

Last published version of the standard is amendment 2 (CWMP1.1). The core defines the protocol, session establishment, message exchange structure, and Remote Procedure Calls.

Why use TR-069?

Service Providers, using TR-069, can have one common platform to manage all Grandstream devices and other CPEs, no matter neither the device type nor the manufacturer.

This common application was not easily achieved before due to CPE vendor’s proprietary mechanisms for provisioning/management.

TYPICAL SCENARIO

Figure 1: TR-069 Typical Scenario

The Previous figure shows a common customer installation. Where CPEs (Grandstream devices) are behind a router/gateway and they connect to the ACS via TR-069 so they can get managed remotely.

Normally TR-069 provisioning/management will be used by service providers in large scale deployments. Therefore, units need to be initially provisioned with the ACS connection parameters before being able to connect with the server. There are several ways to work this initial configuration as per-provisioning before sending unit to end user. However, Grandstream provides a redirection/provisioning service called GAPS that can take care of initial ACS parameters setup.

RPC METHODS

The following table provides a description of supported TR-069 RPC methods by Grandstream devices. Some models may have some extra methods (vendor-specific methods) that are not shown in the table below. Please, contact Grandstream for more information.

MethodsDescription

GetRPCMethods

Sent by the ACS to discover the set of methods supported by the CPE it is in communication with.

GetParameterNames

This method is used by an ACS to discover the device supported parameters.

When called, this method returns a list of parameter names on the device.

Depending on the method parameters, this can be called for complete and partial

parameter paths on the device.

GetParameterValues

This method is used by an ACS to obtain the value of one or more CPE

parameters.

GetAttributeValues

This method is used by an ACS to read the attributes associated with one or

more CPE parameters.

SetParameterValues

This method is used by an ACS to modify the value of one or more of the

device’s parameters.

SetAttributeValues

Changes the attributes (modifiers) of the specified path. The path can be

complete or partial.

AddObject

Adds a new instance of an object defined on the device.

DeleteObject

Deletes an instance of an object defined on the device.

Download

This method is used by the ACS to cause the CPE to download a specified file

from the designated location. Filetype supported by Grandstream devices are:

• 1 Firmware Upgrade Image
• 3 Vendor Configuration File

Upload

This method is used by the ACS to cause the CPE to upload a specified file

from the designated location. Filetype supported by Grandstream devices are:

• 3 Vendor Configuration File

Reboot

Reboots the device.

FactoryReset

Factory reset CPE settings to default.

This method doesn’t affect TR-069 settings.

Important Notes:

1. TR-069 defines the RPC methods “FactoryReset” and “Reboot”, there are some special request for it. As follows:

• For Factory Reset: This method resets the CPE to its factory default state. It should be used with extreme caution. The CPE MUST initiate the factory reset procedure only after successful completion of the session.

In order to make sure the CPE can connect to ACS server, the settings for TR-069 and internet will not be reset.

• For Reboot: This method causes the CPE to reboot. It should be used with extreme caution. The CPE MUST send the method response and complete the reminder of the session prior to Rebooting.
• If these two RPC methods are called to be used with other RPC methods during one session, they will be initiated in time and other RPC methods will be cancelled. It’s recommended to keep FactoryReset or Reboot method as last RPC method during one session.

2. FactoryReset & Reboot may not be effective immediately.

If the request is received while the device is in call, reboot or factory reset will not be effective immediately and will be delayed until device ends active call.

TR-069 DATA MODEL

Figure 2: TR-069 Data Model Tree

CWMP defines different data models for different kinds of device as shown in figure above.

All Grandstream devices with CPE are only SIP compatible, for this reason, our data model is loyal to TR-106 and TR-104.

TR-106 DATA MODEL

This technical report specifies a baseline object structure to be supported by any TR-069-enabled device. And the device according to the function which can be divided into two types.

Grandstream devices with CPE belongs to capable one (other than an Internet Gateway Device), so the root object for TR-069 data model tree is “Device” (for more details, please refer to TR-106 Amendment-2 chapter 2.1.1). The object version is loyal to Amendment-2.

TR-104 DATA MODEL

This technical report defines the data model for provisioning of VoIP devices by an ACS using the mechanism defined in TR-069.

All Grandstream devices are only SIP compatible, for this reason, only objects and parameters related to SIP are implemented from the data model.

Figure 3: TR-104 Data Model

SCOPE OF THE REMOTE MANAGEMENT

• Auto-Configuration:

This mechanism allows the Grandstream device auto-provisioning at the time of initial connection, and the ability to re-provision at any subsequent time. For initial ACS parameters provisioning please refer to the GAPS redirection service.

• Firmware Management:

TR-069 provides tools to manage downloading of CPE software/firmware image files. The protocol provides mechanisms for version identification, file download initiation (ACS initiated downloads and optional CPE initiated downloads), and notification of the ACS of the success or failure of a file download.

• Configuration or environnements variables changes notification :

TR-069 provides support for a CPE to make available information that the ACS may use to monitor the CPE’s status and performance statistics. This is done by defining the conditions under which a CPE should actively/passively notify the ACS of changes.

• Enabling / disabling features remotely:

For example, VoIP accounts can be easily activated by sending a TR-069 RPC. Additionally, other more advanced applications as pushing contents or customizing the GUI can be done by using vendor parameters.

• Reboot:

Grandstream devices can be rebooted by using the mechanisms established by TR-069.

• Factory Reset:

Grandstream devices can be restored with default settings by using the mechanisms established by TR-069. Factory reset from ACS does not affect TR-069 parameters to keep connection enabled with ACS server.

INTEROPERABILITY AND DEPLOYMENT

• Service provider contacts Grandstream sales department to establish initial relationship and provide both parties technical contact information.

• Service provider sends to Grandstream the requirement list and/or expected provisioning flow chart.

• Grandstream works together with service provider and ACS vendor to get the test cases and testing accounts.

• Testing and corrections.
• Initial deployment and verification.

TR-069 CONFIGURATION ON GRANDSTREAM DEVICES

Normally ACS configuration settings are pre-provisioned by the service provider or the Grandstream device is redirected by our GAPS to the location where the service provider has each device configuration file. However, we still have a graphic interface for easy testing and debugging.

To configure TR-069 on Grandstream devices, set following parameters:

ParameterDescription

ACS URL

URL of the TR-069 ACS, Grandstream device will try to connect and send messages to this server.

TR-069 Username

Username used for the HTTP authentication against the ACS.

TR-069 Password

Password used for the HTTP authentication against the ACS.

Periodic Inform Enable

Enables periodic inform. If set to “Yes”, the device will send inform packets to TR-069 ACS server.

Periodic Inform Interval

Periodic time when Grandstream device will send inform packets to TR-069 ACS server. This option is specified in seconds. The default value is 86400.

Connection Request Username

Username to authenticate incoming connection requests.

Connection Request Password

Password to authenticate incoming connection requests.

Connection Request Port

Port for incoming connection requests. The default value is 7547.

CPE SSL Certificate

The Cert File for the phone to authenticate against ACS using SSL.

CPE SSL Private Key

The Private Key File for the phone to authenticate against ACS using SSL.

The screenshot below shows TR-069 on Grandstream GXP2140 as example:

Figure 4: TR-069 Parameters

STANDARDS COMPLIANCE

Currently Grandstream CPEs support the list of standards shown below.

For further information about this technical document, please refer to Broadband Forum website.

TR-069 Amendment 2 (Partially Compliant)

RPC MethodSupportedVersion of CWMP protocolComment

GetRPCMethods

Y

1.0>

SetParameterValues

Y

1.0>

GetParameterValues

Y

1.0>

GetParameterName

Y

1.0>

SetParameterAttributes

Y

1.0>

GetParameterAttributes

Y

1.0>

AddObject

Y

1.0>

DeleteObject

Y

1.0>

Reboot

Y

1.0>

Download

Y

1.0>

FactoryReset

Y

1.0>

GetQueuedTransfers

N

1.0>

May be added in the future

Upload

Y

1.0>

ScheduleInform

Y

1.0>

GetAllQueuedTransfers

N

1.1>

May be added in the future

ScheduleDownload

N

1.2

May be added in the future

CancelTransfer

N

1.2

May be added in the future

Inform

Y

1.0>

TransferComplete

Y

1.0>

• Above supported RPC methods include support of their related fault codes and events.
• In addition to above RPC methods, some Vendor-Specific Events and their fault codes are also supported.

There are two special modules: IPPing Diagnostics and Trace Route Diagnostics.

1. IPPing Diagnostics:

SPV “Device.LAN.IPPingDiagnostics.Host” as the host name or address of the host to ping.

SPV “Device.LAN.IPPingDiagnostics.DiagnosticsState” as “Requested”.

2. Trace Route Diagnostics:

SPV “Device.LAN.TraceRouteDiagnostics.Host” as host name or address of the host to find a route to.

SPV “Device.LAN.TraceRouteDiagnostics.DiagnosticsState” as “Requested”.

Data Model

Device Summary:

NameVersion

Device

1.2

Baseline

1

UDPConnReq

1

LAN

1

Time

1

IPPing

1

TraceRoute

1

Download

1

Upload

1

VoiceService

1.0

Endpoint

1

SIPEndpoint

1

Some details supported:

1. Some special parameter request: When read, this parameter returns an empty string, regardless of the actual value.
2. Support Vendor-Specific Parameters.

TR-104 (Compliant with SIP)

Support SIPEndpoint Profile.

TR-111 part 2 defines an extension to TR-069 that allows an ACS to initiate a Session with a device that is operating behind a NAT Gateway. In this mechanism, we use a particular usage of STUN mechanism to complete. This mechanism requires support only in the Device and the associated ACS.

This Technical Report defines an Active Monitoring test suite which can be leveraged by Network Service Providers to monitor and/or diagnose the state of their broadband network paths serving populations of subscribers who It defines two method to monitor and/or diagnose the state of broadband network paths serving populations of subscribers.

Support diagnostics are specified in TR-143 document by broadband-forum. Two types of diagnostics are supported by library (of 3 in total):

1. Download Diagnostics:
   • SPV “Device.DownloadDiagnostics.DownloadURL” as the URL which used for download test.
   • SPV “Device.DownloadDiagnostics.DiagnosticsState” as “Requested”.
2. Upload Diagnostics:
   • SPV “Device.UploadDiagnostics.UploadURL” as the URL of http server which the file will upload to .
   • SPV “Device.UploadDiagnostics.DiagnosticsState” as “Requested”.

ACS INFORMATION

Grandstream has worked or it is currently working with the following ACS vendors:

• Finepoint
• Alcatel/Motive ACS
• ASISco Geremias
• FriendlyACS
• AVSystem
• Sagemcom

For more info regarding interoperability with these vendors or other ACS vendors, please contact Grandstream technical support https://helpdesk.grandstream.com/

For any additional inquire, please visit our website https://www.grandstream.com/company/contact-us and we will be more than glad to help and provide you specific information regarding Grandstream devices.

SUPPORTED DEVICES

Following table shows Grandstream products supporting TR-069 protocol.

ModelSupportedFirmware

GXP2130/2140/2160 GXP2135/2170

Yes

1.0.7.25 or higher

GXP16xx Series

Yes

1.0.4.6 or higher

GRP261x/GRP2624/GRP2634 Series

Yes

1.0.3.6 or higher

GRP260x Series

Yes

1.0.3.18 or higher

WP820

Yes

1.0.7.7 or higher

WP810

Yes

1.0.7.30 or higher

GXP17xx Series

Yes

1.0.0.37 or higher

GXV3370/GXV3380/GXV3350

Yes

1.0.3.9 or higher

GAC2500

Yes

1.0.1.44 or higher

GXW4216/4224/4232/4248

Yes

1.0.5.16 or higher

HT801/802/812/813/814

Yes

1.0.2.5 or higher

DP750

Yes

1.0.1.20 or higher

DP752

Yes

1.0.13.6 or higher