Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:1.8 Root Object definition
tr-181-1-1-0.xml

License

Copyright (c) 2010-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Summary

TR-181 Issue 1 Amendment 1

Table of Contents

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
Alias string(64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

The IEEE EUI 64-bit identifier as defined in [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

  • The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
  • The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.

Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){7}([0-9A-Fa-f][0-9A-Fa-f])
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.

IPPrefix string(49)

IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation [RFC4632]. This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

  • IPv4 example: 192.168.1.0/24
  • IPv6 example: 2001:edff:fe6a:f76::/64

If the IP address part is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n".

If the entire IP prefix is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition.

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

Can be any IPv4 address that is permitted by the IPAddress data type.

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type.

IPv6Address IPAddress(45)

IPv6 address.

Can be any IPv6 address that is permitted by the IPAddress data type.

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.

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])
StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

UUID string(36:36)

Universally Unique Identifier. See [RFC4122]. Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}
ZigBeeNetworkAddress string(4)

The ZigBee 16-bit network address (NWK) as defined in [ZigBee2007]. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f]){4}
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.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[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.

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
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.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

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

References

[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-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Firewall] ICSA Modular Firewall Certification Criteria, Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0, ICSA Labs.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[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.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069, CPE WAN Management Protocol, Broadband Forum, 2004.
[TR-069a1] TR-069 Amendment 1, CPE WAN Management Protocol, Broadband Forum, 2006.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, 2007.
[TR-069a3] TR-069 Amendment 3, CPE WAN Management Protocol, Broadband Forum, 2010.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-106] TR-106, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2005.
[TR-106a1] TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2006.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2008.
[TR-106a3] TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2009.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2010.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2011.
[TR-143] TR-143, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, 2008.
[TR-157] TR-157, Component Object for CWMP, Broadband Forum, March 2009.
[TR-157a3] TR-157 Amendment 3, Component Objects for CWMP, Broadband Forum, 2010.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[UPnP-DM:1] UPnP Device Management:1, UPnP Device Management v1.
[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.
[Z-Wave] Z-Wave, Z-Wave website.
[ZigBee] ZigBee, ZigBee Alliance website.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

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

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

See [Section 3.7/TR-106].

This parameter is DEPRECATED because DeviceInfo.SupportedDataModel and associated Device Type XML documents (DT Instances) provide a more granular and scalable way of describing the device's data model.

Therefore its value MAY be an empty string if (and only if) DeviceInfo.SupportedDataModel is supported.

- 1.0
UserNumberOfEntries unsignedInt - The number of entries in the User table. - 1.3
SmartCardReaderNumberOfEntries unsignedInt - The number of entries in the SmartCardReader table. - 1.3
Device.Services. object - This object contains general services information. - 1.0
Device.Capabilities. object - 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.2
Device.Capabilities.PerformanceDiagnostic. object - The capabilities of the Performance Diagnostics (DownloadDiagnostics and UploadDiagnostics) for the device. - 1.2
DownloadTransports string -

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

- 1.2
UploadTransports string -

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

- 1.2
Device.DeviceInfo. object - This object contains general device information. - 1.0
Manufacturer string­(64) - The manufacturer of the CPE (human readable string). - 1.0
ManufacturerOUI string­(6) -

Organizationally unique identifier of the device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. The value MUST be a valid OUI as defined in [OUI].

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

Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

- 1.0
ModelName string­(64) - Model name of the CPE (human readable string). - 1.0
Description string­(256) - A full description of the CPE device (human readable string). - 1.0
ProductClass string­(64) -

Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique.

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

Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

- 1.0
SerialNumber string­(64) -

Serial number of the CPE.

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

Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

- 1.0
VendorConfigFileNumberOfEntries unsignedInt - The number of entries in the VendorConfigFile table. - 1.5
HardwareVersion string­(64) - A string identifying the particular CPE model and version. - 1.0
SoftwareVersion 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
EnabledOptions string­(1024) -

This parameter is DEPRECATED because the "voucher mechanism", as defined in [Annex C/TR-069a3] is deprecated in favor of the "Software Module Management mechanism" as described in [Appendix II/TR-157a3].

Comma-separated list (maximum list length 1024) of strings. The OptionName of each is identical to the OptionName element of the OptionStruct described in [TR-069a3]. Only those options are listed whose State indicates the option is enabled.

- 1.0
AdditionalHardwareVersion string­(64) - Comma-separated list (maximum list length 64) of strings. A comma-separated list of any additional versions. Represents any additional hardware version information the vendor might wish to supply. - 1.0
AdditionalSoftwareVersion string­(64) - Comma-separated list (maximum list length 64) of strings. A comma-separated list of any additional versions. Represents any additional software version information the vendor might wish to supply. - 1.0
ProvisioningCode string­(64) W Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. - 1.0
DeviceStatus string -

Current operational status of the device. Enumeration of:

- 1.0
UpTime unsignedInt - Time in seconds since the CPE was last restarted. - 1.0
FirstUseDate 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
DeviceLog string­(32768) - Vendor-specific log(s). - 1.0
SupportedDataModelNumberOfEntries unsignedInt - The number of entries in the SupportedDataModel table. - 1.4
ProcessorNumberOfEntries unsignedInt - The number of entries in the Processor table. - 1.7
VendorLogFileNumberOfEntries unsignedInt - The number of entries in the VendorLogFile table. - 1.7
Device.DeviceInfo.MemoryStatus. object - Status of the device's volatile physical memory. - 1.3
Total unsignedInt - The total physical RAM, in kilobytes, installed on the device. - 1.3
Free unsignedInt - The free physical RAM, in kilobytes, currently available on the device. - 1.3
Device.DeviceInfo.ProcessStatus. object - Status of the processes on the device. - 1.3
CPUUsage 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.3
ProcessNumberOfEntries unsignedInt -

The 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.3
Device.DeviceInfo.ProcessStatus.Process.{i}. object -

List of all processes running on the device.

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

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

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

- 1.3
Device.DeviceInfo.TemperatureStatus. object - Status of the temperature of the device. - 1.3
TemperatureSensorNumberOfEntries unsignedInt - The number of entries in the TemperatureSensor table. - 1.3
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object -

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, or with a given value for Alias.

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable boolean W Indicates whether or not the temperature sensor is enabled. - 1.3
Status 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.3
Reset boolean W

When set to true, resets the temperature sensor.

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

- 1.3
ResetTime 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.3
Name string­(256) - Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 1.3
Value 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.3
LastUpdate 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.3
MinValue 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.3
MinTime 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.3
MaxValue 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.3
MaxTime 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.3
LowAlarmValue 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.

A change to this value will cause LowAlarmTime to be reset.

- 1.3
LowAlarmTime 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.3
HighAlarmValue 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.

A change to this value will cause HighAlarmTime to be reset.

- 1.3
PollingInterval unsignedInt W

The interval, measured in seconds, in which the device polls this TemperatureSensor.

If the value is 0 then the device selects its own polling interval.

If the value is greater than 0 then the device MUST use this value as the polling interval.

- 1.7
HighAlarmTime 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.3
Device.DeviceInfo.NetworkProperties. object - This object defines the parameters that describe how the device handles network traffic. - 1.3
MaxTCPWindowSize 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.3
TCPImplementation 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.3
Device.DeviceInfo.SupportedDataModel.{i}. object -

This table contains details of the device's Current Supported Data Model.

The table MUST describe the device's entire Supported Data Model. Therefore, if a device's Supported Data Model changes at run-time, entries will need to be added or removed as appropriate.

Each table entry MUST refer to only a single Root Object or Service Object. The device MAY choose to use more than one table entry for a given Root Object or Service Object.

Considering that every device has some form of a data model, this table MUST NOT be empty.

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

- 1.4
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
URL string­(256) -

URL ([RFC3986]) that describes some or all of the device's Current Supported Data Model.

The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model.

The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in [Annex B/TR-106a3], including any additional normative requirements referenced within the Schema.

The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that, if the same XML file is to be used for multiple CPE, this strongly suggests that the XML file referenced by this URL should never change.

The URL MAY permit the XML file to be accessed at run-time, in which case, the XML file MAY be located within the CPE.

Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.

- 1.4
URN string­(256) -

URN ([RFC3986]) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry.

For example, if this table entry references a DT Instance that refers to the Device:1.3 Root Object, the value of this parameter would be urn:broadband-forum-org:tr-157-1-0-0, because TR-157 defines Device:1.3. If the DT Instance instead referred to a vendor-specific Root Object, e.g. X_EXAMPLE_Device:1.0 (derived from Device:1.3), the value of this parameter would be something like urn:example-com:device-1-0-0.

- 1.4
Features string -

Comma-separated list of strings. This parameter MUST list exactly the features that are defined using the top-level feature element in the DT Instance referenced by URL.

For example, if the DT instance specified the following:

<feature name="DNSServer"/>
<feature name="Router"/>
<feature name="X_MyDeviceFeature"/>

then the value of this parameter might be DNSServer,Router,X_MyDeviceFeature. The order in which the features are listed is not significant.

- 1.4
Device.DeviceInfo.VendorConfigFile.{i}. object -

Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File.

This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way.

Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table. If the name of the file (determined as described in the definition of the Name parameter) differs from that of any existing instance, then the CPE MUST create a new instance to represent this file. If instead, the name of the file is identical to that of an existing instance, then the CPE MUST update the content of the existing instance with the new version, date, and (optionally) description of the file.

- 1.5
Name string­(64) -

Name of the vendor configuration file.

If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name.

Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name.

Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file.

- 1.5
Version string­(16) -

A string identifying the configuration file version currently used in the CPE.

If the CPE is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value.

Otherwise, the value of this parameter MUST be an empty string.

- 1.5
Date dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 1.5
Description string­(256) - A description of the vendor configuration file (human-readable string). - 1.5
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Device.DeviceInfo.Processor.{i}. object -

Each table entry represents a hardware or virtual processor that resides on this device.

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

- 1.7
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Architecture string -

The architecture of the processor on the underlying hardware. Enumeration of:

For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].

- 1.7
Device.DeviceInfo.VendorLogFile.{i}. object -

Each table entry represents a Vendor Log File.

This table of log files is informational only and does not allow the ACS to operate on these files in any way.

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

- 1.7
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.7
Name string­(64) -

Name of the log file.

Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism.

- 1.7
MaximumSize unsignedInt - The maximum size of the log file in bytes. If the device doesn’t know the maximum file size then MaximumSize will be 0. - 1.7
Persistent boolean -

When true, the log file contents are preserved across a device reboot.

When false, the log file contents will be purged when the device is rebooted.

- 1.7
Device.DeviceInfo.ProxierInfo. object - Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.1.1/TR-069a4]. - 1.8
ManufacturerOUI string­(6:6) -

