Broadband Forum

TR-069 Device:2 Root Data Model definition [CWMP] (changes)

tr-181-2-14-0-cwmp.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2019, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
    Copyright (c) 2017-2019 ARRIS Enterprises, LLC.

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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

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

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

Data Types

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

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

Data Type Base Type Description
boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1].
decimal -

Decimal number, with optional sign and optional fractional part.

For some decimal types, a value range is given using the form decimal(Min:Max) or decimal(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.0. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

int -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

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.

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-069] and described in [Appendix II/TR-069], 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.
DiagnosticsState string

Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)

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

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

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), but not if it is canceled for any reason, 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.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

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.

IPv4Address IPAddress(:45)

IPv4 address (or subnet mask).

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

Possible patterns:

  • <Empty> (an empty string)
  • ((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])
IPv6Address IPAddress(:45)

IPv6 address.

Can be any IPv6 address that is permitted by the IPAddress 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])
PSDBreakPointIndexAndLevel unsignedInt[2:2]
  1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and
  2. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. Both values are represented as unsignedInt.
PSMBreakPointIndexAndLevel unsignedInt[2:2]
  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz. Both values are represented as unsignedInt. [Clause 5.2/G.9964] defines limits on PSM breakpoint levels.
SELTPAttenuationCharacteristicsIndexAndTFlog unsignedInt[2:2]
  1. The paired frequency spacing index in the range [0:8191], and
  2. The transfer function log value, i.e. [i, TFlog(i * TFlogGroupSize * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * TFlogGroupSize * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB. Both values are represented as unsignedInt.
SST string

Service Slice Type (SST). Enumeration of:

  • eMBB (5G Enhanced Mobile Broadband)
  • URLLC (Ultra-Reliable Low Latency Communications)
  • MIoT (Massive IoT)
  • V2X (Vehicle to Everything) See [Clause 5.15.2.2/3GPP-TS.23.501].
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.

UERComplex int[2:2] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
  1. Real UER component, a(i)
  2. Imaginary UER component, b(i) for values of i starting at i=0. Both values are represented as signed integers. The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2].
URI string(:2048) Uniform Resource Identifier. See [RFC3986].
URL URI(:2048) Uniform Resource Locator. See [RFC3986] (URI), [IANA-uri-schemes], and individual URI scheme RFCs such as [RFC7252] (coap, coaps) and [RFC7230] (http, https).

References

[3GPP-TS.23.003] 3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4.
[3GPP-TS.23.501] 3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2.
[3GPP-TS.24.008] 3GPP TS 24.008, Mobile radio interface Layer 3 specification; Core network protocols; Stage 3, 3GPP CT WG1.
[3GPP-TS.24.301] 3GPP TS 24.301, Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.501] 3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.526] 3GPP TS 24.526, User Equipment (UE) policies for 5G System (5GS); Stage 3, 3GPP CT WG1.
[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2016] IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11ax] IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[DVB-TS.102.824] TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[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.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[MAPv1.0] Multi-AP Specification, Multi-AP Specification Version 1.0, June 2018.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT50] MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC2616] RFC 2616, Hypertext Transfer Protocol - HTTP/1.1, IETF, 1999.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2974] RFC 2974, Session Announcement Protocol, IETF, October 2000.
[RFC3926] RFC 3926, FLUTE - File Delivery over Unidirectional Transport, IETF, October 2004.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[RFC7594] RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015.
[RFC7597] RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015.
[RFC7598] RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015.
[RFC7599] RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-124i5] TR-124 Issue 5, Functional Requirements for Broadband Residential Gateway Devices, Broadband Forum, July 2016.
[TR-124i6] TR-124 Issue 6, Functional Requirements for Broadband Residential Gateway Devices, Broadband Forum, July 2020.
[TR-143] TR-143 Amendment 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[TR-471] TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2023.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[UPnP-DAv11] UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 2008.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Parameter definition.

Device:2.14 Data Model

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.

Changes in 2.14:

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device.

Changes in 2.14:

 - 2.0
Device.DeviceInfo. object R This object contains general device information. - 2.0
ProductClass string(:64) R Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. 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. - 2.0
SerialNumber string(:64) R Identifier of the particular device that is unique for the indicated class of product and manufacturer. 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. - 2.0
Device.ManagementServer. object R This object contains parameters relating to the CPE’s association with an ACS. - 2.0
URL string(:2048) W URL, as defined in [RFC3986],The [URL] for the CPE to connect to the ACS using the CPE WAN Management Protocol. This parameter MUST be in the form of a valid HTTP or HTTPS URL. The host portion of this URL is used by the CPE for validating the ACS certificate when using SSL or TLS. 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.

Changes in 2.14:

  • Removed string(:256) syntax
  • Added URL
 - 2.0
DelayReboot int(-1:) W The number of secondsseconds from the time the CWMP session in which this parameter value is set is ended until the CPE performs a reboot. Whenever the CPE reboots, this value MUST be reset by the CPE to -1. - 2.10
ConnectionRequestURL string(:2048) R

The HTTP URL, as defined in [RFC3986],[URL] for an ACS to make a Connection Request notification to the CPE. In the form:

http://host:port/path The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name. Note: If the host portion of the URL is a literal IPv6 address then it MUST be enclosed in square brackets (see [Section 3.2.2/RFC3986]).

This parameter MUST always be included in Inform messages.

Active Notification MUST by default be enabled for this parameter.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
KickURL string(:2048) R Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in [RFC3986],[URL] from which the CPE can be kicked to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
DownloadProgressURL string(:2048) R Present only for a CPE that provides a LAN-side web page to show progress during a file download. LAN-accessible URL, as defined in [RFC3986],[URL] to which a web-server associated with the ACS MAY redirect a user’s browser on initiation of a file download to observer the status of the download.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
Device.ManagementServer.ManageableDevice.{i}. object(0:) R

Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to [Annex F/TR-069] as indicated by the presence of the DHCP option specified in that Annex.

At most one entry in this table can exist with a given value for {{param: reference to obsoleted parameter Device.ManagementServer.ManageableDevice.{i}.Alias}}, or with the same values for all of ManufacturerOUI, SerialNumber and ProductClass.

 - 2.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. An initial unique value MUST be assigned when the CPE creates an instance of this object. This parameter iswas DEPRECATED because ManageableDevice is a transient object. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
Device.ManagementServer.DownloadAvailability. object R This object contains multicast announcement and query parameters used for the purpose of downloading files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement. object R This object contains multicast announcement parameters used to download files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement.Group.{i}. object(0:) 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.

 - 2.0
URL string(:2048) W URL [RFC3986]The [URL] 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.

Changes in 2.14:

  • Removed string(:256) syntax
  • Removed string(:256) syntax default
  • Added URL
 - 2.0
Device.ManagementServer.DownloadAvailability.Query. object R This object contains multicast query parameters used to download files. - 2.0
URL string(:2048) W URLThe [RFC3986][URL] 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.

Changes in 2.14:

  • Removed string(:256) syntax
  • Added URL
 - 2.0
Device.DeviceInfo.FirmwareImage.{i}. object(0:) R

Top-level object for mapping firmware images. This is a static table – the number of object instances in this table is defined by the firmware that is currently running.

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

 - 2.12
Available boolean W Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true. This value MUST be set to true by the device whenever a new firmware image is installed. This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter. Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it. - 2.12
Status string R

Status of the firmware image, as determined by the Agent. Enumeration of:

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Active (This Firmware Image instance is the currently active image)
  • Downloading (This Firmware Image instance is being downloaded)
  • Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
  • Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
  • DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
  • ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
  • InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
  • ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)

Changes in 2.14:

  • Added string Active enumeration
 - 2.12
Device.DeviceInfo.SupportedDataModel.{i}. object(0:) R

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

 - 2.0
URL string(:2048) R URL ([RFC3986])The [URL] that describes some or all of the device’s Currentcurrently 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-106], 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 UUID is a unique key, so the XML file referenced by this URL will never change. The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of “localhost” as URL host portion, When the “localhost” value is used, the ACS has the responsibility to substitute the “localhost” value with the host portion of the connection request URL. Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.

Changes in 2.14:

  • Removed string(:256) syntax
  • Added URL
 - 2.0
Device.UserInterface. object R This object contains parameters relating to the user interface of the CPE. - 2.0
ISPHomePage string(:2048) W The URL[URL] of the ISP’s home page.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
ISPHelpPage string(:2048) W The URL[URL] of the ISP’s on-line support page.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
ISPMailServer string(:2048) W The URL[URL] of the ISP’s mail server.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
ISPNewsServer string(:2048) W The URL[URL] of the ISP’s news server.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
Device.DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Line.{i}. object(0:) R

DSL Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical DSL lines.

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

 - 2.0
StandardsSupported string[] R

Comma-separated list of strings. List items indicate which DSL standards and recommendations are supported by the Line instance. Each list item is an enumeration of:

  • G.992.1_Annex_A
  • G.992.1_Annex_B
  • G.992.1_Annex_C
  • T1.413
  • T1.413i2
  • ETSI_101_388
  • G.992.2
  • G.992.3_Annex_A
  • G.992.3_Annex_B
  • G.992.3_Annex_C
  • G.992.3_Annex_I
  • G.992.3_Annex_J
  • G.992.3_Annex_L
  • G.992.3_Annex_M
  • G.992.4
  • G.992.5_Annex_A
  • G.992.5_Annex_B
  • G.992.5_Annex_C
  • G.992.5_Annex_I
  • G.992.5_Annex_J
  • G.992.5_Annex_M
  • G.993.1
  • G.993.1_Annex_A
  • G.993.2_Annex_A
  • G.993.2_Annex_B
  • G.993.2_Annex_C Note: In G.997.1, this parameter is called “xDSL Transmission system capabilities”. See ITU-T Recommendation [G.997.1]. This parameter iswas DEPRECATED because its entries are out-of-date; XTSE points to a current list. Therefore its value MAY be an empty string if (and only if) XTSE is supported. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
StandardUsed string R The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Line instance is using for the connection. Note: In G.997.1, this parameter is called “xDSL Transmission system”. See ITU-T Recommendation [G.997.1]. This parameter iswas DEPRECATED because its entries are out-of-date; XTSE points to a current list. Therefore its value MAY be an empty string if (and only if) XTSUsed is supported. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
Device.DSL.Line.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Device.DSL.Line.{i}.Stats.Total. object R This object contains DSL line total statistics. See [Chapter 7.2.6/G.997.1]. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
ErroredSecs unsignedInt R

Total number of errored secondsseconds (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
SeverelyErroredSecs unsignedInt R

Total number of severely errored secondsseconds (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
Device.DSL.Line.{i}.Stats.Showtime. object R This object contains DSL line statistics accumulated since the most recent DSL Showtime. See [Chapter 7.2.6/G.997.1]. Note: The Showtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
ErroredSecs unsignedInt R

Number of errored secondsseconds since the most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
SeverelyErroredSecs unsignedInt R

Number of severely errored secondsseconds since the most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
Device.DSL.Line.{i}.Stats.LastShowtime. object R This object contains DSL line statistics accumulated since the second most recent DSL Showtime. See [Chapter 7.2.6/G.997.1]. Note: The LastShowtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
ErroredSecs unsignedInt R

Number of errored secondsseconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
SeverelyErroredSecs unsignedInt R

Number of severely errored secondsseconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
Device.DSL.Line.{i}.Stats.CurrentDay. object R This object contains DSL line statistics accumulated during the current day. See [Chapter 7.2.6/G.997.1]. Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
ErroredSecs unsignedInt R

Number of errored secondsseconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
SeverelyErroredSecs unsignedInt R

Number of severely errored secondsseconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
Device.DSL.Line.{i}.Stats.QuarterHour. object R This object contains DSL line statistics accumulated during the current quarter hour. See [Chapter 7.2.6/G.997.1]. Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
ErroredSecs unsignedInt R

Number of errored secondsseconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
SeverelyErroredSecs unsignedInt R

Number of severely errored secondsseconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. [G.997.1]). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.0
Device.DSL.Diagnostics. object R The DSL Diagnostics object. - 2.0
Device.DSL.Diagnostics.SELTUER. object R This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER) diagnostics parameters. This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. - 2.13
UER int[2:2][1:4096] R The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], … Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of:of the following. [UERComplex] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
  1. Real UER component, a(i)
  2. Imaginary UER component, b(i) for values of i starting at i=0. Both values are represented as signed integers. The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2]. The value of UER at frequency i*UERGroupSizeDf = (UERScaleFactor/(2^31))(a(i)+j*b(i))/(2^31) where Df = 4.3125 kHz. This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].
 - 2.13
