Broadband Forum

Component objects for CWMP: TR-069 Device:1.3 and
InternetGatewayDevice:1.5 Root Object definitions
tr-157-1-0-0.xml

DATA MODEL DEFINITION

License

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

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

[DLNA-NDIG] DLNA Networked Device Interoperability Guidelines, DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles., DLNA, October 2006.
[DVB-TS.102.824] TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.
[ICSA-Firewall] ICSA Modular Firewall Certification Criteria, Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0, ICSA Labs.
[ISO-13818-6:1998] ISO/IEC 13818-6:1998, Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC, ISO, 1998.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[RFC2581] RFC 2581, TCP Congestion Control, IETF, April 1999.
[RFC2582] RFC 2582, The NewReno Modification to TCP's Fast Recovery Algorithm, IETF, April 1999.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2974] RFC 2974, Session Announcement Protocol, IETF, October 2000.
[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.
[RFC3926] RFC 3926, FLUTE - File Delivery over Unidirectional Transport, IETF, October 2004.
[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.
[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-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.
[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.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-143] TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.
[TR-157] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.

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.3 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.3, then it will indicate support for version 1.3. 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
DeviceSummary string​(1024) string​(1024) - See [Section 3.7/TR-106]. - 1.0 TR-106
UserNumberOfEntries unsignedInt unsignedInt - Number of entries in the User table. - 1.0 TR-157
SmartCardReaderNumberOfEntries unsignedInt unsignedInt - Number of entries in the SmartCardReader table. - 1.0 TR-157
Device.​Services. object object​[1:1] - This object contains general services information. - 1.0 TR-106
Device.​Capabilities. object object​[1:1] - The capabilities of the device. This is a constant read-only object, meaning that only a firmware upgrade will cause these values to be altered. - 1.0 TR-143c2
Device.​Capabilities.​PerformanceDiagnostic. object object​[1:1] - The capabilities of the Performance Diagnostics (DownloadDiagnostics and UploadDiagnostics) for the device. - 1.0 TR-143c2
DownloadTransports string​[] list of string -

Comma-separated list of strings. Supported DownloadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:

- 1.0 TR-143c2
UploadTransports string​[] list of string -

Comma-separated list of strings. Supported UploadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:

- 1.0 TR-143c2
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].

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

- 1.0 TR-106
TR-106a2
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.

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

- 1.0 TR-106
TR-106a2
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.

- 1.0 TR-106
TR-106a2
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-069a2]. Only those options are listed whose State indicates the option is enabled. - 1.0 TR-106
TR-106a1
TR-106a2
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 might wish to supply. - 1.0 TR-106
TR-106a1
TR-106a2
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 might wish to supply. - 1.0 TR-106
TR-106a1
TR-106a2
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.

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

- 1.0 TR-106
TR-106a1
DeviceLog string​(32768) string​(32768) - Vendor-specific log(s). - 1.0 TR-106
Device.​DeviceInfo.​MemoryStatus. object object​[1:1] - Status of the device's volatile physical memory. - 1.0 TR-157
Total unsignedInt unsignedInt - The total physical RAM, in kilobytes, installed on the device. - 1.0 TR-157
Free unsignedInt unsignedInt - The free physical RAM, in kilobytes, currently available on the device. - 1.0 TR-157
Device.​DeviceInfo.​ProcessStatus. object object​[1:1] - Status of the processes on the device. - 1.0 TR-157
CPUUsage unsignedInt​(:100) unsignedInt​(:100) - The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU. - 1.0 TR-157
ProcessNumberOfEntries unsignedInt unsignedInt -

Number of entries in the Process table.

Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in [Section 3.2.1/TR-069a2].

- 1.0 TR-157
Device.​DeviceInfo.​ProcessStatus.​Process.​{i}. object​[0:] object​[0:∞] -

List of all processes running on the device.

At most one entry in this table can exist with a given value for PID.

- 1.0 TR-157
PID unsignedInt unsignedInt - The Process Identifier. - 1.0 TR-157
Command string​(256) string​(256) - The name of the command that has caused the process to exist. - 1.0 TR-157
Size unsignedInt unsignedInt - The size in kilobytes of the memory occupied by the process. - 1.0 TR-157
Priority unsignedInt​(:99) unsignedInt​(:99) - The priority of the process where 0 is highest. - 1.0 TR-157
CPUTime unsignedInt unsignedInt - The amount of time in milliseconds that the process has spent taking up CPU time since the process was started. - 1.0 TR-157
State string string -

The current state that the process is in. Enumeration of:

- 1.0 TR-157
Device.​DeviceInfo.​TemperatureStatus. object object​[1:1] - Status of the temperature of the device. - 1.0 TR-157
TemperatureSensorNumberOfEntries unsignedInt unsignedInt - Number of entries in TemperatureSensor table. - 1.0 TR-157
Device.​DeviceInfo.​TemperatureStatus.​TemperatureSensor.​{i}. object​[0:] object​[0:∞] -

This object represents information that the device has obtained via sampling an internal temperature sensor.

At most one entry in this table can exist with a given value for Name.

- 1.0 TR-157
Enable boolean boolean W Indicates whether or not the temperature sensor is enabled. - 1.0 TR-157
Status string string -

The status of this temperature sensor. Enumeration of:

  • Disabled (The sensor is not currently sampling the temperature)
  • Enabled (The sensor is currently sampling the temperature)
  • Error (The sensor error currently prevents sampling the temperature)
- 1.0 TR-157
Reset boolean boolean W

When set to true, resets the temperature sensor.

When read, this parameter returns false, regardless of the actual value.

- 1.0 TR-157
ResetTime dateTime dateTime -

The time at which this temperature sensor was reset.

Reset can be caused by:

  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the temperature sensor (including a reboot of the device).

The Unknown Time value, as defined in [TR-106a2], indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.

- 1.0 TR-157
Name string​(256) string​(256) - Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 1.0 TR-157
Value int​(-274:) int​(-274:) -

This temperature sensor's last good reading in degrees celsius.

A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

- 1.0 TR-157
LastUpdate dateTime dateTime -

The time at which this temperature sensor's last good reading was obtained.

The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

- 1.0 TR-157
MinValue int​(-274:) int​(-274:) -

This temperature sensor's lowest value reading in degrees celsius since last reset.

A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

- 1.0 TR-157
MinTime dateTime dateTime -

The time at which this temperature sensor's lowest value was read.

The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

- 1.0 TR-157
MaxValue int​(-274:) int​(-274:) -

This temperature sensor's highest value reading in degrees celsius since last reset.

A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

- 1.0 TR-157
MaxTime dateTime dateTime -

The time at which this temperature sensor's highest value was read.

The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

- 1.0 TR-157
LowAlarmValue int​(-274:) int​(-274:) W

This temperature sensor's low alarm value in degrees celsius.

A value of -274 (which is below absolute zero) indicates a non configured value.

- 1.0 TR-157
LowAlarmTime dateTime dateTime -

Initial time at which this temperature sensor's LowAlarmValue was encountered.

This value is only set the first time the alarm is seen and not changed until the next reset.

The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset.

- 1.0 TR-157
HighAlarmValue int​(-274:) int​(-274:) W

This temperature sensor's high alarm value in degrees celsius.

A value of -274 (which is below absolute zero) indicates a non configured value.

- 1.0 TR-157
HighAlarmTime dateTime dateTime -

Initial time at which this temperature sensor's HighAlarmValue was encountered.

This value is only set the first time the alarm is seen and not changed until the next reset.

The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset.

- 1.0 TR-157
Device.​DeviceInfo.​NetworkProperties. object object​[1:1] - This object defines the parameters that describe how the device handles network traffic. - 1.0 TR-157
MaxTCPWindowSize unsignedInt unsignedInt - The maximum number of bytes of outstanding data a sender can send on a particular connection prior to an acknowledgment [RFC793]. Any scaling factor SHOULD be included in this parameter [RFC1323]. - 1.0 TR-157
TCPImplementation string​[] list of string -

Comma-separated list of strings. Indicates the TCP congestion control mechanism(s) implemented. Each list item is an enumeration of:

  • Tahoe (Represents the base TCP implementation in [RFC793] and elements of [RFC2582])
  • Reno (Represents the base TCP implementation in [RFC793] with the additional algorithms defined in [RFC2581])
  • New Reno (Described as a modification to the Reno algorithms in [RFC2582])
  • Vegas (An emerging TCP congestion control mechanism)

Tahoe, Reno, and New Reno are defined in [RFC2582]

- 1.0 TR-157
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, 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 TR-106
TR-106a1
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.

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 TR-106
TR-106a1
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.

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 TR-106
TR-106a1
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
TR-106a1
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 will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the PeriodicInformInterval.

PeriodicInformTime is used only to set the phase of the periodic Informs. The actual value of PeriodicInformTime can be arbitrarily far into the past or future.

For example, if PeriodicInformInterval is 86400 (a day) and if PeriodicInformTime is set to UTC midnight on some day (in the past, present, or future) then periodic Informs will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicInformTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval.

If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the PeriodicInformTime parameter was set to the Unknown Time value.

- 1.0 TR-106
TR-106a1
TR-106a2
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, 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.

- 1.0 TR-106
TR-106a1
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.

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 TR-106
TR-106a1
KickURL string​(256) string​(256) -

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 TR-106
TR-106a1
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, 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 TR-106
TR-106a1
UDPConnectionRequestAddress string​(256) string​(256) -

Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069a2]).

