Broadband Forum

TR-069 Device:1.0 Root Object definition
tr-106-1-0-0.xml

DATA MODEL DEFINITION

License

Copyright (c) 2008-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.
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.

IPAddress string(45)

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some 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

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

MACAddress string(17)

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. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])

References

[OUI] Organizationally Unique Identifiers (OUIs).
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.

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.0 Data Model

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
DeviceSummary string​(1024) string​(1024) - See [Section 3.7/TR-106]. - 1.0 TR-106
Device.​Services. object object​[1:1] - This object contains general services information. - 1.0 TR-106
Device.​DeviceInfo. object object​[1:1] - This object contains general device information. - 1.0 TR-106
Manufacturer string​(64) string​(64) - The manufacturer of the CPE (human readable string). - 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]. - 1.0 TR-106
ModelName string​(64) string​(64) - Model name of the CPE (human readable string). - 1.0 TR-106
Description string​(256) string​(256) - A full description of the CPE device (human readable string). - 1.0 TR-106
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. - 1.0 TR-106
SerialNumber string​(64) string​(64) - Serial number of the CPE. - 1.0 TR-106
HardwareVersion string​(64) string​(64) - A string identifying the particular CPE model and version. - 1.0 TR-106
SoftwareVersion string​(64) string​(64) -

A string identifying the software version currently installed in the CPE.

To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.

- 1.0 TR-106
EnabledOptions string​(1024)​[] list​(1024) of string - Comma-separated list (maximum number of characters 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-069]. Only those options are listed whose State indicates the option is enabled. - 1.0 TR-106
AdditionalHardwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. A comma separated list of any additional versions. Represents any additional hardware version information the vendor may wish to supply. - 1.0 TR-106
AdditionalSoftwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. A comma separated list of any additional versions. Represents any additional software version information the vendor may wish to supply. - 1.0 TR-106
ProvisioningCode string​(64) string​(64) W Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. - 1.0 TR-106
DeviceStatus string string -

Current operational status of the device. Enumeration of:

- 1.0 TR-106
UpTime unsignedInt unsignedInt - Time in seconds since the CPE was last restarted. - 1.0 TR-106
FirstUseDate dateTime dateTime - Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset. - 1.0 TR-106
DeviceLog string​(32768) string​(32768) - Vendor-specific log(s). - 1.0 TR-106
Device.​ManagementServer. object object​[1:1] - This object contains parameters relating to the CPE's association with an ACS. - 1.0 TR-106
URL string​(256) string​(256) W

URL for the CPE to connect to the ACS using the CPE WAN Management Protocol.

This parameter MUST be in the form of a valid HTTP or HTTPS URL.

The host portion of this URL is used by the CPE for validating the ACS certificate when using SSL or TLS.

- 1.0 TR-106
Username string​(256) string​(256) W

Username used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This username is used only for HTTP-based authentication of the CPE.

- 1.0 TR-106
Password string​(256) string​(256) W

Password used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol.

This password is used only for HTTP-based authentication of the CPE.

When read, this parameter returns an empty string, regardless of the actual value.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0 TR-106
PeriodicInformEnable boolean boolean W Whether or not the CPE must periodically send CPE information to the ACS using the Inform method call. - 1.0 TR-106
PeriodicInformInterval unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true. - 1.0 TR-106
PeriodicInformTime dateTime dateTime W

An absolute time reference in UTC to determine when the CPE should initiate the Inform method calls. Each Inform call must occur at this reference time plus or minus an integer multiple of the PeriodicInformInterval.

A zero dateTime value (0000-00-00T00:00:00) indicates that no particular time reference is specified. That is, the CPE may locally choose the time reference, required only to adhere to the specified PeriodicInformInterval.

- 1.0 TR-106
ParameterKey string​(32) string​(32) -

ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS.

The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified.

The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string.

- 1.0 TR-106
ConnectionRequestURL string​(256) string​(256) -

HTTP URL for an ACS to make a Connection Request notification to the CPE.

In the form:

http://host:port/path

The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.

