Broadband Forum

TR-069 Device:2.8 Root Object definition

tr-181-2-8-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.

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1].
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.
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

This notation can also represent individual addresses by specifying all bits.

  • IPv4 example: 192.168.1.1/32
  • IPv6 example: 2001:edff:fe6a:f76::1/128

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(:45)

IPv4 address (or subnet mask).

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

Possible patterns:

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

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)

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.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.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.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[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 Alliance, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, 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-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[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.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] RFC 7648, 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.
[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.
[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.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[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-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 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015.
[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-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 15, Device Data Model, Broadband Forum, January 2022.
[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.
Parameter definition.

Device:2.8 Data Model

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

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device. - 2.0
RootDataModelVersion string(:32) R

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\.\d+

This parameter MUST always be included in Inform messages.

- 2.0
InterfaceStackNumberOfEntries unsignedInt R The number of entries in the InterfaceStack table. - 2.0
Device.Services. object R This object contains general services information. - 2.0
Device.ManagementServer. object R This object contains parameters relating to the CPE’s association with an ACS. - 1.0
EnableCWMP boolean W

Enables and disables the CPE’s support for CWMP. false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS. true means that CWMP support on the CPE is enabled. The subscriber can re-enable the CPE’s CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true.

The factory default value MUST be true.

- 1.0
URL string(:256) W URL, as defined in [RFC3986], for the CPE to connect to the ACS using the CPE WAN Management Protocol. This parameter MUST be in the form of a valid HTTP or HTTPS URL. The host portion of this URL is used by the CPE for validating the ACS certificate when using SSL or TLS. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. - 1.0
Username string(:256) W Username used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol. This username is used only for HTTP-based authentication of the CPE. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. - 1.0
Password string(:256) W

Password used to authenticate the CPE when making a connection to the ACS using the CPE WAN Management Protocol. This password is used only for HTTP-based authentication of the CPE. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

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

- 1.0
PeriodicInformEnable boolean W Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call. - 1.0
PeriodicInformInterval unsignedInt(1:) W The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true. - 1.0
PeriodicInformTime dateTime W An absolute time reference in UTC to determine when the CPE will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the PeriodicInformInterval. PeriodicInformTime is used only to set the phase of the periodic Informs. The actual value of PeriodicInformTime can be arbitrarily far into the past or future. For example, if PeriodicInformInterval is 86400 (a day) and if PeriodicInformTime is set to UTC midnight on some day (in the past, present, or future) then periodic Informs will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicInformTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval. If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the PeriodicInformTime parameter was set to the Unknown Time value. - 1.0
ParameterKey string(:32) R

ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS. The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified. The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string.

This parameter MUST always be included in Inform messages.

Active Notification requests for this parameter MAY be denied.

- 1.0
ConnectionRequestURL string(:256) R

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

http://host:port/path The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name.

Note: If the host portion of the URL is a literal IPv6 address then it MUST be enclosed in square brackets (see [Section 3.2.2/RFC3986]).

This parameter MUST always be included in Inform messages.

Active Notification MUST by default be enabled for this parameter.

- 1.0
ConnectionRequestUsername string(:256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 1.0
ConnectionRequestPassword string(:256) W

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

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

- 1.0
UpgradesManaged boolean W Indicates whether or not the ACS will manage upgrades for the CPE. If true, the CPE SHOULD NOT use other means other than the ACS to seek out available upgrades. If false, the CPE MAY use other means for this purpose. Note that an autonomous upgrade (reported via an “10 AUTONOMOUS TRANSFER COMPLETE” Inform Event code) SHOULD be regarded as a managed upgrade if it is performed according to ACS-specified policy. - 1.0
KickURL string(:256) R Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in [RFC3986], from which the CPE can be kicked to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE. - 1.0
DownloadProgressURL string(:256) R Present only for a CPE that provides a LAN-side web page to show progress during a file download. LAN-accessible URL, as defined in [RFC3986], to which a web-server associated with the ACS MAY redirect a user’s browser on initiation of a file download to observer the status of the download. - 1.0
DefaultActiveNotificationThrottle unsignedInt W This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification. In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met. The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection. The time of the last session completion does not need to be tracked across reboots. - 1.0
CWMPRetryMinimumWaitInterval unsignedInt(1:65535) W Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2]. A value of 5 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - 1.0
CWMPRetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. A value of 2000 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - 1.0
UDPConnectionRequestAddress string(:256) R

Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-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]).

- 1.0
STUNEnable boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 1.0
STUNServerAddress string(:256) W Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. If is an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL. - 1.0
STUNServerPort unsignedInt(0:65535) W Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. By default, this SHOULD be the equal to the default STUN port, 3478. - 1.0
STUNUsername string(:256) W If is not an empty string, the value of the STUN USERNAME attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server). If is an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity. - 1.0
STUNPassword string(:256) W

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

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

- 1.0
STUNMaximumKeepAlivePeriod int(-1:) W If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port. A value of -1 indicates that no maximum period is specified. - 1.0
STUNMinimumKeepAlivePeriod unsignedInt W If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489]. - 1.0
NATDetected boolean R When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use. A true value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE’s source address and port. When STUNEnable is false, this value MUST be false. - 1.0
AliasBasedAddressing boolean R

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

This parameter MUST always be included in Inform messages.

- 1.0
ManageableDeviceNumberOfEntries unsignedInt R The number of entries in the ManageableDevice table. - 1.0
ManageableDeviceNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the ManageableDeviceNumberOfEntries (if Active Notification is enabled). - 1.0
EmbeddedDeviceNumberOfEntries unsignedInt R The number of entries in the EmbeddedDevice table. - 1.0
VirtualDeviceNumberOfEntries unsignedInt R The number of entries in the VirtualDevice table. - 1.0
InstanceMode string W

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

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

The factory default value MUST be InstanceNumber.

- 1.0
AutoCreateInstances boolean W

Enable or disable the Auto-Create Instance Mechanism. When AliasBasedAddressing is true, AutoCreateInstances indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in [A.3.2.1/TR-069a4]). *A true value indicates that the CPE will perform auto-creation of instances when the Alias-Based Addressing Mechanism is used in SetParameterValues RPC. *A false value indicates that the CPE will not create new object instances. Instead, it will reject the setting of parameters in unrecognized instances and respond with a fault code. This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be false.

- 1.0
SupportedConnReqMethods string[] R

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

- 1.0
ConnReqXMPPConnection 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. - 1.0
ConnReqAllowedJabberIDs string(:256)[:32] 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 per item 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.
- 1.0
ConnReqJabberID string R

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.

Active Notification MUST by default be enabled for this parameter.

- 1.0
HTTPCompressionSupported string[] R

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:

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

- 1.0
LightweightNotificationProtocolsSupported string[] R

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

  • UDP (As defined in [Annex M/TR-069a5]) 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.
- 1.0
LightweightNotificationProtocolsUsed 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. - 1.0
UDPLightweightNotificationHost 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). - 1.0
UDPLightweightNotificationPort 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. - 1.0
InformParameterNumberOfEntries unsignedInt R The number of entries in the InformParameter table. - 1.0
Device.ManagementServer.ManageableDevice.{i}. object(0:) R

Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to [Annex F/TR-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 {{param: reference to deprecated parameter Device.ManagementServer.ManageableDevice.{i}.Alias}}, or with the same values for all of ManufacturerOUI, SerialNumber and ProductClass.

- 2.0
Alias string(:64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.

This parameter is DEPRECATED because ManageableDevice is a transient object.

- 2.0
ManufacturerOUI string(6) R

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:

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].

Active Notification requests for this parameter MAY be denied.

- 2.0
SerialNumber string(:64) R

Serial number of the Device as provided to the Gateway by the Device.

Active Notification requests for this parameter MAY be denied.

- 2.0
ProductClass string(:64) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
Host string[](:1024) R 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
Device.ManagementServer.AutonomousTransferCompletePolicy. object R 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
Enable boolean W Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS. - 2.0
TransferTypeFilter string W

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

  • Upload
  • Download
  • Both (Upload and Download) 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
ResultTypeFilter string W

Indicates the transfer results that MUST be included when the CPE notifies the ACS of AUTONOMOUS TRANSFER COMPLETE events. Transfer results omitted from this list MUST NOT be included when the CPE notifies the ACS. Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.

Enumeration of:

  • Success (The autonomous file transfer completed successfully; i.e., the FaultCode was zero)
  • Failure (The autonomous file transfer did not complete successfully; i.e., the FaultCode was non-zero)
  • Both (Success and Failure)
- 2.0
FileTypeFilter string[](:1024) 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.

Each list item matches one of:

  • 1 Firmware Upgrade Image (Download Only)
  • 2 Web Content (Download Only)
  • 3 Vendor Configuration File (Download or Upload)
  • 4 Vendor Log File (Upload Only)
  • X [0-9A-F]{6} .* (For Vendor-Specific File Types, could be for either Download or Upload) Additionally, the following format is defined to allow the unique definition of vendor-specific file types:
  • “X 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
Device.ManagementServer.DownloadAvailability. object R This object contains multicast announcement and query parameters used for the purpose of downloading files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement. object R This object contains multicast announcement parameters used to download files. - 2.0
Enable boolean W Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files. - 2.0
Status string R

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
GroupNumberOfEntries unsignedInt R The number of entries in the Group table. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement.Group.{i}. object(0:) W

Multicast groups to which the CPE SHOULD listen for announcements.

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

- 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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
URL string(:256) W URL [RFC3986] encoding the group address, source and port on which to listen, and other protocol information, e.g. expected announcement format. Depending on the application, the messages identified by this URL MAY directly contain the data to be downloaded, or alternatively MAY contain information informing the CPE how to obtain the data to be downloaded via a separate mechanism, which itself could involve a unicast or a multicast download protocol. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SAP [RFC2974] stream that indicates how to use either FLUTE [RFC3926] or DSM-CC [ISO-13818-6:1998] to perform the download. <Empty> 2.0
Device.ManagementServer.DownloadAvailability.Query. object R This object contains multicast query parameters used to download files. - 2.0
Enable boolean W Enable/disable CPE ability to autonomously query a server for the purpose of downloading files. - 2.0
Status string R

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
URL string(:256) W URL [RFC3986] of the query response server. Depending on the application, the protocol described by this URL MAY be a SOAP interface, or MAY be any other RPC mechanism. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS. - 2.0
Device.ManagementServer.DUStateChangeComplPolicy. object R 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
Enable boolean W Enables/Disables CPE notification of “12 AUTONOMOUS DU STATE CHANGE COMPLETE” events to the ACS. - 2.0
OperationTypeFilter string[] W

Comma-separated list of strings. Indicates the Deployment Unit operations that MUST be included when the CPE notifies the ACS of “12 AUTONOMOUS DU STATE CHANGE COMPLETE” events. Operation types not indicated by this list MUST NOT be included when the CPE notifies the ACS. An empty string is essentially the same as setting Enable to false.

Each list item is an enumeration of:

  • Install
  • Update
  • Uninstall
- 2.0
ResultTypeFilter string W

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

Enumeration of:

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

Comma-separated list of strings. Indicates the Deployment Unit state change fault codes that MUST be included when the CPE notifies the ACS of “12 AUTONOMOUS DU STATE CHANGE COMPLETE” events. State change fault codes omitted from this filter MUST NOT be included when the CPE notifies the ACS. This filter has no effect on the notification of a successful autonomous state change. This filter only applies when ResultTypeFilter is set to either Failure or Both. An empty string means that failed autonomous state changes will not be sent to the ACS.

Each list item is an enumeration of:

  • 9001
  • 9003
  • 9012
  • 9013
  • 9015
  • 9016
  • 9017
  • 9018
  • 9022
  • 9023
  • 9024
  • 9025
  • 9026
  • 9027
  • 9028
  • 9029
  • 9030
  • 9031
  • 9032
- 2.0
Device.ManagementServer.EmbeddedDevice.{i}. object(0:) R

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
ControllerID string(:256) R 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
ProxiedDeviceID string(:256) R 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
Reference string R 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
SupportedDataModel string[] R 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
Host string[:32] R 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
ProxyProtocol string() R

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

  • Z-Wave (see [Z-Wave])
  • ZigBee (see [ZigBee])
  • UPnP-DM (see [UPnP-DM:1])
  • ETSI-M2M (see [ETSIM2MFA]) 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
ProxyProtocolReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. - 2.0
DiscoveryProtocol string[] R

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device. Each list item is an enumeration of:

- 2.0
DiscoveryProtocolReference string[] R 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, or an empty string. For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following: - 2.0
CommandProcessed string R

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

Enumeration of:

  • Pending
  • Retrying
  • Success
  • Error
- 2.0
CommandProcessingErrMsg string(:1024) R Detailed CommandProcessed error description (vendor specific). - 2.0
LastSyncTime dateTime R 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
Device.ManagementServer.VirtualDevice.{i}. object(0:) R

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
ManufacturerOUI string(6) R

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:

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].
- 2.0
ProductClass string(:64) R Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 2.0
SerialNumber string(:64) R Serial number of the associated Proxied Device. - 2.0
Host string[:32] R 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
ProxyProtocol string() R

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

  • Z-Wave (see [Z-Wave])
  • ZigBee (see [ZigBee])
  • UPnP-DM (see [UPnP-DM:1])
  • ETSI-M2M (see [ETSIM2MFA]) 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
ProxyProtocolReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. - 2.0
DiscoveryProtocol string[] R

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device. Each list item is an enumeration of:

- 2.0
DiscoveryProtocolReference string[] R 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, or an empty string. For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following: - 2.0
Device.ManagementServer.StandbyPolicy. object R 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
CRUnawarenessMaxDuration 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
MaxMissedPeriodic 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
NotifyMissedScheduled 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
NetworkAwarenessCapable boolean R Indicates that the CPE is capable of CR-Aware Standby. - 2.0
SelfTimerCapable boolean R Indicates that the CPE is capable of Timer-Aware Standby. - 2.0
CRAwarenessRequested 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
PeriodicAwarenessRequested 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
ScheduledAwarenessRequested 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
Device.ManagementServer.InformParameter.{i}. 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ParameterName.

- 2.0
Enable boolean W Enables or disables this InformParameter. false 2.0
Alias string(:64) W

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

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

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

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

- 2.0
ParameterName 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
EventList 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
Device.GatewayInfo. object R This object contains information associated with a connected Internet Gateway Device. - 2.0
ManufacturerOUI string(:6) R

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

  • <Empty> (an empty string)
  • [0-9A-F]{6} an empty string indicates that there is no associated Internet Gateway Device that has been detected.

Active Notification MUST by default be enabled for this parameter.

- 2.0
ProductClass string(:64) R

Identifier of the product class of the associated Internet Gateway Device. An empty string indicates either that there is no associated Internet Gateway Device that has been detected, or the Internet Gateway Device does not support the use of the product-class parameter.

Active Notification MUST by default be enabled for this parameter.

- 2.0
SerialNumber string(:64) R

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

Active Notification MUST by default be enabled for this parameter.

- 2.0
Device.InterfaceStack.{i}. object(0:) R

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
HigherLayer string(:256) R 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
LowerLayer string(:256) R 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
HigherAlias string(:64) R The value of the Alias parameter for the interface object referenced by HigherLayer. - 2.0
LowerAlias string(:64) R The value of the Alias parameter for the interface object referenced by LowerLayer. - 2.0
Device.DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
LineNumberOfEntries unsignedInt R The number of entries in the Line table. - 2.0
ChannelNumberOfEntries unsignedInt R The number of entries in the Channel table. - 2.0
BondingGroupNumberOfEntries unsignedInt R The number of entries in the BondingGroup table. - 2.0
Device.Optical. object R This object models optical interface technologies. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. The data model definition is based on parts of [G.988]. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.Cellular. object R This object models cellular interfaces and access points. - 2.0
RoamingEnabled boolean W Enables or disables roaming. - 2.0
RoamingStatus string R

Current roaming status.

Enumeration of:

  • Home
  • Roaming
- 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
AccessPointNumberOfEntries unsignedInt R The number of entries in the AccessPoint table. - 2.0
Device.Cellular.Interface.{i}. object(0:) R

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

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

- 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

Enumeration of:

  • Up (Corresponds to GPRS, UMTS, LTE etc ATTACHED status)
  • Down
  • Unknown
  • Dormant
  • NotPresent (Corresponds to GPRS, UMTS, LTE etc DETACHED status)
  • LowerLayerDown
  • Error (OPTIONAL) 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].

Active Notification requests for this parameter MAY be denied.