This parameter is represented in the form of an Authority element as defined in [RFC3986]. The value MUST be in one of the following two forms:

host:port
host

  • When STUNEnable is true, the host and port portions of this parameter MUST represent the public address and port corresponding to the NAT binding through which the ACS can send UDP Connection Request messages (once this information is learned by the CPE through the use of STUN).
  • When STUNEnable is false, the host and port portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages.

The second form of this parameter MAY be used only if the port value is equal to 80.

- 1.0 TR-106a1
TR-106a2
UDPConnectionRequestAddressNotificationLimit unsignedInt unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled). - 1.0 TR-106a1
STUNEnable boolean 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 TR-106a1
STUNServerAddress string​(256) 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 TR-106a1
STUNServerPort unsignedInt​(0:65535) 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 TR-106a1
STUNUsername string​(256) 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 TR-106a1
STUNPassword string​(256) 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 TR-106a1
STUNMaximumKeepAlivePeriod int​(-1:) 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 TR-106a1
STUNMinimumKeepAlivePeriod unsignedInt 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 TR-106a1
NATDetected boolean boolean -

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 TR-106a1
Device.​ManagementServer.​AutonomousTransferCompletePolicy. object object​[1:1] -

This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in [TR-069a2].

The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS.

- 1.0 TR-157
Enable boolean boolean W Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS. - 1.0 TR-157
TransferTypeFilter string string W

Indicates the transfer types that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer types not indicated by this filter MUST NOT be included when the CPE notifies the ACS. Enumeration of:

Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.

- 1.0 TR-157
FileTypeFilter string​(1024)​[] list​(1024) of string W

Comma-separated list (maximum number of characters 1024) of strings. Indicates the file types that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. File types omitted from this list MUST NOT be included when the CPE notifies the ACS.

Additionally, the following format is defined to allow the unique definition of vendor-specific file types:

  • "X <OUI> <Vendor-specific identifier>"

<OUI> is replaced by a 6 hexadecimal-digit OUI (organizationally unique identifier) as defined in [OUI], with all upper-case letters and any leading zeros included. The OUI used for a given vendor-specific file type MUST be one that is assigned to the organization that defined this file type (which is not necessarily the same as the vendor of the CPE or ACS).

Note that an empty string indicates that all file types are excluded from this filter, effectively disabling CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS.

- 1.0 TR-157
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
TR-106a1
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.

An alternative to this parameter, e.g. when the configuration file is larger than the parameter size limit, is to use the Upload and Download RPCs with a FileType of 1 Vendor Configuration File.

- 1.0 TR-106
TR-106a1
TR-106a2
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
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. - 1.0 TR-106
TR-106a1
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
TR-106a1
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
TR-106a1
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
TR-106a2
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
TR-106a2
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.​UserInterface.​RemoteAccess. object object​[1:1] -

This object contains parameters relating to remotely accessing the CPE's user interface.

Remote access is defined as any entity not of a local subnet attempting to connect to the CPE.

Remote access requires user authentication. To provide remote access authentication the CPE MUST support a User.{i}. with at least one instance that has User.{i}.RemoteAccessCapable set to true.

- 1.0 TR-157
Enable boolean boolean W Enables/Disables remotely accessing the CPE’s user interface. - 1.0 TR-157
Port unsignedInt​(:65535) unsignedInt​(:65535) W Destination TCP port required for remote access connection. - 1.0 TR-157
SupportedProtocols string​[] list of string -

Comma-separated list of strings. Indicates the protocols that are supported by the CPE for the purpose of remotely accessing the user interface. Each list item is an enumeration of:

- 1.0 TR-157
Protocol string string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 1.0 TR-157
Device.​UserInterface.​LocalDisplay. object object​[1:1] - This object describes how to remotely manage the initial positioning of a user interface on a device's local display. - 1.0 TR-157
Movable boolean boolean W Controls whether the user is allowed to change the GUI window position on the local CPE's display. - 1.0 TR-157
Resizable boolean boolean W Controls whether the user is allowed to resize the GUI window on the local CPE's display. - 1.0 TR-157
PosX int int W The horizontal position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 1.0 TR-157
PosY int int W The vertical position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 1.0 TR-157
Width unsignedInt unsignedInt W The width of the user interface within the local CPE's display, expressed in pixels. - 1.0 TR-157
Height unsignedInt unsignedInt W The height of the user interface within the local CPE's display, expressed in pixels. - 1.0 TR-157
DisplayWidth unsignedInt unsignedInt - The width of the local CPE's display, expressed in pixels. - 1.0 TR-157
DisplayHeight unsignedInt unsignedInt - The height of the local CPE's display, expressed in pixels. - 1.0 TR-157
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 might be associated with other interfaces is not considered part of the common data model defined in this specification.

- 1.0 TR-106
TR-106a1
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
TR-106a1
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
TR-106a1
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
TR-106a1
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
TR-106a1
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
TR-106a1
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
TR-106a2
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​(255) base64​(255) W Base64 encoded octet string to be used as the Value of the DHCP option if Request is false. <Empty> 1.0 TR-106
TR-106a1
TR-106a2
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 does not need to do so.

- 1.0 TR-106
TR-106a2
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 does not need to do so.

- 1.0 TR-106
TR-106a2
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 defines access to an IP-layer ping test for the default IP interface. - 1.0 TR-106
TR-106a1
DiagnosticsState string string W

Indicates availability of diagnostic data. Enumeration of:

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.

- 1.0 TR-106
TR-106a1
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:63) 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 TR-106
TR-106a1
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:

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.

- 1.0 TR-106
TR-106a1
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:63) 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 TR-106
TR-106a1
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
TR-106a1
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
TR-106a1
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
Device.​DownloadDiagnostics. object object​[1:1] -

