TR-181 – Device Data Model

Issue: 2 Amendment 15

Issue Date: January 2022

Table of Contents

List of Figures

  1. CWMP-specific Device:2 Data Model Structure – Overview
  2. USP-specific Device:2 Data Model Structure – Overview
  3. Device:2 Data Model Structure – Device Level
  4. Device:2 Data Model Structure – Common Interface Stack and Networking Technologies
  5. Device:2 Data Model Structure – Common Applications and Protocols
  6. Device:2 Data Model Structure – CWMP Management
  7. Device:2 Data Model Structure – CWMP-specific applications and protocols
  8. Device:2 Data Model Structure – USP Management
  9. Device:2 Data Model Structure – USP-specific applications and protocols
  10. OSI Layers and Interface Objects
  11. Interface LowerLayers
  12. Ignoring a Vendor-specific Interface Object in the Stack
  13. Ignoring a Vendor-specific Interface Object in the Stack (multiple sub-objects)
  14. Simple Router Example (Interfaces Visualized)
  15. Queuing Model of a Device
  16. Tunneling Overview
  17. Tunneling Overview (Showing Forwarding Decisions)
  18. Sample Flow of Upstream Tunneled Traffic through the Device
  19. Sample Flow of Downstream Tunneled Traffic through the Device
  20. General Layer 3 Tunneling Interface Stack
  21. General Layer 3 Tunneling (from Tunneling Overview)
  22. L2TP Interface Stack Example
  23. General Layer 2 Tunneling Interface Stack
  24. Queuing and Scheduling Example for RG
  25. Examples of VLAN configuration based on Bridging and VLAN Termination objects
  26. Bridge 1 model
  27. Bridge 2 model
  28. Bridge 3 model
  29. VLAN Termination model
  30. Bridge 1 model (additional Ethernet interfaces)
  31. Example of VLAN configuration in a 2 box scenario
  32. Bridge 1,2,3 model
  33. WiFi functions within layers
  34. Device User Configuration Backup
  35. Device User Configuration Restore
  36. Relationship of Protocols to Data Model
  37. Internal Relationships of IPv6 Addresses and Prefixes
  38. Example IPv6 RG Configuration
  39. Sample 6rd Routing and Forwarding
  40. Sample DS-Lite Routing and Forwarding
  41. IPsec Data Model Objects
  42. ETSI High Level Functional Architecture
  43. M2M SCL Functional Architecture Framework
  44. M2M REM Service Capability
  45. ETSI M2M Devices and Gateways
  46. Example M2M Network
  47. M2M Device Discovery for Proxy Management
  48. ETSI M2M Data Model Structure
  49. Provider Bridge Scenarios
  50. Provider Bridge Components
  51. Usage of the data model to manage ZigBee devices with TR-069
  52. Example sequence diagram of ZigBee management with TR-069
  53. Example of a PCP Client embedded in the RG using CWMP
  54. Example of a PCP Client embedded in a device using CWMP, with PCP Proxy in the RG
  55. VLAN Traffic over GRE
  56. L2 over GRE Tunnel
  57. IP over IP GRE Encapsulation
  58. L3 over GRE Tunnel
  59. MAP-T Architecture
  60. Sample MAP Routing and Forwarding
  61. Sample MAP Routing and Forwarding (Interface Stack)
  62. PTM Link for DSL mode Line
  63. PTM Link for FAST mode Line
  64. PTM Link Bonding Groups for FAST mode Lines
  65. PTM Link Bonding Groups for DSL mode Lines
  66. Example USB Host Connections
  67. TR-304 Framework
  68. LMAP Framework
  69. CWMP for Pre-configuration
  70. CWMP for Control and Pre-configuration, IPDR for Reporting
  71. CWMP Proxy Device Deployment
  72. CWMP Multi-ACS Deployment
  73. Integration of Bulk Data Profiles with LMAP
  74. 5G Converged Core Network
  75. 5G Architecture
  76. Fixed access only example
  77. Cellular access only example
  78. Hybrid access example
  79. Device.WWC objects
  80. Device.PDU objects
  81. Device.FWE objects

