TR-106 – Data Model Template for CWMP Endpoints and USP Agents

Issue: 1 Amendment 10

Issue Date: November 2020

Table of Contents

List of Tables

  1. XML Description Markup
  2. XML Description Templates
  3. XML Named Data Types
  4. XML Data Type Facets
  5. Path Name Scope Definition
  6. PathRef Facet Definition
  7. InstanceRef Facet Definition
  8. EnumerationRef Facet Definition
  9. XML Facet Inheritance Rules
  10. XML Glossary Items
  11. XML Abbreviation Items
  12. XML Bibliographic References
  13. XML Template Elements
  14. XML Component Definition
  15. XML Root and Service Objects
  16. XML Parameter Definition
  17. XML Parameter Syntax
  18. XML Command Definition
  19. XML Command Input / Output Arguments Definition
  20. XML Object Definition
  21. XML Table Definition
  22. XML Profile Definition
  23. XML Parameter Modification
  24. XML Command Modification
  25. XML Event Modification
  26. XML Object Modification
  27. XML Profile Modification
  28. XML Description Modification

List of Figures

  1. CWMP Positioning in the End-to-End Architecture
  2. USP Architecture Overview
  3. Specification Structure

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 1 September 2005 Jeff Bernstein, 2Wire
Christele Bouchat, Alcatel
Tim Spets, Westell
Original
Issue 1 Amendment 1 November 2006 Jeff Bernstein, 2Wire
John Blackford, 2Wire
Mike Digdon, SupportSoft
Heather Kirksey, Motive
William Lupton, 2Wire
Anton Okmianski, Cisco
Clarification of original document
Issue 1 Amendment 2 November 2008 William Lupton, 2Wire
Håkan Westin, Tilgin
Addition of data model definition XML Schema and normative XML common object and component definitions
Issue 1 Amendment 3 September 2009 William Lupton, 2Wire
Håkan Westin, Tilgin
Addition of device type XML Schema
Issue 1 Amendment 4 February 2010 William Lupton, 2Wire
Paul Sigurdson, Broadband Forum
Moved data model definitions to TR-181 Issue 1
Issue 1 Amendment 5 November 2010 Paul Sigurdson, Broadband Forum Replaced definitions of named data types such as IPAddress with references to normative XML.
Minor changes to DM Schema (v1.3) and DT Schema (v1.1).
Issue 1 Amendment 6 July 2011 Sarah Banks, Cisco
Andrea Colmegna, FASTWEB
Tim Spets, Motorola Mobility
Removed definition of proxying, now defined in TR-069.
Removed Common objects.
Alias Parameter Requirements added.
Issue 1 Amendment 7 September 2013 7 October 2013 William Lupton, Cisco Added descriptions of new features in DM Schema (v1.4 & v1.5) and DT Schema (v1.2 & v1.3).
Added Annex defining additional requirements for BBF standard data models.
Issue 1 Amendment 8 16 March 2018 10 May 2018 Jean-Didier Ott, Orange
William Lupton, Broadband Forum
Added support of USP (mountable objects).
Removed references to obsolete data models.
Moved device requirements to TR-069.
Issue 1 Amendment 9 Schema updates; document not updated.
Issue 1 Amendment 10 5 November 2020 5 November 2020 William Lupton, Broadband Forum Converted document to markdown.
Various editorial improvements.

Comments or questions about this Broadband Forum Technical Report should be directed to info@broadband-forum.org.

Editors

William Lupton, Broadband Forum

Broadband User Services Work Area Director(s)

Jason Walls, QA Cafe
John Blackford, CommScope