This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.

Files received in the DownloadDiagnostics do not require file storage on the CPE device.

- 1.0 TR-143c2
DiagnosticsState string string W

Indicate the availability of diagnostic data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.

When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

- 1.0 TR-143c2
TR-106a2
Interface string​(256) string​(256) W

The value MUST be the Path Name of the IP-layer interface over which the test is to be performed.

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST use the default routing interface.

- 1.0 TR-143c2
DownloadURL string​(256) string​(256) W

The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.

  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
- 1.0 TR-143c2
DSCP unsignedInt​(0:63) unsignedInt​(0:63) W

The DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

- 1.0 TR-143c2
EthernetPriority unsignedInt​(0:7) unsignedInt​(0:7) W

Ethernet priority code for marking packets transmitted in the test (if applicable).

The default value SHOULD be zero.

- 1.0 TR-143c2
ROMTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.
- 1.0 TR-143c2
BOMTime dateTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.
- 1.0 TR-143c2
EOMTime dateTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.
- 1.0 TR-143c2
TestBytesReceived unsignedInt unsignedInt - The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime, - 1.0 TR-143c2
TotalBytesReceived unsignedInt unsignedInt - The total number of bytes received on the Interface between BOMTime and EOMTime. - 1.0 TR-143c2
TCPOpenRequestTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.

Note: Interval of 1 microsecond SHOULD be supported.

- 1.0 TR-143c2
TCPOpenResponseTime dateTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.

Note: Interval of 1 microsecond SHOULD be supported.

- 1.0 TR-143c2
Device.​UploadDiagnostics. object object​[1:1] -

This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

- 1.0 TR-143c2
DiagnosticsState string string W

Indicate the availability of diagnostic data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.

When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

- 1.0 TR-143c2
Interface string​(256) string​(256) W

The value MUST be the Path Name of the IP-layer interface over which the test is to be performed.

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST use the default routing interface.

- 1.0 TR-143c2
UploadURL string​(256) string​(256) W

The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.

  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
- 1.0 TR-143c2
DSCP unsignedInt​(0:63) unsignedInt​(0:63) W

DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

- 1.0 TR-143c2
EthernetPriority unsignedInt​(0:7) unsignedInt​(0:7) W

Ethernet priority code for marking packets transmitted in the test (if applicable).

The default value SHOULD be zero.

- 1.0 TR-143c2
TestFileLength unsignedInt unsignedInt W

The size of the file (in bytes) to be uploaded to the server.

The CPE MUST insure the appropriate number of bytes are sent.

- 1.0 TR-143c2
ROMTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the client sends the PUT command
  • For FTP this is the time at which the STOR command is sent.
- 1.0 TR-143c2
BOMTime dateTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the first data packet is sent.
  • For FTP this is the time at which the client receives the ready for transfer notification.
- 1.0 TR-143c2
EOMTime dateTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time when the HTTP successful response code is received.
  • For FTP this is the time when the client receives a transfer complete.
- 1.0 TR-143c2
TotalBytesSent unsignedInt unsignedInt - The total number of bytes sent on the Interface between BOMTime and EOMTime. - 1.0 TR-143c2
TCPOpenRequestTime dateTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection

Note: Interval of 1 microsecond SHOULD be supported.

- 1.0 TR-143c2
TCPOpenResponseTime dateTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the Time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the Time at which the TCP ACK to the socket opening the Data connection was received.

Note: Interval of 1 microsecond SHOULD be supported.

- 1.0 TR-143c2
Device.​UDPEchoConfig. object object​[1:1] - This object allows the CPE to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. - 1.0 TR-143c2
Enable boolean boolean W MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared. - 1.0 TR-143c2
Interface string​(256) string​(256) W

The value MUST be the Path Name of IP-layer interface over which the CPE MUST listen and receive UDP echo requests on.

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces.

Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets.

- 1.0 TR-143c2
SourceIPAddress string​(45) IPAddress W [IPAddress] The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address. - 1.0 TR-143c2
UDPPort unsignedInt unsignedInt W The UDP port on which the UDP server MUST listen and respond to UDP echo requests. - 1.0 TR-143c2
EchoPlusEnabled boolean boolean W If true the CPE will perform necessary packet processing for UDP Echo Plus packets. - 1.0 TR-143c2
EchoPlusSupported boolean boolean - true if UDP Echo Plus is supported. - 1.0 TR-143c2
PacketsReceived unsignedInt unsignedInt - Incremented upon each valid UDP echo packet received. - 1.0 TR-143c2
PacketsResponded unsignedInt unsignedInt - Incremented for each UDP echo response sent. - 1.0 TR-143c2
BytesReceived unsignedInt unsignedInt - The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled. - 1.0 TR-143c2
BytesResponded unsignedInt unsignedInt - The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled. - 1.0 TR-143c2
TimeFirstPacketReceived dateTime dateTime -

Time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456,

The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled.

- 1.0 TR-143c2
TimeLastPacketReceived dateTime dateTime -

Time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

The time that the server receives the most recent UDP echo packet.

- 1.0 TR-143c2
Device.​User.​{i}. object​[0:] object​[0:∞] W

This object contains parameters relating to the user characteristics.

At most one enabled entry in this table can exist with a given value for Username.

- 1.0 TR-157
Enable boolean boolean W

Enables/disables this user object instance.

If the User being configured is currently accessing the device then a disable MUST apply to the next user session and the current user session MUST NOT be abruptly terminated.

false 1.0 TR-157
RemoteAccessCapable boolean boolean W Allows this user to remotely access the UserInterface via the mechanism defined in UserInterface.RemoteAccess. false 1.0 TR-157
Username string​(64) string​(64) W Name of the current user. MUST NOT be an empty string for an enabled entry. <Empty> 1.0 TR-157
Password string​(64) string​(64) W

The user's password.

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

- 1.0 TR-157
Language string​(16) string​(16) W

String describing the default language for the local configuration interface, specified according to [RFC3066].

If an empty string, UserInterface.CurrentLanguage is used.

<Empty> 1.0 TR-157
Device.​UPnP. object object​[1:1] - This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 1.0 TR-157
Device.​UPnP.​Device. object object​[1:1] - Configuration Object for UPnP Access. - 1.0 TR-157
Enable boolean boolean W Enables/Disables UPnP support. - 1.0 TR-157
UPnPMediaServer boolean boolean W Enables/Disables UPnP Media Server. - 1.0 TR-157
UPnPMediaRenderer boolean boolean W Enables/Disables UPnP Media Renderer. - 1.0 TR-157
UPnPWLANAccessPoint boolean boolean W Enables/Disables UPnP Wireless Access Point. - 1.0 TR-157
UPnPQoSDevice boolean boolean W Enables/Disables UPnP QoS Device. - 1.0 TR-157
UPnPQoSPolicyHolder boolean boolean W Enables/Disables UPnP QoS Policy Holder. - 1.0 TR-157
UPnPIGD boolean boolean W Enables/Disables UPnP IGD. - 1.0 TR-157
Device.​UPnP.​Device.​Capabilities. object object​[1:1] - This object defines what UPnP capabilities this device has. - 1.0 TR-157
UPnPArchitecture unsignedInt unsignedInt -

Numeric value indicating the version of supported architecture for UPnP.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPMediaServer unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Media Server.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPMediaRenderer unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Media Renderer.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPWLANAccessPoint unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Wireless Access Point.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPBasicDevice unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Basic Device.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPQoSDevice unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Qos Device.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPQoSPolicyHolder unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Qos Policy Holder.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPIGD unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP IGD.

