Broadband Forum CPE WAN Management Protocol (CWMP) Data Models

The Broadband Forum defines several data models for use with the CPE WAN Management Protocol (TR-069 Amendment 6). These data models contain objects and parameters that describe the many different functions and capabilities available to devices and services that are manageable via CWMP.

CWMP data models are divided into two types: Root and Service. The root data model, Device1, is used to describe the major functions of a network aware device, including interfaces, software/firmware, diagnostics, components common to CWMP and other services, and the basic device information necessary to CWMP.

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, etc.

Each data model is defined by a Name:Version syntax. A device defines its data model by defining a device type, an XML document that maps to (imports) BBF official data model objects and/or vendor specific objects. A full explanation of how to develop compliant CWMP data models can be found in TR-154.

1 Early versions of the CWMP data model defined two root data models, InternetGatewayDevice and Device. Version 2 of the Device root data model (Device:2) deprecates InternetGatewayDevice and Device:1 in favor of a single root data model.

Note: All the files below are directly reachable via: http://www.broadband-forum.org/cwmp/<filename>.

How do I use these?

Use the CWMP data model files to define and implement what exists in your solution's Supported Data Model. This will help the ACS to learn what your CPE is capable of. The data models will also describe how your CPE's Instantiated Data Model will behave during operation.

These data models are the basis for the Broadband Forum's data models for the User Services Platform (USP).

The source files used to build the complete CWMP data model can be found on GitHub.

List of Data Models

Latest Data Models
Data Model Version XML HTML Description Approval Date PDF
Device:2 2.12 tr-181-2-12-0-cwmp-full.xml Full

Added TR-069a6 support

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
FAPService:2 2.1 tr-196-2-1-0-full.xml Full

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)

 August 2015 TR-196 Issue 2
Diff
FAPService:1 1.1 tr-196-1-1-1-full.xml Full

Supported 3GPP releases 9 and 10

Added Alias parameters

 November 2012 TR-196 Amendment 1
Diff
StorageService:1 1.3 tr-140-1-3-0-full.xml Full

Update file system and connection enumerations

Added SMART data model

 May 2017 TR-140 Amendment 3
Diff
STBService:1 1.4 tr-135-1-4-0-full.xml Full

Added objects for Service Monitoring of Events

 August 2015 TR-135 Amendment 3
Diff
VoiceService:2 2.0 tr-104-2-0-0-full.xml Full Original March 2014 TR-104 Issue 2
VoiceService:1 1.1 tr-104-1-1-0-full.xml Full Added Alias parameters July 2011 TR-104
Diff

Root Data Models
Data Model Version XML HTML Description Approval Date PDF
Device:2 2.12 tr-181-2-12-0-cwmp-full.xml Full

Added TR-069a6 support

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
2.11 tr-181-2-11-0-full.xml Full

Added LED status model

Added layer 2 tunnel support to IP diagnostics model

Added DSL G.fast model

Added Management Frame Protection support to WiFi model

Added WPS 2.0 support to WiFi model

Added user interface toggle

Added user interface messaging model

Added ConnectionRequest HTTP service toggle

Resolved lack of DNS fallback support for XMPP connections

 July 2016 TR-181 Issue 2 Amendment 11
Diff
2.10 tr-181-2-10-0-full.xml Full

Added MQTT model

Added DNS Server updates

Added new diagnostics state

Incorporated new components from TR-157 Amendment 10

 November 2015 TR-181 Issue 2 Amendment 10
Diff
2.9 tr-181-2-9-0-full.xml Full

Added WiFi MAC Address Filtering

Added Traceroute fixes

Added IEEE 1905 data model

Incorporated new components from TR-143 Amendment 1

 1 December 2014 TR-181 Issue 2 Amendment 8
Diff
2.8 tr-181-2-8-0-full.xml Full

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

Added PCP data model

 September 2014
Diff
2.7 tr-181-2-7-0-full.xml Full

Added ZigBee data model, Provider Bridge data model, and various other items

Incorporated new components from TR-157 Amendment 8

 November 2013 TR-181 Issue 2 Amendment 7
Diff
2.6 tr-181-2-6-0-full.xml Full Incorporated DNS_SD component from TR-157 Amendment 7 November 2012 TR-181 Issue 2 Amendment 6
Diff
2.5 tr-181-2-5-0-full.xml Full

Added IPsec data model

Incorporated BulkDataCollection component from TR-157 Amendment 6

 May 2012 TR-181 Issue 2 Amendment 5
Diff
2.4 tr-181-2-4-0-full.xml Full