- 1.0 TR-106
ConnectionRequestUsername string​(256) string​(256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 1.0 TR-106
ConnectionRequestPassword string​(256) string​(256) W

Password used to authenticate an ACS making a Connection Request to the CPE.

When read, this parameter returns an empty string, regardless of the actual value.

When read, this parameter returns an empty string, regardless of the actual value.

- 1.0 TR-106
UpgradesManaged boolean boolean W Indicates whether or not the ACS will manage upgrades for the CPE. If true, the CPE SHOULD not use other means other than the ACS to seek out available upgrades. If false, the CPE MAY use other means for this purpose. - 1.0 TR-106
KickURL string​(256) string​(256) -

Present only for a CPE that supports the Kicked RPC method.

LAN-accessible URL from which the CPE can be kicked to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE.

- 1.0 TR-106
DownloadProgressURL string​(256) string​(256) -

Present only for a CPE that provides a LAN-side web page to show progress during a file download.

LAN-accessible URL to which a web-server associated with the ACS may redirect a user's browser on initiation of a file download to observer the status of the download.

- 1.0 TR-106
Device.​GatewayInfo. object object​[1:1] - This object contains information associated with a connected Internet Gateway Device. - 1.0 TR-106
ManufacturerOUI string​(6) string​(6) - Organizationally unique identifier of the associated Internet Gateway Device. An empty string indicates that there is no associated Internet Gateway Device that has been detected. - 1.0 TR-106
ProductClass string​(64) string​(64) - Identifier of the product class of the associated Internet Gateway Device. An empty string indicates either that there is no associated Internet Gateway Device that has been detected, or the Internet Gateway Device does not support the use of the product-class parameter. - 1.0 TR-106
SerialNumber string​(64) string​(64) - Serial number of the associated Internet Gateway Device. An empty string indicates that there is no associated Internet Gateway Device that has been detected. - 1.0 TR-106
Device.​Config. object object​[1:1] - This object contains general configuration parameters. - 1.0 TR-106
PersistentData string​(256) string​(256) W Arbitrary user data that must persist across CPE reboots. - 1.0 TR-106
ConfigFile string​(32768) 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. - 1.0 TR-106
Device.​Time. object object​[1:1] - This object contains parameters relating an NTP or SNTP time client in the CPE. Support for this object is Optional. - 1.0 TR-106
NTPServer1 string​(64) string​(64) W First NTP timeserver. Either a host name or IP address. - 1.0 TR-106
NTPServer2 string​(64) string​(64) W Second NTP timeserver. Either a host name or IP address. - 1.0 TR-106
NTPServer3 string​(64) string​(64) W Third NTP timeserver. Either a host name or IP address. - 1.0 TR-106
NTPServer4 string​(64) string​(64) W Fourth NTP timeserver. Either a host name or IP address. - 1.0 TR-106
NTPServer5 string​(64) string​(64) W Fifth NTP timeserver. Either a host name or IP address. - 1.0 TR-106
CurrentLocalTime dateTime dateTime - The current date and time in the CPE's local time zone. - 1.0 TR-106
LocalTimeZone string​(256) string​(256) W

The local time zone definition, encoded according to IEEE 1003.1 (POSIX). The following is an example value:

EST+5 EDT,M4.1.0/2,M10.5.0/2
- 1.0 TR-106
Device.​UserInterface. object object​[1:1] - This object contains parameters relating to the user interface of the CPE. Support for this object is Optional. - 1.0 TR-106
PasswordRequired boolean boolean W

Present only if the CPE provides a password-protected LAN-side user interface.

Indicates whether or not the local user interface must require a password to be chosen by the user. If false, the choice of whether or not a password is used is left to the user.

- 1.0 TR-106
PasswordUserSelectable boolean boolean W

Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.

Indicates whether or not a password to protect the local user interface of the CPE may be selected by the user directly, or must be equal to the password used by the LAN-side Auto-Configuration protocol.

- 1.0 TR-106
UpgradeAvailable boolean boolean W Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user. - 1.0 TR-106
WarrantyDate dateTime dateTime W Indicates the date and time in UTC that the warranty associated with the CPE is to expire. - 1.0 TR-106
ISPName string​(64) string​(64) W The name of the customer's ISP. - 1.0 TR-106
ISPHelpDesk string​(32) string​(32) W The help desk phone number of the ISP. - 1.0 TR-106
ISPHomePage string​(256) string​(256) W The URL of the ISP's home page. - 1.0 TR-106
ISPHelpPage string​(256) string​(256) W The URL of the ISP's on-line support page. - 1.0 TR-106
ISPLogo base64​(0:4095) base64​(0:4095) W Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less. - 1.0 TR-106
ISPLogoSize unsignedInt​(0:4095) unsignedInt​(0:4095) W

Un-encoded binary image size in bytes.

If ISPLogoSize input value is 0 then the ISPLogo is cleared.

ISPLogoSize can also be used as a check to verify correct transfer and conversion of Base64 string to image size.

- 1.0 TR-106
ISPMailServer string​(256) string​(256) W The URL of the ISP's mail server. - 1.0 TR-106
ISPNewsServer string​(256) string​(256) W The URL of the ISP's news server. - 1.0 TR-106
TextColor string​(6) string​(6) W The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0 TR-106
BackgroundColor string​(6) string​(6) W The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088). - 1.0 TR-106
ButtonColor string​(6) string​(6) W The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0 TR-106
ButtonTextColor string​(6) string​(6) W The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0 TR-106
AutoUpdateServer string​(256) 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 TR-106
UserUpdateServer string​(256) 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 TR-106
AvailableLanguages string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Comma-separated list of user-interface languages that are available, where each language is specified according to RFC 3066 [RFC3066]. - 1.0 TR-106
CurrentLanguage string​(16) string​(16) W Current user-interface language, specified according to RFC 3066 [RFC3066]. - 1.0 TR-106
Device.​LAN. object object​[1:1] -

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 may be associated with other interfaces is not considered part of the common data model defined in this specification.

