Broadband Forum User Services Platform (USP) Data Models

2024-01-18: TR-106 Amendment 13 and TR-181 Issue 2 Amendment 17

Introduction

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.

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.

View the HTML files on this page for a human-readable look at the data model documentation.
Use the XML files in this repository when generating code and performing data validation.

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.

Current Data Models

Data Model	Version	XML	HTML	Description	Date	Specification
Device:2	2.17	tr-181-2-17-0-usp-full.xml	Full	Added new parameters for Multi-flow and Multi-server testing capability as defined in TR-471 Issue 4 Updated MoCA data model with MoCA Alliance 2.5 specification Added Device.DNS.SD.Advertise object to to allow the configuration of DNS-SD services that need to be advertised by the device Added RDNSS and DNSSL options to the Device.RouterAdvertisement.InterfaceSetting.{i}. object Added missing parameters from the Data Elements R2.1 specification Added the Zone file concept to the Device.DNS. object Added DNS caching configurability to the Device.DNS.Relay. object, allowing for control over the cache settings, added a mechanism to allow the specification of the ingress (LAN side) interface(s) to be used by the DNS forwarders Added new InterfaceSetting object to Device.Firewall. Added ModuleVersion parameter to InstallDU() and Update() commands Added Origin parameter to PinHole, PortMapping and AccesssControl Added PhysAddresMask parameter to AccessControl Added LeaseDuration and RemainLeaseTime parameters to the DMZ and Pinhole objects Added Device.Firewall.ConnectionTracking. object tree to configure ALGs Added missing DSL xTU-C and xTU-R parameters to DSL objects Added Device.Syslog. object tree to configure a syslog service Added Support for password authentication in xPON Added MaxNumberOfPortMappings and MaxNumberOfPortTriggers parameters to indicate system limits Fixed the access of some UserInterface parameters and objects: Demoted Session and User to read-only, promoted Protocol to read-write Fixed the access of a SSH parameter: Promoted AutoDisableDuration to read-write Fixed the access of a USPServices parameter: Demoted Protocol to read-only Added UDSAgent:1 and UDSController:1 profiles Added Device.DeviceInfo.LogRotate.{i}. to setup a log rotation mechanism Clarified descriptions of parameters in Device.SoftwareModules.ExecutionUnit.{i}.AutoRestart. Added initial support for the 802.11be Wi-Fi 7 standard/mode in various places Added OnBoardingComplete parameter to Device.LocalAgent.Controller.{i}. Clarified suggested implementation of Device.PeriodicStatistics. concept Added support for passing environment variables to software modules Removed reference to an incorrect default port requirement from TR-471 Added EEEStatus parameter to Device.Ethernet.Interface.{i}. Extended the key of Device.LocalAgent.Monitor.{i}.OnChange! ChangeSet.{i}.Parameter.{i}. output argument to include ChangeTime Added objects and parameters to align with the work-in-progress DataElements R3 specification Refactored scheduling related parameters into component for easier reuse and added Active and TimeLeft parameters Added Device.SoftwareModules.ExecutionUnit.{i}.NetworkConfig. object and parameters Added MaxSupportedDataDownlinkRate, MaxSupportedDataUplinkRate, SNR, and MaxSupportedBandwidth parameters to Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. Replaced custom coded Order parameter type and descriptions with the new Order datatype and text template Changed the default WebSocket port from 5683 to 8443 Added support for checksum reporting to TransferComplete! event	January 2024	Device Data Model TR-181 Issue 2 Amendment 17
Device:2	2.17	tr-181-2-17-0-usp-full.xml	Diff		January 2024	Device Data Model TR-181 Issue 2 Amendment 17

FAPService:2	2.1	tr-196-2-1-2-usp-full.xml	Full	Deprecated Blacklisted parameters and replaced with Blocklisted parameters	July 2022	TR-196 Issue 2
		tr-196-2-1-2-usp-full.xml	Diff		July 2022
		tr-196-2-1-1-usp-full.xml	Full	Added USP support (split XML into common, CWMP and USP files)	September 2019
		tr-196-2-1-1-usp-full.xml	Diff		September 2019

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

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