- 2.0
Alias string(:64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Name string(:64) R The textual name of the interface as assigned by the CPE. - 2.0
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
IMEI string(15) R

International Mobile Station Equipment Identity number, represented as a 15 digit string (digits 0-9).

Possible patterns:

  • [0-9]{15,15}
- 2.0
SupportedAccessTechnologies string[] R

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

Each list item is an enumeration of:

  • GPRS (GSM with GPRS)
  • EDGE (GSM with EDGE)
  • UMTS
  • UMTSHSPA (UMTS with High Speed Packet Access (HSPA [3GPP-HSPA]))
  • CDMA2000OneX
  • CDMA2000HRPD
  • LTE
- 2.0
PreferredAccessTechnology 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
CurrentAccessTechnology string R The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter. Access technology that is currently in use. - 2.0
AvailableNetworks string(:64)[] R

Comma-separated list of strings (maximum number of characters per item 64). List of available networks.

Active Notification requests for this parameter MAY be denied.

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

- 2.0
NetworkInUse string(:64) R 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
RSSI int R

The received signal strength in dBm. The allowed values depend on CurrentAccessTechnology:

  • For GPRS, EDGE the range is -111 dBm to -49 dBm
  • For UMTS, UMTSHSPA the range is -117 dBm to -54 dBm
  • For LTE the range is -117 dBm to -25 dBm Note: An undetectable signal is indicated by the appropriate lower limit, e.g. -117 dBm for LTE.

Active Notification requests for this parameter MAY be denied.

- 2.0
UpstreamMaxBitRate unsignedInt R The current maximum attainable data rate upstream (expressed in Kbps). - 2.0
DownstreamMaxBitRate unsignedInt R The current maximum attainable data rate downstream (expressed in Kbps). - 2.0
Device.Cellular.Interface.{i}.USIM. object R USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.0
Status string R

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
IMSI string(14:15) R

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:

  • [0-9]{14,15}
- 2.0
ICCID string(6:20) R

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:

  • [0-9]{6,20}
- 2.0
MSISDN string(14:15) R

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:

  • [0-9]{14,15}
- 2.0
PINCheck 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
PIN 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
Device.Cellular.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Cellular.AccessPoint.{i}. 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for APN, or with a given value for Interface.

- 2.0
Enable boolean W Enables or disables the Access Point. - 2.0
Alias string(:64) W

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

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

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

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

- 2.0
APN string(:64) W Access Point Name. - 2.0
Username string(:256) W Username used to authenticate the CPE when making a connection to the Access Point. - 2.0
Password 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
Proxy string(:45) W [IPAddress] Proxy server IP address. - 2.0
ProxyPort unsignedInt(1:65535) W Proxy server port. - 2.0
Interface 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
Device.Optical.Interface.{i}. object(0:) R

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

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

- 2.0
Enable boolean W Enables or disables the optical interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Name string(:64) R The textual name of the optical interface as assigned by the CPE. - 2.0
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
OpticalSignalLevel int R Current measurement of total downstream optical signal level. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -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
LowerOpticalThreshold int R Optical level that is used to declare the downstream low received optical power alarm. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -127.5 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
UpperOpticalThreshold int R Optical level that is used to declare the downstream high received optical power alarm. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -127.5 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
TransmitOpticalLevel int R Current measurement of mean optical launch power. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -127.5 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
LowerTransmitPowerThreshold int R Minimum mean optical launch power that is used to declare the low transmit optical power alarm. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -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
UpperTransmitPowerThreshold int R Maximum mean optical launch power that is used to declare the high transmit optical power alarm. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -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
Device.Optical.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Line.{i}. object(0:) R

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

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

- 2.0
Enable boolean W Enables or disables the DSL line. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
EnableDataGathering boolean W Enables or disables data gathering on the DSL line. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Line is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
FirmwareVersion string(:64) R 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
LinkStatus string R

Status of the DSL physical link. Enumeration of:

- 2.0
StandardsSupported string[] R

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

  • G.992.1_Annex_A
  • G.992.1_Annex_B
  • G.992.1_Annex_C
  • T1.413
  • T1.413i2
  • ETSI_101_388
  • G.992.2
  • G.992.3_Annex_A
  • G.992.3_Annex_B
  • G.992.3_Annex_C
  • G.992.3_Annex_I
  • G.992.3_Annex_J
  • G.992.3_Annex_L
  • G.992.3_Annex_M
  • G.992.4
  • G.992.5_Annex_A
  • G.992.5_Annex_B
  • G.992.5_Annex_C
  • G.992.5_Annex_I
  • G.992.5_Annex_J
  • G.992.5_Annex_M
  • G.993.1
  • G.993.1_Annex_A
  • G.993.2_Annex_A
  • G.993.2_Annex_B
  • G.993.2_Annex_C Note: In G.997.1, this parameter is called “xDSL Transmission system capabilities”. See ITU-T Recommendation [G.997.1].

This parameter 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
StandardUsed string R

The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Line instance is using for the connection. Note: In G.997.1, this parameter is called “xDSL Transmission system”. See ITU-T Recommendation [G.997.1].

This parameter 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
LineEncoding string R

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

  • DMT
  • CAP
  • 2B1Q
  • 43BT
  • PAM
  • QAM Note: Generally speaking, this variable does not change after provisioning.
- 2.0
AllowedProfiles string[] R

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

  • 8a
  • 8b
  • 8c
  • 8d
  • 12a
  • 12b
  • 17a
  • 17b
  • 30a 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
CurrentProfile string R 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
PowerManagementState string R

The power management state of the line. Enumeration of:

  • L0
  • L1
  • L2
  • L3
  • L4 Note: See ITU-T Recommendation [G.997.1].
- 2.0
SuccessFailureCause unsignedInt(0:6) R 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
LastStateTransmittedDownstream unsignedInt R 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
LastStateTransmittedUpstream unsignedInt R 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
UPBOKLE unsignedInt(0:1280) R 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
MREFPSDds base64(0:145) R 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
MREFPSDus base64(0:145) R 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
LIMITMASK unsignedInt R 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
US0MASK unsignedInt R 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
TRELLISds int R 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
TRELLISus int R 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
ACTSNRMODEds unsignedInt R 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
ACTSNRMODEus unsignedInt R 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
VirtualNoisePSDds base64(0:97) R 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
VirtualNoisePSDus base64(0:49) R 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
ACTUALCE unsignedInt R 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
LineNumber int(1:) R Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.0
UpstreamMaxBitRate unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DownstreamMaxBitRate unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UpstreamNoiseMargin int R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DownstreamNoiseMargin int R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRMpbus string[](:24) R 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
SNRMpbds string[](:24) R 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
INMIATOds unsignedInt(3:511) R 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
INMIATSds unsignedInt(0:7) R 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
INMCCds unsignedInt(0:64) R 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
INMINPEQMODEds unsignedInt(0:3) R 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
UpstreamAttenuation int R

The current upstream signal loss (expressed in 0.1dB).

Active Notification requests for this parameter MAY be denied.

- 2.0
DownstreamAttenuation int R

The current downstream signal loss (expressed in 0.1dB).

Active Notification requests for this parameter MAY be denied.

- 2.0
UpstreamPower int R

The current output power at the CPE’s DSL line (expressed in 0.1dBmV).

Active Notification requests for this parameter MAY be denied.

- 2.0
DownstreamPower int R

The current received power at the CPE’s DSL line (expressed in 0.1dBmV).

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURVendor hexBinary(4) R 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
XTURCountry hexBinary(2) R 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
XTURANSIStd unsignedInt R 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
XTURANSIRev unsignedInt R 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
XTUCVendor hexBinary(4) R 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
XTUCCountry hexBinary(2) R 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
XTUCANSIStd unsignedInt R 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
XTUCANSIRev unsignedInt R 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
XTSE hexBinary(8) R 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
XTSUsed hexBinary(8) R 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
UPBOKLER unsignedInt(0:1280) R 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
UPBOKLEPb unsignedInt(0:1280,2047)[] R Comma-separated list of unsigned integers (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
UPBOKLERPb unsignedInt(0:1280,2047)[] R Comma-separated list of unsigned integers (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
RXTHRSHds int(-640:0) R 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
ACTRAMODEds unsignedInt(1:4) R 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
ACTRAMODEus unsignedInt(1:4) R 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
ACTINPROCds unsignedInt R 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
ACTINPROCus unsignedInt R 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
SNRMROCds unsignedInt R 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
SNRMROCus unsignedInt R 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
Device.DSL.Line.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
TotalStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
ShowtimeStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
LastShowtimeStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
CurrentDayStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QuarterHourStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Line.{i}.Stats.Total. object R This object contains DSL line total statistics. See [Chapter 7.2.6/G.997.1]. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
ErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Line.{i}.TestParams. object R This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.0
HLOGGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGpsds string[](:2559) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGpsus string[](:2559) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGMTds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGMTus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNpsds int[](:2047) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNpsus string[](:2047) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNMTds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNMTus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRpsds int[](:2047) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRpsus string[](:2047) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRMTds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRMTus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
LATNds string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LATNus string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SATNds string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SATNus string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Line.{i}.DataGathering. object R 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
LoggingDepthR unsignedInt R 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
ActLoggingDepthReportingR unsignedInt R 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
EventTraceBufferR string(:256) R 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
Device.DSL.Channel.{i}. object(0:) R

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
Enable boolean W Enables or disables the channel. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. - 2.0
LinkEncapsulationSupported string[] R

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:

  • G.992.3_Annex_K_ATM
  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_ATM
  • G.993.2_Annex_K_PTM
  • G.994.1 (Auto)
- 2.0
LinkEncapsulationUsed string R

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

  • G.992.3_Annex_K_ATM
  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_ATM
  • G.993.2_Annex_K_PTM 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
LPATH unsignedInt(:3) R 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
INTLVDEPTH unsignedInt R 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
INTLVBLOCK int R 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
ActualInterleavingDelay unsignedInt R 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
ACTINP int R 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
INPREPORT boolean R 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
NFEC int R 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
RFEC int R 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
LSYMB int R 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
UpstreamCurrRate unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DownstreamCurrRate unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ACTNDR unsignedInt R 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
ACTINPREIN unsignedInt(0:255) R 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
Device.DSL.Channel.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
TotalStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
ShowtimeStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
LastShowtimeStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
CurrentDayStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QuarterHourStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Channel.{i}.Stats.Total. object R 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
XTURFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Channel.{i}.Stats.Showtime. object R 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
XTURFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Channel.{i}.Stats.LastShowtime. object R 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
XTURFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Channel.{i}.Stats.CurrentDay. object R 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
XTURFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.Channel.{i}.Stats.QuarterHour. object R 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
XTURFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCFECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCHECErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTURCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
XTUCCRCErrors unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.BondingGroup.{i}. object(0:) R

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
Enable boolean W Enables or disables the bonding group. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers is read-only for this object because bonding is expected to be configured by the CPE, not by the ACS. - 2.0
GroupStatus string[] R

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
GroupID unsignedInt R DSL bonding group ID. Corresponds to [TR-159] oBondingGroup.aGroupID. - 2.0
BondSchemesSupported string[] R

Comma-separated list of strings. Supported DSL bonding schemes. Each list item is an enumeration of:

  • ATM ([G.998.1] ATM-based bonding)
  • Ethernet ([G.998.2] Ethernet-based bonding)
  • TDIM ([G.998.3] TDIM-based bonding) Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported.
- 2.0
BondScheme string R 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
GroupCapacity unsignedInt(1:32) R 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
RunningTime unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
TargetUpRate unsignedInt R 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
TargetDownRate unsignedInt R Desired downstream data rate in bits per second for DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetDownRate. - 2.0
ThreshLowUpRate unsignedInt R 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
ThreshLowDownRate unsignedInt R 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
UpstreamDifferentialDelayTolerance unsignedInt R 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
DownstreamDifferentialDelayTolerance unsignedInt R 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
BondedChannelNumberOfEntries unsignedInt(1:32) R The number of entries in the BondedChannel table. Corresponds to [TR-159] oBondingGroup.aGroupNumChannels. - 2.0
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. object(0:) R

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Channel string(:256) R 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
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet. object R Per-channel [G.998.2] Ethernet-based bonding parameters. This object MUST be present if, and only if, BondScheme is Ethernet. - 2.0
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet.Stats. object R 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
UnderflowErrorsSent unsignedInt R Number of underflow errors sent, i.e. on the transmit side of the interface. - 2.0
CRCErrorsReceived unsignedInt R Number of CRC errors received, i.e. on the receive side of the interface. - 2.0
AlignmentErrorsReceived unsignedInt R Number of alignment errors received, i.e. on the receive side of the interface. - 2.0
ShortPacketsReceived unsignedInt R Number of short packets received, i.e. on the receive side of the interface. - 2.0
LongPacketsReceived unsignedInt R Number of long packets received, i.e. on the receive side of the interface. - 2.0
OverflowErrorsReceived unsignedInt R Number of overflow errors received, i.e. on the receive side of the interface. - 2.0
PauseFramesReceived unsignedInt R Number of pause frames received, i.e. on the receive side of the interface. - 2.0
FramesDropped unsignedInt R Number of frames dropped, e.g. because the receive queue is full. - 2.0
Device.DSL.BondingGroup.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
TotalStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
CurrentDayStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QuarterHourStart unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.DSL.BondingGroup.{i}.Stats.Total. object R 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
FailureReasons string[] R

Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred) Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.
- 2.0
UpstreamRate unsignedInt R 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
DownstreamRate unsignedInt R 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
UpstreamPacketLoss unsignedInt R 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
DownstreamPacketLoss unsignedInt R 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
UpstreamDifferentialDelay unsignedInt R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
DownstreamDifferentialDelay unsignedInt R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
FailureCount unsignedInt R 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
ErroredSeconds unsignedInt R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
SeverelyErroredSeconds unsignedInt R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
UnavailableSeconds unsignedInt R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.DSL.BondingGroup.{i}.Stats.CurrentDay. object R 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
FailureReasons string[] R

Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred) Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.
- 2.0
UpstreamRate unsignedInt R 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
DownstreamRate unsignedInt R 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
UpstreamPacketLoss unsignedInt R 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
DownstreamPacketLoss unsignedInt R 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
UpstreamDifferentialDelay unsignedInt R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
DownstreamDifferentialDelay unsignedInt R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
FailureCount unsignedInt R 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
ErroredSeconds unsignedInt R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
SeverelyErroredSeconds unsignedInt R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
UnavailableSeconds unsignedInt R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.DSL.BondingGroup.{i}.Stats.QuarterHour. object R 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
FailureReasons string[] R

Comma-separated list of strings. Indicates the failure conditions that have occurred during the accumulation period. Each list item is an enumeration of:

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred) Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.
- 2.0
UpstreamRate unsignedInt R 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
DownstreamRate unsignedInt R 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
UpstreamPacketLoss unsignedInt R 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
DownstreamPacketLoss unsignedInt R 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
UpstreamDifferentialDelay unsignedInt R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
DownstreamDifferentialDelay unsignedInt R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
FailureCount unsignedInt R 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
ErroredSeconds unsignedInt R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
SeverelyErroredSeconds unsignedInt R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
UnavailableSeconds unsignedInt R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.DSL.BondingGroup.{i}.Ethernet. object(0:1) R

Ethernet-based bonding parameters [G.998.2]. This object MUST be present if, and only if, BondScheme is Ethernet.

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

- 2.0
Device.DSL.BondingGroup.{i}.Ethernet.Stats. object R [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
PAFErrors unsignedInt R Number of PAF errors. Corresponds to [TR-159] oBondETH.aEthRxErrors. - 2.0
PAFSmallFragments unsignedInt R Number of PAF Small Fragment events. Corresponds to [TR-159] oBondETH.aEthRxSmallFragments. - 2.0
PAFLargeFragments unsignedInt R Number of PAF Large Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLargeFragments. - 2.0
PAFBadFragments unsignedInt R Number of PAF Bad Fragment events. Corresponds to [TR-159] oBondETH.aEthRxBadFragments. - 2.0
PAFLostFragments unsignedInt R Number of PAF Lost Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLostFragments. - 2.0
PAFLateFragments unsignedInt R Number of PAF Late Fragment events. - 2.0
PAFLostStarts unsignedInt R Number of PAF Lost Start events. Corresponds to [TR-159] oBondETH.aEthRxLostStarts. - 2.0
PAFLostEnds unsignedInt R Number of PAF Lost End events. Corresponds to [TR-159] oBondETH.aEthRxLostEnds. - 2.0
PAFOverflows unsignedInt R Number of PAF Overflow events. Corresponds to [TR-159] oBondETH.aEthRxOverflows. - 2.0
PauseFramesSent unsignedInt R Number of pause frames sent, i.e. on the transmit side of the interface. - 2.0
CRCErrorsReceived unsignedInt R Number of CRC errors received, i.e. on the receive side of the interface. - 2.0
AlignmentErrorsReceived unsignedInt R Number of alignment errors received, i.e. on the receive side of the interface. - 2.0
ShortPacketsReceived unsignedInt R Number of short packets received, i.e. on the receive side of the interface. - 2.0
LongPacketsReceived unsignedInt R Number of long packets received, i.e. on the receive side of the interface. - 2.0
OverflowErrorsReceived unsignedInt R Number of overflow errors received, i.e. on the receive side of the interface. - 2.0
FramesDropped unsignedInt R Number of frames dropped, e.g. because the receive queue is full. - 2.0
Device.DSL.Diagnostics. object R The DSL Diagnostics object. - 2.0
Device.DSL.Diagnostics.ADSLLineTest. object R 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
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test, which brings down the DSL connection while the test is operating. When writing, the only allowed value is Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the corresponding reason in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object instance) 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.
- 2.0
Interface 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
ACTPSDds int R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ACTPSDus int R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ACTATPds int R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ACTATPus int R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
HLINSCds int R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLINSCus int R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLINGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLINGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGpsds string[](:2559) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGpsus string[](:2559) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGMTds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLOGMTus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
LATNpbds string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LATNpbus string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SATNds string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SATNus string[](:24) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
HLINpsds int[](:61430) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HLINpsus string[](:61430) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNpsds int[](:61430) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNpsus string[](:61430) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNMTds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
QLNMTus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRGds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRGus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRpsds int[](:61430) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRpsus string[](:61430) R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRMTds unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
SNRMTus unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
BITSpsds int[](:61430) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BITSpsus string[](:61430) R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.ATM. object R Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. - 2.0
LinkNumberOfEntries unsignedInt R The number of entries in the Link table. - 2.0
Device.ATM.Link.{i}. 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. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables the link. This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

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
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. <Empty> 2.0
LinkType string W

Indicates the type of connection and refers to the complete stack of protocol used for this connection.

Enumeration of:

  • EoA ([RFC2684] bridged Ethernet over ATM)
  • IPoA ([RFC2684] routed IP over ATM)
  • PPPoA ([RFC2364] PPP over ATM)
  • CIP ([RFC2225] Classical IP over ATM)
  • Unconfigured
- 2.0
AutoConfig boolean R 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
DestinationAddress string(:256) W

Destination address of this link, in the form “VPI/VCI” (e.g. “8/23” or “0/35”).

Possible patterns:

  • \d+/\d+
- 2.0
Encapsulation string W

Identifies the connection encapsulation that will be used.

