Broadband Forum

TR-069 Device:2.10 Root Object definition
tr-181-2-10-0.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2017, Broadband Forum

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

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

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

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

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

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

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

Summary

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

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

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

long -

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

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

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:

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

IEEE_EUI64 string(23)

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

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

Can be any IPv4 address that is permitted by the IPAddress data type. 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])
IPv4Prefix IPPrefix(18)

IPv4 address prefix.

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

  • <Empty> (an empty string)
  • /(3[0-2]|[012]?[0-9])
  • ((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])/(3[0-2]|[012]?[0-9])
IPv6Address IPAddress(45)

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

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

MACAddress string(17)

All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. Possible patterns:

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

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

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

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

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

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

StatsCounter64 unsignedLong

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

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

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

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

UUID string(36:36)

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

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

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

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

References

[3GPP-HSPA] High Speed Packet data Access (HSPA), 3GPP.
[3GPP-TS.25.171] 3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4.
[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[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.11h-2003] IEEE Std 802.11h-2003, Spectrum and Transmit Power Management Extensions, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1AB-2009] IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1Q-2011] IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[802.3-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[BLUE] Blue, A New Class of Active Queue Management Algorithms.
[DLNA-NDIG] DLNA Networked Device Interoperability Guidelines, DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles., DLNA, October 2006.
[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[DSLite] RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion, IETF, 2011.
[DSLite-options] RFC 6334, Dynamic Host Configuation Protocol for IPv6 (DHCPv6) Option for Dual-Stack Lite, IETF, 2011.
[DVB-TS.102.824] TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.
[ETSIM2MFA] ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012.
[ETSIM2MInterfaces] ETSI TS 102 921 v1.1.6, M2M mIa, dIa and mId Interfaces, ETSI, August 2012.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[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.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug AV Specification, Version 1.1, HomePlug, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANAifType] IANAifType, IANAifType-MIB DEFINITIONS, IANA, 2009.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Firewall] ICSA Modular Firewall Certification Criteria, Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0, ICSA Labs.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[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.
[IKEv2-params] IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[IPDR-XDR] IPDR XDR Encoding Format, IPDR/XDR Encoding Format, TM Forum.
[IPDR-XML] IPDR XML File Encoding Format, IPDR/XML File Encoding Format, 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.
[ISO3166-1] ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006.
[ISO639-1] ISO 639-1, Codes for the representation of names of Languages - Part 1: Alpha-2 code, ISO, 2002.
[ISO646-1991] ISO/IEC 646-1991, Information Technology - ISO 7-bit coded character set for information interchange, ISO, 1991.
[ITU-E.118] ITU E.118, The international telecommunication charge card, International Telecommunication Union, May 2006.
[ITU-E.164] ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010.
[ITU-X.733] ITU X.733, Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function, International Telecommunication Union, February 1992.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[JJ-300.01] JJ-300.01, The List of Device Categories, TTC, 2011.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MoCAv1.0] MoCA v1.0, MoCA MAC/PHY Specification v1.0, MoCA Alliance, 2009.
[MoCAv1.1] MoCA v1.1, MoCA MAC/PHY Specification v1.1 Extensions, MoCA Alliance, 2009.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT311] MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] PCP Proxy Function, Port Control Protocol (PCP) Proxy Function, IETF, September 2015.
[POSIXBase] ISO/IEC/IEEE 9945, Information technology - Portable Operating System Interface (POSIX) Base Specifications, Issue 7, ISO/IEC/IEEE, September 2009.
[RED] References on RED (Random Early Detection) Queue Management.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1378] RFC 1378, The PPP AppleTalk Control Protocol (ATCP), IETF, 1992.
[RFC1552] RFC 1552, The PPP Internetwork Packet Exchange Control Protocol (IPXCP), IETF, 1993.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC1974] RFC 1974, PPP Stac LZS Compression Protocol, IETF, 1996.
[RFC2080] RFC 2080, RIPng for IPv6, IETF, 1997.
[RFC2097] RFC 2097, The PPP NetBIOS Frames Control Protocol (NBFCP), IETF, 1997.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2225] RFC 2225, Classical IP and ARP over ATM, IETF.
[RFC2364] RFC 2364, PPP Over AAL5, IETF, 1998.
[RFC2474] RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.
[RFC2581] RFC 2581, TCP Congestion Control, IETF, April 1999.
[RFC2582] RFC 2582, The NewReno Modification to TCP's Fast Recovery Algorithm, IETF, April 1999.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2684] RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, IETF.
[RFC2697] RFC 2697, A Single Rate Three Color Marker, IETF.
[RFC2698] RFC 2698, A Two Rate Three Color Marker, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2819] RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2866] RFC 2866, RADIUS Accounting, IETF, 2000.
[RFC2869] RFC 2869, RADIUS Extensions, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC2898] RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.
[RFC2974] RFC 2974, Session Announcement Protocol, IETF, October 2000.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3232] RFC 3232, "Assigned Numbers: RFC 1700 is Replaced by an On-line Database", IETF, 2002.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3489] RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.
[RFC3596] RFC 3596, DDNS Extensions to Support IP Version 6, IETF, 2003.
[RFC3633] RFC 3633, IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP) version 6, IETF, 2003.
[RFC3646] RFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3775] RFC 3775, Mobility Support in IPv6, IETF, 2004.
[RFC3925] RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF.
[RFC3926] RFC 3926, FLUTE - File Delivery over Unidirectional Transport, IETF, October 2004.
[RFC3927] RFC 3927, Dynamic Configuration of IPv4 Link-Local Addresses, IETF, 2005.
[RFC3948] RFC 3948, UDP Encapsulation of IPsec ESP Packets, IETF, January 2005.
[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.
[RFC4180] RFC4180, Common Format and MIME Type for Comma-Separated Values (CSV) Files, IETF, October 2005.
[RFC4191] RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4242] RFC 4242, Information Refresh Time Option for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4292] RFC 4292, IP Forwarding Table MIB, IETF, 2006.
[RFC4293] RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4302] RFC 4302, IP Authentication Header, IETF, December 2005.
[RFC4303] RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005.
[RFC4389] RFC 4389, Neighbor Discovery Proxies (ND Proxy), IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4835] RFC 4835, Cryptographic Algorithm Implementation Requirements for Encapsulating Security Payload (ESP) and Authentication Header (AH), IETF, 2007.
[RFC4861] RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007.
[RFC4862] RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007.
[RFC5072] RFC 5072, IP Version 6 over PPP, IETF, 2007.
[RFC5139] RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008.
[RFC5280] RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008.
[RFC5491] RFC 5491, GEOPRIV Presence Information Data Format Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations, IETF, March 2009.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC5969] RFC 5969, IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol Specification, IETF, 2010.
[RFC5996] RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010.
[RFC6106] RFC 6106, IPv6 Router Advertisement Option for DNS Configuration, IETF, 2010.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC6970] RFC 6970, Universal Plug and Play (UPnP) Internet Gateway Device (IGD) - Port Control Protocol (PCP) Interworking Function, IETF, 2013.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[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.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-064] TR-064 Corrigendum 1, LAN-Side DSL CPE Configuration Specification, Broadband Forum, August 2015.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.
[TR-069a3] TR-069 Amendment 3, CPE WAN Management Protocol, Broadband Forum, November 2010.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, July 2011.
[TR-069a5] TR-069 Amendment 5, CPE WAN Management Protocol, Broadband Forum, December 2013.
[TR-098] TR-098 Amendment 2 Corrigendum 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2014.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a3] TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2009.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, February 2010.
[TR-106a5] TR-106 Amendment 5, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2010.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, July 2011.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2013.
[TR-143] TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.
[TR-143a1] TR-143 Amendment 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, December 2014.
[TR-157] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-157a3] TR-157 Amendment 3, Component Objects for CWMP, Broadband Forum, November 2010.
[TR-157a10] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i1] TR-181 Issue 1, Device Data Model for TR-069, Broadband Forum, February 2010.
[TR-181i2] TR-181 Issue 2 Amendment 13, Device Data Model, Broadband Forum, September 2019.
[TR-181i2a2] TR-181 Issue 2 Amendment 2, Device Data Model for TR-069, Broadband Forum, February 2011.
[TR-181i2a5] TR-181 Issue 2 Amendment 5, Device Data Model for TR-069, Broadband Forum, 2012.
[TR-181i2a8] TR-181 Issue 2 Amendment 8, Device Data Model for TR-069, Broadband Forum, September 2014.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[UPA-PLC] Universal Powerline Association, UPA.
[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.
[UPnP-DM:1] UPnP Device Management:1, UPnP Device Management v1.
[UPnP-IGD:1] UPnP InternetGatewayDevice:1, InternetGatewayDevice:1 Device Template Version 1.01, UPnP, 2001.
[UPnP-IGD:2] UPnP InternetGatewayDevice:2, InternetGatewayDevice:2 Device Template Version 1.01, UPnP, 2010.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.
[WPSv1.0] Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.
[Z-Wave] Z-Wave, Z-Wave website.
[ZigBee] ZigBee, ZigBee Alliance website.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Mountable Object definition.
Mount Point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

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

Name Type Syntax Write Description Object Default Version Spec
Device. object object​[1:1] - The top-level object for a Device. - 2.0 TR-181i2c3
RootDataModelVersion string​(32) string​(32) -

Root data model version, e.g. 2.4. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based. Possible patterns:

- 2.0 TR-181i2a4
InterfaceStackNumberOfEntries unsignedInt unsignedInt - The number of entries in the InterfaceStack table. - 2.0 TR-181i2c3
Device.​Services. object object​[1:1] - This object contains general services information. - 2.0 TR-181i2c3
Device.​DeviceInfo. object object​[1:1] - This object contains general device information. - 2.0 TR-181i2c3
DeviceCategory string​[] list of string -

Comma-separated list of strings. Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.

Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

- 2.0 TR-157a9
Manufacturer string​(64) string​(64) - The manufacturer of the CPE (human readable string). - 2.0 TR-181i2c3
ManufacturerOUI string​(6:6) string​(6:6) -

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

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

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

- 2.0 TR-181i2c3
ModelName string​(64) string​(64) - Model name of the CPE (human readable string). - 2.0 TR-181i2c3
ModelNumber string​(64) string​(64) -

The model number of the device (human readable string), or an empty string if no model number is provided by the device.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31.

- 2.0 TR-157a9
Description string​(256) string​(256) - A full description of the CPE device (human readable string). - 2.0 TR-181i2c3
ProductClass string​(64) string​(64) -

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

This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform.

- 2.0 TR-181i2c3
SerialNumber string​(64) string​(64) -

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 TR-181i2c3
HardwareVersion string​(64) string​(64) - A string identifying the particular CPE model and version. - 2.0 TR-181i2c3
SoftwareVersion string​(64) string​(64) -

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

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

- 2.0 TR-181i2c3
AdditionalHardwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply. - 2.0 TR-181i2c3
AdditionalSoftwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply. - 2.0 TR-181i2c3
ProvisioningCode string​(64) string​(64) W Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. - 2.0 TR-181i2c3
UpTime unsignedInt unsignedInt - Time in seconds since the CPE was last restarted. - 2.0 TR-181i2c3
FirstUseDate dateTime dateTime -

Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset.

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

- 2.0 TR-181i2c3
VendorConfigFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorConfigFile table. - 2.0 TR-181i2c3
SupportedDataModelNumberOfEntries unsignedInt unsignedInt - The number of entries in the SupportedDataModel table. - 2.0 TR-157a1
TR-157a2
ProcessorNumberOfEntries unsignedInt unsignedInt - The number of entries in the Processor table. - 2.0 TR-157a3
VendorLogFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorLogFile table. - 2.0 TR-157a3
LocationNumberOfEntries unsignedInt unsignedInt - The number of entries in the Location table. - 2.0 TR-157a5
Device.​DeviceInfo.​VendorConfigFile.​{i}. object​[0:] object​[0:∞] -

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

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

Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table.

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

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) -

Name of the vendor configuration file.

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

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

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

- 2.0 TR-181i2c3
Version string​(16) string​(16) -

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

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

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

- 2.0 TR-181i2c3
Date dateTime dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 2.0 TR-181i2c3
Description string​(256) string​(256) - A description of the vendor configuration file (human-readable string). - 2.0 TR-181i2c3
UseForBackupRestore boolean boolean -

When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes.

Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific.

- 2.0 TR-181i2a7
Device.​DeviceInfo.​SupportedDataModel.​{i}. object​[0:] object​[0:∞] -

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 TR-157a1
Alias string​(64) Alias 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.0 TR-157a4
URL string​(256) string​(256) -

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

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

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

The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that 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.

- 2.0 TR-157a1
TR-157a7
UUID string​(36:36) UUID - [UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL. - 2.0 TR-157a7
URN string​(256) string​(256) -

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

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

- 2.0 TR-157a1
Features string​[] list of string -

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

For example, if the DT instance specified the following:

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

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

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

The number of entries in the Process table.

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

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

List of all processes running on the device.

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

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

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

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

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

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

- 2.0 TR-157
Alias string​(64) Alias 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.0 TR-157a4
Enable boolean boolean W Indicates whether or not the temperature sensor is enabled. - 2.0 TR-157
Status string string -

The status of this temperature sensor. Enumeration of:

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

When set to true, resets the temperature sensor.

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

- 2.0 TR-157
ResetTime dateTime dateTime -

The time at which this temperature sensor was reset.

Reset can be caused by:

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

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

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

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

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

- 2.0 TR-157
LastUpdate dateTime dateTime -

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

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

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

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

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

- 2.0 TR-157
MinTime dateTime dateTime -

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

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

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

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

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

- 2.0 TR-157
MaxTime dateTime dateTime -

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

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

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

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

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

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

- 2.0 TR-157
TR-157a3
LowAlarmTime dateTime dateTime -

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

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

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

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

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

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

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

- 2.0 TR-157
TR-157a3
PollingInterval unsignedInt unsignedInt W

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

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

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

- 2.0 TR-157a3
HighAlarmTime dateTime dateTime -

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

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

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

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

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

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

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

- 2.0 TR-157
Device.​DeviceInfo.​Processor.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.0 TR-157a3
Alias string​(64) Alias 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.0 TR-157a4
Architecture string string -

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

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

- 2.0 TR-157a3
Device.​DeviceInfo.​VendorLogFile.​{i}. object​[0:] object​[0:∞] -

Each table entry represents a Vendor Log File.

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

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

- 2.0 TR-157a3
Alias string​(64) Alias 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.0 TR-157a3
TR-157a4
Name string​(64) string​(64) -

Name of the log file.

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

- 2.0 TR-157a3
MaximumSize unsignedInt unsignedInt - The maximum size of the log file in bytes. If the device doesn't know the maximum file size then MaximumSize will be 0. - 2.0 TR-157a3
TR-157a7
Persistent boolean boolean -

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

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

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

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

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

- 2.0 TR-157a4
ProductClass string​(64) string​(64) -

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

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

- 2.0 TR-157a4
SerialNumber string​(64) string​(64) - Serial number of the associated CPE Proxier. - 2.0 TR-157a4
ProxyProtocol string string -

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

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

- 2.0 TR-157a4
TR-157a7
Device.​DeviceInfo.​Location.​{i}. object​[0:] object​[0:∞] W

This object contains Location information.

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

- 2.0 TR-157a5
Source string string -

Identifies the source of the location data. Enumeration of:

"External" 2.0 TR-157a5
AcquiredTime dateTime dateTime - The time when the location was acquired. - 2.0 TR-157a5
ExternalSource string string -

URL, MAC address, or other identifier that identifies an "External" source of this location.

Meaningful only if Source has a value of External, otherwise it MUST be an empty string.

If ExternalProtocol has a value of CWMP, this is the URL or IP address of the ACS.

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

- 2.0 TR-157a5
ExternalProtocol string string -

Protocol used to acquire a location from an "External" source. Enumeration of:

Meaningful only if Source has a value of External, otherwise it MUST be an empty string.

"CWMP" 2.0 TR-157a5
DataObject string​(1200) string​(1200) W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP.

If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491].