Added G.hn and Optical interfaces, and additional WiFi parameters

Incorporated new components from TR-157 Amendment 5

Incorporated Femto components from TR-262

 November 2011 TR-181 Issue 2 Amendment 2
Diff
2.3 tr-181-2-3-0-full.xml Full

Incorporated new components from TR-157 Amendment 4

Added Alias parameters

 July 2011
Diff
2.2 tr-181-2-2-0-full.xml Full IPv6 and Firewall additions February 2011
Diff
2.1 tr-181-2-1-0-full.xml Full Incorporated new components from TR-157 Amendment 3 November 2010 TR-181 Issue 2
Diff
2.0 tr-181-2-0-3-full.xml Full

May 2010: Original

Nov 2010: Corrigendum 1

  • Fixed various ranges and defaults
  • Removed non interface object Alias parameters from profiles

July 2016: Corrigendum 2

  • Removed SSID unique key from WiFi.SSID object
July 2016
Device:1
[DEPRECATED]		 1.14 tr-181-1-7-0-full.xml Full

Updated Bulk Data Collection for HTTP Transport

 November 2015 TR-181
Diff
1.13 tr-181-1-6-0-full.xml Full Incorporated new components from TR-157 Amendment 9 September 2014
Diff
1.12 tr-181-1-5-0-full.xml Full Incorporated new components from TR-157 Amendment 8 November 2013
Diff
1.11 tr-181-1-4-0-full.xml Full Incorporated DNS_SD component from TR-157 Amendment 7 November 2012
Diff
1.10 tr-181-1-3-0-full.xml Full Incorporated new components from TR-157 Amendment 6 May 2012
Diff
1.9 tr-181-1-2-0-full.xml Full

Incorporated new components from TR-157 Amendment 5

Incorporated Femto components from TR-262

 November 2011
Diff
1.8 tr-181-1-1-0-full.xml Full

Incorporated new components from TR-157 Amendment 4

Added Alias parameters

 July 2011
Diff
1.7 tr-157-1-3-0-full.xml Full Incorporated new components from TR-157 Amendment 3 November 2010 TR-157 Amendment 3
Diff
1.6 tr-157-1-2-0-full.xml Full Incorporated new components from TR-157 Amendment 2 May 2010 TR-157 Amendment 2
Diff
1.5 tr-181-1-0-0-full.xml Full Minor clarifications and additions February 2010 TR-181
Diff
1.4 tr-157-1-1-0-full.xml Full Incorporated new components from TR-157 Amendment 1 September 2009 TR-157 Amendment 1
Diff
1.3 tr-157-1-0-0-full.xml Full Incorporated new components from TR-157 TR-157
Diff
1.2 tr-106-1-2-0-full.xml Full Minor clarifications TR-106 Amendment 2
Diff
tr-143-1-0-2-full.xml Full Incorporated new components from TR-143 May 2010 TR-143 Corrigendum 1
Diff
1.1 tr-106-1-1-0-full.xml Full

Added TR-069 Annex F and G ("TR-111") objects

Many clarifications to parameter descriptions

 September 2009 TR-106 Amendment 1
Diff
1.0 tr-106-1-0-0-full.xml Full Original TR-106
InternetGatewayDevice:1
[DEPRECATED]		 1.14 tr-098-1-8-0-full.xml Full Incorporated new components from TR-157 Amendment 9 September 2014 TR-098 Amendment 2
Diff
1.13 tr-098-1-7-0-full.xml Full Incorporated new components from TR-157 Amendment 8 November 2013
Diff
1.12 tr-098-1-6-0-full.xml Full Incorporated DNS_SD component from TR-157 Amendment 7 November 2012
Diff
1.11 tr-098-1-5-0-full.xml Full Incorporated new components from TR-157 Amendment 6 May 2012
Diff
1.10 tr-098-1-4-0-full.xml Full

Incorporated new components from TR-157 Amendment 5

Incorporated Femto components from TR-262

 November 2011
Diff
1.9 tr-098-1-3-0-full.xml Full

Incorporated new components from TR-157 Amendment 4

Added Alias parameters

 December 2011
Diff
1.8 tr-157-1-3-0-full.xml Full Incorporated new components from TR-157 Amendment 3 November 2010 TR-157 Amendment 3
Diff
1.7 tr-157-1-2-0-full.xml Full Incorporated new components from TR-157 Amendment 2 May 2010 TR-157 Amendment 2
Diff
1.6 tr-157-1-1-0-full.xml Full Incorporated new components from TR-157 Amendment 1 September 2009 TR-157 Amendment 1
Diff
1.5 tr-157-1-0-0-full.xml Full Incorporated new components from TR-157 TR-157
Diff
1.4 tr-098-1-2-1-full.xml Full