List of Tables

  1. Simple Router Example (InterfaceStack table)
  2. Simple Router Example (Interface LowerLayers)
  3. Default Layer 2/3 QoS Mapping
  4. ProtocolIdentifer URNs
  5. Flow TypeParameters values for flow type urn:dslforum-org:pppoe
  6. Tagged LAN to tagged WAN configuration
  7. Tagged LAN to tagged WAN configuration (VLAN ID translation)
  8. Untagged LAN to tagged WAN configuration
  9. Internally generated to tagged WAN configuration
  10. Configuration to be added to “Tagged LAN to tagged WAN configuration” table
  11. 802.1D (re-)marking
  12. More than one VLAN ID tag admitted on the same Downstream interface
  13. RFC 5969 Configuration Parameter Mapping
  14. FM Object Definition
  15. Mapping LMAP Information Model Parameters to Data Model Parameters
  16. Device.WWC objects
  17. Device.PDU objects
  18. Device.FWE objects

Notice

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband network system development and deployment. This Technical Report has been approved by members of the Forum. This Technical Report is subject to change. This Technical Report is owned and copyrighted by the Broadband Forum, and all rights are reserved. Portions of this Technical Report may be owned and/or copyrighted by Broadband Forum members.

Intellectual Property

Recipients of this Technical Report are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of this Technical Report, or use of any software code normatively referenced in this Technical Report, and to provide supporting documentation.

Terms of Use

1. License

Broadband Forum hereby grants you the right, without charge, on a perpetual, non-exclusive and worldwide basis, to utilize the Technical Report for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, products complying with the Technical Report, in all cases subject to the conditions set forth in this notice and any relevant patent and other intellectual property rights of third parties (which may include members of Broadband Forum). This license grant does not include the right to sublicense, modify or create derivative works based upon the Technical Report except to the extent this Technical Report includes text implementable in computer code, in which case your right under this License to create and modify derivative works is limited to modifying and creating derivative works of such code. For the avoidance of doubt, except as qualified by the preceding sentence, products implementing this Technical Report are not deemed to be derivative works of the Technical Report.

2. NO WARRANTIES

THIS TECHNICAL REPORT IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT AND ANY IMPLIED WARRANTIES ARE EXPRESSLY DISCLAIMED. ANY USE OF THIS TECHNICAL REPORT SHALL BE MADE ENTIRELY AT THE USER’S OR IMPLEMENTER’S OWN RISK, AND NEITHER THE BROADBAND FORUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY USER, IMPLEMENTER, OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS TECHNICAL REPORT, INCLUDING BUT NOT LIMITED TO, ANY CONSEQUENTIAL, SPECIAL, PUNITIVE, INCIDENTAL, AND INDIRECT DAMAGES.

3. THIRD PARTY RIGHTS

Without limiting the generality of Section 2 above, BROADBAND FORUM ASSUMES NO RESPONSIBILITY TO COMPILE, CONFIRM, UPDATE OR MAKE PUBLIC ANY THIRD PARTY ASSERTIONS OF PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS THAT MIGHT NOW OR IN THE FUTURE BE INFRINGED BY AN IMPLEMENTATION OF THE TECHNICAL REPORT IN ITS CURRENT, OR IN ANY FUTURE FORM. IF ANY SUCH RIGHTS ARE DESCRIBED ON THE TECHNICAL REPORT, BROADBAND FORUM TAKES NO POSITION AS TO THE VALIDITY OR INVALIDITY OF SUCH ASSERTIONS, OR THAT ALL SUCH ASSERTIONS THAT HAVE OR MAY BE MADE ARE SO LISTED.

All copies of this Technical Report (or any portion hereof) must include the notices, legends, and other provisions set forth on this page.

Issue History

Issue Number Approval Date Publication Date Issue Editor Changes
Issue 2 May 2010 Paul Sigurdson, Broadband Forum
William Lupton, 2Wire		 Original. Defines version 2.0 of the TR-069 Device data model (Device:2.0).
Issue 2 Amendment 1 November 2010 Paul Sigurdson, Broadband Forum
William Lupton, 2Wire

This update to TR-181 did not update this document; only the XML data model was updated.

Added support for Software Module Management in the data model.

Defines version 2.1 of the TR-069 Device data model (Device:2.1).
Issue 2 Amendment 2 February 2011 Paul Sigurdson, Broadband Forum
William Lupton, Pace

Added support for IPv6 and Firewall in the data model (added IPv6 and Firewall Appendices to this document).

Defines version 2.2 of the TR-069 Device data model (Device:2.2).
Issue 2 Amendment 3 July 2011

This update to TR-181 did not update this document; only the XML data model was updated.

Added support for proxy management and alias-based addressing.
Issue 2 Amendment 4 November 2011 William Lupton, Pace

This update to TR-181 did not update this document; only the XML data model was updated.

Added support for G.hn and Optical interfaces in the data model, and additional WiFi parameters (updated interface stack figures).

Defines version 2.4 of the TR-069 Device data model (Device:2.4).
Issue 2 Amendment 5 May 2012 William Lupton, Pace