If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses).

If obtained by an external source this is the location information as received.

If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64.

CWMP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses).

Only zero or one Location object instance with value CWMP MUST exist at any given time.

- 2.0 TR-157a5
Device.​ManagementServer. object object​[1:1] - This object contains parameters relating to the CPE's association with an ACS. - 2.0 TR-181i2c3
EnableCWMP boolean boolean W

Enables and disables the CPE's support for CWMP.

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

true means that CWMP support on the CPE is enabled.

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

The factory default value MUST be true.

- 2.0 TR-181i2c3
URL string​(256) string​(256) W

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

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

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

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

- 2.0 TR-181i2c3
Username string​(256) string​(256) W

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

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

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

- 2.0 TR-181i2c3
Password string​(256) string​(256) W

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

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

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

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

- 2.0 TR-181i2c3
ScheduleReboot dateTime dateTime W

An absolute date and time in UTC at which time the CPE will perform a reboot.

If a CWMP session is in progress at the specified time, the CPE MUST wait until the session has ended before performing the reboot.

If the value specifies a date and time that has already passed (i.e., a past date and time), no reboot will be performed.

- 2.0 TR-181i2a10
DelayReboot int​(-1:) int​(-1:) W

The number of seconds 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.0 TR-181i2a10
PeriodicInformEnable boolean boolean W Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call. - 2.0 TR-181i2c3
PeriodicInformInterval unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true. - 2.0 TR-181i2c3
PeriodicInformTime dateTime dateTime W

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

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

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

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

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

- 2.0 TR-181i2c3
ParameterKey string​(32) string​(32) -

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

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

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

- 2.0 TR-181i2c3
ConnectionRequestURL string​(256) string​(256) -

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

In the form:

http://host:port/path

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

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]).

- 2.0 TR-181i2c3
TR-181i2a2
ConnectionRequestUsername string​(256) string​(256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 2.0 TR-181i2c3
ConnectionRequestPassword string​(256) string​(256) W

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

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

- 2.0 TR-181i2c3
UpgradesManaged boolean boolean W

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

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

- 2.0 TR-181i2c3
KickURL string​(256) string​(256) -

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

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

- 2.0 TR-181i2c3
DownloadProgressURL string​(256) string​(256) -

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

LAN-accessible URL, as defined in [RFC3986], to which a web-server associated with the ACS MAY redirect a user's browser on initiation of a file download to observer the status of the download.

- 2.0 TR-181i2c3
DefaultActiveNotificationThrottle unsignedInt unsignedInt W

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

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

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

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

- 2.0 TR-181i2c3
CWMPRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

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

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

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

- 2.0 TR-181i2c3
CWMPRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

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

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

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

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

- 2.0 TR-181i2c3
UDPConnectionRequestAddress string​(256) string​(256) -

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

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

host:port
host

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

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

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]).

- 2.0 TR-181i2c3
TR-181i2a2
STUNEnable boolean boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 2.0 TR-181i2c3
STUNServerAddress string​(256) string​(256) W

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

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

- 2.0 TR-181i2c3
STUNServerPort unsignedInt​(0:65535) unsignedInt​(0:65535) W

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

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

- 2.0 TR-181i2c3
STUNUsername string​(256) string​(256) W

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

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

- 2.0 TR-181i2c3
STUNPassword string​(256) string​(256) W

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

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

- 2.0 TR-181i2c3
STUNMaximumKeepAlivePeriod int​(-1:) int​(-1:) W

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

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

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

When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use.

A true value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE's source address and port.

When STUNEnable is false, this value MUST be false.

- 2.0 TR-181i2c3
AliasBasedAddressing boolean boolean -

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

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

- 2.0 TR-181i2a3
InstanceMode string string W

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

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

The factory default value MUST be InstanceNumber.

- 2.0 TR-181i2a3
AutoCreateInstances boolean boolean W

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

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

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

The factory default value MUST be false.

- 2.0 TR-181i2a3
ManageableDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the ManageableDevice table. - 2.0 TR-181i2c3
ManageableDeviceNotificationLimit unsignedInt unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the ManageableDeviceNumberOfEntries (if Active Notification is enabled). - 2.0 TR-181i2a7
EmbeddedDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the EmbeddedDevice table. - 2.0 TR-157a4
VirtualDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the VirtualDevice table. - 2.0 TR-157a4
SupportedConnReqMethods string​[] list of string -

Comma-separated list of strings. The connection request methods supported by this ManagementServer. Each list item is an enumeration of:

  • HTTP (The connection request method as specified in [Section 3.2.2 ACS Connection Initiation/TR-069], REQUIRED)
  • STUN (The connection request method as specified in [Annex G Connection Request via NAT Gateway/TR-069], OPTIONAL)
  • XMPP (The connection request method as specified in [Annex K XMPP Connection Request/TR-069a5], OPTIONAL)
- 2.0 TR-157a8
ConnReqXMPPConnection string string W The value MUST be the Path Name of the XMPP.Connection instance that is used for connection requests to this ManagementServer. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0 TR-157a8
ConnReqAllowedJabberIDs string​[:32]​(256) list​[:32] of string​(256) W

When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza will contian a "from" address that contains the Jabber ID of the initiating entity.

This parameter is a Comma-separated list (up to 32 items) of strings (maximum number of characters 256). Each entry represents a Jabber ID, or address, that is allowed to initiate an XMPP Connection Request.

Each Jabber ID is allowed to be either a "Full JID" (containing a local-part, domain-part, and resource-part in the following format: "local-part@domain-part/resource-part") or a "Bare JID" (containing a local-part and a domain-part in the following format: "local-part@domain-part"). "Full JID" entries require an exact match whereas "Bare JID" entries are a wildcard match and will match any Jabber ID with the same local-part and domain-part independent of the resource-part.

For example, if ConnReqAllowedJabberIDs contained "ACS1@tr069.example.com, ACS2@tr-069.example.com/resource1" then the following incoming "from" addresses would be allowed:

  • "ACS1@tr069.example.com/resource1"
  • "ACS1@tr069.example.com/resource2"
  • "ACS2@tr069.example.com/resource1"

And the following incoming "from" addresses would not be allowed:

  • "ACS2@tr069.example.com/resource2"
  • "ACS@tr069.example.com/resource"

If this Parameter is an empty string then all Jabber IDs are allowed and an XMPP Connection Request can not be deemed invalid due to the "from" address.

- 2.0 TR-157a8
ConnReqJabberID string string -

The value MUST be the value of the XMPP.Connection.{i}.JabberID contained in the XMPP.Connection instance referenced by the ConnReqXMPPConnection parameter.

If the ConnReqXMPPConnection parameter is empty or the XMPP.Connection instance being reference is disabled, then this value will be empty.

If the XMPP.Connection instance being referenced by the ConnReqXMPPConnection parameter is lost (XMPP.Connection.{i}.Status parameter changes from Enabled to some other value), then the value of this parameter MUST remain unchanged until the connection can be reestablished and a new XMPP.Connection.{i}.JabberID can be established. If the new XMPP.Connection.{i}.JabberID is identical to the existing value, then the value of this parameter MUST NOT be altered and a VALUE CHANGE event MUST NOT be generated.

- 2.0 TR-157a8
HTTPCompressionSupported string​[] list of string -

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in [Section 3.4.7/TR-069a5]. Each list item is an enumeration of:

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

- 2.0 TR-157a8
HTTPCompression string string W

The value MUST be a member of the list reported by the HTTPCompressionSupported parameter, or else be Disabled. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when communicating with the ACS.

The factory default value MUST be Disabled.

- 2.0 TR-157a8
LightweightNotificationProtocolsSupported string​[] list of string -

Comma-separated list of strings. Indicates the Lightweight Notification Protocol(s) supported by this CPE. Each list item is an enumeration of:

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

- 2.0 TR-157a8
LightweightNotificationProtocolsUsed string​[] list of string W

Comma-separated list of strings. Each list item MUST be a member of the list reported by the LightweightNotificationProtocolsSupported parameter, or else be an empty string. The value of this parameter represents the protocol(s) that will be used by the CPE when sending Lightweight Notifications.

An empty string means that Lightweight Notifications are disabled, despite any SetParameterAttributes that have been configured on various parameters.

- 2.0 TR-157a8
UDPLightweightNotificationHost string​(256) string​(256) W

Host name or address to be used when sending the UDP Lightweight Notifications.

UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationHost is not implemented or is an empty string, and UDP Lightweight Notifications are supported, the destination host MUST be the same as the ACS (as contained in the host portion of the URL).

- 2.0 TR-157a8
UDPLightweightNotificationPort unsignedInt unsignedInt W

The port number to be used when sending UDP Lightweight Notifications.

UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationPort is not implemented and UDP Lightweight Notifications are supported, the destination port MUST be 7547.

- 2.0 TR-157a8
InformParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the InformParameter table. - 2.0 TR-157a9
Device.​ManagementServer.​ManageableDevice.​{i}. object​[0:] object​[0:∞] -

Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to [Annex F/TR-069a2] 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 Alias!, or with the same values for all of ManufacturerOUI, SerialNumber and ProductClass.

- 2.0 TR-181i2c3
Alias string​(64) 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 is DEPRECATED because ManageableDevice is a transient object.
- 2.0 TR-181i2c3
TR-181i2a3
ManufacturerOUI string​(6:6) string​(6:6) -

Organizationally unique identifier of the Device manufacturer as provided to the Gateway by the Device. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

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

- 2.0 TR-181i2c3
SerialNumber string​(64) string​(64) - Serial number of the Device as provided to the Gateway by the Device. - 2.0 TR-181i2c3
ProductClass string​(64) string​(64) -

Identifier of the class of product for which the Device's serial number applies as provided to the Gateway by the Device.

If the Device does not provide a Product Class, then this parameter MUST be an empty string.

- 2.0 TR-181i2c3
Host string​(1024)​[] list​(1024) of string -

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this physical LAN device. There can be multiple such entries if the device has more than one network interface.

For example: Device.Hosts.Host.1,Device.Hosts.Host.5

- 2.0 TR-181i2c3
Device.​ManagementServer.​AutonomousTransferCompletePolicy. object object​[1:1] -

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

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

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

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

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

- 2.0 TR-157
ResultTypeFilter string string W

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

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

  • Success (The autonomous file transfer completed successfully; i.e., the FaultCode was zero)
  • Failure (The autonomous file transfer did not complete successfully; i.e., the FaultCode was non-zero)
  • Both (Success and Failure)
- 2.0 TR-157a2
FileTypeFilter string​(1024)​[] list​(1024) of string W

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

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

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

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

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

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

The status of the announcement service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)
- 2.0 TR-157
GroupNumberOfEntries unsignedInt unsignedInt - The number of entries in the Group table. - 2.0 TR-157
TR-157a2
Device.​ManagementServer.​DownloadAvailability.​Announcement.​Group.​{i}. object​[0:] 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.

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

- 2.0 TR-157
Alias string​(64) Alias 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.

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

The status of this group table entry. Enumeration of:

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

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

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

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

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

The status of the query service. Enumeration of:

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

URL [RFC3986] of the query response server.

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

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

- 2.0 TR-157
Device.​ManagementServer.​DUStateChangeComplPolicy. object object​[1:1] -

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

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

- 2.0 TR-157a3
Enable boolean boolean W Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events to the ACS. - 2.0 TR-157a3
OperationTypeFilter string​[] list of string W

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

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

- 2.0 TR-157a3
ResultTypeFilter string string W

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

  • Success (The autonomous state change completed successfully; i.e., the FaultCode was zero)
  • Failure (The autonomous state change did not complete successfully; i.e., the FaultCode was non-zero)
  • Both (All result types independent of Success or Failure)
- 2.0 TR-157a3
FaultCodeFilter string​[] list of string W

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

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

- 2.0 TR-157a3
Device.​ManagementServer.​EmbeddedDevice.​{i}. object​[0:] object​[0:∞] -

Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4] for proxying devices.

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

- 2.0 TR-157a4
ControllerID string​(256) string​(256) -

Identifier of the controller that is responsible for a sub-network of Proxied Devices within the LAN.

An empty string indicates that this Proxied Device either:

  • Isn't part of a sub-network, within the LAN, with a controller entity.
  • Doesn't need a ControllerID to ensure its ProxiedDeviceID is unique throughout the LAN.
- 2.0 TR-157a4
ProxiedDeviceID string​(256) string​(256) -

Idenitfier of the Proxied Device.

This is an opaque string that is unique to the Proxied Device within a specific sub-network within the LAN (identified by the ControllerID). If the ControllerID is an empty string this ProxiedDeviceID is unique across the LAN.

- 2.0 TR-157a4
Reference string string - The value MUST be the path name of a table row. If the referenced object is deleted, this EmbeddedDevice instance MUST also be removed. Represents the instance of a multi-instanced object that is directly controlled by, and has come into existence because of, this Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4]. - 2.0 TR-157a4
SupportedDataModel string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instance(s) that this Proxied Device is utilizing. The CWMP-DT schema instance is also the one being utilized by the object referenced within Reference. - 2.0 TR-157a4
Host string​[:32] list​[:32] of string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References the Hosts.Host table entry(s), whether active or inactive, that corresponds to this proxied LAN device. - 2.0 TR-157a4
ProxyProtocol string string -

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

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