Organizationally unique identifier of the associated CPE Proxier. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

The value MUST be a valid OUI as defined in [OUI].

- 1.8
ProductClass string­(64) -

Identifier of the class of product of the associated CPE Proxier for which the serial number applies.

An empty string indicates either that the CPE Proxier does not use a product class to differentiate its serial number.

- 1.8
SerialNumber string­(64) - Serial number of the associated CPE Proxier. - 1.8
ProxyProtocol string­(64) -

The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

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

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

Enables and disables the CPE's support for CWMP.

false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS.

true means that CWMP support on the CPE is enabled.

The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true.

The factory default value MUST be true.

- 1.5
URL string­(256) W

URL, as defined in [RFC3986], for the CPE to connect to the ACS using the CPE WAN Management Protocol.

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

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

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

- 1.0
Username string­(256) W

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

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

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

- 1.0
Password string­(256) W

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

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

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

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

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

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

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

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

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

The Unknown Time value defined in [Section 3.2/TR-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
ParameterKey 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
ConnectionRequestURL 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
ConnectionRequestUsername string­(256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 1.0
ConnectionRequestPassword string­(256) W

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

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

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

- 1.0
UpgradesManaged boolean W

Indicates whether or not the ACS will manage upgrades for the CPE. If true, the CPE SHOULD NOT use other means other than the ACS to seek out available upgrades. If false, the CPE MAY use other means for this purpose.

Note that an autonomous upgrade (reported via an "10 AUTONOMOUS TRANSFER COMPLETE" Inform Event code) SHOULD be regarded as a managed upgrade if it is performed according to ACS-specified policy.

- 1.0
KickURL string­(256) -

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

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

- 1.0
DownloadProgressURL string­(256) -

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
DefaultActiveNotificationThrottle unsignedInt W

This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification.

In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met.

The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection.

The time of the last session completion does not need to be tracked across reboots.

- 1.5
CWMPRetryMinimumWaitInterval unsignedInt­[1:65535] W

Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2].

A value of 5 corresponds to the default behavior that is described in [TR-069a2].

The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

- 1.5
CWMPRetryIntervalMultiplier unsignedInt­[1000:65535] W

Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2].

This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.

A value of 2000 corresponds to the default behavior that is described in [TR-069a2].

The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.

- 1.5
UDPConnectionRequestAddress 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.1
UDPConnectionRequestAddressNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled). - 1.1
STUNEnable boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 1.1
STUNServerAddress string­(256) W

Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable.

If is an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL.

- 1.1
STUNServerPort unsignedInt­[0:65535] W

Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable.

By default, this SHOULD be the equal to the default STUN port, 3478.

- 1.1
STUNUsername string­(256) W

If is not an empty string, the value of the STUN USERNAME attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server).

If is an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity.

- 1.1
STUNPassword string­(256) W

The value of the STUN Password to be used in computing the MESSAGE-INTEGRITY attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server).

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

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

- 1.1
STUNMaximumKeepAlivePeriod int­[-1:] W

If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port.

A value of -1 indicates that no maximum period is specified.

- 1.1
STUNMinimumKeepAlivePeriod unsignedInt W If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489]. - 1.1
NATDetected 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.1
AliasBasedAddressing boolean -

Indicates whether or not the Alias-Based Addressing Mechanism is supported.

A true value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4].

- 1.8
InstanceMode string W

Instance identification mode as defined in [Section 3.6.1/TR-069a4]. When AliasBasedAddressing is true, InstanceMode is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. Enumeration of:

This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be InstanceNumber.

- 1.8
AutoCreateInstances boolean W