A value of 0 indicates no support.

- 1.0 TR-157
Device.​UPnP.​Discovery. object object​[1:1] -

UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services.

The CPE MAY, but need not, retain some or all of the information in this object across reboots.

- 1.0 TR-157
RootDeviceNumberOfEntries unsignedInt unsignedInt - Number of entries in RootDevice table. - 1.0 TR-157
DeviceNumberOfEntries unsignedInt unsignedInt - Number of entries in Device table. - 1.0 TR-157
ServiceNumberOfEntries unsignedInt unsignedInt - Number of entries in Service table. - 1.0 TR-157
Device.​UPnP.​Discovery.​RootDevice.​{i}. object​[0:] object​[0:∞] -

UPnP root device table. This table contains an entry for each UPnP root device that has been discovered via SSDP.

At most one entry in this table can exist with a given value for UUID.

- 1.0 TR-157
Status string string -

The status of the UPnP root device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received)

The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.

- 1.0 TR-157
UUID string​(36) string​(36) -

This UPnP root device's UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:

02c29d2a-dbfd-2d91-99c9-306d537e9856

- 1.0 TR-157
USN string​(256) string​(256) -

The value of the USN (Unique Service Name) header for this UPnP root device. Three discovery messages are sent for root devices, and this SHOULD be the value of the USN header of the following form:

uuid:device-UUID::urn:domain-name:device:deviceType:v

SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, one of the other two forms MAY be used:

uuid:device-UUID::upnp:rootdevice
uuid:device-UUID (for root device UUID)
- 1.0 TR-157
LeaseTime unsignedInt unsignedInt - The UPnP root device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0 TR-157
Location string​(256) string​(256) - The value of the LOCATION header for this UPnP root device, which is the URL of the root device's DDD (Device Description Document). - 1.0 TR-157
Server string​(256) string​(256) -

The value of the SERVER header for this UPnP root device, which is a string of the following form:

OS/version UPnP/udaversion product/version

where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.

- 1.0 TR-157
Host string​(1024)​[]​(256) list​(1024) of string​(256) -

Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 1.0 TR-157
Device.​UPnP.​Discovery.​Device.​{i}. object​[0:] object​[0:∞] -

UPnP embedded device table. This table contains an entry for each UPnP embedded device that has been discovered via SSDP.

At most one entry in this table can exist with a given value for UUID.

- 1.0 TR-157
Status string string -

The status of the UPnP embedded device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received)

The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.

- 1.0 TR-157
UUID string​(36) string​(36) -

This UPnP embedded device's UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:

02c29d2a-dbfd-2d91-99c9-306d537e9856

- 1.0 TR-157
USN string​(256) string​(256) -

The value of the USN (Unique Service Name) header for this UPnP embedded device. Two discovery messages are sent for embedded devices, and this SHOULD be the value of the USN header of the following form:

uuid:device-UUID::urn:domain-name:device:deviceType:v

SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, the other form MAY be used:

uuid:device-UUID
- 1.0 TR-157
LeaseTime unsignedInt unsignedInt - The UPnP embedded device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0 TR-157
Location string​(256) string​(256) - The value of the LOCATION header for this UPnP embedded device, which is the URL of the root device's DDD (Device Description Document). - 1.0 TR-157
Server string​(256) string​(256) -

The value of the SERVER header for this UPnP embedded device, which is a string of the following form:

OS/version UPnP/udaversion product/version

where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.

- 1.0 TR-157
Host string​(1024)​[]​(256) list​(1024) of string​(256) -

Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 1.0 TR-157
Device.​UPnP.​Discovery.​Service.​{i}. object​[0:] object​[0:∞] -

UPnP embedded service table. This table contains an entry for each UPnP embedded service that has been discovered via SSDP.

At most one entry in this table can exist with a given value for USN.

- 1.0 TR-157
Status string string -

The status of the UPnP embedded service. Enumeration of:

  • LeaseActive (Service is active and UPnP lease has not expired)
  • LeaseExpired (Service is inactive because UPnP lease has expired)
  • ByebyeReceived (Service is inactive because byebye message was received)

The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.

- 1.0 TR-157
USN string​(256) string​(256) -

The value of the USN (Unique Service Name) header for this UPnP embedded service. This is of the following form:

uuid:device-UUID::urn:domain-name:service:serviceType:v
- 1.0 TR-157
LeaseTime unsignedInt unsignedInt - The UPnP embedded service lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0 TR-157
Location string​(256) string​(256) - The value of the LOCATION header for this UPnP embedded service, which is the URL of the root device's DDD (Device Description Document). - 1.0 TR-157
Server string​(256) string​(256) -

The value of the SERVER header for this UPnP embedded service, which is a string of the following form:

OS/version UPnP/udaversion product/version

where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.

- 1.0 TR-157
Host string​(1024)​[]​(256) list​(1024) of string​(256) -

Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 1.0 TR-157
Device.​DLNA. object object​[1:1] - This object contains all DLNA related objects and parameters. - 1.0 TR-157
Device.​DLNA.​Capabilities. object object​[1:1] - DLNA capabilities. - 1.0 TR-157
HNDDeviceClass string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Network Device Classes [Table 4-1/DLNA-NDIG]. - 1.0 TR-157
DeviceCapability string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Device Capabilities [Table 4-2/DLNA-NDIG]. - 1.0 TR-157
HIDDeviceClass string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Infrastructure Device Classes [Table 4-4/DLNA-NDIG]. - 1.0 TR-157
ImageClassProfileID string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Image Class Profile IDs supported by this device, from Tables 5-2 and 5-3 of [DLNA-NDIG]. - 1.0 TR-157
AudioClassProfileID string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Audio Class Profile IDs supported by this device, from Tables 5-4 through 5-10 of [DLNA-NDIG]. - 1.0 TR-157
AVClassProfileID string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA AV Class Profile IDs supported by this device, from Tables 5-11 through 5-15 of [DLNA-NDIG]. - 1.0 TR-157
MediaCollectionProfileID string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Media Collection Profile IDs supported by this device [Table 5-16/DLNA-NDIG]. - 1.0 TR-157
PrinterClassProfileID string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Printer Class Profile IDs supported by this device [Table 5-17/DLNA-NDIG]. - 1.0 TR-157
Device.​SmartCardReader.​{i}. object​[0:] object​[0:∞] -

This object describes the characteristics of the smart card reader.

At most one entry in this table can exist with a given value for Name.

- 1.0 TR-157
Enable boolean boolean W Enables or disables this smart card reader. - 1.0 TR-157
Status string string -

Indicates the status of this smart card reader. Enumeration of:

  • Disabled
  • Enabled (Indicates the smart card reader is enabled and functioning properly)
  • Error (Indicates the smart card reader is enabled and not functioning properly)
- 1.0 TR-157
Name string​(256) string​(256) - Human-readable name associated with this smart card reader. - 1.0 TR-157
Reset boolean boolean W

When set to true, resets the SmartCard Reader and the associated SmartCard.

When read, this parameter returns false, regardless of the actual value.

- 1.0 TR-157
ResetTime dateTime dateTime -

The time at which this SmartCard Reader was reset.

Reset can be caused by:

  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the SmartCard Reader (including a reboot of the device).

Unknown Time value indicates that this SmartCard Reader has never been reset, which can only happen if it has never been enabled.

- 1.0 TR-157
DecryptionFailedCounter unsignedInt unsignedInt -

Counter incremented once each time decryption cannot be carried out.

This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed.

- 1.0 TR-157
DecryptionFailedNoKeyCounter unsignedInt unsignedInt -

