DATA MODEL DEFINITION |
|
This Broadband Forum Document is provided AS IS, WITH ALL FAULTS. ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM 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 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 Document will be available for license at all or on reasonable and non-discriminatory terms.
ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM 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 DOCUMENT; AND (B) ANY OBLIGATION TO UPDATE OR CORRECT THIS DOCUMENT.
Broadband Forum 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 of this Broadband Forum Document.
| 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. |
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-069a2] | TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, 2007. |
| [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.7, then it will indicate support for version 1.7. The version number associated with each object and parameter is shown in the Version column.
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| InternetGatewayDevice. | object | - | The top-level object for an Internet Gateway Device. | - | 1.0 |
| UserNumberOfEntries | unsignedInt | - | The number of entries in the User table. | - | 1.5 |
| SmartCardReaderNumberOfEntries | unsignedInt | - | The number of entries in the SmartCardReader table. | - | 1.5 |
| InternetGatewayDevice.DeviceInfo. | object | - | This object contains general device information. | - | 1.0 |
| SupportedDataModelNumberOfEntries | unsignedInt | - | The number of entries in the SupportedDataModel table. | - | 1.6 |
| InternetGatewayDevice.DeviceInfo.ProcessStatus. | object | - | Status of the processes on the device. | - | 1.5 |
| ProcessNumberOfEntries | unsignedInt | - | The number of entries in the Process table. Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in [Section 3.2.1/TR-069a2]. |
- | 1.5 |
| InternetGatewayDevice.DeviceInfo.TemperatureStatus. | object | - | Status of the temperature of the device. | - | 1.5 |
| TemperatureSensorNumberOfEntries | unsignedInt | - | The number of entries in the TemperatureSensor table. | - | 1.5 |
| InternetGatewayDevice.ManagementServer. | object | - | This object contains parameters relating to the CPE's association with an ACS. | - | 1.0 |
| InternetGatewayDevice.ManagementServer.AutonomousTransferCompletePolicy. | object | - | This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in [TR-069a2]. The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS. |
- | 1.5 |
| ResultTypeFilter | string | W | Indicates the transfer results that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer results omitted from this list MUST NOT be included when the CPE notifies the ACS. Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download. Enumeration of:
|
- | 1.7 |
| InternetGatewayDevice.UserInterface. | object | - | This object contains parameters relating to the user interface of the CPE. | - | 1.0 |
| InternetGatewayDevice.UserInterface.RemoteAccess. | object | - | This object contains parameters relating to remotely accessing the CPE's user interface. Remote access is defined as any entity not of a local subnet attempting to connect to the CPE. Remote access requires user authentication. To provide remote access authentication the CPE MUST support a "User" table with at least one instance that has "RemoteAccessCapable" set to true. |
- | 1.5 |
| InternetGatewayDevice.UPnP. | object | - | This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. | - | 1.5 |
| InternetGatewayDevice.UPnP.Device. | object | - | This object defines the UPnP devices and UPnP services that are implemented by the CPE. | - | 1.5 |
| UPnPDMBasicMgmt | boolean | W | Enables/Disables UPnP-DM Basic Management. | - | 1.7 |
| UPnPDMConfigurationMgmt | boolean | W | Enables/Disables UPnP-DM Configuration Management. | - | 1.7 |
| UPnPDMSoftwareMgmt | boolean | W | Enables/Disables UPnP-DM Software Management. | - | 1.7 |
| InternetGatewayDevice.UPnP.Device.Capabilities. | object | - | This object defines what UPnP capabilities this device has. | - | 1.5 |
| UPnPArchitecture | unsignedInt | - | Numeric value indicating the major version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 2. A value of 0 indicates no UPnP support. |
- | 1.5 |
| UPnPArchitectureMinorVer | unsignedInt | - | Numeric value indicating the minor version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 0. If UPnPArchitecture is 0 then this parameter SHOULD be ignored. |
- | 1.7 |
| UPnPDMBasicMgmt | unsignedInt | - | Numeric value indicating the supported revision for UPnP-DM Basic Management. A value of 0 indicates no support. |
- | 1.7 |
| UPnPDMConfigurationMgmt | unsignedInt | - | Numeric value indicating the supported revision for UPnP-DM Configuration Management. A value of 0 indicates no support. |
- | 1.7 |
| UPnPDMSoftwareMgmt | unsignedInt | - | Numeric value indicating the supported revision for UPnP-DM Software Management. A value of 0 indicates no support. |
- | 1.7 |
| InternetGatewayDevice.UPnP.Discovery. | object | - | UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services. The CPE MAY, but need not, retain some or all of the information in this object across reboots. |
- | 1.5 |
| RootDeviceNumberOfEntries | unsignedInt | - | The number of entries in the RootDevice table. | - | 1.5 |
| DeviceNumberOfEntries | unsignedInt | - | The number of entries in the Device table. | - | 1.5 |
| ServiceNumberOfEntries | unsignedInt | - | The number of entries in the Service table. | - | 1.5 |
| InternetGatewayDevice.SelfTestDiagnostics. | object | - | This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. | - | 1.5 |
| DiagnosticsState | string | W | Indicates availability of diagnostic data. Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. |
- | 1.5 |
| InternetGatewayDevice.NSLookupDiagnostics. | object | - | This object defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated. |
- | 1.5 |
| DiagnosticsState | string | W | Indicates availability of diagnostic data. Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. |
- | 1.5 |
| ResultNumberOfEntries | unsignedInt | - | The number of entries in the Result table. Total number of Result entries from the most recent invocation of the test. |
- | 1.5 |
| InternetGatewayDevice.NSLookupDiagnostics.Result.{i}. | object | - | Results from the most recent invocation of the test, one instance per repetition. | - | 1.5 |
| Status | string | - | Result Parameter to represent whether the NS Lookup was successful or not. Errors for individual Result instances do not get bubbled up to DiagnosticsState. A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that DiagnosticsState SHOULD be Error_Other. Enumeration of:
|
- | 1.5 |
| InternetGatewayDevice.USBHosts. | object | - | This object models the CPE's USB Host controllers. See [Appendix I/TR-157] for Theory of Operation. |
- | 1.5 |
| HostNumberOfEntries | unsignedInt | - | The number of entries in the Host table. | - | 1.5 |
| InternetGatewayDevice.USBHosts.Host.{i}. | object | - | Table of CPE USB Host controllers.
At most one entry in this table can exist with a given value for Name. |
- | 1.5 |
| DeviceNumberOfEntries | unsignedInt | - | The number of entries in the Device table. | - | 1.5 |
| InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}. | object | - | Table of connected USB devices.
At most one entry in this table can exist with a given value for DeviceNumber. |
- | 1.5 |
| Parent | string | - | The value MUST be the path name of a row in the Device table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the parent USB device (e.g. hub device). This is an empty string for a device connected to the Host controller (root hub). |
- | 1.5 |
| ConfigurationNumberOfEntries | unsignedInt | - | The number of entries in the Configuration table. | - | 1.5 |
| InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}.Configuration.{i}. | object | - | Table of device configurations.
At most one entry in this table can exist with a given value for ConfigurationNumber. |
- | 1.5 |
| InterfaceNumberOfEntries | unsignedInt | - | The number of entries in the Interface table. | - | 1.5 |
| InternetGatewayDevice.PeriodicStatistics. | object | - | This object configures collection of periodic statistics for the device. Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples. This object provides a single set of global settings that affect the entire device unless overridden locally. |
- | 1.5 |
| SampleSetNumberOfEntries | unsignedInt | - | The number of entries in the SampleSet table. | - | 1.5 |
| InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}. | object | W | Periodic statistics sample set table. Each sample set has its own sample interval etc.
At most one enabled entry in this table can exist with a given value for Name. |
- | 1.5 |
| ParameterNumberOfEntries | unsignedInt | - | The number of entries in the Parameter table. | 0 | 1.5 |
| InternetGatewayDevice.DownloadAvailability. | object | - | This object contains multicast announcement and query parameters used for the purpose of downloading files. | - | 1.5 |
| InternetGatewayDevice.DownloadAvailability.Announcement. | object | - | This object contains multicast announcement parameters used to download files. | - | 1.5 |
| GroupNumberOfEntries | unsignedInt | - | The number of entries in the Group table. | - | 1.5 |
| 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. |