DATA MODEL DEFINITION

TR-181 (changes)

Notice

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband network system development and deployment. This Broadband Forum Document has been approved by members of the Forum. This Broadband Forum Document is not binding on the Broadband Forum, any of its members, or any developer or service provider. This Broadband Forum Document is subject to change, but only with approval of members of the Forum. This Document is copyrighted by the Broadband Forum, and all rights are reserved. Portions of this Document may be copyrighted by Broadband Forum members.

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:

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

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 Types
References
Device:1.5 Data Model (changes)

Data Model Definition

Device.
Device.DeviceInfo.
Device.DeviceInfo.VendorConfigFile.{i}.
Device.ManagementServer.
Device.Time.

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
Time:2 Profile

Data Types

The parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. The complete set of data types, along with the notation used to represent these types, is listed in [Section 3.2/TR-106a4]. The following named data types are used by this specification.

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.

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

[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.

Device:1.5 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.5, then it will indicate support for version 1.5. 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.
Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.
- 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.
Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.
- 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.
Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.
- 1.0

VendorConfigFileNumberOfEntries unsignedInt - The number of entries in the VendorConfigFile table. - 1.5

Device.DeviceInfo.VendorConfigFile.{i}. object - Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File.
This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way.
Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table. If the name of the file (determined as described in the definition of the Name parameter) differs from that of any existing instance, then the CPE MUST create a new instance to represent this file. If instead, the name of the file is identical to that of an existing instance, then the CPE MUST update the content of the existing instance with the new version, date, and (optionally) description of the file.
- 1.5

Name string(64) - Name of the vendor configuration file.
If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name.
Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name.
Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file.
- 1.5

Version string(16) - A string identifying the configuration file version currently used in the CPE.
If the CPE is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value.
Otherwise, the value of this parameter MUST be an empty string.
- 1.5

Date dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 1.5

Description string(256) - A description of the vendor configuration file (human-readable string). - 1.5

Device.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 1.0

EnableCWMP boolean W Enables and disables the CPE's support for CWMP.
false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS.
true means that CWMP support on the CPE is enabled.
The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true.
The factory default value MUST be true.
- 1.5

DefaultActiveNotificationThrottle unsignedInt W This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification.
In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met.
The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection.
The time of the last session completion does not need to be tracked across reboots.
- 1.5

CWMPRetryMinimumWaitInterval unsignedInt[1:65535] W Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2].
A value of 5 corresponds to the default behavior that is described in [TR-069a2].
The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
- 1.5

CWMPRetryIntervalMultiplier unsignedInt[1000:65535] W Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2].
This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.
A value of 2000 corresponds to the default behavior that is described in [TR-069a2].
The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.
- 1.5

Device.Time. object - This object contains parameters relating an NTP or SNTP time client in the CPE. - 1.0

Enable boolean W Enables or disables the NTP or SNTP time client. - 1.5

Status string - Status of Time support on the CPE. Enumeration of:

Disabled
Unsynchronized
Synchronized
Error_FailedToSynchronize
Error (OPTIONAL)
The Unsynchronized value indicates that the CPE's absolute time has not yet been set.
The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate.
The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate.
The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.5

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. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.	-	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. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.	-	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. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.	-	1.0
VendorConfigFileNumberOfEntries	unsignedInt	-	The number of entries in the VendorConfigFile table.	-	1.5
Device.DeviceInfo.VendorConfigFile.{i}.	object	-	Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table. If the name of the file (determined as described in the definition of the Name parameter) differs from that of any existing instance, then the CPE MUST create a new instance to represent this file. If instead, the name of the file is identical to that of an existing instance, then the CPE MUST update the content of the existing instance with the new version, date, and (optionally) description of the file.	-	1.5
Name	string(64)	-	Name of the vendor configuration file. If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name. Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name. Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file.	-	1.5
Version	string(16)	-	A string identifying the configuration file version currently used in the CPE. If the CPE is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value. Otherwise, the value of this parameter MUST be an empty string.	-	1.5
Date	dateTime	-	Date and time when the content of the current version of this vendor configuration file was first applied by the CPE.	-	1.5
Description	string(256)	-	A description of the vendor configuration file (human-readable string).	-	1.5
Device.ManagementServer.	object	-	This object contains parameters relating to the CPE's association with an ACS.	-	1.0
EnableCWMP	boolean	W	Enables and disables the CPE's support for CWMP. false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS. true means that CWMP support on the CPE is enabled. The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true. The factory default value MUST be true.	-	1.5
DefaultActiveNotificationThrottle	unsignedInt	W	This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification. In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met. The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection. The time of the last session completion does not need to be tracked across reboots.	-	1.5
CWMPRetryMinimumWaitInterval	unsignedInt[1:65535]	W	Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2]. A value of 5 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.	-	1.5
CWMPRetryIntervalMultiplier	unsignedInt[1000:65535]	W	Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. A value of 2000 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.	-	1.5
Device.Time.	object	-	This object contains parameters relating an NTP or SNTP time client in the CPE.	-	1.0
Enable	boolean	W	Enables or disables the NTP or SNTP time client.	-	1.5
Status	string	-	Status of Time support on the CPE. Enumeration of: Disabled Unsynchronized Synchronized Error_FailedToSynchronize Error (OPTIONAL) The Unsynchronized value indicates that the CPE's absolute time has not yet been set. The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate. The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate. The Error value MAY be used by the CPE to indicate a locally defined error condition.	-	1.5

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

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.

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.

Time:2 Profile

The Time:2 profile for the Device:1 object is defined as the union of the Time:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:1.5.

Name Requirement

Device.Time. P

Enable W

Status R

Name	Requirement
Device.Time.	P
Enable	W
Status	R

Generated by Broadband Forum report.pl#174 (2010/10/08 version) on 2010/10/21 at 11:47:56.

DATA MODEL DEFINITION

TR-181 (changes)

Notice

Table of Contents