VoiceService:2	2.0	tr-104-2-0-2-usp-full.xml	Full	Clarified meaning of SessionID and added new SIPSessionID	January 2020	TR-104 Issue 2
VoiceService:2	2.0	tr-104-2-0-1-usp-full.xml	Full	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	Date	Specification
Device:2	2.17	tr-181-2-17-0-usp-full.xml	Full	Added new parameters for Multi-flow and Multi-server testing capability as defined in TR-471 Issue 4 Updated MoCA data model with MoCA Alliance 2.5 specification Added Device.DNS.SD.Advertise object to to allow the configuration of DNS-SD services that need to be advertised by the device Added RDNSS and DNSSL options to the Device.RouterAdvertisement.InterfaceSetting.{i}. object Added missing parameters from the Data Elements R2.1 specification Added the Zone file concept to the Device.DNS. object Added DNS caching configurability to the Device.DNS.Relay. object, allowing for control over the cache settings, added a mechanism to allow the specification of the ingress (LAN side) interface(s) to be used by the DNS forwarders Added new InterfaceSetting object to Device.Firewall. Added ModuleVersion parameter to InstallDU() and Update() commands Added Origin parameter to PinHole, PortMapping and AccesssControl Added PhysAddresMask parameter to AccessControl Added LeaseDuration and RemainLeaseTime parameters to the DMZ and Pinhole objects Added Device.Firewall.ConnectionTracking. object tree to configure ALGs Added missing DSL xTU-C and xTU-R parameters to DSL objects Added Device.Syslog. object tree to configure a syslog service Added Support for password authentication in xPON Added MaxNumberOfPortMappings and MaxNumberOfPortTriggers parameters to indicate system limits Fixed the access of some UserInterface parameters and objects: Demoted Session and User to read-only, promoted Protocol to read-write Fixed the access of a SSH parameter: Promoted AutoDisableDuration to read-write Fixed the access of a USPServices parameter: Demoted Protocol to read-only Added UDSAgent:1 and UDSController:1 profiles Added Device.DeviceInfo.LogRotate.{i}. to setup a log rotation mechanism Clarified descriptions of parameters in Device.SoftwareModules.ExecutionUnit.{i}.AutoRestart. Added initial support for the 802.11be Wi-Fi 7 standard/mode in various places Added OnBoardingComplete parameter to Device.LocalAgent.Controller.{i}. Clarified suggested implementation of Device.PeriodicStatistics. concept Added support for passing environment variables to software modules Removed reference to an incorrect default port requirement from TR-471 Added EEEStatus parameter to Device.Ethernet.Interface.{i}. Extended the key of Device.LocalAgent.Monitor.{i}.OnChange! ChangeSet.{i}.Parameter.{i}. output argument to include ChangeTime Added objects and parameters to align with the work-in-progress DataElements R3 specification Refactored scheduling related parameters into component for easier reuse and added Active and TimeLeft parameters Added Device.SoftwareModules.ExecutionUnit.{i}.NetworkConfig. object and parameters Added MaxSupportedDataDownlinkRate, MaxSupportedDataUplinkRate, SNR, and MaxSupportedBandwidth parameters to Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. Replaced custom coded Order parameter type and descriptions with the new Order datatype and text template Changed the default WebSocket port from 5683 to 8443 Added support for checksum reporting to TransferComplete! event	January 2024	Device Data Model TR-181 Issue 2 Amendment 17
	2.17	tr-181-2-17-0-usp-full.xml	Diff		January 2024	Device Data Model TR-181 Issue 2 Amendment 17
	2.16	tr-181-2-16-0-usp-full.xml	Full	Added Device.LocalAgent.Subscription.{i}.TriggerAction parameter to control the notification behavior Added SecuredRoles concept to the USP-specific ControllerTrust Turned a number of “hidden” parameters into “secured” parameters to allow USP Controllers with a secure role to read parameter values Added a few parameters to Device.Bridging.Bridge. and sub-objects to allow better control over bridges and STP behavior Made unique key type (functional vs non-functional) explicit rather than defaulting, and fixed incorrect choices Added ability to configure exclusions from BulkData reports Added Device.DeviceInfo.HostName parameter Unified description of Interface parameters Updated status according to our deprecation policy Extended some incorrect type restrictions Fixed/unified some units and their use in the description Added SupportedLinkModes parameter to ethernet interfaces Clarified the Device.Firewall. object and added support for firewall features DMZ, Services, Pinholing and Policies. Also added support for additional classifiers Introduced Device.GatewayInfo. into USP Extended the type of a few counters from unsignedInt to StatsCounter64 Added new IPLayerCapacityDiagnostic parameters/arguments from the TR-471i3 document Added UDS (Unix Domain Socket) MTP and Device.UnixDomainSockets. objects for internal services Added Device.Logical. sub-tree to allow for definition of logical network interfaces Added Device.NAT.PortTrigger. Added USP notification mechanism to Device.PeriodicStatistics. Improved PPP LCPEcho description and added LCPEchoAdaptive parameter Vastly extended Device.QoS. features by adding Queues, Shapers and Schedulers Added new parameters to Device.Routing. and sub-objects to add more routing features Vastly extended SMM (Software Module Management) capabilities with support for ApplicationData, HostObject, ExecEnvClass and AutoRestart Added Device.SSH. to configure an SSH service Extended Device.Time. with support for NTP client and server configuration Added Device.UserInterface.HTTPAccess. to allow for local UI access control Added USP-specific Device.LocalAgent.Monitor. object to allow for efficient tracking of parameter value changes Added support for Device.USPServices. to manage internal services via USP Added Device.XPON. to model xPON interfaces Applied cleanup for Wi-Fi objects/parameters to line up with Wi-Fi Alliance documents Removed activeNotify=“canDeny” attributes from some parameters Added PeriodicStatsAdv:2 and MQTTController:2 profiles Added USPServiceRef parameters to MTP referencing a service using it Disambiguated NTP vs. SNTP protocols Expanded/unified descriptions of parameters used for retries	June 2023	TR-181 Issue 2 Amendment 16
	2.16	tr-181-2-16-0-usp-full.xml	Diff		June 2023	TR-181 Issue 2 Amendment 16
	2.15	tr-181-2-15-1-usp-full.xml	Full	Removed items that were erroneously added to the User:1 profile and instead added them to a new User:2 profile Fixed the BulkData Profile Parameter reference; it’s a string, not a formal path reference Fixed the InstallDU() command’s ExecutionEnvRef argument; it references an execution environment, not an execution unit Fixed the VendorConfigFile description’s CWMP/USP-specific text	April 2022	TR-181 Issue 2 Amendment 15
		tr-181-2-15-1-usp-full.xml	Diff		April 2022
		tr-181-2-15-0-usp-full.xml	Full	Split the XML into multiple smaller files (this is just housekeeping; it doesn’t affect how the model is used) Allowed USP to access the EnableCWMP parameter (so a USP Controller can enable/disable CWMP access) Added Device.Routing.Babel for the RFC 8966 Babel routing protocol Added Device.DOCSIS for modeling DOCSIS 3.0 and 3.1 interfaces Added Device.Users.Group, Device.Users.Role and Device.Users.SupportedShell tables for modeling system users Improved the Wi-Fi data model by adding Data Elements R2 parameters, commands and events, moving MultiAP parameters and commands into the Data Elements structure, and by deprecating AIFSN, ECWMin, ECWMax and TxOpMax Clarified the LockoutPeriod and Retries ControllerTrust parameters that impact how the RequestChallenge() and ChallengeResponse() data model commands handle failed attempts Clarified bulk data profile, threshold and periodic statistics USP Controller permissions: only the USP Controller that created the profile will receive the corresponding events Added a bulk data profile ForceCollection() command Added support for a new bulk data collection mechanism that utilizes MQTT as the transport protocol Removed old bulk data collection protocols (Streaming and File) from the USP data model (they don’t apply to USP) Updated the IPLayerCapacity() test to support TR-472 Issue 2 Added an enumeration to indicate when a Boot! event was due to a factory reset Added an enumeration to distinguish encrypted and unencrypted USP MQTT WebSocket connections Added an Order parameter to provide guidance to USP Agents on which MTP to use when communicating with a Controller Clarified that Device.Optical is intended for generic optical interfaces and is not intended to model anything specific to IEEE or ITU-T PON technologies (objects specific to such technologies may be added in future versions of the data model) Clarified the meaning and usage of the Device.Ethernet.Interface and Device.Ethernet.Link objects (also allowed the Ethernet Link MACAddress parameter to be written) Improved (and made more consistent) the marking of (and explanation of) deprecated items, and how such items should progress from being deprecated to obsoleted to deleted Added a Baseline:4 profile that doesn’t include Device.LANConfigSecurity (it relates to the now-deprecated TR-064 LAN management protocol) Many minor improvements to object, parameter, command and event descriptions Replaced the non-standard dmr:version attribute with the version attribute (which supports three levels of version) Switched to DMR (data model report) schema v1.0, which supports multi-line paragraphs, and wrapped all lines to 80 characters maximum	January 2022
		tr-181-2-15-0-usp-full.xml	Diff		January 2022
	2.14	tr-181-2-14-1-usp-full.xml	Full	Fixed Device.LocalAgent.Subscription.{i}.ID constraints Fixed typos	November 2020	TR-181 Issue 2 Amendment 14
		tr-181-2-14-1-usp-full.xml	Diff
		tr-181-2-14-0-usp-full.xml	Full	Added WWC (5G Wireline Wireless Convergence), PDU (Protocol Data Unit) and FWE (5G Wireline wireless Encapsulation) top-level objects Updated Cellular object to be applicable to 5G Residential Gateways Extended support for TR-471 IP-layer metrics, including new IP-layer capacity test Supported LAN device time-based access-control Various Wi-Fi improvements
		tr-181-2-14-0-usp-full.xml	Diff
	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 Packet capture diagnostics Updates for TR-369 MQTT support Added support for IoT Data model	September 2019	TR-181 Issue 2 Amendment 13
	2.13	tr-181-2-13-0-usp-full.xml	Diff		September 2019	TR-181 Issue 2 Amendment 13
	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
	2.12	tr-181-2-12-0-usp-full.xml	Diff		March 2018	TR-181 Issue 2 Amendment 12