Enumeration of:

  • LLC
  • VCMUX
- 2.0
FCSPreserved 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
VCSearchList string[](:256) 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:

  • \d+/\d+ Example:
0/35, 8/35, 1/35
- 2.0
AAL string R

Describes the ATM Adaptation Layer (AAL) currently in use on the PVC.

Enumeration of:

  • AAL1
  • AAL2
  • AAL3
  • AAL4
  • AAL5
- 2.0
Device.ATM.Link.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) 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
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
TransmittedBlocks unsignedInt R

The current count of successfully transmitted cells.

Active Notification requests for this parameter MAY be denied.

- 2.0
ReceivedBlocks unsignedInt R

The current count of successfully received cells.

Active Notification requests for this parameter MAY be denied.

- 2.0
CRCErrors unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
HECErrors unsignedInt R

Count of the number of Header Error Check related errors at the ATM layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.ATM.Link.{i}.QoS. object R The ATM Link QoS object. - 2.0
QoSClass string W

Describes the ATM Quality Of Service (QoS) being used on the VC.

Enumeration of:

  • UBR
  • CBR
  • GFR
  • VBR-nrt
  • VBR-rt
  • UBR+
  • ABR
- 2.0
PeakCellRate unsignedInt W Specifies the upstream peak cell rate in cells per second. - 2.0
MaximumBurstSize unsignedInt W Specifies the upstream maximum burst size in cells. - 2.0
SustainableCellRate unsignedInt W Specifies the upstream sustainable cell rate, in cells per second. - 2.0
Device.ATM.Diagnostics. object R The ATM Diagnostics object. - 2.0
Device.ATM.Diagnostics.F5Loopback. object R This object provides access to an ATM-layer F5 OAM loopback test. - 2.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object instance) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

Active Notification requests for this parameter MAY be denied.

- 2.0
Interface 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
NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform before reporting the results. - 2.0
Timeout unsignedInt(1:) W Timeout in milliseconds for the ping test. - 2.0
SuccessCount unsignedInt R

Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test.

Active Notification requests for this parameter MAY be denied.

- 2.0
FailureCount unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
AverageResponseTime unsignedInt R

Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

- 2.0
MinimumResponseTime unsignedInt R

Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

- 2.0
MaximumResponseTime unsignedInt R

Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.PTM. object R Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0
LinkNumberOfEntries unsignedInt R The number of entries in the Link table. - 2.0
Device.PTM.Link.{i}. 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. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables the link. This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

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
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ethernet. object R Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An “outer” VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
LinkNumberOfEntries unsignedInt R The number of entries in the Link table. - 2.0
VLANTerminationNumberOfEntries unsignedInt R The number of entries in the VLANTermination table. - 2.0
RMONStatsNumberOfEntries unsignedInt R The number of entries in the RMONStats table. - 2.0
Device.Ethernet.Interface.{i}. object(0:) R

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
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [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
MaxBitRate 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
CurrentBitRate unsignedInt R

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.

Active Notification requests for this parameter MAY be denied.

- 2.0
DuplexMode string W

The duplex mode available to this connection.

Enumeration of:

  • Half
  • Full
  • Auto
- 2.0
EEECapability boolean R Indicates whether this physical ethernet port supports Energy Efficient Ethernet as specified in [Section 78/802.3-2012_section6]. - 2.0
EEEEnable 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
Device.Ethernet.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ethernet.Link.{i}. object(0:) W

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

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

- 2.0
Enable boolean W Enables or disables the link. This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

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
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ethernet.VLANTermination.{i}. 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. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables the VLANTermination entry. This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

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
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. <Empty> 2.0
VLANID 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
TPID 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
Device.Ethernet.VLANTermination.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ethernet.RMONStats.{i}. 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Interface, VLANID and Queue.

- 2.0
Enable boolean W Enables or disables this instance. false 2.0
Status string R

The status of this instance. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

- 2.0
Name string(:64) R The textual name of the RMONStats entry as assigned by the CPE. - 2.0
Interface 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. 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
VLANID 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
Queue 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
AllQueues 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
DropEvents unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets unsignedLong R

The total number of packets (including bad packets, broadcast packets, and multicast packets) received. This parameter is based on etherStatsPkts from [RFC2819].

Active Notification requests for this parameter MAY be denied.

0 2.0
BroadcastPackets unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
MulticastPackets unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
CRCErroredPackets unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
UndersizePackets unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
OversizePackets unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets64Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets65to127Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets128to255Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets256to511Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets512to1023Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Packets1024to1518Bytes unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

0 2.0
Device.USB. object R Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
PortNumberOfEntries unsignedInt R The number of entries in the Port table. - 2.0
Device.USB.Interface.{i}. object(0:) R

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
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [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
MaxBitRate unsignedInt R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
Port string(:256) R 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
Device.USB.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.USB.Port.{i}. object(0:) R

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R The textual name of the port. - 2.0
Standard string(:4) R USB specification version supported by the Port. Example: “1.1” - 2.0
Type string R

Type of the USB connection.

Enumeration of:

  • Host
  • Hub
  • Device
- 2.0
Receptacle string R

Receptacle of the port.

Enumeration of:

  • Standard-A
  • Standard-B
  • Powered-B
  • Micro-AB
  • Micro-B
- 2.0
Rate string R

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
Power string R

Power configuration of the USB connection. Enumeration of:

- 2.0
Device.USB.USBHosts. object R This object models the CPE’s USB Host controllers. See [Appendix I/TR-157] for Theory of Operation. - 2.0
HostNumberOfEntries unsignedInt R The number of entries in the Host table. - 2.0
Device.USB.USBHosts.Host.{i}. object(0:) R

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Enable boolean W Enables or disables the USB Host controller. - 2.0
Name string(:64) R User-readable host controller name. - 2.0
Type string R

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
Reset boolean W

When set to true, reset the Host Controller and apply the reset signaling (see [Chapter 7.1.7.5/USB2.0]) to all of the Host Controller Hub downstream ports. The value is not saved in the device’s state and setting it to false has no effect.

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

- 2.0
PowerManagementEnable boolean W When set to true, PowerManagementEnable enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see [USB2.0], Chapters 4.3.2, 7.1.7.6, and 11.9). When set to false PowerManagementEnable immediately disables the Host controller Power Management policy. - 2.0
USBVersion string(:4) R USB specification version with which the controller complies. Example: “1.1” - 2.0
DeviceNumberOfEntries unsignedInt R The number of entries in the Device table. - 2.0
Device.USB.USBHosts.Host.{i}.Device.{i}. object(0:) R

Table of connected USB devices.

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

- 2.0
DeviceNumber unsignedInt R Device number on USB bus. - 2.0
USBVersion string(:4) R USB specification version with which the device complies. Example: “1.1” - 2.0
DeviceClass hexBinary(:1) R 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
DeviceSubClass hexBinary(:1) R Subclass code (assigned by USB-IF). - 2.0
DeviceVersion unsignedInt(:65535) R Device release number. - 2.0
DeviceProtocol hexBinary(:1) R Protocol code (assigned by USB-IF). - 2.0
ProductID unsignedInt(:65535) R Product ID (assigned by manufacturer). - 2.0
VendorID unsignedInt(:65535) R Vendor ID (assigned by USB-IF). - 2.0
Manufacturer string(:64) R Device Manufacturer string descriptor. - 2.0
ProductClass string(:64) R Device Product Class string descriptor. - 2.0
SerialNumber string(:64) R Device SerialNumber string descriptor. - 2.0
Port unsignedInt(:255) R Hub port on parent device. 0 when no parent. - 2.0
USBPort string R 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
Rate string R

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
Parent string R 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
MaxChildren unsignedInt R Number of ports. Only applies for hub device, equal to 0 for other devices. - 2.0
IsSuspended boolean R 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
IsSelfPowered boolean R 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
ConfigurationNumberOfEntries unsignedInt R The number of entries in the Configuration table. - 2.0
Device.USB.USBHosts.Host.{i}.Device.{i}.Configuration.{i}. object(0:) R

Table of device configurations.

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

- 2.0
ConfigurationNumber unsignedInt R The identifier for each Device Configuration. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.USB.USBHosts.Host.{i}.Device.{i}.Configuration.{i}.Interface.{i}. object(0:) R

Table of device interface descriptors.

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

- 2.0
InterfaceNumber unsignedInt(:255) R Number of this interface (from USB interface descriptor). - 2.0
InterfaceClass hexBinary(:1) R 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
InterfaceSubClass hexBinary(:1) R Subclass code (assigned by USB-IF). - 2.0
InterfaceProtocol hexBinary(:1) R Protocol code (assigned by USB-IF). - 2.0
Device.HPNA. object R 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
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.HPNA.Interface.{i}. object(0:) R

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
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [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
FirmwareVersion string(:64) R This interface’s firmware version. - 2.0
NodeID unsignedInt R The Node ID of this interface. - 2.0
IsMaster boolean R Whether this interface is the HPNA network master. - 2.0
Synced boolean R Whether this interface is synchronized with the HPNA network master. If this interface is the HPNA network master, Synced MUST be true. - 2.0
TotalSyncTime unsignedInt R

Total time in seconds (since device reset) that this interface has been up and synchronized to the HPNA network master.

Active Notification requests for this parameter MAY be denied.

- 2.0
MaxBitRate unsignedInt R The maximum HPNA PHY bit rate (expressed in Mbps) of this interface. - 2.0
NetworkUtilization unsignedInt(0:1000) R Current HPNA network utilization (expressed in 0.1%). - 2.0
PossibleConnectionTypes string[] R

Comma-separated list of strings. List items indicate the types of connections possible for this interface. Each list item is an enumeration of:

  • Phone
  • Coax
- 2.0
ConnectionType string[] W Each list item MUST be a member of the list reported by the PossibleConnectionTypes parameter. Comma-separated list of strings. Connection type(s) for which the HPNA protocol is active. - 2.0
PossibleSpectralModes string[] R

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
SpectralMode 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
MTU unsignedInt W Maximum Transmission Unit for this HPNA interface (expressed in bytes). - 2.0
NoiseMargin unsignedInt W The desired noise margin for which the local HPNA interface has been configured (expressed in 0.1dB). - 2.0
DefaultNonLARQPER 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
LARQEnable boolean W Enable or disable the Limited Automatic Repeat Request (LARQ) mechanism. - 2.0
MinMulticastRate 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
NegMulticastRate unsignedInt R The negotiated multicast (and broadcast) rate on the HPNA network directly accessible via this interface (expressed in Mbps). - 2.0
MasterSelectionMode string W

Master selection mode. Enumeration of:

  • Automatic (Automatic master selection)
  • ForceEndpoint (Force local HPNA interface to be end point)
  • ForceMaster (Force local HPNA interface to be master)
- 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. This is the number of HPNA nodes that are directly accessible via this interface. - 2.0
Device.HPNA.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.HPNA.Interface.{i}.QoS. object R QoS configuration object. - 2.0
FlowSpecNumberOfEntries unsignedInt R The number of entries in the FlowSpec table. - 2.0
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

- 2.0
Enable boolean W Enables or disables the table entry. false 2.0
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
TrafficClasses unsignedInt[](:256) 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
FlowType 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
Priority unsignedInt(0:7) W Flow queue network priority. Priority 0 is the lowest priority. 0 2.0
Latency unsignedInt(0:999) W Maximum latency of the flow (expressed in milliseconds). Value 0 means no latency requirements. 0 2.0
Jitter unsignedInt(0:999) W Maximum jitter of the flow (expressed in milliseconds). Value 0 means no jitter requirements. 0 2.0
PacketSize unsignedInt(0:) W Typical packet size. Value 0 means undefined packet size. 0 2.0
MinRate unsignedInt W Minimum required rate in Kbps. Value 0 means no MinRate requirements. 0 2.0
AvgRate unsignedInt W Average required rate in Kbps. Value 0 means no AvgRate requirements. 0 2.0
MaxRate unsignedInt W Maximum required rate in Kbps. Value 0 means no MaxRate requirements. 0 2.0
PER 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
Timeout unsignedInt W Flow inactivity tear down timeout (expressed in milliseconds). Value 0 means unlimited timeout. 0 2.0
Device.HPNA.Interface.{i}.AssociatedDevice.{i}. object(0:) R

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
MACAddress string(:17) R [MACAddress] The physical address of this node. - 2.0
NodeID unsignedInt R The Node ID of this node. - 2.0
IsMaster boolean R Whether this node is the HPNA network master. - 2.0
Synced boolean R Whether this node is synchronized with the HPNA network master. If this node is the HPNA network master, Synced MUST be true. - 2.0
TotalSyncTime unsignedInt R

Total time in seconds (since device reset) that this node has been up and synchronized to the HPNA network master.

Active Notification requests for this parameter MAY be denied.

- 2.0
MaxBitRate unsignedInt R This node’s maximum HPNA PHY bit rate (expressed in Mbps). - 2.0
PHYDiagnosticsEnable 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
Active boolean R 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
Device.HPNA.Diagnostics. object R The HPNA Diagnostics object. - 2.0
Device.HPNA.Diagnostics.PHYThroughput. object R 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
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_FailToEnableCert (READONLY)
  • Error_CertCmdTimeout (READONLY)
  • Error_UnknownErr (READONLY)
  • Error_UnsupportedOpcode (READONLY)
  • Error_InvalidParam (READONLY)
  • Error_UnsupportedCmdSegment (READONLY)
  • Error_UnsupportedDataGen (READONLY)
  • Error_InvalidSequence (READONLY)
  • Error_InvalidFrame (READONLY)
  • Eror_InvalidOpcode (READONLY) Value is set to Requested to initiate the diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the PHY diagnostics 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. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code “8 DIAGNOSTICS COMPLETE” in the Inform message.
- 2.0
Interface 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
NumPacketsInBurst 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
BurstInterval unsignedInt W Test packet burst interval length (expressed in milliseconds). - 2.0
TestPacketPayloadLength unsignedInt(0:1480) W Payload length in the test packets. - 2.0
PayloadEncoding unsignedInt W HPNA payload encoding in PHY diagnostics. 0 is used for negotiated payload between devices according to line conditions. - 2.0
PayloadDataGen unsignedInt W Test packets payload data generator value. - 2.0
PayloadType string W

Test packets payload type. Enumeration of:

  • Pattern
  • IncrementByte 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
PriorityLevel unsignedInt(0:7) W Priority level of PHY diagnostics packets (0 lowest -7 highest). - 2.0
ResultNumberOfEntries unsignedInt R The number of entries in the Result table. This is the number of PHY diagnostics results. - 2.0
Device.HPNA.Diagnostics.PHYThroughput.Result.{i}. object(0:) R

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
SrcMACAddress string(:17) R [MACAddress] HPNA source MAC address. - 2.0
DestMACAddress string(:17) R [MACAddress] HPNA destination MAC address. - 2.0
PHYRate unsignedInt R PHY diagnostics HPNA PHY rate (expressed in Mbps). - 2.0
BaudRate unsignedInt R PHY Baud rate (expressed in Kbaud). - 2.0
SNR unsignedInt R PHY diagnostics SNR (expressed in 0.1dB). - 2.0
PacketsReceived unsignedInt R Number of received packets in PHY diagnostics mode. - 2.0
Attenuation unsignedInt R Measured attenuation (expressed in 0.1dB). - 2.0
Device.HPNA.Diagnostics.PerformanceMonitoring. object R HPNA performance monitoring configuration and results. Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network. - 2.0
DiagnosticsState string W

Indicates availability of performance monitoring data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_SampleIntervalTooSmall (READONLY) The value is set to Requested to initiate performance monitoring sampling. When writing, the only allowed value is Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the sampling. When the sampling initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code “8 DIAGNOSTICS COMPLETE” in the Inform message. If SampleInterval is non-zero, the CPE will automatically initiate PM sampling every SampleInterval seconds. In this case, the value of this variable MUST transition from Requested to Complete (or to one of the defined error values). The CPE MAY reject a request because insufficient time has elapsed since the previous request, in which case it MUST indicate this via the Error_SampleIntervalTooSmall value. If the ACS requests initiation of the PM sampling while it is already active (i.e. the value of this parameter is already Requested), then the CPE MUST establish a new connection to the ACS on completion of the sampling. This guarantees that the interface seen by the ACS is independent of whether the CPE has automatically initiated the sampling.
- 2.0
Interface 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
SampleInterval unsignedInt W Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The CPE MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the CPE MAY choose to align sample intervals with time of day, but is not required to do so. - 2.0
Device.HPNA.Diagnostics.PerformanceMonitoring.Nodes. object R Per-node HPNA performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the “current” interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the “current” interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. - 2.0
CurrentStart dateTime R Start time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago. - 2.0
CurrentEnd dateTime R End time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample. - 2.0
NodeNumberOfEntries unsignedInt R The number of entries in the Node table. This is the number of HPNA nodes for which performance monitoring results were collected during the current sample interval. - 2.0
Device.HPNA.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}. object(1:) R

Per-node HPNA performance monitoring results during the current sample interval. Each table entry contains the results collected between an HPNA node (as indicated by MACAddress) and the local HPNA interface (as indicated by Interface). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

This table MUST contain at least 1 entry.

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

- 2.0
MACAddress string(:17) R [MACAddress] The MAC address of the HPNA node. - 2.0
BytesSent unsignedLong R The total number of bytes sent by host equipment for transmission on the HPNA interface. - 2.0
BytesReceived unsignedLong R The total number of received bytes on the HPNA interface destined for the host equipment. - 2.0
PacketsSent unsignedLong R The total number of packets sent by host equipment for transmission on the HPNA interface. Number includes also short error packets and control packets. - 2.0
PacketsReceived unsignedLong R The total number of good packets received on the HPNA interface destined for the host equipment. - 2.0
BroadcastPacketsSent unsignedLong R The number of broadcast packets transmitted on the HPNA interface. - 2.0
BroadcastPacketsReceived unsignedLong R The number of broadcast packets received on the HPNA interface. - 2.0
MulticastPacketsSent unsignedLong R The number of multicast packets transmitted on the HPNA interface. - 2.0
MulticastPacketsReceived unsignedLong R The number of multicast packets received on the HPNA interface. - 2.0
PacketsCrcErrored unsignedInt R The number of packets received on the HPNA interface with CRC errors. - 2.0
PacketsCrcErroredHost unsignedInt R The number of CRC error packets received on the HPNA interface destined for the host equipment. - 2.0
PacketsShortErrored unsignedInt R The number of packets received on the HPNA interface that are too short to be valid. - 2.0
PacketsShortErroredHost unsignedInt R The number packets sent by the host equipment that are too short to be valid. - 2.0
RxPacketsDropped unsignedInt R The number of received packets dropped due to lack of resources. - 2.0
TxPacketsDropped unsignedInt R The number packets sent by the host equipment for transmission on the HPNA interface but dropped due to lack of resources. - 2.0
ControlRequestLocal unsignedInt R The number of HPNA control request packets from local host. - 2.0
ControlReplyLocal unsignedInt R The number of HPNA control reply packets to local host. - 2.0
ControlRequestRemote unsignedInt R The number of HPNA control request packets from remote host. - 2.0
ControlReplyRemote unsignedInt R The number of HPNA control reply packets to remote host. - 2.0
PacketsSentWire unsignedLong R The total number of packets transmitted to wire. - 2.0
BroadcastPacketsSentWire unsignedLong R The total number of broadcast packets transmitted to wire. - 2.0
MulticastPacketsSentWire unsignedLong R The total number of multicast packets transmitted to wire. - 2.0
PacketsInternalControl unsignedInt R The number of HPNA control request packets from internal node. - 2.0
BroadcastPacketsInternalControl unsignedInt R The number of HPNA broadcast control request packets from internal node. - 2.0
PacketsReceivedQueued unsignedInt R The number of received packets queued on host output queues. - 2.0
PacketsReceivedForwardUnknown unsignedInt R The number of packets received and forwarded to unknown hosts. - 2.0
NodeUtilization unsignedInt(0:1000) R The node utilization (expressed in 0.1%). - 2.0
Device.HPNA.Diagnostics.PerformanceMonitoring.Channels. object R Per-channel HPNA performance monitoring results. Note: channels are unidirectional. - 2.0
TimeStamp dateTime R Time at which channel data was last collected. - 2.0
ChannelNumberOfEntries unsignedInt R The number of entries in the Channel table. This is the number of HPNA channels for which performance monitoring results have been collected. - 2.0
Device.HPNA.Diagnostics.PerformanceMonitoring.Channels.Channel.{i}. object(0:) R

Per-channel HPNA performance monitoring results.

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

- 2.0
HostSrcMACAddress string(:17) R [MACAddress] The host source MAC address associated with the channel. - 2.0
HostDestMACAddress string(:17) R [MACAddress] The host destination MAC address associated with the channel. - 2.0
HPNASrcMACAddress string(:17) R [MACAddress] The HPNA source MAC address associated with the channel. - 2.0
HPNADestMACAddress string(:17) R [MACAddress] The HPNA destination MAC address associated with the channel. - 2.0
PHYRate unsignedInt R Channel PHY rate (expressed in Mbps). - 2.0
BaudRate unsignedInt R PHY Baud rate (expressed in Kbaud). - 2.0
SNR unsignedInt R Channel actual SNR measured in receiver side (expressed in 0.1dB). - 2.0
PacketsSent unsignedInt R Number of packets sent in the channel. - 2.0
PacketsReceived unsignedInt R Pre-LARQ number of packets received in the channel. - 2.0
LARQPacketsReceived unsignedInt R Post-LARQ number of packets received in the channel. Valid only if LARQ is enabled. - 2.0
FlowSpec string(:256) R The value MUST be the Path Name of a row in the HPNA.Interface.{i}.QoS.FlowSpec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Identifies the FlowSpec associated with the channel. This parameter is only used for channels that correspond to egress traffic from the local HPNA interface. An empty string means that the channel is not associated with any specified flow specification in the QoS object. - 2.0
Device.MoCA. object R MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.Ghn. object R G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.Ghn.Interface.{i}. object(0:) R

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

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

- 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Name string(:64) R The textual name of the interface as assigned by the CPE. - 2.0
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [MACAddress] The MAC Address of the interface, denoted as node MAC address or REGID in [G.9961]. 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
FirmwareVersion string(:64) R The firmware version of the interface. - 2.0
ConnectionType string R

This parameter is DEPRECATED because it has been replaced by MediumType.

Enumeration of:

  • Powerline
  • Phone
  • Coax
- 2.0
TargetDomainNames string(:32)[](:1024) W Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 32). Identifies the target domains configured by the user, as described in [Section 8.6.1/G.9961]. When registering or re-registering, the G.hn interface SHOULD try to register to one of these domains in the given order. - 2.0
DomainName string(:32) R This is the domain name to which the interface is currently registered. An empty string indicates that the interface is currently not registered. - 2.0
DomainNameIdentifier unsignedInt R The Domain Name Identifier, a shortened version of DomainName, denoted as DNI in [Section 8.6.11.2.1/G.9961]. - 2.0
DomainId unsignedInt R The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.0
DeviceId unsignedInt R The Device Identifier assigned by the Domain Master, denoted as DEVICE_ID in [G.9961]. The value 0 indicates that the device is not currently registered. - 2.0
MaxBitRate unsignedInt R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
NodeTypeDMCapable boolean R Indicates whether this interface has the capability to act as Domain Master in the G.hn domain. - 2.0
DMRequested boolean W Indicates a request to force the role of the G.hn interface to Domain Master (DM) for the G.hn domain it is connected to. The selection of the Domain Master follows the procedures described in [Clause 8.6.6/G.9961]. - 2.0
NodeTypeSCCapable boolean R Indicates whether this interface has the capability to act as Security Controller in the G.hn domain. - 2.0
SCRequested boolean W Indicates a request to force the role of the G.hn interface to Security Controller (SC) for the G.hn domain it is connected to. The selection of the Security Controller follows the procedures described in [Clause 9.2/G.9961]. - 2.0
NodeTypeDMConfig boolean W Requests the interface to become the Domain Master in the G.hn domain. This parameter is valid only if NodeTypeDMCapable is true. Note that, if more than one node is configured to act as Domain Master, G.hn specifies a protocol to ensure only one device actually becomes DM. - 2.0
NodeTypeDMStatus boolean R Indicates whether the interface is acting as Domain Master (true) or not (false). See Note in NodeTypeDMConfig regarding the possibility of more than one node being configured with NodeTypeDMConfig = true. - 2.0
NodeTypeSCStatus boolean R Indicates whether the interface is acting as Security Controller (true) or not (false). - 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.0
MaxTransmitRate unsignedInt R The maximum PHY data rate that the interface is capable of transmitting (expressed in Mbps). - 2.0
IsDM boolean R Indicates whether this G.hn interface is currently the Domain Master (DM) for the G.hn domain it is connected to, as described in [Clause 8.6/G.9961]. - 2.0
IsSC boolean R Indicates whether this G.hn interface is currently the Security Controller (SC) for the G.hn domain it is connected to, as described in [Clause 9.2/G.9961]. - 2.0
StandardVersions string[] R Comma-separated list of strings. The standard versions that the interface supports. The list MUST have an even number of items. The first item of each pair represents an ITU-T G.hn Recommendation while the second element of each pair represents the amendment version of the indicated Recommendation that this interface supports (the value 0 corresponds to the base Recommendation). For example, to indicate support for the G.9960 base document and G.9961 amendment 1, the corresponding list would be “G9960,0,G9961,1”. - 2.0
MaxBandPlan unsignedInt R The largest bandplan that the interface can support, as defined in [Clause 8.8.5.5/G.9961]. - 2.0
MediumType string R