Sep 2009: Original

  • Enhanced management of LAN hosts, and addition of DHCP conditional serving capabilities
  • Improvements to management of QoS, routing, and bridging
  • Significant WiFi improvements, including configuration of WMM and U-APSD, and various fixes to the existing WiFi data model
  • PPPoE and NAT management enhancements
  • Enhancements to DSL and Ethernet statistics, including support for VDSL2

Dec 2011: Corrigendum 1

  • Fixed data type for QoS QueueStats Interface
  • Various other minor changes
December 2011 TR-098 Amendment 2
Diff
1.3 tr-143-1-0-2-full.xml Full Incorporated new components from TR-143 May 2010 TR-143 Corrigendum 1
Diff
1.2 tr-098-1-1-0-full.xml Full

Added TR-069 Annex F and G ("TR-111") objects

Many clarifications to parameter descriptions

 September 2009 TR-098 Amendment 1
Diff
1.1 tr-098-1-0-0-full.xml Full Added QoS and Layer2Bridging objects TR-098
Diff
1.0 tr-069-1-0-0-full.xml Full Original TR-069

Service Data Models
Data Model Version XML HTML Description Approval Date PDF
FAPService:2 2.1 tr-196-2-1-0-full.xml Full

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)

 August 2015 TR-196 Issue 2
Diff
2.0 tr-196-2-0-3-full.xml Full

November 2011: Original

November 2012: Corrigendum 1

  • Corrected errors in TR-196i2 per direction of 3GPP TS 32.592.
  • Corrected range of FAPService.{i}.REM.UMTS.GSM.Cell.{i}.CI

February 2015: Corrigendum 2

  • Corrected errors in QHyst1s and QHyst2s parameter descriptions

October 2016: Corrigendum 3

  • Corrected errors in CID and LAC parameter ranges
October 2016
FAPService:1 1.1 tr-196-1-1-1-full.xml Full

Supported 3GPP releases 9 and 10

Added Alias parameters

 November 2012 TR-196 Amendment 1
Diff
1.0 tr-196-1-0-0-full.xml Full Original September 2009 TR-196
StorageService:1 1.3 tr-140-1-3-0-full.xml Full

Update file system and connection enumerations

Added SMART data model

 May 2017 TR-140 Amendment 3
Diff
1.2 tr-140-1-2-0-full.xml Full Added Alias parameters July 2011 TR-140 Amendment 1
Diff
1.1 tr-140-1-1-1-full.xml Full

Apr 2010: Original

  • Added missing NumberOfEntries and Enable parameters

Dec 2011: Corrigendum 1

  • Corrected import of tr-140-1-0.xml
December 2011
Diff
1.0 tr-140-1-0-2-full.xml Full Apr 2010: Corrigendum 2 April 2010 TR-140
STBService:1 1.4 tr-135-1-4-0-full.xml Full

Added objects for Service Monitoring of Events

 August 2015 TR-135 Amendment 3
Diff
1.3 tr-135-1-3-0-full.xml Full Added loss event histograms November 2012
Diff
1.2 tr-135-1-2-0-full.xml Full Added Alias parameters July 2011 TR-135 Amendment 1
Diff
1.1 tr-135-1-1-1-full.xml Full Added CDS, HDMI and S/PDIF objects February 2013
Diff
1.0 tr-135-1-0-0-full.xml Full Original September 2009 TR-135
VoiceService:2 2.0 tr-104-2-0-0-full.xml Full Original March 2014 TR-104 Issue 2
VoiceService:1 1.1 tr-104-1-1-0-full.xml Full Added Alias parameters July 2011 TR-104
Diff
1.0 tr-104-1-0-0-full.xml Full Original September 2009

Component Definitions
Document XML HTML Description Approval Date PDF
Femto Components tr-262-1-0-0.xml Full Original November 2011 TR-262
Component Objects for CWMP tr-157-1-10-0.xml Full

Update Bulk Data Collection for HTTP Transport

 November 2015 TR-157 Amendment 10
tr-157-1-9-0.xml Full

Added Inform Parameters table to ManagementServer

Added HTIP Component to DeviceInfo containing HTIP related parameters

Updated the UPnP component for HTIP parameters

 September 2014 TR-157 Amendment 5