- 2.0 TR-157a4
TR-157a7
ProxyProtocolReference string string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0 TR-157a7
DiscoveryProtocol string​[] list of string -

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

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

- 2.0 TR-157a7
DiscoveryProtocolReference string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol. If the referenced object is deleted, the corresponding item MUST be removed from the list.

For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

- 2.0 TR-157a7
CommandProcessed string string -

Whether or not the CPE Proxier has successfully communicated all pending configuration commands down to the Proxied Device. Enumeration of:

- 2.0 TR-157a4
CommandProcessingErrMsg string​(1024) string​(1024) - Detailed CommandProcessed error description (vendor specific). - 2.0 TR-157a4
LastSyncTime dateTime dateTime -

The last time that the CPE Proxier synchronized the state of the Proxied Device. This parameter MUST be updated when a proxy command is executed successfully on the Proxied Device.

The Unknown Time value, as defined in [TR-106a6], indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted.

- 2.0 TR-157a4
Device.​ManagementServer.​VirtualDevice.​{i}. object​[0:] object​[0:∞] -

Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex I.1.1/TR-069a4] for proxying devices.

At most one entry in this table can exist with the same values for all of ManufacturerOUI, ProductClass and SerialNumber.

- 2.0 TR-157a4
ManufacturerOUI string​(6:6) string​(6:6) -

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

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

- 2.0 TR-157a4
ProductClass string​(64) string​(64) - Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 2.0 TR-157a4
SerialNumber string​(64) string​(64) - Serial number of the associated Proxied Device. - 2.0 TR-157a4
Host string​[:32] list​[:32] of string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface. - 2.0 TR-157a4
ProxyProtocol string string -

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

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

- 2.0 TR-157a4
TR-157a7
ProxyProtocolReference string string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0 TR-157a7
DiscoveryProtocol string​[] list of string -

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

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

- 2.0 TR-157a7
DiscoveryProtocolReference string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol. If the referenced object is deleted, the corresponding item MUST be removed from the list.

For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

- 2.0 TR-157a7
Device.​ManagementServer.​StandbyPolicy. object object​[1:1] -

Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of [Annex L/TR-069a5].

NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069.

- 2.0 TR-157a8
CRUnawarenessMaxDuration int​(-1:) int​(-1:) W

When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in seconds), the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for having been non CR-aware.

The factory default value MUST be -1.

- 2.0 TR-157a8
MaxMissedPeriodic int​(-1:) int​(-1:) W

When waking up from a non fully Timer-Aware Standby that made it miss more than this parameter's value Periodic Contacts, the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for exceeding that limit.

The factory default value MUST be -1.

- 2.0 TR-157a8
NotifyMissedScheduled boolean boolean W

When waking up from a non fully Timer-Aware Standby that made it miss at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if this parameter is true.

The factory default value MUST be false.

- 2.0 TR-157a8
NetworkAwarenessCapable boolean boolean - Indicates that the CPE is capable of CR-Aware Standby. - 2.0 TR-157a8
SelfTimerCapable boolean boolean - Indicates that the CPE is capable of Timer-Aware Standby. - 2.0 TR-157a8
CRAwarenessRequested boolean boolean W

If NetworkAwarenessCapable and this parameter are both true, the CPE MUST NOT go into a non CR-Aware Standby state.

The factory default value MUST be false.

- 2.0 TR-157a8
PeriodicAwarenessRequested boolean boolean W

If SelfTimerCapable and this parameter are both true, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.

The factory default value MUST be false.

- 2.0 TR-157a8
ScheduledAwarenessRequested boolean boolean W

If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact:

  • if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby;
  • if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.
- 2.0 TR-157a8
Device.​ManagementServer.​InformParameter.​{i}. object​[0:] object​[0:∞] W

This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the ParameterList argument of the Inform RPC whenever any Event within the EventList is being delivered.

This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

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

- 2.0 TR-157a9
Enable boolean boolean W Enables or disables this InformParameter. false 2.0 TR-157a9
Alias string​(64) Alias 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.

- 2.0 TR-157a9
ParameterName string​(256) string​(256) W

A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE.

If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.

<Empty> 2.0 TR-157a9
EventList string​[] list of string W

Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC.

All Inform Events (see [Section 3.7.1.5/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069].

An empty string means all events except "4 VALUE CHANGE".

<Empty> 2.0 TR-157a9
Device.​GatewayInfo. object object​[1:1] - This object contains information associated with a connected Internet Gateway Device. - 2.0 TR-181i2c3
ManufacturerOUI string​(6) string​(6) -

Organizationally unique identifier of the associated Internet Gateway Device. Possible patterns:

An empty string indicates that there is no associated Internet Gateway Device that has been detected.

- 2.0 TR-181i2c3
TR-181i2a7
ProductClass string​(64) string​(64) - Identifier of the product class of the associated Internet Gateway Device. An empty string indicates either that there is no associated Internet Gateway Device that has been detected, or the Internet Gateway Device does not support the use of the product-class parameter. - 2.0 TR-181i2c3
TR-181i2a7
SerialNumber string​(64) string​(64) - Serial number of the associated Internet Gateway Device. An empty string indicates that there is no associated Internet Gateway Device that has been detected. - 2.0 TR-181i2c3
TR-181i2a7
Device.​Time. object object​[1:1] - This object contains parameters relating an NTP or SNTP time client in the CPE. - 2.0 TR-181i2c3
Enable boolean boolean W Enables or disables the NTP or SNTP time client. - 2.0 TR-181i2c3
Status string string -

Status of Time support on the CPE. Enumeration of:

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

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

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

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

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

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

EST+5 EDT,M4.1.0/2,M10.5.0/2
- 2.0 TR-181i2c3
Device.​UserInterface. object object​[1:1] - This object contains parameters relating to the user interface of the CPE. - 2.0 TR-181i2c3
PasswordRequired boolean boolean W

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

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

- 2.0 TR-181i2c3
PasswordUserSelectable boolean boolean W

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

Indicates whether or not a password to protect the local user interface of the CPE MAY be selected by the user directly (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword).

- 2.0 TR-181i2c3
PasswordReset boolean boolean W

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

When set to true, resets LANConfigSecurity.ConfigPassword to its factory value.

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

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

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

Un-encoded binary image size in bytes.

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

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

- 2.0 TR-181i2c3
ISPMailServer string​(256) string​(256) W The URL of the ISP's mail server. - 2.0 TR-181i2c3
ISPNewsServer string​(256) string​(256) W The URL of the ISP's news server. - 2.0 TR-181i2c3
TextColor hexBinary​(3:3) hexBinary​(3:3) W The color of text on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2c3
BackgroundColor hexBinary​(3:3) hexBinary​(3:3) W The color of the GUI screen backgrounds in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2c3
ButtonColor hexBinary​(3:3) hexBinary​(3:3) W The color of buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2c3
ButtonTextColor hexBinary​(3:3) hexBinary​(3:3) W The color of text on buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2c3
AutoUpdateServer string​(256) string​(256) W The server the CPE can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true. - 2.0 TR-181i2c3
UserUpdateServer string​(256) string​(256) W The server where a user can check via a web browser if an update is available for download to a PC. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true. - 2.0 TR-181i2c3
AvailableLanguages string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. List items represent user-interface languages that are available, where each language is specified according to [RFC3066]. - 2.0 TR-181i2c3
CurrentLanguage string​(16) string​(16) W Current user-interface language, specified according to [RFC3066]. The value MUST be a member of the list reported by the AvailableLanguages parameter. - 2.0 TR-181i2c3
Device.​UserInterface.​RemoteAccess. object object​[1:1] -

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

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

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

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

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

- 2.0 TR-157
Protocol string string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 2.0 TR-157
Device.​UserInterface.​LocalDisplay. object object​[1:1] - This object describes how to remotely manage the initial positioning of a user interface on a device's local display. - 2.0 TR-157
Movable boolean boolean W Controls whether the user is allowed to change the GUI window position on the local CPE's display. - 2.0 TR-157
Resizable boolean boolean W Controls whether the user is allowed to resize the GUI window on the local CPE's display. - 2.0 TR-157
PosX int int W The horizontal position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 2.0 TR-157
PosY int int W The vertical position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 2.0 TR-157
Width unsignedInt unsignedInt W The width of the user interface within the local CPE's display, expressed in pixels. - 2.0 TR-157
Height unsignedInt unsignedInt W The height of the user interface within the local CPE's display, expressed in pixels. - 2.0 TR-157
DisplayWidth unsignedInt unsignedInt - The width of the local CPE's display, expressed in pixels. - 2.0 TR-157
DisplayHeight unsignedInt unsignedInt - The height of the local CPE's display, expressed in pixels. - 2.0 TR-157
Device.​InterfaceStack.​{i}. object​[0:] object​[0:∞] -

This table contains information about the relationships between the multiple layers of interface objects ([Section 4.3/TR-181i2]). In particular, it contains information on which interfaces run on top of which other interfaces.

This table is auto-generated by the CPE based on the LowerLayers parameters on individual interface objects.

Each table row represents a "link" between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPE MUST delete the corresponding InterfaceStack row(s) that had referenced it.

At most one entry in this table can exist with the same values for both HigherLayer and LowerLayer, or with a given value for Alias.

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2a3
HigherLayer string​(256) string​(256) -

A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on top of the interface identified by the corresponding instance of LowerLayer.

When the referenced higher layer interface is deleted, the CPE MUST delete the table row.

- 2.0 TR-181i2c3
LowerLayer string​(256) string​(256) -

A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs below the interface identified by the corresponding instance of HigherLayer.

When the referenced lower layer interface is deleted, the CPE MUST delete the table row.

- 2.0 TR-181i2c3
HigherAlias string​(64) string​(64) - The value of the Alias parameter for the interface object referenced by HigherLayer. - 2.0 TR-181i2c3
LowerAlias string​(64) string​(64) - The value of the Alias parameter for the interface object referenced by LowerLayer. - 2.0 TR-181i2c3
Device.​DSL. object object​[1:1] - 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 TR-181i2c3
LineNumberOfEntries unsignedInt unsignedInt - The number of entries in the Line table. - 2.0 TR-181i2c3
ChannelNumberOfEntries unsignedInt unsignedInt - The number of entries in the Channel table. - 2.0 TR-181i2c3
BondingGroupNumberOfEntries unsignedInt unsignedInt - The number of entries in the BondingGroup table. - 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}. object​[0:] object​[0:∞] -

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 TR-181i2c3
Enable boolean boolean W

Enables or disables the DSL line.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2c3
EnableDataGathering boolean boolean W Enables or disables data gathering on the DSL line. - 2.0 TR-181i2a8
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the DSL line as assigned by the CPE. - 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the DSL line entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Line is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2c3
Upstream boolean boolean -

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.
- 2.0 TR-181i2c3
FirmwareVersion string​(64) string​(64) - A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.0 TR-181i2c3
LinkStatus string string -

Status of the DSL physical link. Enumeration of:

When LinkStatus is Up, Status is expected to be Up. When LinkStatus is Initializing or EstablishingLink or NoSignal or Disabled, Status is expected to be Down.

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

- 2.0 TR-181i2c3
StandardsSupported string​[] list of string -

Note: In G.997.1, this parameter is called "xDSL Transmission system capabilities". See ITU-T Recommendation [G.997.1].
This parameter is 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.
- 2.0 TR-181i2c3
TR-181i2a8
XTSE hexBinary​(8:8) hexBinary​(8:8) -

This configuration parameter defines the transmission system types to be allowed by the xTU on this Line instance. Each bit is 0 if not allowed or 1 if allowed, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1.

Note: This parameter is defined as xDSL Transmission system enabling (XTSE) in ITU-T G.997.1. For a full definition, see Clause 7.3.1.1.1 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
StandardUsed string string -
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 is 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.
- 2.0 TR-181i2c3
TR-181i2a8
XTSUsed hexBinary​(8:8) hexBinary​(8:8) - This parameter indicates which DSL standard and recommendation are currently in use by the Line instance. Only one bit is set, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. - 2.0 TR-181i2a8
LineEncoding string string -

The line encoding method used in establishing the Layer 1 DSL connection between the CPE and the DSLAM. Enumeration of:

Note: Generally speaking, this variable does not change after provisioning.

- 2.0 TR-181i2c3
AllowedProfiles string​[] list of string -

Comma-separated list of strings. List items indicate which VDSL2 profiles are allowed on the line. Each list item is an enumeration of:

Note: In G.997.1, this parameter is called PROFILES. See ITU-T Recommendation [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 an empty string.

- 2.0 TR-181i2c3
CurrentProfile string string -

The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which VDSL2 profile is currently in use on the line.

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 an empty string.

- 2.0 TR-181i2c3
PowerManagementState string string -

The power management state of the line. Enumeration of:

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SuccessFailureCause unsignedInt​(0:6) unsignedInt​(0:6) -

The success failure cause of the initialization. An enumeration of the following integer values:

  • 0: Successful
  • 1: Configuration error. This error occurs with inconsistencies in configuration parameters, e.g. when the line is initialized in an xDSL Transmission system where an xTU does not support the configured Maximum Delay or the configured Minimum or Maximum Data Rate for one or more bearer channels.
  • 2: Configuration not feasible on the line. This error occurs if the Minimum Data Rate cannot be reached on the line with the Minimum Noise Margin, Maximum PSD level, Maximum Delay and Maximum Bit Error Ratio for one or more bearer channels.
  • 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout.
  • 4: No peer xTU detected. This error occurs if the peer xTU is not powered or not connected or if the line is too long to allow detection of a peer xTU.
  • 5: Any other or unknown Initialization Failure cause.
  • 6: ITU T G.998.4 retransmission mode was not selected while RTX_MODE = FORCED or with RTX_MODE = RTX_TESTMODE.

Note: In G.997.1, this parameter is called "Initialization success/failure cause". See Clause 7.5.1.6 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
TR-181i2a8
UPBOKLER unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter contains the estimated electrical loop length estimated by the VTU-R expressed in 0.1 dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R in Clause 7.5.1.23.2 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
UPBOKLEPb unsignedInt​[]​(0:1280,2047) list of unsignedInt​(0:1280,2047) -

Comma-separated list of unsigned integers (value 0 to 1280, or 2047). VTU-O estimated upstream power back-off electrical length per band.

This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported upstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).