Counter incremented once each time the key is not available to decrypt it. This is a subset of the more general DecryptionFailedCounter within the same object and thus will always be less than that parameter.

This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed.

- 1.0 TR-157
Device.​SmartCardReader.​{i}.​SmartCard. object object​[1:1] - Status of currently associated smart card. - 1.0 TR-157
Status string string -

Status of the Smart Card. Enumeration of:

  • None (Indicates that no Smart Card is inserted)
  • Running (Indicates a Smart Card is present and working normally)
  • Error (Indicates the Smart Card is present and in an error condition)
- 1.0 TR-157
Type string string -

Smart Card Type. Enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.

- 1.0 TR-157
Application string​[] list of string -

Comma-separated list of strings. Indicates Smart Card Application(s). Application is only relevant when Type has a value of UICC, otherwise it is an empty string. Each list item is an enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.

- 1.0 TR-157
SerialNumber string​(256) string​(256) - The Smart Card Serial Number or an empty string if the Smart Card serial Number is not available, e.g. in the case of IPTV due to restrictions of the Service Delivery Platform. - 1.0 TR-157
ATR string​(1024) string​(1024) - The Smart Card answer to a reset action. Issued by the Smart Card upon reset. - 1.0 TR-157
Device.​SelfTestDiagnostics. object object​[1:1] - This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 1.0 TR-157
DiagnosticsState string string W

Indicates availability of diagnostic data. Enumeration of:

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.

- 1.0 TR-157
Results string​(1024) string​(1024) - Results of self-test (vendor specific). - 1.0 TR-157
Device.​NSLookupDiagnostics. object object​[1:1] -

This object defines access to an IP-layer NS Lookup test for the specified IP interface.

When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times.

There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions.

Any previous Result instances are removed when a new test is initiated.

- 1.0 TR-157
DiagnosticsState string string W

Indicates availability of diagnostic data. Enumeration of:

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.

- 1.0 TR-157
Interface string​(256) string​(256) W

The value MUST be the Path Name of a table row. This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test).

If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface.

- 1.0 TR-157
HostName string​(256) string​(256) W Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name. - 1.0 TR-157
DNSServer string​(256) string​(256) W

Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided.

If an empty string is specified, the device's default DNS server will be used.

- 1.0 TR-157
Timeout unsignedInt unsignedInt W Timeout in milliseconds that indicates that a request has failed. - 1.0 TR-157
NumberOfRepetitions unsignedInt unsignedInt W

The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions.

Each repetition will use a Result instance to hold the NSLookup result data.

- 1.0 TR-157
SuccessCount unsignedInt unsignedInt - Number of successfully executed repetitions. - 1.0 TR-157
ResultNumberOfEntries unsignedInt unsignedInt - Total number of Result entries from the most recent invocation of the test. - 1.0 TR-157
Device.​NSLookupDiagnostics.​Result.​{i}. object​[0:] object​[0:∞] - Results from the most recent invocation of the test, one instance per repetition. - 1.0 TR-157
Status string string -

Result Parameter to represent whether the NS Lookup was successful or not.

Errors for individual Result instances do not get bubbled up to NSLookupDiagnostics.DiagnosticsState.

A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that NSLookupDiagnostics.DiagnosticsState SHOULD be Error_Other. Enumeration of:

- 1.0 TR-157
AnswerType string string -

Result parameter to represent whether the answer is Authoritative or not. Enumeration of:

- 1.0 TR-157
HostNameReturned string​(256) string​(256) - Result parameter to represent the fully qualified name for the Host Name in the calling parameter (e.g. HostName.DomainName); if no response was provided, then this parameter is an empty string. - 1.0 TR-157
IPAddresses string​[:10]​(45) list​[:10] of IPAddress - [IPAddress] Comma-separated list (up to 10 items) of IPAddresses. Indicates the IP Address results returned by the NS Lookup; if no response was provided, then this parameter is an empty string. - 1.0 TR-157
DNSServerIP string​(45) IPAddress - [IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used. - 1.0 TR-157
ResponseTime unsignedInt unsignedInt - Response time (for the first response packet) in milliseconds, or 0 if no response was received. - 1.0 TR-157
Device.​Firewall. object object​[1:1] - Firewall configuration object. - 1.0 TR-157
Config string string W

How this firewall is configured. Enumeration of:

  • High (The firewall implements the "Traffic Denied Inbound" and "Minimally Permit Common Services Outbound" components of the ICSA residential certification's Required Services Security Policy [ICSA-Firewall])
  • Low (All Outbound traffic and pinhole-defined Inbound traffic is allowed)
  • Off (All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings)

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.

- 1.0 TR-157
Version string​(16) string​(16) - A string identifying the firewall settings version currently used in the CPE, or an empty string if the firewall settings are not associated with a version. - 1.0 TR-157
LastChange dateTime dateTime - The time at which the firewall settings most recently changed. - 1.0 TR-157
Device.​USBHosts. object object​[1:1] -

This object models the CPE's USB Host controllers.

See [Appendix I/TR-157] for Theory of Operation.

- 1.0 TR-157
HostNumberOfEntries unsignedInt unsignedInt - Number of entries in the Host table. - 1.0 TR-157
Device.​USBHosts.​Host.​{i}. object​[0:] object​[0:∞] -

Table of CPE USB Host controllers.

At most one entry in this table can exist with a given value for Name.

- 1.0 TR-157
Enable boolean boolean W Enables or disables the USB Host controller. - 1.0 TR-157
Name string​(64) string​(64) - User-readable host controller name. - 1.0 TR-157
Type string string -

Type of USB Host

Enumeration of:

  • OHCI (Open Host Controller Interface)
  • EHCI (Enhanced Host Controller Interface)
  • UHCI (Universal Host Controller Interface)
  • xHCI (Extensible Host Controller Interface)
- 1.0 TR-157
Reset boolean boolean W

When set to true, reset the Host Controller and apply the reset signaling (see [Chapter 7.1.7.5/USB2.0]) to all of the Host Controller Hub downstream ports.

The value is not saved in the device's state and setting it to false has no effect.

When read, this parameter returns false, regardless of the actual value.

- 1.0 TR-157
PowerManagementEnable boolean boolean W

When set to true, PowerManagementEnable enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see [USB2.0], Chapters 4.3.2, 7.1.7.6, and 11.9).

When set to false PowerManagementEnable immediately disables the Host controller Power Management policy.

- 1.0 TR-157
USBVersion string​(4) string​(4) - USB specification version with which the controller complies. Example: "1.1" - 1.0 TR-157
DeviceNumberOfEntries unsignedInt unsignedInt - Number of entries in the Device table. - 1.0 TR-157
Device.​USBHosts.​Host.​{i}.​Device.​{i}. object​[0:] object​[0:∞] -

Table of connected USB devices.

At most one entry in this table can exist with a given value for DeviceNumber.

- 1.0 TR-157
DeviceNumber unsignedInt unsignedInt - Device number on USB bus. - 1.0 TR-157
USBVersion string​(4) string​(4) - USB specification version with which the device complies. Example: "1.1" - 1.0 TR-157
DeviceClass hexBinary​(1) hexBinary​(1) -

Class Code as assigned by USB-IF.

When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified.

- 1.0 TR-157
DeviceSubClass hexBinary​(1) hexBinary​(1) - Subclass code (assigned by USB-IF). - 1.0 TR-157
DeviceVersion unsignedInt​(:65535) unsignedInt​(:65535) - Device release number. - 1.0 TR-157
DeviceProtocol hexBinary​(1) hexBinary​(1) - Protocol code (assigned by USB-IF). - 1.0 TR-157
ProductID unsignedInt​(:65535) unsignedInt​(:65535) - Product ID (assigned by manufacturer). - 1.0 TR-157
VendorID unsignedInt​(:65535) unsignedInt​(:65535) - Vendor ID (assigned by USB-IF). - 1.0 TR-157
Manufacturer string​(64) string​(64) - Device Manufacturer string descriptor. - 1.0 TR-157
ProductClass string​(64) string​(64) - Device Product Class string descriptor. - 1.0 TR-157
SerialNumber string​(64) string​(64) - Device SerialNumber string descriptor. - 1.0 TR-157
Port unsignedInt​(:255) unsignedInt​(:255) -

Hub port on parent device.

0 when no parent.

- 1.0 TR-157
Rate string string -

Speed of the USB device. Enumeration of:

  • Low (1.5 Mbits/sec (187.5 KB/sec) defined in [USB1.0])
  • Full (12 Mbits/sec (1.5 MB/sec) defined in [USB1.0])
  • High (480 Mbits/sec (60 MB/sec) defined in [USB2.0])
  • Super (5.0 Gbits/sec (625 MB/sec) defined in [USB3.0])

Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate.

- 1.0 TR-157
Parent string string -

The value MUST be the Path Name of a row in the USBHosts.Host.{i}.Device.{i} table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the parent USB device (e.g. hub device).

Example:

.USBHosts.Host.2.Device.3

This is an empty string for a device connected to the Host controller (root hub).

- 1.0 TR-157
MaxChildren unsignedInt unsignedInt - Number of ports. Only applies for hub device, equal to 0 for other devices. - 1.0 TR-157
IsSuspended boolean boolean -

When true the associated Device is in a suspended (i.e. low-power) state (see [Chapter 11.9/USB2.0]).

When false the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see [Chapter 9.1.1/USB2.0]).

