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.

A ZIP file containing all the latest data models can be downloaded from here.

List of Data Models

Latest Data Models

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

Added support for WFA Data Elements

Added support for Multi AP

Added support for WPA3 and 802.11ax

Added support for MQTT 5.0

Added support for Package capture diagnostics

Updates for TR-369 MQTT support

Added support for IoT Data model

September 2019 TR-181 Issue 2 Amendment 13
Diff
FAPService:2 2.1 tr-196-2-1-1-usp-full.xml Full

August 2015:

  • 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)

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-196 Issue 2
Diff
StorageService:1 1.3 tr-140-1-3-1-usp-full.xml Full

May 2017:

  • Update file system and connection enumerations
  • Added SMART data model

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-140 Amendment 3
Diff
STBService:1 1.4 tr-135-1-4-1-usp-full.xml Full

August 2015:

  • Added objects for Service Monitoring of Events

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-135 Amendment 3
Diff
VoiceService:2 2.0 tr-104-2-0-1-usp-full.xml Full

March 2014:

  • Original

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-104 Issue 2

Root Data Models

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

Added support for WFA Data Elements

Added support for Multi AP

Added support for WPA3 and 802.11ax

Added support for MQTT 5.0

Added support for Package capture diagnostics

Updates for TR-369 MQTT support

Added support for IoT Data model

September 2019 TR-181 Issue 2 Amendment 13
Diff
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-1-usp-full.xml Full

August 2015:

  • 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)

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-196 Issue 2
Diff
StorageService:1 1.3 tr-140-1-3-1-usp-full.xml Full

May 2017:

  • Update file system and connection enumerations
  • Added SMART data model

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-140 Amendment 3
Diff
STBService:1 1.4 tr-135-1-4-1-usp-full.xml Full

August 2015:

  • Added objects for Service Monitoring of Events

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-135 Amendment 3
Diff
VoiceService:2 2.0 tr-104-2-0-1-usp-full.xml Full

March 2014:

  • Original

September 2019: Corrigendum 1

  • Added USP support (split XML into common, CWMP and USP files)
September 2019 TR-104 Issue 2

Schema Files

Document Filename Description Approval Date PDF
USP Protocol Buffers Schemas usp-record-1-1.proto USP v1.1 Record Schema (no changes from v1.0) September 2019 TR-369 Amendment 1
usp-record-1-0.proto USP v1.0 Record Schema April 2018 TR-369
usp-msg-1-1.proto USP v1.1 Message Schema (no changes from v1.0) September 2019 TR-369 Amendment 1
usp-msg-1-0.proto USP v1.0 Message Schema April 2018 TR-369
Data Model Definition Schema (DM Schema) cwmp-datamodel-1-7.xsd Supported implementation defaults, version attribute, description templates, writeOnceReadOnly access type and the decimal datatype September 2019 TR-106 Amendment 8
cwmp-datamodel-1-6.xsd Supported USP commands, events and mount points March 2018
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-4.xsd Updated to reference latest published DM Schema version (v1.7) September 2019 TR-106 Amendment 8
cwmp-devicetype-1-3.xsd Many minor updates and clarifications September 2013 TR-106 Amendment 7
DT (Device Type) Features Schema (DTF Schema) cwmp-devicetype-features.xsd Original September 2009 TR-106 Amendment 3

Support Files

Document XML HTML Description Approval Date PDF
Data Model Data Types tr-106-types.xml Full

Added datatypes from versioned files

Added CWMP and USP versions of the Alias datatype

Added URI, URL and URL datatypes

September 2019  
Data Model Bibliographic References tr-069-biblio.xml Full

Added references from versioned files (grouped by category and sorted within category)

Updated references for convention that "TR-nnn" means the latest Amendment and Corrigendum

Added references in support of Device:2.13 DM Instances

September 2019