The medium type that the interface currently operates on. Refer to [Table 7-5/G.9962].

Enumeration of:

  • PowerLineBaseband
  • PhoneLineBaseband
  • CoaxBaseband
  • CoaxRF
  • PlasticOpticalFiber
- 2.0
TAIFG unsignedInt R The Acknowledgement InterFrame Gap, or TAIFG, as defined in [Clause 8.4/G.9961]. It is represented as multiples of 1.28 microseconds. - 2.0
NotchedAmateurRadioBands hexBinary(:2) W A bit map representing usage of international amateur bands (0 = masked, 1 = unmasked). The LSB represents the lowest band (1.8-2.0 MHz), the second LSB represents the second lowest band (3.5-4.0 MHz), and so on. The maximum value for this parameter is 0x03FF, i.e. it is a 10-bit quantity represented in 16 bits and the top 6 bits are always zero. International Radio amateur bands are described in [Table D-1/G.9964] and conveyed by the Domain Master in the Amateur radio band descriptor (see [Table 8-77/G.9961]). - 2.0
PHYThroughputDiagnosticsEnable string W Comma-separated list of DeviceIDs of nodes that need to enable their PHY throughput diagnostics mode. All devices that are enabled will participate in the G.hn network PHY throughput diagnostics process. - 2.0
PerformanceMonitoringDiagnosticsEnable string W Comma-separated list of DeviceIDs of nodes that need to enable their Performance Monitoring diagnostics mode on this node. All devices that are enabled will participate in the G.hn network Performance Monitoring diagnostics process. - 2.0
SMMaskedBandNumberOfEntries unsignedInt R The number of entries in the SMMaskedBand table. - 2.0
Device.Ghn.Interface.{i}.Stats. object R Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961]. 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
BytesSent unsignedLong R

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

More specifically, this is the total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

More specifically, this is the total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It can include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of packets transmitted out of the interface.

More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of packets received on the interface.

More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

[StatsCounter32] 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.

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

[StatsCounter32] 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.

More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtBytesSent unsignedLong R

[StatsCounter64] The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtBytesReceived unsignedLong R

[StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtPacketsSent unsignedLong R

[StatsCounter64] The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtPacketsReceived unsignedLong R

[StatsCounter64] The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksSent unsignedLong R

[StatsCounter64] The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksReceived unsignedLong R

[StatsCounter64] The total number of LPDUs that were received by the node through a physical medium, with or without errors.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksResent unsignedInt R

[StatsCounter32] The total number of LPDUs that were retransmitted.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksErrorsReceived unsignedInt R

[StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:

  • PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
  • PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
  • Retransmission rate = BlocksResent / BlocksSent.
  • Block error rate = BlocksErrorReceived / BlocksReceived.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ghn.Interface.{i}.AssociatedDevice.{i}. object(0:) R

This table contains information about other G.hn devices connected to this G.hn interface.

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

- 2.0
MACAddress string(:17) R

[MACAddress] MAC address of remote G.hn device.

This is denoted as REGID in [G.9961].

- 2.0
DeviceId unsignedInt R Device Id (as defined in G.hn) for the remote G.hn device, denoted as DEVICE_ID in [G.9961]. - 2.0
TxPhyRate unsignedInt R

The PHY transmit Rate (expressed in Mbps) to this remote device, denoted as PHY data rate in [G.9961].

Refer to Note 1 of [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down.

Active Notification requests for this parameter MAY be denied.

- 2.0
RxPhyRate unsignedInt R

The PHY receive Rate (expressed in Mbps) from this remote device, denoted as PHY data rate in [G.9961].

Refer to Note 1 of [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down.

Active Notification requests for this parameter MAY be denied.

- 2.0
Active boolean R

Whether or not this device is currently present in the G.hn domain. 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.

If Active is true, it indicates that the Status of the remote device is 0, 1, or 2 (see [Table 7-3/G.9961]).

- 2.0
Device.Ghn.Interface.{i}.DMInfo. object R This object specifies management parameters pertaining to the domain functionality (Domain Master function; see [Clause 8.6/G.9961]). The object exists only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true. - 2.0
DomainName hexBinary(:32) W This is the domain name to which the interface is currently registered. An empty string indicates that the interface is currently not registered. - 2.0
DomainNameIdentifier hexBinary(:2) R The Domain Name Identifier, a shortened version of DomainName, denoted as DNI in [Section 8.6.11.2.1/G.9961]. - 2.0
DomainId unsignedInt R The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.0
MACCycleDuration unsignedInt(0,10:200) W The MAC cycle duration, as specified in [Clause 8.4/G.9961]. It is represented as multiples of 0.5 msec. In the case of power line, writing to this parameter has no effect and it reads back as 0, which is a special value indicating that the MAC cycle is synchronized with 2 AC cycles as defined in [Clause 8.6.3.1/G.9961]. - 2.0
SCDeviceId unsignedInt W The DEVICE_ID of the Security Controller selected by the Domain Master. - 2.0
SCMACAddress string(:17) W [MACAddress] The REGID of the Security Controller selected by the Domain Master. - 2.0
ReregistrationTimePeriod unsignedInt(5:63) W The time interval for periodic re-registration, as specified in [Clause 8.8.5.8/G.9961]. It is represented as multiples of 2 seconds. - 2.0
TopologyPeriodicInterval unsignedInt(0:255) W The time interval that a node sends out the periodic topology update using TM_NodeTopologyChange.ind message, as specified in [Clause 8.8.5.8.1/G.9961]. It is represented as multiples of 0.1 sec. The special value 0 represents an infinite interval (i.e., no periodic topology update). - 2.0
MinSupportedBandplan unsignedInt W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.0
MaxSupportedBandplan unsignedInt W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.0
Device.Ghn.Interface.{i}.SCInfo. object R This object specifies management parameters pertaining to the Security Controller functionality (Security Controller function; see [Clause 9.2/G.9961]). The object exists only on G.hn interfaces that are currently the Security Controller, i.e. for which parameter IsSC is true. - 2.0
ModesSupported string[] R

Comma-separated list of strings. The security modes that the Security Controller can support. Refer to [Clause 9.2/G.9961].

Each list item is an enumeration of:

  • NN (Node-to-Node)
  • NMK (Network Membership Key)
- 2.0
ModeEnabled string W The value MUST be a member of the list reported by the ModesSupported parameter, or else be Disabled. The security mode in which the Security Controller is operating. - 2.0
MICSize string W

The selected MIC size used in the domain.

Enumeration of:

  • 4-byte MIC
  • 8-byte MIC
  • 16-byte MIC
- 2.0
Location boolean R Indicates whether the Security Controller is above the L1 reference point. It is set to true if the Security Controller is above the L1 reference point, and set to false otherwise. - 2.0
Device.Ghn.Interface.{i}.SMMaskedBand.{i}. object(0:32) W

Specifies the list of masked bands to be applied to the G.hn interface. This information is conveyed by the Domain Master in the SM descriptor as specified in [Table 8-77/G.9961]. Instances of this object are expected to exist only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true.

This table MUST contain at least 0 and at most 32 entries.

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

- 2.0
Enable boolean W Enables or disables the SMMaskedBand. - 2.0
BandNumber unsignedInt W The masked band number. - 2.0
StartSubCarrier unsignedInt W Index of the lowest frequency sub-carrier in the band to be masked as specified in [Table 8-79/G.9961]. This parameter is writable only on the interface which acts as the Domain Master. - 2.0
StopSubCarrier unsignedInt W Index of the highest frequency sub-carrier in the band to be masked as specified in Table 8-79 in [G.9961]. This parameter is writable only on the interface which acts as the Domain Master. - 2.0
Device.Ghn.Diagnostics. object R The G.hn Diagnostics object. - 2.0
Device.Ghn.Diagnostics.PHYThroughput. object R G.hn PHY throughput diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PHYThroughputDiagnosticsEnable parameter is set enter PHY diagnostics mode. - 2.0
DiagnosticsState string W

Indicates availability of diagnostic data for PHYThroughput measurements Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When 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. After the diagnostic is complete, the value of all result parameters (all read-only parameters in the Diagnostics 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.
- 2.0
Interface string W The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. - 2.0
DiagnoseMACAddress string(:17) W [MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain. - 2.0
PHYThroughputResultNumberOfEntries unsignedInt R The number of entries in the Result table. - 2.0
Device.Ghn.Diagnostics.PHYThroughput.Result.{i}. object(0:) R

PHY throughput diagnostics results.

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

- 2.0
DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.0
LinkState string R

Indicates the state of the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress.

Enumeration of:

- 2.0
TxPhyRate unsignedInt R

PHY data rate in transmit direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down.

Active Notification requests for this parameter MAY be denied.

- 2.0
RxPhyRate unsignedInt R

PHY data rate in receive direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ghn.Diagnostics.PerformanceMonitoring. object R G.hn Performance Monitoring diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PerformanceMonitoringDiagnosticsEnable parameter is set enter PHY diagnostics mode. - 2.0
DiagnosticsState string W

Indicates availability of diagnostic data for Performance Monitoring. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When 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. After the diagnostic is complete, the value of all result parameters (all read-only parameters in the Diagnostics object) MUST be retained by the node 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.
- 2.0
Interface string W The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. - 2.0
DiagnoseMACAddress string(:17) W [MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain. - 2.0
SampleInterval unsignedInt W Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The node MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the device MAY choose to align sample intervals with time of day, but is not required to do so. - 2.0
SNRGroupLength unsignedInt(1,2,4,8,16,32,64,128,256) W The number of sub-carriers in a group to be used for averaging SNR values when providing SNR information for a channel. - 2.0
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes. object R Per-node G.hn performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the “current” interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the “current” interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. - 2.0
CurrentStart dateTime R Start time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago. - 2.0
CurrentEnd dateTime R End time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample. - 2.0
NodeNumberOfEntries unsignedInt R The number of entries in the Node table. This is the number of G.hn nodes for which performance monitoring results were collected during the current sample interval. - 2.0
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}. object(1:) R

Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses DiagnoseMACAddress) and DestinationMACAddress). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

This table MUST contain at least 1 entry.

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

- 2.0
DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.0
BytesSent unsignedLong R

[StatsCounter64] The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

[StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). This parameter represents the total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

[StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

[StatsCounter32] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

[StatsCounter32] The total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

[StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

[StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] The total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtBytesSent unsignedLong R

[StatsCounter64] The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtBytesReceived unsignedLong R

[StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtPacketsSent unsignedLong R

[StatsCounter64] The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium.

Active Notification requests for this parameter MAY be denied.

- 2.0
MgmtPacketsReceived unsignedLong R

[StatsCounter64] The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksSent unsignedLong R

[StatsCounter64] The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksReceived unsignedLong R

[StatsCounter64] The total number of LPDUs that were received by the node through a physical medium, with or without errors.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksResent unsignedInt R

[StatsCounter32] The total number of LPDUs that were retransmitted.

Active Notification requests for this parameter MAY be denied.

- 2.0
BlocksErrorsReceived unsignedInt R

[StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:

  • PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
  • PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
  • Retransmission rate = BlocksResent / BlocksSent.
  • Block error rate = BlocksErrorReceived / BlocksReceived.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.Ghn.Diagnostics.PerformanceMonitoring.Channels. object R Per-channel G.hn performance monitoring results. Note: channels are unidirectional. - 2.0
TimeStamp dateTime R Time at which channel data was last collected. - 2.0
ChannelNumberOfEntries unsignedInt R The number of entries in the Channel table. - 2.0
Device.Ghn.Diagnostics.PerformanceMonitoring.Channels.Channel.{i}. object(0:) R

Per-channel G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected from the channel between a G.hn interface (as indicated by DiagnoseMACAddress) and a G.hn interface indicated by DestinationMACAddress)

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

- 2.0
DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.0
SNR unsignedInt[] R Comma-separated list of unsigned integers. The result of an SNR test performed over the channel. It is formatted as a comma-separated list of N/M unsigned integers that represents the result of Signal-to-Noise-Ratio measurement averaging in groups of M subcarriers. The number N depends on the bandplan used by the node and corresponds to the OFDM control parameter N of each medium as defined in [G.9964]. The number M corresponds to the parameter SNRGroupLength. - 2.0
Device.MoCA.Interface.{i}. object(0:) R

MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1].

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

- 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [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
FirmwareVersion string(:64) R This interface’s firmware version. This parameter is based on mocaIfSoftwareVersion from [MOCA11-MIB]. - 2.0
MaxBitRate unsignedInt R The maximum MoCA PHY bit rate (expressed in Mbps). - 2.0
MaxIngressBW unsignedInt R The maximum bandwidth of this interface for flows onto the MoCA network in Mbps. This parameter is based on mocaIfMaxIngressNodeBw from [MOCA11-MIB]. - 2.0
MaxEgressBW unsignedInt R The maximum bandwidth of this interface for flows from the MoCA network in Mbps. This parameter is based on mocaIfMaxEgressNodeBw from [MOCA11-MIB]. - 2.0
HighestVersion string(:64) R

Identifies the highest MoCA version that this interface supports. This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • \d+(\.\d+)* This parameter is based on mocaIfMocaVersion from [MOCA11-MIB].
- 2.0
CurrentVersion string(:64) R

Identifies the MoCA version that the MoCA network is currently running. This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • \d+(\.\d+)* This parameter is based on mocaIfNetworkVersion from [MOCA11-MIB].
- 2.0
NetworkCoordinator unsignedInt R The Node ID of the current Network Coordinator (NC) for the MoCA network. This parameter is based on mocaIfNC from [MOCA11-MIB]. - 2.0
NodeID unsignedInt R The Node ID of this interface. This parameter is based on mocaIfNodeID from [MOCA11-MIB]. - 2.0
MaxNodes boolean R The maximum network node capability supported by the interface. If MaxNodes is true then the interface supports 16 nodes (the maximum for a MoCA 1.1 network). If MaxNodes is false then the interface supports 8 nodes (the maximum for a MoCA 1.0 network). - 2.0
PreferredNC boolean W Whether this interface is a preferred Network Coordinator (NC). This parameter is based on mocaIfPreferredNC from [MOCA11-MIB]. - 2.0
BackupNC unsignedInt R The Node ID of the backup Network Coordinator node. This parameter is based on mocaIfBackupNC from [MOCA11-MIB]. - 2.0
PrivacyEnabledSetting boolean W The configured privacy mode. This indicates whether link-layer security is enabled (true) or disabled (false) for network admission. The configured privacy setting MAY NOT match the current operational state (PrivacyEnabled), since this setting is only applied during network formation or admission. - 2.0
PrivacyEnabled boolean R Indicates whether link-layer security is enabled or disabled. This parameter is based on mocaIfPrivacyEnable from [MOCA11-MIB]. - 2.0
FreqCapabilityMask hexBinary(8) R Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. For example, an interface that supports 1150 MHz through 1500 MHz would have a value of 0x000000001FFFC000. This parameter is based on mocaIfCapabilityMask from [MOCA11-MIB]. - 2.0
FreqCurrentMaskSetting hexBinary(8) W The configured hexadecimal encoded 64-bit mask of enabled frequencies for network admission. The configured frequencies MAY NOT match the current operational state (FreqCurrentMask), since this setting is only applied during network formation or admission. - 2.0
FreqCurrentMask hexBinary(8) R Hexadecimal encoded 64-bit mask of used frequencies. This is the bit map of the spectrum that can be used and is a subset of the FreqCapabilityMask. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfChannelMask from [MOCA11-MIB]. - 2.0
CurrentOperFreq unsignedInt R Current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when Status is Up. This parameter is based on mocaIfRFChannel from [MOCA11-MIB]. - 2.0
LastOperFreq unsignedInt R Last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the Up state. This parameter is based on mocaIfLOF from [MOCA11-MIB]. - 2.0
KeyPassphrase string(12:17) W

MoCA Password. The value consists of numeric characters (0-9). Possible patterns:

  • \d+ This parameter is based on mocaIfPassword from [MOCA11-MIB].

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

- 2.0
TxPowerLimit unsignedInt W Transmit Power attenuation in dB relative to the maximum transmit power. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfTxPowerLimit from [MOCA11-MIB]. - 2.0
PowerCntlPhyTarget unsignedInt W Target PHY rate in Mbps for the power control algorithm. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfPowerControlTargetRate from [MOCA11-MIB]. - 2.0
BeaconPowerLimit unsignedInt W Beacon Transmit Power attenuation in dB relative to the maximum transmit power. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB]. - 2.0
NetworkTabooMask hexBinary(8) R Hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfTabooChannelMask from [MOCA11-MIB]. - 2.0
NodeTabooMask hexBinary(8) R Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfNodeTabooChannelMask from [MOCA11-MIB]. - 2.0
TxBcastRate unsignedInt R The broadcast PHY transmit rate in Mbps for this interface. This parameter is based on mocaIfTxGcdRate from [MOCA11-MIB]. - 2.0
TxBcastPowerReduction unsignedInt R Transmit Power attenuation in dB relative to the maximum transmit power for broadcast transmissions. This parameter is based on mocaIfTxGcdPowerReduction from [MOCA11-MIB]. - 2.0
QAM256Capable boolean R Whether this interface supports the 256 QAM feature. This parameter is based on mocaIfQAM256Capable from [MOCA11-MIB]. - 2.0
PacketAggregationCapability unsignedInt(0:10) R The packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). This parameter is based on mocaIfPacketsAggrCapability from [MOCA11-MIB]. - 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.0
Device.MoCA.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.MoCA.Interface.{i}.QoS. object R The QoS object provides information on MoCA parameterized QoS for this interface [MoCAv1.1]. - 2.0
EgressNumFlows unsignedInt R The number of QoS flows that this interface has from the MoCA network. This parameter is based on mocaIfEgressNodeNumFlows from [MOCA11-MIB]. - 2.0
IngressNumFlows unsignedInt R The number of QoS flows that this interface has onto the MoCA network. This parameter is based on mocaIfIngressNodeNumFlows from [MOCA11-MIB]. - 2.0
FlowStatsNumberOfEntries unsignedInt R The number of entries in the FlowStats table. - 2.0
Device.MoCA.Interface.{i}.QoS.FlowStats.{i}. object(0:) R

The flow statistics table provides information on the MoCA parameterized QoS flows this interface has allocated onto the MoCA network.

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

- 2.0
FlowID unsignedInt R The flow ID used to identify a flow in the network. This parameter is based on mocaIfFlowID from [MOCA11-MIB]. - 2.0
PacketDA string(:17) R [MACAddress] The Destination Address (DA) for the packets in this flow. This parameter is based on mocaIfPacketDA from [MOCA11-MIB]. - 2.0
MaxRate unsignedInt R Maximum required rate in Kbps. This parameter is based on mocaIfPeakDataRate from [MOCA11-MIB]. - 2.0
MaxBurstSize unsignedInt R Maximum burst size. This parameter is based on mocaIfBurstSize from [MOCA11-MIB]. - 2.0
LeaseTime unsignedInt R Flow lease time (expressed in seconds). A LeaseTime of 0 means unlimited lease time. This parameter is based on mocaIfLeaseTime from [MOCA11-MIB]. - 2.0
LeaseTimeLeft unsignedInt R

Flow lease time remaining (expressed in seconds). If LeaseTime is 0 then a LeaseTimeLeft of 0 means unlimited lease time; otherwise, a LeaseTimeLeft of 0 means expired. This parameter is based on mocaIfLeaseTimeLeft from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

- 2.0
FlowPackets unsignedInt R

The number of packets transmitted for this flow. This parameter is based on mocaIfTxPacketsFlow from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.MoCA.Interface.{i}.AssociatedDevice.{i}. object(0:) R

This table contains information about other MoCA devices currently associated with this MoCA interface.

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

- 2.0
MACAddress string(:17) R [MACAddress] The MAC address of the associated device’s MoCA interface. - 2.0
NodeID unsignedInt R The Node ID of this remote device. This parameter is based on mocaNodeIndex from [MOCA11-MIB]. - 2.0
PreferredNC boolean R Whether this remote device is a preferred Network Coordinator (NC). This parameter is based on mocaNodePreferredNC from [MOCA11-MIB]. - 2.0
HighestVersion string(:64) R

Identifies the highest MoCA version that this remote device supports. This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • \d+(\.\d+)* This parameter is based on mocaNodeMocaVersion from [MOCA11-MIB].
- 2.0
PHYTxRate unsignedInt R The PHY transmit rate (in Mbps) to this remote device. This parameter is based on mocaMeshTxRate from [MOCA11-MIB]. - 2.0
PHYRxRate unsignedInt R The PHY receive rate (in Mbps) from this remote device. - 2.0
TxPowerControlReduction unsignedInt R The reduction in transmitter level (in dB) due to power control. This parameter is based on mocaNodeTxPowerReduction from [MOCA11-MIB]. - 2.0
RxPowerLevel unsignedInt R

The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

- 2.0
TxBcastRate unsignedInt R The broadcast PHY transmit rate (in Mbps) from this remote device. This parameter is based on mocaNodeTxGcdRate from [MOCA11-MIB]. - 2.0
RxBcastPowerLevel unsignedInt R

The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxGcdPower from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

- 2.0
TxPackets unsignedInt R

The number of packets transmitted to this remote device (Note: Includes Broadcast, Multicast and Unicast packets).

Active Notification requests for this parameter MAY be denied.

- 2.0
RxPackets unsignedInt R

The number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets). This parameter is based on mocaNodeRxPackets from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

- 2.0
RxErroredAndMissedPackets unsignedInt R The number of errored and missed packets received from this remote device. This parameter is based on mocaNodeRxDrops from [MOCA11-MIB]. - 2.0
QAM256Capable boolean R Whether this remote device supports the 256 QAM feature. This parameter is based on mocaNodeQAM256Capable from [MOCA11-MIB]. - 2.0
PacketAggregationCapability unsignedInt(0:10) R The packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). This parameter is based on mocaNodePacketsAggrCapability from [MOCA11-MIB]. - 2.0
RxSNR unsignedInt R The signal to noise level (in dBm) received at this interface from this remote device. This parameter is based on mocaNodeSNR from [MOCA11-MIB]. - 2.0
Active boolean R Whether or not this remote device is currently present in the MoCA 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
Device.HomePlug. object R HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.HomePlug.Interface.{i}. object(0:) R

HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1].

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

- 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [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
LogicalNetwork string(:64) W The textual name of the HomePlug Logical Network. - 2.0
Version string(:16) R

Indicates the HomePlug version of the interface. This element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example:

“1.0”
“1.1”
- 2.0
FirmwareVersion string(:64) R The firmware version of the interface. - 2.0
ForceCCo boolean W

Central Coordinator (CCo) selection mode. If false, CCo selection is automatic. If true, the local HomePlug interface is forced to be CCo and all other devices in the Logical Network MUST be set to automatic CCo selection. Typically ForceCCo is set to automatic CCo selection (false).

The factory default value MUST be false.

- 2.0
NetworkPassword string(:32) W

The network password of the device. This is a human readable ASCII string that is hashed per the HomePlug specification to generate the Network Membership Key (NMK). Note that care needs to be taken when setting this parameter as it might prohibit communication with other adapters or equipment connected via the powerline network.

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

- 2.0
OtherNetworksPresent string[](:64) R

Comma-separated list (maximum number of characters 64) of strings. Indicates whether any other HomePlug networks are currently visible via this interface. Examples of valid list items include, but are not limited to:

“HomePlugAV”
“HomePlug1.0”
“Other”
- 2.0
MaxBitRate unsignedInt R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.0
Device.HomePlug.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MPDUTxAck unsignedLong R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Transmitted and Acknowledged. - 2.0
MPDUTxCol unsignedLong R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Transmitted and Collided - 2.0
MPDUTxFailed unsignedLong R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Transmitted and Failed - 2.0
MPDURxAck unsignedLong R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Received and Acknowledged - 2.0
MPDURxFailed unsignedLong R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Received and Failed - 2.0
Device.HomePlug.Interface.{i}.AssociatedDevice.{i}. object(0:) R

This table contains information about other HomePlug devices connected to this HomePlug interface.

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

- 2.0
MACAddress string(:17) R [MACAddress] MAC address of remote HomePlug device. It is used to uniquely identify and easily correlate with the connected remote HomePlug device. - 2.0
TxPhyRate unsignedInt R The PHY transmit Rate (expressed in Mbps) to this remote device. - 2.0
RxPhyRate unsignedInt R The PHY receive Rate (expressed in Mbps) from this remote device. - 2.0
SNRPerTone unsignedInt[:1155] R Comma-separated list (up to 1155 items) of unsigned integers. List items indicate Signal to Noise Ratio (SNR) per tone from this remote device (expressed in 0.1dB). - 2.0
AvgAttenuation unsignedInt R Average attenuation from this remote device (expressed in 0.1dB). - 2.0
EndStationMACs string(:17)[:16] R [MACAddress] Comma-separated list (up to 16 items) of MAC Addresses. List items represent MAC addresses of end stations bridged by the remote HomePlug device. For example: “11:22:33:AA:BB:CC, 22:33:44:DD:EE:66” - 2.0
Active boolean R Whether or not this device is currently present in the HomePlug 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
Device.UPA. object R Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
Device.UPA.Interface.{i}. object(0:) R

UPA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a UPA interface [UPA-PLC].

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

- 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string(:17) R [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
FirmwareVersion string(:64) R This interface’s firmware version. - 2.0
MaxBitRate unsignedInt R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
NodeType string W

Type of UPA device role. It can be Fixed Access Point (master) or End Point (slave) of the PLC network. Enumeration of:

  • AP
  • EP
- 2.0
LogicalNetwork string(:20) W The name (network ID) of the logical PLC network in which the local interface is a member (human readable string). - 2.0
EncryptionMethod string(:6) W

Encryption Method used by UPA device. Enumeration of:

  • None
  • DES
  • 3DES
  • AES128
  • AES256
- 2.0
EncryptionKey string(:36) W

Encryption key for secure PLC communications. This a human readable string used by the system to generate the encryption key to encrypt communications in powerline. It takes non extended ASCII characters (i.e. printable 7-bit ASCII character codes 32-126, which includes SPACE but excludes TAB, LF and CR). For example: bvjPekZiYUf9kjNKJASkgJ09adfoP01Fjvgd

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

- 2.0
PowerBackoffEnabled boolean W Power back-off management feature status in the UPA device. Boolean can be true for “enabled” and false for “disabled”. - 2.0
PowerBackoffMechanismActive boolean R Show if power back-off mechanism is active at that time in the UPA device. Boolean can be true for “active” and false for “not active”. - 2.0
EstApplicationThroughput unsignedInt R The estimated application throughput (expressed in Mbps), received from the PLC link. This value can be used to indicate link quality. - 2.0
ActiveNotchEnable boolean W Enables or disables the ActiveNotch table for this interface. - 2.0
ActiveNotchNumberOfEntries unsignedInt R The number of entries in the ActiveNotch table. - 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.0
BridgeForNumberOfEntries unsignedInt R The number of entries in the BridgeFor table. - 2.0
Device.UPA.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.UPA.Interface.{i}.AssociatedDevice.{i}. object(0:) R

This table contains information about PLC connections running between this UPA interface and other UPA devices.

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

- 2.0
MACAddress string(:17) R [MACAddress] Remote UPA device MAC address. - 2.0
Port unsignedInt(0:65535) R The PLC port number. - 2.0
LogicalNetwork string(:20) R The name of the logical PLC network (human readable string). In the case where the associated device belongs to a different powerline network than the UPA interface, the actual network identifier of the neighboring network is not shown in LogicalNetwork. Rather, only a generic string, e.g. “Network 1”, “Network 2”, etc is stored here due to security/privacy implications. - 2.0
PhyTxThroughput unsignedInt R Physical transmission throughput (in Mbps). - 2.0
PhyRxThroughput unsignedInt R Physical reception throughput (in Mbps). - 2.0
RealPhyRxThroughput unsignedInt R Real Physical reception throughput (in Mbps). - 2.0
EstimatedPLR unsignedInt(0:100) R Estimated PDU Loss Rate measurement between two devices (i.e. estimated percent of MPDUs that have been received with errors). - 2.0
MeanEstimatedAtt unsignedInt R Mean estimated attenuation (i.e. channel loss between the local interface and the remote device). It is measured in dB. - 2.0
SmartRouteIntermediatePLCMAC string(:17) R [MACAddress] Intermediate UPA adapter MAC address of the device that is acting as a relay to increase coverage in mesh scenarios. This is the MAC address of a third UPA device, with which the UPA interface is doing smart repeating in order to transmit data to the associated MACAddress UPA device. SmartRouteIntermediatePLCMAC will be empty when DirectRoute is true. - 2.0
DirectRoute boolean R Route status, where true indicates direct and false indicates indirect. - 2.0
Active boolean R Whether or not this node is currently present in the UPA 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
Device.UPA.Interface.{i}.ActiveNotch.{i}. object(0:) W

This object contains the list of active notches of the UPA interface. A UPA device can have notches in its spectrum, where no power is transmitted in a given part of the spectrum. These notches are typically located in amateur radio bands, to avoid interference. Note: All ActiveNotch entries can be enabled/disabled as a group using the ActiveNotchEnable parameter.

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

- 2.0
Enable boolean W Enables or disables the active notch entry. false 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
StartFreq unsignedInt W The initial frequency (in kHz) of a notch enabled in the spectrum of the local interface. - 2.0
StopFreq unsignedInt W The final frequency (in kHz) of a notch enabled in the spectrum of the local interface. - 2.0
Depth unsignedInt W The depth (in dB) of a notch enabled in the spectrum of the local interface. - 2.0
Device.UPA.Interface.{i}.BridgeFor.{i}. object(0:) R

This object represents the bridge table of the UPA interface. Each instance is a bridge table entry. It shows the MAC addresses of the remote UPA devices with their associated port number, and the MAC addresses of the end-devices (PCs, STBs, routers, etc) connected to Ethernet port of the powerline adapters with their associated logical port. In this way the system identifies to which UPA device an external device is connected to.

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

- 2.0
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MACAddress string(:17) R [MACAddress] MAC address of the device. - 2.0
Port unsignedInt(0:65535) R Internal bridge associated port. - 2.0
Device.UPA.Diagnostics. object R The UPA Diagnostics object. - 2.0
Device.UPA.Diagnostics.InterfaceMeasurement. object R This object provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The Type parameter is used to select which type of test to perform. CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network). - 2.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_InvalidPort (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.
- 2.0
Type string W

Indicates the type of port measurement test to be carried out. Enumeration of:

  • SNR (Signal-to-Noise-Ratio)
  • CFR (Channel Frequency Response) .
- 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the UPA.Interface. table. This is the local UPA interface from which the test is to be performed. - 2.0
Port unsignedInt(0:65535) W PLC port being measured. This identifies which PLC connection to measure between the local interface (indicated by Interface) and the remote device (implied by Port). - 2.0
Measurements unsignedInt[:1536] R Comma-separated list (up to 1536 items) of unsigned integers. Result of Signal-to-Noise-Ratio measurement (if Type is SNR) or Channel Frequency Response measurement (if Type is CFR). List items indicate measurements per carrier for a PLC port (expressed in 0.1dB). - 2.0
RxGain int R Reception gain of the adapter (expresssed in dB). - 2.0
Device.WiFi. object R The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
RadioNumberOfEntries unsignedInt R The number of entries in the Radio table. - 2.0
SSIDNumberOfEntries unsignedInt R The number of entries in the SSID table. - 2.0
AccessPointNumberOfEntries unsignedInt R The number of entries in the AccessPoint table. - 2.0
EndPointNumberOfEntries unsignedInt R The number of entries in the EndPoint table. - 2.0
Device.ZigBee. object R Top level object for ZigBee capabilities based on the [ZigBee2007] specification. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
ZDONumberOfEntries unsignedInt R The number of entries in the ZDO table. - 2.0
Device.ZigBee.Interface.{i}. object(0:) R

ZigBee interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the ZigBee interface of a ZigBee end device, ZigBee router or ZigBee coordinator.

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

- 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. - 2.0
IEEEAddress string(:23) R

[IEEE_EUI64] The IEEE address assigned to this interface. A value of “FF:FF:FF:FF:FF:FF:FF:FF” indicates that this address is unknown. This parameter has the same value as the ZigBee.ZDO.{i}.IEEEAddress parameter of the ZDO instance ZDOReference is pointing to.

Active Notification MUST by default be enabled for this parameter.

- 2.0
NetworkAddress string(:4) R [ZigBeeNetworkAddress] The ZigBee network address assigned to this interface. This parameter has the same value as the ZigBee.ZDO.{i}.NetworkAddress parameter of the ZDO instance ZDOReference is pointing to. - 2.0
ZDOReference string(:256) R The value MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The ZigBee Device Object assigned to this interface. - 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.0
Device.ZigBee.Interface.{i}.Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of ZigBee packets sent transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of ZigBee packets received by the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of ZigBee packets discarded by interface due to any error.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of ZigBee packets received that contained errors preventing them from being delivered to a higher-layer protocol.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedInt R

[StatsCounter32] The total number of ZigBee packets received which were not addressed to a multicast or broadcast address at this layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

[StatsCounter32] The total number of ZigBee packets requested for transmission which were chosen to be discarded even though no errors had been detected to prevent the ZigBee packets being transmitted.

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

[StatsCounter32] The total number of ZigBee packets received which were chosen to be discarded even though no errors had been detected to prevent their being delivered.

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedInt R

[StatsCounter32] The total number of ZigBee packets received which were addressed to a multicast address at this layer and delivered by this layer to a higher layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedInt R

[StatsCounter32] The total number of ZigBee packets received which were addressed to a broadcast address at this layer and delivered by this layer to a higher layer.

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownPacketsReceived unsignedInt R

[StatsCounter32] The total number of ZigBee packets received which were discarded because of an unknown or unsupported protocol.

Active Notification requests for this parameter MAY be denied.

- 2.0
Device.ZigBee.Interface.{i}.AssociatedDevice.{i}. object(0:) R This table provides information about other ZigBee devices that are directly accessible via this interface. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is “FF:FF:FF:FF:FF:FF:FF:FF” and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more AssociatedDevice instances have the same key value the implemenation is undefined. - 2.0
IEEEAddress string(:23) R [IEEE_EUI64] The IEEE address assigned to this device. A value of “FF:FF:FF:FF:FF:FF:FF:FF” indicates that this address is unknown. - 2.0
NetworkAddress string(:4) R [ZigBeeNetworkAddress] The ZigBee network address assigned to this device. - 2.0
Active boolean R Whether or not this device is currently present in the ZigBee network as defined in [Section 2.4.4.1/ZigBee2007]. The ability to list inactive devices is OPTIONAL. If the CPE includes inactive devices in this table, Active MUST be set to false for each inactive device. The length of time an inactive device remains listed in this table is a local matter to the CPE. - 2.0
ZDOReference string(:256) R The value MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The ZigBee Device Object assigned to this interface. - 2.0
Device.ZigBee.ZDO.{i}. object(0:) R ZigBee Device Object (ZDO) provides management capabilities of the ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee Device as defined in [Section 2.5/ZigBee2007]. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is “FF:FF:FF:FF:FF:FF:FF:FF” and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more ZDO instances have the same key value the implemenation is undefined - 2.0
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
IEEEAddress string(:23) R [IEEE_EUI64] The IEEE address assigned to this device. A value of “FF:FF:FF:FF:FF:FF:FF:FF” indicates that this address is unknown. - 2.0
NetworkAddress string(:4) R [ZigBeeNetworkAddress] The ZigBee network address assigned to this device. - 2.0
BindingTableNumberOfEntries unsignedInt R The number of entries in the Binding table. - 2.0
GroupNumberOfEntries unsignedInt R The number of entries in the Group table. - 2.0
ApplicationEndpointNumberOfEntries unsignedInt R The number of entries in the ApplicationEndpoint table. - 2.0
Device.ZigBee.ZDO.{i}.NodeDescriptor. object R The NodeDescriptor object describes the node capabilities of the ZigBee device as defined in [Section 2.3.2.3 Node Descriptor/ZigBee2007]. - 2.0
LogicalType string R

The type of ZigBee device that is extracted from the Logical Type Field as defined in [Table 2.29/ZigBee2007]. Enumeration of:

  • ZC (ZigBee Coordinator)
  • ZR (ZigBee Router)
  • ZED (ZigBee End Device)
- 2.0
ComplexDescriptorSupported boolean R When true, specifies that the ComplexDescriptor object is supported for this ZigBee device. - 2.0
UserDescriptorSupported boolean R When true, specifies that the UserDescriptor object is supported for this ZigBee device. - 2.0
FrequencyBand string[] R

Specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio utilized by the ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:

  • 868-868.6 (The 868-868.6 MHz Band)
  • 902-928 (The 902-928 MHz Band)
  • 2400-2483.5 (The 2400-2483.5 MHz Band)
- 2.0
MACCapability string[] R

Specifies the IEEE 802.15.4-2003 MAC sub-layer capabilities for this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:

  • AlternatePANCoordinator (Alternate PAN Coordinator)
  • FFD (Full Function Device)
  • MainsPowerSource (The current power source is mains power)
  • OnWhenIdle (The receiver is on when idle)
  • SecureCommunication (Secure communication is enabled)
- 2.0
ManufactureCode unsignedInt(:65535) R Specifies a manufacturer code that is allocated by the ZigBee Alliance, relating the manufacturer to the device. - 2.0
MaximumBufferSize unsignedInt(:128) R Specifies the maximum buffer size, in octets, of the network sub-layer data unit (NSDU) for this ZigBee device. - 2.0
MaximumIncomingTransferSize unsignedInt(:32768) R Specifies the maximum size, in octets, of the application sub-layer data unit (ASDU) that can be transferred to this ZigBee device in one single message transfer. - 2.0
MaximumOutgoingTransferSize unsignedInt(:32768) R Specifies the maximum size, in octets, of the application sub-layer data unit (ASDU) that can be transferred from this ZigBee device in one single message transfer. - 2.0
ServerMask string[] R

Specifies the system server capabilities of this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:

  • PrimaryTrustCenter
  • PrimaryBindingTableCache
  • BackupBindingTableCache
  • PrimaryDiscoveryCache
  • BackupDiscoveryCache
  • NetworkManager
- 2.0
DescriptorCapability string[] R

Specifies the descriptor capabilities of this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:

  • ExtendedActiveEndpointListAvailable
  • ExtendedSimpleDescriptorListAvailable
- 2.0
Device.ZigBee.ZDO.{i}.PowerDescriptor. object R The PowerDescriptor object describes the power capabilities of the ZigBee device as defined in [Section 2.3.2.4 Node Power Descriptor/ZigBee2007]. - 2.0
CurrentPowerMode string R

Specifies the current sleep/power-saving mode of the ZigBee device. Enumeration of:

  • Synchronized
  • Periodic
  • Manual
- 2.0
AvailablePowerSource string[] R

Specifies the power sources available on this ZigBee device. Comma-separated list of strings. Each list item is an enumeration of:

  • Constant (Constant (mains) power)
  • Rechargeable (Rechargable battery)
  • Disposable (Disposable battery)
- 2.0
CurrentPowerSource string R

The current power source field specifies the current power source being utilized by the node. Enumeration of:

  • Constant (Constant (mains) power)
  • Rechargeable (Rechargable battery)
  • Disposable (Disposable battery)
- 2.0
CurrentPowerSourceLevel string R

Specifies the level of charge of the current power source. Enumeration of:

  • Critical (Critical battery state)
  • 33 (Battery state is 33 percent)
  • 66 (Battery state is 66 percent)
  • 100 (Battery state is 100 percent)
- 2.0
Device.ZigBee.ZDO.{i}.UserDescriptor. object R The UserDescriptor object is an optional descriptor that describes user defined capabilities of the ZigBee device as defined in [Section 2.3.2.7 User Descriptor/ZigBee2007]. The UserDescriptor object contains information that allows the user to identify the device using a user-friendly character string, such as “Bedroom TV” or “Stairs Light”. - 2.0
DescriptorAvailable boolean R When true, the User Descriptor recorded has been received from the target device. - 2.0
Description string(:16) R Specifies the information that allows the user to identify the ZigBee device using a user-friendly character string, such as “Bedroom TV” or “Stairs light”. - 2.0
Device.ZigBee.ZDO.{i}.ComplexDescriptor. object R The ComplexDescriptor object is an optional descriptor that describes extended capabilities of the ZigBee device as defined in [Section 2.3.2.6 Complex Descriptor/ZigBee2007]. - 2.0
DescriptorAvailable boolean R When true, the Complex Descriptor recorded has been received from the target device. - 2.0
Language string R Specifies the ISO 639-1 language code as defined in [ISO639-1]. - 2.0
CharacterSet string R Specifies the ISO 646 character set as defined in [ISO646-1991]. - 2.0
ManufacturerName string R Specifies the name of the manufacturer of the ZigBee device. - 2.0
ModelName string R Specifies the name of the manufacturer’s model of the ZigBee device. - 2.0
SerialNumber string R Specifies the manufacturer’s serial number of the ZigBee device. - 2.0
DeviceURL string R Specifies the URL through which more information relating to the ZigBee device can be obtained. - 2.0
Icon hexBinary(:65535) R The icon field contains an octet string which carries the data for an icon that can represent the ZigBee device. The format of the icon MUST be a 32-by-32-pixel PNG image. - 2.0
IconURL string R Specifies the URL through which the icon for the ZigBee device can be obtained. - 2.0
Device.ZigBee.ZDO.{i}.Security. object R The Security object provides the configuration capabilities needed to perform the Security Management functionality defined in [Section 4 Security Management/ZigBee2007]. - 2.0
TrustCenterAddress string(:23) R [IEEE_EUI64] Specifies the IEEE address of a special device trusted by devices within a ZigBee network to distribute keys for the purpose of network and end-to-end application configuration management. - 2.0
SecurityLevel string R

Specifies how an outgoing frame is to be secured, how an incoming frame purportedly has been secured; it also indicates whether or not the payload is encrypted and to what extent data authenticity over the frame is provided, as reflected by the length of the message integrity code (MIC). Enumeration of:

  • None
  • MIC-32
  • MIC-64
  • MIC-128
  • ENC
  • ENC-MIC-32
  • ENC-MIC-64
  • ENC-MIC-128
- 2.0
TimeOutPeriod unsignedInt(:65535) R The period of time, in milliseconds, that this ZigBee device will wait for an expected security protocol frame. - 2.0
Device.ZigBee.ZDO.{i}.Network. object R The Network object provides the configuration capabilities needed to by a ZigBee Device to operate within a ZigBee Area Network as defined in [Section 2.5.2.4 Network Manager/ZigBee2007]. - 2.0
NeighborNumberOfEntries unsignedInt R The number of entries in the Neighbor table. - 2.0
Device.ZigBee.ZDO.{i}.Network.Neighbor.{i}. object(0:) R

The Neighbor object provides the configuration capabilities needed to by a ZigBee Device to operate within a ZigBee Area Network as defined in [Section 2.5.2.4 Network Manager/ZigBee2007].

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

- 2.0
Neighbor string R The value MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Neighbor of this ZigBee device. The value MUST be the path name of a row in the ZigBee.ZDO table. If the referenced row is deleted then this entry MUST be deleted. - 2.0
LQI unsignedInt(:255) R

The LQI field specified link quality identification (LQI) for neighbor ZigBee device.

Active Notification requests for this parameter MAY be denied.

- 2.0
Relationship string R

The relationship between the neighbor and this device. Enumeration of:

  • Parent
  • Child
  • PrevChild
  • Sibling
  • None
- 2.0
PermitJoin string R

An indication of whether the neighbor device is accepting join requests. Enumeration of:

  • Accepting
  • NotAccepting
  • Unknown
- 2.0
Depth unsignedInt R The tree depth of the neighbor device. A value of 0x00 indicates that the device is the ZigBee coordinator for the network. - 2.0
Device.ZigBee.ZDO.{i}.NodeManager. object R The NodeManager object describes the configuration capabilities related for remote management of the ZigBee Area Network as defined in [Section 2.5.2.6 Node Manager/ZigBee2007]. - 2.0
RoutingTableNumberOfEntries unsignedInt R The number of entries in the RoutingTable table. - 2.0
Device.ZigBee.ZDO.{i}.NodeManager.RoutingTable.{i}. object(0:) R

The RoutingTable object describes the route table as defined in [Table 3.51 Routing Table Entry/ZigBee2007].

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

- 2.0
DestinationAddress string(:4) R

The ZigBee network address of this route.

Possible patterns:

  • ([0-9A-Fa-f]){4}
- 2.0
NextHopAddress string(:4) R

[ZigBeeNetworkAddress] Specifies the network address of the next hop ZigBee device on the way to the destination ZigBee device.

Active Notification requests for this parameter MAY be denied.

- 2.0
Status string R

The status of the route entry. Enumeration of:

  • Active
  • DiscoveryUnderway
  • DiscoveryFailed
  • Inactive
  • ValidationUnderway

Active Notification requests for this parameter MAY be denied.

- 2.0
MemoryConstrained boolean R A flag indicating whether the device is a memory constrained concentrator. - 2.0
ManyToOne boolean R A flag indicating that the destination is a concentrator that issued a many to-one request. - 2.0
RouteRecordRequired boolean R A flag indicating that a route record command frame should be sent to the destination prior to the next data packet. - 2.0
Device.ZigBee.ZDO.{i}.Binding.{i}. object(0:) W

The Binding object describes the configuration capabilities related to maintaining a ZigBee Device’s Binding Table as defined in [Section 2.2.8.2 Binding/ZigBee2007].

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

- 2.0
Enable boolean W Enables or disables the use of this binding on the device. - 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SourceEndpoint unsignedInt(:240) W Specifies the source endpoint used in this binding entry. - 2.0
SourceAddress string(:23) W [IEEE_EUI64] Specifies the source address used in this binding entry. - 2.0
ClusterId unsignedInt(:65535) W Specifies the cluster identifier used in this binding entry. - 2.0
DestinationAddressMode string W

Specifies the type of destination address used for this binding entry. Enumeration of:

  • Group
  • Endpoint
- 2.0
DestinationEndpoint unsignedInt(:240) W Specifies the destination endpoint for the binding entry. The value of this field is valid when the value of the DestinationAddressMode is Endpoint. - 2.0
IEEEDestinationAddress string(:23) W [IEEE_EUI64] Specifies the IEEE destination address for this binding entry. The value of this field is valid when the value of the DestinationAddressMode is Endpoint. - 2.0
GroupDestinationAddress string(:4) W [ZigBeeNetworkAddress] Specifies the group destination address for this binding entry. The value of this field is valid when the value of the DestinationAddressMode is Group. - 2.0
Device.ZigBee.ZDO.{i}.Group.{i}. object(0:) W

The Group object describes the configuration capabilities related to maintaining a ZigBee Device’s Group Table as defined in [Section 2.5.2.7 Group Manager/ZigBee2007].

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

- 2.0
Enable boolean W Enables or disables the use of this group on the device. - 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
GroupId string(:4) W [ZigBeeNetworkAddress] The Group Identifier for this object as defined in [Table 2.25 Group Table Entry Format/ZigBee2007]. - 2.0
EndpointList string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the ZigBee.ZDO.{i}.ApplicationEndpoint. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The list of application endpoints assigned as a member of this Group object. - 2.0
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}. object(0:) W

The ApplicationEndpoint object describes the application endpoint as defined in [Section 2.1.2 Application Framework/ZigBee2007].

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

- 2.0
Enable boolean W Enables or disables the use of this application endpoint on the device. - 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
EndpointId unsignedInt(:240) W The Endpoint Identifier for this object as defined in [Section 2.1.2 Application Framework/ZigBee2007]. An ApplicationEndpoint with an EndpointId value of 0 is designated as the device application: This is a special application that is responsible for device operation and contains logic to manage the device’s networking and general maintenance features. - 2.0
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}.SimpleDescriptor. object R The SimpleDescriptor object contains the attributes of the Simple Descriptor of an application endpoint, as defined in [Section 2.3.2.5 Simple Descriptor/ZigBee2007]. - 2.0
ProfileId unsignedInt(:65535) W Specifies the application profile that is supported on this endpoint. Application profiles are agreements for messages, message formats, andprocessing actions that enable developers to create an interoperable, distributed application employing application entities that reside on separate ZigBee devices. These application profiles enable applications to send commands, request data, and process commands and requests as defined in [Section 2.1.2.1 Application Profiles/ZigBee2007]. - 2.0
DeviceId unsignedInt(:65535) R Application device identifier, as defined in [Section 2.3.2.5.3 Application Device Identifier Field/ZigBee2007]. - 2.0
DeviceVersion unsignedInt(:15) R Application device version, as defined in [Section 2.3.2.5.4 Application Device Version Field/ZigBee2007]. - 2.0
InputClusterList unsignedInt(:65535)[] W Comma-separated list of unsigned integers (up to 65535). Specifies the input cluster identifiers to be matched by the ZigBee coordinator by remote Zigbee device’s output cluster list for this SimpleDescriptor object. - 2.0
OutputClusterList unsignedInt(:65535)[] W Comma-separated list of unsigned integers (up to 65535). Specifies the output cluster identifiers to be matched by the ZigBee coordinator by remote Zigbee device’s input cluster list for this SimpleDescriptor object. - 2.0
Device.ZigBee.Discovery. object R This object is used for managing the discovery of ZigBee devices within a ZigBee Area Network. ZigBee Devices are discovered via the ZDO instance associated with the ZigBee Coordinator of an Area Network. - 2.0
AreaNetworkNumberOfEntries unsignedInt R The number of entries in the AreaNetwork table. - 2.0
Device.ZigBee.Discovery.AreaNetwork.{i}. object(0:) W

This object specifies the ZigBee devices that are discovered by the Coordinator. As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the AreaNetwork object is provisioned and not discovered.

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

- 2.0
Enable boolean W Enables or disables discovery of the ZigBee devices in this AreaNetwork. - 2.0
LastUpdate dateTime R The date and time when this AreaNetwork or its member devices (i.e., the devices with ZDOs listed in ZDOList) were updated due to a discovery operation. - 2.0
Status string R

The status of the current discovery operation. Enumeration of:

  • Indeterminate (The discovery operation has not been executed and there are no valid discovery results available))
  • InProgress
  • Success
  • Error
  • Error_Timeout (OPTIONAL)
- 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Coordinator string(:256) W The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee Coordinator. The coordinator MAY be located within the CPE. In this scenario the ACS or CPE MAY use the value of “localhost”. - 2.0
ZDOReference string(:256) R The ZDO object for this device that is used to discover the ZigBee capabilities of attached devices. The value MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
ZDOList string(:256)[] R Comma-separated list of strings (maximum number of characters per item 256). The list of ZDO objects discovered in this Area Network by the ZigBee Coordinator. Each list item MUST be the Path Name of a row in the ZigBee.ZDO. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.0
Device.WiFi.Radio.{i}. object(0:) R

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

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

- 2.0
Enable boolean W Enables or disables the radio. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Radio is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MaxBitRate unsignedInt R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
SupportedFrequencyBands string[] R

Comma-separated list of strings. List items indicate the frequency bands at which the radio can operate.

Each list item is an enumeration of:

  • 2.4GHz
  • 5GHz
- 2.0
OperatingFrequencyBand string W The value MUST be a member of the list reported by the SupportedFrequencyBands parameter. Indicates the frequency band at which the radio is operating. If the radio supports multiple bands, and OperatingFrequencyBand is changed, then all parameters whose value is not valid for the new frequency band (e.g. Channel) MUST be set to a valid value (according to some CPE vendor-specific behavior). - 2.0
SupportedStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Radio instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

- 2.0
OperatingStandards string[] W Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed. For example, a value of “g,b” (or “b,g” - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of “g” means that only the 802.11g standard can be used. - 2.0
PossibleChannels string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n) and the regulatory domain. Ranges in the form “n-m” are permitted. For example, for 802.11b and North America, would be “1-11”. - 2.0
ChannelsInUse string[](:1024) R

Comma-separated list (maximum number of characters 1024) of strings. List items represent channels that the radio determines to be currently in use (including any that it is using itself). Ranges in the form “n-m” are permitted.

Active Notification requests for this parameter MAY be denied.

- 2.0
Channel unsignedInt(1:255) W The current radio channel used by the connection. To request automatic channel selection, set AutoChannelEnable to true. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. Note: Valid Channel values depend on the OperatingFrequencyBand and RegulatoryDomain values specified. - 2.0
AutoChannelSupported boolean R Indicates whether automatic channel selection is supported by this radio. If false, then AutoChannelEnable MUST be false. - 2.0
AutoChannelEnable boolean W Enable or disable automatic channel selection. Set to false to disable the automatic channel selection procedure, in which case the currently selected channel remains selected. Set to true to enable the automatic channel selection procedure. This procedure MUST automatically select the channel, and MAY also change it subsequently. AutoChannelEnable MUST automatically change to false whenever the channel is manually selected, i.e. whenever the Channel parameter is written. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. - 2.0
AutoChannelRefreshPeriod unsignedInt W The time period in seconds between two consecutive automatic channel selections. A value of 0 means that the automatic channel selection is done only at boot time. This parameter is significant only if AutoChannelEnable is set to true. - 2.0
OperatingChannelBandwidth string W

The channel bandwidth (applicable to 802.11n and 802.11ac specifications only).

Enumeration of:

  • 20MHz
  • 40MHz (wide mode)
  • 80MHz (802.11ac only)
  • 160MHz (802.11ac only)
  • Auto
- 2.0
ExtensionChannel string W

The secondary extension channel position, applicable when operating in wide channel mode (i.e. when OperatingChannelBandwidth is set to 40MHz or Auto).

Enumeration of:

  • AboveControlChannel
  • BelowControlChannel
  • Auto
- 2.0
GuardInterval string W

The guard interval value between OFDM symbols (applicable to 802.11n and 802.11ac specifications only).

Enumeration of:

  • 400nsec
  • 800nsec
  • Auto
- 2.0
MCS int(-1:15,16:31) W The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ([802.11n-2009]). Values from 0 to 9 MUST be supported for [802.11ac-2013]. A value of -1 indicates automatic selection of the MCS index. - 2.0
TransmitPowerSupported int(-1:100)[](:64) R Comma-separated list (maximum number of characters 64) of integers (-1 to 100). List items represent supported transmit power levels as percentage of full power. For example, “0,25,50,75,100”. A -1 item indicates auto mode (automatic decision by CPE). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE. - 2.0
TransmitPower int(-1:100) W Indicates the current transmit power level as a percentage of full power. The value MUST be one of the values reported by the TransmitPowerSupported parameter. A value of -1 indicates auto mode (automatic decision by CPE). - 2.0
IEEE80211hSupported boolean R Indicates whether IEEE 802.11h [802.11h-2003] functionality is supported by this radio. The value can be true only if the 802.11a or the 802.11n@5GHz standard is supported (i.e. SupportedFrequencyBands includes 5GHz and SupportedStandards includes a and/or n). - 2.0
IEEE80211hEnabled boolean W Indicates whether IEEE 802.11h functionality is enabled on this radio. The value can be true only if the 802.11a or the 802.11n@5GHz standard is supported and enabled (i.e. OperatingFrequencyBand is 5GHz and OperatingStandards includes a and/or n). - 2.0
RegulatoryDomain string(3) W

The 802.11d Regulatory Domain. First two octets are [ISO3166-1] two-character country code. The third octet is either “ “ (all environments), “O” (outside) or “I” (inside).

Possible patterns:

  • [A-Z][A-Z][ OI]
- 2.0
RetryLimit unsignedInt(0:7) W The maximum number of retransmissions of a short packet i.e. a packet that is no longer than the RTSThreshold. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit [802.11-2012]. - 2.0
CCARequest hexBinary(11) W A request for the clear channel assessment (CCA) report in the format specified in [Clause 8.4.2.23.3/802.11-2012]. - 2.0
CCAReport hexBinary(12) R The clear channel assessment (CCA) report in the format specified in [Clause 8.4.2.24.3/802.11-2012]. When read, the value of this parameter MUST correspond to CCARequest. How this is achieved is a local matter to the CPE. If this parameter is read before a CCARequest has been issued, then its value is an empty string. - 2.0
RPIHistogramRequest hexBinary(11) W A request for a received power indicator (RPI) histogram in the format specified in [Clause 8.4.2.23.4/802.11-2012]. - 2.0
RPIHistogramReport hexBinary(19) R Received power indicator (RPI) histogram report in the format specified in [Clause 8.4.2.24.4/802.11-2012]. - 2.0
FragmentationThreshold unsignedInt W This specifies the current maximum size, in octets, of the MPDU that can be delivered to the PHY. This parameter is based on dot11FragmentationThreshold from [802.11-2012]. - 2.0
RTSThreshold unsignedInt W This indicates the number of octets in an MPDU, below which an RTS/CTS handshake is not performed. This parameter is based on dot11RTSThreshold from [802.11-2012]. - 2.0
LongRetryLimit unsignedInt W This indicates the maximum number of transmission attempts of a frame, the length of which is greater than RTSThreshold, that will be made before a failure condition is indicated. This parameter is based on dot11LongRetryLimit from [802.11-2012]. - 2.0
BeaconPeriod unsignedInt W Time interval between transmitting beacons (expressed in milliseconds). This parameter is based on dot11BeaconPeriod from [802.11-2012]. - 2.0
DTIMPeriod unsignedInt W This specifies the number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM Count field is 0. This parameter is based on dot11DTIMPeriod from [802.11-2012]. - 2.0
PacketAggregationEnable boolean W This determines whether or not packet aggregation (commonly called “frame aggregation”) is enabled. This applies only to 802.11n. - 2.0
PreambleType string W

The type of preamble. Longer preambles (more overhead) are needed by 802.11g to coexist with legacy systems 802.11 and 802.11b.

Enumeration of:

  • short
  • long
  • auto
- 2.0
BasicDataTransmitRates string[] W Comma-separated list of strings. The set of data rates, in Mbps, that have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed in BasicDataTransmitRates. For example, a value of “1,2”, indicates that stations support 1 Mbps and 2 Mbps. Most control packets use a data rate in BasicDataTransmitRates. - 2.0
OperationalDataTransmitRates string[] W Comma-separated list of strings. Maximum access point data transmit rates in Mbps for unicast frames (a superset of BasicDataTransmitRates). Given the value of BasicDataTransmitRates from the example above, OperationalDataTransmitRates might be “1,2,5.5,11”, indicating that unicast frames can additionally be transmitted at 5.5 Mbps and 11 Mbps. - 2.0
SupportedDataTransmitRates string[] R Comma-separated list of strings. Data transmit rates in Mbps for unicast frames at which the access point will permit a station to connect (a subset of OperationalDataTransmitRates). Given the values of BasicDataTransmitRates and OperationalDataTransmitRates from the examples above, SupportedDataTransmitRates might be “1,2,5.5”, indicating that the AP will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps, even though it could theoretically accept connections at 11 Mbps. - 2.0
Device.WiFi.Radio.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2a5] for further details. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2a5]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PLCPErrorCount unsignedInt R The number of packets that were received with a detected Physical Layer Convergence Protocol (PLCP) header error. - 2.0
FCSErrorCount unsignedInt R The number of packets that were received with a detected FCS error. This parameter is based on dot11FCSErrorCount from [Annex C/802.11-2012]. - 2.0
InvalidMACCount unsignedInt R The number of packets that were received with a detected invalid MAC header error. - 2.0
PacketsOtherReceived unsignedInt R The number of packets that were received, but which were destined for a MAC address that is not associated with this interface. - 2.0
Noise int R An indicator of average noise strength received at this radio, measured in dBm. This measurement of non-IEEE 802.11 noise power is made by sampling the channel when virtual carrier sense indicates idle and this radio is neither transmitting nor receiving a frame. - 2.0
Device.WiFi.SSID.{i}. object(0:) W

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

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