tr-157-1-8-0.xml Full Addition of MS_StandbyPolicy, XMPP and XMPPConnReq components; other minor updates November 2013
tr-157-1-7-0.xml Full Addition of DNS_SD component; other minor updates November 2012
tr-157-1-6-0.xml Full Addition of BulkDataCollection component May 2012
tr-157-1-5-0.xml Full Addition of Location, FaultManagement and Security components November 2011
tr-157-1-4-0.xml Full Support for CWMP Proxy Management and Alias-Based Addressing July 2011 TR-157 Amendment 3
tr-157-1-3-0.xml Full Support for Software Module Management November 2010
tr-157-1-2-0.xml Full Support for TR-181 Issue 2 May 2010 TR-157 Amendment 2
tr-157-1-1-0.xml Full Addition of SupportedDataModel component September 2009 TR-157 Amendment 1
tr-157-1-0-0.xml Full Original TR-157
Network Performance Tests tr-143-1-1-0.xml Full

Added multiple connections to DownloadDiagnostics and UploadDiagnostics

Added time based testing to DownloadDiagnostics and UploadDiagnostics

Added UDPEchoDiagnostics

Added ServerSelectionDiagnostics

Added IPv4 vs IPv6 selection to all tests.

 1 December 2014 TR-143 Amendment 1
tr-143-1-0-2.xml Full

Nov 2008: Original

Mar 2009: Corrigendum 1

  • Changed to use new global bibliography, plus a few editorial changes

May 2010: Corrigendum 2

 May 2010 TR-143 Corrigendum 1

Schema Files
Document Filename Description Approval Date PDF
TR-069 RPCs cwmp-1-4.xsd v1.2 (CWMP v1.4): Added 13 WAKEUP event code, CWMP version negotiation SOAP headers, and lightweight notification attribute values November 2013 TR-069 Amendment 5
cwmp-1-3.xsd v1.2 (CWMP v1.3): Added SessionTimeout SOAP header parameter July 2011 TR-069 Amendment 4
cwmp-1-2.xsd v1.2 (CWMP v1.2): Added software management RPCs November 2010 TR-069 Amendment 3
cwmp-1-1.xsd v1.1 (CWMP v1.1): Added autonomous transfer RPCs November 2007 TR-069 Amendment 2
cwmp-1-0.xsd

v1.0 (CWMP v1.0): Original

Note that the first version of TR-069 did not include a formal XML Schema.

 November 2006 TR-069 Amendment 1
IPDR Service Specification for Bulk Data Collection tr-232-1-0-0-serviceSpec.xsd Original May 2012 TR-232
XMPP Connection Request cwmp-xmppConnReq-1-0.xsd Original November 2013 TR-069 Amendment 5
UDP Lightweight Notification cwmp-UDPLightweightNotification-1-0.xsd Original November 2013 TR-069 Amendment 5
Data Model Definition Schema (DM Schema) cwmp-datamodel-1-6.xsd Supported USP commands, events and mount points March 2018 TR-106 Amendment 8
cwmp-datamodel-1-5.xsd

Added profile/@minVersion attribute

Allowed uniqueKey parameters to be in sub-objects

Added UUID data type

Added nestedBrackets attribute, and allowed use of the list facet in named data type definitions

Several other minor updates and clarifications

 September 2013 TR-106 Amendment 7
cwmp-datamodel-1-4.xsd Added top-level file attribute July 2011 TR-106 Amendment 6
cwmp-datamodel-1-3.xsd

Relaxed some referential constraints (in the light of experience)

Added description/@action prefix option

Added syntax/@command

 November 2010 TR-106 Amendment 5
cwmp-datamodel-1-2.xsd Distinguished functional and non-functional keys; supported #.A relative path syntax March 2010 TR-106 Amendment 4
cwmp-datamodel-1-1.xsd Made import/@file optional; supported range/@step September 2009 TR-106 Amendment 3
cwmp-datamodel-1-0.xsd Original November 2008 TR-106 Amendment 2
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-3.xsd Many minor updates and clarifications September 2013 TR-106 Amendment 7
cwmp-devicetype-1-2.xsd Added top-level UUID data type and attribute November 2012 TR-106 Amendment 6
cwmp-devicetype-1-1.xsd Minor changes tracking DM Schema v1.3 changes November 2010 TR-106 Amendment 5
cwmp-devicetype-1-0.xsd Original September 2009 TR-106 Amendment 3
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-1-1-1-types.xml Full Added DiagnosticsState November 2015  
tr-106-1-0-0-types.xml Full

Nov 2013: Added IEEE_EUI64 and ZigBeeNetworkAddress

Sep 2013: Clarified use of the Alias cpe- prefix

