Broadband Forum User Services Platform (USP) Data Models

The Broadband Forum defines several data models for use with the User Services Platform (USP) (TR-369). These data models contain objects, parameters, commands, and events that describe the many different service elements that can be exposed via USP Agents.

USP data models are divided into two types: Root and Service. The root data model, Device, is used to describe the major functions of network aware devices, including interfaces, software/firmware, diagnostics, components common to USP and other services, and the basic Agent information necessary to the operation of USP.

Service data models describe modular functionality that allow the extension of the root data model on a device (under Device.Services.) to provide particular services, such as a voice service, set top box service, network attached storage, smart home objects, etc.

Each data model is defined by a Name:Version syntax. The objects, parameters, commands, and events that a particular Agent supports from its implementation of the data model define what is reported to Controllers via the GetSupportedDM message.

How do I use these?

Use the USP data model files to define and implement what exists in your solution's Supported Data Model. This will help Controllers learn what your solution is capable of. The data models will also describe how your solution's Instantiated Data Model will behave during operation.

These data models are based on the Broadband Forum's data models for the CPE WAN Management Protocol, also known as "TR-069", with a robust development history.

The source files used to build the complete USP data model can be found on GitHub.

List of Data Models

Latest Data Models

Data Model Version XML HTML Description Approval Date PDF
Device:2 2.12 tr-181-2-12-0-usp-full.xml Full

Added USP Local agent support (TR-369)

Added Firmware Image support

Added Ethernet Link Aggregation Group

Added additional Wi-Fi and WAN statistics

Added support for Two-Way Active Measurement Protocol (TWAMP) reflector

Added support for Layer Two Tunneling Protocol version 3 (L2TPv3)

Added support for Virtual eXtensible Local Area Network (VXLAN) tunnels

Added support for Broadband Access Service Attributes and Performance Metrics measurement test framework (BASAPM)

Added support for Large-Scale Measurement of Broadband Performance (LMAP)

March 2018 TR-181 Issue 2 Amendment 12
Diff
FAPService:2 2.1 tr-196-2-1-0-full.xml Full

Added parameters for 3GPP SA5 Rel 11 and 12 (TS 32.452, TS 32.453)

Added parameters for 3GPP SA5 Rel 13 (CR S5-145293)

Added parameters for 3GPP SA5 Rel 13 (CR S5-146268)

August 2015 TR-196 Issue 2
Diff
StorageService:1 1.3 tr-140-1-3-0-full.xml Full

Update file system and connection enumerations

Added SMART data model

May 2017 TR-140 Amendment 3
Diff
STBService:1 1.4 tr-135-1-4-0-full.xml Full

Added objects for Service Monitoring of Events

August 2015 TR-135 Amendment 3
Diff
VoiceService:2 2.0 tr-104-2-0-0-full.xml Full Original March 2014 TR-104 Issue 2

Root Data Models

Data Model Version XML HTML Description Approval Date PDF
Device:2 2.12 tr-181-2-12-0-usp-full.xml Full

Added USP Local agent support (TR-369)

Added Firmware Image support

Added Ethernet Link Aggregation Group

Added additional Wi-Fi and WAN statistics

Added support for Two-Way Active Measurement Protocol (TWAMP) reflector

Added support for Layer Two Tunneling Protocol version 3 (L2TPv3)

Added support for Virtual eXtensible Local Area Network (VXLAN) tunnels

Added support for Broadband Access Service Attributes and Performance Metrics measurement test framework (BASAPM)

Added support for Large-Scale Measurement of Broadband Performance (LMAP)

March 2018 TR-181 Issue 2 Amendment 12
Diff

Service Data Models

Data Model Version XML HTML Description Approval Date PDF
FAPService:2 2.1 tr-196-2-1-0-full.xml Full

Added parameters for 3GPP SA5 Rel 11 and 12 (TS 32.452, TS 32.453)

Added parameters for 3GPP SA5 Rel 13 (CR S5-145293)

Added parameters for 3GPP SA5 Rel 13 (CR S5-146268)

August 2015 TR-196 Issue 2
Diff
2.0 tr-196-2-0-3-full.xml Full

November 2011: Original

November 2012: Corrigendum 1

  • Corrected errors in TR-196i2 per direction of 3GPP TS 32.592.
  • Corrected range of FAPService.{i}.REM.UMTS.GSM.Cell.{i}.CI

February 2015: Corrigendum 2

  • Corrected errors in QHyst1s and QHyst2s parameter descriptions

October 2016: Corrigendum 3

  • Corrected errors in CID and LAC parameter ranges
October 2016
StorageService:1 1.3 tr-140-1-3-0-full.xml Full

Update file system and connection enumerations

Added SMART data model

May 2017 TR-140 Amendment 3
Diff
1.2 tr-140-1-2-0-full.xml Full Added Alias parameters July 2011 TR-140 Amendment 1
Diff
1.1 tr-140-1-1-1-full.xml Full

Apr 2010: Original

  • Added missing NumberOfEntries and Enable parameters

Dec 2011: Corrigendum 1

  • Corrected import of tr-140-1-0.xml
