DATA MODEL DEFINITION |
|
This Broadband Forum XML Document is provided AS IS, WITH ALL FAULTS. ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM XML DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW ANY REPRESENTATION OR WARRANTY, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY:
By using this Broadband Forum XML Document, users acknowledge that implementation may require licenses to patents. The Broadband Forum encourages but does not require its members to identify such patents. For a list of declarations made by Broadband Forum member companies, please see http://www.broadband-forum.org. No assurance is given that licenses to patents necessary to implement this XML Document will be available for license at all or on reasonable and non-discriminatory terms.
ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM XML DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW (A) ANY LIABILITY (INCLUDING DIRECT, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES UNDER ANY LEGAL THEORY) ARISING FROM OR RELATED TO THE USE OF OR RELIANCE UPON THIS XML DOCUMENT; AND (B) ANY OBLIGATION TO UPDATE OR CORRECT THIS XML DOCUMENT.
Broadband Forum XML Documents may be copied, downloaded, stored on a server or otherwise re-distributed in their entirety only, and may not be modified without the advance written permission of the Broadband Forum.
The text of this notice must be included in all copies.
| Data Type | Base Type | Description |
|---|---|---|
| IPAddress | string | All IPv4 addresses and subnet masks are represented as strings in IPv4 dotted-decimal notation. All IPv6 addresses MUST be represented using any of the 3 standard textual representations as defined in [RFC3513] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used. Use of the lower-case letters is RECOMMENDED. Examples of valid IPv6 address textual representations:
Unspecified or inapplicable IP addresses and subnet masks MUST be represented as empty strings unless otherwise specified by the parameter definition. |
| IPPrefix | string | IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation [RFC4632]. This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. IPv4 example: 192.168.1.0/24 IPv6 example: 2001:edff:fe6a:f76::/64 Unspecified or inapplicable IP prefixes MUST be represented as empty strings unless otherwise specified by the parameter definition. |
| IPv4Address | string | IPv4 addresses and subnet masks are represented as strings in IPv4 dotted-decimal notation. Unspecified or inapplicable IP addresses and subnet masks MUST be represented as empty strings unless otherwise specified by the parameter definition. |
| MACAddress | string | All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. |
| [RFC3986] | RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-106a3] | TR-106 Amendment 3, Data Model Template for TR-069 Enabled Devices, Broadband Forum, September 2009. |
| [TR-106a4] | TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2010. |
For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 1.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| Device. | object | - | The top-level object for a Device. | - | 1.0 |
| DeviceSummary | string(1024) | - | See [Section 3.7/TR-106]. This parameter is DEPRECATED because DeviceInfo.SupportedDataModel and associated Device Type XML documents (DT Instances) provide a more granular and scalable way of describing the device's data model. Therefore its value MAY be an empty string if (and only if) DeviceInfo.SupportedDataModel is supported. |
- | 1.0 |
| Device.DeviceInfo. | object | - | This object contains general device information. | - | 1.0 |
| SupportedDataModelNumberOfEntries | unsignedInt | - | Number of entries in the SupportedDataModel table. | - | 1.4 |
| Device.DeviceInfo.SupportedDataModel.{i}. | object | - | 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. |
- | 1.4 |
| URL | string(256) | - | 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. |
- | 1.4 |
| URN | string(256) | - | 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. |
- | 1.4 |
| Features | 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. |
- | 1.4 |
| Parameter |
|---|
| Device.DeviceSummary |
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| Abbreviation | Description |
|---|---|
| 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 via AddObject and DeleteObject is REQUIRED. |
| A | Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED. |
| D | Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED. |
| Name | Requirement |
|---|---|
| Device.DeviceInfo. | P |
| SupportedDataModelNumberOfEntries | R |
| Device.DeviceInfo.SupportedDataModel.{i}. | P |
| URL | R |
| URN | R |
| Features | R |