Enable or disable the Auto-Create Instance Mechanism. When AliasBasedAddressing is true, AutoCreateInstances indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in [A.3.2.1/TR-069a4]).

  • A true value indicates that the CPE will perform auto-creation of instances when the Alias-Based Addressing Mechanism is used in SetParameterValues RPC.
  • A false value indicates that the CPE will not create new object instances. Instead, it will reject the setting of parameters in unrecognized instances and respond with a fault code.

This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be false.

- 1.8
Device.ManagementServer.AutonomousTransferCompletePolicy. object -

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.3
Enable boolean W Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS. - 1.3
TransferTypeFilter 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.3
ResultTypeFilter string W

Indicates the transfer results that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer results omitted from this list MUST NOT be included when the CPE notifies the ACS.

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. Enumeration of:

  • Success (The autonomous file transfer completed successfully; i.e., the FaultCode was zero)
  • Failure (The autonomous file transfer did not complete successfully; i.e., the FaultCode was non-zero)
  • Both (Success and Failure)
- 1.6
FileTypeFilter string­(1024) W

Comma-separated list (maximum list length 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.3
Device.ManagementServer.DUStateChangeComplPolicy. object -

This object allows configuration of CPE policy for notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in [TR-069a3].

The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of Deployment Unit state changes that were not specifically requested via CWMP.

- 1.7
Enable boolean W Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events to the ACS. - 1.7
OperationTypeFilter string W

Comma-separated list of strings. Indicates the Deployment Unit operations that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events.

Operation types not indicated by this list MUST NOT be included when the CPE notifies the ACS. An empty string is essentially the same as setting Enable to false. Each list item is an enumeration of:

- 1.7
ResultTypeFilter string W

Indicates the Deployment Unit state change results that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events. State change results omitted from this filter MUST NOT be included when the CPE notifies the ACS. Enumeration of:

  • Success (The autonomous state change completed successfully; i.e., the FaultCode was zero)
  • Failure (The autonomous state change did not complete successfully; i.e., the FaultCode was non-zero)
  • Both (All result types independent of Success or Failure)
- 1.7
FaultCodeFilter string W

Comma-separated list of strings. Indicates the Deployment Unit state change fault codes that MUST be included when the CPE notifies the ACS of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events. State change fault codes omitted from this filter MUST NOT be included when the CPE notifies the ACS.

This filter has no effect on the notification of a successful autonomous state change. This filter only applies when ResultTypeFilter is set to either Failure or Both. An empty string means that failed autonomous state changes will not be sent to the ACS. Each list item is an enumeration of:

- 1.7
Device.GatewayInfo. object - This object contains information associated with a connected Internet Gateway Device. - 1.0
ManufacturerOUI 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
ProductClass 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
SerialNumber 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
Device.Config. object - This object contains general configuration parameters. - 1.0
PersistentData string­(256) W Arbitrary user data that MUST persist across CPE reboots. - 1.0
ConfigFile string­(32768) W

A dump of the currently running configuration on the CPE. This parameter enables the ability to backup and restore the last known good state of the CPE. It returns a vendor-specific document that defines the state of the CPE. The document MUST be capable of restoring the CPE's state when written back to the CPE using SetParameterValues.

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
Device.Time. object - This object contains parameters relating an NTP or SNTP time client in the CPE. - 1.0
Enable boolean W Enables or disables the NTP or SNTP time client. - 1.5
Status string -

Status of Time support on the CPE. Enumeration of:

The Unsynchronized value indicates that the CPE's absolute time has not yet been set.

The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate.

The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

- 1.5
NTPServer1 string­(64) W First NTP timeserver. Either a host name or IP address. - 1.0
NTPServer2 string­(64) W Second NTP timeserver. Either a host name or IP address. - 1.0
NTPServer3 string­(64) W Third NTP timeserver. Either a host name or IP address. - 1.0
NTPServer4 string­(64) W Fourth NTP timeserver. Either a host name or IP address. - 1.0
NTPServer5 string­(64) W Fifth NTP timeserver. Either a host name or IP address. - 1.0
CurrentLocalTime dateTime - The current date and time in the CPE's local time zone. - 1.0
LocalTimeZone string­(256) W

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

EST+5 EDT,M4.1.0/2,M10.5.0/2
- 1.0
Device.UserInterface. object - This object contains parameters relating to the user interface of the CPE. - 1.0
PasswordRequired boolean W

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

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

- 1.0
PasswordUserSelectable boolean W

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

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

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

Un-encoded binary image size in bytes.

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

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

- 1.0
ISPMailServer string­(256) W The URL of the ISP's mail server. - 1.0
ISPNewsServer string­(256) W The URL of the ISP's news server. - 1.0
TextColor string­(6) W The color of text on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
BackgroundColor string­(6) W The color of the GUI screen backgrounds in RGB hexidecimal notation (e.g., FF0088). - 1.0
ButtonColor string­(6) W The color of buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
ButtonTextColor string­(6) W The color of text on buttons on the GUI screens in RGB hexidecimal notation (e.g., FF0088). - 1.0
AutoUpdateServer string­(256) W The server the CPE can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true. - 1.0
UserUpdateServer string­(256) W The server where a user can check via a web browser if an update is available for download to a PC. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true. - 1.0
AvailableLanguages string­(256) - Comma-separated list (maximum list length 256) of strings. Comma-separated list of user-interface languages that are available, where each language is specified according to RFC 3066 [RFC3066]. - 1.0
CurrentLanguage string­(16) W Current user-interface language, specified according to RFC 3066 [RFC3066]. - 1.0
Device.UserInterface.RemoteAccess. object -

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" table with at least one instance that has "RemoteAccessCapable" set to true.

- 1.3
Enable boolean W Enables/Disables remotely accessing the CPE’s user interface. - 1.3
Port unsignedInt­[:65535] W Destination TCP port required for remote access connection. - 1.3
SupportedProtocols 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.3
Protocol 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.3
Device.UserInterface.LocalDisplay. object - This object describes how to remotely manage the initial positioning of a user interface on a device's local display. - 1.3
Movable boolean W Controls whether the user is allowed to change the GUI window position on the local CPE's display. - 1.3
Resizable boolean W Controls whether the user is allowed to resize the GUI window on the local CPE's display. - 1.3
PosX 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.3
PosY 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.3
Width unsignedInt W The width of the user interface within the local CPE's display, expressed in pixels. - 1.3
Height unsignedInt W The height of the user interface within the local CPE's display, expressed in pixels. - 1.3
DisplayWidth unsignedInt - The width of the local CPE's display, expressed in pixels. - 1.3
DisplayHeight unsignedInt - The height of the local CPE's display, expressed in pixels. - 1.3
Device.LAN. object -

This object contains parameters relating to IP-based LAN connectivity of a device.

This object relates only to IP-layer LAN capabilities. Lower-layer aspects of LAN connectivity are not considered part of the common data model defined in this specification.

For a device that contains multiple IP interfaces, the scope of this object is limited to the default IP interface. Data that might be associated with other interfaces is not considered part of the common data model defined in this specification.

- 1.0
AddressingType string W

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

The ability to modify this parameter is OPTIONAL.

- 1.0
IPAddress string­(45) W

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

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

- 1.0
SubnetMask string­(45) W

[IPAddress] The current subnet mask.

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

- 1.0
DefaultGateway string W

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

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

- 1.0
DNSServers string­(256) W

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

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

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

- 1.0
MACAddress string­(17) W [MACAddress] The physical address of this interface. Writable only if MACAddressOverride is present and equal to true. - 1.0
MACAddressOverride boolean W

Whether the value of MACAddress parameter can be overridden.

  • When true, MACAddress is writable.
  • When false, MACAddress is not writable, and the default MAC address assigned by the device SHOULD be restored.
- 1.0
DHCPOptionNumberOfEntries unsignedInt - Number of entries in the DHCP option table. - 1.0
Device.LAN.DHCPOption.{i}. object 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.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 1.0
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Request boolean W

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

  • When true, this entry represents a request. In this case, the DHCP client MUST include the specified Tag in the Parameter Request List, as defined in RFC 2132. The Value parameter is ignored in this case.
  • When false, this entry represents a value to be sent by the DHCP client. In this case, the DHCP client MUST include a DHCP option formed from the Tag and Value parameters (with the Length derived from the length of the Value parameter).
- 1.0
Tag unsignedInt­[1:254] W Tag of the DHCP option as defined in RFC 2132. - 1.0
Value base64­(255) W Base64 encoded octet string to be used as the Value of the DHCP option if Request is false. <Empty> 1.0
Device.LAN.Stats. object - This object contains statistics for the default IP interface. - 1.0
ConnectionUpTime 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
TotalBytesSent unsignedInt - Total number of IP payload bytes sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0
TotalBytesReceived unsignedInt - Total number of IP payload bytes received over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0
TotalPacketsSent unsignedInt - Total number of IP packets sent over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0
TotalPacketsReceived unsignedInt - Total number of IP packets received over this interface since the device was last restarted as specified in DeviceInfo.UpTime. - 1.0
CurrentDayInterval 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
CurrentDayBytesSent 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
CurrentDayBytesReceived 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
CurrentDayPacketsSent unsignedInt - Total number of IP packets sent over this interface since the beginning of the current-day interval as specified by CurrentDayInterval. - 1.0
CurrentDayPacketsReceived unsignedInt - Total number of IP packets received over this interface since the beginning of the current-day interval as specified by CurrentDayInterval. - 1.0
QuarterHourInterval 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
QuarterHourBytesSent 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
QuarterHourBytesReceived 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
QuarterHourPacketsSent unsignedInt - Total number of IP packets sent over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval. - 1.0
QuarterHourPacketsReceived unsignedInt - Total number of IP packets received over this interface since the beginning of the quarter-hour interval as specified by QuarterHourInterval. - 1.0
Device.LAN.IPPingDiagnostics. object - This object defines access to an IP-layer ping test for the default IP interface. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

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
Host string­(256) W Host name or address of the host to ping. - 1.0
NumberOfRepetitions unsignedInt­[1:] W Number of repetitions of the ping test to perform before reporting the results. - 1.0
Timeout unsignedInt­[1:] W Timeout in milliseconds for the ping test. - 1.0
DataBlockSize unsignedInt­[1:65535] W Size of the data block in bytes to be sent for each ping. - 1.0
DSCP unsignedInt­[0:63] W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 1.0
SuccessCount unsignedInt - 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
FailureCount unsignedInt - Result parameter indicating the number of failed pings in the most recent ping test. - 1.0
AverageResponseTime 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
MinimumResponseTime 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
MaximumResponseTime 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
Device.LAN.TraceRouteDiagnostics. object - This object is defines access to an IP-layer trace-route test for the default IP interface. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

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

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.2
DiagnosticsState 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.2
Interface 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.2
DownloadURL 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.2
DSCP unsignedInt­[0:63] W

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

The default value SHOULD be zero.

- 1.2
EthernetPriority unsignedInt­[0:7] W

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

The default value SHOULD be zero.

- 1.2
ROMTime 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.2
BOMTime 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.2
EOMTime 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.2
TestBytesReceived unsignedInt - The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime, - 1.2
TotalBytesReceived unsignedInt - The total number of bytes received on the Interface between BOMTime and EOMTime. - 1.2
TCPOpenRequestTime 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.2
TCPOpenResponseTime 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.2
Device.UploadDiagnostics. object -

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.2
DiagnosticsState 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.2
Interface 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.2
UploadURL 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.2
DSCP unsignedInt­[0:63] W

DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

- 1.2
EthernetPriority unsignedInt­[0:7] W

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

The default value SHOULD be zero.

- 1.2
TestFileLength 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.2
ROMTime 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.2
BOMTime 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.2
EOMTime 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.2
TotalBytesSent unsignedInt - The total number of bytes sent on the Interface between BOMTime and EOMTime. - 1.2
TCPOpenRequestTime 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.2
TCPOpenResponseTime 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.2
Device.UDPEchoConfig. object - 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.2
Enable 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.2
Interface 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.2
SourceIPAddress string­(45) 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.2
UDPPort unsignedInt W The UDP port on which the UDP server MUST listen and respond to UDP echo requests. - 1.2
EchoPlusEnabled boolean W If true the CPE will perform necessary packet processing for UDP Echo Plus packets. - 1.2
EchoPlusSupported boolean - true if UDP Echo Plus is supported. - 1.2
PacketsReceived unsignedInt - Incremented upon each valid UDP echo packet received. - 1.2
PacketsResponded unsignedInt - Incremented for each UDP echo response sent. - 1.2
BytesReceived unsignedInt - The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled. - 1.2
BytesResponded unsignedInt - The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled. - 1.2
TimeFirstPacketReceived 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.2
TimeLastPacketReceived 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.2
Device.User.{i}. object W

This object contains parameters relating to the user characteristics.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable 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.3
RemoteAccessCapable boolean W Allows this user to remotely access the UserInterface via the mechanism defined in UserInterface.RemoteAccess. false 1.3
Username string­(64) W Name of the current user. MUST NOT be an empty string for an enabled entry. <Empty> 1.3
Password string­(64) W

The user's password.

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

- 1.3
Language 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.3
Device.UPnP. object - This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 1.3
Device.UPnP.Device. object - This object defines the UPnP devices and UPnP services that are implemented by the CPE. - 1.3
Enable boolean W Enables/Disables UPnP support. - 1.3
UPnPMediaServer boolean W Enables/Disables UPnP Media Server. - 1.3
UPnPMediaRenderer boolean W Enables/Disables UPnP Media Renderer. - 1.3
UPnPWLANAccessPoint boolean W Enables/Disables UPnP Wireless Access Point. - 1.3
UPnPQoSDevice boolean W Enables/Disables UPnP QoS Device. - 1.3
UPnPQoSPolicyHolder boolean W Enables/Disables UPnP QoS Policy Holder. - 1.3
UPnPIGD boolean W Enables/Disables UPnP IGD. - 1.3
UPnPDMBasicMgmt boolean W Enables/Disables UPnP-DM Basic Management. - 1.6
UPnPDMConfigurationMgmt boolean W Enables/Disables UPnP-DM Configuration Management. - 1.6
UPnPDMSoftwareMgmt boolean W Enables/Disables UPnP-DM Software Management. - 1.6
Device.UPnP.Device.Capabilities. object - This object defines what UPnP capabilities this device has. - 1.3
UPnPArchitecture unsignedInt -

Numeric value indicating the major version of the supported UPnP architecture.

If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 2.

A value of 0 indicates no UPnP support.

- 1.3
UPnPArchitectureMinorVer unsignedInt -

Numeric value indicating the minor version of the supported UPnP architecture.

If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 0.

If UPnPArchitecture is 0 then this parameter SHOULD be ignored.

- 1.6
UPnPMediaServer unsignedInt -

Numeric value indicating the supported revision for UPnP Media Server.

A value of 0 indicates no support.

- 1.3
UPnPMediaRenderer unsignedInt -

Numeric value indicating the supported revision for UPnP Media Renderer.

A value of 0 indicates no support.

- 1.3
UPnPWLANAccessPoint unsignedInt -

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

A value of 0 indicates no support.

- 1.3
UPnPBasicDevice unsignedInt -

Numeric value indicating the supported revision for UPnP Basic Device.

A value of 0 indicates no support.

- 1.3
UPnPQoSDevice unsignedInt -

Numeric value indicating the supported revision for UPnP Qos Device.

A value of 0 indicates no support.

- 1.3
UPnPQoSPolicyHolder unsignedInt -

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

A value of 0 indicates no support.

- 1.3
UPnPIGD unsignedInt -

Numeric value indicating the supported revision for UPnP IGD.

A value of 0 indicates no support.

- 1.3
UPnPDMBasicMgmt unsignedInt -

Numeric value indicating the supported revision for UPnP-DM Basic Management.

A value of 0 indicates no support.

- 1.6
UPnPDMConfigurationMgmt unsignedInt -

Numeric value indicating the supported revision for UPnP-DM Configuration Management.

A value of 0 indicates no support.

- 1.6
UPnPDMSoftwareMgmt unsignedInt -

Numeric value indicating the supported revision for UPnP-DM Software Management.

A value of 0 indicates no support.

- 1.6
Device.UPnP.Discovery. object -

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.3
RootDeviceNumberOfEntries unsignedInt - The number of entries in the RootDevice table. - 1.3
DeviceNumberOfEntries unsignedInt - The number of entries in the Device table. - 1.3
ServiceNumberOfEntries unsignedInt - The number of entries in the Service table. - 1.3
Device.UPnP.Discovery.RootDevice.{i}. object -

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.3
Status 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.3
UUID 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.3
USN 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.3
LeaseTime unsignedInt - The UPnP root device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.3
Location 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.3
Server 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.3
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings (maximum item length 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.3
Device.UPnP.Discovery.Device.{i}. object -

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.3
Status 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.3
UUID 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.3
USN 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.3
LeaseTime unsignedInt - The UPnP embedded device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.3
Location 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.3
Server 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.3
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings (maximum item length 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.3
Device.UPnP.Discovery.Service.{i}. object -

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.3
Status 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.3
USN 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.3
LeaseTime unsignedInt - The UPnP embedded service lease time in seconds, extracted from the CACHE-CONTROL header. - 1.3
Location 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.3
Server 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.3
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings (maximum item length 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.3
Device.DLNA. object - This object contains all DLNA related objects and parameters. - 1.3
Device.DLNA.Capabilities. object - DLNA capabilities. - 1.3
HNDDeviceClass string­(256) - Comma-separated list (maximum list length 256) of strings. Indicates the supported DLNA Home Network Device Classes [Table 4-1/DLNA-NDIG]. - 1.3
DeviceCapability string­(256) - Comma-separated list (maximum list length 256) of strings. Indicates the supported DLNA Device Capabilities [Table 4-2/DLNA-NDIG]. - 1.3
HIDDeviceClass string­(256) - Comma-separated list (maximum list length 256) of strings. Indicates the supported DLNA Home Infrastructure Device Classes [Table 4-4/DLNA-NDIG]. - 1.3
ImageClassProfileID string­(256) - Comma-separated list (maximum list length 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.3
AudioClassProfileID string­(256) - Comma-separated list (maximum list length 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.3
AVClassProfileID string­(256) - Comma-separated list (maximum list length 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.3
MediaCollectionProfileID string­(256) - Comma-separated list (maximum list length 256) of strings. Indicates the DLNA Media Collection Profile IDs supported by this device [Table 5-16/DLNA-NDIG]. - 1.3
PrinterClassProfileID string­(256) - Comma-separated list (maximum list length 256) of strings. Indicates the DLNA Printer Class Profile IDs supported by this device [Table 5-17/DLNA-NDIG]. - 1.3
Device.SmartCardReader.{i}. object -

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, or with a given value for Alias.

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable boolean W Enables or disables this smart card reader. - 1.3
Status 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.3
Name string­(256) - Human-readable name associated with this smart card reader. - 1.3
Reset 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.3
ResetTime 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.3
DecryptionFailedCounter 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.3
DecryptionFailedNoKeyCounter 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.3
Device.SmartCardReader.{i}.SmartCard. object - Status of currently associated smart card. - 1.3
Status 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.3
Type 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.3
Application 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.3
SerialNumber 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.3
ATR string­(1024) - The Smart Card answer to a reset action. Issued by the Smart Card upon reset. - 1.3
Device.SelfTestDiagnostics. object - This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 1.3
DiagnosticsState 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.3
Results string­(1024) - Results of self-test (vendor specific). - 1.3
Device.NSLookupDiagnostics. object -

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.3
DiagnosticsState 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.3
Interface 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.3
HostName 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.3
DNSServer 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.3
Timeout unsignedInt W Timeout in milliseconds that indicates that a request has failed. - 1.3
NumberOfRepetitions 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.3
SuccessCount unsignedInt - Number of successfully executed repetitions. - 1.3
ResultNumberOfEntries unsignedInt -

The number of entries in the Result table.

Total number of Result entries from the most recent invocation of the test.

- 1.3
Device.NSLookupDiagnostics.Result.{i}. object - Results from the most recent invocation of the test, one instance per repetition. - 1.3
Status string -

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

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

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

- 1.3
AnswerType string -

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

- 1.3
HostNameReturned 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.3
IPAddresses string - [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.3
DNSServerIP string­(45) - [IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used. - 1.3
ResponseTime unsignedInt - Response time (for the first response packet) in milliseconds, or 0 if no response was received. - 1.3
Device.Firewall. object - Firewall configuration object. - 1.3
Config 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-Residential]. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Low (All Outbound traffic and pinhole-defined Inbound traffic is allowed. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Off (All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings (if supported and enabled). If DoS and vulnerability protections are implemented [ICSA-Baseline], these are disabled)

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.3
Version 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.3
LastChange dateTime - The time at which the firewall settings most recently changed. - 1.3
Device.USBHosts. object -

This object models the CPE's USB Host controllers.

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

- 1.3
HostNumberOfEntries unsignedInt - The number of entries in the Host table. - 1.3
Device.USBHosts.Host.{i}. object -

Table of CPE USB Host controllers.

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

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable boolean W Enables or disables the USB Host controller. - 1.3
Name string­(64) - User-readable host controller name. - 1.3
Type 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.3
Reset 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.3
PowerManagementEnable 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.3
USBVersion string­(4) - USB specification version with which the controller complies. Example: "1.1" - 1.3
DeviceNumberOfEntries unsignedInt - The number of entries in the Device table. - 1.3
Device.USBHosts.Host.{i}.Device.{i}. object -

Table of connected USB devices.

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

- 1.3
DeviceNumber unsignedInt - Device number on USB bus. - 1.3
USBVersion string­(4) - USB specification version with which the device complies. Example: "1.1" - 1.3
DeviceClass 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.3
DeviceSubClass hexBinary­(1) - Subclass code (assigned by USB-IF). - 1.3
DeviceVersion unsignedInt­[:65535] - Device release number. - 1.3
DeviceProtocol hexBinary­(1) - Protocol code (assigned by USB-IF). - 1.3
ProductID unsignedInt­[:65535] - Product ID (assigned by manufacturer). - 1.3
VendorID unsignedInt­[:65535] - Vendor ID (assigned by USB-IF). - 1.3
Manufacturer string­(64) - Device Manufacturer string descriptor. - 1.3
ProductClass string­(64) - Device Product Class string descriptor. - 1.3
SerialNumber string­(64) - Device SerialNumber string descriptor. - 1.3
Port unsignedInt­[:255] -

Hub port on parent device.

0 when no parent.

- 1.3
Rate 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.3
Parent string -

The value MUST be the Path Name of a row in the Device 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).

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

- 1.3
MaxChildren unsignedInt - Number of ports. Only applies for hub device, equal to 0 for other devices. - 1.3
IsSuspended 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.3
IsSelfPowered 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.3
ConfigurationNumberOfEntries unsignedInt - The number of entries in the Configuration table. - 1.3
Device.USBHosts.Host.{i}.Device.{i}.Configuration.{i}. object -

Table of device configurations.

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

- 1.3
ConfigurationNumber unsignedInt - The identifier for each Device Configuration. - 1.3
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 1.3
Device.USBHosts.Host.{i}.Device.{i}.Configuration.{i}.Interface.{i}. object -

Table of device interface descriptors.

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

- 1.3
InterfaceNumber unsignedInt­[:255] - Number of this interface (from USB interface descriptor). - 1.3
InterfaceClass 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.3
InterfaceSubClass hexBinary­(1) - Subclass code (assigned by USB-IF). - 1.3
InterfaceProtocol hexBinary­(1) - Protocol code (assigned by USB-IF). - 1.3
Device.PeriodicStatistics. object -

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.3
MinSampleInterval unsignedInt -

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

A value of 0 indicates no specific minimum sample interval.

- 1.3
MaxReportSamples 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.3
SampleSetNumberOfEntries unsignedInt - The number of entries in the SampleSet table. - 1.3
Device.PeriodicStatistics.SampleSet.{i}. object W

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable 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.3
Status 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.3
Name string­(128) W The name of this sample set, which uniquely distinguishes each sample set. <Empty> 1.3
SampleInterval 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.3
ReportSamples 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.3
TimeReference 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.3
FetchSamples 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.3
ForceSample 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.3
ReportStartTime dateTime - The absolute time at which the sample interval for the first stored sample (for each statistic) started. <Empty> 1.3
ReportEndTime 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.3
SampleSeconds string -

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.3
ParameterNumberOfEntries unsignedInt - The number of entries in the Parameter table. 0 1.3
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object 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 entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable boolean W Enables or disables this object instance. false 1.3
Reference 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.3
SampleMode 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.3
CalculationMode 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.3
LowThreshold 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.3
HighThreshold 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.3
SampleSeconds string -

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.3
SuspectData string -

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.3
Values 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.3
Failures 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.3
Device.DownloadAvailability. object - This object contains multicast announcement and query parameters used for the purpose of downloading files. - 1.3
Device.DownloadAvailability.Announcement. object - This object contains multicast announcement parameters used to download files. - 1.3
Enable boolean W Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files. - 1.3
Status 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.3
GroupNumberOfEntries unsignedInt - The number of entries in the Group table. - 1.3
Device.DownloadAvailability.Announcement.Group.{i}. object W

Multicast groups to which the CPE SHOULD listen for announcements.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

- 1.3
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.8
Enable boolean W Enable/disable listening to this multicast group. false 1.3
Status 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.3
URL 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.3
Device.DownloadAvailability.Query. object - This object contains multicast query parameters used to download files. - 1.3
Enable boolean W Enable/disable CPE ability to autonomously query a server for the purpose of downloading files. - 1.3
Status 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.3
URL 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.3
Device.SoftwareModules. object - Top level object for dynamically managed software applications. - 1.7
ExecEnvNumberOfEntries unsignedInt - The number of entries in the ExecEnv table. - 1.7
DeploymentUnitNumberOfEntries unsignedInt - The number of entries in the DeploymentUnit table. - 1.7
ExecutionUnitNumberOfEntries unsignedInt - The number of entries in the ExecutionUnit table. - 1.7
Device.SoftwareModules.ExecEnv.{i}. object -

The Execution Environments that are available on the device, along with their properties and configurable settings.

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

- 1.7
Enable boolean W

Indicates whether or not this ExecEnv is enabled.

Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it.

When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to Idle.

If a ChangeDUState is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that ChangeDUState operation fails and the associated DUStateChangeComplete RPC will contain a FaultStruct for that operation.

If a SetParameterValues is attempted against the ExecutionUnit.{i}.RequestedState for an ExecutionUnit that is associated with a disabled ExecEnv a CWMP Fault will be issued in response.

Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and the ACS disabled it, the CWMP management agent might be terminated leaving the device unmanageable.

- 1.7
Status string -

Indicates the status of this ExecEnv. Enumeration of:

- 1.7
Reset boolean W

Setting this parameter to true causes this ExecEnv to revert back to the state it was in when the device last issued a "0 BOOTSTRAP" Inform event. The following requirements dictate what MUST happen for the reset to be complete:

  1. All Deployment Units that were installed after the last "0 BOOTSTRAP" Inform event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last "0 BOOTSTRAP" Inform event was issued
  4. Any Deployment Unit that was present when the last "0 BOOTSTRAP" Inform event was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last "0 BOOTSTRAP" Inform event was issued
  5. The Execution Environment MUST be restored to the version and configuration present when the last "0 BOOTSTRAP" Inform event was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met

The value of this parameter is not part of the device configuration and is always false when read.

- 1.7
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.7
Name string­(32) - A Name provided by the CPE that adequately distinguishes this ExecEnv from all other ExecEnv instances. - 1.7
Type string­(64) - Indicates the complete type and specification version of this ExecEnv. - 1.7
InitialRunLevel unsignedInt­[:65535] W

The run level that this ExecEnv will be in upon startup (whether that is caused by a CPE Boot or the Execution Environment starting).

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this ExecEnv.

- 1.7
RequestedRunLevel int­[-1:65535] W

Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this parameter's value will change the value of the CurrentRunLevel.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this ExecEnv.

The value of this parameter is not part of the device configuration and is always -1 when read.

- 1.7
CurrentRunLevel int­[-1:65535] -

The run level that this ExecEnv is currently operating in. This value is altered by changing the RequestedRunLevel parameter.

Upon startup (whether that is caused by a CPE Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or RequestedRunLevel will not impact the Run Level of this ExecEnv.

- 1.7
Vendor string­(128) - The vendor that produced this ExecEnv. - 1.7
Version string­(32) - The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification. - 1.7
ParentExecEnv string -

The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the parent ExecEnv of this ExecEnv.

If this value is an empty string then this is the Primary Execution Environment.

- 1.7
AllocatedDiskSpace int­[-1:] - The amount of disk space measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.7
AvailableDiskSpace int­[-1:] - The amount of disk space measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes disk space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.7
AllocatedMemory int­[-1:] - The amount of physical RAM measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.7
AvailableMemory int­[-1:] - The amount of physical RAM measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv are started/stopped and consume the physical RAM. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.7
ActiveExecutionUnits string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances currently running on this ExecEnv. This parameter only contains ExecutionUnit instances that currently have a ExecutionUnit.{i}.Status of Active. - 1.7
ProcessorRefList string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it. - 1.7
Device.SoftwareModules.DeploymentUnit.{i}. object -

This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit.

A new instance of this table gets created during the installation of a Software Module.

At most one entry in this table can exist with all the same values for UUID, Version and ExecutionEnvRef, or with a given value for Alias.

- 1.7
UUID string­(36) -

A Universally Unique Identifier either provided by the ACS, or generated by the CPE, at the time of Deployment Unit Installation. The format of this value is defined by [RFC4122] Version 3 (Name-Based) and [Annex H/TR-069a3].

This value MUST NOT be altered when the DeploymentUnit is updated.

- 1.7
DUID string­(64) - Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific. - 1.7
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.7
Name string­(64) -

Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit.

The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3].

- 1.7
Status string -

Indicates the status of this DeploymentUnit. Enumeration of:

  • Installing (This instance is in the process of being Installed and SHOULD transition to the Installed state)
  • Installed (This instance has been successfully Installed. The Resolved flag SHOULD also be referenced for dependency resolution)
  • Updating (This instance is in the process of being Updated and SHOULD transition to the Installed state)
  • Uninstalling (This instance is in the process of being Uninstalled and SHOULD transition to the Uninstalled state)
  • Uninstalled (This instance has been successfully Uninstalled. This status will typically not be seen within a DeploymentUnit instance)
- 1.7
Resolved boolean - Indicates whether or not this DeploymentUnit has resolved all of its dependencies. - 1.7
URL string­(1024) - Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit. - 1.7
Description string­(256) - Textual description of this DeploymentUnit. The format of this value is Execution Environment specific. - 1.7
Vendor string­(128) -

The author of this DeploymentUnit formatted as a domain name.

The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3].

- 1.7
Version string­(32) - Version of this DeploymentUnit. The format of this value is Execution Environment specific. - 1.7
VendorLogList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this DeploymentUnit. This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.

Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 1.7
VendorConfigList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this DeploymentUnit. This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.

Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 1.7
ExecutionUnitList string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances that are associated with this DeploymentUnit instance. - 1.7
ExecutionEnvRef string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv instance where this DeploymentUnit instance is installed. - 1.7
Device.SoftwareModules.ExecutionUnit.{i}. object -

This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit.

Each DeploymentUnit that is installed can have zero or more Execution Units.

Once a Deployment Unit is installed it populates this table with its contained Execution Units.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed.

Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

At most one entry in this table can exist with a given value for EUID, or with a given value for Alias.

- 1.7
EUID string­(64) -

Execution Unit Identifier chosen by the ExecEnv during installation of the associated DeploymentUnit.

The format of this value is Execution Environment specific, but it MUST be unique across ExecEnv instances. Thus, it is recommended that this be a combination of the ExecEnv.{i}.Name and an Execution Environment local unique value.

- 1.7
Alias string­(64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.7
Name string­(32) - The name of this ExecutionUnit as it pertains to its associated DeploymentUnit, which SHOULD be unique across all ExecutionUnit instances contained within its associated DeploymentUnit. - 1.7
ExecEnvLabel string­(64) - The name of this ExecutionUnit as provided by the ExecEnv, which SHOULD be unique across all ExecutionUnit instances contained within a specific ExecEnv. - 1.7
Status string -

Indicates the status of this ExecutionUnit. Enumeration of:

  • Idle (This instance is in an Idle state and not running)
  • Starting (This instance is in the process of Starting and SHOULD transition to the Active state)
  • Active (This instance is currently running)
  • Stopping (This instance is in the process of Stopping and SHOULD transition to the Idle state)
- 1.7
RequestedState string W

Indicates the state transition that the ACS is requesting for this ExecutionUnit. Enumeration of:

  • Idle (If this ExecutionUnit is currently in Starting or Active the CPE will attempt to Stop the Execution Unit; otherwise this requested state is ignored)
  • Active (If this ExecutionUnit is currently in Idle the CPE will attempt to Start the Execution Unit. If this ExecutionUnit is in Stopping the request is rejected and a fault raised. Otherwise this requested state is ignored)

If this ExecutionUnit is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a CWMP Fault MUST be generated.

The value of this parameter is not part of the device configuration and is always an empty string when read.

- 1.7
ExecutionFaultCode string -

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter embodies the problem. The value of NoFault MUST be used when everything is working as intended. Enumeration of:

For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].

- 1.7
ExecutionFaultMessage string­(256) -

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem.

If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the ACS.

- 1.7
AutoStart boolean W

If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted.

If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the ACS or another Execution Unit.

- 1.7
RunLevel unsignedInt­[:65535] W

Determines when this ExecutionUnit will be started.

If AutoStart is true and ExecEnv.{i}.CurrentRunLevel is greater than or equal to RunLevel, then this ExecutionUnit will be started.

If the value of ExecEnv.{i}.CurrentRunLevel is -1, then the associated ExecEnv. doesn't support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this ExecutionUnit.

- 1.7
Vendor string­(128) - Vendor of this ExecutionUnit. - 1.7
Version string­(32) - Version of the ExecutionUnit. The format of this value is Execution Environment specific. - 1.7
Description string­(256) - Textual description of this ExecutionUnit. The format of this value is Execution Environment specific. - 1.7
DiskSpaceInUse int­[-1:] - The amount of disk space measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 1.7
MemoryInUse int­[-1:] - The amount of physical RAM measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 1.7
References string -

Comma-separated list of strings. Each list item MUST be the Path Name of a table row. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit. See [Appendix II.3.2/TR-157a3] for more description and some examples.

NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the DeviceInfo.SupportedDataModel.{i}. table.

- 1.7
AssociatedProcessList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.ProcessStatus.Process table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the system processes that are active in the system because of this ExecutionUnit.

If Status is not Active it is expected that this list will be an empty string. Some ExecutionUnit instances MIGHT NOT have any system processes irrespective of the value of Status.

- 1.7
VendorLogList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.

Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 1.7
VendorConfigList string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.

Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 1.7
SupportedDataModelList string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instances that have been introduced to this device because of the existence of this ExecutionUnit. - 1.7
ExecutionEnvRef string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv that this ExecutionUnit is associated with. - 1.7
Device.SoftwareModules.ExecutionUnit.{i}.Extensions. object -

This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit.

It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of References and SupportedDataModelList will be used to determine their locations.

See [Appendix II.3.2/TR-157a3] for more description and some examples.

- 1.7

Inform and Notification Requirements

Forced Inform Parameters

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

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter
Device.SoftwareModules.ExecutionUnit.{i}.Status

Parameters for which Active Notification MAY be Denied

Parameter
Device.DeviceInfo.
ModelName
Description
UpTime
FirstUseDate
DeviceLog
Device.DeviceInfo.MemoryStatus.
Free
Device.DeviceInfo.ProcessStatus.
CPUUsage
Device.DeviceInfo.ProcessStatus.Process.{i}.
Size
CPUTime
State
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.
Alias
Value
LastUpdate
Device.DeviceInfo.SupportedDataModel.{i}.
Alias
Device.DeviceInfo.VendorConfigFile.{i}.
Alias
Device.DeviceInfo.Processor.{i}.
Alias
Device.DeviceInfo.VendorLogFile.{i}.
Alias
Device.ManagementServer.
ParameterKey
Device.Time.
CurrentLocalTime
Device.UserInterface.LocalDisplay.
PosX
PosY
Width
Height
Device.LAN.DHCPOption.{i}.
Alias
Device.LAN.Stats.
ConnectionUpTime
TotalBytesSent
TotalBytesReceived
TotalPacketsSent
TotalPacketsReceived
CurrentDayInterval
CurrentDayBytesSent
CurrentDayBytesReceived
CurrentDayPacketsSent
CurrentDayPacketsReceived
QuarterHourInterval
QuarterHourBytesSent
QuarterHourBytesReceived
QuarterHourPacketsSent
QuarterHourPacketsReceived
Device.LAN.IPPingDiagnostics.
DiagnosticsState
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
Device.LAN.TraceRouteDiagnostics.
DiagnosticsState
ResponseTime
NumberOfRouteHops
Device.LAN.TraceRouteDiagnostics.RouteHops.{i}.
HopHost
Device.DownloadDiagnostics.
DiagnosticsState
ROMTime
BOMTime
EOMTime
TestBytesReceived
TotalBytesReceived
TCPOpenRequestTime
TCPOpenResponseTime
Device.UploadDiagnostics.
DiagnosticsState
ROMTime
BOMTime
EOMTime
TotalBytesSent
TCPOpenRequestTime
TCPOpenResponseTime
Device.UDPEchoConfig.
PacketsReceived
PacketsResponded
BytesReceived
BytesResponded
TimeFirstPacketReceived
TimeLastPacketReceived
Device.User.{i}.
Alias
Device.SmartCardReader.{i}.
Alias
DecryptionFailedCounter
DecryptionFailedNoKeyCounter
Device.SelfTestDiagnostics.
DiagnosticsState
Results
Device.NSLookupDiagnostics.
DiagnosticsState
SuccessCount
ResultNumberOfEntries
Device.NSLookupDiagnostics.Result.{i}.
Status
AnswerType
HostNameReturned
IPAddresses
DNSServerIP
ResponseTime
Device.USBHosts.Host.{i}.
Alias
Device.PeriodicStatistics.SampleSet.{i}.
Alias
SampleSeconds
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Alias
SampleSeconds
SuspectData
Values
Device.DownloadAvailability.Announcement.Group.{i}.
Alias
Device.SoftwareModules.ExecEnv.{i}.
Alias
AvailableDiskSpace
AvailableMemory
ActiveExecutionUnits
Device.SoftwareModules.DeploymentUnit.{i}.
Alias
Status
Device.SoftwareModules.ExecutionUnit.{i}.
Alias
DiskSpaceInUse
MemoryInUse

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

SupportedDataModel:1 Profile

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

Name Requirement
Device.­DeviceInfo. P
SupportedDataModelNumberOfEntries R
Device.­DeviceInfo.­SupportedDataModel.­{i}. P
URL R
URN R
Features R

Time:2 Profile

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

Name Requirement
Device.­Time. P
Enable W
Status R

TempStatusAdv:2 Profile

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

Name Requirement
Device.­DeviceInfo.­TemperatureStatus.­TemperatureSensor.­{i}. P
PollingInterval W

Processors:1 Profile

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

Name Requirement
Device.­DeviceInfo.­Processor.­{i}. P
Architecture R

VendorLogFiles:1 Profile

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

Name Requirement
Device.­DeviceInfo.­VendorLogFile.­{i}. P
Name R
MaximumSize R
Persistent R

DUStateChngComplPolicy:1 Profile

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

Name Requirement
Device.­ManagementServer.­DUStateChangeComplPolicy. P
Enable W
OperationTypeFilter W
ResultTypeFilter W

SM_ExecEnvs:1 Profile

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

Name Requirement
Device.­SoftwareModules. P
ExecEnvNumberOfEntries R
Device.­SoftwareModules.­ExecEnv.­{i}. P
Enable W
Status R
Name R
Type R
Vendor R
Version R
AllocatedDiskSpace R
AvailableDiskSpace R
AllocatedMemory R
AvailableMemory R
ActiveExecutionUnits R

SM_DeployAndExecUnits:1 Profile

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

Name Requirement
Device.­SoftwareModules. P
DeploymentUnitNumberOfEntries R
ExecutionUnitNumberOfEntries R
Device.­SoftwareModules.­DeploymentUnit.­{i}. P
UUID R
DUID R
Name R
Status R
Resolved R
URL R
Description R
Vendor R
Version R
VendorLogList R
VendorConfigList R
ExecutionUnitList R
ExecutionEnvRef R
Device.­SoftwareModules.­ExecutionUnit.­{i}. P
EUID R
Name R
ExecEnvLabel R
Status R
RequestedState W
ExecutionFaultCode R
ExecutionFaultMessage R
Vendor R
Version R
Description R
References R
AssociatedProcessList R
VendorLogList R
VendorConfigList R
SupportedDataModelList R
ExecutionEnvRef R
Device.­SoftwareModules.­ExecutionUnit.­{i}.­Extensions. P

SM_Baseline:1 Profile

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

Name Requirement
Device.­SoftwareModules. P
ExecEnvNumberOfEntries R
DeploymentUnitNumberOfEntries R
ExecutionUnitNumberOfEntries R
Device.­SoftwareModules.­ExecEnv.­{i}. P
Enable W
Status R
Name R
Type R
Vendor R
Version R
ActiveExecutionUnits R
Device.­SoftwareModules.­DeploymentUnit.­{i}. P
UUID R
DUID R
Name R
Status R
Resolved R
URL R
Vendor R
Version R
ExecutionUnitList R
ExecutionEnvRef R
Device.­SoftwareModules.­ExecutionUnit.­{i}. P
EUID R
Name R
ExecEnvLabel R
Status R
RequestedState W
ExecutionFaultCode R
ExecutionFaultMessage R
Vendor R
Version R
References R
SupportedDataModelList R
Device.­SoftwareModules.­ExecutionUnit.­{i}.­Extensions. P


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:27:30.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --report=html --outfile=tr-181-1-1-0.html tr-181-1-1-0.xml