Service Data Models

Data Model	Version	XML	HTML	Description	Date	Specification
FAPService:2	2.1	tr-196-2-1-2-usp-full.xml	Full	Deprecated Blacklisted parameters and replaced with Blocklisted parameters	July 2022	TR-196 Issue 2
		tr-196-2-1-2-usp-full.xml	Diff		July 2022
		tr-196-2-1-1-usp-full.xml	Full	Added USP support (split XML into common, CWMP and USP files)	September 2019
		tr-196-2-1-1-usp-full.xml	Diff		September 2019

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

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

VoiceService:2	2.0	tr-104-2-0-2-usp-full.xml	Full	Clarified meaning of SessionID and added new SIPSessionID	January 2020	TR-104 Issue 2
VoiceService:2	2.0	tr-104-2-0-1-usp-full.xml	Full	Added USP support (split XML into common, CWMP and USP files)	September 2019	TR-104 Issue 2

Schema Files

Document	Filename	Description	Date	Specification
USP Protocol Buffers Schemas	usp-record-1-3.proto	USP v1.3 Record Schema Adds UDSConnectRecord	June 2023	Release 1.3
	usp-msg-1-3.proto	USP v1.3 Message Schema Adds Register and Deregister messages	June 2023	Release 1.3
	usp-record-1-2.proto	USP v1.2 Record Schema Added Connect and Disconnect Record Types	January 2022	Release 1.2
	usp-msg-1-2.proto	USP v1.2 Message Schema Added max_depth as a new input argument to the Get message Enhanced the GetSupportedDM response to allow return of parameter types, parameters that will be ignored for value change notifications, divergent object paths, and command types	January 2022	Release 1.2
	usp-record-1-1.proto	USP v1.1 Record Schema (no changes from v1.0)	October 2019	Release 1.1
	usp-msg-1-1.proto	USP v1.1 Message Schema (no changes from v1.0)	October 2019	Release 1.1
	usp-record-1-0.proto	USP v1.0 Record Schema	April 2018	Release 1.0
	usp-msg-1-0.proto	USP v1.0 Message Schema	April 2018	Release 1.0