- 1.0 TR-157
IsSelfPowered boolean boolean -

When true the associated device is at least partly powered by a local source (see [Chapter 9.4.5/USB2.0]).

When false the associated device draws all the current it needs from the USB bus.

- 1.0 TR-157
ConfigurationNumberOfEntries unsignedInt unsignedInt - Number of entries in the Configuration table. - 1.0 TR-157
Device.​USBHosts.​Host.​{i}.​Device.​{i}.​Configuration.​{i}. object​[0:] object​[0:∞] -

Table of device configurations.

At most one entry in this table can exist with a given value for ConfigurationNumber.

- 1.0 TR-157
ConfigurationNumber unsignedInt unsignedInt - The identifier for each Device Configuration. - 1.0 TR-157
InterfaceNumberOfEntries unsignedInt unsignedInt - Number of entries in the Interface table. - 1.0 TR-157
Device.​USBHosts.​Host.​{i}.​Device.​{i}.​Configuration.​{i}.​Interface.​{i}. object​[0:] object​[0:∞] -

Table of device interface descriptors.

At most one entry in this table can exist with a given value for InterfaceNumber.

- 1.0 TR-157
InterfaceNumber unsignedInt​(:255) unsignedInt​(:255) - Number of this interface (from USB interface descriptor). - 1.0 TR-157
InterfaceClass hexBinary​(1) hexBinary​(1) -

Class Code as assigned by USB-IF.

When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified.

- 1.0 TR-157
InterfaceSubClass hexBinary​(1) hexBinary​(1) - Subclass code (assigned by USB-IF). - 1.0 TR-157
InterfaceProtocol hexBinary​(1) hexBinary​(1) - Protocol code (assigned by USB-IF). - 1.0 TR-157
Device.​PeriodicStatistics. object object​[1:1] -

This object configures collection of periodic statistics for the device.

Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples.

This object provides a single set of global settings that affect the entire device unless overridden locally.

- 1.0 TR-157
MinSampleInterval unsignedInt unsignedInt -

Minimum sample interval in seconds that the CPE is able to support.

A value of 0 indicates no specific minimum sample interval.

- 1.0 TR-157
MaxReportSamples unsignedInt unsignedInt -

Maximum number of samples of each statistic that the CPE is able to store and report.

A value of 0 indicates no specific maximum number of samples.

- 1.0 TR-157
SampleSetNumberOfEntries unsignedInt unsignedInt - Number of entries in SampleSet table. - 1.0 TR-157
Device.​PeriodicStatistics.​SampleSet.​{i}. object​[0:] object​[0:∞] W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

At most one enabled entry in this table can exist with a given value for Name.

- 1.0 TR-157
Enable boolean boolean W

Enables or disables collection of periodic statistics for this sample set.

When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

false 1.0 TR-157
Status string string -

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the ACS SHOULD now fetch the collected data)

The Trigger value is only used for triggering the ACS to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples].

The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.

"Disabled" 1.0 TR-157
Name string​(128) string​(128) W The name of this sample set, which uniquely distinguishes each sample set. <Empty> 1.0 TR-157
SampleInterval unsignedInt​(1:) unsignedInt​(1:) W

The sample interval in seconds. Each statistic is measured over this sample interval.

The CPE MAY reject a request to set SampleInterval to less than PeriodicStatistics.MinSampleInterval.

Sample intervals MUST begin every SampleInterval seconds, with no delay between samples.

If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.

3600 1.0 TR-157
ReportSamples unsignedInt​(1:) unsignedInt​(1:) W

The number of samples that the CPE will store and report for each statistic.

The CPE MUST permit ReportSamples to be set to at least PeriodicStatistics.MaxReportSamples.

If ReportSamples is changed while collection of periodic statistics is enabled, the CPE will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.

24 1.0 TR-157
TimeReference dateTime dateTime W

An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval.

TimeReference is used only to set the "phase" of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future.

This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval).

If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

The Unknown Time value defined in [TR-106a2] 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 sample and fetch intervals.

If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value.

For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc).

If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight.

Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start.

0001-01-01T00:00:00Z 1.0 TR-157
FetchSamples unsignedInt unsignedInt W

The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled.

If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur.

For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also ForceSample).

To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples.

0 1.0 TR-157
ForceSample boolean boolean W

When set to true, forces statistics for the current sample to be calculated and updated in the data model. Setting it to false has no effect. When read, this parameter returns false, regardless of the actual value.

If this is the first time that ForceSample has been set to true during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly.

If this is not the first time that ForceSample has been set to true during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly.

Note that ForceSample just provides a "sneak preview" of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.

At the end of each sample interval, if ForceSample was set to true during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample was set to true will be updated one last time at the end of the sample interval.

false 1.0 TR-157
ReportStartTime dateTime dateTime - The absolute time at which the sample interval for the first stored sample (for each statistic) started. <Empty> 1.0 TR-157
ReportEndTime dateTime dateTime -

The absolute time at which the sample interval for the last stored sample (for each statistic) ended.

If ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected.

<Empty> 1.0 TR-157
SampleSeconds unsignedInt​[] list of unsignedInt -

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval.

Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:

TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.
<Empty> 1.0 TR-157
ParameterNumberOfEntries unsignedInt unsignedInt - Number of entries in Parameter table. 0 1.0 TR-157
Device.​PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. object​[0:] object​[0:∞] W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled.

Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a "sneak preview" of the current sample), or (c) at the end of the sample interval.

At most one enabled entry in this table can exist with a given value for Reference.

- 1.0 TR-157
Enable boolean boolean W Enables or disables this object instance. false 1.0 TR-157
Reference string​(256) string​(256) W The value MUST be the Path Name of a parameter. This is the parameter being monitored by the Periodic Statistics mechanism. <Empty> 1.0 TR-157
SampleMode string string W