Note: This parameter is defined as UPBOKLE-pb in Clause 7.5.1.23.3 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
UPBOKLERPb unsignedInt​[]​(0:1280,2047) list of unsignedInt​(0:1280,2047) -

Comma-separated list of unsigned integers (value 0 to 1280, or 2047). VTU-R estimated upstream power back-off electrical length per band.

This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported downstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).

The value of each list element is coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R-pb in Clause 7.5.1.23.4 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
RXTHRSHds int​(-640:0) int​(-640:0) -

UPBO downstream receiver signal level threshold.

This parameter reports the downstream received signal level threshold value used in the alternative electrical length estimation method (ELE-M1). This parameter represents an offset from -100 dBm/Hz, and ranges from -64 dB to 0 dB in steps of 0.1 dB.

The value is coded as a 16 bit number in the range -64 (coded as -640) to 0 dB (coded as 0) in steps of 0.1 dB.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
ACTRAMODEds unsignedInt​(1:4) unsignedInt​(1:4) -

This parameter indicates the actual active rate adaptation mode in the downstream direction.

  • If ACTRAMODEds equals 1, the link is operating in RA-MODE 1 (MANUAL).
  • If ACTRAMODEds equals 2, the link is operating in RA-MODE 2 (AT_INIT).
  • If ACTRAMODEds equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
  • If ACTRAMODEds equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).

Note: This parameter is defined as ACT-RA-MODEds in Clause 7.5.1.33.1 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
ACTRAMODEus unsignedInt​(1:4) unsignedInt​(1:4) -

This parameter indicates the actual active rate adaptation mode in the upstream direction.

  • If ACTRAMODEus equals 1, the link is operating in RA-MODE 1 (MANUAL).
  • If ACTRAMODEus equals 2, the link is operating in RA-MODE 2 (AT_INIT).
  • If ACTRAMODEus equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
  • If ACTRAMODEus equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).

Note: This parameter is defined as ACT-RA-MODEus in Clause 7.5.1.33.2 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
ACTINPROCds unsignedInt unsignedInt -

This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the downstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP.

Note: This parameter is defined as ACTINP-ROC-ds in Clause 7.5.1.34.1 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
ACTINPROCus unsignedInt unsignedInt -

This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the upstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP.

Note: This parameter is defined as ACTINP-ROC-us in Clause 7.5.1.34.2 ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
SNRMROCds unsignedInt unsignedInt -

This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the downstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin DownstreamNoiseMargin.

Note: This parameter is defined as SNRM-ROC-ds in Clause 7.5.1.35.1 ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
SNRMROCus unsignedInt unsignedInt -

This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the upstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin (UpstreamNoiseMargin).

Note: This parameter is defined as SNRM-ROC-us in Clause 7.5.1.35.2 ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
LastStateTransmittedDownstream unsignedInt unsignedInt -

This parameter represents the last successful transmitted initialization state in the downstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System.

This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
LastStateTransmittedUpstream unsignedInt unsignedInt -

This parameter represents the last successful transmitted initialization state in the upstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System.

This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
UPBOKLE unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter contains the estimated electrical loop length expressed in 0.1dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value SHALL be coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
MREFPSDds base64​(0:145) base64​(0:145) -

This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding).

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
MREFPSDus base64​(0:145) base64​(0:145) -

This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding).

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
LIMITMASK unsignedInt unsignedInt -

Indicates the enabled VDSL2 Limit PSD mask of the selected PSD mask class. Bit mask as specified in ITU-T Recommendation G.997.1.

Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
US0MASK unsignedInt unsignedInt -

Indicates the allowed VDSL2 US0 PSD masks for Annex A operation. Bit mask as specified in see ITU-T Recommendation G.997.1.

Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
TRELLISds int int -

Reports whether trellis coding is enabled in the downstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
TRELLISus int int -

Reports whether trellis coding is enabled in the upstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
ACTSNRMODEds unsignedInt unsignedInt -

Reports whether the OPTIONAL virtual noise mechanism is in use in the downstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
ACTSNRMODEus unsignedInt unsignedInt -

Reports whether the OPTIONAL virtual noise mechanism is in use in the upstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
VirtualNoisePSDds base64​(0:97) base64​(0:97) -

Reports the virtual noise PSD for the downstream direction. Base64 encoded of the binary representation defined in G.997.1 by the parameter called TXREFVNds (maximum length is 97 octets, which requires 132 bytes for Base64 encoding).

See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string.

- 2.0 TR-181i2c3
VirtualNoisePSDus base64​(0:49) base64​(0:49) -

Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding).

See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string.

- 2.0 TR-181i2c3
ACTUALCE unsignedInt unsignedInt -

Reports the actual cyclic extension, as the value of m, in use for the connection.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 99.

- 2.0 TR-181i2c3
LineNumber int​(1:) int​(1:) - Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.0 TR-181i2c3
UpstreamMaxBitRate unsignedInt unsignedInt -

The current maximum attainable data rate upstream (expressed in Kbps).

Note: This parameter is related to the G.997.1 parameter ATTNDRus, which is measured in bits/s. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
DownstreamMaxBitRate unsignedInt unsignedInt -

The current maximum attainable data rate downstream (expressed in Kbps).

Note: This parameter is related to the G.997.1 parameter ATTNDRds, which is measured in bits/s. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
UpstreamNoiseMargin int int -

The current signal-to-noise ratio margin (expressed in 0.1dB) in the upstream direction.

Note: In G.997.1, this parameter is called SNRMus. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
DownstreamNoiseMargin int int -

The current signal-to-noise ratio margin (expressed in 0.1dB) in the downstream direction.

Note: In G.997.1, this parameter is called SNRMds. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SNRMpbus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the current signal-to-noise ratio margin of each upstream band. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SNRMpbds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the current signal-to-noise ratio margin of each band. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
INMIATOds unsignedInt​(3:511) unsignedInt​(3:511) -

The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset, measured in DMT symbols, that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported.

Note: In G.997.1, this parameter is called INMIATO. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
INMIATSds unsignedInt​(0:7) unsignedInt​(0:7) -

The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported.

Note: In G.997.1, this parameter is called INMIATS. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
INMCCds unsignedInt​(0:64) unsignedInt​(0:64) -

The Impulse Noise Monitoring (INM) Cluster Continuation value, measured in DMT symbols, that the xTU receiver uses in the cluster indication process.

Note: In G.997.1, this parameter is called INMCC. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
INMINPEQMODEds unsignedInt​(0:3) unsignedInt​(0:3) -

The Impulse Noise Monitoring (INM) Equivalent Impulse Noise Protection (INP) Mode that the xTU receiver uses in the computation of the Equivalent INP.

Note: In G.997.1, this parameter is called INM_INPEQ_MODE. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
UpstreamAttenuation int int - The current upstream signal loss (expressed in 0.1dB). - 2.0 TR-181i2c3
DownstreamAttenuation int int - The current downstream signal loss (expressed in 0.1dB). - 2.0 TR-181i2c3
UpstreamPower int int - The current output power at the CPE's DSL line (expressed in 0.1dBmV). - 2.0 TR-181i2c3
DownstreamPower int int - The current received power at the CPE's DSL line (expressed in 0.1dBmV). - 2.0 TR-181i2c3
XTURVendor hexBinary​(4:4) hexBinary​(4:4) -

xTU-R vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits.

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, it MUST have the value "00000000".

Note: In G.997.1, this parameter is called "xTU-R G.994.1 Vendor ID". See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
XTURCountry hexBinary​(2:2) hexBinary​(2:2) -

T.35 country code of the xTU-R vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits.

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, it MUST have the value "0000".

Note: In G.997.1, this parameter is called "xTU-R G.994.1 Vendor ID". See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
XTURANSIStd unsignedInt unsignedInt -

xTU-R T1.413 Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

- 2.0 TR-181i2c3
XTURANSIRev unsignedInt unsignedInt -

xTU-R Vendor Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

- 2.0 TR-181i2c3
XTUCVendor hexBinary​(4:4) hexBinary​(4:4) -

xTU-C vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits.

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, it MUST have the value "00000000".

- 2.0 TR-181i2c3
XTUCCountry hexBinary​(2:2) hexBinary​(2:2) -

T.35 country code of the xTU-C vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits.

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, it MUST have the value "0000".

- 2.0 TR-181i2c3
XTUCANSIStd unsignedInt unsignedInt -

xTU-C T1.413 Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

- 2.0 TR-181i2c3
XTUCANSIRev unsignedInt unsignedInt -

xTU-C Vendor Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
TotalStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
ShowtimeStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics.

Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link.

Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
LastShowtimeStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
CurrentDayStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
QuarterHourStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​Stats.​Total. object object​[1:1] -

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 TR-181i2c3
ErroredSecs unsignedInt unsignedInt -

Total number of errored seconds (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).

- 2.0 TR-181i2c3
SeverelyErroredSecs unsignedInt unsignedInt -

Total number of severely errored seconds (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).

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​Stats.​Showtime. object object​[1:1] -

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 TR-181i2c3
ErroredSecs unsignedInt unsignedInt -

Number of errored seconds 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).

- 2.0 TR-181i2c3
SeverelyErroredSecs unsignedInt unsignedInt -

Number of severely errored seconds 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).

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​Stats.​LastShowtime. object object​[1:1] -

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 TR-181i2c3
ErroredSecs unsignedInt unsignedInt -

Number of errored seconds 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).

- 2.0 TR-181i2c3
SeverelyErroredSecs unsignedInt unsignedInt -

Number of severely errored seconds 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).

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​Stats.​CurrentDay. object object​[1:1] -

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 TR-181i2c3
ErroredSecs unsignedInt unsignedInt -

Number of errored seconds 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).

- 2.0 TR-181i2c3
SeverelyErroredSecs unsignedInt unsignedInt -

Number of severely errored seconds 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).

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​Stats.​QuarterHour. object object​[1:1] -

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 TR-181i2c3
ErroredSecs unsignedInt unsignedInt -

Number of errored seconds 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).

- 2.0 TR-181i2c3
SeverelyErroredSecs unsignedInt unsignedInt -

Number of severely errored seconds 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).

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​TestParams. object object​[1:1] - This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.0 TR-181i2c3
HLOGGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
HLOGGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the upstream direction for HLOGpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
HLOGpsds string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. Indicates the downstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: HLOGpsds is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2c3
HLOGpsus string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. Indicates the upstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: HLOGpsus is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2c3
HLOGMTds unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsds was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
HLOGMTus unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsus was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
QLNGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
QLNGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the upstream direction for QLNpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
QLNpsds int​(2047)​[] list​(2047) of int -

Comma-separated list (maximum number of characters 2047) of integers. Indicates the downstream quiet line noise per subcarrier group. The maximum number of elements is 256 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: QLNpsds is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2c3
QLNpsus string​(2047)​[] list​(2047) of string -

Comma-separated list (maximum number of characters 2047) of strings. Indicates the upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: QLNpsus is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2c3
QLNMTds unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsds was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
QLNMTus unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsus was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
SNRGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
SNRGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the upstream direction for SNRpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
SNRpsds int​(2047)​[] list​(2047) of int -

Comma-separated list (maximum number of characters 2047) of integers. Indicates the downstream SNR per subcarrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: SNRpsds is first measured during initialization and is updated during Showtime.

- 2.0 TR-181i2c3
SNRpsus string​(2047)​[] list​(2047) of string -

Comma-separated list (maximum number of characters 2047) of strings. Indicates the upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: SNRpsus is first measured during initialization and is updated during Showtime.

- 2.0 TR-181i2c3
SNRMTds unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsds was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
SNRMTus unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsus was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
LATNds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
LATNus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SATNds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SATNus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
Device.​DSL.​Line.​{i}.​DataGathering. object object​[1:1] -

This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2.

Note: see ITU-T Recommendation [G.993.2].

- 2.0 TR-181i2a8
LoggingDepthR unsignedInt unsignedInt -

This parameter is the maximum depth of the entire data gathering event buffer at the VTU-R, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2].

Note: This parameter is defined as LOGGING_DEPTH_R in Clause 7.5.3.2 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
ActLoggingDepthReportingR unsignedInt unsignedInt -

This parameter is actual logging depth that is used for reporting the VTU-R event trace buffer over the eoc channel, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2].

Note: This parameter is defined as ACT_LOGGING_DEPTH_REPORTING_R in Clause 7.5.3.4 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
EventTraceBufferR string​(256) string​(256) -

The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the log file of the the data gathering event trace buffer containing the event records that originated at the VTU-R.

This indicates the table entry that represents a Vendor Log File that contains the data gathering buffer at the VTU-R in the DeviceInfo.VendorLogFile table.

This data gathering buffer MAY be retrieved wia an upload RPC of the identified Vendor Log File.

Note: This parameter is defined as EVENT_TRACE_BUFFER_R in Clause 7.5.3.6 of ITU-T Recommendation [G.997.1] and Clause 11.5 of ITU-T Recommendation [G.993.2].

- 2.0 TR-181i2a8
Device.​DSL.​Channel.​{i}. object​[0:] object​[0:∞] -

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

This table models DSL channel(s) on top of 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 TR-181i2c3
Enable boolean boolean W

Enables or disables the channel.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the channel as assigned by the CPE. - 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the channel entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string - 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.0 TR-181i2c3
LinkEncapsulationSupported string​[] list of string -

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

- 2.0 TR-181i2c3
LinkEncapsulationUsed string string -

Indicates the link encapsulation standard that the Channel instance is using for the connection. Enumeration of:

When ATM encapsulation is identified then an upper-layer ATM.Link interface MUST be used.

When PTM encapsulation is identified then an upper-layer PTM.Link interface MUST be used.

- 2.0 TR-181i2c3
LPATH unsignedInt​(:3) unsignedInt​(:3) -

Reports the index of the latency path supporting the bearer channel.

Note: See ITU-T Recommendation [Section 7.5.2.7/G.997.1].

- 2.0 TR-181i2c3
INTLVDEPTH unsignedInt unsignedInt -

Reports the interleaver depth D for the latency path indicated in LPATH.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
INTLVBLOCK int int -

Reports the interleaver block length in use on the latency path indicated in LPATH.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
ActualInterleavingDelay unsignedInt unsignedInt -

Reports the actual delay, in milliseconds, of the latency path due to interleaving.

Note: In G.997.1, this parameter is called "Actual Interleaving Delay." See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
ACTINP int int -