UERScaleFactor unsignedInt R The Uncalibrated Echo Response (UER) scale factor. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2]. Note that the scale factor is chosen such that max(abs(a(i)), abs(b(i))) over all i is equal to 2^31 - 1, which doesn’t allow UERScaleFactor to be zero. - 2.13
UERGroupSize unsignedInt(1:2,12) R The Uncalibrated Echo Response (UER) group size, UER_G. In units of subcarriers. This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.2/G.996.2]. - 2.13
Device.DSL.Diagnostics.SELTQLN. object R This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN) diagnostics parameters. This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. - 2.13
QLNGroupSize unsignedInt(1:2,12) R This parameter represents the Quiet Line Noise (QLN) group size. In units of subcarriers. This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation [Clause A.2.2.4/G.996.2]. - 2.13
Device.DSL.Diagnostics.SELTP. object R This object contains DSL Single-Ended Line Test - Processed (SELT-P) diagnostics parameters. This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [G.996.2].

Changes in 2.14:

 - 2.13
CapacitySignalPSD unsignedInt[2:2][1:48] W The capacity estimate signal Power Spectral Density (PSD): Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of:of the following. [PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and
  1. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. Both values are represented as unsignedInt. This capacity estimate signal PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.2/G.996.2].
 - 2.13
CapacityNoisePSD unsignedInt[2:2][1:48] W The capacity estimate noise Power Spectral Density (PSD): Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of:of the following. [PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and
  1. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. Both values are represented as unsignedInt. This capacity estimate noise PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.3/G.996.2].
 - 2.13
LoopTermination string R Loop termination indicator,indicator. one of the following state indications: ‘Open’ ‘Short’ ‘Powered on DSLAM/DPU’ ‘Unknown’{{enum: only valid as argument}} This parameter is defined as LOOP-TERM in ITU-T Recommendation [Clause B.1.1.1/G.996.2].

Changes in 2.14:

  • Removed string :21 size
  • Added string Open enumeration
  • Added string Short enumeration
  • Added string Powered on DSLAM/DPU enumeration
  • Added string Powered on CPE enumeration
  • Added string Unknown enumeration
 - 2.13
AttenuationCharacteristics unsignedInt[2:2][0:8191] R

Comma-separated list (0 to 8191 items) of SELTPAttenuation Characteristics Index And TFlogs. List items represent paired frequency spacing index i and transfer function log value, i.e. [i,TFlog(i * Df)], whereSpecifies the referencelist frequencyof spacingattenuation Dfcharacteristics. =Comma-separated list (0 to 8191 items) of SELTPAttenuation Characteristics Index And TFlogs, with. 4.3125each kHz,list item consisting of the indexfollowing i valid range is 0 to 8191, and

[SELTPAttenuationCharacteristicsIndexAndTFlog] 1. The paired frequency spacing index in the range [0:8191], and

  1. The transfer function log value, i.e. [i, TFlog(i * TFlogGroupSize * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * TFlogGroupSize * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB. Both values are represented as unsignedInt.

TFlog(i * TFlogGroupSize * Df) spansis arepresented by an integer k, 0 <= k <= 1022, where TFlog(i * TFlogGroupSize * Df) = 6.0 - k * 0.1. The special value of k of 1023 is used to indicate that no measurement could be done for this subcarrier because the attenuation is out of the range fromthat +6.0can dBbe down to -96.2 dB with units of 0.1 dB.represented. The Attenuationattenuation characteristics TFlog(f) parameter is defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2].

Changes in 2.14:

  • Added [0:8191] list minItems = 0
  • Added [0:8191] list maxItems = 8191
  • Added [0:8191] list nestedBrackets = required
  • Removed list :61430 size
  • Changed syntax = string -> SELTPAttenuationCharacteristicsIndexAndTFlog[0:8191]
 - 2.13
TFlogGroupSize unsignedInt(1:2,12) R This parameter represents the Transfer Function Log (TFlog) group size. In units of subcarriers. This parameter is defined as part of the SELT attenuation characteristics, AttenuationCharacteristics, defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2]. - 2.14
CapacityEstimate unsignedInt[1:2] R Capacity Estimate: Comma-separated list (1 to 2 items) of unsigned integers. This parameter is an unsigned integer representingrepresents the downstream and/or upstream capacity estimateestimates in kbit/s,kbit/s. withIf unitsonly one value is supplied, then it’s not specified whether it’s the downstream value, the upstream value or some combination of kbit/s.the two. If two values are supplied, then the first is the downstream value and the second is the upstream value. The capacity estimate parameterparameters isare defined in [Clause B.1.1.7/G.996.2].

Changes in 2.14:

  • Added unsignedInt[1:2] syntax [1:2] list
 - 2.13
Device.FAST. object R This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. - 2.11
Device.FAST.Line.{i}. object(0:) R

FAST Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical FAST lines.

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

 - 2.11
Device.FAST.Line.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.11
Device.FAST.Line.{i}.Stats.Total. object R This object contains DSL line total statistics. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.11
ErroredSecs unsignedInt R

Total number of errored secondsseconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
SeverelyErroredSecs unsignedInt R

Total number of severely errored secondsseconds as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LOSS unsignedInt R

Total number of loss of signal secondsseconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LORS unsignedInt R

Total number of loss of RMC secondsseconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
UAS unsignedInt R

Total number of unavailable secondsseconds (UAS) as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
Device.FAST.Line.{i}.Stats.Showtime. object R This object contains FAST line statistics since the most recent showtime. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.11
ErroredSecs unsignedInt R

Total number of errored secondsseconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
SeverelyErroredSecs unsignedInt R

Total number of severely errored secondsseconds as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LOSS unsignedInt R

Total number of loss of signal secondsseconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LORS unsignedInt R

Total number of loss of RMC secondsseconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
UAS unsignedInt R

Total number of unavailable secondsseconds (UAS) as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
Device.FAST.Line.{i}.Stats.LastShowtime. object R This object contains FAST line statistics since the second most recent showtime. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.11
ErroredSecs unsignedInt R

Total number of errored secondsseconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
SeverelyErroredSecs unsignedInt R

Total number of severely errored secondsseconds as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LOSS unsignedInt R

Total number of loss of signal secondsseconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LORS unsignedInt R

Total number of loss of RMC secondsseconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
UAS unsignedInt R

Total number of unavailable secondsseconds (UAS) as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
Device.FAST.Line.{i}.Stats.CurrentDay. object R This object contains FAST line statistics accumulated during the current day. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.11
ErroredSecs unsignedInt R

Total number of errored secondsseconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
SeverelyErroredSecs unsignedInt R

Total number of severely errored secondsseconds as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LOSS unsignedInt R

Total number of loss of signal secondsseconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LORS unsignedInt R

Total number of loss of RMC secondsseconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
UAS unsignedInt R

Total number of unavailable secondsseconds (UAS) as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
Device.FAST.Line.{i}.Stats.QuarterHour. object R This object contains FAST line statistics accumulated during the current quarter hour. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.11
ErroredSecs unsignedInt R

Total number of errored secondsseconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
SeverelyErroredSecs unsignedInt R

Total number of severely errored secondsseconds as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LOSS unsignedInt R

Total number of loss of signal secondsseconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
LORS unsignedInt R

Total number of loss of RMC secondsseconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects.

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
UAS unsignedInt R

Total number of unavailable secondsseconds (UAS) as defined in ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

Changes in 2.14:

  • Added unsignedInt seconds units
 - 2.11
Device.Optical. object R This object models optical interface technologies. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. The data model definition is based on parts of [G.988]. - 2.4
Device.Optical.Interface.{i}. object(0:) R

Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces.

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

 - 2.4
TransmitOpticalLevel int R Current measurement of mean optical launch power. [Dbm1000] 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. Valid values are -127.5-65.536 dBm (coded as -127500)-65536), to 065.534 dBm (coded as 0)65534) in 0.50.002 dB increments. The value -127500 indicates the device’s internal policy. This parameter is based on Transmit optical level from [Section 9.2.1/G.988].

Changes in 2.14:

  • Changed -65536:65533:2 range minInclusive = -127000 ⇒ -65536
  • Changed -65536:65533:2 range maxInclusive = 0 ⇒ 65534
  • Changed -65536:65533:2 range step = 500 ⇒ 2
 - 2.4
Device.Cellular. object R This object models cellular interfaces and access points. - 2.8
Device.Cellular.Interface.{i}. object(0:) R

Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and a single USIM.

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

Changes in 2.14:

  • Added RSRP parameter
  • Added RSRQ parameter
 - 2.8
SupportedAccessTechnologies string[] R

Comma-separated list of strings. Access technologies supported by the interface.

Each list item is an enumeration of:

  • GPRS (GSM with GPRS)
  • EDGE (GSM with EDGE)
  • UMTS
  • UMTSHSPA (UMTS with High Speed Packet Access (HSPA [3GPP-HSPA]))
  • CDMA2000OneX
  • CDMA2000HRPD
  • LTE
  • NR (5G New Radio)

Changes in 2.14:

  • Added string NR enumeration
 - 2.8
RSSI int R

The received signal strength in dBm. The allowed values depend on CurrentAccessTechnology: * For GPRS, EDGE the range is -111 dBm to -49 dBm * For UMTS, UMTSHSPA the range is -117 dBm to -54 dBm * For LTE, NR the range is -117 dBm to -25 dBm Note: An undetectable signal is indicated by the appropriate lower limit, e.g. -117 dBm for LTE.

Active Notification requests for this parameter MAY be denied.

 - 2.8
RSRP int R

The Reference Signal Received Power in dBm for LTE, NR values of CurrentAccessTechnology:

  • The valid range of RSRP values from worst to best is -140 dBm to -44 dBm

Active Notification requests for this parameter MAY be denied.

 - 2.14
RSRQ int R

The Reference Signal Received Quality in dBm for LTE, NR values of CurrentAccessTechnology:

  • RSRQ is calculated using RSSI and RSRP values using RSRQ = (N*RSRP)/RSSI where N is the number of resource blocks (bandwidth).
  • The valid range of RSRP values from worst to best is -20 dBm to -3 dBm

Active Notification requests for this parameter MAY be denied.

 - 2.14
Device.Ethernet. object R Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An “outer” VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID.

Changes in 2.14:

 - 2.0
FlowControlSupported boolean R Indicates that Flow Control over Ethernet is supported, as per [802.3-2015]. - 2.14
Device.Ethernet.Link.{i}. object(0:) W

Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name 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 MACAddress.

Changes in 2.14:

 - 2.0
FlowControl boolean W Configures Flow Control on given Ethernet port. When set to true, it activates the exchange of pause-resume flow control frames. false 2.14
Device.Ghn. object R G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Device.Ghn.Interface.{i}. object(0:) R

G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface.

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

 - 2.4
ConnectionType string R

This parameter iswas DEPRECATED because it has been replaced by MediumType. This parameter is OBSOLETED in 2.14.

Enumeration of:

  • Powerline
  • Phone
  • Coax

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.4
PSM unsignedInt[2:2][2:32] W Specifies the list of PSD shaping mask (PSM) breakpoints to be applied to the G.hn interface. Comma-separated list (2 to 32 items) of PSMBreak Point Index And Levels, with each list item consisting of:of the following. [PSMBreakPointIndexAndLevel] 1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  1. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz. Both values are represented as unsignedInt. [Clause 5.2/G.9964] defines limits on PSM breakpoint levels. The PSM level is 0.1*(the value of the level of the PSM) - 140 dBm/Hz. For example, a PSM defined by two breakpoints (subcarrier 450, PSM level -80 dBm/Hz) and (subcarrier 1050, PSM level -90 dBm/Hz) is represented by PSM [450,600],[1050,500] .
 - 2.12
Device.WiFi. object R The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint).

Changes in 2.14:

 - 2.0
ResetCause string R

Reports the cause for the previous Wi-Fi driver reset.

Enumeration of:

  • HostReinit (Indicates that the host processor intentionally performed the reset. This can be due to an external instruction)
  • SpontaneousInterrupt (Indicates that the reset was spontaneous. This can be due to an error condition)
  • LossOfPower (Indicates that the reset was due to a loss of mains power on the device)
 - 2.14
Device.WiFi.MultiAP. object R This object describes a Wi-Fi network containing 1 or more Access Point devices. This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network. - 2.13
Device.WiFi.MultiAP.APDevice.{i}. object(0:) R