December 2011
Diff
1.0 tr-140-1-0-2-full.xml Full Apr 2010: Corrigendum 2 April 2010 TR-140
STBService:1 1.4 tr-135-1-4-0-full.xml Full

Added objects for Service Monitoring of Events

August 2015 TR-135 Amendment 3
Diff
1.3 tr-135-1-3-0-full.xml Full Added loss event histograms November 2012
Diff
1.2 tr-135-1-2-0-full.xml Full Added Alias parameters July 2011 TR-135 Amendment 1
Diff
1.1 tr-135-1-1-1-full.xml Full Added CDS, HDMI and S/PDIF objects February 2013
Diff
1.0 tr-135-1-0-0-full.xml Full Original September 2009 TR-135
VoiceService:2 2.0 tr-104-2-0-0-full.xml Full Original March 2014 TR-104 Issue 2

Schema Files

Document Filename Description Approval Date PDF
Data Model Definition Schema (DM Schema) cwmp-datamodel-1-6.xsd Supported USP commands, events and mount points March 2018 TR-106 Amendment 8
Data Model Report Schema (DMR Schema) cwmp-datamodel-report.xsd

Nov 2008: Original

Sep 2009: Added noUniqueKeys

September 2009 TR-106 Amendment 3
Device Type Schema (DT Schema) cwmp-devicetype-1-3.xsd Many minor updates and clarifications September 2013 TR-106 Amendment 7

Support Files

Document XML HTML Description Approval Date PDF
Data Model Data Types tr-106-1-2-0-types.xml Full Minor clarifications September 2009  
tr-106-1-1-1-types.xml Full Added DiagnosticsState November 2015
tr-106-1-0-0-types.xml Full

Nov 2013: Added IEEE_EUI64 and ZigBeeNetworkAddress

Sep 2013: Clarified use of the Alias cpe- prefix

Nov 2012: Added UUID and updated IPPrefix and IPv4Prefix

Nov 2011: Added Dbm1000 and updated statistics counter types

Jul 2011: Added Alias

Nov 2010: Added IPv6 and statistics counter types

May 2010: Added IPPrefix and IPAddress

Sep 2009: Minor changes, e.g. imported tr-069-biblio.xml

Nov 2008: Original

November 2013
Data Model Bibliographic References tr-069-1-6-0-biblio.xml Full

Mar 2014: Added TR-104i2 references

Nov 2013: Added Device:2.7 and TR-157a8 references

Nov 2012: Added TR-157a7 references

May 2012: Added Device:2.5 references

Dec 2011: Added Device:2.4, FAPService:2.0 and TR-262 references

Jul 2011: Added Alias-based addressing and proxy management references

May 2011: Added FAPService:1.1 references

Mar 2011: Added Device:2.2 references

Nov 2010: Added Device:2.1 references

May 2010: Added Device:2.0 references

Sep 2009: Minor changes, e.g. added missing dates

Mar 2009: Original

March 2014  
tr-069-1-5-0-biblio.xml Full Added Device:2.11 references July 2016
tr-069-1-4-0-biblio.xml Full Added Device:2.10 references November 2015
tr-069-1-3-0-biblio.xml Full Added TR-196i2a1 references August 2015
tr-069-1-2-0-biblio.xml Full Added Device:2.9 references December 2014
tr-069-1-1-0-biblio.xml Full Added Device:2.8, TR-143a1 and TR-157a9 references September 2014
tr-069-biblio.xml Full

Mar 2014: Added TR-104i2 references

Nov 2013: Added Device:2.7 and TR-157a8 references

Nov 2012: Added TR-157a7 references

May 2012: Added Device:2.5 references

Dec 2011: Added Device:2.4, FAPService:2.0 and TR-262 references

Jul 2011: Added Alias-based addressing and proxy management references

May 2011: Added FAPService:1.1 references

Mar 2011: Added Device:2.2 references

Nov 2010: Added Device:2.1 references

May 2010: Added Device:2.0 references

Sep 2009: Minor changes, e.g. added missing dates

Mar 2009: Original

March 2014

Outdated Corrigenda

Document XML Description Approval Date PDF
Femto Access Point Service Data Model tr-196-2-0-2.xml

November 2011: Original

November 2012: Corrigendum 1

  • Corrected errors in TR-196i2 per direction of 3GPP TS 32.592.
  • Corrected range of FAPService.{i}.REM.UMTS.GSM.Cell.{i}.CI

February 2015: Corrigendum 2

  • Corrected errors in QHyst1s and QHyst2s parameter descriptions

October 2016: Corrigendum 3

  • Corrected errors in CID and LAC parameter ranges
October 2016 TR-196 Issue 2
tr-196-2-0-1.xml
tr-196-2-0-0.xml
TR-069 Data Model for Storage Service Enabled Devices tr-140-1-1-0.xml

Apr 2010: Original

  • Added missing NumberOfEntries and Enable parameters

Dec 2011: Corrigendum 1

  • Corrected import of tr-140-1-0.xml
December 2011 TR-140 Amendment 1