Reports the actual impulse noise protection (INP) provided by the latency path indicated in LPATH. The value is the actual INP in the L0 (i.e., Showtime) state.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
INPREPORT boolean boolean -

Reports whether the value reported in ACTINP was computed assuming the receiver does not use erasure decoding. Valid values are 0 (computed per the formula assuming no erasure decoding) and 1 (computed by taking into account erasure decoding capabilities of receiver).

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to false.

- 2.0 TR-181i2c3
NFEC int int -

Reports the size, in octets, of the Reed-Solomon codeword in use on the latency path indicated in LPATH.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
RFEC int int -

Reports the number of redundancy bytes per Reed-Solomon codeword on the latency path indicated in LPATH.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
LSYMB int int -

Reports the number of bits per symbol assigned to the latency path indicated in LPATH. This value does not include overhead due to trellis coding.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1.

- 2.0 TR-181i2c3
UpstreamCurrRate unsignedInt unsignedInt -

The current physical layer aggregate data rate (expressed in Kbps) of the upstream DSL connection.

Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
DownstreamCurrRate unsignedInt unsignedInt -

The current physical layer aggregate data rate (expressed in Kbps) of the downstream DSL connection.

Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
ACTNDR unsignedInt unsignedInt -

Actual net data rate expressed in Kbps. Independent whether retransmission is used or not in a given transmit direction:

  • In L0 state, this parameter reports the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) at which the bearer channel is operating.
  • In L2 state, the parameter contains the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) in the previous L0 state.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
ACTINPREIN unsignedInt​(0:255) unsignedInt​(0:255) -

Actual impulse noise protection against REIN, expressed in 0.1 DMT symbols.

If retransmission is used in a given transmit direction, this parameter reports the actual impulse noise protection (INP) against REIN (under specific conditions detailed in [ITU T G.998.4]) on the bearer channel in the L0 state. In the L2 state, the parameter contains the INP in the previous L0 state.

The value is coded in fractions of DMT symbols with a granularity of 0.1 symbols.

The range is from 0 to 25.4. A special value of 25.5 indicates an ACTINP_REIN of 25.5 or higher.

Note: This parameter is defined as ACTINP_REIN in Clause 7.5.2.9 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a8
Device.​DSL.​Channel.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
TotalStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
ShowtimeStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics.

Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link.

Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
LastShowtimeStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
CurrentDayStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
QuarterHourStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
Device.​DSL.​Channel.​{i}.​Stats.​Total. object object​[1:1] -

This object contains DSL channel total statistics [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 TR-181i2c3
XTURFECErrors unsignedInt unsignedInt -

Total number of FEC errors detected (FEC-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCFECErrors unsignedInt unsignedInt -

Total number of FEC errors detected by the ATU-C (FEC-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURHECErrors unsignedInt unsignedInt -

Total number of HEC errors detected (HEC-P as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCHECErrors unsignedInt unsignedInt -

Total number of HEC errors detected by the ATU-C (HEC-PFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURCRCErrors unsignedInt unsignedInt -

Total number of CRC errors detected (CV-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCCRCErrors unsignedInt unsignedInt -

Total number of CRC errors detected by the ATU-C (CV-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
Device.​DSL.​Channel.​{i}.​Stats.​Showtime. object object​[1:1] -

This object contains DSL channel statistics accumulated since the most recent DSL Showtime [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 TR-181i2c3
XTURFECErrors unsignedInt unsignedInt -

Number of FEC errors detected since the most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCFECErrors unsignedInt unsignedInt -

Number of FEC errors detected by the ATU-C since the most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURHECErrors unsignedInt unsignedInt -

Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCHECErrors unsignedInt unsignedInt -

Number of HEC errors detected by the ATU-C since the most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected since the most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected by the ATU-C since the most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
Device.​DSL.​Channel.​{i}.​Stats.​LastShowtime. object object​[1:1] -

This object contains DSL channel statistics accumulated since the second most recent DSL Showtime [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 TR-181i2c3
XTURFECErrors unsignedInt unsignedInt -

Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCFECErrors unsignedInt unsignedInt -

Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURHECErrors unsignedInt unsignedInt -

Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCHECErrors unsignedInt unsignedInt -

Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
Device.​DSL.​Channel.​{i}.​Stats.​CurrentDay. object object​[1:1] -

This object contains DSL channel statistics accumulated during the current day [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 TR-181i2c3
XTURFECErrors unsignedInt unsignedInt -

Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCFECErrors unsignedInt unsignedInt -

Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURHECErrors unsignedInt unsignedInt -

Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCHECErrors unsignedInt unsignedInt -

Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
Device.​DSL.​Channel.​{i}.​Stats.​QuarterHour. object object​[1:1] -

This object contains DSL channel statistics accumulated during the current quarter hour [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 TR-181i2c3
XTURFECErrors unsignedInt unsignedInt -

Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCFECErrors unsignedInt unsignedInt -

Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURHECErrors unsignedInt unsignedInt -

Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCHECErrors unsignedInt unsignedInt -

Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTURCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
XTUCCRCErrors unsignedInt unsignedInt -

Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]).

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}. object​[0:] object​[0:∞] -

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance for each bonded channel in the group.

Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured via [TR-069].

The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup.

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

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the bonding group.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the bonding group as assigned by the CPE. - 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the bonding group entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string -

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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

LowerLayers is read-only for this object because bonding is expected to be configured by the CPE, not by the ACS.

- 2.0 TR-181i2c3
GroupStatus string​[] list of string -

Comma-separated list of strings. Indicates the current fault status of the DSL bonding group. Each list item is an enumeration of:

  • NoPeer (Peer physical layer is unreachable)
  • PeerPowerLoss (Local device received a "dying gasp" message (preceding a loss-of-power) from the peer device)
  • PeerBondSchemeMismatch (Operating bonding scheme of the peer port is different from the local one)
  • LowRate (Upstream or downstream data rate is at or below threshold)

Corresponds to [TR-159] oBondingGroup.aGroupStatus.

- 2.0 TR-181i2c3
GroupID unsignedInt unsignedInt - DSL bonding group ID. Corresponds to [TR-159] oBondingGroup.aGroupID. - 2.0 TR-181i2c3
BondSchemesSupported string​[] list of string -

Comma-separated list of strings. Supported DSL bonding schemes. Each list item is an enumeration of:

Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported.

- 2.0 TR-181i2c3
BondScheme string string - The value MUST be a member of the list reported by the BondSchemesSupported parameter. Currently operating bonding scheme. Corresponds to [TR-159] aGroupOperBondScheme. - 2.0 TR-181i2c3
GroupCapacity unsignedInt​(1:32) unsignedInt​(1:32) - DSL bonding group capacity, i.e. the maximum number of channels that can be bonded in this group. Corresponds to [TR-159] oBondingGroup.aGroupCapacity. - 2.0 TR-181i2c3
RunningTime unsignedInt unsignedInt - The accumulated time in seconds for which this bonding group has been operationally up. Corresponds to [Section 11.4.2/G.998.1] Group Running Time. - 2.0 TR-181i2c3
TargetUpRate unsignedInt unsignedInt - Desired upstream data rate in bits per second for this DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetUpRate. - 2.0 TR-181i2c3
TargetDownRate unsignedInt unsignedInt - Desired downstream data rate in bits per second for DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetDownRate. - 2.0 TR-181i2c3
ThreshLowUpRate unsignedInt unsignedInt - Threshold upstream data rate in bits per second for this DSL bonding group. GroupStatus will include LowRate whenever the upstream rate is less than this threshold. Corresponds to [TR-159] oBondingGroup.aGroupThreshLowUpRate. - 2.0 TR-181i2c3
ThreshLowDownRate unsignedInt unsignedInt - Threshold downstream data rate in bits per second for this DSL bonding group. GroupStatus will include LowRate whenever the downstream rate is less than this threshold. Corresponds to [TR-159] oBondingGroup.aGroupThreshLowDownRate. - 2.0 TR-181i2c3
UpstreamDifferentialDelayTolerance unsignedInt unsignedInt - The maximum upstream differential delay in milliseconds among member links in a bonding group. Corresponds to [Section 11.4.1/G.998.1] Differential Delay Tolerance. - 2.0 TR-181i2c3
DownstreamDifferentialDelayTolerance unsignedInt unsignedInt - The maximum downstream differential delay in milliseconds among member links in a bonding group. Corresponds to [Section 11.4.1/G.998.1] Differential Delay Tolerance. - 2.0 TR-181i2c3
BondedChannelNumberOfEntries unsignedInt​(1:32) unsignedInt​(1:32) - The number of entries in the BondedChannel table. Corresponds to [TR-159] oBondingGroup.aGroupNumChannels. - 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}. object​[0:] object​[0:∞] -

DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one Channel instance. There MUST be an instance of BondedChannel for each DSL channel that is bonded.

When a Channel is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded Channel becomes disabled, the channel remains bonded and so the corresponding BondedChannel instance MUST NOT be deleted.

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

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Channel string​(256) string​(256) -

The value MUST be the Path Name of a row in the DSL.Channel table. This is the channel that is being bonded.

This is read-only because bonding is expected to be configured by the CPE, not by the ACS.

- 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}.​Ethernet. object object​[1:1] -

Per-channel [G.998.2] Ethernet-based bonding parameters.

This object MUST be present if, and only if, BondScheme is Ethernet.

- 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}.​Ethernet.​Stats. object object​[1:1] -

Per-channel [G.998.2] Ethernet-based bonding statistics.

These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) lower layer (per-channel) interfaces.

The CPE MUST reset the Stats parameters 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 TR-181i2c3
UnderflowErrorsSent unsignedInt unsignedInt - Number of underflow errors sent, i.e. on the transmit side of the interface. - 2.0 TR-181i2c3
CRCErrorsReceived unsignedInt unsignedInt - Number of CRC errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
AlignmentErrorsReceived unsignedInt unsignedInt - Number of alignment errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
ShortPacketsReceived unsignedInt unsignedInt - Number of short packets received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
LongPacketsReceived unsignedInt unsignedInt - Number of long packets received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
OverflowErrorsReceived unsignedInt unsignedInt - Number of overflow errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
PauseFramesReceived unsignedInt unsignedInt - Number of pause frames received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
FramesDropped unsignedInt unsignedInt - Number of frames dropped, e.g. because the receive queue is full. - 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
TotalStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
CurrentDayStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
QuarterHourStart unsignedInt unsignedInt -

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​Stats.​Total. object object​[1:1] -

Total statistics for this bonding group.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
FailureReasons string​[] list of string -

Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.0 TR-181i2c3
UpstreamRate unsignedInt unsignedInt - The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0 TR-181i2c3
DownstreamRate unsignedInt unsignedInt - The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0 TR-181i2c3
UpstreamPacketLoss unsignedInt unsignedInt - The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0 TR-181i2c3
DownstreamPacketLoss unsignedInt unsignedInt - The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0 TR-181i2c3
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2c3
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2c3
FailureCount unsignedInt unsignedInt - The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0 TR-181i2c3
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0 TR-181i2c3
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0 TR-181i2c3
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​Stats.​CurrentDay. object object​[1:1] -

Current day statistics for this bonding group.

Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
FailureReasons string​[] list of string -

Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.0 TR-181i2c3
UpstreamRate unsignedInt unsignedInt - The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0 TR-181i2c3
DownstreamRate unsignedInt unsignedInt - The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0 TR-181i2c3
UpstreamPacketLoss unsignedInt unsignedInt - The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0 TR-181i2c3
DownstreamPacketLoss unsignedInt unsignedInt - The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0 TR-181i2c3
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2c3
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2c3
FailureCount unsignedInt unsignedInt - The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0 TR-181i2c3
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0 TR-181i2c3
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0 TR-181i2c3
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​Stats.​QuarterHour. object object​[1:1] -

Current quarter hour statistics for this bonding group.

Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2c3
FailureReasons string​[] list of string -

Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.0 TR-181i2c3
UpstreamRate unsignedInt unsignedInt - The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0 TR-181i2c3
DownstreamRate unsignedInt unsignedInt - The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0 TR-181i2c3
UpstreamPacketLoss unsignedInt unsignedInt - The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0 TR-181i2c3
DownstreamPacketLoss unsignedInt unsignedInt - The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0 TR-181i2c3
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2c3
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2c3
FailureCount unsignedInt unsignedInt - The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0 TR-181i2c3
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0 TR-181i2c3
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0 TR-181i2c3
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​Ethernet. object​[0:1] object​[0:1] -

Ethernet-based bonding parameters [G.998.2].

This object MUST be present if, and only if, BondScheme is Ethernet.

- 2.0 TR-181i2c3
Device.​DSL.​BondingGroup.​{i}.​Ethernet.​Stats. object object​[1:1] -

[G.998.2] Ethernet-based bonding statistics.

These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) and to its upper layer interface. PAF lower layer interface statistics are in the BondedChannel.{i}.Ethernet.Stats objects.

The CPE MUST reset the Stats parameters 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 TR-181i2c3
PAFErrors unsignedInt unsignedInt - Number of PAF errors. Corresponds to [TR-159] oBondETH.aEthRxErrors. - 2.0 TR-181i2c3
PAFSmallFragments unsignedInt unsignedInt - Number of PAF Small Fragment events. Corresponds to [TR-159] oBondETH.aEthRxSmallFragments. - 2.0 TR-181i2c3
PAFLargeFragments unsignedInt unsignedInt - Number of PAF Large Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLargeFragments. - 2.0 TR-181i2c3
PAFBadFragments unsignedInt unsignedInt - Number of PAF Bad Fragment events. Corresponds to [TR-159] oBondETH.aEthRxBadFragments. - 2.0 TR-181i2c3
PAFLostFragments unsignedInt unsignedInt - Number of PAF Lost Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLostFragments. - 2.0 TR-181i2c3
PAFLateFragments unsignedInt unsignedInt - Number of PAF Late Fragment events. - 2.0 TR-181i2c3
PAFLostStarts unsignedInt unsignedInt - Number of PAF Lost Start events. Corresponds to [TR-159] oBondETH.aEthRxLostStarts. - 2.0 TR-181i2c3
PAFLostEnds unsignedInt unsignedInt - Number of PAF Lost End events. Corresponds to [TR-159] oBondETH.aEthRxLostEnds. - 2.0 TR-181i2c3
PAFOverflows unsignedInt unsignedInt - Number of PAF Overflow events. Corresponds to [TR-159] oBondETH.aEthRxOverflows. - 2.0 TR-181i2c3
PauseFramesSent unsignedInt unsignedInt - Number of pause frames sent, i.e. on the transmit side of the interface. - 2.0 TR-181i2c3
CRCErrorsReceived unsignedInt unsignedInt - Number of CRC errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
AlignmentErrorsReceived unsignedInt unsignedInt - Number of alignment errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
ShortPacketsReceived unsignedInt unsignedInt - Number of short packets received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
LongPacketsReceived unsignedInt unsignedInt - Number of long packets received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
OverflowErrorsReceived unsignedInt unsignedInt - Number of overflow errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2c3
FramesDropped unsignedInt unsignedInt - Number of frames dropped, e.g. because the receive queue is full. - 2.0 TR-181i2c3
Device.​DSL.​Diagnostics. object object​[1:1] - The DSL Diagnostics object. - 2.0 TR-181i2c3
Device.​DSL.​Diagnostics.​ADSLLineTest. object object​[1:1] - This object is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - 2.0 TR-181i2c3
DiagnosticsState string DiagnosticsState W

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

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed 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.

- 2.0 TR-181i2c3
TR-181i2a10
Interface string​(256) string​(256) W The value MUST be the Path Name of a row in the DSL.Channel table. This is the interface over which the test is to be performed. - 2.0 TR-181i2c3
ACTPSDds int int -

Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
ACTPSDus int int -

Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
ACTATPds int int -

Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
ACTATPus int int -

Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
HLINSCds int int -

Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
HLINSCus int int -

Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
HLINGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for HLINpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
HLINGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for HLINpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
HLOGGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
HLOGGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the upstream direction for HLOGpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
HLOGpsds string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. List items represent downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: HLOGpsds is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2c3
HLOGpsus string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. List items represent upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

Note: HLOGpsus is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2c3
HLOGMTds unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsds was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
HLOGMTus unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsus was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
LATNpbds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
LATNpbus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SATNds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
SATNus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2c3
HLINpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

- 2.0 TR-181i2c3
HLINpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

- 2.0 TR-181i2c3
QLNGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
QLNGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the upstream direction for QLNpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
QLNpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream quiet line noise per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

- 2.0 TR-181i2c3
QLNpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

- 2.0 TR-181i2c3
QLNMTds unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsds was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
QLNMTus unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsus was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
SNRGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
SNRGus unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the upstream direction for SNRpsus. Valid values are 1, 2, 4, and 8.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

- 2.0 TR-181i2c3
SNRpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream SNR per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

- 2.0 TR-181i2c3
SNRpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None.

- 2.0 TR-181i2c3
SNRMTds unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsds was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
SNRMTus unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsus was measured.

Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0.

- 2.0 TR-181i2c3
BITSpsds int​(61430)​[] list​(61430) of int - Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0 TR-181i2c3
BITSpsus string​(61430)​[] list​(61430) of string - Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0 TR-181i2c3
Device.​Optical. object object​[1:1] - 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.0 TR-181i2a4
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.0 TR-181i2a4
Device.​Optical.​Interface.​{i}. object​[0:] object​[0:∞] -

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.0 TR-181i2a4
Enable boolean boolean W

Enables or disables the optical interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2a4
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2a4
Alias string​(64) Alias 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.0 TR-181i2a4
Name string​(64) string​(64) - The textual name of the optical interface as assigned by the CPE. - 2.0 TR-181i2a4
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the optical interface entered its current operational state. - 2.0 TR-181i2a4
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2a4
Upstream boolean boolean -

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.
- 2.0 TR-181i2a4
OpticalSignalLevel int​(-65536:65534 step 2) Dbm1000​(-65536:65534 step 2) -

[Dbm1000] Current measurement of total downstream optical signal level.

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 -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments.

This parameter is based on Optical signal level from [Section 9.2.1/G.988].

- 2.0 TR-181i2a4
LowerOpticalThreshold int​(-127000:0 step 500) Dbm1000​(-127000:0 step 500) -

[Dbm1000] Optical level that is used to declare the downstream low received optical power alarm.

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 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy.

This parameter is based on Lower optical threshold from [Section 9.2.1/G.988].

- 2.0 TR-181i2a4
UpperOpticalThreshold int​(-127000:0 step 500) Dbm1000​(-127000:0 step 500) -

[Dbm1000] Optical level that is used to declare the downstream high received optical power alarm.

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 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy.

This parameter is based on Upper optical threshold from [Section 9.2.1/G.988].

- 2.0 TR-181i2a4
TransmitOpticalLevel int​(-127000:0 step 500) Dbm1000​(-127000:0 step 500) -

[Dbm1000] Current measurement of mean optical launch power.

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 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 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].

- 2.0 TR-181i2a4
LowerTransmitPowerThreshold int​(-63500:63500 step 500) Dbm1000​(-63500:63500 step 500) -

[Dbm1000] Minimum mean optical launch power that is used to declare the low transmit optical power alarm.

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 -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy.

This parameter is based on Lower transmit power threshold from [Section 9.2.1/G.988].

- 2.0 TR-181i2a4
UpperTransmitPowerThreshold int​(-63500:63500 step 500) Dbm1000​(-63500:63500 step 500) -

[Dbm1000] Maximum mean optical launch power that is used to declare the high transmit optical power alarm.

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 -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy.

This parameter is based on Upper transmit power threshold from [Section 9.2.1/G.988].

- 2.0 TR-181i2a4
Device.​Optical.​Interface.​{i}.​Stats. object object​[1:1] -

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 TR-181i2a4
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2a4
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2a4
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2a4
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2a4
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2a4
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2a4
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2a4
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2a4
Device.​Cellular. object object​[1:1] - This object models cellular interfaces and access points. - 2.0 TR-181i2a8
RoamingEnabled boolean boolean W Enables or disables roaming. - 2.0 TR-181i2a8
RoamingStatus string string -

Current roaming status. Enumeration of:

- 2.0 TR-181i2a8
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.0 TR-181i2a8
AccessPointNumberOfEntries unsignedInt unsignedInt - The number of entries in the AccessPoint table. - 2.0 TR-181i2a8
Device.​Cellular.​Interface.​{i}. object​[0:] object​[0:∞] -

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.

- 2.0 TR-181i2a8
Enable boolean boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2a8
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status

  • SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.
  • SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed)
  • SHOULD remain in the Error state if there is an error or other fault condition detected on the interface
  • SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

Because the interface includes layer 1 the LowerLayerDown value SHOULD never be used.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2a8
Alias string​(64) Alias 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.0 TR-181i2a8
Name string​(64) string​(64) - The textual name of the interface as assigned by the CPE. - 2.0 TR-181i2a8
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.0 TR-181i2a8
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2a8
Upstream boolean boolean -

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.
- 2.0 TR-181i2a8
IMEI string​(15:15) string​(15:15) -

International Mobile Station Equipment Identity number, represented as a 15 digit string (digits 0-9). Possible patterns:

- 2.0 TR-181i2a8
SupportedAccessTechnologies string​[] list of string -

Comma-separated list of strings. Access technologies supported by the interface. Each list item is an enumeration of:

- 2.0 TR-181i2a8
PreferredAccessTechnology string string W

The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter, or else be Auto. Preferred access technology.

The factory default value MUST be Auto.

- 2.0 TR-181i2a8
CurrentAccessTechnology string string - The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter. Access technology that is currently in use. - 2.0 TR-181i2a8
AvailableNetworks string​[]​(64) list of string​(64) - Comma-separated list of strings (maximum number of characters 64). List of available networks. - 2.0 TR-181i2a8
NetworkRequested string​(64) string​(64) W

Name of the network which will be used, or an empty string if the network is selected automatically.

The factory default value MUST be <Empty>.

- 2.0 TR-181i2a8
NetworkInUse string​(64) string​(64) - The value MUST be a member of the list reported by the AvailableNetworks parameter, or else be an empty string. The value is an empty string if no network is found, or if the network specified in NetworkRequested is not found. - 2.0 TR-181i2a8
RSSI int int -

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

- 2.0 TR-181i2a8
UpstreamMaxBitRate unsignedInt unsignedInt - The current maximum attainable data rate upstream (expressed in Kbps). - 2.0 TR-181i2a8
DownstreamMaxBitRate unsignedInt unsignedInt - The current maximum attainable data rate downstream (expressed in Kbps). - 2.0 TR-181i2a8
Device.​Cellular.​Interface.​{i}.​USIM. object object​[1:1] - USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.0 TR-181i2a8
Status string string -

The current status of the USIM card. Enumeration of:

  • None (No card available)
  • Available (Card is available but not verified)
  • Valid (Card can be used; either valid PIN was entered, or PIN check is deactivated)
  • Blocked (USIM is blocked because the maximum number of invalid PIN entries was exceeded)
  • Error (An error was detected with the card, OPTIONAL)
- 2.0 TR-181i2a8
IMSI string​(14:15) string​(14:15) -

International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN). Possible patterns:

- 2.0 TR-181i2a8
ICCID string​(6:20) string​(6:20) -

Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:

  • Major industry identifier (MII), 2 fixed digits, 89 for telecommunication purposes.
  • Country code, 1–3 digits, as defined by ITU-T recommendation [ITU-E.164].
  • identifier, 1–4 digits.
  • Individual account identification number. Its length is variable, but every number under one IIN will have the same length.
  • Single check digit calculated from the other digits using the Luhn algorithm.

For cards using an ICCID according to [ITU-E.118] the maximum length is 19 Digits, for GSM cards 20 digits. Possible patterns:

- 2.0 TR-181i2a8
MSISDN string​(14:15) string​(14:15) -

Mobile Subscriber Integrated Service Digital Network Number, a number uniquely identifying a subscription in a GSM, UMTS, or LTE mobile network. [ITU-E.164]

Possible patterns:

- 2.0 TR-181i2a8
PINCheck string string W

Controls the PIN verification of the USIM card. Enumeration of:

  • OnNetworkAccess (Check the PIN with each access to a new network)
  • Reboot (Check the PIN with first access after (re)boot)
  • Off (Disable the PIN check)
- 2.0 TR-181i2a8
PIN string​(4) string​(4) W

Allows the ACS to change the USIM PIN used for SIM card activation.

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

- 2.0 TR-181i2a8
Device.​Cellular.​Interface.​{i}.​Stats. object object​[1:1] -

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 TR-181i2a8
BytesSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2a8
BytesReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2a8
PacketsSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of packets transmitted out of the interface. - 2.0 TR-181i2a8
PacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of packets received on the interface. - 2.0 TR-181i2a8
ErrorsSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2a8
ErrorsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2a8
UnicastPacketsSent unsignedLong StatsCounter64 - [StatsCounter64] 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. - 2.0 TR-181i2a8
UnicastPacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] 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. - 2.0 TR-181i2a8
DiscardPacketsSent unsignedLong StatsCounter64 - [StatsCounter64] 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. - 2.0 TR-181i2a8
DiscardPacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] 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. - 2.0 TR-181i2a8
MulticastPacketsSent unsignedLong StatsCounter64 - [StatsCounter64] 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. - 2.0 TR-181i2a8
MulticastPacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2a8
BroadcastPacketsSent unsignedLong StatsCounter64 - [StatsCounter64] 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. - 2.0 TR-181i2a8
BroadcastPacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2a8
UnknownProtoPacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2a8
Device.​Cellular.​AccessPoint.​{i}. object​[0:] object​[0:∞] W

Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with a given value for APN, or with a given value for Interface.

- 2.0 TR-181i2a8
Enable boolean boolean W Enables or disables the Access Point. - 2.0 TR-181i2a8
Alias string​(64) Alias 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.

- 2.0 TR-181i2a8
APN string​(64) string​(64) W Access Point Name. - 2.0 TR-181i2a8
Username string​(256) string​(256) W Username used to authenticate the CPE when making a connection to the Access Point. - 2.0 TR-181i2a8
Password string​(256) string​(256) W

Password used to authenticate the CPE when making a connection to the Access Point.

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

- 2.0 TR-181i2a8
Proxy string​(45) IPAddress W [IPAddress] Proxy server IP address. - 2.0 TR-181i2a8
ProxyPort unsignedInt​(1:65535) unsignedInt​(1:65535) W Proxy server port. - 2.0 TR-181i2a8
Interface string string W The value MUST be the Path Name of a row in the Cellular.Interface table. Reference to the interface with which the access point is associated. - 2.0 TR-181i2a8
Device.​ATM. object object​[1:1] - Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. - 2.0 TR-181i2c3
LinkNumberOfEntries unsignedInt unsignedInt - The number of entries in the Link table. - 2.0 TR-181i2c3
Device.​ATM.​Link.​{i}. object​[0:] object​[0:∞] W

ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object.

When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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.

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the link.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

"Down" 2.0 TR-181i2c3
Alias string​(64) Alias 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.

- 2.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) -

The textual name of the link as assigned by the CPE.

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

- 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the link entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. <Empty> 2.0 TR-181i2c3
LinkType string string W

Indicates the type of connection and refers to the complete stack of protocol used for this connection. Enumeration of:

- 2.0 TR-181i2c3
AutoConfig boolean boolean - Indicates if the CPE is currently using some auto configuration mechanisms for this connection. If this variable is true, all writable variables in this connection instance become read-only. Any attempt to change one of these variables SHOULD fail and an error SHOULD be returned. - 2.0 TR-181i2c3
DestinationAddress string​(256) string​(256) W

Destination address of this link, in the form "VPI/VCI" (e.g. "8/23" or "0/35"). Possible patterns:

- 2.0 TR-181i2c3
Encapsulation string string W

Identifies the connection encapsulation that will be used. Enumeration of:

- 2.0 TR-181i2c3
FCSPreserved boolean boolean W This flag tells if a checksum SHOULD be added in the ATM payload. It does not refer to the checksum of one of the ATM cells or AALX packets. In case of LLC or VCMUX encapsulation, this ATM checksum is the FCS field described in [RFC2684]. It is only applicable in the upstream direction. - 2.0 TR-181i2c3
VCSearchList string​(256)​[] list​(256) of string W

Comma-separated list (maximum number of characters 256) of strings. Ordered list of VPI/VCI pairs to search if a link using the DestinationAddress cannot be established. In the form "VPI1/VCI1, VPI2/VCI2, ...". Each list item matches one of:

Example:

0/35, 8/35, 1/35
- 2.0 TR-181i2c3
AAL string string -

Describes the ATM Adaptation Layer (AAL) currently in use on the PVC. Enumeration of:

- 2.0 TR-181i2c3
Device.​ATM.​Link.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
TransmittedBlocks unsignedInt unsignedInt - The current count of successfully transmitted cells. - 2.0 TR-181i2c3
ReceivedBlocks unsignedInt unsignedInt - The current count of successfully received cells. - 2.0 TR-181i2c3
CRCErrors unsignedInt unsignedInt -