Each instance of this object represents an individual Access Point device in the Wi-Fi network.

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

Changes in 2.14:

 - 2.13
ProductClass string(:64) R Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. 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. - 2.13
SerialNumber string(:64) R Identifier of the particular Access Point device that is unique for the indicated class of product and manufacturer. 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. - 2.13
RadarDetections unsignedInt[](:1024) R Comma-separated list (maximum number of characters 1024) of unsigned integers. List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC). - 2.14
DFSEnable boolean W Enables or disables Dynamic Frequency Selection (DFS). - 2.14
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}. object(0:) R

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

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

Changes in 2.14:

 - 2.13
OperatingStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each list item is an enumeration of:

 - 2.13
Channel unsignedInt(1:255) W The current radio channel used by the connection. To request automatic channel selection, set Device.WiFi.Radio.{i}.AutoChannelEnable to true. Whenever Device.WiFi.Radio.{i}.AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. For channels in “wide mode” (where a channel bandwidth strictly greater than 20 MHz is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through ExtensionChannel. Note: Valid Channel values depend on the OperatingFrequencyBand value specified and the regulatory domain.

Changes in 2.14:

  • Changed access = readOnly ⇒ readWrite
 - 2.13
PossibleChannels string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n, ac, ax) and the regulatory domain. Ranges in the form “n-m” are permitted. For example, for 802.11b and North America, would be “1-11”. - 2.14
TransmitPowerLimit int(-90:36) W Indicates the maximum Effective Isotropic Radiated Power (EIRP) per 20 MHz bandwidth representing the nominal transmit power limit for this radio. The field is coded in units of dBm relative to 1 mW. [Clause 17.2.15/MAPv1.0] - 2.14
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}. object(0:) R

A single logical Access Point operating on this radio.

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

 - 2.13
BlacklistAttempts unsignedLong R [StatsCounter64] Number of times a Blacklist steer was attempted for this Access Point. Blacklist steering is the process of forcing a connected STA to move to another Access Point by temporarily blocking its access to the current Access Point. - 2.13
Device.WiFi.Radio.{i}. object(0:) R

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]). If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information. Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

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

Changes in 2.14:

 - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example: * For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces. * For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface. * For an End Device, Upstream will be true for all interfaces. This parameter iswas DEPRECATED because it gives a wrong indication for multiple SSIDs. Use the SSID.{i}.Upstream parameter instead. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
PossibleChannels string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n)n, ac, ax) and the regulatory domain. Ranges in the form “n-m” are permitted. For example, for 802.11b and North America, would be “1-11”. - 2.0
Channel unsignedInt(1:255) W The current radio channel used by the connection. To request automatic channel selection, set AutoChannelEnable to true. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. For channels in “wide mode” (802.11n where a 40MHz channel bandwidth is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through ExtensionChannel. Note: Valid Channel values depend on the OperatingFrequencyBand value specified and the RegulatoryDomain values specified.. - 2.0
GuardInterval string W

The guard interval value between OFDM symbols.

Enumeration of:

  • 400nsec (applicable to 802.11n and 802.11ac specifications only)
  • 800nsec (applicable to 802.11n and 802.11ac specifications only)
  • 1xLTF_0.8us (applicable to 802.11ax specification only)
  • 1xLTF_1.6us (applicable to 802.11ax specification only)
  • 2xLTF_0.8us (applicable to 802.11ax specification only)
  • 2xLTF_1.6us (applicable to 802.11ax specification only)
  • 4xLTF_0.8us (applicable to 802.11ax specification only)
  • 4xLTF_3.2us (applicable to 802.11ax specification only)
  • Auto

Changes in 2.14:

  • Removed string 1600nsec enumeration
  • Removed string 3200nsec enumeration
  • Added string 1xLTF_0.8us enumeration
  • Added string 1xLTF_1.6us enumeration
  • Added string 2xLTF_0.8us enumeration
  • Added string 2xLTF_1.6us enumeration
  • Added string 4xLTF_0.8us enumeration
  • Added string 4xLTF_3.2us enumeration
 - 2.0
CenterFrequencySegement0 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. This parameter is DEPRECATED in 2.14 due to a typo. Use CenterFrequencySegment0 instead.

Changes in 2.14:

  • Added status = deprecated
 - 2.13
CenterFrequencySegement1 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. This parameter is DEPRECATED in 2.14 due to a typo. Use CenterFrequencySegment1 instead.

Changes in 2.14:

  • Added status = deprecated
 - 2.13
CenterFrequencySegment0 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. - 2.14
CenterFrequencySegment1 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. - 2.14
MCS int(-1:15,16:31) W The Modulation Coding Scheme index (applicable to 802.11n802.11n, 802.11ac, and 802.11ac802.11ax specifications only). Values from 0 to 15 MUST be supported for ([802.11n-2009]). Values from 0 to 9 MUST be supported for [802.11ac-2013]. Values from 0 to 11 MUST be supported for [802.11ax]. A value of -1 indicates automatic selection of the MCS index. - 2.0
EnableRRM boolean W Enables or disables 802.11k Radio Resource Management (RRM). - 2.14
Device.WiFi.NeighboringWiFiDiagnostic. object R This object defines access to other WiFi SSIDs that this device is able to receive. - 2.7
Device.WiFi.Radio.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

Changes in 2.14:

 - 2.0
CtsReceived unsignedLong R [StatsCounter64] The total number of Request To Send (RTS) control frames that received a Clear To Send (CTS) response. - 2.14
NoCtsReceived unsignedLong R [StatsCounter64] The total number of Request To Send (RTS) control frames that did not receive a Clear To Send (CTS) response. - 2.14
FrameHeaderError unsignedLong R [StatsCounter64] The total number of received packets for which the PHY was able to correlate the preamble but not the header. - 2.14
GoodPLCPReceived unsignedLong R [StatsCounter64] The total number of received frames with a good Physical Layer Convergence Protocol (PLCP) header. - 2.14
DPacketOtherMACReceived unsignedLong R [StatsCounter64] The total number of Wi-Fi data packets received from other Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not matching the receiver address, meaning that that the frame is received at the MAC layer but is addressed to a different MAC. - 2.14
MPacketOtherMACReceived unsignedLong R [StatsCounter64] The total number of Wi-Fi management packets received from other Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not matching the receiver address, meaning that that the frame is received at the MAC layer but is addressed to a different MAC. - 2.14
CPacketOtherMACReceived unsignedLong R [StatsCounter64] The total number of Wi-Fi control packets received from other Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not matching the receiver address, meaning that that the frame is received at the MAC layer but is addressed to a different MAC. - 2.14
CtsOtherMACReceived unsignedLong R [StatsCounter64] The total number of received Clear to Send (CTS) packets not addressed to the MAC address of this receiver. - 2.14
RtsOtherMACReceived unsignedLong R [StatsCounter64] The total number of received Request to Send (RTS) frames not addressed to the MAC address of this receiver. - 2.14
Device.WiFi.SSID.{i}. object(0:) W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object. WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name 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 BSSID.

Changes in 2.14:

 - 2.0
MACAddress string(:17) R [MACAddress] The MAC address of this interface. If this instance models an access point SSID, MACAddress is the same as BSSID. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
ATFEnable boolean W Enables or disables Air Time Fairness (ATF). - 2.14
FlushATFTable boolean W After this parameter is set to true, the ATF configuration of the interface will be reset. - 2.14
SetATF unsignedInt(0:100) W Configures the ATF setting for all associated devices on an individual SSID. Expressed as percentage of airtime, such that no station should exceed this percentage. - 2.14
Device.WiFi.SSID.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

Changes in 2.14:

 - 2.0
DiscardPacketsSentBufOverflow unsignedLong R [StatsCounter64] The total number of discarded packets during transmission caused by transmit buffer overflow. - 2.14
DiscardPacketsSentNoAssoc unsignedLong R [StatsCounter64] The total number of discarded packets due to the station not being associated. - 2.14
FragSent unsignedLong R [StatsCounter64] The total number of frame-fragments transmitted out of the interface. - 2.14
SentNoAck unsignedLong R [StatsCounter64] The total number of transmitted data packets that did not receive an ACK when expected. - 2.14
DupReceived unsignedLong R [StatsCounter64] The total number of received packets whose Sequence Control field indicates it is a duplicate. - 2.14
TooLongReceived unsignedLong R [StatsCounter64] The total number of received packets longer than the maximum allowed packet length. - 2.14
TooShortReceived unsignedLong R [StatsCounter64] The total number of received packets that did not contain enough bytes for the packet type. - 2.14
AckUcastReceived unsignedLong R [StatsCounter64] The total number of unicast ACKs received, with good Frame Check Sequence (FCS). - 2.14
Device.WiFi.AccessPoint.{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter. For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

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

Changes in 2.14:

 - 2.0
RetryLimit unsignedInt(0:7) W The maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit. This parameter iswas DEPRECATED because it is really a Radio attribute. Use Radio.{i}.RetryLimit. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
MaxAssociatedDevices unsignedInt W The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. This parameter has been DEPRECATED in favor of MaxAllowedAssociations. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 0 2.4
CpeOperationMode string W

Reports information about the CPE operation mode (router or bridge/range extender).

Enumeration of:

  • Router (Indicates indicates operation as a router)
  • Bridge/Extender (Indicates operation as a range extender or acess point in bridge mode)
 Router 2.14
Device.WiFi.AccessPoint.{i}.Security. object R This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007].

Changes in 2.14:

 - 2.0
ModesSupported string[] R

Comma-separated list of strings. Indicates which security modes this AccessPoint instance is capable of supporting. The WPA3-Personal value is the same as WPA3-SAE. The WPA3-Personal-Transition value is the same as WPA2-PSK-WPA3-SAE.

Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA3-Personal
  • WPA-WPA2-Personal
  • WPA3-Personal-Transition
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA3-Enterprise
  • WPA-WPA2-Enterprise
 - 2.0
EncryptionMode string[] W

Comma-separated list of strings. The type of encryption in use. When ModeEnabled is one of WPA3-Personal, WPA3-Personal-Transition, or WPA3-Enterprise, TKIP is not valid, and should not be in the list.

Each list item is an enumeration of:

  • TKIP
  • AES
 - 2.14
SecondaryRadiusServerIPAddr string(:45) W [IPAddress] The IP Address of a secondary RADIUS server used for WLAN security. SecondaryRadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise, WPA3-Enterprise, or WPA-WPA2-Enterprise). The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion [RFC2865]. - 2.5
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object(0:) R

A table of the devices currently associated with the access point.

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

Changes in 2.14:

 - 2.0
Type string R Associated device type (Laptop, iPhone, Android, etc.). - 2.14
SetStaATF unsignedInt(0:100) W Configures the Air Time Fairness (ATF) setting of this individual associated device. Expressed as percentage of airtime, such that this associated device should not exceed this percentage. Setting this value overrides Device.WiFi.SSID.{i}.SetATF for this associated device. - 2.14
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats. object R These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames. The CPE MUST reset these Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Status of the parent AccessPoint object transitions from Disabled to Enabled, or when it transitions from Enabled to Disabled.

Changes in 2.14:

 - 2.8
ErrorsReceived unsignedInt R [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.14
Device.ZigBee. object R Top level object for ZigBee capabilities based on the [ZigBee2007] specification. - 2.7
Device.ZigBee.ZDO.{i}. object(0:) R ZigBee Device Object (ZDO) provides management capabilities of the ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee Device as defined in [Section 2.5/ZigBee2007]. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is “FF:FF:FF:FF:FF:FF:FF:FF” and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more ZDO instances have the same key value the implemenation is undefined - 2.7
Device.ZigBee.ZDO.{i}.ComplexDescriptor. object R The ComplexDescriptor object is an optional descriptor that describes extended capabilities of the ZigBee device as defined in [Section 2.3.2.6 Complex Descriptor/ZigBee2007]. - 2.7
DeviceURL string(:2048) R Specifies the URL[URL] through which more information relating to the ZigBee device can be obtained.

Changes in 2.14:

  • Changed syntax = string -> URL
 - 2.7
IconURL string(:2048) R Specifies the URL[URL] through which the icon for the ZigBee device can be obtained.

Changes in 2.14:

  • Changed syntax = string -> URL
 - 2.7
Device.PPP. object R Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Device.PPP.Interface.{i}. object(0:) W

PPP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]).

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

 - 2.0
Device.PPP.Interface.{i}.PPPoA. object(0:1) R

PPPoA object that functionally groups PPPoA related parameters. This object is OBSOLETED because it contains no standard parameters and its existence causes confusion.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.14:

  • Added status = obsoleted
 - 2.2
