Data Model Template for TR-069-Enabled Devices TR-106 Amendment 1
Page 1 of 37
TECHNICAL REPORT
DSL Forum
TR-106 Amendment 1
Data Model Template
for TR-069-Enabled Devices
November 2006
Produced by:
DSLHome-Technical Working Group
Editors:
Jeff Bernstein, 2Wire Mike Digdon, SupportSoft
Tim Spets, Westell Heather Kirksey, Motive
Christele Bouchat, Alcatel William Lupton, 2Wire
John Blackford, 2Wire Anton Okmianski, Cisco
Working Group Chair:
Greg Bathrick, PMC-Sierra
Heather Kirksey, Motive
Abstract:
This document specifies a generic data model applicable to all TR-069-enabled devices.
Data Model Template for TR-069-Enabled Devices TR-106 Amendment 1
Page 2 of 37
Notice:
The DSL Forum is a non-profit corporation organized to create guidelines for DSL network system
development and deployment. This Technical Report has been approved by members of the Forum. This
document is not binding on the DSL Forum, any of its members, or any developer or service provider. The
document is subject to change, but only with approval of members of the Forum.
©2005, 2006 Digital Subscriber Line Forum. All Rights Reserved.
DSL Forum technical reports may be copied, downloaded, stored on a server or otherwise re-distributed in
their entirety only. The text of this notice must be included in all copies.
Notwithstanding anything to the contrary, the DSL Forum makes no representation or warranty, expressed
or implied, concerning this publication, its contents or the completeness, accuracy, or applicability of any
information contained in this publication. No liability of any kind shall be assumed by the DSL Forum as a
result of reliance upon any information contained in this publication. The DSL Forum does not assume any
responsibility to update or correct any information in this publication.
Data Model Template for TR-069-Enabled Devices TR-106 Amendment 1
Page 3 of 37
Version History
Version
Number
Version Date Version Editor Changes
Issue 1 September 2005 Jeff Bernstein, 2Wire
Christele Bouchat, Alcatel
Tim Spets, Westell
Issue 1
Issue 1
Amendment 1
November 2006 Jeff Bernstein, 2Wire
John Blackford, 2Wire
Mike Digdon, SupportSoft
Heather Kirksey, Motive
William Lupton, 2Wire
Anton Okmianski, Cisco
Clarification of original document
Contents
1 Introduction ............................................................................................................................................. 4
1.1 Terminology................................................................................................................................. 5
1.2 Document Conventions ............................................................................................................... 5
2 Architecture............................................................................................................................................. 5
2.1 Data Hierarchy ............................................................................................................................ 5
2.1.1 Data Hierarchy Requirements....................................................................................... 6
2.1.2 Data Hierarchy Examples ............................................................................................. 7
2.2 Object Versioning........................................................................................................................ 9
2.2.1 Requirements for Compatible Versions......................................................................... 9
2.2.2 Version Notation ..........................................................................................................10
2.3 Profiles .......................................................................................................................................10
2.3.1 Scope of Profiles..........................................................................................................10
2.3.2 Multiple Profile Support................................................................................................11
2.3.3 Profile Versions............................................................................................................11
2.3.4 Baseline Profiles ..........................................................................................................11
2.3.5 Types of Requirements in a Profile ..............................................................................11
2.4 DEPRECATED and OBSOLETED Items ...................................................................................12
2.4.1 Requirements for DEPRECATED Items ......................................................................12
2.4.2 Requirements for OBSOLETED Items.........................................................................13
3 Object Definitions...................................................................................................................................13
3.1 General Notation ........................................................................................................................13
3.2 Data Types.................................................................................................................................14
3.3 Vendor-Specific Parameters ......................................................................................................15
3.4 Common Object Definitions........................................................................................................16
3.5 Inform Requirements..................................................................................................................29
3.6 Notification Requirements ..........................................................................................................30
3.7 DeviceSummary Definition.........................................................................................................31
3.7.1 DeviceSummary Examples..........................................................................................32
4 Profile Definitions ...................................................................................................................................33
4.1 Notation......................................................................................................................................33
4.2 Baseline Profile ..........................................................................................................................33
4.3 GatewayInfo Profile....................................................................................................................34
4.4 Time Profile ................................................................................................................................34
4.5 LAN Profile .................................................................................................................................34
4.6 IPPing Profile..............................................................................................................................35
4.7 TraceRoute Profile .....................................................................................................................35
4.8 UDPConnReq Profile .................................................................................................................35
Normative References ...................................................................................................................................37
Data Model Template for TR-069-Enabled Devices TR-106 Amendment 1
Page 4 of 37
1 Introduction
This document specifies a baseline object structure and set of TR-069-accessible parameters to be available
on any TR-069-enabled device [2]. TR-069 defines the generic requirements of the management protocol
methods which can be applied to any TR-069 CPE. It is intended to support a variety of different
functionalities to manage a collection of CPE, including the following primary capabilities:
• Auto-configuration and dynamic service provisioning
• Software/firmware image management
• Status and performance monitoring
• Diagnostics
If TR-069 defines the generic methods for any device, other documents (such as this one) specify the
managed objects, or data models, on which the generic methods act to configure, diagnose, and monitor the
state of specific devices and services.
The following figure places TR-069 in the end-to-end management architecture:
Figure 1 – Positioning in the End-to-End Architecture
OSS/BSS
Call
Center
Policy
Auto-Configuration
Server (ACS)
Managed Internet
Gateway Device
Managed LAN
Device
Managed LAN
Device
Managed LAN
Device
Scope of CPE WAN Management
Protocol (CWMP):
ACS Southbound Interface
ACS Northbound Interface
OSS/BSS
Call
Center
Policy
Auto-Configuration
Server (ACS)
Managed Internet
Gateway Device
Managed LAN
Device
Managed LAN
Device
Managed LAN
Device
Scope of CPE WAN Management
Protocol (CWMP):
ACS Southbound Interface
ACS Northbound Interface
The ACS is a server that resides in the network and manages devices in the subscriber premises. It uses the
methods, or RPCs, defined to TR-069 to get and set the state of the device, initiate diagnostic tests,
download and upload files, and manage events. Some portions of this state are common across managed
devices and some are relevant only to certain devices types or services.
For a particular type of device, it is expected that the baseline defined in this document would be
augmented with additional objects and parameters specific to the device type. The data-model used in any
TR-069-capable device must follow the guidelines described in this document. These guidelines include
the following aspects:
• Structural requirements for the data hierarchy
• Requirements for versioning of data models
• Requirements for defining profiles
• A set of common data objects
• A baseline profile for any device supporting these common data objects
Data Model Template for TR-069-Enabled Devices TR-106 Amendment 1
Page 5 of 37
1.1 Terminology
The following terminology is used throughout the series of documents defining the CPE WAN
Management Protocol.
ACS
Auto-Configuration Server. This is a component in the broadband network responsible
for auto-configuration of the CPE for advanced services.
CPE
Customer Premises Equipment.
Common
Object
An object defined in this specification that may be contained either directly within the
“Device” Root Object or within a Service Object contained within the “Services” object.
CWMP
CPE WAN Management Protocol. Defined in [2], CWMP is a communication protocol
between an ACS and CPE that defines a mechanism for secure auto-configuration of a
CPE and other CPe management functions in a common framework.
Data Model
A hierarchical set of Parameters that define the managed objects accessible via TR-069
for a particular device or service.
Device
Used here as a synonym for CPE.
Event
An indication that something of interest has happened that requires the CPE to notify the
ACS.
Internet
Gateway
Device
A CPE device that is either a B-NT (broadband network termination) or a broadband
router.
Object
A named collection of Parameters and/or other Objects.
Parameter
A name-value pair representing a manageable CPE parameter made accessible to an ACS
for reading and/or writing.
RPC
Remote Procedure Call.
Profile
A named collection of requirements relating to a given object.
Root Object
The top-level object of a device’s data model that contains all of the manageable objects.
The name of the Root Object is either “Device” or “InternetGatewayDevice”—the
former is used for all types of devices except an Internet Gateway Device.
Service
Object
The top-most object associated with a specific service or application within which all
objects and parameters associated with the service are contained.
1.2 Document Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted
as described in [1].
2 Architecture
2.1 Data Hierarchy
The data-model for a TR-069-capable device will follow a common set of structural requirements. The
detailed structure depends on the nature of the device.