Nov 2012: Added UUID and updated IPPrefix and IPv4Prefix

Nov 2011: Added Dbm1000 and updated statistics counter types

Jul 2011: Added Alias

Nov 2010: Added IPv6 and statistics counter types

May 2010: Added IPPrefix and IPAddress

Sep 2009: Minor changes, e.g. imported tr-069-biblio.xml

Nov 2008: Original

 November 2013
Data Model Bibliographic References tr-069-1-6-0-biblio.xml Full

Mar 2014: Added TR-104i2 references

Nov 2013: Added Device:2.7 and TR-157a8 references

Nov 2012: Added TR-157a7 references

May 2012: Added Device:2.5 references

Dec 2011: Added Device:2.4, FAPService:2.0 and TR-262 references

Jul 2011: Added Alias-based addressing and proxy management references

May 2011: Added FAPService:1.1 references

Mar 2011: Added Device:2.2 references

Nov 2010: Added Device:2.1 references

May 2010: Added Device:2.0 references

Sep 2009: Minor changes, e.g. added missing dates

Mar 2009: Original

 March 2014  
tr-069-1-5-0-biblio.xml Full Added Device:2.11 references July 2016
tr-069-1-4-0-biblio.xml Full Added Device:2.10 references November 2015
tr-069-1-3-0-biblio.xml Full Added TR-196i2a1 references August 2015
tr-069-1-2-0-biblio.xml Full Added Device:2.9 references December 2014
tr-069-1-1-0-biblio.xml Full Added Device:2.8, TR-143a1 and TR-157a9 references September 2014
tr-069-biblio.xml Full

Mar 2014: Added TR-104i2 references

Nov 2013: Added Device:2.7 and TR-157a8 references

Nov 2012: Added TR-157a7 references

May 2012: Added Device:2.5 references

Dec 2011: Added Device:2.4, FAPService:2.0 and TR-262 references

Jul 2011: Added Alias-based addressing and proxy management references

May 2011: Added FAPService:1.1 references

Mar 2011: Added Device:2.2 references

Nov 2010: Added Device:2.1 references

May 2010: Added Device:2.0 references

Sep 2009: Minor changes, e.g. added missing dates

Mar 2009: Original

 March 2014

Outdated Corrigenda
Document XML Description Approval Date PDF
Femto Access Point Service Data Model tr-196-2-0-2.xml

November 2011: Original

November 2012: Corrigendum 1

  • Corrected errors in TR-196i2 per direction of 3GPP TS 32.592.
  • Corrected range of FAPService.{i}.REM.UMTS.GSM.Cell.{i}.CI

February 2015: Corrigendum 2

  • Corrected errors in QHyst1s and QHyst2s parameter descriptions

October 2016: Corrigendum 3

  • Corrected errors in CID and LAC parameter ranges
October 2016 TR-196 Issue 2
tr-196-2-0-1.xml
tr-196-2-0-0.xml
Device Data Model for TR-069 tr-181-2-0-2.xml

May 2010: Original

Nov 2010: Corrigendum 1

  • Fixed various ranges and defaults
  • Removed non interface object Alias parameters from profiles

July 2016: Corrigendum 2

  • Removed SSID unique key from WiFi.SSID object
July 2016 TR-181 Issue 2
tr-181-2-0-1.xml
tr-181-2-0-0.xml
Network Performance Tests tr-143-1-0-1.xml

Nov 2008: Original

Mar 2009: Corrigendum 1

  • Changed to use new global bibliography, plus a few editorial changes

May 2010: Corrigendum 2

 May 2010 TR-143 Corrigendum 1
TR-069 Data Model for Storage Service Enabled Devices tr-140-1-1-0.xml

Apr 2010: Original

  • Added missing NumberOfEntries and Enable parameters

Dec 2011: Corrigendum 1

  • Corrected import of tr-140-1-0.xml
December 2011 TR-140 Amendment 1
Internet Gateway Device Data Model for TR-069 tr-098-1-2-0.xml

Sep 2009: Original

  • Enhanced management of LAN hosts, and addition of DHCP conditional serving capabilities
  • Improvements to management of QoS, routing, and bridging
  • Significant WiFi improvements, including configuration of WMM and U-APSD, and various fixes to the existing WiFi data model
  • PPPoE and NAT management enhancements
  • Enhancements to DSL and Ethernet statistics, including support for VDSL2

Dec 2011: Corrigendum 1

  • Fixed data type for QoS QueueStats Interface
  • Various other minor changes
December 2011 TR-098 Amendment 2