Device.IP. object R IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Diagnostics. object R The IP Diagnostics object.

Changes in 2.14:

 - 2.0
IPLayerCapacitySupported boolean R Indicates that IP Layer Capacity measurement is supported. - 2.14
Device.IP.Diagnostics.DownloadDiagnostics. object R 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. - 2.0
DownloadURL string(:2048) W The URL, as defined in [RFC3986],[URL] 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. Note: For time based tests (TimeBasedTestDuration > 0) the Controller MAY add a hint to duration of the test to the URL. See [Section 4.3/TR-143] for more details.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
TimeBasedTestMeasurementInterval unsignedInt(0:999) W The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP download test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 secondsseconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. - 2.9
Device.IP.Diagnostics.UploadDiagnostics. object R 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. - 2.0
UploadURL string(:2048) W The URL, as defined in [RFC3986],[URL] 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.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
TimeBasedTestMeasurementInterval unsignedInt(0:999) W The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP upload test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 secondsseconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. - 2.9
Device.IP.Diagnostics.IPLayerCapacityMetrics. object R This object defines the diagnostics configuration for a IP Layer Capacity test. IP Layer Capacity measurement is specified in [TR-471]. Files received in the IP Layer Capacity test do not require file storage on the CPE device. - 2.14
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_RejectedByRemote (READONLY)
  • Error_IncorrectSize (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and {{enum: non-existent Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

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

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), but not if it is canceled for any reason, 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.

While the test is in progress, setting this parameter to {{enum: non-existent Canceled}} MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the {{enum: non-existent Canceled}} value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_RejectedByRemote (READONLY)
  • Error_IncorrectSize (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 2.14
IPLayerMaxConnections unsignedInt(1:) R Indicates the maximum number of connections that are supported for an IP-Layer Capacity test. - 2.14
IPLayerMaxIncrementalResult unsignedInt(1:) R The maximum number of rows in IncrementalResult that the device will store. - 2.14
IPLayerCapSupportedMetrics string[] R

Comma-separated list of strings. Indicates the test metrics from [Section 5.2/TR-471] that are supported by the device.

Each list item is an enumeration of:

  • IPLR (IP packet Loss Ratio)
  • Sampled_RTT (Sampled Round Trip Time)
  • IPDV (IP packet Delay Variation, OPTIONAL)
  • IPRR (IP packet Reordering Ratio, OPTIONAL)
 - 2.14
Interface string(:256) W Note that [TR-471] mandates support for and use of IPLR and Sampled RTT. The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the device MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.14
Role string W

Indicates whether the device will act as Sender or Receiver of test packets.

Enumeration of:

  • Receiver (The device will act as the Receiver)
  • Sender (The device will act as the Sender)
 - 2.14
Host string(:256) W The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. - 2.14
Port unsignedInt(1:65535) W

Port on the Test Endpoint host.

Active Notification requests for this parameter MAY be denied.

 - 2.14
JumboFramesPermitted boolean W If true, jumbo frames are allowed. Default SHOULD be false. - 2.14
NumberOfConnections unsignedInt(1:) W The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than {{param: non-existent #.IPLayerMaxConnections}}. - 2.14
EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.14
DSCP unsignedInt(0:63) W The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.14
ProtocolVersion string W

Indicates the IP protocol version to be used. The default value SHOULD be Any.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.14
UDPPayloadMin unsignedInt(35:9000) W Minimum reference size of UDP payload in octets. No default. The implementation will algorithmically determine a value if none is configured. The value SHOULD be set to a value that avoids fragmentation (i.e., using path MTU discovery). - 2.14
UDPPayloadMax unsignedInt(35:9000) W Maximum reference size of UDP payload in octets. No default. The implementation will algorithmically determine a value if none is configured. The value SHOULD be set to the largest value that avoids fragmentation (i.e., using path MTU discovery). If JumboFramesPermitted is false, the maximum value MUST be 1472 octets. If JumboFramesPermitted is true, this value can be as large as 9000 octets. UDPPayloadMax MUST be greater than or equal to UDPPayloadMin. - 2.14
PortMin unsignedInt(49152:65535) W Starting value for range of Dynamic Ports supported for test traffic and status feedback messages. - 2.14
PortMax unsignedInt(49152:65535) W Indicates the upper bound of the supported Dynamic Port range, where PortMin indicates the starting port number. PortMax MUST be greater than or equal to PortMin. - 2.14
PortOptionalMin unsignedInt(0,1024:49151) W Starting value for range of User Ports supported for test traffic and status feedback messages. A value of zero (0) indicates no User Ports are used for test traffic or status feedback messages. - 2.14
PortOptionalMax unsignedInt(0,1024:49151) W Indicates the upper bound of the supported User Port range, where PortOptionalMin indicates the starting port number. PortOptionalMax MUST be greater than or equal to PortOptionalMin. A value of zero (0) indicates no User Ports are used for test traffic or status feedback messages. - 2.14
TestType string W

Indicates the type of IP-Layer Capacity test being run. The default value SHOULD be Search.

Enumeration of:

  • Search (Search algorithm will be used to determine sending rate)
  • Fixed (Fixed sending rate will be used)
 - 2.14
IPDVEnable boolean W Enables IPDV (IP packet Delay Variation) metric. Default SHOULD be false. - 2.14
IPRREnable boolean W Enables IPRR (IP packet Reordering Ratio) metric. Default SHOULD be false. - 2.14
PreambleDuration unsignedInt(0:5) W Duration of the preamble testing, when traffic is being sent and/or received but the test clock has not been started. This is done to ensure all network elements in the path are “awake”. The default value SHOULD be 2 seconds. Value specified in seconds. - 2.14
StartSendingRate unsignedInt(500:10000000) W The Sending Rate for a Fixed test or the initial Sending Rate value for a Search test. Value specified in kbps. The default SHOULD be 500 kbps. - 2.14
NumberTestSubIntervals unsignedInt(1:100) W Number of intermediate measurement reporting intervals. The value MUST NOT be greater than {{param: non-existent #.IPLayerMaxIncrementalResult}}. The default value SHOULD be 10. - 2.14
TestSubInterval unsignedInt(100:6000) W Duration of intermediate measurement reporting intervals. TestSubInterval * NumberTestSubIntervals MUST result in an integer value in seconds, in the range 5 seconds <= TestSubInterval * NumberTestSubIntervals <= 60 seconds. The default value SHOULD be 1000 milliseconds. Value specified in milliseconds. - 2.14
StatusFeedbackInterval unsignedInt(5:250) W Period of status feedback message (receiver of offered load returns messages to the sender with results of measured metrics). Value specified in milliseconds. The default SHOULD be 50 milliseconds. - 2.14
TimeoutNoTraffic unsignedInt(5:30) W Timeout value. Value specified in seconds. The default value SHOULD be 5 seconds. - 2.14
Tmax unsignedInt(50:3000) W Maximum waiting time for packets to arrive. Value specified in milliseconds. The default SHOULD be 1000 milliseconds. - 2.14
TmaxRTT unsignedInt(50:3000) W Maximum Round Trip Time waiting time for packets to arrive. Value specified in milliseconds. The default SHOULD be 3000 milliseconds. - 2.14
TimestampResolution unsignedInt(1:1000) W Indicates the requested precision of timestamp values. The test implementation will determine the actual precision to use based on the implemented resolution capabilities of the protocols used and this requested value. If the implemented resolution capabilities of the {{param: non-existent #.IPLayerCapSupportedMetrics}} protocols being used are able to provide the requested resolution, this resolution SHOULD be provided. Value specified in microseconds. The default SHOULD be 1 microseconds. - 2.14
LowerThresh unsignedInt(5:250) W This parameter is only meaningful if TestType is Search. The lower threshold on the range of Round Trip Time (RTT) variation. Value specified in milliseconds. The default SHOULD be 30 milliseconds. - 2.14
UpperThresh unsignedInt(5:250) W This parameter is only meaningful if TestType is Search. The upper threshold on the range of Round Trip Time (RTT) variation. Value specified in milliseconds. The default SHOULD be 90 milliseconds. - 2.14
HighSpeedDelta unsignedInt(2:) W This parameter is only meaningful if TestType is Search. The number of rows to move in a single adjustment when initially increasing offered load (to ramp up quickly). The default SHOULD be 10. - 2.14
SlowAdjThresh unsignedInt(2:) W This parameter is only meaningful if TestType is Search. Threshold on the measured number of consecutive status reports indicating loss and/or delay variation above UpperThresh (SlowAdjCount). The default SHOULD be 2. - 2.14
HSpeedThresh unsignedInt(1:) W This parameter is only meaningful if TestType is Search. Threshold for transition between low and high sending rate step sizes (such as 1Mbps and 100 Mbps). If JumboFramesPermitted is true this may result in use of jumbo frames. The default SHOULD be 1 Gbps. - 2.14
BOMTime dateTime R

Beginning of transmission send/receive time in UTC, which MUST be specified to TimestampResolution precision. If multiple connections are used, then BOMTime is set to the earliest value across all connections. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.14
EOMTime dateTime R

End of transmission in UTC, which MUST be specified to TimestampResolution precision. If multiple connections are used, then EOMTime is set to the latest value across all connections. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.14
TmaxUsed unsignedInt R Configured value of Tmax used in the test. This value is expressed in milliseconds. - 2.14
TestInterval unsignedInt R Duration of the test (either downlink or uplink). This value is expected to equal TestSubInterval * NumberTestSubIntervals. This value is expressed in seconds. - 2.14
MaxIPLayerCapacity decimal R The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 3 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.14
TimeOfMax dateTime R

Time in UTC of end of the sub-interval when MaxIPLayerCapacity was measured. If the value of MaxIPLayerCapacity occurred in multiple sub-intervals, this MUST be the earliest of these sub-intervals. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.14
LossRatioAtMax decimal R Ratio of lost packets to total packets during sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.14
RTTRangeAtMax decimal R The range of Round Trip Time (RTT) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14
PDVRangeAtMax decimal R The range of Packet Delay Variation (PDV) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14
MinOnewayDelayAtMax decimal R The minimum one-way delay during the sub-interval of MaxIPLayerCapacity. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14
ReorderedRatioAtMax decimal R Ratio of reordered packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.14
IncrementalResultNumberOfEntries unsignedInt R The number of entries in the IncrementalResult table. - 2.14
TmaxRTTUsed unsignedInt R Configured value of TmaxRTT used in the test. This value is expressed in milliseconds. - 2.14
TimestampResolutionUsed unsignedInt R Indicates the timestamp resolution of reported results. Value specified in microseconds. - 2.14
Device.IP.Diagnostics.IPLayerCapacityMetrics.IncrementalResult.{i}. object(0:) R Results for time segmented tests (tests where NumberTestSubIntervals > 1). This data is calculated across all connections in the test. A new object is created every TestSubInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when new test is started or results are otherwise cleared. - 2.14
IPLayerCapacity decimal R Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from [TR-471] Equation 1, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. Result is expressed in Mbps with 3 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.14
TimeOfSubInterval dateTime R

Time in UTC of end of sub-interval when IPLayerCapacity was measured. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.14
LossRatio decimal R Ratio of lost packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. - 2.14
RTTRange decimal R The range of Round Trip Time (RTT), for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. See [TR-471] for description of how value is calculated. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14
PDVRange decimal R The range of Packet Delay Variation (PDV), for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. See [TR-471] for description of how value is calculated. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14
MinOnewayDelay decimal R The minimum one-way delay, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14
ReorderedRatio decimal R Ratio of reordered packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. - 2.14
Device.MAP. object R The Mapping of Address and Port (MAP) object [RFC7597] [RFC7599] [RFC7598]. This object applies only to gateway devices that support IPv4 on the LAN side, include a NAT, and typically have only IPv6 connectivity on the WAN side. See the MAP Theory of Operation [Appendix XV/TR-181i2] for a description of the working of this MAP data model. - 2.8
Device.MAP.Domain.{i}. object(0:) W

MAP domain settings [RFC7597] [RFC7599]. Each instance models a MAP domain. MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):

  • MAP-E (TransportMode = Encapsulation) uses an IPv4-in-IPv6 tunnel.
  • MAP-T (TransportMode = Translation) uses stateless NAT64. Note: There is an n:1 relationship between a MAP domain and the associated WANInterface, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own End-user IPv6 prefix and MAP IPv6 address). Note: The Domain table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Domain row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Domain row.

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 the same values for both WANInterface and IPv6Prefix.

 - 2.8
PSIDOffset unsignedInt(0:15) W Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field. This parameter iswas DEPRECATED because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 6 2.8
PSIDLength unsignedInt(0:16) W The length in bits of the Port-set id (PSID) configured in the PSID parameter. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID-len field. This parameter iswas DEPRECATED because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 0 2.8
PSID unsignedInt(0:65535) W Port-set ID (PSID) to use in preference to the value extracted from the Embedded Address (EA) bits. Only the high order PSIDLength bits of the PSID value are used, so the parameter is ignored when PSIDLength is zero. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID field. This parameter iswas DEPRECATED because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 0 2.8
Device.CaptivePortal. object R This object contains parameters relating to the captive portal configuration on the CPE. The captive portal configuration defines the CPE’s upstream HTTP (port 80) traffic redirect behavior. When the captive portal is disabled, upstream HTTP (port 80) traffic MUST be permitted to all destinations. When the captive portal is enabled, upstream HTTP (port 80) traffic MUST be permitted only to destinations listed in the AllowedList; traffic to all other destinations MUST be redirected to the URL. - 2.0
URL string(:2048) W Captive portal URL[URL] to which upstream HTTP (port 80) traffic to destinations not listed in the AllowedList will be redirected. The captive portal URL MUST be an HTTP (not HTTPS) URL. The CPE MUST permit the captive portal URL to be set to an empty string, which has the effect of disabling the captive portal (if Enable is true and the captive portal URL is an empty string, Status MUST be Error_URLEmpty).

Changes in 2.14:

  • Removed string(:2000) syntax
  • Added URL
 - 2.0
Device.Hosts. object R This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts.

Changes in 2.14:

 - 2.0
AccessControlNumberOfEntries unsignedInt R The number of entries in the AccessControl table. - 2.14
Device.Hosts.Host.{i}. object(0:) R

Host table.

At most one entry in this table can exist with a given value for {{param: reference to obsoleted parameter Device.Hosts.Host.{i}.Alias}}, or with a given value for PhysAddress.

 - 2.0
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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. This parameter iswas DEPRECATED because Host is a transient object. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
AddressSource string R

Indicates whether the IP address of the host was allocated by the CPE using DHCP, was assigned to the host statically, or was assigned using automatic IP address allocation. Enumeration of:

  • DHCP
  • Static
  • AutoIP
  • None This parameter iswas DEPRECATED because only None and DHCP made sense (the CPE doesn’t know whether the address is Static or AutoIP). The DHCP case is now handled via the DHCPClient reference. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
LeaseTimeRemaining int(-1:) R DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease. The value MUST be 0 (zero) if the AddressSource is not DHCP. This parameter iswas DEPRECATED because DHCP lease/lifetime information can be accessed via the DHCPClient reference. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
AssociatedDevice string(:256) R The value MUST be the path name of the AssociatedDevice (or equivalent) table row that models the host, or an empty string if either there is no such table or the host isn’t directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point). For example: Device.WiFi.AccessPoint.1.AssociatedDevice.2 - 2.2
VendorClassID string(:255) R Vendor Class Identifier DHCP option (Option 60) of the host. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter iswas DEPRECATED because host-supplied DHCP options can be accessed via the DHCPClient reference. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
ClientID hexBinary(:65535) R A hexbinary string, Client Identifier DHCP option (Option 61) for the specific IP connection of the client. The option value is binary, so an exact match is REQUIRED. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter iswas DEPRECATED because host-supplied DHCP options can be accessed via the DHCPClient reference. This parameter is OBSOLETED in 2.14.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
UserClassID hexBinary(:65535) R A hexbinary string, User Class Identifier DHCP option (Option 77) of the host. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter is DEPRECATED because host-supplied DHCP options can be accessed via the DHCPClient reference.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
Device.Hosts.AccessControl.{i}. object(0:) W

Every instance of this object provides access control for a LAN device. Access is allowed if no instance of AccessControl is defined for a device.

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Active Notification requests for this parameter MAY be denied.

 - 2.14
PhysAddress string(:64) W Unique physical identifier of the device. For many layer 2 technologies this is typically a MAC address. - 2.14
HostName string(:256) W Any user defined name for the device. - 2.14
Enable boolean W Enables or disables this AccessControl entry. false 2.14
AccessPolicy string W

Allows or denies access for a device. If AccessPolicy is set to “Allow”, device access is allowed based on the Schedule objects. Access is enabled if there is no Schedule object defined. If AccessPolicy is set to “Deny”, defined Schedule objects are ignored and no access is allowed for the device.

Enumeration of:

  • Allow
  • Deny
 Allow 2.14
ScheduleNumberOfEntries unsignedInt R The number of entries in the Schedule table. - 2.14
Device.Hosts.AccessControl.{i}.Schedule.{i}. object(0:) W

Each instance of this object provides a schedule where access is enabled.

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.

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Enable boolean W Enables or disables this Schedule entry. false 2.14
Day string[] W

Comma-separated list of strings. Comma-separated list of days which access is enabled. Each list item is an enumeration of:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
 - 2.14
StartTime string(:5) W

Start time of the enable schedule in hh:mm format. [hh] refers to a zero-padded hour between 00 and 23. [mm] refers to a zero-padded minute between 00 and 59. Start time is in local time zone.

Possible patterns:

  • <Empty> (an empty string)
  • ([01][0-9]|2[0-3]):[0-5][0-9]
 - 2.14
Duration unsignedInt(1:) W The duration, in seconds, which the access is enabled. If the StartTime is not defined, duration is the total time access is allowed during a calendar day. If a StartTime is defined, access is allowed for the Duration period starting from StartTime. - 2.14
Device.DNS. object R Properties for Domain Name Service (DNS). - 2.0
Device.DNS.Client. object R Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. - 2.0
Device.DNS.Client.Server.{i}. object(0:) W

This table contains the DNS Server IP address to be used by the DHCP Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller.

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

 - 2.0
DNSServer string(:45) W [IPAddress] DNS server IP addresses.address. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information. - 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

  • DHCP (

Replaced by DHCPv4.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted

, OBSOLETED)

  • DHCPv4
  • DHCPv6
  • RouterAdvertisement
  • IPCP
  • Static Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entires will have their Type set to Static.
 Static 2.0
Device.DNS.Relay. object R DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. - 2.0
Device.DNS.Relay.Forwarding.{i}. object(0:) W

DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.

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

 - 2.0
DNSServer string(:45) W [IPAddress] DNS server IP addresses.address. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information. - 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

  • DHCP (

Replaced by DHCPv4.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted

, OBSOLETED)

  • DHCPv4
  • DHCPv6
  • RouterAdvertisement
  • IPCP
  • Static Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entires will have their Type set to Static.
 Static 2.0
Device.NAT. object R Properties for Network Address Translation (NAT). The entire NAT object only applies to IPv4. - 2.0
Device.NAT.PortMapping.{i}. object(0:) W

Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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 the same values for all of RemoteHost, ExternalPort and Protocol.

 - 2.0
LeaseDuration unsignedInt W

Determines the time to live, in seconds, of a port mapping lease, where “time to live” means the number of secondsseconds before the port mapping expires. A value of 0 means the port mapping is static. Support for dynamic (non-static) port mappings is OPTIONAL. That is, the only value for LeaseDuration that MUST be supported is 0. For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time remaining on the port mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port mapping lease expires, the CPE MUST automatically terminate that port mapping, and MUST automatically delete the corresponding PortMapping table entry.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.PCP. object R Properties for Port Control Protocol (PCP) [RFC6887]. See the PCP Theory of Operation [Appendix XIV/TR-181i2] for a description of the working of this PCP data model. - 2.8
Device.PCP.Client.{i}. object(0:) W

Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in [RFC6887] for internal device applications or LAN device applications via Interworking functions.

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

 - 2.8
Device.PCP.Client.{i}.Server.{i}. object(0:) W

This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per [RFC7291]. Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a Server instance. If an option returns multiple addresses then that Server instance has multiple addresses.

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

 - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. object(0:) W

Inbound Mapping table. This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in [Section 11/RFC6887]. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping. For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

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 the same values for all of InternalPort, ProtocolNumber and ThirdPartyAddress.

 - 2.8
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. object(0:) W

Outbound Mapping table. This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in [Section 12/RFC6887]. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping. For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

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 the same values for all of InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort.

 - 2.8
Device.UPnP. object R This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 2.0
Device.UPnP.Device. object R This object defines the UPnP devices and UPnP services that are implemented by the CPE.

Changes in 2.14:

 - 2.0
UPnPQoSDevice boolean W Enables/Disables UPnP QoS Device. - 2.0
Device.UPnP.Discovery. object R 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. - 2.0
Device.UPnP.Discovery.RootDevice.{i}. object(0:) R

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.

 - 2.0
Location string(:2048) R The value of the LOCATION header for this UPnP root device, which is the URL[URL] of the root device’s DDD (Device Description Document).

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
Device.UPnP.Discovery.Device.{i}. object(0:) R

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.

 - 2.0
Location string(:2048) R The value of the LOCATION header for this UPnP embedded device, which is the URL[URL] of the root device’s DDD (Device Description Document).

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
Device.UPnP.Discovery.Service.{i}. object(0:) R

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.

 - 2.0
Location string(:2048) R The value of the LOCATION header for this UPnP embedded service, which is the URL[URL] of the root device’s DDD (Device Description Document).

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.0
Device.UPnP.Description. object R This object contains information from the Description Document discovered from the UPnP Devices and Services. - 2.6
Device.UPnP.Description.DeviceDescription.{i}. object(0:) R

This table contains information read from the Device Description Document of discovered root devices. The CPE MAY, but need not, retain some or all of the information in this table after the associated SSDP advertisement (objects in the UPnP.Discovery. object tables) expires. In case the SSDP advertisement expires and the CPE deletes the related instances from the tables in UPnP.Discovery., the reference to such instances MUST be set to the empty string.

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

 - 2.6
URLBase string(:2048) R The value extracted from the URLBase element in the Device Description Document of the discovered root device. If the URLBase element in the root device’s Device Description Document is empty or absent, the URL[URL] from which the device description was retrieved (e.g. the LOCATION from the SSDP message) is utilized as the URLBase. Note: the URLBase element is not recommended by [UPnP-DAv1] and is not permitted by [UPnP-DAv11], so the value of URLBase will usually be the URL from which the device description was retrieved.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.6
Device.UPnP.Description.DeviceInstance.{i}. object(0:) R

This table contains the information from Device Description Document retrieved for a discovered UPnP root or embedded device.

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

 - 2.6
ManufacturerURL string(:2048) R [URL] The value of the UPnP manufacturerURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.6
ModelURL string(:2048) R [URL] The value of the UPnP modelURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.6
PresentationURL string(:2048) R [URL] The value of the UPnP presentationURL element in the Device Description Document for this DeviceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the presentationURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the presentationURL is not provided by the device then this value MUST be an empty string.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.6
Device.UPnP.Description.ServiceInstance.{i}. object(0:) R

This table contains the information from Device Description Document retrieved for a discovered UPnP service.

At most one entry in this table can exist with the same values for both ParentDevice and ServiceId.

 - 2.6
SCPDURL string(:2048) R The value of the UPnP SCPDURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL.[URL]. The way to obtain an absolute URL from the SCPDURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the SCPDURL is not provided by the device then this value MUST be an empty string.

Changes in 2.14:

  • Changed syntax = string -> URL
 - 2.6
ControlURL string(:2048) R The value of the UPnP controlURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL.[URL]. The way to obtain an absolute URL from the controlURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the controlURL is not provided by the device then this value MUST be an empty string

Changes in 2.14:

  • Changed syntax = string -> URL
 - 2.6
EventSubURL string(:2048) R The value of the UPnP eventSubURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL.[URL]. The way to obtain an absolute URL from the eventSubURLL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the eventSubURL is not provided by the device then this value MUST be an empty string

Changes in 2.14:

  • Changed syntax = string -> URL
 - 2.6
Device.Firewall. object R Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. See [Appendix VIII/TR-181i2] for an example Advanced configuration. - 2.0
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. This value is DEPRECATED because it is the same as setting Enable to false.

Changes in 2.14:

  • Changed status = deprecated ⇒ obsoleted

, OBSOLETED)

  • Advanced (Advanced firewall configuration applies, as specified by AdvancedLevel, OPTIONAL) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to.
 - 2.0
Device.FAP. object R This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 2.4
Device.FAP.PerfMgmt. object R This object contains parameters relating to Performance Management in a Femto-related environment. - 2.4
Device.FAP.PerfMgmt.Config.{i}. object(0:) W

This object contains parameters relating to File Management configuration for uploading of Performance Files to a designated File Server. Each table entry can be referenced by zero or more radio-specific objects contained in the FAPService instances. The periodic upload will upload data for all of the radio-specific objects that reference it.

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 the same values for all of URL, PeriodicUploadInterval and PeriodicUploadTime.

 - 2.4
URL string(:2048) W URL[URL] specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.

Changes in 2.14:

  • Removed string(:256) syntax
  • Added URL
 - 2.4
Device.FAP.ApplicationPlatform. object R This object defines the data model for the following Femtozone APIs.
  • Femto Awareness
  • SMS
  • MMS
  • Terminal Location Femto Awareness, SMS, MMS, and Terminal Location APIs are defined in the Release 1 API Specifications of the Service SIG in the Femto Forum (non public document). [Appendix I/TR-262] provides the “Theory of Operation” for the usage of this object.
 - 2.4
Device.FAP.ApplicationPlatform.Control. object R This object contains parameters related to the operation of the Femtozone APIs. - 2.4
Device.FAP.ApplicationPlatform.Control.FemtoAwareness. object R This object contains parameters related to the Femto Awareness API.

Changes in 2.14:

 - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to Femto Awareness API.

Enumeration of:

  • FiFo
  • Priority
 - 2.4
Device.FAP.ApplicationPlatform.Control.SMS. object R This object contains parameters related to the SMS API.

Changes in 2.14:

 - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to SMS API.

Enumeration of:

  • FiFo
  • Priority
 - 2.4
Device.FAP.ApplicationPlatform.Control.MMS. object R This object contains parameters related to the MMS API.

Changes in 2.14:

 - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to MMS API.

Enumeration of:

  • FiFo
  • Priority
 - 2.4
Device.FAP.ApplicationPlatform.Control.TerminalLocation. object R This object contains parameters related to the TerminalLocation API.

Changes in 2.14:

 - 2.4
Queueing string W

Determines how FAP handles simultaneous requests from different Applications to TerminalLocation API.

Enumeration of:

  • FiFo
  • Priority
 - 2.4
Device.BulkData. object R This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in [TR-232]. The HTTP solution is based on transfer mechanisms described in **{{templ: non-existent **{{template: non-existent }}****BULK-DATA-HTTP-REF}}. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. - 2.5
Device.BulkData.Profile.{i}. object(0:) W

A set of Bulk Data Collection profiles. Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data.

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.

 - 2.5
FileTransferURL string(:2048) W This is the URL[URL] within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.5
Device.BulkData.Profile.{i}.Parameter.{i}. object(0:) W Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported. - 2.5
Name string(:64) W Name of the parameter in the report body. If the value of this parameter is an empty string, then the value of the Reference parameter is used as the name. When the value Reference parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in [Annex N/TR-069][Annex N.3.1/TR-069]. - 2.10
Device.BulkData.Profile.{i}.CSVEncoding. object R This object defines the properties to be used when the Profile object’s EncodingType parameter value is CSV. - 2.10
ReportFormat string W

This parameter describes the formatting used for reports defined by this profile as described in [Annex N.3.4/TR-069][Annex N.3.4/TR-069]. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616].

Enumeration of:

  • ParameterPerRow (Reports are formatted with each parameter formatted as a row entry)
  • ParameterPerColumn (Reports are formatted with each parameter formatted as a column entry)
 ParameterPerColumn 2.10
RowTimestamp string W

The format of the timestamp to use for data inserted into the row.

Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format**{{template: non-existent }}**BULK-DATA-TIMESTAMP.)
  • None (Timestamp is not inserted in the row)
 Unix-Epoch 2.10
Device.BulkData.Profile.{i}.JSONEncoding. object R This object defines the properties to be used when the Profile object’s EncodingType parameter value is JSON. - 2.10
ReportFormat string W

This parameter describes the formatting used for the report as described in [Annex N.3.5/TR-069][Annex N.3.5/TR-069]. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in [RFC2616].

Enumeration of:

  • ObjectHierarchy (Reports are formatted with each object in the object hierarchy of the data model encoded as a corresponding hierarchy of JSON Objects with the parameters of the object specified as name/value pairs of the JSON Object)
  • NameValuePair (Reports are formatted with each parameter of the data model encoded as a corresponding array of JSON Objects with the parameters specified as name/value pairs)
 ObjectHierarchy 2.10
ReportTimestamp string W

The format of timestamp to use for the JSON Object named “CollectionTime” as described in [Annex N.3.5.1/TR-069][Annex N.3.5/TR-069].

Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format**{{template: non-existent }}**BULK-DATA-TIMESTAMP.)
  • None (Timestamp is not inserted)
 Unix-Epoch 2.10
Device.BulkData.Profile.{i}.HTTP. object R This object defines the properties to be used when transporting bulk data using the HTTP/HTTPS protocol. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the CPE MUST support HTTP Basic and Digest Access Authentication as defined in [RFC2616]. - 2.10
URL string(:2048) W The URL, as defined in [RFC3986],[URL] for the collection server to receive the Bulk Data transmitted by the CPE.

Changes in 2.14:

  • Removed string(:1024) syntax
  • Added URL
 - 2.10
RetryMinimumWaitInterval unsignedInt(1:65535) W Configures the data transfer retry wait interval, in seconds, as specified in [Annex N.2.2.1/TR-069][Annex N.2.2.1/TR-069]. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 5 2.10
RetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in [Annex N.2.2.1/TR-069][Annex N.2.2.1/TR-069]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 2000 2.10
Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. object(0:) W This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by [Annex N.2.1/TR-069][Annex N.2.1/TR-069]. - 2.10
Device.XMPP. object R The XMPP represents the XMPP capabilities of the device, as described in [Appendix III/TR-069]., as described in [Appendix III/TR-069]. - 2.7
Device.XMPP.Connection.{i}. object(0:) W

The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device.

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 the same values for all of Username, Domain and Resource.

 - 2.7
ServerRetryInitialInterval unsignedInt(1:65535) W The maximum first reconnection wait interval, in seconds**{{templ: non-existent **{{template: non-existent }}****XMPP-REF}}. The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval. NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 60 2.7
ServerRetryIntervalMultiplier unsignedInt(1000:65535) W The reconnection interval multiplier**{{templ: non-existent **{{template: non-existent }}****XMPP-REF}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1). NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 2000 2.7
Device.IEEE1905. object R This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. - 2.9
Device.IEEE1905.AL. object R This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.Interface.{i}. object(0:) R

The 1905 interface table (described in [Sub-clause 5 Abstraction Layer Management/IEEE1905.1a]).

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

 - 2.9
GenericPhyURL string(:2048) R URL[URL] to the Generic Phy XML Description of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a].

Changes in 2.14:

  • Changed syntax = string(:1024) -> URL
 - 2.9
Device.IEEE1905.AL.Interface.{i}.Link.{i}. object(0:) R

This object defines the 1905 neighbors and link properties.

At most one entry in this table can exist with the same values for both InterfaceId and IEEE1905Id.

 - 2.9
GenericPhyURL string(:2048) R URL[URL] to the Generic Phy XML Description of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message URL to Generic Phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a].

