DATA MODEL DEFINITION

TR-106 Amendment 2 (changes)

Notice

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:

• OF ACCURACY, COMPLETENESS, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE;
• THAT THE CONTENTS OF THIS BROADBAND FORUM XML DOCUMENT ARE SUITABLE FOR ANY PURPOSE, EVEN IF THAT PURPOSE IS KNOWN TO THE COPYRIGHT HOLDER;
• THAT THE IMPLEMENTATION OF THE CONTENTS OF THE DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

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.

Table of Contents

• Data Types
• References
• Device:1.2 Data Model (changes)
• Data Model Definition
• Device.
• Device.DeviceInfo.
• Device.ManagementServer.
• Device.Config.
• Device.UserInterface.
• Device.LAN.
• Device.LAN.DHCPOption.{i}.
• Device.LAN.Stats.
• Device.DownloadDiagnostics.
• Inform and Notification Requirements
• Forced Inform Parameters
• Forced Active Notification Parameters
• Default Active Notification Parameters
• Parameters for which Active Notification MAY be Denied
• Profile Definitions
• Notation

Data Types

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: 1080:0:0:800:ba98:3210:11aa:12dd 1080::800:ba98:3210:11aa:12dd 0:0:0:0:0:0:13.1.68.3 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.

References

Device:1.2 Data Model (changes)

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.2, then it will indicate support for version 1.2. 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
Device.DeviceInfo.	object	-	This object contains general device information.	-	1.0
ManufacturerOUI	string­(6)	-	Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates.	-	1.0
ProductClass	string­(64)	-	Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates.	-	1.0
SerialNumber	string­(64)	-	Serial number of the CPE. This value MUST remain fixed over the lifetime of the device, including across firmware updates.	-	1.0
EnabledOptions	string­(1024)	-	Comma-separated list (maximum length 1024) of strings. Comma-separated list of the OptionName of each Option that is currently enabled in the CPE. The OptionName of each is identical to the OptionName element of the OptionStruct described in [TR-069a2]. Only those options are listed whose State indicates the option is enabled.	-	1.0
AdditionalHardwareVersion	string­(64)	-	Comma-separated list (maximum length 64) of strings. A comma-separated list of any additional versions. Represents any additional hardware version information the vendor might wish to supply.	-	1.0
AdditionalSoftwareVersion	string­(64)	-	Comma-separated list (maximum length 64) of strings. A comma-separated list of any additional versions. Represents any additional software version information the vendor might wish to supply.	-	1.0
Device.ManagementServer.	object	-	This object contains parameters relating to the CPE's association with an ACS.	-	1.0
PeriodicInformTime	dateTime	W	An absolute time reference in UTC to determine when the CPE will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the PeriodicInformInterval. PeriodicInformTime is used only to set the phase of the periodic Informs. The actual value of PeriodicInformTime can be arbitrarily far into the past or future. For example, if PeriodicInformInterval is 86400 (a day) and if PeriodicInformTime is set to UTC midnight on some day (in the past, present, or future) then periodic Informs will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicInformTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval. If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the PeriodicInformTime parameter was set to the Unknown Time value.	-	1.0
UDPConnectionRequestAddress	string­(256)	-	Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069a2]). This parameter is represented in the form of an Authority element as defined in [RFC3986]. The value MUST be in one of the following two forms: host:port host When STUNEnable is true, the host and port portions of this parameter MUST represent the public address and port corresponding to the NAT binding through which the ACS can send UDP Connection Request messages (once this information is learned by the CPE through the use of STUN). When STUNEnable is false, the host and port portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages. The second form of this parameter MAY be used only if the port value is equal to 80.	-	1.1
Device.Config.	object	-	This object contains general configuration parameters.	-	1.0
ConfigFile	string­(32768)	W	A dump of the currently running configuration on the CPE. This parameter enables the ability to backup and restore the last known good state of the CPE. It returns a vendor-specific document that defines the state of the CPE. The document MUST be capable of restoring the CPE's state when written back to the CPE using SetParameterValues. An alternative to this parameter, e.g. when the configuration file is larger than the parameter size limit, is to use the Upload and Download RPCs with a FileType of 1 Vendor Configuration File.	-	1.0
Device.UserInterface.	object	-	This object contains parameters relating to the user interface of the CPE.	-	1.0
AutoUpdateServer	string­(256)	W	The server the CPE can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true.	-	1.0
UserUpdateServer	string­(256)	W	The server where a user can check via a web browser if an update is available for download to a PC. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true.	-	1.0
Device.LAN.	object	-	This object contains parameters relating to IP-based LAN connectivity of a device. This object relates only to IP-layer LAN capabilities. Lower-layer aspects of LAN connectivity are not considered part of the common data model defined in this specification. For a device that contains multiple IP interfaces, the scope of this object is limited to the default IP interface. Data that might be associated with other interfaces is not considered part of the common data model defined in this specification.	-	1.0
MACAddressOverride	boolean	W	Whether the value of MACAddress parameter can be overridden. When true, MACAddress is writable. When false, MACAddress is not writable, and the default MAC address assigned by the device SHOULD be restored.	-	1.0
Device.LAN.DHCPOption.{i}.	object	W	This object is for configuration of DHCP options. Each instance of this object represents a DHCP option to be included by the DHCP client in client requests. The DHCP client MAY include any other options not specified in this table.	-	1.0
Value	base64­(255)	W	Base64 encoded octet string to be used as the Value of the DHCP option if Request is false.	<Empty>	1.0
Device.LAN.Stats.	object	-	This object contains statistics for the default IP interface.	-	1.0
CurrentDayInterval	unsignedInt	-	Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The device MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but does not need to do so.	-	1.0
QuarterHourInterval	unsignedInt	-	Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The device MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but does not need to do so.	-	1.0
Device.DownloadDiagnostics.	object	-	This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device.	-	1.2
DiagnosticsState	string	W	Indicate the availability of diagnostic data. Enumeration of: None Requested Completed Error_InitConnectionFailed Error_NoResponse Error_TransferFailed Error_PasswordRequestFailed Error_LoginFailed Error_NoTransferMode Error_NoPASV Error_IncorrectSize Error_Timeout 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 Completed (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Completed, 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.2

Inform and Notification Requirements

Forced Inform Parameters

Forced Active Notification Parameters

Default Active Notification Parameters

Parameters for which Active Notification MAY be Denied

Profile Definitions

Notation

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.