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.
|Data Type||Base Type||Description|
|[SOAP1.1]||Simple Object Access Protocol (SOAP) 1.1, W3C.|
|[TR-106a7]||TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.|
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.14, then it will indicate support for version 1.14. The version number associated with each object and parameter is shown in the Version column.
|InternetGatewayDevice.||object||-||The top-level object for an Internet Gateway Device.||-||1.0|
|InternetGatewayDevice.DeviceInfo.||object||-||This object contains general device information.||-||1.0|
Comma-separated list of strings. Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.
Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.
The model number of the device (human readable string), or an empty string if no model number is provided by the device.
|InternetGatewayDevice.ManagementServer.||object||-||This object contains parameters relating to the CPE's association with an ACS.||-||1.0|
|InformParameterNumberOfEntries||unsignedInt||-||The number of entries in the InformParameter table.||-||1.14|
This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.
This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.
At most one enabled entry in this table can exist with a given value for ParameterName.
|Enable||boolean||W||Enables or disables this InformParameter.||false||1.14|
A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.
A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE.
If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.
Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC.
All Inform Events (see [Section 184.108.40.206/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069].
An empty string means all events except "4 VALUE CHANGE".
|InternetGatewayDevice.UPnP.||object||-||This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters.||-||1.5|
|InternetGatewayDevice.UPnP.Description.||object||-||This object contains information from the Description Document discovered from the UPnP Devices and Services.||-||1.12|
This table contains the information from Device Description Document retrieved for a discovered UPnP root or embedded device.
At most one entry in this table can exist with a given value for UDN.
Comma-separated list of strings. Each list item is the value of an element in the Device Description Document for this DeviceInstance that indicates a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.
Note: It is assumed that the htip:X_DeviceCategory Device Description Document element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.
Note: DeviceCategory is different from DeviceType and is included here for the purpose of HTIP usage.
The value of an element in the Device Description Document for this DeviceInstance that indicates the manufacturer OUI if this value is provided by the device; or an empty string if this value is not provided by the device.
|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.|