Changes in 2.14:

  • Changed syntax = string(:1024) -> URL
 - 2.9
Device.IEEE1905.AL.NetworkTopology. object R This object represents the 1905 Network Topology capabilities of this device. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. object(0:) R

This object represents an instance of discovered 1905 Devices in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]).

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

 - 2.9
ControlURL string(:2048) R Control URL[URL] received in Higher Layer response message as defined in defined in [Table 6-31: Control URL Type TLV/IEEE1905.1a].

Changes in 2.14:

  • Changed syntax = string(:1024) -> URL
 - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.Interface.{i}. object(0:) R

This object represents an instance of an interface for the IEEE1905Device.

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

 - 2.9
GenericPhyURL string(:2048) R URL[URL] to the Generic Phy XML Description of the Generic Phy networking technology of this Interface. This value is from a Generic Phy response message URL to generic phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a].

Changes in 2.14:

  • Changed syntax = string(:1024) -> URL
 - 2.9
Device.MQTT. object R MQTT Base object describing all MQTT related parameters and objects. - 2.10
Device.MQTT.Client.{i}. object(0:) W

MQTT client table. Contains a list of configured MQTT clients.

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

Changes in 2.14:

 - 2.10
EnableEncryption boolean W When true, encryption MUST be used for this MQTT Client instance. true 2.14
CleanSession boolean W The value of the MQTT clean session flag in the MQTT CONNECT packet (see [Section 3.1/MQTT31] and [Section 3.1.2.4/MQTT31]). If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} This parameter only applies if ProtocolVersion is set to 3.1 or 3.1.1. true 2.10
CleanStart boolean W The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50]. If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}}. **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} true 2.13
WillEnable boolean W Enables or disables the will handling (see [Section 3.1/MQTT31], [Section 3.1.2.5/MQTT31]) or [Section 3.1.2.5/MQTT50]). If the connection gets enabled and this parameter is set to true and either the parameter WillTopic or WillValue are an empty string, the CPE MUST set the Status to Error_Misconfigured. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}}. - 2.10
WillQoS unsignedInt(0:2) W The MQTT QoS level assigned with the will message (see [Section 3.1/MQTT31], [Section 3.1.2.6/MQTT31]) or [Section 3.1.2.6/MQTT50]). This parameter is only used if WillEnable is set to true. **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} - 2.10
WillRetain boolean W Indicate to the MQTT broker to retain the Will over a Disconnect (see [Section 3.1/MQTT31], [Section 3.1.2.7/MQTT31]) or [Section 3.1.2.7/MQTT50]). This parameter is only used if WillEnable is set to true. **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} - 2.10
KeepAliveTime unsignedInt(:65535) W Keep Alive Time in seconds defines the maximum wait time after which a packet has to be sent to the MQTT broker (see [Section 3.1/MQTT31], [Section 3.1.2.10/MQTT31]) or [Section 3.1.2.10/MQTT50]). If no regular packet can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive packets are sent and the MQTT client is not disconnected by the server. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} 60 2.10
SessionExpiryInterval unsignedInt W Session expiry interval in seconds defines the wait time before a session expires after the connection has been closed by the MQTT client [Section 3.1.2.11.2/MQTT50]). **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
ReceiveMaximum unsignedInt W The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see [Section 3.1.2.11.3/MQTT50]). **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
MaximumPacketSize unsignedInt W The maximum packet size in byte the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet [Section 3.1.2.11.4/MQTT50]). **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
TopicAliasMaximum unsignedInt(:65535) W This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see [Section 3.1.2.11.5/MQTT50]). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection. A value of 0 indicates that Topic Alias is not supported. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
RequestResponseInfo boolean W The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see [Section 3.1.2.11.6/MQTT50]). **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
RequestProblemInfo boolean W This value indicates whether the Reason String or User Properties are sent in the case of failures.(see [Section 3.1.2.11.7/MQTT50]). **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
AuthenticationMethod string(0:256) W This value defines the extended authentication method to be used (see [Section 3.1.2.11.9/MQTT50]). If the parameter is empty, no extended authentication is performed. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
ClientID string(0:65535) W The MQTT client identifier used in the MQTT CONNECT packet (see [Section 3.1/MQTT31], [Section 3.1.3.1/MQTT31]) or [Section 3.1.3.1/MQTT50]). If ProtocolVersion is set to 3.1 or 3.1.1, this parameter MUST NOT be an empty string. If ProtocolVersion is set to 5.0, an empty string is allowed. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} - 2.10
WillDelayInterval unsignedInt W The delay in seconds after the session is disconnected, before sending the Will message [Section 3.1.3.2.2/MQTT50]). A value of 0 indicates that there is no delay. **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} 5 2.13
WillMessageExpiryInterval unsignedInt W The lifetime in seconds of a Will Message (see [Section 3.1.3.2.4/MQTT50]). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
WillContentType string(:256) W Describes the type of the WillValue [Section 3.1.3.2.5/MQTT50]). **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
WillResponseTopic string(:65535) W Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request [Section 3.1.3.2.6/MQTT50]). If the WillResponseTopic is an empty string the will response topic will not be sent in a MQTT CONNECT packet. **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
WillTopic string(:65535) W The Topic sent in the Will Message (see [Section 3.1/MQTT31], [Section 3.1.3.3/MQTT31]) or [Section 3.1.3.3/MQTT50]). This parameter is only used if WillEnable is set to true. **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} - 2.10
WillValue string(:65535) W The value sent in the Will Message (see [Section 3.1/MQTT31], [Section 3.1.2.5/MQTT31]) or [Section 3.1.3.4/MQTT50]). This parameter is only used if WillEnable is set to true. **{{templ: non-existent **{{template: non-existent }}****MQTTWillChange}} - 2.10
PublishMessageExpiryInterval unsignedInt W The lifetime in seconds of a PUBLISH Message (see [Section 3.3.2.3.3/MQTT50]). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. **{{templ: non-existent **{{template: non-existent }}****MQTT50ONLY}} - 2.13
Device.MQTT.Broker.{i}. object(0:) W

