Component objects for CWMP: TR-069 Device:1.4 and
DATA MODEL DEFINITION
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.
|Data Type||Base Type||Description|
|string||-||For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.|
Unsigned integer in the range 0 to 4294967295, inclusive.
For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.
|[802.1D-2004]||IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.|
|[802.1Q-2005]||IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.|
|[BLUE]||Blue, A New Class of Active Queue Management Algorithms.|
|[DLNA-NDIG]||DLNA Networked Device Interoperability Guidelines, DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles., DLNA, October 2006.|
|[DVB-TS.102.824]||TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.|
|[HTML4.01]||HTML 4.01 Specification, W3C.|
|[ICSA-Firewall]||ICSA Modular Firewall Certification Criteria, Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0, ICSA Labs.|
|[ISO-13818-6:1998]||ISO/IEC 13818-6:1998, Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC, ISO, 1998.|
|[OUI]||Organizationally Unique Identifiers (OUIs).|
|[RED]||References on RED (Random Early Detection) Queue Management.|
|[RFC793]||RFC 793, Transmission Control Protocol, IETF, September 1981.|
|[RFC862]||RFC 862, Echo Protocol, IETF, 1983.|
|[RFC959]||RFC 959, File Transfer Protocol, IETF, 1985.|
|[RFC1323]||RFC 1323, TCP Extensions for High Performance, IETF, May 1992.|
|[RFC2131]||RFC 2131, Dynamic Host Configuration Protocol, IETF.|
|[RFC2132]||RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.|
|[RFC2225]||RFC 2225, Classical IP and ARP over ATM, IETF.|
|[RFC2474]||RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.|
|[RFC2516]||RFC 2516, A Method for Transmitting PPP Over Ethernet (PPPoE), IETF.|
|[RFC2581]||RFC 2581, TCP Congestion Control, IETF, April 1999.|
|[RFC2582]||RFC 2582, The NewReno Modification to TCP's Fast Recovery Algorithm, IETF, April 1999.|
|[RFC2616]||RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.|
|[RFC2634]||RFC 2634, Enhanced Security Services for S/MIME, IETF.|
|[RFC2662]||RFC 2662, Definitions of Managed Objects for the ADSL Lines, IETF.|
|[RFC2684]||RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, IETF.|
|[RFC2697]||RFC 2697, A Single Rate Three Color Marker, IETF.|
|[RFC2698]||RFC 2698, A Two Rate Three Color Marker, IETF.|
|[RFC2818]||RFC 2818, HTTP Over TLS, IETF, May 2000.|
|[RFC2898]||RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.|
|[RFC2974]||RFC 2974, Session Announcement Protocol, IETF, October 2000.|
|[RFC3004]||RFC 3004, The User Class Option for DHCP, IETF.|
|[RFC3066]||RFC 3066, Tags for the Identification of Languages, IETF.|
|[RFC3489]||RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.|
|[RFC3925]||RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF.|
|[RFC3926]||RFC 3926, FLUTE - File Delivery over Unidirectional Transport, IETF, October 2004.|
|[RFC3986]||RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.|
|[RFC4122]||RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.|
|[SOAP1.1]||Simple Object Access Protocol (SOAP) 1.1, W3C.|
|[TR-069]||TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.|
|[TR-069a1]||TR-069 Amendment 1, CPE WAN Management Protocol, Broadband Forum, December 2006.|
|[TR-069a2]||TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.|
|[TR-098]||TR-098 Amendment 2 Corrigendum 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2014.|
|[TR-098a1]||TR-098 Amendment 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2006.|
|[TR-098a2]||TR-098 Amendment 2, Internet Gateway Device Data Model for TR-069, Broadband Forum, September 2008.|
|[TR-106]||TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.|
|[TR-106a1]||TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2006.|
|[TR-106a2]||TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.|
|[TR-106a3]||TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2009.|
|[TR-143]||TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.|
|[TR-157]||TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.|
|[UPnP-DAv1]||UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.|
|[USB1.0]||USB 1.0, USB 1.0 Specification, USB-IF, January 1996.|
|[USB2.0]||USB 2.0, USB 2.0 Specification, USB-IF, April 2000.|
|[USB3.0]||USB 3.0, USB 3.0 Specification, USB-IF, November 2008.|
|[WPSv1.0]||Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.|
|Mountable Object definition.|
|Mount Point definition.|
|Command or Event definition.|
|Command Input / Output Arguments container.|
|Command or Event Object Input / Output Argument definition.|
|Command or Event Parameter Input / Output Argument definition.|
For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.1, then it will indicate support for version 1.1. The version number associated with each object and parameter is shown in the Version column.
|SupportedDataModelNumberOfEntries||unsignedInt||unsignedInt||-||Number of entries in the SupportedDataModel table.||-||1.0||TR-157a1|
This table contains details of the device's Current Supported Data Model.
The table MUST describe the device's entire Supported Data Model. Therefore, if a device's Supported Data Model changes at run-time, entries will need to be added or removed as appropriate.
Each table entry MUST refer to only a single Root Object or Service Object. The device MAY choose to use more than one table entry for a given Root Object or Service Object.
Considering that every device has some form of a data model, this table MUST NOT be empty.
At most one entry in this table can exist with a given value for URL.
URL ([RFC3986]) that describes some or all of the device's Current Supported Data Model.
The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model.
The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in [Annex B/TR-106a3], including any additional normative requirements referenced within the Schema.
The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that, if the same XML file is to be used for multiple CPE, this strongly suggests that the XML file referenced by this URL should never change.
The URL MAY permit the XML file to be accessed at run-time, in which case, the XML file MAY be located within the CPE.
Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.
URN ([RFC3986]) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry.
For example, if this table entry references a DT Instance that refers to the Device:1.3 Root Object, the value of this parameter would be urn:broadband-forum-org:tr-157-1-0-0, because TR-157 defines Device:1.3. If the DT Instance instead referred to a vendor-specific Root Object, e.g. X_EXAMPLE_Device:1.0 (derived from Device:1.3), the value of this parameter would be something like urn:example-com:device-1-0-0.
|Features||string||list of string||-||
Comma-separated list of strings. This parameter MUST list exactly the features that are defined using the top-level feature element in the DT Instance referenced by URL.
For example, if the DT instance specified the following:
then the value of this parameter might be DNSServer,Router,X_MyDeviceFeature. The order in which the features are listed is not significant.
|R||Read support is REQUIRED.|
|W||Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.|
|P||The object is REQUIRED to be present.|
|C||Creation and deletion of instances of the object is REQUIRED.|
|A||Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.|
|D||Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.|