Added support for IPsec and bulk data collection in the data model (added Tunneling Annex and IPsec Appendix to this document).

Defines version 2.5 of the TR-069 Device data model (Device:2.5).
Issue 2 Amendment 6 November 2012 18 January 2013 Tim Carey, Alcatel-Lucent

Added support M2M SCL Administration as an Appendix.

Defines version 2.6 of the TR-069 Device data model (Device: 2.6).
Issue 2 Amendment 7 11 November 2013 17 January 2014 Apostolos Papageorgiou, NEC
William Lupton, Cisco

Added ZigBee and Provider Bridge data models (including theory of operation); also added additional WiFi statistics, and other minor changes; added backup/restore theory of operation.

Defines version 2.7 of the TR-069 Device data model (Device: 2.7).
Issue 2 Amendment 8 8 September 2014 15 September 2014 William Lupton, Cisco

Added LLDP and HTIP home network topology discovery parameters, G.997.1-2012 DSL parameters, various WiFi parameters (associated device statistics, retry limits, reports, QoS), IPv6-related IP diagnostics parameters, and other minor changes; updated G.hn data model to align with G.9962; updated Annex B on tunneling, and added GRE and MAP data models (including theory of operation); added PCP data model (including theory of operation); added Cellular interface data model.

Defines version 2.8 of the TR-069 Device data model (Device: 2.8).
Issue 2 Amendment 9 1 December 2014 11 February 2015 Douglas Knisely, Qualcomm, Inc

This update to TR-181 did not update this document; only the XML data model was updated.

Added support forWiFi MAC Address Filtering, fixes for Traceroute, IEEE 1905 data model and incorporated new components from TR-143 Amendment 1
Issue 2 Amendment 10 9 November 2015 13 November 2015 Klaus Wich, Axiros

Added data model updates:

  • MQTT model
  • Bulk data over HTTP
  • DNS Server updates
  • new diagnostics state
Issue 2 Amendment 11 18 July 2016 12 August 2016 Klaus Wich, Axiros
Mark Tabry, Google

Added G.fast data model (including theory of operation).

Data model additions:

  • LED status model
  • Layer 2 tunnel support for IP diagnostics model
  • DSL G.fast model
  • Management Frame Protection support for WiFi model
  • WPS 2.0 support for WiFi model
  • User interface toggle
  • User interface messaging model
  • ConnectionRequest HTTP service toggle
  • DNS fallback support for XMPP connections
Issue 2 Amendment 12 16 March 2018 9 May 2018 Steve Nicolai, Arris

Added Appendix I, II, IV from TR-157a10 as Appendix XVII, XVIII and XIX.

Added Appendix XX BASAPM and LMAP Theory of Operations

Added Annex H from TR-069a5 as Annex C.

Data model additions:

  • Ethernet Link Aggregation
Issue 2 Amendment 13 13 September 2019 13 September 2019 Klaus Wich, Huawei

Unified text for CWMP and USP support, updated references.

Data model additions:

  • IoT data model parameters
  • WFA Data Elements and Multi AP parameters
  • WPA3 and 802.11ax support parameters
  • Support for MQTT5.0, package capture diagnostics.

Defines version 2.13 of the Device data model (Device: 2.13).
Issue 2 Amendment 14 5 November 2020 5 November 2020 David Woolley, Telstra

Added Appendix XXI 5G – Wireline Wireless Convergence and Appendix XXII Data Elements.

Data model additions:

  • Wireline Wireless Convergence support using WWC, PDU and FWE objects
  • TR-471 Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements support
  • Improved Wi-Fi statistics
  • Access control objects for Hosts

Defines version 2.14 of the Device data model (Device: 2.14).
Issue 2 Amendment 15 27 January 2022 27 January 2022 William Lupton, Broadband Forum

Converted the document to markdown and extended the Wi-Fi Theory of Operation.

Data Model additions:

  • Converted the document to markdown and extended the Wi-Fi Theory of Operation
  • Split the XML into multiple smaller files (this is just housekeeping; it doesn’t affect how the model is used)
  • Added Device.USPAgent to the CWMP model to allow a CWMP ACS to configure a device for USP communications
  • 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

Defines version 2.15 of the Device data model (Device: 2.15).

Comments or questions about this Broadband Forum Technical Report should be directed to .

Editors

William Lupton, Broadband Forum

Work Area Director(s)

Jason Walls, QA Cafe
John Blackford, CommScope

Project Stream Leader(s)

Daniel Egger, Axiros
William Lupton, Broadband Forum