MQTT broker table. Contains a list of configured MQTT brokers.

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

 - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object(0:) W

Configures MQTT bridges, which are used to communicate with other MQTT brokers.

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

 - 2.10
CleanSession boolean W The value of the MQTT clean session flag in the MQTT CONNECT packet (see [Section 3.1/MQTT31] and [Section 3.1.2.4/MQTT31]) to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} This parameter only applies if ProtocolVersion is set to 3.1 or 3.1.1. true 2.10
CleanStart boolean W The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50] to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}}. This parameter only applies if ProtocolVersion is set to 5.0. true 2.13
KeepAliveTime unsignedInt(:65535) W Keep Alive Time in seconds defines the maximum wait time after which a packet has to be sent to the remote MQTT broker (see [Section 3.1/MQTT31], [Section 3.1.2.10/MQTT31]) or [Section 3.1.2.10/MQTT50]). If no regular packet can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive packets are sent and the bridge is not disconnected by the server. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} 60 2.10
ClientID string(0:65535) W The MQTT client identifier used in the CONNECT packet (see [Section 3.1/MQTT31], [Section 3.1.3.1/MQTT31]) or [Section 3.1.3.1/MQTT50]). If ProtocolVersion is set to 3.1 or 3.1.1, this parameter MUST NOT be an empty string. If ProtocolVersion is set to 5.0, an empty string is allowed. **{{templ: non-existent **{{template: non-existent }}****MQTTReconnect}} - 2.10
Device.LMAP. object R This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. - 2.12
Device.LMAP.MeasurementAgent.{i}. object(0:) W