Controls how this parameter's value is sampled. Enumeration of:

  • Current (Sampled value is current value)
  • Change (Sampled value is change in value since start of sample interval)

Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters.

"Current" 1.0 TR-157
CalculationMode string string W

Controls how this parameter's statistic is calculated from the sampled value(s). Enumeration of:

  • Latest (Statistic is sampled value at end of sample interval)
  • Minimum (Statistic is minimum sampled value during sample interval)
  • Maximum (Statistic is maximum sampled value during sample interval)
  • Average (Statistic is average (mean) sampled value during sample interval)

Parameters of non-numeric types can only support Latest. The value of the CalculationMode MUST be ignored for such parameters.

SampleMode MUST be applied before CalculationMode, i.e. the inputs to the calculation will have already accounted for SampleMode.

"Latest" 1.0 TR-157
LowThreshold int int W

The low threshold value that controls the calculation of Failures.

A value equal to HighThreshold disables the threshold/failure mechanism.

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
HighThreshold int int W

The high threshold value that controls the calculation of Failures.

A value equal to LowThreshold disables the threshold/failure mechanism.

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
SampleSeconds unsignedInt​[] list of unsignedInt -

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval.

Individual SampleSeconds values can be less than PeriodicStatistics.SampleSet.{i}.SampleInterval, for several reasons, including:

Any of the reasons for which PeriodicStatistics.SampleSet.{i}.SampleSeconds values might be less than PeriodicStatistics.SampleSet.{i}.SampleInterval.
The parameter doesn't exist, or was created or deleted during a sample interval.
<Empty> 1.0 TR-157
SuspectData unsignedInt​[]​(:1) list of unsignedInt​(:1) -

Comma-separated list of unsigned integers (value 0 to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval.

For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1.

<Empty> 1.0 TR-157
Values string​[] list of string -

Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval.

The statistics values in this comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.

If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.

<Empty> 1.0 TR-157
Failures unsignedInt unsignedInt -

Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the “in range” state to the “out of range” state, or between the “out of range (low)” and “out of range (high)” states. The states are defined as follows:

Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment.

This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in [Section 3.2.1/TR-069a2].

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
Device.​DownloadAvailability. object object​[1:1] - This object contains multicast announcement and query parameters used for the purpose of downloading files. - 1.0 TR-157
Device.​DownloadAvailability.​Announcement. object object​[1:1] - This object contains multicast announcement parameters used to download files. - 1.0 TR-157
Enable boolean boolean W Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files. - 1.0 TR-157
Status string string -

The status of the announcement service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)
- 1.0 TR-157
GroupNumberOfEntries unsignedInt unsignedInt - Number of entries in the Group table. - 1.0 TR-157
Device.​DownloadAvailability.​Announcement.​Group.​{i}. object​[0:] object​[0:∞] W

Multicast groups to which the CPE SHOULD listen for announcements.

At most one enabled entry in this table can exist with a given value for URL.

- 1.0 TR-157
Enable boolean boolean W Enable/disable listening to this multicast group. false 1.0 TR-157
Status string string -

The status of this group table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to parse received announcements, OPTIONAL)
"Disabled" 1.0 TR-157
URL string​(256) string​(256) W

URL [RFC3986] encoding the group address, source and port on which to listen, and other protocol information, e.g. expected announcement format.

Depending on the application, the messages identified by this URL MAY directly contain the data to be downloaded, or alternatively MAY contain information informing the CPE how to obtain the data to be downloaded via a separate mechanism, which itself could involve a unicast or a multicast download protocol.

Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SAP [RFC2974] stream that indicates how to use either FLUTE [RFC3926] or DSM-CC [ISO-13818-6:1998] to perform the download.

<Empty> 1.0 TR-157
Device.​DownloadAvailability.​Query. object object​[1:1] - This object contains multicast query parameters used to download files. - 1.0 TR-157
Enable boolean boolean W Enable/disable CPE ability to autonomously query a server for the purpose of downloading files. - 1.0 TR-157
Status string string -

The status of the query service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to contact query response server, OPTIONAL)
- 1.0 TR-157
URL string​(256) string​(256) W

URL [RFC3986] of the query response server.

Depending on the application, the protocol described by this URL MAY be a SOAP interface, or MAY be any other RPC mechanism.

Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS.

- 1.0 TR-157

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.DeviceInfo.MemoryStatus.
Free
Device.DeviceInfo.ProcessStatus.
CPUUsage
Device.DeviceInfo.ProcessStatus.Process.{i}.
Size
Device.DeviceInfo.ProcessStatus.Process.{i}.
CPUTime
Device.DeviceInfo.ProcessStatus.Process.{i}.
State
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.
Value
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.
LastUpdate
Device.ManagementServer.
ParameterKey
Device.Time.
CurrentLocalTime
Device.UserInterface.LocalDisplay.
PosX
Device.UserInterface.LocalDisplay.
PosY
Device.UserInterface.LocalDisplay.
Width
Device.UserInterface.LocalDisplay.
Height
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
Device.DownloadDiagnostics.
DiagnosticsState
Device.DownloadDiagnostics.
ROMTime
Device.DownloadDiagnostics.
BOMTime
Device.DownloadDiagnostics.
EOMTime
Device.DownloadDiagnostics.
TestBytesReceived
Device.DownloadDiagnostics.
TotalBytesReceived
Device.DownloadDiagnostics.
TCPOpenRequestTime
Device.DownloadDiagnostics.
TCPOpenResponseTime
Device.UploadDiagnostics.
DiagnosticsState
Device.UploadDiagnostics.
ROMTime
Device.UploadDiagnostics.
BOMTime
Device.UploadDiagnostics.
EOMTime
Device.UploadDiagnostics.
TotalBytesSent
Device.UploadDiagnostics.
TCPOpenRequestTime
Device.UploadDiagnostics.
TCPOpenResponseTime
Device.UDPEchoConfig.
PacketsReceived
Device.UDPEchoConfig.
PacketsResponded
Device.UDPEchoConfig.
BytesReceived
Device.UDPEchoConfig.
BytesResponded
Device.UDPEchoConfig.
TimeFirstPacketReceived
Device.UDPEchoConfig.
TimeLastPacketReceived
Device.SmartCardReader.{i}.
DecryptionFailedCounter
Device.SmartCardReader.{i}.
DecryptionFailedNoKeyCounter
Device.SelfTestDiagnostics.
DiagnosticsState
Device.SelfTestDiagnostics.
Results
Device.NSLookupDiagnostics.
DiagnosticsState
Device.NSLookupDiagnostics.
SuccessCount
Device.NSLookupDiagnostics.
ResultNumberOfEntries
Device.NSLookupDiagnostics.Result.{i}.
Status
Device.NSLookupDiagnostics.Result.{i}.
AnswerType
Device.NSLookupDiagnostics.Result.{i}.
HostNameReturned
Device.NSLookupDiagnostics.Result.{i}.
IPAddresses
Device.NSLookupDiagnostics.Result.{i}.
DNSServerIP
Device.NSLookupDiagnostics.Result.{i}.
ResponseTime
Device.PeriodicStatistics.SampleSet.{i}.
SampleSeconds
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SampleSeconds
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SuspectData
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Values

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

Download:1 Profile

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

Name Requirement
Device.​Capabilities.​PerformanceDiagnostic. P
DownloadTransports R
Device.​DownloadDiagnostics. P
DiagnosticsState W
Interface W
DownloadURL W
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestBytesReceived R
TotalBytesReceived R

