Broadband Forum

TR-069 Device:1.5 Root Object definition
tr-181-1-0-0.xml (changes)

DATA MODEL DEFINITION

License

Copyright (c) 2010-2017, Broadband Forum

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 Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.

Legend

Object definition.
Mountable Object definition.
Mount Point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

Device:1.5 Data Model ​(changes)

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent 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 Syntax Write Description Object Default Version Spec
Device. object object​[1:1] - The top-level object for a Device. - 1.0 TR-106
Device.​DeviceInfo. object object​[1:1] - This object contains general device information. - 1.0 TR-106
ManufacturerOUI string​(6) 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 TR-106
TR-106a2
TR-181
ProductClass string​(64) 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 TR-106
TR-106a2
TR-181
SerialNumber string​(64) 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 TR-106
TR-106a2
TR-181
VendorConfigFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorConfigFile table. - 1.0 TR-181
Device.​DeviceInfo.​VendorConfigFile.​{i}. object​[0:] object​[0:∞] -

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.0 TR-181
Name string​(64) 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.0 TR-181
Version string​(16) 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.0 TR-181
Date dateTime dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 1.0 TR-181
Description string​(256) string​(256) - A description of the vendor configuration file (human-readable string). - 1.0 TR-181
Device.​ManagementServer. object object​[1:1] - This object contains parameters relating to the CPE's association with an ACS. - 1.0 TR-106
EnableCWMP boolean 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.0 TR-181
DefaultActiveNotificationThrottle unsignedInt 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.0 TR-181
CWMPRetryMinimumWaitInterval unsignedInt​(1:65535) 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.0 TR-181
CWMPRetryIntervalMultiplier unsignedInt​(1000:65535) 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.0 TR-181
Device.​Time. object object​[1:1] - This object contains parameters relating an NTP or SNTP time client in the CPE. - 1.0 TR-106
TR-106a1
Enable boolean boolean W Enables or disables the NTP or SNTP time client. - 1.0 TR-181
Status string string -

Status of Time support on the CPE. Enumeration of:

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.0 TR-181

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 is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

Time:2 Profile

The Time:2 profile for the Device:1 data model 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


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 17:02:23 (INTERIM VERSION).
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-1-0-0-diffs.html tr-181-1-0-0.xml