Support for this object is Optional.

- 1.0 TR-106
AddressingType string string W

The method used to assign an address to this interface. Enumeration of:

The ability to modify this parameter is optional.

- 1.0 TR-106
IPAddress string​(45) IPAddress W

[IPAddress] The current IP address assigned to this interface.

The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.

- 1.0 TR-106
SubnetMask string​(45) IPAddress W

[IPAddress] The current subnet mask.

The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.

- 1.0 TR-106
DefaultGateway string string W

The IP address of the current default gateway for this interface.

The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.

- 1.0 TR-106
DNSServers string​(256)​[] list​(256) of string W

Comma-separated list (maximum number of characters 256) of strings. Comma-separated list of IP address of the DNS servers for this interface.

The ability to modify this parameter is optional, and this parameter cannot be modified if the AddressingType is DHCP.

If this parameter is modifiable, the device MAY ignore any DNS servers beyond the first two in the list.

- 1.0 TR-106
MACAddress string​(17) MACAddress W [MACAddress] The physical address of this interface. Writable only if MACAddressOverride is present and equal to true. - 1.0 TR-106
MACAddressOverride boolean 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 TR-106
DHCPOptionNumberOfEntries unsignedInt unsignedInt - Number of entries in the DHCP option table. - 1.0 TR-106
Device.​LAN.​DHCPOption.​{i}. object​[0:] object​[0:∞] 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 TR-106
Request boolean boolean W

Whether this entry represents a request to the DHCP server, or a value to be sent by the DHCP client.

  • When true, this entry represents a request. In this case, the DHCP client MUST include the specified Tag in the Parameter Request List, as defined in RFC 2132. The Value parameter is ignored in this case.
  • When false, this entry represents a value to be sent by the DHCP client. In this case, the DHCP client MUST include a DHCP option formed from the Tag and Value parameters (with the Length derived from the length of the Value parameter).
- 1.0 TR-106
Tag unsignedInt​(1:254) unsignedInt​(1:254) W Tag of the DHCP option as defined in RFC 2132. - 1.0 TR-106
Value base64 base64 W Base64 encoded octet string to be used as the Value of the DHCP option if Request is false. - 1.0 TR-106
Device.​LAN.​Stats. object object​[1:1] - This object contains statistics for the default IP interface. - 1.0 TR-106
ConnectionUpTime unsignedInt unsignedInt -

The time in seconds that this IP interface has been connected.

  • If the IP interface is using DHCP, this is the time that the DHCP client has been only in the Bound or Renewing states and the lower-layer interface has continuously maintained a link.
  • If the IP interface is using static addressing, this is the time that the lower-layer interface has continuously maintained a link.
- 1.0 TR-106
TotalBytesSent unsignedInt unsignedInt - Total number of IP payload bytes sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0 TR-106
TotalBytesReceived unsignedInt unsignedInt - Total number of IP payload bytes received over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0 TR-106
TotalPacketsSent unsignedInt unsignedInt - Total number of IP packets sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0 TR-106
TotalPacketsReceived unsignedInt unsignedInt - Total number of IP packets received over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0 TR-106
CurrentDayInterval unsignedInt 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 is not required to do so.

