Broadband Forum

TR-069 Device:1.1 Root Object definition

tr-106-1-1-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 types.

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-separate 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 [SOAP1.1].
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.

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

[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3489] RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[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-069a1] TR-069 Amendment 1, CPE WAN Management Protocol, Broadband Forum, December 2006.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-106a1] TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2006.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Parameter definition.

Device:1.1 Data Model

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.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device. - 1.0
DeviceSummary string(:1024) R

See [Section 3.7/TR-106].

This parameter MUST always be included in Inform messages.

 - 1.0
Device.Services. object R This object contains general services information. - 1.0
Device.DeviceInfo. object R This object contains general device information. - 1.0
Manufacturer string(:64) R The manufacturer of the CPE (human readable string). - 1.0
ManufacturerOUI string(:6) R 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
ModelName string(:64) R

Model name of the CPE (human readable string).

Active Notification requests for this parameter MAY be denied.

 - 1.0
Description string(:256) R

A full description of the CPE device (human readable string).

Active Notification requests for this parameter MAY be denied.

 - 1.0
ProductClass string(:64) R 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
SerialNumber string(:64) R Serial number of the CPE. - 1.0
HardwareVersion string(:64) R

A string identifying the particular CPE model and version.

This parameter MUST always be included in Inform messages.

 - 1.0
SoftwareVersion string(:64) R

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.

This parameter MUST always be included in Inform messages.

 - 1.0
EnabledOptions string[](:1024) R 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-069a1]. Only those options are listed whose State indicates the option is enabled. - 1.0
AdditionalHardwareVersion string[](:64) R 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 might wish to supply. - 1.0
AdditionalSoftwareVersion string[](:64) R 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 might wish to supply. - 1.0
ProvisioningCode 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
DeviceStatus string R

Current operational status of the device.

Enumeration of:

  • Up
  • Initializing
  • Error
  • Disabled
 - 1.0
UpTime unsignedInt R

Time in seconds since the CPE was last restarted.

Active Notification requests for this parameter MAY be denied.

 - 1.0
FirstUseDate dateTime R

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.

If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value.

Active Notification requests for this parameter MAY be denied.

 - 1.0
DeviceLog string(:32768) R

Vendor-specific log(s).

Active Notification requests for this parameter MAY be denied.

 - 1.0
Device.ManagementServer. object R This object contains parameters relating to the CPE’s association with an ACS. - 1.0
URL string(:256) W URL, as defined in [RFC3986], 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. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. - 1.0
Username 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.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

 - 1.0
Password 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.

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

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

 - 1.0
PeriodicInformEnable boolean W Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call. - 1.0
PeriodicInformInterval 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
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-106a1] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required 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
ParameterKey string(:32) R

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.

This parameter MUST always be included in Inform messages.

Active Notification requests for this parameter MAY be denied.

 - 1.0
ConnectionRequestURL string(:256) R

HTTP URL, as defined in [RFC3986], 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.

This parameter MUST always be included in Inform messages.

 - 1.0
ConnectionRequestUsername string(:256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 1.0
ConnectionRequestPassword 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
UpgradesManaged 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. Note that an autonomous upgrade (reported via an “10 AUTONOMOUS TRANSFER COMPLETE” Inform Event code) SHOULD be regarded as a managed upgrade if it is performed according to ACS-specified policy. - 1.0
KickURL string(:256) R Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in [RFC3986], 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
DownloadProgressURL string(:256) R Present only for a CPE that provides a LAN-side web page to show progress during a file download. LAN-accessible URL, as defined in [RFC3986], 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
UDPConnectionRequestAddress string(:256) R

Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069a1]). 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.0
UDPConnectionRequestAddressNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled). - 1.0
STUNEnable boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 1.0
STUNServerAddress string(:256) W Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. If is an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL. - 1.0
STUNServerPort unsignedInt(0:65535) W Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. By default, this SHOULD be the equal to the default STUN port, 3478. - 1.0
STUNUsername string(:256) W If is not an empty string, the value of the STUN USERNAME attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server). If is an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity. - 1.0
STUNPassword string(:256) W