DownloadTCP:1 Profile

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

Name Requirement
Device.​DownloadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

Upload:1 Profile

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

Name Requirement
Device.​Capabilities.​PerformanceDiagnostic. P
UploadTransports R
Device.​UploadDiagnostics. P
DiagnosticsState W
Interface W
UploadURL W
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestFileLength R
TotalBytesSent R

UploadTCP:1 Profile

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

Name Requirement
Device.​UploadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

UDPEcho:1 Profile

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

Name Requirement
Device.​UDPEchoConfig. P
Enable W
Interface W
SourceIPAddress W
UDPPort W
PacketsReceived R
PacketsResponded R
BytesReceived R
BytesResponded R
TimeFirstPacketReceived R
TimeLastPacketReceived R
EchoPlusSupported R

UDPEchoPlus:1 Profile

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

Name Requirement
Device.​UDPEchoConfig. P
EchoPlusEnabled W

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

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

MemoryStatus:1 Profile

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

Name Requirement
Device.​DeviceInfo.​MemoryStatus. P
Total R
Free R

ProcessStatus:1 Profile

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

Name Requirement
Device.​DeviceInfo.​ProcessStatus. P
CPUUsage R
ProcessNumberOfEntries R
Device.​DeviceInfo.​ProcessStatus.​Process.​{i}. P
PID R
Command R
Size R
Priority R
CPUTime R
State R

TempStatus:1 Profile

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

Name Requirement
Device.​DeviceInfo.​TemperatureStatus. P
TemperatureSensorNumberOfEntries R
Device.​DeviceInfo.​TemperatureStatus.​TemperatureSensor.​{i}. P
Enable W
Status R
ResetTime R
Name R
Value R
LastUpdate R
MinValue R
MinTime R
MaxValue R
MaxTime R

TempStatusAdv:1 Profile

The TempStatusAdv:1 profile for the Device:1 data model is defined as the union of the TempStatus:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:1.3.

Name Requirement
Device.​DeviceInfo.​TemperatureStatus.​TemperatureSensor.​{i}. P
Reset W
LowAlarmValue W
LowAlarmTime R
HighAlarmValue W
HighAlarmTime R

AutonXferComplPolicy:1 Profile

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

Name Requirement
Device.​ManagementServer.​AutonomousTransferCompletePolicy. P
Enable W
TransferTypeFilter W
FileTypeFilter W

User:1 Profile

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

Name Requirement
Device. P
UserNumberOfEntries R
Device.​User.​{i}. C
Enable W
Username W
Password W

UPnPDev:1 Profile

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

Name Requirement
Device.​UPnP. P
Device.​UPnP.​Device. P
Enable W
UPnPMediaServer W
UPnPMediaRenderer W
UPnPWLANAccessPoint W
UPnPQoSDevice W
UPnPQoSPolicyHolder W
UPnPIGD W
Device.​UPnP.​Device.​Capabilities. P
UPnPArchitecture R
UPnPMediaServer R
UPnPMediaRenderer R
UPnPWLANAccessPoint R
UPnPBasicDevice R
UPnPQoSDevice R
UPnPQoSPolicyHolder R
UPnPIGD R

UPnPDiscBasic:1 Profile

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

Name Requirement
Device.​UPnP. P
Device.​UPnP.​Discovery. P
RootDeviceNumberOfEntries R
Device.​UPnP.​Discovery.​RootDevice.​{i}. P
Status R
UUID R
USN R
LeaseTime R
Location R
Server R

UPnPDiscAdv:1 Profile

The UPnPDiscAdv:1 profile for the Device:1 data model is defined as the union of the UPnPDiscBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:1.3.

Name Requirement
Device.​UPnP.​Discovery. P
DeviceNumberOfEntries R
ServiceNumberOfEntries R
Device.​UPnP.​Discovery.​Device.​{i}. P
Status R
UUID R
USN R
LeaseTime R
Location R
Server R
Device.​UPnP.​Discovery.​Service.​{i}. P
Status R
USN R
LeaseTime R
Location R
Server R

SelfTestDiag:1 Profile

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

Name Requirement
Device.​SelfTestDiagnostics. P
DiagnosticsState W
Results R

NSLookupDiag:1 Profile

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

Name Requirement
Device.​NSLookupDiagnostics. P
DiagnosticsState W
Interface W
HostName W
DNSServer W
Timeout W
NumberOfRepetitions W
SuccessCount R
ResultNumberOfEntries R
Device.​NSLookupDiagnostics.​Result.​{i}. P
Status R
AnswerType R
HostNameReturned R
IPAddresses R
DNSServerIP R
ResponseTime R

SimpleFirewall:1 Profile

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

Name Requirement
Device.​Firewall. P
Config W
Version R
LastChange R

USBHostsBasic:1 Profile

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

Name Requirement
Device.​USBHosts. P
HostNumberOfEntries R
Device.​USBHosts.​Host.​{i}. P
Enable W
Name R
Type R
USBVersion R
DeviceNumberOfEntries R
Device.​USBHosts.​Host.​{i}.​Device.​{i}. P
DeviceNumber R
USBVersion R
DeviceClass R
DeviceSubClass R
DeviceVersion R
DeviceProtocol R
ProductID R
VendorID R
Manufacturer R
ProductClass R
SerialNumber R
Port R
Rate R
Parent R
MaxChildren R

USBHostsAdv:1 Profile

The USBHostsAdv:1 profile for the Device:1 data model is defined as the union of the USBHostsBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:1.3.

Name Requirement
Device.​USBHosts.​Host.​{i}. P
Reset W
PowerManagementEnable W
Device.​USBHosts.​Host.​{i}.​Device.​{i}. P
IsSuspended R
IsSelfPowered R
ConfigurationNumberOfEntries R
Device.​USBHosts.​Host.​{i}.​Device.​{i}.​Configuration.​{i}. P
ConfigurationNumber R
InterfaceNumberOfEntries R
Device.​USBHosts.​Host.​{i}.​Device.​{i}.​Configuration.​{i}.​Interface.​{i}. P
InterfaceNumber R
InterfaceClass R
InterfaceSubClass R
InterfaceProtocol R

PeriodicStatsBase:1 Profile

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

Name Requirement
Device.​PeriodicStatistics. P
MinSampleInterval R
MaxReportSamples R
SampleSetNumberOfEntries R
Device.​PeriodicStatistics.​SampleSet.​{i}. C
Name W
SampleInterval W
ReportSamples W
ReportStartTime R
ReportEndTime R
SampleSeconds R
ParameterNumberOfEntries R
Device.​PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. C
Reference W
SampleSeconds R
SuspectData R
Values R

PeriodicStatsAdv:1 Profile

The PeriodicStatsAdv:1 profile for the Device:1 data model is defined as the union of the PeriodicStatsBase:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:1.3.

Name Requirement
Device.​PeriodicStatistics.​SampleSet.​{i}. C
Enable W
Status R
TimeReference W
FetchSamples W
ForceSample W
Device.​PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. C
Enable W
SampleMode W
CalculationMode W
LowThreshold W
HighThreshold W
Failures R

DownloadAnnounce:1 Profile

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

Name Requirement
Device.​DownloadAvailability. P
Device.​DownloadAvailability.​Announcement. P
Enable W
Status R
GroupNumberOfEntries R
Device.​DownloadAvailability.​Announcement.​Group.​{i}. C
Enable W
Status R
URL W

DownloadQuery:1 Profile

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

Name Requirement
Device.​DownloadAvailability. P
Device.​DownloadAvailability.​Query. P
Enable W
Status R
URL W


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