Broadband Forum User Services Platform (USP) Data Models

2024-07-23: TR-369 Amendment 4, TR-106 Amendment 14 and TR-181 Issue 2 Amendment 18


The Broadband Forum defines several data models for use with the User Services Platform (USP). 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.

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.