- 2.0
Enable boolean W Enables or disables the SSID entry. This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
Name string(:64) R

The textual name of the SSID entry as assigned by the CPE.

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

- 2.0
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. <Empty> 2.0
BSSID string(:17) R [MACAddress] The Basic Service Set ID. This is the MAC address of the access point, which can either be local (when this instance models an access point SSID) or remote (when this instance models an end point SSID). - 2.0
MACAddress string(:17) R [MACAddress] The MAC address of this interface. If this instance models an access point SSID, MACAddress is the same as MACAddress. 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
SSID string(:32) W The current service set identifier in use by the connection. The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as an ID for joining a particular radio network (BSS). - 2.0
Device.WiFi.SSID.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2a5] for further details. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2a5]. - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsSent unsignedInt R

The total number of outbound packets that could not be transmitted because of errors. These can be due to the number of retransmissions exceeding the retry limit, or from other causes.

Active Notification requests for this parameter MAY be denied.

- 2.0
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
DiscardPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
UnknownProtoPacketsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

- 2.0
RetransCount unsignedInt R The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.0
FailedRetransCount unsignedInt R The number of packets that were not transmitted successfully due to the number of retransmission attempts exceeding an 802.11 retry limit. This parameter is based on dot11FailedCount from [802.11-2012]. - 2.0
RetryCount unsignedInt R The number of packets that were successfully transmitted after one or more retransmissions. This parameter is based on dot11RetryCount from [802.11-2012]. - 2.0
MultipleRetryCount unsignedInt R The number of packets that were successfully transmitted after more than one retransmission. This parameter is based on dot11MultipleRetryCount from [802.11-2012]. - 2.0
ACKFailureCount unsignedInt R The number of expected ACKs that were never received. This parameter is based on dot11ACKFailureCount from [802.11-2012]. - 2.0
AggregatedPacketCount unsignedInt R The number of aggregated packets that were transmitted. This applies only to 802.11n and 802.11ac. - 2.0
Device.WiFi.AccessPoint.{i}. object(0:) W

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

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