The value of the STUN Password to be used in computing the MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server). 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
STUNMaximumKeepAlivePeriod int(-1:) W If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port. A value of -1 indicates that no maximum period is specified. - 1.0
STUNMinimumKeepAlivePeriod unsignedInt W If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489]. - 1.0
NATDetected boolean R When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use. A true value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE’s source address and port. When STUNEnable is false, this value MUST be false. - 1.0
Device.GatewayInfo. object R This object contains information associated with a connected Internet Gateway Device. - 1.0
ManufacturerOUI string(:6) R 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
ProductClass string(:64) R 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
SerialNumber string(:64) R 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
Device.Config. object R This object contains general configuration parameters. - 1.0
PersistentData string(:256) W Arbitrary user data that MUST persist across CPE reboots. - 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. - 1.0
Device.Time. object R This object contains parameters relating an NTP or SNTP time client in the CPE. - 1.0
NTPServer1 string(:64) W First NTP timeserver. Either a host name or IP address. - 1.0
NTPServer2 string(:64) W Second NTP timeserver. Either a host name or IP address. - 1.0
NTPServer3 string(:64) W Third NTP timeserver. Either a host name or IP address. - 1.0
NTPServer4 string(:64) W Fourth NTP timeserver. Either a host name or IP address. - 1.0
NTPServer5 string(:64) W Fifth NTP timeserver. Either a host name or IP address. - 1.0
CurrentLocalTime dateTime R

The current date and time in the CPE’s local time zone.

Active Notification requests for this parameter MAY be denied.

 - 1.0