- 1.0 TR-106
CurrentDayBytesSent unsignedInt unsignedInt - Total number of IP payload bytes sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval. - 1.0 TR-106
CurrentDayBytesReceived unsignedInt unsignedInt - Total number of IP payload bytes received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval. - 1.0 TR-106
CurrentDayPacketsSent unsignedInt unsignedInt - Total number of IP packets sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval. - 1.0 TR-106
CurrentDayPacketsReceived unsignedInt unsignedInt - Total number of IP packets received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval. - 1.0 TR-106
QuarterHourInterval unsignedInt 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 is not required to do so.

- 1.0 TR-106
QuarterHourBytesSent unsignedInt unsignedInt - Total number of IP payload bytes sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval. - 1.0 TR-106
QuarterHourBytesReceived unsignedInt unsignedInt - Total number of IP payload bytes received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval. - 1.0 TR-106
QuarterHourPacketsSent unsignedInt unsignedInt - Total number of IP packets sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval. - 1.0 TR-106
QuarterHourPacketsReceived unsignedInt unsignedInt - Total number of IP packets received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval. - 1.0 TR-106
Device.​LAN.​IPPingDiagnostics. object object​[1:1] - This object is defines access to an IP-layer ping test for the default IP interface. - 1.0 TR-106
DiagnosticsState string string W

Indicates availability of diagnostic data. Enumeration of:

Value may be set to Requested to initiate the 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 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.

- 1.0 TR-106
Host string​(256) string​(256) W Host name or address of the host to ping. - 1.0 TR-106
NumberOfRepetitions unsignedInt​(1:) unsignedInt​(1:) W Number of repetitions of the ping test to perform before reporting the results. - 1.0 TR-106
Timeout unsignedInt​(1:) unsignedInt​(1:) W Timeout in milliseconds for the ping test. - 1.0 TR-106
DataBlockSize unsignedInt​(1:65535) unsignedInt​(1:65535) W Size of the data block in bytes to be sent for each ping. - 1.0 TR-106
DSCP unsignedInt​(0:64) unsignedInt​(0:64) W DiffServ codepoint to be used for the test packets. By default the CPE should set this value to zero. - 1.0 TR-106
SuccessCount unsignedInt unsignedInt - Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 1.0 TR-106
FailureCount unsignedInt unsignedInt - Result parameter indicating the number of failed pings in the most recent ping test. - 1.0 TR-106
AverageResponseTime unsignedInt unsignedInt - Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0 TR-106
MinimumResponseTime unsignedInt unsignedInt - Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0 TR-106
MaximumResponseTime unsignedInt unsignedInt - Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0 TR-106
Device.​LAN.​TraceRouteDiagnostics. object object​[1:1] - This object is defines access to an IP-layer trace-route test for the default IP interface. - 1.0 TR-106
DiagnosticsState string string W

Indicates availability of diagnostic data. Enumeration of:

Value may be set to Requested to initiate the 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 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.

- 1.0 TR-106
Host string​(256) string​(256) W Host name or address of the host to find a route to. - 1.0 TR-106
Timeout unsignedInt​(1:) unsignedInt​(1:) W Timeout in milliseconds for the trace route test. - 1.0 TR-106
DataBlockSize unsignedInt​(1:65535) unsignedInt​(1:65535) W Size of the data block in bytes to be sent for each trace route. - 1.0 TR-106
MaxHopCount unsignedInt​(1:64) unsignedInt​(1:64) W The maximum number of hop used in outgoing probe packets (max TTL). The default is 30 hops. - 1.0 TR-106
DSCP unsignedInt​(0:64) unsignedInt​(0:64) W DiffServ codepoint to be used for the test packets. By default the CPE should set this value to zero. - 1.0 TR-106
ResponseTime unsignedInt unsignedInt - Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value must be zero. - 1.0 TR-106
NumberOfRouteHops unsignedInt unsignedInt - Result parameter indicating the number of hops within the discovered route. If a route could not be determined, this value must be zero. - 1.0 TR-106
Device.​LAN.​TraceRouteDiagnostics.​RouteHops.​{i}. object​[0:] object​[0:∞] - Result parameter indicating the components of the discovered route. If a route could not be determined, there will be no instances of this object. - 1.0 TR-106
HopHost string​(256) string​(256) - Result parameter indicating the Host Name or IP Address of a hop along the discovered route. - 1.0 TR-106

Inform and Notification Requirements

Forced Inform Parameters