Count of the ATM layer cyclic redundancy check (CRC) errors.

This refers to CRC errors at the ATM adaptation layer (AAL). The AAL in use is indicated by the AAL parameter. The value of the CRCErrors parameter MUST be 0 for AAL types that have no CRCs.

- 2.0 TR-181i2c3
HECErrors unsignedInt unsignedInt - Count of the number of Header Error Check related errors at the ATM layer. - 2.0 TR-181i2c3
Device.​ATM.​Link.​{i}.​QoS. object object​[1:1] - The ATM Link QoS object. - 2.0 TR-181i2c3
QoSClass string string W

Describes the ATM Quality Of Service (QoS) being used on the VC. Enumeration of:

- 2.0 TR-181i2c3
PeakCellRate unsignedInt unsignedInt W Specifies the upstream peak cell rate in cells per second. - 2.0 TR-181i2c3
MaximumBurstSize unsignedInt unsignedInt W Specifies the upstream maximum burst size in cells. - 2.0 TR-181i2c3
SustainableCellRate unsignedInt unsignedInt W Specifies the upstream sustainable cell rate, in cells per second. - 2.0 TR-181i2c3
Device.​ATM.​Diagnostics. object object​[1:1] - The ATM Diagnostics object. - 2.0 TR-181i2c3
Device.​ATM.​Diagnostics.​F5Loopback. object object​[1:1] - This object provides access to an ATM-layer F5 OAM loopback test. - 2.0 TR-181i2c3
DiagnosticsState string DiagnosticsState W

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

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed 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.

- 2.0 TR-181i2c3
TR-181i2a10
Interface string​(256) string​(256) W The value MUST be the Path Name of a row in the ATM.Link table. This is the interface over which the test is to be performed. - 2.0 TR-181i2c3
NumberOfRepetitions unsignedInt​(1:) unsignedInt​(1:) W Number of repetitions of the ping test to perform before reporting the results. - 2.0 TR-181i2c3
Timeout unsignedInt​(1:) unsignedInt​(1:) W Timeout in milliseconds for the ping test. - 2.0 TR-181i2c3
SuccessCount unsignedInt unsignedInt - Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 2.0 TR-181i2c3
FailureCount unsignedInt unsignedInt - Result parameter indicating the number of failed pings in the most recent ping test. - 2.0 TR-181i2c3
AverageResponseTime unsignedInt unsignedInt - Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0 TR-181i2c3
MinimumResponseTime unsignedInt unsignedInt - Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0 TR-181i2c3
MaximumResponseTime unsignedInt unsignedInt - Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0 TR-181i2c3
Device.​PTM. object object​[1:1] - Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0 TR-181i2c3
LinkNumberOfEntries unsignedInt unsignedInt - The number of entries in the Link table. - 2.0 TR-181i2c3
Device.​PTM.​Link.​{i}. object​[0:] object​[0:∞] W

PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object.

When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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.

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the link.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

"Down" 2.0 TR-181i2c3
Alias string​(64) Alias 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.

- 2.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) -

The textual name of the link as assigned by the CPE.

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

- 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the link entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. <Empty> 2.0 TR-181i2c3
MACAddress string​(17) MACAddress -

[MACAddress] The MAC Address of the interface.

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 TR-181i2c3
Device.​PTM.​Link.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
Device.​Ethernet. object object​[1:1] - 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. - 2.0 TR-181i2c3
TR-181i2a7
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.0 TR-181i2c3
LinkNumberOfEntries unsignedInt unsignedInt - The number of entries in the Link table. - 2.0 TR-181i2c3
VLANTerminationNumberOfEntries unsignedInt unsignedInt - The number of entries in the VLANTermination table. - 2.0 TR-181i2c3
RMONStatsNumberOfEntries unsignedInt unsignedInt - The number of entries in the RMONStats table. - 2.0 TR-181i2a4
Device.​Ethernet.​Interface.​{i}. object​[0:] object​[0:∞] -

Ethernet interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical Ethernet ports, but in terms of the interface stack it also models the PHY and MAC level Ethernet interface.

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

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the interface as assigned by the CPE. - 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2c3
Upstream boolean boolean -

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.
- 2.0 TR-181i2c3
MACAddress string​(17) MACAddress -

[MACAddress] The MAC Address of the interface.

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 TR-181i2c3
MaxBitRate int​(-1:) int​(-1:) W

The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps).

A value of -1 indicates automatic selection of the maximum bit rate.

- 2.0 TR-181i2c3
CurrentBitRate unsignedInt unsignedInt -

The current upstream and downstream PHY bit rate on this interface (expressed in Mbps).

A value of 0 indicates that the current bit rate is unknown.

- 2.0 TR-181i2a7
DuplexMode string string W

The duplex mode available to this connection. Enumeration of:

- 2.0 TR-181i2c3
EEECapability boolean boolean - Indicates whether this physical ethernet port supports Energy Efficient Ethernet as specified in [Section 78/802.3-2012_section6]. - 2.0 TR-181i2a8
EEEEnable boolean boolean W Whether Energy Efficient Ethernet [Section 78/802.3-2012_section6] support is currently enabled. When enabled, this ethernet port will be capable of entering or exiting Low Power Idle (LPI) mode. - 2.0 TR-181i2a8
Device.​Ethernet.​Interface.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
Device.​Ethernet.​Link.​{i}. object​[0:] 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.

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

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the link.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

"Down" 2.0 TR-181i2c3
Alias string​(64) Alias 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.

- 2.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) -

The textual name of the link as assigned by the CPE.

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

- 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the link entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. <Empty> 2.0 TR-181i2c3
MACAddress string​(17) MACAddress - [MACAddress] The MAC address used for packets sent via this interface. Provides the source MAC address for outgoing traffic and the destination MAC address for incoming traffic. - 2.0 TR-181i2c3
PriorityTagging boolean boolean W

Enables or disables priority tagging on this Ethernet Link.

When true, egress frames leaving this interface will be priority tagged with the frame's associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark or QoS.Classification.{i}.InnerEthernetPriorityMark.

When false, egress frames leaving this interface will be untagged.

The parameter does not affect reception of ingress frames.

false 2.0 TR-181i2c3
TR-181i2a7
Device.​Ethernet.​Link.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
Device.​Ethernet.​VLANTermination.​{i}. object​[0:] object​[0:∞] W

VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID.

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.

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the VLANTermination entry.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

"Down" 2.0 TR-181i2c3
Alias string​(64) Alias 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.

- 2.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) -

The textual name of the VLANTermination entry as assigned by the CPE.

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

- 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the VLANTermination entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. <Empty> 2.0 TR-181i2c3
VLANID unsignedInt​(1:4094) unsignedInt​(1:4094) W The VLAN ID for this VLANTermination entry (as defined in [802.1Q-2011]). Only ingress frames with this VLAN ID will be passed to higher protocol layers; frames sent from higher protocol layers will be tagged with this VLAN ID. - 2.0 TR-181i2c3
TR-181i2a7
TPID unsignedInt unsignedInt W

The Tag Protocol Identifier (TPID) assigned to this VLANTermination. The TPID is an EtherType value used to identify the frame as a tagged frame.

Standard [Table 9.1/802.1Q-2011] TPID values are:

  • S-TAG 0x88A8 = 34984
  • C-TAG 0x8100 = 33024

Non-Standard TPID values are:

  • S-TAG 0x9100 = 37120
33024 2.0 TR-181i2a7
Device.​Ethernet.​VLANTermination.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
Device.​Ethernet.​RMONStats.​{i}. object​[0:] object​[0:∞] W

Ethernet statistics based on the [RFC2819] RMON-MIB etherStatsTable, with some extensions inspired by [Section 9.3.32/G.988].

Each instance is associated with an interface capable of transporting Ethernet-encapsulated packets, and contains a set of unidirectional Ethernet statistics.

The statistics are sampled either on ingress or on egress. This is determined as follows:

  • If the instance is associated with an egress queue (or queues) via the Queue parameter or by setting AllQueues to true then data is sampled on egress. In this case Bytes etc measure the data that has been sent on the interface, possibly filtered by Queue or VLANID.
  • Otherwise data is sampled on ingress. In this case Bytes etc measure the data that has been received on the interface, possibly filtered by VLANID.

When sampling on egress, the term received means received by the queuing sub-system.

Multiple instances can be associated with a single interface: individual instances can be configured to collect data associated with the entire interface, or with a particular VLAN and/or queue.

The CPE MUST reset each instances's Stats parameters whenever the instance is disabled and re-enabled. Whether this reset occurs when the instance becomes operationally disabled (Status = Disabled) or administratively enabled (Enable = true) is a local matter to the CPE. This is similar to the behavior of interface statistics, e.g. as specified for Device.Ethernet.Interface.{i}.Stats. Furthermore, this instance's Stats parameters MUST be reset whenever the referenced interface's Stats parameters are reset, or when the referenced queue or VLAN is disabled and re-enabled.

For enabled table entries, if Interface references an interface that is not capable of transporting Ethernet-encapsulated packets, or if Queue references a queue that is not instantiated on Interface, or if Queue is not a valid reference and AllQueues is false, the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The RMONStats 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 RMONStats 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 RMONStats row.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

At most one enabled entry in this table can exist with the same values for all of Interface, VLANID and Queue.

- 2.0 TR-181i2a4
Enable boolean boolean W Enables or disables this instance. false 2.0 TR-181i2a4
Status string string -

The status of this instance. Enumeration of:

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

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

"Disabled" 2.0 TR-181i2a4
Alias string​(64) Alias 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.

- 2.0 TR-181i2a4
Name string​(64) string​(64) - The textual name of the RMONStats entry as assigned by the CPE. - 2.0 TR-181i2a4
Interface string string W

The interface associated with this instance. The value MUST be the Path Name of an interface that is capable of transporting Ethernet-encapsulated packets. If the referenced object is deleted, the parameter value MUST be set to an empty string.

The term "capable of transporting Ethernet-encapsulated packets" means "has an Ethernet header" and therefore refers to any interface that is at or below an Ethernet.Link instance in the interface stack.

<Empty> 2.0 TR-181i2a4
VLANID unsignedInt​(0:4094) unsignedInt​(0:4094) W

Filter criterion.

The VLAN ID for which statistics are to be collected.

A zero value indicates that all packets, whether or not they have a VLAN header, will be considered.

A non-zero value indicates that only packets that have the the specified VLAN ID will be considered.

0 2.0 TR-181i2a4
Queue string string W

The value MUST be the Path Name of a row in the Device.QoS.Queue table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Filter criterion.

The egress queue with which this instance is associated.

Only packets that are sent to the referenced queue will be considered.

<Empty> 2.0 TR-181i2a4
AllQueues boolean boolean W Indicates whether this instance applies to all queues. If true, the value of Queue is ignored since all egress queues are indicated. false 2.0 TR-181i2a4
DropEvents unsignedInt unsignedInt -

The total number of events in which packets were dropped due to lack of resources. Note that this number is not necessarily the number of packets dropped; it is just the number of times this condition has been detected.

This parameter is based on etherStatsDropEvents from [RFC2819].

0 2.0 TR-181i2a4
Bytes unsignedLong unsignedLong -