- 2.0
Enable boolean W Enables or disables this access point. false 2.0
Status string R

Indicates the status of this access point. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SSIDReference string(:256) W The value MUST be the Path Name of a row in the SSID. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.0
SSIDAdvertisementEnabled boolean W Indicates whether or not beacons include the SSID name. - 2.0
RetryLimit unsignedInt(0:7) W

The maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.

This parameter is DEPRECATED because it is really a Radio attribute. Use Radio.{i}.RetryLimit.

- 2.0
WMMCapability boolean R Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC). - 2.0
UAPSDCapability boolean R Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies WMM support. - 2.0
WMMEnable boolean W Whether WMM support is currently enabled. When enabled, this is indicated in beacon frames. - 2.0
UAPSDEnable boolean W Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. Note: U-APSD can only be enabled if WMM is also enabled. - 2.0
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.0
MaxAssociatedDevices unsignedInt W The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. 0 2.0
IsolationEnable boolean W Enables or disables device isolation. A value of true means that the devices connected to the Access Point are isolated from all other devices within the home network (as is typically the case for a Wireless Hotspot). - 2.0
Device.WiFi.AccessPoint.{i}.Security. object R This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. - 2.0
Reset boolean W When set to true, this AccessPoint instance’s WiFi security settings are reset to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey and KeyPassphrase. If the parameter cannot be set, the CPE MUST reject the request as an invalid parameter value. Possible failure reasons include a lack of default values or if ModeEnabled is an Enterprise type, i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise. - 2.0
ModesSupported string[] R