LocalTimeZone 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
Device.UserInterface. object R This object contains parameters relating to the user interface of the CPE. - 1.0
PasswordRequired 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
PasswordUserSelectable 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
UpgradeAvailable boolean W Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user. - 1.0
WarrantyDate dateTime W Indicates the date and time in UTC that the warranty associated with the CPE is to expire. - 1.0
ISPName string(:64) W The name of the customer’s ISP. - 1.0
ISPHelpDesk string(:32) W The help desk phone number of the ISP. - 1.0
ISPHomePage string(:256) W The URL of the ISP’s home page. - 1.0
ISPHelpPage string(:256) W The URL of the ISP’s on-line support page. - 1.0
base64(0:4095) W Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less. - 1.0
ISPLogoSize 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
ISPMailServer string(:256) W The URL of the ISP’s mail server. - 1.0
ISPNewsServer string(:256) W The URL of the ISP’s news server. - 1.0
TextColor string(:6) W The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
BackgroundColor string(:6) W The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088). - 1.0
ButtonColor string(:6) W The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
ButtonTextColor string(:6) W The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 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 {{param: non-existent 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 {{param: non-existent ManagementServer.UpgradesManaged}} parameter is true. - 1.0
AvailableLanguages string[](:256) R 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
CurrentLanguage string(:16) W Current user-interface language, specified according to RFC 3066 [RFC3066]. - 1.0
Device.LAN. object R 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
AddressingType string W

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

  • DHCP
  • Static The ability to modify this parameter is OPTIONAL.
 - 1.0
IPAddress string(:45) 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.

This parameter MUST always be included in Inform messages.

 - 1.0
SubnetMask string(:45) 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
DefaultGateway 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
DNSServers string[](:256) 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
MACAddress string(:17) W [MACAddress] The physical address of this interface. Writable only if MACAddressOverride is present and equal to true. - 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
DHCPOptionNumberOfEntries unsignedInt R Number of entries in the DHCP option table. - 1.0
Device.LAN.DHCPOption.{i}. 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
Request 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
Tag unsignedInt(1:254) W Tag of the DHCP option as defined in RFC 2132. - 1.0
Value base64 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 R This object contains statistics for the default IP interface. - 1.0
ConnectionUpTime unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
TotalBytesSent unsignedInt R

Total number of IP payload bytes sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime.

Active Notification requests for this parameter MAY be denied.

 - 1.0
TotalBytesReceived unsignedInt R

Total number of IP payload bytes received over this interface since the device was last restarted as specified in DeviceInfo.UpTime.

Active Notification requests for this parameter MAY be denied.

 - 1.0
TotalPacketsSent unsignedInt R

Total number of IP packets sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime.

Active Notification requests for this parameter MAY be denied.

 - 1.0
TotalPacketsReceived unsignedInt R

Total number of IP packets received over this interface since the device was last restarted as specified in DeviceInfo.UpTime.

Active Notification requests for this parameter MAY be denied.

 - 1.0
CurrentDayInterval unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
CurrentDayBytesSent unsignedInt R

Total number of IP payload bytes sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
CurrentDayBytesReceived unsignedInt R

Total number of IP payload bytes received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
CurrentDayPacketsSent unsignedInt R

Total number of IP packets sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
CurrentDayPacketsReceived unsignedInt R

Total number of IP packets received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
QuarterHourInterval unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
QuarterHourBytesSent unsignedInt R

Total number of IP payload bytes sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
QuarterHourBytesReceived unsignedInt R

Total number of IP payload bytes received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
QuarterHourPacketsSent unsignedInt R

Total number of IP packets sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
QuarterHourPacketsReceived unsignedInt R

Total number of IP packets received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Device.LAN.IPPingDiagnostics. object R This object defines access to an IP-layer ping test for the default IP interface. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None
  • Requested
  • Complete
  • Error_CannotResolveHostName
  • Error_Internal
  • Error_Other 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 Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, 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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Host string(:256) W Host name or address of the host to ping. - 1.0
NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform before reporting the results. - 1.0
Timeout unsignedInt(1:) W Timeout in milliseconds for the ping test. - 1.0
DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each ping. - 1.0
DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 1.0
SuccessCount unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
FailureCount unsignedInt R

Result parameter indicating the number of failed pings in the most recent ping test.

Active Notification requests for this parameter MAY be denied.

 - 1.0
AverageResponseTime unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
MinimumResponseTime unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
MaximumResponseTime unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Device.LAN.TraceRouteDiagnostics. object R This object is defines access to an IP-layer trace-route test for the default IP interface. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None
  • Requested
  • Complete
  • Error_CannotResolveHostName
  • Error_MaxHopCountExceeded
  • Error_Internal
  • Error_Other 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 Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, 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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Host string(:256) W Host name or address of the host to find a route to. - 1.0
Timeout unsignedInt(1:) W Timeout in milliseconds for the trace route test. - 1.0
DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each trace route. - 1.0
MaxHopCount unsignedInt(1:64) W The maximum number of hop used in outgoing probe packets (max TTL). The default is 30 hops. - 1.0
DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 1.0
ResponseTime unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

 - 1.0
NumberOfRouteHops unsignedInt R

Result parameter indicating the number of hops within the discovered route. If a route could not be determined, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

 - 1.0
Device.LAN.TraceRouteDiagnostics.RouteHops.{i}. object(0:) R 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
HopHost string(:256) R

Result parameter indicating the Host Name or IP Address of a hop along the discovered route.

Active Notification requests for this parameter MAY be denied.

 - 1.0

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

Parameters for which Active Notification MAY be Denied

Parameter
Device.DeviceInfo.
ModelName
Description
UpTime
FirstUseDate
DeviceLog
Device.ManagementServer.
ParameterKey
Device.Time.
CurrentLocalTime
Device.LAN.Stats.
ConnectionUpTime
TotalBytesSent
TotalBytesReceived
TotalPacketsSent
TotalPacketsReceived
CurrentDayInterval
CurrentDayBytesSent
CurrentDayBytesReceived
CurrentDayPacketsSent
CurrentDayPacketsReceived
QuarterHourInterval
QuarterHourBytesSent
QuarterHourBytesReceived
QuarterHourPacketsSent
QuarterHourPacketsReceived
Device.LAN.IPPingDiagnostics.
DiagnosticsState
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
Device.LAN.TraceRouteDiagnostics.
DiagnosticsState
ResponseTime
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

UDPConnReq:1 Profile

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

Name Requirement
Device.ManagementServer. -
UDPConnectionRequestAddress R
UDPConnectionRequestAddressNotificationLimit W
STUNEnable W
STUNServerAddress W
STUNServerPort W
STUNUsername W
STUNPassword W
STUNMaximumKeepAlivePeriod W
STUNMinimumKeepAlivePeriod W
NATDetected R

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:39:44 UTC.
report.py –output –format markdown tr-106-1-1-0.xml

Table of Contents