Device Type Schema (DT Schema)	cwmp-devicetype-1-10.xsd	Updated to reference latest published DM Schema version (v1.10) Note that the DT Schema is v1.10 to match the DM Schema (DT Schema v1.7, v1.8 and v1.9 were skipped)	June 2023	TR-106 Amendment 12
	cwmp-devicetype-1-6.xsd	Updated to reference latest published DM Schema version (v1.9)	January 2022	TR-106 Amendment 11
	cwmp-devicetype-1-5.xsd	Updated to reference latest published DM Schema version (v1.8) Supported event and command structures in device type files	November 2020	TR-106 Amendment 10
	cwmp-devicetype-1-4.xsd	Schema updates; document not updated Updated to reference latest published DM Schema version (v1.7)	September 2019	TR-106 Amendment 9

Data Model Report Schema (DMR Schema)	cwmp-datamodel-report-1-0.xsd	Added noUnitsTemplate to suppress “missing {{units}} template” warnings Added previousCommand and previousEvent attributes	June 2023	TR-106 Amendment 12
Data Model Report Schema (DMR Schema)	cwmp-datamodel-report-1-0.xsd	Changed version number to 1-0, which indicates new markdown-friendly wrapped descriptions Added customNumEntriesParameter, noDiscriminatorParameter and noUnionObject to suppress various warnings	January 2022	TR-106 Amendment 11