The total number of bytes (including those in bad packets) received (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsOctets from [RFC2819].

0 2.0 TR-181i2a4
Packets unsignedLong unsignedLong -

The total number of packets (including bad packets, broadcast packets, and multicast packets) received.

This parameter is based on etherStatsPkts from [RFC2819].

0 2.0 TR-181i2a4
BroadcastPackets unsignedLong unsignedLong -

The total number of good packets received that were directed to the broadcast address. Note that this does not include multicast packets.

This parameter is based on etherStatsBroadcastPkts from [RFC2819].

0 2.0 TR-181i2a4
MulticastPackets unsignedLong unsignedLong -

The total number of good packets received that were directed to a multicast address. Note that this number does not include packets directed to the broadcast address.

This parameter is based on etherStatsMulticastPkts from [RFC2819].

0 2.0 TR-181i2a4
CRCErroredPackets unsignedInt unsignedInt -

The total number of packets received that had a length (excluding framing bits, but including FCS bytes) of between 64 and 1518 bytes, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of bytes (FCS Error) or a bad FCS with a non-integral number of bytes (Alignment Error).

This parameter is based on etherStatsCRCAlignErrors from [RFC2819].

0 2.0 TR-181i2a4
UndersizePackets unsignedInt unsignedInt -

The total number of packets received that were less than 64 bytes long (excluding framing bits, but including FCS bytes) and were otherwise well formed.

This parameter is based on etherStatsUndersizePkts from [RFC2819].

0 2.0 TR-181i2a4
OversizePackets unsignedInt unsignedInt -

The total number of packets received that were longer than 1518 bytes (excluding framing bits, but including FCS bytes) and were otherwise well formed.

This parameter is based on etherStatsOversizePkts from [RFC2819].

0 2.0 TR-181i2a4
Packets64Bytes unsignedLong unsignedLong -

The total number of packets (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts64Octets from [RFC2819].

0 2.0 TR-181i2a4
Packets65to127Bytes unsignedLong unsignedLong -

The total number of packets (including bad packets) received that were between 65 and 127 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts65to127Octets from [RFC2819].

0 2.0 TR-181i2a4
Packets128to255Bytes unsignedLong unsignedLong -

The total number of packets (including bad packets) received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts6128to255Octets from [RFC2819].

0 2.0 TR-181i2a4
Packets256to511Bytes unsignedLong unsignedLong -

The total number of packets (including bad packets) received that were between 256 and 511 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts256to511Octets from [RFC2819].

0 2.0 TR-181i2a4
Packets512to1023Bytes unsignedLong unsignedLong -

The total number of packets (including bad packets) received that were between 512 and 1023 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts512to1023Octets from [RFC2819].

0 2.0 TR-181i2a4
Packets1024to1518Bytes unsignedLong unsignedLong -

The total number of packets (including bad packets) received that were between 1024 and 1518 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts1024to1518Octets from [RFC2819].

0 2.0 TR-181i2a4
Device.​USB. object object​[1:1] - Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0 TR-181i2c3
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.0 TR-181i2c3
PortNumberOfEntries unsignedInt unsignedInt - The number of entries in the Port table. - 2.0 TR-181i2c3
Device.​USB.​Interface.​{i}. object​[0:] object​[0:∞] -

USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class.

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

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the interface as assigned by the CPE. - 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2c3
Upstream boolean boolean -

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.
- 2.0 TR-181i2c3
MACAddress string​(17) MACAddress -

[MACAddress] The MAC Address of the interface.

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 TR-181i2c3
MaxBitRate unsignedInt unsignedInt - The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0 TR-181i2c3
Port string​(256) string​(256) - The value MUST be the Path Name of a row in the Port table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the USB port associated with this interface object. - 2.0 TR-181i2c3
Device.​USB.​Interface.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
Device.​USB.​Port.​{i}. object​[0:] object​[0:∞] -

USB Port table. This table models master and slave USB physical ports on the device.

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

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the port. - 2.0 TR-181i2c3
Standard string​(4) string​(4) - USB specification version supported by the Port. Example: "1.1" - 2.0 TR-181i2c3
Type string string -

Type of the USB connection. Enumeration of:

- 2.0 TR-181i2c3
Receptacle string string -

Receptacle of the port. Enumeration of:

- 2.0 TR-181i2c3
Rate string string -

Current speed of the USB connection. Enumeration of:

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

Power configuration of the USB connection. Enumeration of:

Only applies when Type is Device. In other cases value is Unknown.

- 2.0 TR-181i2c3
Device.​USB.​USBHosts. object object​[1:1] -

This object models the CPE's USB Host controllers.

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

- 2.0 TR-157
HostNumberOfEntries unsignedInt unsignedInt - The number of entries in the Host table. - 2.0 TR-157
TR-157a2
Device.​USB.​USBHosts.​Host.​{i}. object​[0:] object​[0:∞] -

Table of CPE USB Host controllers.

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

- 2.0 TR-157
Alias string​(64) Alias 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.0 TR-157a4
Enable boolean boolean W Enables or disables the USB Host controller. - 2.0 TR-157
Name string​(64) string​(64) - User-readable host controller name. - 2.0 TR-157
Type string string -

Type of USB Host

Enumeration of:

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

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

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

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

- 2.0 TR-157
PowerManagementEnable boolean boolean W

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

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

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

Table of connected USB devices.

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

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

Class Code as assigned by USB-IF.

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

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

Hub port on parent device.

0 when no parent.

- 2.0 TR-157
USBPort string string - The value MUST be the Path Name of a row in the USB.Port table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the USB host device to which this (external) USB device is connected. - 2.0 TR-157a2
Rate string string -

Speed of the USB device. Enumeration of:

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

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

- 2.0 TR-157
Parent string string -

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

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

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

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

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

- 2.0 TR-157
IsSelfPowered boolean boolean -

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

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

- 2.0 TR-157
ConfigurationNumberOfEntries unsignedInt unsignedInt - The number of entries in the Configuration table. - 2.0 TR-157
TR-157a2
Device.​USB.​USBHosts.​Host.​{i}.​Device.​{i}.​Configuration.​{i}. object​[0:] object​[0:∞] -

Table of device configurations.

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

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

Table of device interface descriptors.

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

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

Class Code as assigned by USB-IF.

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

- 2.0 TR-157
InterfaceSubClass hexBinary​(1) hexBinary​(1) - Subclass code (assigned by USB-IF). - 2.0 TR-157
InterfaceProtocol hexBinary​(1) hexBinary​(1) - Protocol code (assigned by USB-IF). - 2.0 TR-157
Device.​HPNA. object object​[1:1] - HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. - 2.0 TR-181i2c3
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.0 TR-181i2c3
Device.​HPNA.​Interface.​{i}. object​[0:] object​[0:∞] -

HPNA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of an HPNA interface [G.9954].

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

- 2.0 TR-181i2c3
Enable boolean boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2c3
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.0 TR-181i2c3
Alias string​(64) Alias 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.0 TR-181i2c3
TR-181i2a3
Name string​(64) string​(64) - The textual name of the interface as assigned by the CPE. - 2.0 TR-181i2c3
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.0 TR-181i2c3
LowerLayers string​(1024)​[] list​(1024) of string 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. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2c3
Upstream boolean boolean -

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.
- 2.0 TR-181i2c3
MACAddress string​(17) MACAddress -

[MACAddress] The MAC Address of the interface.

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 TR-181i2c3
FirmwareVersion string​(64) string​(64) - This interface's firmware version. - 2.0 TR-181i2c3
NodeID unsignedInt unsignedInt - The Node ID of this interface. - 2.0 TR-181i2c3
IsMaster boolean boolean - Whether this interface is the HPNA network master. - 2.0 TR-181i2c3
Synced boolean boolean - Whether this interface is synchronized with the HPNA network master. If this interface is the HPNA network master, Synced MUST be true. - 2.0 TR-181i2c3
TotalSyncTime unsignedInt unsignedInt - Total time in seconds (since device reset) that this interface has been up and synchronized to the HPNA network master. - 2.0 TR-181i2c3
MaxBitRate unsignedInt unsignedInt - The maximum HPNA PHY bit rate (expressed in Mbps) of this interface. - 2.0 TR-181i2c3
NetworkUtilization unsignedInt​(0:1000) unsignedInt​(0:1000) - Current HPNA network utilization (expressed in 0.1%). - 2.0 TR-181i2c3
PossibleConnectionTypes string​[] list of string -

Comma-separated list of strings. List items indicate the types of connections possible for this interface. Each list item is an enumeration of:

- 2.0 TR-181i2c3
ConnectionType string​[] list of string W Comma-separated list of strings. Each list item MUST be a member of the list reported by the PossibleConnectionTypes parameter. Connection type(s) for which the HPNA protocol is active. - 2.0 TR-181i2c3
PossibleSpectralModes string​[] list of string -

Comma-separated list of strings. List items indicate the spectral modes possible for this interface. Each list item is an enumeration of:

  • A (4-20MHz - Phone / Coax)
  • B (12-28MHz - Phone / Coax)
  • C (36-52MHz - Coax only)
  • D (4-36MHz - Coax only)
- 2.0 TR-181i2c3
SpectralMode string string W The value MUST be a member of the list reported by the PossibleSpectralModes parameter. Spectral mode for which the HPNA protocol is active. - 2.0 TR-181i2c3
MTU unsignedInt unsignedInt W Maximum Transmission Unit for this HPNA interface (expressed in bytes). - 2.0 TR-181i2c3
NoiseMargin unsignedInt unsignedInt W The desired noise margin for which the local HPNA interface has been configured (expressed in 0.1dB). - 2.0 TR-181i2c3
DefaultNonLARQPER unsignedInt unsignedInt W The desired packet error rate for which the local HPNA interface has been configured (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127). - 2.0 TR-181i2c3
LARQEnable boolean boolean W Enable or disable the Limited Automatic Repeat Request (LARQ) mechanism. - 2.0 TR-181i2c3
MinMulticastRate unsignedInt unsignedInt W The minimum multicast (and broadcast) rate that can be negotiated on the HPNA network directly accessible via this interface (expressed in Mbps). - 2.0 TR-181i2c3
NegMulticastRate unsignedInt unsignedInt - The negotiated multicast (and broadcast) rate on the HPNA network directly accessible via this interface (expressed in Mbps). - 2.0 TR-181i2c3
MasterSelectionMode string string W

Master selection mode. Enumeration of:

- 2.0 TR-181i2c3
AssociatedDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the AssociatedDevice table. This is the number of HPNA nodes that are directly accessible via this interface. - 2.0 TR-181i2c3
Device.​HPNA.​Interface.​{i}.​Stats. object object​[1:1] -

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 TR-181i2c3
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2c3
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2c3
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2c3
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2c3
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2c3
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2c3
UnicastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
UnicastPacketsReceived unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
DiscardPacketsSent unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
DiscardPacketsReceived unsignedInt unsignedInt - 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. - 2.0 TR-181i2c3
MulticastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0 TR-181i2c3
BroadcastPacketsSent unsignedLong unsignedLong - 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. - 2.0 TR-181i2c3
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0 TR-181i2c3
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2c3
Device.​HPNA.​Interface.​{i}.​QoS. object object​[1:1] - QoS configuration object. - 2.0 TR-181i2c3
FlowSpecNumberOfEntries unsignedInt unsignedInt - The number of entries in the FlowSpec table. - 2.0 TR-181i2c3
Device.​HPNA.​Interface.​{i}.​QoS.​FlowSpec.​{i}. object​[0:] object​[0:∞] W

Flow specification table.

The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate FlowSpec entry (i.e. the FlowSpec entry whose TrafficClasses list contains a matching traffic class).

For enabled table entries, if TrafficClasses is an empty string 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.

- 2.0 TR-181i2c3
Enable boolean boolean W Enables or disables the table entry. false 2.0 TR-181i2c3
Status string string -

The status of this entry. Enumeration of:

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

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

"Disabled" 2.0 TR-181i2c3
Alias string​(64) Alias 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.

- 2.0 TR-181i2c3
TR-181i2a3
TrafficClasses unsignedInt​(256)​[] list​(256) of unsignedInt W Comma-separated list (maximum number of characters 256) of unsigned integers. This list identifies the set of traffic classes associated with this flow spec. <Empty> 2.0 TR-181i2c3
FlowType string string W

Flow type. Enumeration of:

  • CBR (Constant Bit Rate)
  • VBR (Variable Bit Rate)
  • VBR-NRT (Variable Bit Rate - Non Real Time)
  • BE (Best Effort)
"BE" 2.0 TR-181i2c3
Priority unsignedInt​(0:7) unsignedInt​(0:7) W

Flow queue network priority.

Priority 0 is the lowest priority.

0 2.0 TR-181i2c3
Latency unsignedInt​(0:999) unsignedInt​(0:999) W

Maximum latency of the flow (expressed in milliseconds).

Value 0 means no latency requirements.

0 2.0 TR-181i2c3
Jitter unsignedInt​(0:999) unsignedInt​(0:999) W

Maximum jitter of the flow (expressed in milliseconds).

Value 0 means no jitter requirements.

0 2.0 TR-181i2c3
PacketSize unsignedInt​(0:) unsignedInt​(0:) W

Typical packet size.

Value 0 means undefined packet size.

0 2.0 TR-181i2c3
MinRate unsignedInt unsignedInt W

Minimum required rate in Kbps.

Value 0 means no MinRate requirements.

0 2.0 TR-181i2c3
AvgRate unsignedInt unsignedInt W

Average required rate in Kbps.

Value 0 means no AvgRate requirements.

0 2.0 TR-181i2c3
MaxRate unsignedInt unsignedInt W

Maximum required rate in Kbps.

Value 0 means no MaxRate requirements.

0 2.0 TR-181i2c3
PER unsignedInt unsignedInt W

The desired packet error rate (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127).

Value 0 means no PER requirements.

0 2.0 TR-181i2c3
Timeout unsignedInt unsignedInt W

Flow inactivity tear down timeout (expressed in milliseconds).

Value 0 means unlimited timeout.

0 2.0 TR-181i2c3
Device.​HPNA.​Interface.​{i}.​AssociatedDevice.​{i}. object​[0:] object​[0:∞] -

This table provides information about other HPNA devices that are directly accessible via this HPNA interface.

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

- 2.0 TR-181i2c3
MACAddress string​(17) MACAddress - [MACAddress] The physical address of this node. - 2.0 TR-181i2c3
NodeID unsignedInt unsignedInt - The Node ID of this node. - 2.0 TR-181i2c3
IsMaster boolean boolean - Whether this node is the HPNA network master. - 2.0 TR-181i2c3
Synced boolean boolean - Whether this node is synchronized with the HPNA network master. If this node is the HPNA network master, Synced MUST be true. - 2.0 TR-181i2c3
TotalSyncTime unsignedInt unsignedInt - Total time in seconds (since device reset) that this node has been up and synchronized to the HPNA network master. - 2.0 TR-181i2c3
MaxBitRate unsignedInt unsignedInt - This node's maximum HPNA PHY bit rate (expressed in Mbps). - 2.0 TR-181i2c3
PHYDiagnosticsEnable boolean boolean W Enable / disable PHY throughput diagnostics mode on this node. All devices that are enabled will participate in the HPNA network PHY throughput diagnostics process. - 2.0 TR-181i2c3
Active boolean boolean -

Whether or not this node is currently present in the HPNA network.

The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.

- 2.0 TR-181i2c3
Device.​HPNA.​Diagnostics. object object​[1:1] - The HPNA Diagnostics object. - 2.0 TR-181i2c3
Device.​HPNA.​Diagnostics.​PHYThroughput. object object​[1:1] -

HPNA PHY throughput diagnostics configuration and results.

When diagnostics are requested, all HPNA nodes for which the Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable parameter is set enter PHY diagnostics mode.

- 2.0 TR-181i2c3
DiagnosticsState string DiagnosticsState W

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

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed 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.

- 2.0 TR-181i2c3
TR-181i2a10
Interface string​(256) string​(256) W The value MUST be the Path Name of a row in the HPNA.Interface table. This is the interface over which the test is to be performed. - 2.0 TR-181i2c3
NumPacketsInBurst unsignedInt unsignedInt W Number of test packet in burst to be send during PHY diagnostics test from each HPNA device to other HPNA device in the HPNA network. - 2.0 TR-181i2c3
BurstInterval unsignedInt unsignedInt W Test packet burst interval length (expressed in milliseconds). - 2.0 TR-181i2c3
TestPacketPayloadLength unsignedInt​(0:1480) unsignedInt​(0:1480) W Payload length in the test packets. - 2.0 TR-181i2c3
PayloadEncoding unsignedInt unsignedInt W HPNA payload encoding in PHY diagnostics. 0 is used for negotiated payload between devices according to line conditions. - 2.0 TR-181i2c3
PayloadDataGen unsignedInt unsignedInt W Test packets payload data generator value. - 2.0 TR-181i2c3
PayloadType string string W

Test packets payload type. Enumeration of:

In Pattern mode the PayloadDataGen value is repeated pattern in the payload.

In IncrementByte mode LSByte in PayloadDataGen is used as first payload and next bytes in payload are incremented.

- 2.0 TR-181i2c3
PriorityLevel unsignedInt​(0:7) unsignedInt​(0:7) W Priority level of PHY diagnostics packets (0 lowest -7 highest). - 2.0 TR-181i2c3
ResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the Result table. This is the number of PHY diagnostics results. - 2.0 TR-181i2c3
Device.​HPNA.​Diagnostics.​PHYThroughput.​Result.​{i}. object​[0:] object​[0:∞] -

PHY throughput diagnostics results.

Each result object corresponds to unidirectional traffic between two PHY diagnostics-enabled nodes (so there are two such objects for each such pair).

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

- 2.0 TR-