This object represents the measurement agent that performs measurement tasks and reporting functions defined in [RFC7594].

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

 - 2.12
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}. object(0:) W

This object represents the properties communication channel used to establish communication between a measurement agent and other elements of the LMAP framework (e.g., measurement controller, measurement collector). The value of the Name parameter used for conveying information is defined as an option in the Task’s or scheduled Task’s option parameter. When this object uses the BulkData capability, a BulkData.Profile.{i} object instance referred to by this object.

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.

 - 2.12
Target string(:2048) W The URL[URL] of the LMAP component that is the target of this communication channel.

Changes in 2.14:

  • Changed syntax = string(:256) -> URL
 - 2.12
Device.WWC. object R Base object for Wireline Wireless Convergence. The controller can use this object to learn the supported 5G features and whether the 5G-RG is operating in 5G mode. - 2.14
HwCapabilities string[] R

Comma-separated list of strings. Wireline Wireless Convergence hardware capabilities supported by the CPE. Each list item is an enumeration of:

  • NG-RAN (Able to use the 5G Radio Access Network)
  • E-UTRAN (Able to use the 4G (LTE) Radio Access Network)
  • W-5GAN (Able to use fixed access networks)
 - 2.14
SwCapabilities string[] R

Comma-separated list of strings. Wireline Wireless Convergence software capabilities supported by the CPE. Each list item is an enumeration of:

  • FN-RG (Able to use PPPoE or IPoE as specified in [TR-124i5] or earlier)
  • 5G-RG (Able to use 5G capabilities such as specified in [TR-124i6])
  • ATSSS (Able to support multi access PDUs using Access Traffic Steering Switching Splitting (ATSSS))
 - 2.14
Mode string W

Sets the mode the CPE is operating in. Whilst the CPE is expected to auto-negotiate, a service provider may need to lock the CPE in FN-RG or 5G-RG mode for stability. Enumeration of:

  • FN-RG (The CPE only attempts to authenticate using PPPoE or IPoE)
  • 5G-RG (The CPE only attempts to register using 5G NAS)
  • Auto (The CPE may operate in either mode)

The factory default value MUST be Auto.

 - 2.14
Status string R

The mode the CPE is operating in. A CPE in Negotiating is deemed to be auto-negotiating its operational mode. Enumeration of:

  • FN-RG
  • 5G-RG
  • Negotiating
 - 2.14
AccessNetworkNumberOfEntries unsignedInt R The number of entries in the AccessNetwork table. - 2.14
URSPNumberOfEntries unsignedInt R The number of entries in the URSP table. - 2.14
Device.WWC.AccessNetwork.{i}. object(0:) R

Each table entry describes a single access network. The entire table is built by the 5G-RG upon startup. The primary purpose is to show the registration and connectivity status of each access network. Typically a 5G-RG would register on each available access network. A minimum of one access network must be in the CM-CONNECTED state in order to support N1 messaging.

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Name string(:64) R The textual name of the Access Network entry as assigned by the CPE. - 2.14
Interface string(:256) W The value MUST be the Path Name of a table row. Specifies the egress interface associated with this “AccessNetwork” entry. This MUST be a layer 1 interface. - 2.14
RegistrationStatus string R

The registration status of this entry. See [Clause 5.3.2/3GPP-TS.23.501]. Enumeration of:

  • RM_REGISTERED (The 5G-RG has sucessfully authenticated and has been assigned an AMF to manage it)
  • RM_DEREGISTERED (The 5G-RG is no longer managed by an AMF)
  • RM_UNDEFINED (The access network will always start in this state and indicates that the 5G-RG has never registered to the access network. This state is only used by the 5G-RG and is never present in the AMF)
  • Error (The LastError parameter is updated with the detail of this error) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.14
ConnectionStatus string R

The connection status of this entry. A 5G-RG is deemed in the CM_CONNECTED state if there is a NAS signalling connection established between the 5G-RG and AMF. If RegistrationStatus transitions from RM_REGISTERED to RM_DEREGISTERED, the status of ConnectionStatus must change to CM_UNDEFINED. See [Clause 5.3.3/3GPP-TS.23.501]. Enumeration of:

  • CM_IDLE (The 5G-RG does not have a NAS connection over N1 to the AMF)
  • CM_CONNECTED (The 5G-RG does have a NAS connection over N1 to the AMF)
  • CM_UNDEFINED (The access network will always start in this state and indicates that the 5G-RG is not registered to the access network. This state is only used by the 5G-RG and is never present in the AMF)
  • Error (The LastError parameter is updated with the detail of this error) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.14
AccessNetworkType string R

The access network type of this entry. Enumeration of:

  • NG-RAN
  • E-UTRAN
  • W-5GAN
 - 2.14
LastError unsignedInt R Error code. See [Clause 9.11.4.2/3GPP-TS.24.501] - 2.14
Device.WWC.AccessNetwork.{i}.GUTI. object R A 5G Globally Unique Temparary Identity (GUTI) securely identifes an CPE by keeping the permanent User Equipment (UE identifier (IMSI) hidden. This identity is globally unique and assigned by the AMF at the time of registration. See [.Clause 2.10/3GPP-TS.23.003]. - 2.14
PLMN unsignedInt R The Public Land Mobile Network (PLMN) globally identifies the service provider. A PLMN consists of a country code (MCC) and a network code (MNC). See [Clause 12.1/3GPP-TS.23.003]. For example, a PLMN of 50101 refers to MCC 501 (Australia) and MNC 01 (Telstra). - 2.14
AMFId unsignedInt R The AMFId identifies an AMF instance within a service provider’s network. In conjunction with the PLMN, it forms a Globally Unique AMF Id (GUAMI) which globally uniquely identifes an AMF. See [Clause 2.10/3GPP-TS.23.003]. - 2.14
TMSI unsignedInt R The Temporary Mobile Subscriber Identity (TMSI) is allocatred by the AMF at the time of registration and uniquely identifies the CPE. See [Clause 2.4/3GPP-TS.23.003]. - 2.14
Device.WWC.URSP.{i}. object(0:) R

User equipment Router Selection Policy (URSP) is a table of rules used to determine which network slice and data network to route a PDU over. Typically a 5G-RG would search the URSP table in precedence order matching the traffic descriptor types against the service it was setting up. For example a 5G-RG would search for ‘connection capabilities’ matching ‘ims’ in order to establish a dedicated PDU session for telephony. See [Clause 5.2/3GPP-TS.24.526] for a full descrption of the URSP data elements.

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Precedence unsignedInt(0:255) R The precedence value of URSP rule field is used to specify the precedence of the URSP rule among all URSP rules in the URSP. The precedence value in the range from 0 to 255 (decimal). The higher the value of the precedence value field, the lower the precedence of the URP rule is. Multiple URSP rules in the URSP shall not have the same precedence value. - 2.14
TrafficDescriptorNumberOfEntries unsignedInt R The number of entries in the TrafficDescriptor table. - 2.14
Device.WWC.URSP.{i}.TrafficDescriptor.{i}. object(0:) R

A set of rules for a given precedence that must be matched in order to select a router in the form of data network and slice. Selection criteria range from destination IP addresses to connection capabilities.

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Type unsignedInt R Traffic Descriptor Type. See [Clause 5.2/3GPP-TS.24.526]. - 2.14
Value string(:1024) R Traffic descriptor value. See [Clause 5.2/3GPP-TS.24.526]. - 2.14
RouteSelectionDescriptorNumberOfEntries unsignedInt R The number of entries in the RouteSelectionDescriptor table. - 2.14
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}. object(0:) R

This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established. See ((bibref|3GPP-TS.23.503|Annex A for an example URSP rule traversal.}}

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Precedence unsignedInt(0:255) R The precedence value of route selection descriptor field is used to specify the precedence of the route selection descriptor among all route selection descriptors in the URSP rule. The precedence value in the range from 0 to 255 (decimal). The higher the value of the precedence value field, the lower the precedence of the route selection descriptor is. - 2.14
SSC unsignedInt(1:3) R Session and Service Continuity (SSC) Mode: Indicates that the traffic of the matching application shall be routed via a PDU Session supporting the included SSC Mode. See [Clause 9.11.4.16/3GPP-TS.24.501]. - 2.14
DNN string(:100) R The DNN value contains an APN as defined in [Clause 9.1.1/3GPP-TS.23.003]. - 2.14
PDUSessionType string R

PDU session type. See [Clause 9.11.4.11/3GPP-TS.24.501]. Enumeration of:

  • IPv4
  • IPv6
  • IPv4v6
  • Unstructured
 - 2.14
AccessType string R

The preferred access type for the PDU session. For a 5G-RG non-3GPP refers to any fixed access technology. See [Clause 9.11.3.11/3GPP-TS.24.501]. Enumeration of:

  • 3GPP access
  • Non-3GPP access
 - 2.14
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}.NetworkSlice. object R Describes a S-NSSAI Information element providing network slice specification. See [Clause 9.11.2.8/3GPP-TS.24.501] - 2.14
SliceServiceType string R

[SST] The Slice Service Type (SST). Enumeration of:

  • eMBB (5G Enhanced Mobile Broadband)
  • URLLC (Ultra-Reliable Low Latency Communications)
  • MIoT (Massive IoT)
  • V2X (Vehicle to Everything) See [Clause 5.15.2.2/3GPP-TS.23.501].
 - 2.14
SliceDifferentiator unsignedInt R The Slice differentiator is an optional number used to differentiate network slices with the same SST. See [Clause 5.15.2.1/3GPP-TS.23.501]. - 2.14
Device.PDU. object R The logical connection between the 5G-RG and data network is the Protocol Data Unit (PDU). The Device.PDU subtree describes each PDU sessions properties together with the QoS rules specific to that PDU session. - 2.14
SessionNumberOfEntries unsignedInt R The number of entries in the Session table. - 2.14
Device.PDU.Session.{i}. object(0:) R

Contains all the properties of a PDU session instance, ranging from maximum bitrate through to assigned network slice. This object contains the Session table.

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.
 - 2.14
Interface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the PDU entry. - 2.14
SessionID unsignedInt(1:15) R PDU session identity. See [Clause 9.4/3GPP-TS.24.501]. - 2.14
PTI unsignedInt(1:254) R Procedure transaction identity. See [Clause 9.6/3GPP-TS.24.501]. - 2.14
SessionType string R