Parameter
Device.DeviceSummary
Device.DeviceInfo.HardwareVersion
Device.DeviceInfo.SoftwareVersion
Device.ManagementServer.ParameterKey
Device.ManagementServer.ConnectionRequestURL
Device.LAN.IPAddress

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter
Device.DeviceInfo.
ModelName
Device.DeviceInfo.
Description
Device.DeviceInfo.
UpTime
Device.DeviceInfo.
FirstUseDate
Device.DeviceInfo.
DeviceLog
Device.ManagementServer.
ParameterKey
Device.Time.
CurrentLocalTime
Device.LAN.Stats.
ConnectionUpTime
Device.LAN.Stats.
TotalBytesSent
Device.LAN.Stats.
TotalBytesReceived
Device.LAN.Stats.
TotalPacketsSent
Device.LAN.Stats.
TotalPacketsReceived
Device.LAN.Stats.
CurrentDayInterval
Device.LAN.Stats.
CurrentDayBytesSent
Device.LAN.Stats.
CurrentDayBytesReceived
Device.LAN.Stats.
CurrentDayPacketsSent
Device.LAN.Stats.
CurrentDayPacketsReceived
Device.LAN.Stats.
QuarterHourInterval
Device.LAN.Stats.
QuarterHourBytesSent
Device.LAN.Stats.
QuarterHourBytesReceived
Device.LAN.Stats.
QuarterHourPacketsSent
Device.LAN.Stats.
QuarterHourPacketsReceived
Device.LAN.IPPingDiagnostics.
DiagnosticsState
Device.LAN.IPPingDiagnostics.
SuccessCount
Device.LAN.IPPingDiagnostics.
FailureCount
Device.LAN.IPPingDiagnostics.
AverageResponseTime
Device.LAN.IPPingDiagnostics.
MinimumResponseTime
Device.LAN.IPPingDiagnostics.
MaximumResponseTime
Device.LAN.TraceRouteDiagnostics.
DiagnosticsState
Device.LAN.TraceRouteDiagnostics.
ResponseTime
Device.LAN.TraceRouteDiagnostics.
NumberOfRouteHops
Device.LAN.TraceRouteDiagnostics.RouteHops.{i}.
HopHost

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.

Baseline:1 Profile

This table defines the Baseline:1 profile for the Device:1 data model. The minimum REQUIRED version for this profile is Device:1.0.

Name Requirement
Device. P
DeviceSummary R
Device.​DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
DeviceStatus R
UpTime R
Device.​ManagementServer. P
URL W
Username W
Password W
PeriodicInformEnable W
PeriodicInformInterval W
PeriodicInformTime W
ParameterKey R
ConnectionRequestURL R
ConnectionRequestUsername W
ConnectionRequestPassword W
UpgradesManaged W

GatewayInfo:1 Profile

This table defines the GatewayInfo:1 profile for the Device:1 data model. The minimum REQUIRED version for this profile is Device:1.0.

Name Requirement
Device.​GatewayInfo. P
ManufacturerOUI R
ProductClass R
SerialNumber R

Time:1 Profile

This table defines the Time:1 profile for the Device:1 data model. The minimum REQUIRED version for this profile is Device:1.0.

Name Requirement
Device.​Time. P
NTPServer1 W
NTPServer2 W
CurrentLocalTime R
LocalTimeZone W

LAN:1 Profile

This table defines the LAN:1 profile for the Device:1 data model. The minimum REQUIRED version for this profile is Device:1.0.

Name Requirement
Device.​LAN. P
AddressingType R
IPAddress R
SubnetMask R
DefaultGateway R
DNSServers R
MACAddress R
Device.​LAN.​Stats. P
ConnectionUpTime R
TotalBytesSent R
TotalBytesReceived R
TotalPacketsSent R
TotalPacketsReceived R

IPPing:1 Profile

This table defines the IPPing:1 profile for the Device:1 data model. The minimum REQUIRED version for this profile is Device:1.0.

Name Requirement
Device.​LAN.​IPPingDiagnostics. P
DiagnosticsState W
Host W
NumberOfRepetitions W
Timeout W
DataBlockSize W
DSCP W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

TraceRoute:1 Profile

This table defines the TraceRoute:1 profile for the Device:1 data model. The minimum REQUIRED version for this profile is Device:1.0.

Name Requirement
Device.​LAN.​TraceRouteDiagnostics. P
DiagnosticsState W
Host W
Timeout W
DataBlockSize W
MaxHopCount W
DSCP W
ResponseTime R
NumberOfRouteHops R
Device.​LAN.​TraceRouteDiagnostics.​RouteHops.​{i}. P
HopHost R


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