Comma-separated list of strings. Indicates which security modes this AccessPoint instance is capable of supporting.

Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
- 2.0
ModeEnabled string W The value MUST be a member of the list reported by the ModesSupported parameter. Indicates which security mode is enabled. - 2.0
WEPKey hexBinary(5,13) W

A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

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

- 2.0
PreSharedKey hexBinary(:32) W

A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined).

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

- 2.0
KeyPassphrase string(8:63) W

A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 ([RFC2898]).

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

- 2.0
RekeyingInterval unsignedInt W The interval (expressed in seconds) in which the keys are re-generated. This is applicable to WPA, WPA2 and Mixed (WPA-WPA2) modes in Personal or Enterprise mode (i.e. when ModeEnabled is set to a value other than None or WEP-64 or WEP-128. 3600 2.0
RadiusServerIPAddr string(:45) W [IPAddress] The IP Address of the RADIUS server used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). - 2.0
SecondaryRadiusServerIPAddr string(:45) W [IPAddress] The IP Address of a secondary RADIUS server used for WLAN security. *SecondaryRadiusServerIPAddr * is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion [RFC2865]. - 2.0
RadiusServerPort unsignedInt W The port number of the RADIUS server used for WLAN security. RadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). 1812 2.0
SecondaryRadiusServerPort unsignedInt W The port number of the secondary RADIUS server used for WLAN security. SecondaryRadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server. 1812 2.0
RadiusSecret string W

The secret used for handshaking with the RADIUS server [RFC2865].

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

- 2.0
SecondaryRadiusSecret string W

The secret used for handshaking with the secondary RADIUS server [RFC2865]. If this parameter is not implemented, the secondary RADIUS server will use the same secret as the primary RADIUS server.

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

- 2.0
Device.WiFi.AccessPoint.{i}.WPS. object R This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this access point. - 2.0
Enable boolean W Enables or disables WPS functionality for this access point. true 2.0
ConfigMethodsSupported string[] R

Comma-separated list of strings. Indicates WPS configuration methods supported by the device. Each list item is an enumeration of:

  • USBFlashDrive
  • Ethernet
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN This parameter corresponds directly to the “Config Methods” attribute of the WPS specification [WPSv1.0]. The PushButton and PIN methods MUST be supported.
- 2.0
ConfigMethodsEnabled string[] W Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. Comma-separated list of strings. Indicates WPS configuration methods enabled on the device. - 2.0
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object(0:) R

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

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

- 2.0
MACAddress string(:17) R

[MACAddress] The MAC address of an associated device.

Active Notification requests for this parameter MAY be denied.

- 2.0
AuthenticationState boolean R

Whether an associated device has authenticated (true) or not (false).

Active Notification requests for this parameter MAY be denied.

- 2.0
LastDataDownlinkRate unsignedInt(1000:600000) R

The data transmit rate in kbps that was most recently used for transmission from the access point to the associated device.

Active Notification requests for this parameter MAY be denied.

- 2.0
LastDataUplinkRate unsignedInt(1000:600000) R

The data transmit rate in kbps that was most recently used for transmission from the associated device to the access point.

Active Notification requests for this parameter MAY be denied.

- 2.0
SignalStrength int(-200:0) R An indicator of radio signal strength of the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device. - 2.0
Retransmissions unsignedInt(0:100) R The number of packets that had to be re-transmitted, from the last 100 packets sent to the associated device. Multiple re-transmissions of the same packet count as one. - 2.0
Active boolean R Whether or not this node is currently present in the WiFi AccessPoint 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
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats. object R These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames. The CPE MUST reset these Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Status of the parent AccessPoint object transitions from Disabled to Enabled, or when it transitions from Enabled to Disabled. - 2.0
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the Associated Device, including framing characters. - 2.0
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the Associated Device, including framing characters. - 2.0
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.0
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received from the Associated Device. - 2.0
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.0
RetransCount unsignedInt R [StatsCounter32] The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.0
FailedRetransCount unsignedInt R [StatsCounter32] The number of packets that were not transmitted successfully due to the number of retransmission attempts exceeding an 802.11 retry limit. This parameter is based on dot11FailedCount from [802.11-2012]. - 2.0
RetryCount unsignedInt R [StatsCounter32] The number of packets that were successfully transmitted after one or more retransmissions. This parameter is based on dot11RetryCount from [802.11-2012]. - 2.0
MultipleRetryCount unsignedInt R [StatsCounter32] The number of packets that were successfully transmitted after more than one retransmission. This parameter is based on dot11MultipleRetryCount from [802.11-2012]. - 2.0
Device.WiFi.AccessPoint.{i}.Accounting. object R This object contains the parameters related to RADIUS accounting functionality for the access point. - 2.0
Enable boolean W Enables or disables accounting functionality for the access point. - 2.0
ServerIPAddr string(:45) W [IPAddress] The IP Address of the RADIUS accounting server. - 2.0
SecondaryServerIPAddr string(:45) W [IPAddress] The IP Address of a secondary RADIUS accounting server. The client can forward requests to the secondary server in the event that the primary server is down or unreachable, or after a number of tries to the primary server fail, or in a round-robin fashion. [RFC2866] - 2.0
ServerPort unsignedInt W The port number of the RADIUS server used for accounting. The default port is 1813 as defined in [RFC2866]. 1813 2.0
SecondaryServerPort unsignedInt W The port number of the secondary RADIUS server used for accounting. The default port is 1813 as defined in [RFC2866]. If this parameter is not implemented, the secondary RADIUS server will use the same port number as the primary RADIUS server. 1813 2.0
Secret string W

The secret used for handshaking with the RADIUS accounting server [RFC2865].

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

- 2.0
SecondarySecret string W

The secret used for handshaking with the secondary RADIUS accounting server [RFC2865]. If this parameter is not implemented, the secondary RADIUS server will use the same secret as the primary RADIUS server.

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

- 2.0
InterimInterval unsignedInt(0,60:) W Specifies the default interim accounting interval in seconds, which is used for service accounting when the Acct-Interim-Interval attribute is not configured. [Section 2.1/RFC2869] The value MUST NOT be smaller than 60. The value SHOULD NOT be smaller than 600, and careful consideration should be given to its impact on network traffic [Section 5.16/RFC2869]. A value of 0 means no interim accounting messages are sent. 0 2.0
Device.WiFi.AccessPoint.{i}.AC.{i}. object(4:4) R

This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:

  • BE (Best Effort)
  • BK (Background)
  • VI (Video)
  • VO (Voice)

This table MUST contain exactly 4 entries.

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

- 2.0
AccessCategory string R

This identifies the access category.

Enumeration of:

  • BE
  • BK
  • VI
  • VO
- 2.0
Alias string(:64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
AIFSN unsignedInt(2:15) W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 2.0
ECWMin unsignedInt(0:15) W Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 28 - 1, or 255, (expressed in microseconds). - 2.0
ECWMax unsignedInt(0:15) W Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 28 - 1, or 255, (expressed in microseconds). - 2.0
TxOpMax unsignedInt(0:255) W Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU). - 2.0
AckPolicy boolean W Ack Policy, where False=“Do Not Acknowledge” and True=“Acknowledge” - 2.0
OutQLenHistogramIntervals string[] W Comma-separated list of strings. Definition of the histogram intervals for counting the transmit queue length in packets. Each value indicates the maximum value of the interval. For example, “0,1,4,8,” defines the five intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no Stats.OutQLenHistogram stats will be collected. - 2.0
OutQLenHistogramSampleInterval unsignedInt W The time between recording samples of the current transmit queue in seconds. - 2.0
Device.WiFi.AccessPoint.{i}.AC.{i}.Stats. object R This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). The CPE MUST reset the Access Point’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point’s Status parameter transitions to a Diasbled state) or when the Access Point becomes administratively up (i.e. the Access Point’s Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted in this access category, including framing characters. - 2.0
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received in this access category, including framing characters. - 2.0
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted in this access category. - 2.0
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received in this access category. - 2.0
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound packets in this access category that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.0
ErrorsReceived unsignedInt R [StatsCounter32] The total number of inbound packets in this access category that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
DiscardPacketsSent unsignedInt R [StatsCounter32] The total number of outbound packets in this access category 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
DiscardPacketsReceived unsignedInt R [StatsCounter32] The total number of inbound packets in this access category 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
RetransCount unsignedInt R [StatsCounter32] The total number of transmitted packets in this access category which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.0
OutQLenHistogram string[] R Comma-separated list of strings. Histogram of the total length of the transmit queue of this access category in packets (1 packet, 2 packets, etc.) according to the intervals defined by OutQLenHistogramIntervals, with samples taken each OutQLenHistogramSampleInterval. Example: “12,5,1,0,2,0,0,1”. - 2.0
Device.WiFi.EndPoint.{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point. For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint 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 EndPoint row.

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

- 2.0
Enable boolean W Enables or disables this end point. false 2.0
Status string R

Indicates the status of this end point. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) 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
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
ProfileReference string(:256) W The value MUST be the Path Name of a row in the Profile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the currently active profile, which specifies the SSID and security settings to be used by the end point. <Empty> 2.0
SSIDReference string(:256) R The value MUST be the Path Name of a row in the SSID. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. SSIDReference is determined based on the Profile.{i}.SSID within the associated ProfileReference) endpoint profile. SSIDReference MUST be an empty string if ProfileReference is an empty string (i.e. only when an active profile is assigned can the associated SSID interface be determined). <Empty> 2.0
ProfileNumberOfEntries unsignedInt R The number of entries in the Profile table. - 2.0
Device.WiFi.EndPoint.{i}.Stats. object R Throughput statistics for this end point. - 2.0
LastDataDownlinkRate unsignedInt(1000:600000) R

The data transmit rate in kbps that was most recently used for transmission from the access point to the end point device.

Active Notification requests for this parameter MAY be denied.

- 2.0
LastDataUplinkRate unsignedInt(1000:600000) R

The data transmit rate in kbps that was most recently used for transmission from the end point to the access point device.

Active Notification requests for this parameter MAY be denied.

- 2.0
SignalStrength int(-200:0) R An indicator of radio signal strength of the downlink from the access point to the end point, measured in dBm, as an average of the last 100 packets received from the device. - 2.0
Retransmissions unsignedInt(0:100) R The number of packets that had to be re-transmitted, from the last 100 packets sent to the access point. Multiple re-transmissions of the same packet count as one. 0 2.0
Device.WiFi.EndPoint.{i}.Security. object R This object contains security related parameters that apply to a WiFi end point [802.11-2007]. - 2.0
ModesSupported string[] R

Comma-separated list of strings. Indicates which security modes this EndPoint instance is capable of supporting.

Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
- 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}. object(0:) W

EndPoint Profile table.

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

- 2.0
Enable boolean W Enables or disables this Profile. When there are multiple WiFi EndPoint Profiles, e.g. each instance supports a different SSID and/or different security configuration, this parameter can be used to control which of the instances are currently enabled. false 2.0
Status string R

Indicates the status of this Profile. Enumeration of:

  • Active
  • Available
  • Error (OPTIONAL)
  • Disabled The Active value is reserved for the instance that is actively connected. The Available value represents an instance that is not currently active, but is also not disabled or in error. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string(:64) W

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

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

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

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

Active Notification requests for this parameter MAY be denied.

- 2.0
SSID string(:32) W The profile identifier in use by the connection. The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as an ID for joining a particular radio network (BSS). - 2.0
Location string W Location of the profile. This value serves as a reminder from the user, describing the location of the profile. For example: “Home”, “Office”, “Neighbor House”, “Airport”, etc. An empty string is also valid. - 2.0
Priority unsignedInt(:255) W The profile Priority defines one of the criteria used by the End Point to automatically select the “best” AP when several APs with known profiles are simultaneously available for association. In this situation, the End Point has to select the AP with the higher priority in its profile. If there are several APs with the same priority, providing different SSID or the same SSID, then the wireless end point has to select the APs according to other criteria like signal quality, SNR, etc. 0 is the highest priority. 0 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. object R This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007]. - 2.0
ModeEnabled string W The value MUST be a member of the list reported by the Security.ModesSupported parameter. Indicates which security mode is enabled. - 2.0
WEPKey hexBinary(5,13) W

A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

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

- 2.0
PreSharedKey hexBinary(:32) W

A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined).

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

- 2.0
KeyPassphrase string(8:63) W

A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 [RFC2898].

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

- 2.0
Device.WiFi.EndPoint.{i}.WPS. object R This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this end point. - 2.0
Enable boolean W Enables or disables WPS functionality for this end point. true 2.0
ConfigMethodsSupported string[] R

Comma-separated list of strings. Indicates the WPS configuration methods supported by the device. Each list item is an enumeration of:

  • USBFlashDrive
  • Ethernet
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN This parameter corresponds directly to the “Config Methods” attribute of the WPS specification [WPSv1.0].
- 2.0
ConfigMethodsEnabled string[] W Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. Comma-separated list of strings. Indicates the WPS configuration methods enabled on the device. - 2.0
Device.WiFi.EndPoint.{i}.AC.{i}. object(4:4) R

This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:

  • BE (Best Effort)
  • BK (Background)
  • VI (Video)
  • VO (Voice)

This table MUST contain exactly 4 entries.

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

- 2.0
AccessCategory string R

This identifies the access category.

Enumeration of:

  • BE
  • BK
  • VI
  • VO
- 2.0
Alias string(:64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
AIFSN unsignedInt(2:15) W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 2.0
ECWMin unsignedInt(0:15) W Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 28 - 1, or 255, (expressed in microseconds). - 2.0
ECWMax unsignedInt(0:15) W Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 28 - 1, or 255, (expressed in microseconds). - 2.0
TxOpMax unsignedInt(0:255) W Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU). - 2.0
AckPolicy boolean W Ack Policy, where False=“Do Not Acknowledge” and True=“Acknowledge” - 2.0
OutQLenHistogramIntervals string[] W Comma-separated list of strings. Definition of the histogram intervals for counting the transmit queue length in packets. Each value indicates the maximum value of the interval. For example, “0,1,4,8,” defines the five intervals: 0 packets in queue, 1 packet in queue, 2 to 4 packets in queue, 5 to 8 packets in queue, and 9 or more packets in queue. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, no Stats.OutQLenHistogram stats will be collected. - 2.0
OutQLenHistogramSampleInterval unsignedInt W The time between recording samples of the current transmit queue seconds. - 2.0
Device.WiFi.EndPoint.{i}.AC.{i}.Stats. object R This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). The CPE MUST reset the EndPoint’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the EndPoint becomes operationally down due to a previous administrative down (i.e. the EndPoint’s Status parameter transitions to a Diasbled state) or when the EndPoint becomes administratively up (i.e. the EndPoint’s Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted in this access category, including framing characters. - 2.0
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received in this access category, including framing characters. - 2.0
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted in this access category. - 2.0
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received in this access category. - 2.0
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound packets in this access category that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.0
ErrorsReceived unsignedInt R [StatsCounter32] The total number of inbound packets in this access category that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
DiscardPacketsSent unsignedInt R [StatsCounter32] The total number of outbound packets in this access category 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
DiscardPacketsReceived unsignedInt R [StatsCounter32] The total number of inbound packets in this access category 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
RetransCount unsignedInt R [StatsCounter32] The total number of transmitted packets in this access category which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.0
OutQLenHistogram string[] R Comma-separated list of strings. Histogram of the total length of the transmit queue of this access category in packets (1 packet, 2 packets, etc.) according to the intervals defined by OutQLenHistogramIntervals, with samples taken each OutQLenHistogramSampleInterval. Example: “12,5,1,0,2,0,0,1” - 2.0
Device.WiFi.NeighboringWiFiDiagnostic. object R This object defines access to other WiFi SSIDs that this device is able to receive. - 2.0
DiagnosticsState string W

Indicates availability of WiFi SSID data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the WiFi scan. When writing, the only allowed value is Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

Active Notification requests for this parameter MAY be denied.

- 2.0
ResultNumberOfEntries unsignedInt R The number of entries in the Result table. - 2.0
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. object(0:) R

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

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

- 2.0
Radio string R The value MUST be the Path Name of a row in the Device.WiFi.Radio. table. The Radio that detected the neighboring WiFi SSID. - 2.0
SSID string(:32) R The current service set identifier in use by the neighboring WiFi SSID. The value MAY be empty for hidden SSIDs. - 2.0
BSSID string(:17) R [MACAddress] The BSSID used for the neighboring WiFi SSID. - 2.0
Mode string R

The mode the neighboring WiFi radio is operating in.

Enumeration of:

  • AdHoc
  • Infrastructure
- 2.0
Channel unsignedInt(1:255) R The current radio channel used by the neighboring WiFi radio. - 2.0
SignalStrength int(-200:0) R An indicator of radio signal strength (RSSI) of the neighboring WiFi radio measured in dBm, as an average of the last 100 packets received. - 2.0
SecurityModeEnabled string R

The type of encryption the neighboring WiFi SSID advertises.

Enumeration of:

  • None
  • WEP
  • WPA
  • WPA2
  • WPA-WPA2
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
- 2.0
EncryptionMode string[] R

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises.

Each list item is an enumeration of:

  • TKIP
  • AES
- 2.0
OperatingFrequencyBand string R

Indicates the frequency band at which the radio this SSID instance is operating.

Enumeration of:

  • 2.4GHz
  • 5GHz
- 2.0
SupportedStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Result instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

- 2.0
OperatingStandards string[] R Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this Result. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed. For example, a value of “g,b” (or “b,g” - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of “g” means that only the 802.11g standard can be used. - 2.0
OperatingChannelBandwidth string R

Indicates the bandwidth at which the channel is operating.

Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
  • Auto
- 2.0
BeaconPeriod unsignedInt R Time interval (in ms) between transmitting beacons. - 2.0
Noise int(-200:0) R Indicator of average noise strength (in dBm) received from the neighboring WiFi radio. - 2.0
BasicDataTransferRates string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is “1,2”, this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.0