The PDU session type indicating the protocol the PDU is capable of carrying. See [Clause 9.11.4.11/3GPP-TS.24.501]. Enumeration of:

  • IPv4
  • IPv6
  • IPv4v6
  • Unstructured
 - 2.14
SSC unsignedInt(1:3) R Session and Service Continuity (SSC) Mode: Indicates that the traffic of the matching application shall be routed via a PDU Session supporting the included SSC Mode. See [Clause 9.11.4.16/3GPP-TS.24.501] - 2.14
SessionAMBRDownlink unsignedLong R Downlink Aggregate Maximum Bit Rate in bits per second. See [Clause 9.11.4.14/3GPP-TS.24.501]. - 2.14
SessionAMBRUplink unsignedLong R Uplink Aggregate Maximum Bit Rate in bits per second. See [Clause 9.11.4.14/3GPP-TS.24.501]. - 2.14
LastError unsignedInt R Error code. See [Clause 9.11.4.2/3GPP-TS.24.501] - 2.14
PDUIPv4Address string(:45) R [IPv4Address] The IPv4 address allocated to the PDU session by the SMF. This parameter is only valid if SessionType has a value of IPv4 or IPv4v6. See [Clause 9.11.4.10/3GPP-TS.24.501]. - 2.14
PDUIPv6InterfaceIdentifier string R The interface identifier for the IPv6 link local address allocated to the PDU session by the SMF. This parameter is only valid if SessionType has a value of IPv6 or IPv4v6. See [Clause 9.11.4.10/3GPP-TS.24.501]. - 2.14
RQTimerValue unsignedInt R Reflective QoS timeout in seconds. See [Clause 9.11.2.3/3GPP-TS.24.501]. - 2.14
AlwaysOn boolean R Always on PDU session indication. The purpose of the Always-on PDU session indication information element is to indicate whether a PDU session is established as an always-on PDU session. See [Clause 9.11.4.3/3GPP-TS.24.501]. - 2.14
DNN string(:100) R The Data Network Name used by the PDU. The DNN value may be from the optional S-NSSAI specified at the time of PDU establishment or a default determined by the 5G core. A DNN is analagous to an LTE APN used the same format defined in [Clause 9.11.2.1A/3GPP-TS.24.501]. - 2.14
QoSRuleNumberOfEntries unsignedInt R The number of entries in the QoSRule table. - 2.14
QoSFlowNumberOfEntries unsignedInt R The number of entries in the QoSFlow table. - 2.14
Device.PDU.Session.{i}.PCO. object R Policy Configuration Options (PCO) is an optional set of configuration parameters supplied by the network at the request of the 5G-RG as defined in [Clause 10.5.6.3/3GPP-TS.24.008]. - 2.14
IPv6PCSCF string(:45) R [IPv6Address] The IPv6 address of the P-CSCF used for VoLTE telephony. - 2.14
IPv6DNS string(:256) R A comma separated list of IPv6 DNS servers. - 2.14
IPv4PCSCF string(:45) R [IPv4Address] The IPv4 address of the P-CSCF used for VoLTE telephony. - 2.14
IPv4DNS string(:256) R A comma separated list of IPv4 DNS servers. - 2.14
Device.PDU.Session.{i}.NetworkSlice. object R Describes a S-NSSAI Information element providing network slice specification. See [Clause 9.11.2.8/3GPP-TS.24.501] - 2.14
SliceServiceType string R

[SST] The Slice Service Type (SST). Enumeration of:

  • eMBB (5G Enhanced Mobile Broadband)
  • URLLC (Ultra-Reliable Low Latency Communications)
  • MIoT (Massive IoT)
  • V2X (Vehicle to Everything) See [Clause 5.15.2.2/3GPP-TS.23.501].
 - 2.14
SliceDifferentiator unsignedInt R The Slice differentiator is an optional number used to differentiate network slices with the same SST. See [Clause 5.15.2.1/3GPP-TS.23.501]. - 2.14
Device.PDU.Session.{i}.QoSRule.{i}. object(0:) R

This object describes the PDU QoS Rule table. The purpose of the QoS Rule table is to assign a QFI to mark traffic based on a set of classification rules. The rules are set by the netowrk operator and are specific for each PDU. For example:

  • A QoS Rule with a default used for general traffic has the following parameters.
  • QFI=1
  • DQR=1 - Default rule
  • Filter 1 for rule
  • Direction=bidirectional
  • Type=1 - Match all
  • A QoS Rule matchihg a voice service.
  • QFI=32
  • DQR=0
  • Filter 1 for rule
  • Direction=bidirectional
  • Type=33 - Destination IPv6 range
  • Value=2001:8000/48 - Destination IPv6 range
  • Filter 2 for rule
  • Direction=bidirectional
  • Type=16 - Destination IPv4 address with netmask
  • Value=203.1.0.0 255.255.255.0 - Destination IPv4 address with netmask A full description can be found at [Clause 9.11.4.13/3GPP-TS.24.501] QoS Rules

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Identifier unsignedInt(1:255) R The QoS rule identifier field is used to identify the QoS rule. - 2.14
Precedence unsignedInt(0:255) R The QoS rule precedence field is used to specify the precedence of the QoS rule among all QoS rules. The higher the value of the QoS rule precedence field, the lower the precedence of that QoS rule is. - 2.14
Segregation boolean R In the UE to network direction the segregation bit indicates whether the UE is requesting the network to bind service data flows described by the QoS rule to a dedicated QoS Flow. When true segregation is requested. - 2.14
QFI unsignedInt(1:63) R QoS Flow identifier. - 2.14
DQR boolean R Default QoS rule flag. When true this QoS rule is the default QoS rule. - 2.14
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.14
Device.PDU.Session.{i}.QoSRule.{i}.Filter.{i}. object(0:) R

This object describes the PDU QoS Rule Filter table. As each packet filter is logically anded with the others, there shall not be more than one occurrence of each packet filter component type.

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Direction string R

The packet filter direction field is used to indicate for what traffic direction the filter applies. See [Clause 9.11.4.13/3GPP-TS.24.501] Enumeration of:

  • downlink
  • uplink
  • bidirectional
 - 2.14
Type unsignedInt R Packet filter component type identifier. See [Clause 9.11.4.13/3GPP-TS.24.501]. - 2.14
Value string(:1024) R Matching value for the component type. See [Clause 9.11.4.13/3GPP-TS.24.501]. - 2.14
Device.PDU.Session.{i}.QoSFlow.{i}. object(0:) R

Table of all QoS Flow Indicators (QFI) and their properties supported by the access network for this particular PDU. For example:

  • A QoS Flow with a QFI of 1 used for general traffic has the following parameters.
  • FiveQI=8
  • A QoS Flow with a QFI of 32 used for voice traffic with a guaranteed bitrate of 150k has the following parameters.
  • FiveQI=1
  • GFBRUplink=150
  • GFBRDownlink=150

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

 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
QFI unsignedInt(1:63) R QoS Flow Identifier. - 2.14
FiveQI unsignedInt(1:255) R 5G QoS Identifier. See [Clause 5.7.4/3GPP-TS.23.501] for a table of standardised 5QI QoS characteristics. - 2.14
GFBRUplink unsignedLong R Guaranteed Flow Bitrate - Upstream (expressed in bits per second). - 2.14
GFBRDownlink unsignedLong R Guaranteed Flow Bitrate - Downstream (expressed in bits per second). - 2.14
MFBRUplink unsignedLong R Maximum Flow Bitrate - Upstream (expressed in bits per second). - 2.14
MFBRDownlink unsignedLong R Maximum Flow Bitrate - Downstream (expressed in bits per second). - 2.14
AveragingWindow unsignedInt R Averaging window for both uplink and downlink in milliseconds. - 2.14
EPSBearer unsignedInt R EPS Bearer Identity. See [Clause 9.3.2/3GPP-TS.24.301]. - 2.14
Device.FWE. object R 5G Wireline wireless Encapsulation transport for data plane. See {{bibref: non-existent FWEREG}}. - 2.14
LinkNumberOfEntries unsignedInt R The number of entries in the Link table. - 2.14
Device.FWE.Link.{i}. object(0:) R

5G Wireline wireless Encapsulation link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]).

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

 - 2.14
Status string R

The current operational state of the link (see [Section 4.2.2/TR-181i2]). Enumeration of:

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) This parameter is based on ifOperStatus from [RFC2863].
 - 2.14
Alias string(:64) W

[Alias] 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-069] and described in [Appendix II/TR-069], 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.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Name string(:64) R The textual name of the link as assigned by the CPE. - 2.14
LastChange unsignedInt R

The accumulated time in seconds since the link entered its current operational state.

Active Notification requests for this parameter MAY be denied.

 - 2.14
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. - 2.14
Device.FWE.Link.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled). Operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.14
BytesSent unsignedLong R

The total number of bytes transmitted out of the interface, including framing characters.

Active Notification requests for this parameter MAY be denied.

 - 2.14
BytesReceived unsignedLong R

The total number of bytes received on the interface, including framing characters.

Active Notification requests for this parameter MAY be denied.

 - 2.14
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

 - 2.14
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

 - 2.14
ErrorsSent unsignedInt R

The total number of outbound packets that could not be transmitted because of errors.

Active Notification requests for this parameter MAY be denied.

 - 2.14
ErrorsReceived unsignedInt R

The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

Active Notification requests for this parameter MAY be denied.

 - 2.14
UnicastPacketsSent unsignedLong R

The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

 - 2.14
UnicastPacketsReceived unsignedLong R

The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.

Active Notification requests for this parameter MAY be denied.

 - 2.14
DiscardPacketsSent unsignedInt R

The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

Active Notification requests for this parameter MAY be denied.

 - 2.14
DiscardPacketsReceived unsignedInt R

The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.

Active Notification requests for this parameter MAY be denied.

 - 2.14
MulticastPacketsSent unsignedLong R

The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

 - 2.14
MulticastPacketsReceived unsignedLong R

The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.

Active Notification requests for this parameter MAY be denied.

 - 2.14
BroadcastPacketsSent unsignedLong R

The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

 - 2.14
BroadcastPacketsReceived unsignedLong R

The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.

Active Notification requests for this parameter MAY be denied.

 - 2.14
UnknownProtoPacketsReceived unsignedInt R

The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.

Active Notification requests for this parameter MAY be denied.

 - 2.14
Device.SoftwareModules. object R Top level object for dynamically managed software applications. - 2.1
Device.SoftwareModules.DeploymentUnit.{i}. object(0:) R

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 the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias.

 - 2.1
URL string(:2048) R Contains the URL[URL] used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit.

Changes in 2.14:

  • Removed string(:1024) syntax
  • Added URL
 - 2.1
Device.SoftwareModules.ExecutionUnit.{i}. object(0:) R

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.

 - 2.1
ExecutionFaultMessage string(:256) R 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 be an empty string and ignored by the ACS. - 2.1
Device.PacketCaptureDiagnostics. object R The PacketCaptureDiagnostics object. This diagnostic is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. - 2.13
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

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

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

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), but not if it is canceled for any reason, 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.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

Changes in 2.14:

  • Removed Cancel enumeration
 - 2.13
FileTarget string(:2048) W URL,The as defined in [RFC3986],[URL] specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported.

Changes in 2.14:

  • Changed syntax = string(:2048) -> URL
 - 2.13
Device.PacketCaptureDiagnostics.PacketCaptureResult.{i}. object(0:) R Results for individual packet capture diagnostics. Packet capture files whose FileLocation is local to the system SHOULD be deleted when the next diagnostic is run, or upon a system reboot. - 2.13
FileLocation string(:2048) R URL,The as defined in [RFC3986],[URL] specifying the resulting file location of the packet capture record that triggered this result. This MAY be different than the location specified in FileTarget.

Changes in 2.14:

  • Changed syntax = string(:2048) -> URL
 - 2.13
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. object(0:) R

Neighboring SSID table. This table models the other WiFi SSIDs that this device is able to receive.

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

 - 2.7
SecurityModeEnabled string R

The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition.

Enumeration of:

  • None
  • WEP
  • WPA
  • WPA2
  • WPA-WPA2
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
  • WPA3-SAE
  • WPA2-PSK-WPA3-SAE
  • WPA3-Enterprise
 - 2.7

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:51:28 UTC.
report.py –include ../../install/cwmp –output –transform diff –format markdown tr-181-2-13-0-cwmp.xml tr-181-2-14-0-cwmp.xml

Table of Contents