DM Data Model Definition Schema (DM Schema)	cwmp-datamodel-1-10.xsd	Supported XSD v1.1, which allows more rigorous validation, e.g., use of appropriate attributes when creating and modifying items Added defaults for various attributes, e.g. access, minEntries and maxEntries default to readOnly, 1 and 1 respectively Deprecated the mountType attribute’s none and mountable values, because mountable objects are now determined automatically Made the uniqueKey/functional and the command/async attributes mandatory Relaxed rules governing the order of top-level elements such as import, dataType and component; they can now occur in any order Tightened up the use of dmr: attributes, which can now only be used on elements where they make sense Fixed a few bugs, e.g., added a template element uniqueness check	June 2023	TR-106 Amendment 12
	cwmp-datamodel-1-9.xsd	Allowed the version attribute in component references Allowed minEntries and maxEntries in command and event argument objects Allowed status attribute in profile command/event arguments Added secured attribute	January 2022	TR-106 Amendment 11
	cwmp-datamodel-1-8.xsd	Allowed command attributes, e.g. mandatory, in component definitions	November 2020	TR-106 Amendment 10
	cwmp-datamodel-1-7.xsd	Schema updates; document not updated Supported implementation defaults, version attribute, description templates, writeOnceReadOnly access type and the decimal datatype	September 2019	TR-106 Amendment 9
	cwmp-datamodel-1-6.xsd	Supported USP commands, events and mount points	May 2018	TR-106 Amendment 8

XML Catalog	catalog.xml	Original	May 2018	TR-106 Amendment 8

Support Files

Document	XML	HTML	Description	Date
Data Model Data Types	tr-106-types.xml	Full	Added an Alias component to reduce cut-and-paste in the data models Added an Order type to reduce cut-and-paste in the data models	January 2024
Data Model Data Types	tr-106-types.xml	Full	Schema updates; document not updated 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 more bibrefs	January 2024
Data Model Bibliographic References	tr-069-biblio.xml	Full	Schema updates; document not updated 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 Added references for 3GPP 5G standards in support of Device:2.14 DM Instances	September 2019

The User Services Platform

Device Data Model Files and Documentation

Broadband Forum User Services Platform (USP) Data Models

Introduction

How do I use these?

Current Data Models

Device:2

FAPService:2

StorageService:1

STBService:1

VoiceService:2

Root Data Models

Device:2

Service Data Models

FAPService:2

StorageService:1

STBService:1

VoiceService:2

Schema Files

USP Protocol Buffers Schemas

Device Type Schema (DT Schema)

Data Model Report Schema (DMR Schema)

DM Data Model Definition Schema (DM Schema)

XML Catalog

Support Files

Data Model Data Types

Data Model Bibliographic References

Outdated Corrigenda