Broadband Forum

TR-069 Device:2.12 Root Object definition [CWMP]

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

DATA MODEL DEFINITION

License

Copyright (c) 2010-2018, Broadband Forum

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

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

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

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

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

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

Data Types

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

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

Data Type Base Type Description
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.
DiagnosticsState string

Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

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])
PSMBreakPointIndexAndLevel unsignedInt[2:2]
  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz. Both values are represented as unsignedInt. [Clause 5.2/G.9964] defines limits on PSM breakpoint levels.
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.1AX-2014] IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks - Link Aggregation, IEEE, 2014.
[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.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[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.
[ETSIBRAN] ETSI EN 301 893, Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN; Harmonized EN covering the essential requirements of article 3.2 of the RTTE Directive, ETSI.
[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.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.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.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[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.
[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[IKEv2-params] IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[IPDR-XDR] IPDR XDR Encoding Format, IPDR/XDR Encoding Format, TM Forum.
[IPDR-XML] IPDR XML File Encoding Format, IPDR/XML File Encoding Format, TM Forum.
[ISO-13818-6:1998] ISO/IEC 13818-6:1998, Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC, ISO, 1998.
[ISO3166-1] ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006.
[ISO639-1] ISO 639-1, Codes for the representation of names of Languages - Part 1: Alpha-2 code, ISO, 2002.
[ISO646-1991] ISO/IEC 646-1991, Information Technology - ISO 7-bit coded character set for information interchange, ISO, 1991.
[ITU-E.118] ITU E.118, The international telecommunication charge card, International Telecommunication Union, May 2006.
[ITU-E.164] ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010.
[ITU-X.733] ITU X.733, Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function, International Telecommunication Union, February 1992.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[JJ-300.01] JJ-300.01, The List of Device Categories, TTC, 2011.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[LMAPREG] draft-ietf-ippm-metric-registry-12, Registry for Performance Metrics, IETF, June 30, 2017.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MoCAv1.0] MoCA v1.0, MoCA MAC/PHY Specification v1.0, MoCA Alliance, 2009.
[MoCAv1.1] MoCA v1.1, MoCA MAC/PHY Specification v1.1 Extensions, MoCA Alliance, 2009.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT311] MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] 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.
[RFC3339] RFC 3339, Date and Time on the Internet: Timestamps, IETF, July, 2002.
[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.
[RFC3931] RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), IETF, March 2005.
[RFC3948] RFC 3948, UDP Encapsulation of IPsec ESP Packets, IETF, January 2005.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4180] RFC4180, Common Format and MIME Type for Comma-Separated Values (CSV) Files, IETF, October 2005.
[RFC4191] RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4242] RFC 4242, Information Refresh Time Option for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4292] RFC 4292, IP Forwarding Table MIB, IETF, 2006.
[RFC4293] RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4302] RFC 4302, IP Authentication Header, IETF, December 2005.
[RFC4303] RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005.
[RFC4389] RFC 4389, Neighbor Discovery Proxies (ND Proxy), IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4719] RFC 4719, Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3 (L2TPv3), IETF, November 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.
[RFC7348] RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014.
[RFC7395] RFC 7395, An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for WebSocket, IETF, October 2014.
[RFC7398] RFC 7398, A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance, IETF, February 2015.
[RFC7594] RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015.
[RFC7597] RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015.
[RFC7598] RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015.
[RFC7599] RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015.
[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-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a3] TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2009.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, February 2010.
[TR-106a5] TR-106 Amendment 5, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2010.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, July 2011.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2013.
[TR-143] TR-143 Amendment 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015.
[TR-143a1] TR-143 Amendment 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, December 2014.
[TR-157] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-157a10] 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.
[TR-304] TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015.
[TR-390] TR-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, May 2017.
[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.
[WPS 2.0] WSC 2.0, Wi-Fi Simple Configuration Technical Specification Version 2.0.x, Wi-Fi Alliance.
[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.12 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.4
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.DeviceInfo. object R This object contains general device information. - 2.0
DeviceCategory string[] R Comma-separated list of strings. Each list item is a device category (e.g. “AV_TV” and “AV_Recorder”), or the value is an empty string if no such element is provided by the device. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories. - 2.8
Manufacturer string(:64) R The manufacturer of the CPE (human readable string). - 2.0
ManufacturerOUI string(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates.

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

 - 2.0
ModelName string(:64) R

Model name of the CPE (human readable string).

Active Notification requests for this parameter MAY be denied.

 - 2.0
ModelNumber string(:64) R The model number of the device (human readable string), or an empty string if no model number is provided by the device. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31. - 2.8
Description string(:256) R

A full description of the CPE device (human readable string).

Active Notification requests for this parameter MAY be denied.

 - 2.0
ProductClass string(:64) R Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 2.0
SerialNumber string(:64) R Identifier of the particular device that is unique for the indicated class of product and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 2.0
HardwareVersion string(:64) R

A string identifying the particular CPE model and version.

This parameter MUST always be included in Inform messages.

 - 2.0
SoftwareVersion string(:64) R

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware). To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build. For CPEs that support multiple firmware images, the value for this parameter MUST be the software version of the active firmware image.

This parameter MUST always be included in Inform messages.

Active Notification MUST always be enabled for this parameter.

 - 2.0
ActiveFirmwareImage string R A full path reference to the row in the FirmwareImage table representing the currently running firmware image. - 2.12
BootFirmwareImage string W A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots. This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to ‘true’). Out of the factory, this parameter should be set to point to the firmware image the CPE will attempt to boot when first powered on. The firmware image instance referenced by this parameter must also have an Available parameter value of ‘true’. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPE responding with a CWMP fault (9007). In situations where the CPE cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPE MUST NOT modify this value to point to the alternate firmware image that is currently active. - 2.12
AdditionalHardwareVersion string[](:64) R Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply. - 2.0
AdditionalSoftwareVersion string[](:64) R Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply. - 2.0
ProvisioningCode string(:64) W

Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters.

This parameter MUST always be included in Inform messages.

Active Notification MUST always be enabled for this parameter.

 - 2.0
UpTime unsignedInt R

Time in seconds since the CPE was last restarted.

Active Notification requests for this parameter MAY be denied.

 - 2.0
FirstUseDate dateTime R

Date and time in UTC that the CPE first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPE MAY reset this date after a factory reset. If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value.

Active Notification requests for this parameter MAY be denied.

 - 2.0
FirmwareImageNumberOfEntries unsignedInt R The number of entries in the FirmwareImage table. - 2.12
VendorConfigFileNumberOfEntries unsignedInt R The number of entries in the VendorConfigFile table. - 2.0
ProcessorNumberOfEntries unsignedInt R The number of entries in the Processor table. - 2.1
VendorLogFileNumberOfEntries unsignedInt R The number of entries in the VendorLogFile table. - 2.1
LocationNumberOfEntries unsignedInt R The number of entries in the Location table. - 2.4
DeviceImageNumberOfEntries unsignedInt R The number of entries in the DeviceImageFile table. - 2.11
SupportedDataModelNumberOfEntries unsignedInt R The number of entries in the SupportedDataModel table. - 2.0
Device.ManagementServer. object R This object contains parameters relating to the CPE’s association with an ACS. - 2.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.

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

 - 2.0
ScheduleReboot dateTime W An absolute date and time in UTC at which time the CPE will perform a reboot. If a CWMP session is in progress at the specified time, the CPE MUST wait until the session has ended before performing the reboot. If the value specifies a date and time that has already passed (i.e., a past date and time), no reboot will be performed. - 2.10
DelayReboot int(-1:) W The number of seconds from the time the CWMP session in which this parameter value is set is ended until the CPE performs a reboot. Whenever the CPE reboots, this value MUST be reset by the CPE to -1. - 2.10
PeriodicInformEnable boolean W Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call. - 2.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. - 2.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. - 2.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.

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

 - 2.0
ConnectionRequestUsername string(:256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 2.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.

 - 2.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. - 2.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. - 2.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. - 2.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. - 2.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. - 2.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. - 2.0
HTTPConnectionRequestEnable boolean W

Enables or disables HTTP connection request handling on the CPE. If HTTP connection request handling is disabled (HTTPConnectionRequestEnable is set to false), ConnectionRequestURL MUST be set to an empty string and the CPE MUST close the port used by the HTTP connection request server.

The factory default value MUST be true.

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

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

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

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

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

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

 - 2.7
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. - 2.7
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) (length ) 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.
 - 2.7
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.

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

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

 - 2.7
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.
 - 2.7
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. - 2.7
LightweightNotificationTriggerInterval unsignedInt(0:) W The duration in seconds of the interval for which the CPE MUST attempt to deliver any pending Passive Lightweight Notifications. A value of 0 means that the trigger interval is effectively disabled. In this case pending Passive Lightweight Notifications are only sent when triggered by an Active Lightweight Notification. - 2.12
LightweightNotificationTriggerTime dateTime W An absolute time reference in UTC to determine when the CPE will initiate the Lightweight Notification (in the case that there are pending Passive Lightweight Notifications that need to be delivered). Each Passive Lightweight Notification (that is waiting for the Lightweight Notification Trigger mechanism for delivery) MUST occur at this reference time plus or minus an integer multiple of the LightweightNotificationTriggerInterval. LightweightNotificationTriggerTime is used only to set the phase of the Passive Lightweight Notification. The actual value of LightweightNotificationTriggerTime can be arbitrarily far into the past or future. For example, if LightweightNotificationTriggerInterval is 86400 (a day) and if LightweightNotificationTriggerTime is set to UTC midnight on some day (in the past, present, or future) then Lightweight Notifications for pending Passive Lightweight Notifications will occur every day at UTC midnight. These MUST begin on the very next midnight, even if LightweightNotificationTriggerTime 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 LightweightNotificationTriggerInterval. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the LightweightNotificationTriggerTime parameter was set to the Unknown Time value. - 2.12
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). - 2.7
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. - 2.7
InstanceWildcardsSupported boolean R Indicates whether or not instance wildcards are supported. A true value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069a6]. - 2.12
InformParameterNumberOfEntries unsignedInt R The number of entries in the InformParameter table. - 2.8
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.3
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.1
Enable boolean W Enables/Disables CPE notification of “12 AUTONOMOUS DU STATE CHANGE COMPLETE” events to the ACS. - 2.1
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.1
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.1
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.1
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.3
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.3
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.3
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.3
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.3
Host string[:32]() R Comma-separated list (up to 32 items) (length ) 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.3
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.3
ProxyProtocolReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. - 2.6
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.6
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.6
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.3
CommandProcessingErrMsg string(:1024) R Detailed CommandProcessed error description (vendor specific). - 2.3
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.3
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.3
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.3
ProductClass string(:64) R Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 2.3
SerialNumber string(:64) R Serial number of the associated Proxied Device. - 2.3
Host string[:32]() R Comma-separated list (up to 32 items) (length ) 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.3
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.3
ProxyProtocolReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. - 2.6
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.6
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.6
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.7
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.7
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.7
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.7
NetworkAwarenessCapable boolean R Indicates that the CPE is capable of CR-Aware Standby. - 2.7
SelfTimerCapable boolean R Indicates that the CPE is capable of Timer-Aware Standby. - 2.7
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.7
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.7
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.7
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.8
Enable boolean W Enables or disables this InformParameter. false 2.8
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.8
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.8
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.8
Device.ManagementServer.HeartbeatPolicy. object R Parameters related to CPE behavior in order to issue a Heartbeat event to the ACS using the Inform method call. If this object is supported then the CPE MUST support the requirements of [Annex O/TR-069]. - 2.12
Enable boolean W When true, Heartbeat events are enabled to be sent to the ACS based on the values of the ReportingInterval and InitiationTime parameters. - 2.12
ReportingInterval unsignedInt(30:) 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 Enable is true. - 2.12
InitiationTime dateTime W An absolute time reference in UTC to determine when the CPE will initiate the Heartbeat event Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the ReportingInterval. InitiationTime is used only to set the phase of the Heartbeat event Informs. The actual value of InitiationTime can be arbitrarily far into the past or future. For example, if ReportingInterval is 60 (one minute) and if InitiationTime is set to UTC midnight on some day (in the past, present, or future) then Heartbeat Informs will occur every minute at the next UTC midnight. These MUST begin on the very next midnight, even if InitiationTime 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. The CPE MUST locally choose a random time reference. If absolute time is not available to the CPE, its Heartbeat Inform behavior MUST be the same as if the InitiationTime parameter was set to the Unknown Time value. - 2.12
Device.DeviceInfo.VendorConfigFile.{i}. object(0:) R

Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table.

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

 - 2.0
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 Name of the vendor configuration file. If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name. Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name. Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file. - 2.0
Version string(:16) R A string identifying the configuration file version currently used in the CPE. If the CPE is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value. Otherwise, the value of this parameter MUST be an empty string. - 2.0
Date dateTime R Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 2.0
Description string(:256) R A description of the vendor configuration file (human-readable string). - 2.0
UseForBackupRestore boolean R When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes. Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific. - 2.7
Device.DeviceInfo.MemoryStatus. object R Status of the device’s volatile physical memory. - 2.0
Total unsignedInt R The total physical RAM, in kilobytes, installed on the device. - 2.0
Free unsignedInt R

The free physical RAM, in kilobytes, currently available on the device.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.DeviceInfo.ProcessStatus. object R Status of the processes on the device. - 2.0
CPUUsage unsignedInt(:100) R

The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ProcessNumberOfEntries unsignedInt R The number of entries in the Process table. Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in [Section 3.2.1/TR-069a2]. - 2.0
Device.DeviceInfo.ProcessStatus.Process.{i}. object(0:) R

List of all processes running on the device.

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

 - 2.0
PID unsignedInt R The Process Identifier. - 2.0
Command string(:256) R The name of the command that has caused the process to exist. - 2.0
Size unsignedInt R

The size in kilobytes of the memory occupied by the process.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Priority unsignedInt(:99) R The priority of the process where 0 is highest. - 2.0
CPUTime unsignedInt R

The amount of time in milliseconds that the process has spent taking up CPU time since the process was started.

Active Notification requests for this parameter MAY be denied.

 - 2.0
State string R

The current state that the process is in.

Enumeration of:

  • Running
  • Sleeping
  • Stopped
  • Idle (OPTIONAL)
  • Uninterruptible (OPTIONAL)
  • Zombie (OPTIONAL)

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.DeviceInfo.TemperatureStatus. object R Status of the temperature of the device. - 2.0
TemperatureSensorNumberOfEntries unsignedInt R The number of entries in the TemperatureSensor table. - 2.0
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object(0:) R

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

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

 - 2.0
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.3
Enable boolean W Indicates whether or not the temperature sensor is enabled. - 2.0
Status string R

The status of this temperature sensor.

Enumeration of:

  • Disabled (The sensor is not currently sampling the temperature)
  • Enabled (The sensor is currently sampling the temperature)
  • Error (The sensor error currently prevents sampling the temperature)
 - 2.0
Reset boolean W When set to true, resets the temperature sensor. - 2.0
ResetTime dateTime R The time at which this temperature sensor was reset. Reset can be caused by:
  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the temperature sensor (including a reboot of the device). The Unknown Time value, as defined in [TR-106a2], indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.
 - 2.0
Name string(:256) R Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 2.0
Value int(-274:) R

This temperature sensor’s last good reading in degrees celsius. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset.

Active Notification requests for this parameter MAY be denied.

 - 2.0
LastUpdate dateTime R

The time at which this temperature sensor’s last good reading was obtained. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset.

Active Notification requests for this parameter MAY be denied.

 - 2.0
MinValue int(-274:) R This temperature sensor’s lowest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. - 2.0
MinTime dateTime R The time at which this temperature sensor’s lowest value was read. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset. - 2.0
MaxValue int(-274:) R This temperature sensor’s highest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. - 2.0
MaxTime dateTime R The time at which this temperature sensor’s highest value was read. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset. - 2.0
LowAlarmValue int(-274:) W This temperature sensor’s low alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value. A change to this value will cause LowAlarmTime to be reset. - 2.0
LowAlarmTime dateTime R Initial time at which this temperature sensor’s LowAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset. - 2.0
HighAlarmValue int(-274:) W This temperature sensor’s high alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value. A change to this value will cause HighAlarmTime to be reset. - 2.0
PollingInterval unsignedInt W The interval, measured in seconds, in which the device polls this TemperatureSensor. If the value is 0 then the device selects its own polling interval. If the value is greater than 0 then the device MUST use this value as the polling interval. - 2.1
HighAlarmTime dateTime R Initial time at which this temperature sensor’s HighAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset. - 2.0
Device.DeviceInfo.NetworkProperties. object R This object defines the parameters that describe how the device handles network traffic. - 2.0
MaxTCPWindowSize unsignedInt R The maximum number of bytes of outstanding data a sender can send on a particular connection prior to an acknowledgment [RFC793]. Any scaling factor SHOULD be included in this parameter [RFC1323]. - 2.0
TCPImplementation string[] R

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

  • Tahoe (Represents the base TCP implementation in [RFC793] and elements of [RFC2582])
  • Reno (Represents the base TCP implementation in [RFC793] with the additional algorithms defined in [RFC2581])
  • New Reno (Described as a modification to the Reno algorithms in [RFC2582])
  • Vegas (An emerging TCP congestion control mechanism) Tahoe, Reno, and New Reno are defined in [RFC2582]
 - 2.0
Device.DeviceInfo.Processor.{i}. object(0:) R

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

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

 - 2.1
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.3
Architecture string R

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

  • arm
  • i386
  • m68010
  • m68k
  • mipseb (big-endian)
  • mipsel (little-endian)
  • powerpc
  • sh3eb (big-endian)
  • sh3el (little-endian)
  • x86_64 For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].
 - 2.1
Device.DeviceInfo.VendorLogFile.{i}. object(0:) R

Each table entry represents a Vendor Log File. This table of log files is informational only and does not allow the ACS to operate on these files in any way.

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

 - 2.1
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.1
Name string(:64) R Name of the log file. Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism. - 2.1
MaximumSize unsignedInt R The maximum size of the log file in bytes. If the device doesn’t know the maximum file size then MaximumSize will be 0. - 2.1
Persistent boolean R When true, the log file contents are preserved across a device reboot. When false, the log file contents will be purged when the device is rebooted. - 2.1
Device.DeviceInfo.Location.{i}. object(0:) W

This object contains Location information.

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

 - 2.4
Source string R

Identifies the source of the location data.

Enumeration of:

  • GPS
  • AGPS
  • Manual
  • External
 External 2.4
AcquiredTime dateTime R The time when the location was acquired. - 2.4
ExternalSource string R

URL, MAC address, or other identifier that identifies an “External” source of this location. Meaningful only if Source has a value of External, otherwise it MUST be an empty string. If ExternalProtocol has a value of CWMP, this is the URL or IP address of the ACS.

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

 - 2.4
ExternalProtocol string R

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

  • <Empty> (An empty string)
  • CWMP
  • OMA-DM
  • SNMP
  • UPnP
  • HELD
  • DHCPv4
  • DHCPv6
  • LLDP-MED
  • MLP
  • Other Meaningful only if Source has a value of External, otherwise it MUST be an empty string.
 CWMP 2.4
DataObject string(:1200) W The currently valid location information. Writable only when ExternalProtocol has a value of CWMP. If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491]. If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). If obtained by an external source this is the location information as received. If it’s an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. CWMP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). Only zero or one Location object instance with value CWMP MUST exist at any given time. - 2.4
Device.DeviceInfo.DeviceImageFile.{i}. object(0:) R

This object describes an image of the device.

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

 - 2.11
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.11
Location string R

The location of the device that represents the image as the user looks at the front of the device in its typical orientation (e.g., on-end, flat).

Enumeration of:

  • Front
  • Back
  • Left
  • Right
  • Top
  • Bottom
 - 2.11
Image base64 R The device image in PNG, JPEG or GIF format. - 2.11
Device.DeviceInfo.FirmwareImage.{i}. object(0:) R

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

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

 - 2.12
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.12
Name string(:64) R Firmware/software image name. Descriptive text of the image or filename. The value of Name is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed. - 2.12
Version string(:64) R A string identifying the version of the firmware image represented by this FirmwareImage. Whenever this firmware image is active (ie, the device has booted this firmware image), the value of the DeviceInfo.SoftwareVersion parameter MUST be the same as the value contained in this parameter. To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build. The value of Version is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed. - 2.12
Available boolean W Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true. This value MUST be set to true whenever a new firmware image is installed. This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter. Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it. - 2.12
Status string R

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

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Downloading (This Firmware Image instance is being downloaded)
  • Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
  • Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
  • DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
  • ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
  • InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
  • ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)
 - 2.12
BootFailureLog string R If the Agent is unable to boot into this firmware image, when specified, the Agent can use this parameter to record some information as to why the boot failed. If the Agent successfully boots into this firmware, the value of this parameter SHOULD be an empty string. When a new firmware image is installed into this object instance, this parameter MUST be cleared. The length of this string is defined as implementation-specific by the Agent. - 2.12
Device.DeviceInfo.SupportedDataModel.{i}. object(0:) R

This table contains details of the device’s Current Supported Data Model. The table MUST describe the device’s entire Supported Data Model. Therefore, if a device’s Supported Data Model changes at run-time, entries will need to be added or removed as appropriate. Each table entry MUST refer to only a single Root Object or Service Object. The device MAY choose to use more than one table entry for a given Root Object or Service Object. Considering that every device has some form of a data model, this table MUST NOT be empty.

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

 - 2.0
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.3
URL string(:256) R URL ([RFC3986]) that describes some or all of the device’s Current Supported Data Model. The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model. The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in [Annex B/TR-106a3], including any additional normative requirements referenced within the Schema. The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that UUID is a unique key, so the XML file referenced by this URL will never change. The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of “localhost” as URL host portion, When the “localhost” value is used, the ACS has the responsibility to substitute the “localhost” value with the host portion of the connection request URL. Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent. - 2.0
UUID string(36) R [UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL. - 2.6
URN string(:256) R URN ([RFC3986]) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry. For example, if this table entry references a DT Instance that refers to the Device:1.3 Root Object, the value of this parameter would be urn:broadband-forum-org:tr-157-1-0-0, because TR-157 defines Device:1.3. If the DT Instance instead referred to a vendor-specific Root Object, e.g. X_EXAMPLE_Device:1.0 (derived from Device:1.3), the value of this parameter would be something like urn:example-com:device-1-0-0. - 2.0
Features string[] R

Comma-separated list of strings. This parameter MUST list exactly the features that are defined using the top-level feature element in the DT Instance referenced by URL. For example, if the DT instance specified the following:

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

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

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].
 - 2.3
ProductClass string(:64) R Identifier of the class of product of the associated CPE Proxier for which the serial number applies. An empty string indicates either that the CPE Proxier does not use a product class to differentiate its serial number. - 2.3
SerialNumber string(:64) R Serial number of the associated CPE Proxier. - 2.3
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.3
Device.Time. object R This object contains parameters relating an NTP or SNTP time client in the CPE. - 2.0
Enable boolean W Enables or disables the NTP or SNTP time client. - 2.0
Status string R

Status of Time support on the CPE. Enumeration of:

  • Disabled
  • Unsynchronized
  • Synchronized
  • Error_FailedToSynchronize
  • Error (OPTIONAL) The Unsynchronized value indicates that the CPE’s absolute time has not yet been set. The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate. The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.0
NTPServer1 string(:64) W First NTP timeserver. Either a host name or IP address. - 2.0
NTPServer2 string(:64) W Second NTP timeserver. Either a host name or IP address. - 2.0
NTPServer3 string(:64) W Third NTP timeserver. Either a host name or IP address. - 2.0
NTPServer4 string(:64) W Fourth NTP timeserver. Either a host name or IP address. - 2.0
NTPServer5 string(:64) W Fifth NTP timeserver. Either a host name or IP address. - 2.0
CurrentLocalTime dateTime R

The current date and time in the CPE’s local time zone.

Active Notification requests for this parameter MAY be denied.

 - 2.0
LocalTimeZone string(:256) W

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

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

Enables and disables the CPE’s user interface.

The factory default value MUST be true.

 - 2.11
PasswordRequired boolean W Present only if the CPE provides a password-protected LAN-side user interface. Indicates whether or not the local user interface MUST require a password to be chosen by the user. If false, the choice of whether or not a password is used is left to the user. - 2.0
PasswordUserSelectable boolean W Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. Indicates whether or not a password to protect the local user interface of the CPE MAY be selected by the user directly (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword). - 2.0
PasswordReset boolean W Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. When set to true, resets LANConfigSecurity.ConfigPassword to its factory value. - 2.0
UpgradeAvailable boolean W Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user. - 2.0
WarrantyDate dateTime W Indicates the date and time in UTC that the warranty associated with the CPE is to expire. - 2.0
ISPName string(:64) W The name of the customer’s ISP. - 2.0
ISPHelpDesk string(:32) W The help desk phone number of the ISP. - 2.0
ISPHomePage string(:256) W The URL of the ISP’s home page. - 2.0
ISPHelpPage string(:256) W The URL of the ISP’s on-line support page. - 2.0
base64(0:4095) W Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less. - 2.0
ISPLogoSize unsignedInt(0:4095) W Un-encoded binary image size in bytes. If ISPLogoSize input value is 0 then the ISPLogo is cleared. ISPLogoSize can also be used as a check to verify correct transfer and conversion of Base64 string to image size. - 2.0
ISPMailServer string(:256) W The URL of the ISP’s mail server. - 2.0
ISPNewsServer string(:256) W The URL of the ISP’s news server. - 2.0
TextColor hexBinary(3) W The color of text on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0
BackgroundColor hexBinary(3) W The color of the GUI screen backgrounds in RGB hexadecimal notation (e.g., FF0088). - 2.0
ButtonColor hexBinary(3) W The color of buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0
ButtonTextColor hexBinary(3) W The color of text on buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0
AutoUpdateServer string(:256) W

The server the CPE can check to see if an update is available for direct download to it.

This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true.

 - 2.0
UserUpdateServer string(:256) W

The server where a user can check via a web browser if an update is available for download to a PC.

This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true.

 - 2.0
AvailableLanguages string[](:256) R Comma-separated list (maximum number of characters 256) of strings. List items represent user-interface languages that are available, where each language is specified according to [RFC3066]. - 2.0
CurrentLanguage string(:16) W Current user-interface language, specified according to [RFC3066]. The value MUST be a member of the list reported by the AvailableLanguages parameter. - 2.0
Device.UserInterface.RemoteAccess. object R This object contains parameters relating to remotely accessing the CPE’s user interface. Remote access is defined as any entity not of a local subnet attempting to connect to the CPE. Remote access requires user authentication. To provide remote access authentication the CPE MUST support a “User” table with at least one instance that has “RemoteAccessCapable” set to true. - 2.0
Enable boolean W Enables/Disables remotely accessing the CPE’s user interface. - 2.0
Port unsignedInt(:65535) W Destination TCP port required for remote access connection. - 2.0
SupportedProtocols string[] R

Comma-separated list of strings. Indicates the protocols that are supported by the CPE for the purpose of remotely accessing the user interface.

Each list item is an enumeration of:

 - 2.0
Protocol string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 2.0
Device.UserInterface.LocalDisplay. object R This object describes how to remotely manage the initial positioning of a user interface on a device’s local display. - 2.0
Movable boolean W Controls whether the user is allowed to change the GUI window position on the local CPE’s display. - 2.0
Resizable boolean W Controls whether the user is allowed to resize the GUI window on the local CPE’s display. - 2.0
PosX int W

The horizontal position of the User Interface’s top left corner within the local CPE’s display measured from the top left corner, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

 - 2.0
PosY int W

The vertical position of the User Interface’s top left corner within the local CPE’s display measured from the top left corner, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Width unsignedInt W

The width of the user interface within the local CPE’s display, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Height unsignedInt W

The height of the user interface within the local CPE’s display, expressed in pixels.

Active Notification requests for this parameter MAY be denied.

 - 2.0
DisplayWidth unsignedInt R The width of the local CPE’s display, expressed in pixels. - 2.0
DisplayHeight unsignedInt R The height of the local CPE’s display, expressed in pixels. - 2.0
Device.UserInterface.Messages. object R Definition of user information message displays. - 2.11
Enable boolean W

Enables and displays the user information message.

The factory default value MUST be true.

 - 2.11
Title string(:128) W Message title to be displayed. - 2.11
SubTitle string(:128) W Message sub title to be displayed. - 2.11
Text string W Message text. - 2.11
IconType string W

Icon to be displayed.

Enumeration of:

  • None
  • Greeting
  • Information
  • Warning
  • Important
  • Urgent
  • Advertisement
 - 2.11
MessageColor hexBinary(3) W The color of message text in RGB hexadecimal notation (e.g., FF0088). - 2.11
BackgroundColor hexBinary(3) W The color of the message screen background in RGB hexadecimal notation (e.g., FF0088). - 2.11
TitleColor hexBinary(3) W The color of the message title in RGB hexadecimal notation (e.g., FF0088). - 2.11
SubTitleColor hexBinary(3) W The color of the sub title in RGB hexadecimal notation (e.g., FF0088). - 2.11
RequestedNumberOfRepetitions unsignedInt W The number of times the device SHOULD repeat the message. - 2.11
ExecutedNumberOfRepetitions unsignedInt R The number of times the device repeated the message. - 2.11
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.3
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.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.8
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
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.8
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
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.8
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 (DELETED)
  • 30a
  • 35b 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
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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). Doesn’t apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNus.

Active Notification requests for this parameter MAY be denied.

 - 2.0
DownstreamAttenuation int R

The current downstream signal loss (expressed in 0.1dB). Doesn’t apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNds.

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
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, 8, and 16. 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, 8, and 16. 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, 8, and 16. 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[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T 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[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for ITU-T 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[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream signal attenuation averaged across all active sub-carriers in the frequency 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 ITU-T 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[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream signal attenuation averaged across all active sub-carriers in the frequency 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 ITU-T 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.8
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.8
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.8
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.8
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.8
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.8
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 DSL.Channel instance or a FAST.Line 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 DSL.Channel instance or one FAST.Line instance. There MUST be an instance of BondedChannel for each DSL channel or FAST line that is bonded. When a DSL.Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded DSL.Channel or FAST.Line 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. or FAST.Line. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string.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

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

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 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.FAST. object R This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. - 2.11
LineNumberOfEntries unsignedInt R The number of entries in the Line table. - 2.11
Device.FAST.Line.{i}. object(0:) R

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

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

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

The current operational state of the FAST 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.11
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.11
Name string(:64) R The textual name of the FAST line as assigned by the CPE. - 2.11
LastChange unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
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.11
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.11
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.11
LinkStatus string R

Status of the FAST physical link. Enumeration of:

 - 2.11
AllowedProfiles string[] R

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

  • 106a
  • 212a Note: In G.997.2, this parameter is called PROFILES. See ITU-T Recommendation [G.997.2].
 - 2.11
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 FAST profile is currently in use on the line. - 2.11
PowerManagementState string R

The power management state of the line. Enumeration of:

  • L0
  • L2.1
  • L2.2
  • L3 Note: See ITU-T Recommendation [G.9701].
 - 2.11
SuccessFailureCause unsignedInt(0:5) R The success failure cause of the initialization. An enumeration of the following integer values:
  • 0: Successful
  • 1: Configuration error. Configuration error. This error occurs if the line cannot reach L0 state due to a mismatch of configuration and FTU capabilities.
  • 2: Configuration not feasible on the line. This error occurs if the line cannot reach the L0 state due to a mismatch of configuration of line and noise characteristics.
  • 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 far-end FTU detected. This error occurs if the far-end FTU is not powered or not connected or if the line is too long to allow detection of a far-end FTU.
  • 5: Any other or unknown initialization failure cause. Note: In G.997.2, this parameter is called “Initialization success/failure cause”. See Clause 7.20.2.1 of ITU-T Recommendation [G.997.2].
 - 2.11
UPBOKLER unsignedInt(0:1280) R This parameter reports the estimate of the electrical length expressed in 0.1 dB, as determined by the FTU-R (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the R-MSG1 initialization message (see clause 12.3.3.2.3/[G.9701]). 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.10.4.2 of ITU-T Recommendation [G.997.2]. - 2.11
LastTransmittedDownstreamSignal unsignedInt(0:21) R This parameter reports the downstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The downstream signal count is defined in clause 12.3.1/[G.9701]. Note: See clause 7.10.2.2 ITU-T Recommendation [G.997.2]. - 2.11
LastTransmittedUpstreamSignal unsignedInt(0:21) R This parameter reports the upstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The upstream signal count is defined in clause 12.3.1/[G.9701]. Note: See clause 7.10.2.3 ITU-T Recommendation [G.997.2]. - 2.11
UPBOKLE unsignedInt(0:1280) R This parameter reports the electrical length that would have been sent from the FTU-O to the FTU-R if the electrical length was not forced by the DPU-MIB. If the electrical length is not forced by the DPU-MIB, then this object reports the final electrical length, as determined by the FTU-O (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the O-UPDATE initialization message (see clause 12.3.3.2.4/[G.9701]). Note: See clause 7.10.4.1 in ITU-T Recommendation [G.997.2]. - 2.11
LineNumber int(1:) R Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.11
UpstreamMaxBitRate unsignedInt R

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701]. Note: This parameter is related to the G.997.2 parameter ATTNDRus. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
DownstreamMaxBitRate unsignedInt R

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701]. Note: This parameter is related to the G.997.2 parameter ATTNDRds. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
UpstreamNoiseMargin int R

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB. Note: In G.997.2, this parameter is called SNRMus. See ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
DownstreamNoiseMargin int R

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB. Note: In G.997.2, this parameter is called SNRMds. See ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
UpstreamAttenuation int R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
DownstreamAttenuation int R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
UpstreamPower int R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
DownstreamPower int R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRMRMCds int R

This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the downstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.1 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRMRMCus int R

This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the upstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.2 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
BITSRMCpsds int[](:4610) R

Comma-separated list (maximum number of characters 4610) of integers. List items report the bit allocation values on RMC sub-carriers in RMC symbols in the downstream direction. Each pair composes of a sub-carrier index from 0..4095 and an 8 bit allocation value. There are maximum 512 pairs. This parameter is defined in clause 7.10.12.3 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
BITSRMCpsus int[](:4610) R

Comma-separated list (maximum number of characters 4610) of integers. List items report the bit allocation values on RMC sub-carriers in RMC symbols in the upstream direction. Each pair composes of a sub-carrier index from 0..4095 and an 8 bit allocation value. There are maximum 512 pairs. This parameter is defined in clause 7.10.12.4 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
FEXTCANCELds boolean R This indicates whether FEXT cancellation in the downstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.11
FEXTCANCELus boolean R This indicates whether FEXT cancellation in the upstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.11
ETRds unsignedInt R

This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2]

Active Notification requests for this parameter MAY be denied.

 - 2.11
ETRus unsignedInt R

This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2]

Active Notification requests for this parameter MAY be denied.

 - 2.11
ATTETRds unsignedInt R

This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2]

Active Notification requests for this parameter MAY be denied.

 - 2.11
ATTETRus unsignedInt R

This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2]

Active Notification requests for this parameter MAY be denied.

 - 2.11
MINEFTR unsignedInt R

This parameter reports the minimum error free throughput value expressed in Kbps computed from power up as defined in clause 11.4.1.1.3 of ITU-T Recommendation [G.9701]

Active Notification requests for this parameter MAY be denied.

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

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

 - 2.11
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

 - 2.11
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.11
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.11
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.11
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.11
TotalStart unsignedInt R

FAST-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.11
ShowtimeStart unsignedInt R

FAST-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.11
LastShowtimeStart unsignedInt R

FAST-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.11
CurrentDayStart unsignedInt R

FAST-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.11
QuarterHourStart unsignedInt R

FAST-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.11
Device.FAST.Line.{i}.Stats.Total. object R This object contains DSL line total statistics. Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.11
ErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LOSS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LORS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
UAS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXUC unsignedInt R

This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXTX unsignedInt R

This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessBSW unsignedInt R

This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessSRA unsignedInt R

This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessFRA unsignedInt R

This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessRPA unsignedInt R

This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessTIGA unsignedInt R

This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LOSS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LORS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
UAS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXUC unsignedInt R

This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXTX unsignedInt R

This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessBSW unsignedInt R

This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessSRA unsignedInt R

This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessFRA unsignedInt R

This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessRPA unsignedInt R

This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessTIGA unsignedInt R

This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LOSS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LORS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
UAS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXUC unsignedInt R

This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXTX unsignedInt R

This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessBSW unsignedInt R

This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessSRA unsignedInt R

This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessFRA unsignedInt R

This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessRPA unsignedInt R

This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessTIGA unsignedInt R

This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LOSS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LORS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
UAS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXUC unsignedInt R

This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXTX unsignedInt R

This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessBSW unsignedInt R

This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessSRA unsignedInt R

This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessFRA unsignedInt R

This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessRPA unsignedInt R

This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessTIGA unsignedInt R

This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

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

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
SeverelyErroredSecs unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LOSS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
LORS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
UAS unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXUC unsignedInt R

This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
RTXTX unsignedInt R

This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessBSW unsignedInt R

This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessSRA unsignedInt R

This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessFRA unsignedInt R

This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessRPA unsignedInt R

This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SuccessTIGA unsignedInt R

This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2].

Active Notification requests for this parameter MAY be denied.

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

Reports the number of sub-carriers in any one sub-carrier group used to represent the downstream SNR(f) values. Valid values are 1, 2, 4, and 8. Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.2 ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRGus unsignedInt R

Reports the number of sub-carriers in any one sub-carrier group used to represent the upstream SNR(f) values. Valid values are 1, 2, 4, and 8. Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.5 ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRpsds int[](:2047) R

Comma-separated list (maximum number of characters 2047) of integers. Reports the downstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. [G.9701]. Note: See clause 7.10.8.3 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRpsus string[](:2047) R

Comma-separated list (maximum number of characters 2047) of strings. Reports the upstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. [G.9701]. Note: See clause 7.10.8.6 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRMTds unsignedInt R

Reports the number of symbols used to measure the downstream SNR(f) values. The valid values 0..65535. Note: See clause 7.10.8.1 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
SNRMTus unsignedInt R

Reports the number of symbols used to measure the upstream SNR(f) values. The valid values 0..65535. Note: See clause 7.10.8.4 of ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
ACTINP unsignedInt R

Reports the actual INP against SHINE as defined in clause 11.4.1.1.7/[G.9701]. A special value indicates an actual INP against SHINE of 2047 symbols or higher. The valid values are 0..2046 and 2047 is the special value. Note: See ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
NFEC unsignedInt R

Reports the DTU FEC codeword length (expressed in 1 byte unit) as defined in clause 9.3/[G.9701]. The valid range is 32..255. Note: See clause 7.11.4.1 ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
RFEC int R

Reports the DTU FEC codeword redundancy as defined in clause 9.3/[G.9701]. Note: See ITU-T Recommendation [G.997.2].

Active Notification requests for this parameter MAY be denied.

 - 2.11
UpstreamCurrRate unsignedInt R

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701]. The current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

Active Notification requests for this parameter MAY be denied.

 - 2.11
DownstreamCurrRate unsignedInt R

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701]. The current physical layer aggregate data rate (expressed in Kbps) of the downstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

Active Notification requests for this parameter MAY be denied.

 - 2.11
ACTINPREIN unsignedInt R

Reports the actual INP against REIN as defined in clause 11.4.1.1.8/[G.9701]. A special value indicates an actual INP against REIN of 63 symbols or higher. The valid range is 0..62 symbols, and 63 is the special value.

Active Notification requests for this parameter MAY be denied.

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

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

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

 - 2.4
Enable boolean W Enables or disables the optical interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.4
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.4
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.4
Name string(:64) R The textual name of the optical interface as assigned by the CPE. - 2.4
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.4
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.4
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.4
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.4
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.4
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.4
TransmitOpticalLevel int R Current measurement of mean optical launch power. [Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. Valid values are -127.5 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.4
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.4
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.4
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.4
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.4
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.4
PacketsSent unsignedLong R

The total number of packets transmitted out of the interface.

Active Notification requests for this parameter MAY be denied.

 - 2.4
PacketsReceived unsignedLong R

The total number of packets received on the interface.

Active Notification requests for this parameter MAY be denied.

 - 2.4
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.4
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.4
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.4
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.4
Device.Cellular. object R This object models cellular interfaces and access points. - 2.8
RoamingEnabled boolean W Enables or disables roaming. - 2.8
RoamingStatus string R

Current roaming status.

Enumeration of:

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

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

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

 - 2.8
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.8
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.8
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.8
Name string(:64) R The textual name of the interface as assigned by the CPE. - 2.8
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.8
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.8
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.8
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.8
SupportedAccessTechnologies string[] R

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

Each list item is an enumeration of:

  • GPRS (GSM with GPRS)
  • EDGE (GSM with EDGE)
  • UMTS
  • UMTSHSPA (UMTS with High Speed Packet Access (HSPA [3GPP-HSPA]))
  • CDMA2000OneX
  • CDMA2000HRPD
  • LTE
 - 2.8
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.8
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.8
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.8
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.8
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.8
RSSI int R

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

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
UpstreamMaxBitRate unsignedInt R The current maximum attainable data rate upstream (expressed in Kbps). - 2.8
DownstreamMaxBitRate unsignedInt R The current maximum attainable data rate downstream (expressed in Kbps). - 2.8
Device.Cellular.Interface.{i}.USIM. object R USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
PacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
PacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
Enable boolean W Enables or disables the Access Point. - 2.8
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.8
APN string(:64) W Access Point Name. - 2.8
Username string(:256) W Username used to authenticate the CPE when making a connection to the Access Point. - 2.8
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.8
Proxy string(:45) W [IPAddress] Proxy server IP address. - 2.8
ProxyPort unsignedInt(1:65535) W Proxy server port. - 2.8
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.8
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

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

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 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 FAST.Line., 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.4
LAGNumberOfEntries unsignedInt R The number of entries in the LAG table. - 2.12
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.7
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.8
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.8
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.7
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.4
Enable boolean W Enables or disables this instance. false 2.4
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.4
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.4
Name string(:64) R The textual name of the RMONStats entry as assigned by the CPE. - 2.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
Device.Ethernet.LAG.{i}. object(0:) W

Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Link Aggregation Sub-Layer as defined in [802.3-2015] and [802.1AX-2014]. It is expected that a LAG interface can only be stacked above Ethernet.Interface interfaces. The CPE can reject creation of additional LAG instances if this would exceed its capabilities.

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.12
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
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.12
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.12
Name string(:64) R

The textual name of the LAG interface as assigned by the CPE.

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

 - 2.12
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.12
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]. LowerLayers must reference to Device.Ethernet.Interface instances where Link Aggregation Group is configured by the CPE. For example, “Device.Ethernet.Interface.1, Device.Ethernet.Interface.2” - 2.12
MACAddress string(:17) W [MACAddress] MAC address of the Link Aggregation Interface. - 2.12
Device.Ethernet.LAG.{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.12
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.12
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.12
PacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.12
PacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.12
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.12
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

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

Active Notification requests for this parameter MAY be denied.

 - 2.12
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.12
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.12
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.12
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.12
UnknownProtoPacketsReceived unsignedInt R

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • 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)

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_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)
 - 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

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

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_SampleIntervalTooSmall (READONLY)
 - 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.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.Ghn. object R G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.4
Device.Ghn.Interface.{i}. object(0:) R

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

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

 - 2.4
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.4
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.4
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.4
Name string(:64) R The textual name of the interface as assigned by the CPE. - 2.4
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.4
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.4
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.4
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.4
FirmwareVersion string(:64) R The firmware version of the interface. - 2.4
ConnectionType string R

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

Enumeration of:

  • Powerline
  • Phone
  • Coax
 - 2.4
MaxTransmitRate unsignedInt R The maximum PHY data rate that the interface is capable of transmitting (expressed in Mbps). - 2.8
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.4
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.4
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.4
DomainId unsignedInt R The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.4
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.4
MaxBitRate unsignedInt R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.4
NodeTypeDMCapable boolean R Indicates whether this interface has the capability to act as Domain Master in the G.hn domain. - 2.4
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.8
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.8
NodeTypeSCCapable boolean R Indicates whether this interface has the capability to act as Security Controller in the G.hn domain. - 2.4
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.8
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.8
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.8
MaxBandPlan unsignedInt R The largest bandplan that the interface can support, as defined in [Clause 8.8.5.5/G.9961]. - 2.8
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.8
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.8
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.8
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.8
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.8
SMMaskedBandNumberOfEntries unsignedInt R The number of entries in the SMMaskedBand table. - 2.8
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.4
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.4
NodeTypeSCStatus boolean R Indicates whether the interface is acting as Security Controller (true) or not (false). - 2.4
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.4
PSM unsignedInt[2:2][2:32] W Specifies the list of PSD shaping mask (PSM) breakpoints to be applied to the G.hn interface. Comma-separated list (2 to 32 items) of PSMBreak Point Index And Levels, with each list item consisting of:. [PSMBreakPointIndexAndLevel] 1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  1. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz. Both values are represented as unsignedInt. [Clause 5.2/G.9964] defines limits on PSM breakpoint levels. The PSM level is 0.1*(the value of the level of the PSM) - 140 dBm/Hz. For example, a PSM defined by two breakpoints (subcarrier 450, PSM level -80 dBm/Hz) and (subcarrier 1050, PSM level -90 dBm/Hz) is represented by PSM [450,600],[1050,500] .
 - 2.12
Device.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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.4
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.8
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.8
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.8
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.8
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.8
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.8
BlocksResent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
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.8
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.4
MACAddress string(:17) R [MACAddress] MAC address of remote G.hn device. This is denoted as REGID in [G.9961]. - 2.4
DeviceId unsignedInt R Device Id (as defined in G.hn) for the remote G.hn device, denoted as DEVICE_ID in [G.9961]. - 2.4
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.4
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.4
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.4
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.8
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.8
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.8
DomainId unsignedInt R The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.8
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.8
SCDeviceId unsignedInt W The DEVICE_ID of the Security Controller selected by the Domain Master. - 2.8
SCMACAddress string(:17) W [MACAddress] The REGID of the Security Controller selected by the Domain Master. - 2.8
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.8
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.8
MinSupportedBandplan unsignedInt W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.8
MaxSupportedBandplan unsignedInt W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.8
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.8
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.8
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.8
MICSize string W

The selected MIC size used in the domain.

Enumeration of:

  • 4-byte MIC
  • 8-byte MIC
  • 16-byte MIC
 - 2.8
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.8
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.8
Enable boolean W Enables or disables the SMMaskedBand. - 2.8
BandNumber unsignedInt W The masked band number. - 2.8
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.8
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.8
Device.Ghn.Diagnostics. object R The G.hn Diagnostics object. - 2.8
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.8
DiagnosticsState string W

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

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
 - 2.8
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.8
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.8
PHYThroughputResultNumberOfEntries unsignedInt R The number of entries in the Result table. - 2.8
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.8
DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.8
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.8
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.8
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.8
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.8
DiagnosticsState string W

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

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
 - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
BlocksResent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
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.8
Device.Ghn.Diagnostics.PerformanceMonitoring.Channels. object R Per-channel G.hn performance monitoring results. Note: channels are unidirectional. - 2.8
TimeStamp dateTime R Time at which channel data was last collected. - 2.8
ChannelNumberOfEntries unsignedInt R The number of entries in the Channel table. - 2.8
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.8
DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.8
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.8
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) (length ) 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) (length ) 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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • 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 values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_InvalidPort (READONLY)
 - 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) (length ) 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
ResetCounter unsignedInt R [StatsCounter32] This parameter counts the number of WiFi host or driver resets since the last device reset. This parameter is reset to zero after the device resets, and increments with each successive WiFi host or driver reset. - 2.12
Reset boolean W This parameter represents a request to reset or reboot the WiFi sub-system without resetting or rebooting the device. - 2.12
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. This parameter is DEPRECATED because it gives a wrong indication for multiple SSIDs. Use the SSID.{i}.Upstream parameter instead.
 - 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
ChannelLastChange unsignedInt R

The accumulated time in seconds since the current Channel came into use.

Active Notification requests for this parameter MAY be denied.

 - 2.12
ChannelLastSelectionReason string R

The cause of the last channel selection.

Enumeration of:

  • Manual (Manual selection of the Channel)
  • Auto_Startup (Automatic channel selection procedure launched at radio startup)
  • Auto_User (Automatic channel selection procedure triggered by the user (e.g. via a GUI))
  • Auto_Refresh (Automatic channel selection procedure triggered by the AutoChannelRefreshPeriod timer)
  • Auto_Dynamic (Automatic channel selection procedure dynamically triggered to adjust to environmental interference)
  • Auto_DFS (Automatic channel selection procedure triggered by Dynamic Frequency Selection (DFS) [ETSIBRAN])
  • Unknown
 - 2.12
MaxSupportedSSIDs unsignedInt(1:) R Maximum number of SSIDs supported on this radio. - 2.12
MaxSupportedAssociations unsignedInt(1:) R Maximum number of associated devices supported. - 2.12
FirmwareVersion string(:64) R This radio’s WiFi firmware version. - 2.12
SupportedOperatingChannelBandwidths string[] R

Comma-separated list of strings. These are the valid writable values for OperatingChannelBandwidth.

Each list item is an enumeration of:

  • 20MHz
  • 40MHz (wide mode)
  • 80MHz (802.11ac only)
  • 160MHz (802.11ac only)
  • Auto
 - 2.12
OperatingChannelBandwidth string W The value MUST be a member of the list reported by the SupportedOperatingChannelBandwidths parameter. The preferred channel bandwidth to be used (applicable to 802.11n and 802.11ac specifications only). - 2.0
CurrentOperatingChannelBandwidth string R

The channel bandwidth currently in use.

Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
 - 2.11
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.8
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.8
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.8
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.8
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.8
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.8
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.8
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.8
BeaconPeriod unsignedInt W Time interval between transmitting beacons (expressed in milliseconds). This parameter is based on dot11BeaconPeriod from [802.11-2012]. - 2.8
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.8
PacketAggregationEnable boolean W This determines whether or not packet aggregation (commonly called “frame aggregation”) is enabled. This applies only to 802.11n. - 2.8
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.8
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.8
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.8
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.8
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.7
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.7
InvalidMACCount unsignedInt R The number of packets that were received with a detected invalid MAC header error. - 2.7
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.7
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.8
TotalChannelChangeCount unsignedInt R The total number of times that the Channel has changed since the WiFi.Radio entered its current operating state. - 2.12
ManualChannelChangeCount unsignedInt R The number of times that the Channel has changed due to manual channel selection since the WiFi.Radio entered its current operating state. - 2.12
AutoStartupChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure launched at radio startup since the WiFi.Radio entered its current operating state. - 2.12
AutoUserChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure triggered by the user (e.g. via a GUI) since the WiFi.Radio entered its current operating state. - 2.12
AutoRefreshChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure triggered by the AutoChannelRefreshPeriod timer since the WiFi.Radio entered its current operating state. - 2.12
AutoDynamicChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure dynamically triggered to adjust to environmental interference since the WiFi.Radio entered its current operating state. - 2.12
AutoDFSChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure triggered by DFS [ETSIBRAN] since the WiFi.Radio entered its current operating state. - 2.12
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
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces. This parameter supersedes the deprecated {{param: reference to deprecated parameter Device.WiFi.Radio.{i}.Upstream}} parameter. If both exist, the parameter {{param: reference to deprecated parameter Device.WiFi.Radio.{i}.Upstream}} is ignored.
 - 2.12
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. - 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.7
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.7
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.7
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.7
ACKFailureCount unsignedInt R The number of expected ACKs that were never received. This parameter is based on dot11ACKFailureCount from [802.11-2012]. - 2.7
AggregatedPacketCount unsignedInt R The number of aggregated packets that were transmitted. This applies only to 802.11n and 802.11ac. - 2.7
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.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.4
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.4
MACAddressControlEnabled boolean W Indicates whether or not MAC Address Control is enabled on this WiFi. MAC Address Control limits client devices to those whose hardware addresses match the AllowedMACAddress list. - 2.9
AllowedMACAddress string(:17)[] W [MACAddress] Comma-separated list of MAC Addresses. Hardware addresses of client devices that are allowed to associate with this WiFi if MACAddressControlEnabled is true. - 2.9
MaxAllowedAssociations unsignedInt W Maximum number of associated devices allowed for this SSID. If the number is reached new device connections to this access point will be rejected. If the number is changed to a value less than the actual number of associated devices, new device connections will be rejected until the number of devices is below this number. It is not expected that any connections are dropped. If the parameter Radio.{i}.MaxSupportedAssociations exists, the value MUST be less than or equal to the maximum number specified in Radio.{i}.MaxSupportedAssociations. - 2.12
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
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.5
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.5
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.5
MFPConfig string W

Management Frame Protection configuration applicable when ModeEnabled is set to WPA2-Personal or WPA2-Enterprise.

Enumeration of:

  • Disabled
  • Optional
  • Required
 Disabled 2.11
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 , KeyPassphrase and WPS.PIN (if applicable). 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.4
Device.WiFi.AccessPoint.{i}.WPS. object R {{div: unexpected argument WPSv2.0 after: [classes()], [’This object contains parameters related to Wi-Fi Protected Setup for this access point (as specified in ‘, bibref(WPSv1.0), ’ or {bibref’]}}).}} - 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. WPS configuration methods supported by the device. Each list item is an enumeration of:

  • USBFlashDrive
  • Ethernet
  • Label
  • Display
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN
  • PhysicalPushButton
  • PhysicalDisplay
  • VirtualPushButton
  • VirtualDisplay This parameter corresponds directly to the “Config Methods” attribute of [WPS 2.0]. The USBFlashDrive and Ethernet are only applicable in WPS 1.0 and are deprecated in WPS 2.x. The PhysicalPushButton, VirtualPushButton, PhysicalDisplay and VirtualDisplay are applicable to WPS 2.x only.
 - 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
Status string R

{{list: parameter is not a list}} Indicates the current status of WPS. If the device goes to SetupLocked the WPS needs to be disabled and re-enabled to come out of state.

Enumeration of:

  • Disabled
  • Error
  • Unconfigured
  • Configured
  • SetupLocked
 - 2.11
Version string R The Wi-Fi Simple Configuration version supported by the device, a string of the form m.n where m is the major version and n is the minor version. For example, a value of 1.0 denotes WSC 1.0 and a value of 2.0 denotes WSC 2.0. - 2.11
PIN string(:8) W

Represents the Device PIN used for PIN based pairing between WPS peers. This PIN is either a four digit number or an eight digit number. When read, this parameter returns an empty string, regardless of the actual value.

Possible patterns:

  • \d{4}|\d{8}
 - 2.11
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
OperatingStandard string R

The operating standard that this associated device is connected with.

Enumeration of:

 - 2.10
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:) 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:) 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
AssociationTime dateTime R Date and time in UTC when the device was associated - 2.12
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
Noise int(-200:0) R An indicator of radio noise on 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 (see ANPI definition in [Clause 10.11.9.4/802.11-2012]) - 2.12
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.8
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the Associated Device, including framing characters. - 2.8
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the Associated Device, including framing characters. - 2.8
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.8
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received from the Associated Device. - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
AccessCategory string R

This identifies the access category.

Enumeration of:

  • BE
  • BK
  • VI
  • VO
 - 2.8
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.8
AIFSN unsignedInt(2:15) W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 2.8
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.8
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.8
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.8
AckPolicy boolean W Ack Policy, where False=“Do Not Acknowledge” and True=“Acknowledge” - 2.8
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.8
OutQLenHistogramSampleInterval unsignedInt W The time between recording samples of the current transmit queue in seconds. - 2.8
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.8
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted in this access category, including framing characters. - 2.8
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received in this access category, including framing characters. - 2.8
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted in this access category. - 2.8
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received in this access category. - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
Device.WiFi.AccessPoint.{i}.Accounting. object R This object contains the parameters related to RADIUS accounting functionality for the access point. - 2.5
Enable boolean W Enables or disables accounting functionality for the access point. - 2.5
ServerIPAddr string(:45) W [IPAddress] The IP Address of the RADIUS accounting server. - 2.5
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.5
ServerPort unsignedInt W The port number of the RADIUS server used for accounting. The default port is 1813 as defined in [RFC2866]. 1813 2.5
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.5
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.5
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.5
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.5
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
MFPConfig string W

Management Frame Protection configuration applicable when ModeEnabled is set to WPA2-Personal or WPA2-Enterprise.

Enumeration of:

  • Disabled
  • Optional
  • Required
 Disabled 2.11
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. WPS configuration methods supported by the device. Each list item is an enumeration of:

  • USBFlashDrive
  • Ethernet
  • Label
  • Display
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN
  • PhysicalPushButton
  • PhysicalDisplay
  • VirtualPushButton
  • VirtualDisplay This parameter corresponds directly to the “Config Methods” attribute of [WPS 2.0]. The USBFlashDrive and Ethernet are only applicable in WPS 1.0 and are deprecated in WPS 2.x. The PhysicalPushButton, VirtualPushButton, PhysicalDisplay and VirtualDisplay are applicable to WPS 2.x only.
 - 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
Status string R

{{list: parameter is not a list}} Indicates the current status of WPS in EndPoint.

Enumeration of:

  • Disabled
  • Error
  • Unconfigured
  • Configured
 - 2.11
Version string R The Wi-Fi Simple Configuration version supported by the device, a string of the form m.n where m is the major version and n is the minor version. For example, a value of 1.0 denotes WSC 1.0 and a value of 2.0 denotes WSC 2.0. - 2.11
PIN unsignedInt(4,8) W Represents the Device PIN used for PIN based pairing between WPS peers. This PIN is either a four digit number or an eight digit number. When read, this parameter returns 0, regardless of the actual value. - 2.11
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.8
AccessCategory string R

This identifies the access category.

Enumeration of:

  • BE
  • BK
  • VI
  • VO
 - 2.8
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.8
AIFSN unsignedInt(2:15) W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 2.8
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.8
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.8
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.8
AckPolicy boolean W Ack Policy, where False=“Do Not Acknowledge” and True=“Acknowledge” - 2.8
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.8
OutQLenHistogramSampleInterval unsignedInt W The time between recording samples of the current transmit queue seconds. - 2.8
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.8
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted in this access category, including framing characters. - 2.8
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received in this access category, including framing characters. - 2.8
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted in this access category. - 2.8
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received in this access category. - 2.8
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.8
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.8
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.8
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.8
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.8
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.8
Device.WiFi.NeighboringWiFiDiagnostic. object R This object defines access to other WiFi SSIDs that this device is able to receive. - 2.7
DiagnosticsState string W

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

Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Completed (READONLY, DEPRECATED)
 - 2.7
ResultNumberOfEntries unsignedInt R The number of entries in the Result table. - 2.7
Device.ZigBee. object R Top level object for ZigBee capabilities based on the [ZigBee2007] specification. - 2.7
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.7
ZDONumberOfEntries unsignedInt R The number of entries in the ZDO table. - 2.7
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.7
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.7
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.7
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.7
Name string(:64) R The textual name of the interface as assigned by the CPE. - 2.7
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.7
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.7
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.7
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.7
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.7
AssociatedDeviceNumberOfEntries unsignedInt R The number of entries in the AssociatedDevice table. - 2.7
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.7
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.7
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.7
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.7
PacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
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.7
NetworkAddress string(:4) R [ZigBeeNetworkAddress] The ZigBee network address assigned to this device. - 2.7
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.7
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.7
Device.ZigBee.ZDO.{i}. object(0:) R ZigBee Device Object (ZDO) provides management capabilities of the ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee Device as defined in [Section 2.5/ZigBee2007]. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is “FF:FF:FF:FF:FF:FF:FF:FF” and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more ZDO instances have the same key value the implemenation is undefined - 2.7
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.7
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.7
NetworkAddress string(:4) R [ZigBeeNetworkAddress] The ZigBee network address assigned to this device. - 2.7
BindingTableNumberOfEntries unsignedInt R The number of entries in the Binding table. - 2.7
GroupNumberOfEntries unsignedInt R The number of entries in the Group table. - 2.7
ApplicationEndpointNumberOfEntries unsignedInt R The number of entries in the ApplicationEndpoint table. - 2.7
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.7
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.7
ComplexDescriptorSupported boolean R When true, specifies that the ComplexDescriptor object is supported for this ZigBee device. - 2.7
UserDescriptorSupported boolean R When true, specifies that the UserDescriptor object is supported for this ZigBee device. - 2.7
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.7
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.7
ManufactureCode unsignedInt(:65535) R Specifies a manufacturer code that is allocated by the ZigBee Alliance, relating the manufacturer to the device. - 2.7
MaximumBufferSize unsignedInt(:128) R Specifies the maximum buffer size, in octets, of the network sub-layer data unit (NSDU) for this ZigBee device. - 2.7
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.7
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.7
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.7
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.7
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.7
CurrentPowerMode string R

Specifies the current sleep/power-saving mode of the ZigBee device. Enumeration of:

  • Synchronized
  • Periodic
  • Manual
 - 2.7
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.7
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.7
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.7
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.7
DescriptorAvailable boolean R When true, the User Descriptor recorded has been received from the target device. - 2.7
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.7
Device.ZigBee.ZDO.{i}.ComplexDescriptor. object R The ComplexDescriptor object is an optional descriptor that describes extended capabilities of the ZigBee device as defined in [Section 2.3.2.6 Complex Descriptor/ZigBee2007]. - 2.7
DescriptorAvailable boolean R When true, the Complex Descriptor recorded has been received from the target device. - 2.7
Language string R Specifies the ISO 639-1 language code as defined in [ISO639-1]. - 2.7
CharacterSet string R Specifies the ISO 646 character set as defined in [ISO646-1991]. - 2.7
ManufacturerName string R Specifies the name of the manufacturer of the ZigBee device. - 2.7
ModelName string R Specifies the name of the manufacturer’s model of the ZigBee device. - 2.7
SerialNumber string R Specifies the manufacturer’s serial number of the ZigBee device. - 2.7
DeviceURL string R Specifies the URL through which more information relating to the ZigBee device can be obtained. - 2.7
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.7
IconURL string R Specifies the URL through which the icon for the ZigBee device can be obtained. - 2.7
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.7
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.7
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.7
TimeOutPeriod unsignedInt(:65535) R The period of time, in milliseconds, that this ZigBee device will wait for an expected security protocol frame. - 2.7
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.7
NeighborNumberOfEntries unsignedInt R The number of entries in the Neighbor table. - 2.7
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.7
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.7
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.7
Relationship string R

The relationship between the neighbor and this device. Enumeration of:

  • Parent
  • Child
  • PrevChild
  • Sibling
  • None
 - 2.7
PermitJoin string R

An indication of whether the neighbor device is accepting join requests. Enumeration of:

  • Accepting
  • NotAccepting
  • Unknown
 - 2.7
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.7
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.7
RoutingTableNumberOfEntries unsignedInt R The number of entries in the RoutingTable table. - 2.7
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.7
DestinationAddress string(:4) R

The ZigBee network address of this route.

Possible patterns:

  • ([0-9A-Fa-f]){4}
 - 2.7
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.7
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.7
MemoryConstrained boolean R A flag indicating whether the device is a memory constrained concentrator. - 2.7
ManyToOne boolean R A flag indicating that the destination is a concentrator that issued a many to-one request. - 2.7
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.7
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.7
Enable boolean W Enables or disables the use of this binding on the device. - 2.7
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.7
SourceEndpoint unsignedInt(:240) W Specifies the source endpoint used in this binding entry. - 2.7
SourceAddress string(:23) W [IEEE_EUI64] Specifies the source address used in this binding entry. - 2.7
ClusterId unsignedInt(:65535) W Specifies the cluster identifier used in this binding entry. - 2.7
DestinationAddressMode string W

Specifies the type of destination address used for this binding entry. Enumeration of:

  • Group
  • Endpoint
 - 2.7
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.7
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.7
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.7
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.7
Enable boolean W Enables or disables the use of this group on the device. - 2.7
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.7
GroupId string(:4) W [ZigBeeNetworkAddress] The Group Identifier for this object as defined in [Table 2.25 Group Table Entry Format/ZigBee2007]. - 2.7
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.7
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.7
Enable boolean W Enables or disables the use of this application endpoint on the device. - 2.7
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.7
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.7
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.7
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.7
DeviceId unsignedInt(:65535) R Application device identifier, as defined in [Section 2.3.2.5.3 Application Device Identifier Field/ZigBee2007]. - 2.7
DeviceVersion unsignedInt(:15) R Application device version, as defined in [Section 2.3.2.5.4 Application Device Version Field/ZigBee2007]. - 2.7
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.7
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.7
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.7
AreaNetworkNumberOfEntries unsignedInt R The number of entries in the AreaNetwork table. - 2.7
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.7
Enable boolean W Enables or disables discovery of the ZigBee devices in this AreaNetwork. - 2.7
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.7
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.7
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.7
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.7
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.7
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.7
Device.Bridging. object R Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. - 2.0
MaxBridgeEntries unsignedInt R The maximum number of entries available in the Bridging.Bridge table. - 2.0
MaxDBridgeEntries unsignedInt R The maximum number of 802.1D [802.1D-2004] entries available in the Bridging.Bridge table. A positive value for this parameter implies support for 802.1D. There is no guarantee that this many 802.1D Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges. - 2.0
MaxQBridgeEntries unsignedInt R The maximum number of 802.1Q [802.1Q-2011] entries available in the Bridging.Bridge table. A non-zero value for this parameter implies support for 802.1Q. There is no guarantee that this many 802.1Q Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges. - 2.0
MaxVLANEntries unsignedInt R The maximum number of 802.1Q [802.1Q-2011] VLANs supported per Bridging.Bridge table entry. - 2.0
MaxProviderBridgeEntries unsignedInt R The maximum number of entries available in the Bridging.ProviderBridge table. A non-zero value for this parameter implies support for 802.1Q Provider Bridges. - 2.7
ProviderBridgeNumberOfEntries unsignedInt R The number of entries in the ProviderBridge table. - 2.7
MaxFilterEntries unsignedInt R

The maximum number of entries available in the Filter table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
BridgeNumberOfEntries unsignedInt R The number of entries in the Bridge table. - 2.0
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.0
Device.Bridging.Bridge.{i}. object(0:) W

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

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

The status of this Bridge. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
Standard string W

Selects the standard supported by this Bridge table entry.

Enumeration of:

 - 2.0
PortNumberOfEntries unsignedInt R The number of entries in the Port table. - 2.0
VLANNumberOfEntries unsignedInt R The number of entries in the VLAN table. - 2.0
VLANPortNumberOfEntries unsignedInt R The number of entries in the VLANPort table. - 2.0
Device.Bridging.Bridge.{i}.Port.{i}. object(0:) W

Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance.

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 bridge port. This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then this parameter SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then this parameter 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 bridge port 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 bridge port 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]. When ManagementPort is set to true the CPE MUST set LowerLayers to reference all non-management bridge ports that are within the same Bridge instance (and update LowerLayers when subsequent non-management bridge ports are added or deleted on that Bridge). The ACS SHOULD NOT set LowerLayers in this case. <Empty> 2.0
ManagementPort boolean W If true then the entry is a management (upward facing) bridge port rather than a non-management (downward facing) bridge port. For a given Bridge instance, each management bridge port appears in the interface stack above all non-management bridge ports. The concept of Management Port is discussed in [Chapter 8/802.1Q-2005]. false 2.0
Type string W

The type of bridge port as defined in 802.1Q [Section 17 IEEE8021BridgePortType/802.1Q-2011]. Enumeration of: Enumeration of:

  • ProviderNetworkPort (Indicates this Port is an S-TAG aware port of a ProviderBridge)
  • CustomerNetworkPort (Indicates this Port is an S-TAG aware port of a ProviderBridge)
  • CustomerEdgePort (Indicates this Port is an C-TAG aware port of a ProviderBridge)
  • CustomerVLANPort (Indicates this Port is an C-TAG aware port of a Customer Bridge)
  • VLANUnawarePort (Indicates this Port is a VLAN unaware member of an 802.1D-2004 bridge)
 - 2.7
DefaultUserPriority unsignedInt(0:7) W Bridge Port Default User Priority. - 2.0
PriorityRegeneration unsignedInt(0:7)[8:8]() W Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent user priority regeneration values for each ingress user priority on this Bridge Port. 0,1,2,3,4,5,6,7 2.0
PortState string R

Bridge Port state as defined in 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011].

Enumeration of:

  • Disabled
  • Blocking
  • Listening
  • Learning
  • Forwarding
  • Broken
 Disabled 2.0
PVID int(1:4094) W PVID (or Port VID) is the VLAN ID with which an untagged or priority tagged frame that arrives on this port will be associated (i.e. default Port VLAN ID as defined in 802.1Q [802.1Q-2011]). For an 802.1D Bridge [802.1D-2004], this parameter MUST be ignored. 1 2.0
TPID unsignedInt W The Tag Protocol Identifier (TPID) assigned to this Port. 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.7
AcceptableFrameTypes string W

Indicates which types of frame arriving on this port will be admitted to the bridge (i.e. Bridge Port acceptable frame types as defined in 802.1Q [802.1Q-2011]). Enumeration of:

  • AdmitAll
  • AdmitOnlyVLANTagged (OPTIONAL)
  • AdmitOnlyPrioUntagged (OPTIONAL) For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be AdmitAll.
 AdmitAll 2.0
IngressFiltering boolean W Enables or disables Ingress Filtering as defined in 802.1Q [802.1Q-2011]. If enabled (true), causes frames arriving on this port to be discarded if the port is not in the VLAN ID’s member set (which is configured via the VLANPort table). For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be false. false 2.0
ServiceAccessPrioritySelection boolean W This parameter controls the Service Access Priority selection function as described in [Section 6.13/802.1Q-2011]. The parameter is applicable to deployments of Bridge instances that are referenced by Bridging.ProviderBridge.{i}.SVLANcomponent. false 2.7
ServiceAccessPriorityTranslation unsignedInt(0:7)[8:8]() W Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent service access priority translation values for each ingress priority on this Port as described in [Section 6.13/802.1Q-2011]. The parameter is applicable to deployments of Bridge instances that are referenced by Bridging.ProviderBridge.{i}.SVLANcomponent. 0,1,2,3,4,5,6,7 2.7
PriorityTagging boolean W Enables or disables priority tagging on this Bridge Port. 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. When false, egress frames leaving this interface will be untagged. The parameter does not affect reception of ingress frames. Only applies on bridge ports that are untagged member of one or more VLAN’s. false 2.0
Device.Bridging.Bridge.{i}.Port.{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.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. object R PriorityCodePoint provides the management control for the processing of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011]. The object is applicable to deployments of Bridging.ProviderBridge where the Bridge instance is referenced by Bridging.ProviderBridge.{i}.SVLANcomponent or Bridging.ProviderBridge.{i}.CVLANcomponents parameters. - 2.7
PCPSelection unsignedInt(1:4) W This parameter identifies the row in the PCPEncoding and PCPDecoding parameter lists. The value of 1 points to the 8P0D row in the corresponding parameter lists. 1 2.7
UseDEI boolean W This parameter controls the processing of the drop_eligible field and is described in [Section 6.9.3/802.1Q-2011]. false 2.7
RequireDropEncoding boolean W This parameter controls the processing of the encoding or decoding of the drop_eligible component in the PCP field and is described in [Section 8.6.7/802.1Q-2011]. false 2.7
PCPEncoding string(31)[4:4]() W

Comma-separated list (4 items) (length ) of strings (length 31). This parameter provides the management control for the processing of the encoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-3/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: “8P0D”,“7P1D”, “6P2D” “5P3D”. Each list entry matches the following pattern:

Each list item matches one of:

  • ([0-7],){15}[0-7] (PCP for each priority and drop_eligible field (7, 7DE, 6, 6DE, …, 1, 1DE, 0, 0DE)) The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-3 (mentioned above):
[7,7,6,6,5,5,4,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,0,1,0]
 - 2.7
PCPDecoding string(15)[4:4]() W

Comma-separated list (4 items) (length ) of strings (length 15). This parameter provides the management control for the processing of the decoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-4/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: “8P0D”,“7P1D”, “6P2D” “5P3D”. Each list entry matches the following pattern:

Each list item matches one of:

  • ([0-7],[0-1],){7}[0-7],[0-1] (Priority (0-7) and drop_eligible field (0-1) for each PCP value (7, 6, …, 1, 0)) The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-4 (mentioned above):
[7,0,6,0,5,0,4,0,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,0,0,0,1]
 - 2.7
Device.Bridging.Bridge.{i}.VLAN.{i}. object(0:) W

Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge. This table only applies to an 802.1Q [802.1Q-2011] Bridge.

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

 - 2.0
Enable boolean W Enables or disables this VLAN table 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
Name string(:64) W Human-readable name for this VLAN table entry. <Empty> 2.0
VLANID int(1:4094) W VLAN ID of the entry. - 2.0
Device.Bridging.Bridge.{i}.VLANPort.{i}. object(0:) W

Bridge VLAN egress port and untagged port membership table. This table only applies to an 802.1Q [802.1Q-2011] Bridge. Note: The VLANPort 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 VLANPort row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending VLANPort row.

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

 - 2.0
Enable boolean W Enables or disables this VLANPort 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
VLAN string(:256) W The value MUST be the Path Name of a row in the VLAN. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the VLAN for which port membership is expressed. <Empty> 2.0
Port string(:256) W 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. Specifies the bridge port that is member of the VLAN. <Empty> 2.0
Untagged boolean W Enables or disables untagged port membership to the VLAN and determines whether egress frames for this VLAN are sent untagged or tagged. - 2.0
Device.Bridging.Filter.{i}. object(0:) W

Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance. Bridge VLAN classification only applies for 802.1Q [802.1Q-2011] Bridges. For enabled table entries, if Bridge or Interface is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Several of this object’s parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as filter criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType 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 this Filter table 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
Status string R

The status of this Filter table 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. If the Bridge Port table is supported, but none of its entries correspond to Interface, or if such an entry exists but is disabled, Status MUST NOT indicate Enabled. If the Bridge VLAN table is supported, but none of its entries correspond to VLANIDFilter, or if such an entry exists but is disabled, Status MUST NOT indicate Enabled.
 Disabled 2.0
Bridge string(:256) W The value MUST be the Path Name of a Bridging.Bridge object in case of a 802.1D bridge or a Bridging.Bridge.{i}.VLAN object in case of a 802.1Q bridge. If the referenced object is deleted, the parameter value MUST be set to an empty string. Note: either way, this identifies the bridge (because each bridge has a VLAN table). Defines the Bridge or Bridge VLAN to which ingress frames will be classified based upon matches of the classification criteria. <Empty> 2.0
Order unsignedInt(1:) W Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each ingress frame on the Interface, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the Bridge.{i}.Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This MUST relate to the same bridge as does Bridge. Defines the Bridge Port on which ingress frame classification will occur. <Empty> 2.0
DHCPType string W

The DHCP protocol associated with the Filter instance. Affects only parameters that specify DHCP option values as filter criteria (all such parameter descriptions note this fact). Enumeration of:

  • DHCPv4
  • DHCPv6 If DHCPType is DHCPv4, then Filter parameters that are DHCPv6-specific are ignored. If DHCPType is DHCPv6, then Filter parameters that are DHCPv4-specific are ignored.
 DHCPv4 2.2
VLANIDFilter unsignedInt(0:4094) W Classification criterion. The 802.1Q [802.1Q-2011] VLAN ID. For an 802.1D [802.1D-2004] Bridge, which has no concept of VLANs, the VLAN ID MUST be 0. 0 2.0
EthertypeFilterList unsignedInt[](:256) W Classification criterion. Comma-separated list (maximum number of characters 256) of unsigned integers. Each list item represents an Ethertype value. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on Ethertype. <Empty> 2.0
EthertypeFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit only those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit all packets except those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, packets are admitted regardless of Ethertype. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on Ethertype. true 2.0
SourceMACAddressFilterList string[](:512) W Classification criterion. Comma-separated list (maximum number of characters 512) of strings, each representing a MAC Address. Each list entry MAY optionally specify a bit-mask, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. <Empty> 2.0
SourceMACAddressFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. true 2.0
DestMACAddressFilterList string[](:512) W Classification criterion. Comma-separated list (maximum number of characters 512) of strings. Each list item specifies a MAC Address. List items MAY optionally specify a bit-mask after the MAC Address, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 <Empty> 2.0
DestMACAddressFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, packets are admitted regardless of MAC address. true 2.0
SourceMACFromVendorClassIDFilter string(:255) W Classification criterion. A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCPv4 Vendor Class Identifier (Option 60 as defined in [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in SourceMACFromVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. <Empty> 2.0
SourceMACFromVendorClassIDFilterv6 hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in [RFC3315]) was equal to the specified value. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. <Empty> 2.2
SourceMACFromVendorClassIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromVendorClassIDFilter (for DHCPv4) or SourceMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromVendorClassIDFilter (for DHCPv4) or SourceMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address true 2.0
SourceMACFromVendorClassIDMode string W

SourceMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

 Exact 2.0
DestMACFromVendorClassIDFilter string(:255) W Classification criterion. A string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCPv4 Vendor Class Identifier (Option 60 as defined in [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in DestMACFromVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. <Empty> 2.0
DestMACFromVendorClassIDFilterv6 hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in [RFC3315]) was equal to the specified value. The option value is binary, so an exact match is REQUIRED. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. <Empty> 2.2
DestMACFromVendorClassIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromVendorClassIDFilter (for DHCPv4) or DestMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromVendorClassIDFilter (for DHCPv4) or DestMACFromVendorClassIDFilterv6 (for DHCPv6). If this corresponding filter parameter is an empty string, packets are admitted regardless of MAC address. true 2.0
DestMACFromVendorClassIDMode string W

DestMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

 Exact 2.0
SourceMACFromClientIDFilter hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. <Empty> 2.0
SourceMACFromClientIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If SourceMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If the SourceMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. true 2.0
DestMACFromClientIDFilter hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. <Empty> 2.0
DestMACFromClientIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If DestMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If the DestMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address. true 2.0
SourceMACFromUserClassIDFilter hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. <Empty> 2.0
SourceMACFromUserClassIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If SourceMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If the SourceMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. true 2.0
DestMACFromUserClassIDFilter hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. <Empty> 2.0
DestMACFromUserClassIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If DestMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If the DestMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address. true 2.0
DestIP string(:45) W [IPAddress] Classification criterion. Destination IP address. An empty string indicates this criterion is not used for classification. <Empty> 2.6
DestMask string(:49) W [IPPrefix] Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.6
DestIPExclude boolean W If false, the class includes only those packets that match the (masked) DestIP entry, if specified. If true, the class includes all packets except those that match the (masked) DestIP entry, if specified. false 2.6
SourceIP string(:45) W [IPAddress] Classification criterion. Source IP address. An empty string indicates this criterion is not used for classification. <Empty> 2.6
SourceMask string(:49) W [IPPrefix] Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.6
SourceIPExclude boolean W If false, the class includes only those packets that match the (masked) SourceIP entry, if specified. If true, the class includes all packets except those that match the (masked) SourceIP entry, if specified. false 2.6
Protocol int(-1:255) W Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. -1 2.6
ProtocolExclude boolean W If false, the class includes only those packets that match the Protocol entry, if specified. If true, the class includes all packets except those that match the Protocol entry, if specified. false 2.6
DestPort int(-1:65535) W Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. -1 2.6
DestPortRangeMax int(-1:65535) W Classification criterion. If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. -1 2.6
DestPortExclude boolean W If false, the class includes only those packets that match the DestPort entry (or port range), if specified. If true, the class includes all packets except those that match the DestPort entry (or port range), if specified. false 2.6
SourcePort int(-1:65535) W Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. -1 2.6
SourcePortRangeMax int(-1:65535) W Classification criterion. If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. -1 2.6
SourcePortExclude boolean W If false, the class includes only those packets that match the SourcePort entry (or port range), if specified. If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified. false 2.6
Device.Bridging.ProviderBridge.{i}. object(0:) W

Provider Bridge table. A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects. When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags). When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized.

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.7
Enable boolean W Enables or disables this ProviderBridge. false 2.7
Status string R

The status of this ProviderBridge. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. For example when the Type is configured with value of PE but CVLANcomponents is an empty string. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.7
Alias string(:64) W

A non-volatile handle used to reference this instance. This parameter 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.

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

 - 2.7
Type string W

Selects the standard supported by this ProviderBridge table entry.

Enumeration of:

 - 2.7
SVLANcomponent string(:256) W The value MUST be the Path Name of a Bridge instance that specifies the S-VLAN component for the ProviderBridge. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.7
CVLANcomponents 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 Bridge instance that specifies a C-VLAN component for the ProviderBridge. If the referenced object is deleted, the corresponding item MUST be removed from the list. <Empty> 2.7
Device.PPP. object R Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
SupportedNCPs string[] R

Comma-separated list of strings. The Network Control Protocols (NCPs) that are supported by the device. Each list item is an enumeration of:

 - 2.2
Device.PPP.Interface.{i}. object(0:) W

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

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

 - 2.0
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. false 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].
 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 interface 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 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]. <Empty> 2.0
Reset boolean W When set to true, the device MUST tear down the existing PPP connection represented by this object and establish a new one. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. Reset on a disabled interface is a no-op (not an error). false 2.0
ConnectionStatus string R

Current status of the connection.

Enumeration of:

  • Unconfigured
  • Connecting
  • Authenticating
  • Connected
  • PendingDisconnect
  • Disconnecting
  • Disconnected
 - 2.0
LastConnectionError string R

The cause of failure for the last connection setup attempt.

Enumeration of:

  • ERROR_NONE
  • ERROR_ISP_TIME_OUT
  • ERROR_COMMAND_ABORTED
  • ERROR_NOT_ENABLED_FOR_INTERNET
  • ERROR_BAD_PHONE_NUMBER
  • ERROR_USER_DISCONNECT
  • ERROR_ISP_DISCONNECT
  • ERROR_IDLE_DISCONNECT
  • ERROR_FORCED_DISCONNECT
  • ERROR_SERVER_OUT_OF_RESOURCES
  • ERROR_RESTRICTED_LOGON_HOURS
  • ERROR_ACCOUNT_DISABLED
  • ERROR_ACCOUNT_EXPIRED
  • ERROR_PASSWORD_EXPIRED
  • ERROR_AUTHENTICATION_FAILURE
  • ERROR_NO_DIALTONE
  • ERROR_NO_CARRIER
  • ERROR_NO_ANSWER
  • ERROR_LINE_BUSY
  • ERROR_UNSUPPORTED_BITSPERSECOND
  • ERROR_TOO_MANY_LINE_ERRORS
  • ERROR_IP_CONFIGURATION
  • ERROR_UNKNOWN
 - 2.0
AutoDisconnectTime unsignedInt W The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 2.0
IdleDisconnectTime unsignedInt W The time in seconds that if the connection remains idle, the CPE automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 2.0
WarnDisconnectDelay unsignedInt W Time in seconds the ConnectionStatus remains in the PendingDisconnect state before transitioning to disconnecting state to drop the connection. - 2.0
Username string(:64) W Username to be used for authentication. - 2.0
Password string(:64) W

Password to be used for authentication.

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

 - 2.0
EncryptionProtocol string R

Describes the PPP encryption protocol.

Enumeration of:

  • None
  • MPPE
 - 2.0
CompressionProtocol string R

Describes the PPP compression protocol.

Enumeration of:

 - 2.0
AuthenticationProtocol string R

Describes the PPP authentication protocol.

Enumeration of:

  • PAP
  • CHAP
  • MS-CHAP
 - 2.0
MaxMRUSize unsignedInt(64:65535) W The maximum allowed size of frames sent from the remote peer. 1500 2.0
CurrentMRUSize unsignedInt(64:65535) R

The current MRU in use over this connection.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ConnectionTrigger string W

Trigger used to establish the PPP connection. Enumeration of:

  • OnDemand (If this PPP connection is disconnected for any reason, it is to remain disconnected until the CPE has one or more packets to communicate over this connection, at which time the CPE automatically attempts to reestablish the connection)
  • AlwaysOn (If this PPP connection is disconnected for any reason, the CPE automatically attempts to reestablish the connection (and continues to attempt to reestablish the connection as long it remains disconnected))
  • Manual (If this PPP connection is disconnected for any reason, it is to remain disconnected until the user of the CPE explicitly instructs the CPE to reestablish the connection) Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object.
 - 2.0
LCPEcho unsignedInt R PPP LCP Echo period in seconds. - 2.0
LCPEchoRetry unsignedInt R Number of PPP LCP Echo retries within an echo period. - 2.0
IPCPEnable boolean W Enables or disables IPCP ([RFC1332]) on this interface. If this parameter is present, IPCP MUST be included in SupportedNCPs. - 2.2
IPv6CPEnable boolean W Enables or disables IPv6CP ([RFC5072]) on this interface. If this parameter is present, IPv6CP MUST be included in SupportedNCPs. - 2.2
Device.PPP.Interface.{i}.PPPoE. object(0:1) R

PPPoE object that functionally groups PPPoE related parameters. PPPoE is only applicable when the lower layer provides Ethernet frames, e.g. ATM with EoA, PTM, or anything else that supports an Ethernet MAC.

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
SessionID unsignedInt(1:) R Represents the PPPoE Session ID. - 2.0
ACName string(:256) W PPPoE Access Concentrator. - 2.0
ServiceName string(:256) W PPPoE Service Name. - 2.0
Device.PPP.Interface.{i}.IPCP. object R IP Control Protocol (IPCP) client object for this PPP interface [RFC1332]. IPCP only applies to IPv4. - 2.0
LocalIPAddress string(:45) R [IPv4Address] The local IPv4 address for this connection received via IPCP. <Empty> 2.0
RemoteIPAddress string(:45) R [IPv4Address] The remote IPv4 address for this connection received via IPCP. <Empty> 2.0
DNSServers string(:45)[:2]() R [IPv4Address] Comma-separated list (up to 2 items) (length ) of IPv4Addresses. Items represent DNS Server IPv4 address(es) received via IPCP [RFC1877]. <Empty> 2.0
PassthroughEnable boolean W If false, the PPP Interface retrieved information is configured on the IP Interface stacked on top of this PPP Interface. If true, the PPP Interface retrieved information is propagated to the parameters in the referenced PassthroughDHCPPool object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers). false 2.0
PassthroughDHCPPool string(:256) W The value MUST be the Path Name of a row in the DHCPv4.Server.Pool. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.When PassthroughDHCPPool is set to an empty string, PassthroughEnable MUST be set to false (i.e. passthrough can not be enabled without a pool reference specified). <Empty> 2.0
Device.PPP.Interface.{i}.IPv6CP. object R IPv6 Control Protocol (IPv6CP) client object for this PPP interface [RFC5072]. IPv6CP only applies to IPv6. - 2.2
LocalInterfaceIdentifier string(:45) R [IPv6Address] The interface identifier for the local end of the PPP link, negotiated using the IPv6CP Interface-Identifier option [Section 4.1/RFC5072]. The identifier is represented as the rightmost 64 bits of an IPv6 address (the leftmost 64 bits MUST be zero and MUST be ignored by the recipient). - 2.2
RemoteInterfaceIdentifier string(:45) R [IPv6Address] The interface identifier for the remote end of the PPP link, negotiated using the IPv6CP Interface-Identifier option [Section 4.1/RFC5072]. The identifier is represented as the rightmost 64 bits of an IPv6 address (the leftmost 64 bits MUST be zero and MUST be ignored by the recipient). - 2.2
Device.PPP.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.PPP.Interface.{i}.PPPoA. object(0:1) R

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

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

 - 2.2
Device.IP. object R IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
IPv4Capable boolean R Indicates whether the device is IPv4 capable. - 2.0
IPv4Enable boolean W Enables or disables the IPv4 stack, and so the use of IPv4 on the device. This affects only layer 3 and above. When false, IP interfaces that had been operationally up and passing IPv4 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv6 stack). - 2.2
IPv4Status string R

Indicates the status of the IPv4 stack. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.2
IPv6Capable boolean R Indicates whether the device is IPv6 capable. Note: If false, it is expected that IPv6-related parameters, enumeration values, etc will not be implemented by the device. - 2.2
IPv6Enable boolean W Enables or disables the IPv6 stack, and so the use of IPv6 on the device. This affects only layer 3 and above. When false, IP interfaces that had been operationally up and passing IPv6 packets will now no longer be able to do so, and will be operationally down (unless also attached to an enabled IPv4 stack). - 2.2
IPv6Status string R

Indicates the status of the IPv6 stack. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.2
ULAPrefix string(:49) W [IPv6Prefix] The ULA /48 prefix [Section 3/RFC4193]. - 2.2
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.0
ActivePortNumberOfEntries unsignedInt R The number of entries in the ActivePort table. - 2.0
Device.IP.Interface.{i}. object(0:) W

IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface. Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface’s IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables. Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the ACS to create) Interface instances of type Loopback. When the ACS administratively disables the interface, i.e. sets Enable to false, the interface’s automatically-assigned IP addresses and prefixes MAY be retained. When the ACS administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It’s up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. Any Tunneled IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces. Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects.

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 interface (regardless of IPv4Enable and IPv6Enable). This parameter is based on ifAdminStatus from [RFC2863]. false 2.0
IPv4Enable boolean W If set to true, attaches this interface to the IPv4 stack. If set to false, detaches this interface from the IPv4 stack. Once detached from the IPv4 stack, the interface will now no longer be able to pass IPv4 packets, and will be operationally down (unless also attached to an enabled IPv6 stack). For an IPv4 capable device, if IPv4Enable is not present this interface SHOULD be permanently attached to the IPv4 stack. Note that IPv4Enable is independent of Enable, and that to administratively enable an interface for IPv4 it is necessary for both Enable and IPv4Enable to be true. - 2.2
IPv6Enable boolean W If set to true, attaches this interface to the IPv6 stack. If set to false, detaches this interface from the IPv6 stack. Once detached from the IPv6 stack, the interface will now no longer be able to pass IPv6 packets, and will be operationally down (unless also attached to an enabled IPv4 stack). For an IPv6 capable device, if IPv6Enable is not present this interface SHOULD be permanently attached to the IPv6 stack. Note that IPv6Enable is independent of Enable, and that to administratively enable an interface for IPv6 it is necessary for both Enable and IPv6Enable to be true. - 2.2
ULAEnable boolean W Controls whether or not ULAs [RFC4193] are generated and used on this interface. false 2.2
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].
 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 interface 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 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]. LowerLayers MUST be an empty string and read-only when Type is Loopback, Tunnel, or Tunneled. <Empty> 2.0
Router string(:256) W The value MUST be the Path Name of a row in the Routing.Router. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Router instance that is associated with this IP Interface entry. <Empty> 2.0
Reset boolean W When set to true, the device MUST tear down the existing IP connection represented by this object and establish a new one. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. Reset on a disabled interface is a no-op (not an error). false 2.0
MaxMTUSize unsignedInt(64:65535) W The maximum transmission unit (MTU); the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. - 2.0
Type string R

IP interface type. Enumeration of:

 Normal 2.0
Loopback boolean W When set to true, the IP interface becomes a loopback interface and the CPE MUST set Type to Loopback. In this case, the CPE MUST also set LowerLayers to an empty string and fail subsequent attempts at setting LowerLayers until the interface is no longer a loopback. Support for manipulating loopback interfaces is OPTIONAL. false 2.0
IPv4AddressNumberOfEntries unsignedInt R The number of entries in the IPv4Address table. - 2.0
IPv6AddressNumberOfEntries unsignedInt R The number of entries in the IPv6Address table. - 2.2
IPv6PrefixNumberOfEntries unsignedInt R The number of entries in the IPv6Prefix table. - 2.2
AutoIPEnable boolean W If true, enables auto-IP on the interface [RFC3927]. This mechanism is only used with IPv4. When auto-IP is enabled on an interface, an IPv4Address object will dynamically be created and configured with auto-IP parameter values. The exact conditions under which an auto-IP address is created (e.g. always when enabled or only in absence of dynamic IP addressing) is implementation specific. false 2.0
TWAMPReflectorNumberOfEntries unsignedInt R The number of entries in the TWAMPReflector table. - 2.12
Device.IP.Interface.{i}.IPv4Address.{i}. object(0:) W

IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the ACS.

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

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

The status of this IPv4Address table 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.2
Alias string(:64) W

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

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

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

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
IPAddress string(:45) W [IPv4Address] IPv4 address. This parameter can only be modified if the AddressingType is Static. - 2.0
SubnetMask string(:45) W [IPv4Address] Subnet mask. This parameter can only be modified if the AddressingType is Static. <Empty> 2.0
AddressingType string R

Addressing method used to assign the IP address. Enumeration of:

  • DHCP
  • IKEv2 (Assigned by IKEv2 [RFC5996])
  • AutoIP
  • IPCP
  • Static
 Static 2.0
Device.IP.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. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. - 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. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. - 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.IP.Interface.{i}.TWAMPReflector.{i}. object(0:) W

This object contains parameters associated with the configuration that permits this interface to be used as Two-Way Active Measurement Protocol (TWAMP) reflector as defined in [TR-390].

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

 - 2.12
Enable boolean W Enables or disables the TWAMP reflector. - 2.12
Status string R

The current operational state of the TWAMP reflector.

Enumeration of:

  • Disabled
  • Active
  • Error (OPTIONAL)
 - 2.12
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.12
Port unsignedInt(:65535) W The port used to listen for the TWAMP test packets. 862 2.12
MaximumTTL unsignedInt(1:255) W The maximum TTL of a received packet that this TWAMP reflector will reflect to the TWAMP controller. 1 2.12
IPAllowedList string[](:255) W Comma-separated list (maximum number of characters 255) of strings. List items represent source IP addresses and subnets from which test packets MUST always be received. An empty string list will allow test packets to be received from any source IP address. Each entry in the list MUST be either an IP address, or an IP prefix specified using Classless Inter-Domain Routing (CIDR) notation [RFC4632]. An IP prefix is specified as an IP address followed (with no intervening white space) by “/n”, 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 prefix. IPv4 example:
  • 1.2.3.4 specifies a single IPv4 address, and 1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0.
  • 1.2.0.0/22 represents the 1024 IPv4 addresses from 1.2.0.0 to 1.2.3.255. IPv6 example:
  • fec0::220:edff:fe6a:f76 specifies a single IPv6 address.
  • 2001:edff:fe6a:f76::/64 represents the IPv6 addresses from 2001:edff:fe6a:f76:0:0:0:0 to 2001:edff:fe6a:f76:ffff:ffff:ffff:ffff.
 - 2.12
PortAllowedList string[](:255) W Comma-separated list (maximum number of characters 255) of strings. List items represent source port ranges from which test packets MUST always be received. An empty string list will allow test packets to be received from any source port. Each entry in the list MUST be either a port number or a range of port numbers separated by a hypen (-). For example, an entry with the value: ‘2-40’ accepts test packets from any allowed source IP addresses with a source port between 2 and 40 inclusive. An entry of ‘3’ accepts test packets from allow source IP addresses with a port of 3. - 2.12
Device.IP.Interface.{i}.IPv6Address.{i}. object(0:) W

This table contains the IP interface’s IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses. There are several ways in which entries can be added to and deleted from this table, including:

  • Automatically via SLAAC [RFC4862], which covers generation of link-local addresses (for all types of device) and global addresses (for non-router devices).
  • Automatically via DHCPv6 [RFC3315], which covers generation of any type of address (subject to the configured DHCP server policy).
  • Manually via a GUI or some other local management interface.
  • Manually via factory default configuration.
  • By the ACS. This table MUST NOT include entries for the Subnet-Router anycast address [Section 2.6.1/RFC4291]. Such entries would be identical to others but with a zero interface identifier, and would add no value. A loopback interface will always have address ::1 [Section 2.5.3/RFC4291] and MAY also have link-local address fe80::1. This object is based on ipAddressTable from [RFC4293].

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

 - 2.2
Enable boolean W Enables or disables this IPv6Address entry. false 2.2
Status string R

The status of this IPv6Address table 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.2
IPAddressStatus string R

The status of IPAddress, indicating whether it can be used for communication. See also PreferredLifetime and ValidLifetime. Enumeration of:

  • Preferred (Valid address that can appear as the destination or source address of a packet)
  • Deprecated (Valid but deprecated address that is not intended to be used as a source address)
  • Invalid (Invalid address that is not intended to appear as the destination or source address of a packet)
  • Inaccessible (Valid address that is not accessible because the interface to which it is assigned is not operational)
  • Unknown (Address status cannot be determined for some reason)
  • Tentative (The uniqueness of the address on the link is being verified)
  • Duplicate (Invalid address that has been determined to be non-unique on the link)
  • Optimistic (Valid address that is available for use, subject to restrictions, while its uniqueness on a link is being verified) This parameter is based on ipAddressStatus and ipAddressStatusTC from [RFC4293].
 Invalid 2.2
Alias string(:64) W

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

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

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

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.2
IPAddress string(:45) W [IPv6Address] IPv6 address. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressAddr from [RFC4293]. <Empty> 2.2
Origin string R

Mechanism via which the IP address was assigned. Enumeration of:

  • AutoConfigured (Automatically generated. For example, a link-local address as specified by SLAAC [Section 5.3/RFC4862], a global address as specified by SLAAC [Section 5.5/RFC4862], or generated via CPE logic (e.g. from delegated prefix as specified by [RFC3633]), or from ULA /48 prefix as specified by [RFC4193])
  • DHCPv6 (Assigned by DHCPv6 [RFC3315])
  • IKEv2 (Assigned by IKEv2 [RFC5996])
  • MAP (Assigned by MAP [RFC7597], i.e. is this interface’s MAP IPv6 address)
  • WellKnown (Specified by a standards organization, e.g. the ::1 loopback address, which is defined in [RFC4291])
  • Static (For example, present in the factory default configuration (but not WellKnown), created by the ACS, or created by some other management entity (e.g. via a GUI)) This parameter is based on ipOrigin from [RFC4293].
 Static 2.2
Prefix string W The value MUST be the Path Name of a row in the IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. IPv6 address prefix. Some addresses, e.g. addresses assigned via the DHCPv6 IA_NA option, are not associated with a prefix, and some WellKnown prefixes might not be modeled. In both of these cases Prefix will be an empty string. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressPrefix from [RFC4293]. <Empty> 2.2
PreferredLifetime dateTime W The time at which this address will cease to be preferred (i.e. will become deprecated), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if the Origin is Static. 9999-12-31T23:59:59Z 2.2
ValidLifetime dateTime W The time at which this address will cease to be valid (i.e. will become invalid), or 0001-01-01T00:00:00Z if unknown. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if the Origin is Static. 9999-12-31T23:59:59Z 2.2
Anycast boolean W Indicates whether this is an anycast address [Section 2.6/RFC4291]. Anycast addresses are syntactically identical to unicast addresses and so need to be configured explicitly. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressType from [RFC4293]. false 2.2
Device.IP.Interface.{i}.IPv6Prefix.{i}. object(0:) W

This table contains the interface’s IPv6 prefixes. There MUST be an entry for each such prefix, not only for prefixes learned from router advertisements. There are several ways in which entries can be added to and deleted from this table, including:

  • Automatically via [RFC4861] Router Advertisements. See also RouterAdvertisement.
  • Automatically via DHCPv6 [RFC3315] prefix delegation [RFC3633]. See also DHCPv6.Client.
  • Automatically via internal CPE logic, e.g. creation of child prefixes derived from a parent prefix.
  • Manually via a GUI or some other local management interface.
  • Manually via factory default configuration.
  • By the ACS. The CPE MAY choose not to create IPv6Prefix entries for WellKnown prefixes or for the ULA /48 prefix [RFC4193]. If an IPv6Prefix entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has Upstream = false). This object is based on ipAddressPrefixTable from [RFC4293].

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

 - 2.2
Enable boolean W Enables or disables this IPv6Prefix entry. false 2.2
Status string R

The status of this IPv6Prefix table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.2
PrefixStatus string R

The status of Prefix, indicating whether it can be used for communication. See also PreferredLifetime and ValidLifetime. Enumeration of:

  • Preferred (Valid prefix)
  • Deprecated (Valid but deprecated prefix)
  • Invalid (Invalid prefix)
  • Inaccessible (Valid prefix that is not accessible because the interface to which it is assigned is not operational)
  • Unknown (Prefix status cannot be determined for some reason) This parameter is based on ipAddressStatus and ipAddressStatusTC from [RFC4293].
 Invalid 2.2
Alias string(:64) W

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

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

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

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.2
Prefix string(:49) W [IPv6Prefix] IPv6 address prefix. This parameter can only be modified if the Origin is Static. This parameter is based on ipAddressPrefixPrefix from [RFC4293]. <Empty> 2.2
Origin string R

Mechanism via which the prefix was assigned or most recently updated.

Enumeration of:

  • AutoConfigured (Generated via internal CPE logic (e.g. the ULA /48 prefix) or derived from an internal prefix that is not modeled in any IPv6Prefix table)
  • PrefixDelegation (Delegated via DHCPv6 [RFC3633] or some other protocol, e.g. IPv6rd [RFC5969]. Also see StaticType)
  • RouterAdvertisement (Discovered via router advertisement [RFC4861] Prefix Information Option)
  • WellKnown (Specified by a standards organization, e.g. fe80::/10 for link-local addresses, or ::1/128 for the loopback address, both of which are defined in [RFC4291])
  • Static (Created by the ACS, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not WellKnown). Unrelated to any shorter length prefix that might exist on the CPE. Also see StaticType. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD))
  • Child (Derived from an associated AutoConfigured or PrefixDelegation parent prefix. Also see StaticType, ParentPrefix and ChildPrefixBits. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD)) Note that:
  • PrefixDelegation and RouterAdvertisement prefixes can exist only on upstream interfaces (i.e. interfaces for which the physical layer interface object has Upstream = true),
  • AutoConfigured and WellKnown prefixes can exist on any interface, and
  • Static and Child prefixes can exist only on downstream interfaces (i.e. interfaces for which the physical layer interface object has Upstream = false). Also note that a Child prefix’s ParentPrefix will always be an AutoConfigured, PrefixDelegation, or RouterAdvertisement prefix. This parameter is based on ipAddressOrigin from [RFC4293].
 Static 2.2
StaticType string W

Static prefix sub-type. For a Static prefix, this can be set to PrefixDelegation or Child, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the ACS to pre-create “prefix slots” with known path names that can be referenced from elsewhere in the data model before they have been populated.

Enumeration of:

  • Static (Prefix is a “normal” Static prefix)
  • Inapplicable (Prefix is not Static, so this parameter does not apply, READONLY)
  • PrefixDelegation (Prefix will be populated when a PrefixDelegation prefix needs to be created)
  • Child (Prefix will be populated when a Child prefix needs to be created. In this case, the ACS needs also to set ParentPrefix and might want to set ChildPrefixBits (if parent prefix is not set, or goes away, then the child prefix will become operationally disabled)) This mechanism works as follows:
  • When this parameter is set to PrefixDelegation or Child, the instance becomes a “prefix slot” of the specified type.
  • Such an instance can be administratively enabled (Enable = true) but will remain operationally disabled (Status = Disabled) until it has been populated.
  • When a new prefix of of type T is needed, the CPE will look for a matching unpopulated instance, i.e. an instance with (Origin,StaticType,Prefix) = (Static,T,““). If the CPE finds at least one such instance it will choose one and populate it. If already administratively enabled it will immediately become operationally enabled. If the CPE finds no such instances, it will create and populate a new instance with (Origin,StaticType) = (T,T). If the CPE finds more than one such instance, the algorithm via which it chooses which instance to populate is implementation-specific.
  • When a prefix that was populated via this mechanism becomes invalid, the CPE will reset Prefix to an empty string. This does not affect the value of the Enable parameter. The prefix StaticType can only be modified if Origin is Static.
 Static 2.2
ParentPrefix string W The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the parent prefix from which this prefix was derived. The parent prefix is relevant only for Child prefixes and for Static Child prefixes (both of which will always be on downstream interfaces), i.e. for Origin=Child and for (Origin,StaticType) = (Static,Child) prefixes. This parameter can only be modified if Origin is Static (which makes sense only for a prefix whose StaticType is already or will be changed to Child). <Empty> 2.2
ChildPrefixBits string(:49) W [IPv6Prefix] A prefix that specifies the length of Static Child prefixes and how they are derived from their ParentPrefix. It will be used if and only if it is not an empty string and is longer than the parent prefix (if it is not used, derivation of such prefixes is implementation-specific). Any bits to the right of the parent prefix are set to the bits in this prefix. For example, for a parent prefix of fedc::/56, if this parameter had the value 123:4567:89ab:cdef::/64, the child /64 would be fedc:0:0:ef::/64. For a parent prefix of fedc::/60, the child /64 would be fedc:0:0:f::/64. This parameter can only be modified if Origin is Static. <Empty> 2.2
OnLink boolean W On-link flag [Section 4.6.2/RFC4861] as received (in the RA) for RouterAdvertisement. Indicates whether this prefix can be used for on-link determination. This parameter can only be modified if Origin is Static. This parameter is based on ipAddressPrefixOnLinkFlag from [RFC4293]. false 2.2
Autonomous boolean W Autonomous address configuration flag [Section 4.6.2/RFC4861] as received (in the RA) for RouterAdvertisement. Indicates whether this prefix can be used for generating global addresses as specified by SLAAC [RFC4862]. This parameter can only be modified if Origin is Static. This parameter is based on ipAddressPrefixAutonomousFlag from [RFC4293]. false 2.2
PreferredLifetime dateTime W This parameter is based on ipAddressPrefixAdvPreferredLifetime from [RFC4293]. The time at which this prefix will cease to be preferred (i.e. will become deprecated), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if Origin is Static. 9999-12-31T23:59:59Z 2.2
ValidLifetime dateTime W This parameter is based on ipAddressPrefixAdvValidLifetime from [RFC4293]. The time at which this prefix will cease to be valid (i.e. will become invalid), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. This parameter can only be modified if Origin is Static. 9999-12-31T23:59:59Z 2.2
Device.IP.ActivePort.{i}. object(0:) R

This table lists the ports on which TCP connections are listening or established.

At most one entry in this table can exist with the same values for all of LocalIPAddress, LocalPort, RemoteIPAddress and RemotePort.

 - 2.0
LocalIPAddress string(:45) R [IPAddress] Connection local IP address. - 2.0
LocalPort unsignedInt(0:65535) R Connection local port. - 2.0
RemoteIPAddress string(:45) R [IPAddress] The remote IP address of the source of inbound packets. This will be an empty string for listening connections (only connections in ESTABLISHED state have remote addresses). - 2.0
RemotePort unsignedInt(0:65535) R The remote port of the source of inbound packets. This will be 0 for listening connections (only connections in ESTABLISHED state have remote addresses). - 2.0
Status string R

Current operational status of the connection. Enumeration of:

  • LISTEN
  • ESTABLISHED
 - 2.0
Device.IP.Diagnostics. object R The IP Diagnostics object. - 2.0
IPv4PingSupported boolean R Indicates that Ping over IPv4 is supported. - 2.8
IPv6PingSupported boolean R Indicates that Ping over IPv6 is supported. - 2.8
IPv4TraceRouteSupported boolean R Indicates that TraceRoute over IPv4 is supported. - 2.8
IPv6TraceRouteSupported boolean R Indicates that TraceRoute over IPv6 is supported. - 2.8
IPv4DownloadDiagnosticsSupported boolean R Indicates that Download Diagnostics over IPv4 is supported. - 2.9
IPv6DownloadDiagnosticsSupported boolean R Indicates that Download Diagnostics over IPv6 is supported. - 2.9
IPv4UploadDiagnosticsSupported boolean R Indicates that Upload Diagnostics over IPv4 is supported. - 2.9
IPv6UploadDiagnosticsSupported boolean R Indicates that Upload Diagnostics over IPv6 is supported. - 2.9
IPv4UDPEchoDiagnosticsSupported boolean R Indicates that UDPEcho Diagnostics over IPv4 is supported. - 2.9
IPv6UDPEchoDiagnosticsSupported boolean R Indicates that UDPEcho Diagnostics over IPv6 is supported. - 2.9
IPv4ServerSelectionDiagnosticsSupported boolean R Indicates that ServerSelection Diagnostics over IPv4 is supported. - 2.9
IPv6ServerSelectionDiagnosticsSupported boolean R Indicates that ServerSelection Diagnostics over IPv6 is supported. - 2.9
Device.IP.Diagnostics.UDPEchoConfig. object R This object allows the CPE to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. - 2.0
Enable boolean W MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared. - 2.0
Interface string(:256) W The value MUST be the Path Name of IP-layer interface over which the CPE MUST listen and receive UDP echo requests on. The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets. - 2.0
SourceIPAddress string(:45) W [IPAddress] The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address. - 2.0
UDPPort unsignedInt W The UDP port on which the UDP server MUST listen and respond to UDP echo requests. - 2.0
EchoPlusEnabled boolean W If true the CPE will perform necessary packet processing for UDP Echo Plus packets. - 2.0
EchoPlusSupported boolean R true if UDP Echo Plus is supported. - 2.0
PacketsReceived unsignedInt R

Incremented upon each valid UDP echo packet received.

Active Notification requests for this parameter MAY be denied.

 - 2.0
PacketsResponded unsignedInt R

Incremented for each UDP echo response sent.

Active Notification requests for this parameter MAY be denied.

 - 2.0
BytesReceived unsignedInt R

The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled.

Active Notification requests for this parameter MAY be denied.

 - 2.0
BytesResponded unsignedInt R

The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled.

Active Notification requests for this parameter MAY be denied.

 - 2.0
TimeFirstPacketReceived dateTime R

Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456, The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled.

Active Notification requests for this parameter MAY be denied.

 - 2.0
TimeLastPacketReceived dateTime R

Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 The time that the server receives the most recent UDP echo packet.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.IP.Diagnostics.IPPing. object R This object provides access to an IP-layer ping test. - 2.0
DiagnosticsState string W

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (The CPE can not reach the requested Ping host address, READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (The CPE can not reach the requested Ping host address, READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. or Bridging.Bridge.{i}.Port. tables. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
ProtocolVersion string W

Indicates the IP protocol to be used.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the Ping requests)
  • IPv6 (Use IPv6 for the Ping requests)
 - 2.8
Host string(:256) W Host name or address of the host to ping. In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use. - 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
DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each ping. - 2.0
DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 2.0
IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the Ping request. The parameter is only valid if the DiagnosticsState is Complete. - 2.8
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
AverageResponseTimeDetailed unsignedInt R

Result parameter indicating the average response time in microseconds 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.7
MinimumResponseTimeDetailed unsignedInt R

Result parameter indicating the minimum response time in microseconds 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.7
MaximumResponseTimeDetailed unsignedInt R

Result parameter indicating the maximum response time in microseconds 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.7
Device.IP.Diagnostics.TraceRoute. object R This object defines access to an IP-layer trace-route test for the specified IP interface. - 2.0
DiagnosticsState string W

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (The CPE can not reach the requested TraceRoute host address, READONLY)
  • Error_MaxHopCountExceeded (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

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

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

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

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

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

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

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

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

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

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

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (The CPE can not reach the requested TraceRoute host address, READONLY)
  • Error_MaxHopCountExceeded (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. or Bridging.Bridge.{i}.Port. tables. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
ProtocolVersion string W

Indicates the IP protocol to be used.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the TraceRoute)
  • IPv6 (Use IPv6 for the TraceRoute)
 - 2.8
Host string(:256) W Host name or address of the host to find a route to. In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use. - 2.0
NumberOfTries unsignedInt(1:3) W Number of tries per hop. Set prior to running Diagnostic. By default, the CPE SHOULD set this value to 3. - 2.0
Timeout unsignedInt(1:) W Timeout in milliseconds for each hop of the trace route test. By default the CPE SHOULD set this value to 5000. - 2.0
DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each trace route. By default, the CPE SHOULD set this value to 38. - 2.0
DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to 0. - 2.0
MaxHopCount unsignedInt(1:64) W The maximum number of hop used in outgoing probe packets (max TTL). By default the CPE SHOULD set this value to 30. - 2.0
IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used for TraceRoute. The parameter is only valid if the DiagnosticsState is Complete. - 2.8
ResponseTime unsignedInt R

Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

 - 2.0
RouteHopsNumberOfEntries unsignedInt R

The number of entries in the RouteHops table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}. object(0:) R Contains the array of hop results returned. If a route could not be determined, this array will be empty - 2.0
Host string(:256) R

Result parameter indicating the Host Name if DNS is able to resolve or IP Address of a hop along the discovered route.

Active Notification requests for this parameter MAY be denied.

 - 2.0
HostAddress string R

If this parameter is not an empty string it will contain the last IP address of the host returned for this hop and the Host will contain the Host Name returned from the reverse DNS query.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ErrorCode unsignedInt R

Contains the error code returned for this hop. This code is directly from the ICMP CODE field.

Active Notification requests for this parameter MAY be denied.

 - 2.0
RTTimes unsignedInt[1:3](:16) R Comma-separated list (1 to 3 items) (maximum number of characters 16) of unsigned integers. Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop. A list item of 0 indicates that the corresponding response was not received. Round trip times of less than 1 milliseconds MUST be rounded up to 1. The number of list entries is determined by the value of NumberOfTries. - 2.0
Device.IP.Diagnostics.DownloadDiagnostics. object R This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device. - 2.0
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_TransferFailed (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_IncorrectSize (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None and remove all object instances from PerConnectionResult and IncrementalResult. 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 and remove all object instances from PerConnectionResult and IncrementalResult. 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 and remove all object instances from PerConnectionResult and IncrementalResult. 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
Interface string(:256) W The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
DownloadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used. Note: For time based tests (TimeBasedTestDuration > 0) the ACS MAY add a hint to duration of the test to the URL. See [Section 4.3/TR-143a1] for more details.
 - 2.0
DownloadTransports string[] R

Comma-separated list of strings. Supported DownloadDiagnostics transport protocols for a CPE device.

Each list item is an enumeration of:

  • HTTP
  • FTP (OPTIONAL)
 - 2.0
DSCP unsignedInt(0:63) W The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.0
EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.0
TimeBasedTestDuration unsignedInt(0:999) W Controls time based testing [Section 4.3/TR-143a1]. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. - 2.9
TimeBasedTestMeasurementInterval unsignedInt(0:999) W The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP download test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. - 2.9
TimeBasedTestMeasurementOffset unsignedInt(0:255) W This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval to allow the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers. This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0. - 2.9
ProtocolVersion string W

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

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.9
NumberOfConnections unsignedInt(1:) W The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than DownloadDiagnosticMaxConnections. - 2.9
IPAddressUsed string(:45) R

[IPAddress] Indicates which IP address was used to send the request.

Active Notification requests for this parameter MAY be denied.

 - 2.9
DownloadDiagnosticMaxConnections unsignedInt(1:) R Indicates the maximum number of connections that are supported by Download Diagnostics. - 2.9
DownloadDiagnosticsMaxIncrementalResult unsignedInt(1:) R The maximum number of rows in IncrementalResult that the CPE will store. - 2.9
ROMTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command. If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
BOMTime dateTime R

Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection. If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
EOMTime dateTime R

End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection. If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
TestBytesReceived unsignedInt R The number of bytes received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime across all connections. - 2.0
TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 2.0
TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
TestBytesReceivedUnderFullLoading unsignedInt R The number of bytes of the test file received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections. - 2.9
TotalBytesReceivedUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) received in between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
TotalBytesSentUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
PeriodOfFullLoading unsignedInt R The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 2.9
TCPOpenRequestTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
TCPOpenResponseTime dateTime R

Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
PerConnectionResultNumberOfEntries unsignedInt R The number of entries in the PerConnectionResult table. - 2.9
EnablePerConnectionResults boolean W

The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false.

Active Notification requests for this parameter MAY be denied.

 - 2.9
IncrementalResultNumberOfEntries unsignedInt R The number of entries in the IncrementalResult table. - 2.9
Device.IP.Diagnostics.DownloadDiagnostics.PerConnectionResult.{i}. object(0:) R Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 2.9
ROMTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.

Active Notification requests for this parameter MAY be denied.

 - 2.9
BOMTime dateTime R

Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.

Active Notification requests for this parameter MAY be denied.

 - 2.9
EOMTime dateTime R

End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TestBytesReceived unsignedInt R

The number of bytes of the test file received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TotalBytesReceived unsignedInt R

The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TotalBytesSent unsignedInt R

The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TCPOpenRequestTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

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

Active Notification requests for this parameter MAY be denied.

 - 2.9
TCPOpenResponseTime dateTime R

Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

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

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IP.Diagnostics.DownloadDiagnostics.IncrementalResult.{i}. object(0:) R Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 2.9
TestBytesReceived unsignedInt R

Change in the value of TestBytesReceivedUnderFullLoading between StartTime and EndTime.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at StartTime and at EndTime and subtracting. - 2.9
TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at StartTime and at EndTime and subtracting. - 2.9
StartTime dateTime R

The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.9
EndTime dateTime R

The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IP.Diagnostics.UploadDiagnostics. object R This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. - 2.0
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_NoCWD (READONLY)
  • Error_NoSTOR (READONLY)
  • Error_NoTransferComplete (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None and remove all object instances from UploadDiagnostics and IncrementalResult. 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 and remove all object instances from PerConnectionResult and IncrementalResult. 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 and remove all object instances from PerConnectionResult and IncrementalResult. 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
Interface string(:256) W The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
UploadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
 - 2.0
UploadTransports string[] R

Comma-separated list of strings. Supported UploadDiagnostics transport protocols for a CPE device.

Each list item is an enumeration of:

  • HTTP
  • FTP (OPTIONAL)
 - 2.0
DSCP unsignedInt(0:63) W DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.0
EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.0
TestFileLength unsignedInt W The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent. - 2.0
TimeBasedTestDuration unsignedInt(0:999) W Controls time based testing [Section 4.3/TR-143a1]. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. - 2.9
TimeBasedTestMeasurementInterval unsignedInt(0:999) W The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP upload test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. - 2.9
TimeBasedTestMeasurementOffset unsignedInt(0:255) W This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval and allows the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers. This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0. - 2.9
ProtocolVersion string W

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

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.9
NumberOfConnections unsignedInt(1:) W The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than UploadDiagnosticsMaxConnections. - 2.9
IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request. - 2.9
UploadDiagnosticsMaxConnections unsignedInt(1:) R Indicates the maximum number of connections that are supported by Upload Diagnostics. - 2.9
UploadDiagnosticsMaxIncrementalResult unsignedInt(1:) R The maximum number of rows in IncrementalResult that the CPE will store. - 2.9
ROMTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command. If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
BOMTime dateTime R

Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection. If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
EOMTime dateTime R

End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection. If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
TestBytesSent unsignedInt R The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime acrosss all connections. - 2.9
TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 2.0
TestBytesSentUnderFullLoading unsignedInt R The number of bytes of the test file sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections. - 2.9
TotalBytesReceivedUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
TotalBytesSentUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
PeriodOfFullLoading unsignedInt R The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 2.9
TCPOpenRequestTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
TCPOpenResponseTime dateTime R

Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.

Active Notification requests for this parameter MAY be denied.

 - 2.0
PerConnectionResultNumberOfEntries unsignedInt R The number of entries in the PerConnectionResult table. - 2.9
EnablePerConnectionResults boolean W

The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false.

Active Notification requests for this parameter MAY be denied.

 - 2.9
IncrementalResultNumberOfEntries unsignedInt R The number of entries in the IncrementalResult table. - 2.9
Device.IP.Diagnostics.UploadDiagnostics.PerConnectionResult.{i}. object(0:) R Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 2.9
ROMTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.

Active Notification requests for this parameter MAY be denied.

 - 2.9
BOMTime dateTime R

Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.

Active Notification requests for this parameter MAY be denied.

 - 2.9
EOMTime dateTime R

End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TestBytesSent unsignedInt R

The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TotalBytesReceived unsignedInt R

The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TotalBytesSent unsignedInt R

The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TCPOpenRequestTime dateTime R

Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

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

Active Notification requests for this parameter MAY be denied.

 - 2.9
TCPOpenResponseTime dateTime R

Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

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

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IP.Diagnostics.UploadDiagnostics.IncrementalResult.{i}. object(0:) R Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when DiagnosticsState is set to Requested or None. - 2.9
TestBytesSent unsignedInt R

Change in the value of TestBytesSent between StartTime and EndTime.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at StartTime and at EndTime and subtracting. - 2.9
TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at StartTime and at EndTime and subtracting. - 2.9
StartTime dateTime R

The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.9
EndTime dateTime R

The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IP.Diagnostics.UDPEchoDiagnostics. object R This object defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143a1] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143a1]. - 2.9
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error_CannotResolveHostName (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 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 and remove all object instances from IndividualPacketResult. 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 and remove all object instances from IndividualPacketResult. 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 and remove all object instances from IndividualPacketResult. 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.9
Interface string(:256) W The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. If the referenced object is deleted, the parameter value MUST be set to an empty string. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.9
Host string(:256) W

Host name or address of the host to perform tests to.

Active Notification requests for this parameter MAY be denied.

 - 2.9
Port unsignedInt(1:65535) W

Port on the host to perform tests to.

Active Notification requests for this parameter MAY be denied.

 - 2.9
NumberOfRepetitions unsignedInt(1:) W

Number of repetitions of the test to perform before reporting the results. The default value SHOULD be 1.

Active Notification requests for this parameter MAY be denied.

 - 2.9
Timeout unsignedInt(1:) W

Timeout in milliseconds for the test. That is, the amount of time to wait for the return of a packet that was sent to the Host.

Active Notification requests for this parameter MAY be denied.

 - 2.9
DataBlockSize unsignedInt(1:65535) W

Size of the data block in bytes to be sent for each packet. The default value SHOULD be 24.

Active Notification requests for this parameter MAY be denied.

 - 2.9
DSCP unsignedInt(0:63) W

DiffServ codepoint to be used for the test packets. The default value SHOULD be zero.

Active Notification requests for this parameter MAY be denied.

 - 2.9
InterTransmissionTime unsignedInt(1:65535) W

The time in milliseconds between the NumberOfRepetitions of packets sent during a given test. The default value SHOULD be 1000.

Active Notification requests for this parameter MAY be denied.

 - 2.9
ProtocolVersion string W

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

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.9
IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request. - 2.9
SuccessCount unsignedInt R Result parameter indicating the number of successful packets (those in which a successful response was received prior to the timeout) in the most recent test. - 2.9
FailureCount unsignedInt R Result parameter indicating the number of failed packets (those in which a successful response was not received prior to the timeout) in the most recent test. - 2.9
AverageResponseTime unsignedInt R Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 2.9
MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 2.9
MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 2.9
EnableIndividualPacketResults boolean W

The results must be returned in the IndividualPacketResult table for every repetition of the test when set to true. The default value SHOULD be false.

Active Notification requests for this parameter MAY be denied.

 - 2.9
IndividualPacketResultNumberOfEntries unsignedInt R The number of entries in the IndividualPacketResult table. - 2.9
UDPEchoDiagnosticsMaxResults unsignedInt(1:) R

The maximum number of rows in IndividualPacketResult that the CPE will store. If a test would create more rows than UDPEchoDiagnosticsMaxResults only the first UDPEchoDiagnosticsMaxResults rows are present in IndividualPacketResult.

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IP.Diagnostics.UDPEchoDiagnostics.IndividualPacketResult.{i}. object(0:) R This object provides the results from individual UDPEchoPlus test packets collected during a test if EnableIndividualPacketResults is set to true. When DiagnosticsState is set to Completed it should contain NumberOfRepetitions objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet. All instances are removed when DiagnosticsState is set to Requested or None. - 2.9
PacketSuccess boolean R Indicates that the response to this UDP Echo Plus packet sent was received by the client. When this value is true, then all the remaining parameters in this instance are valid. Otherwise only the values originally set by the CPE client (e.g. PacketSendTime and TestGenSN) MAY be set to valid values. - 2.9
PacketSendTime dateTime R Time the client sent this UDP Echo Plus packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - 2.9
PacketReceiveTime dateTime R Time the client receives the response packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z If this response is never received, PacketReceiveTime SHOULD be set to the Unknown Time value as specified in [Section 3.2.2/TR-106a7]. - 2.9
TestGenSN unsignedInt R The TestGenSN field in the UDPEcho Plus packet [Section A.1.4/TR-143a1] sent by the CPE client. - 2.9
TestRespSN unsignedInt R The TestRespSN field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) for this Echo Plus packet sent by the CPE client. If PacketSuccess is false, TestRespSN SHOULD be 0. - 2.9
TestRespRcvTimeStamp unsignedInt R The TestRespRcvTimeStamp field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If PacketSuccess is false, TestRespRcvTimeStamp SHOULD be 0. - 2.9
TestRespReplyTimeStamp unsignedInt R The TestRespReplyTimeStamp field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If PacketSuccess is false, TestRespReplyTimeStamp SHOULD be 0. - 2.9
TestRespReplyFailureCount unsignedInt R The count value that was set by the UDP Echo Plus server (i.e. Host) to record the number of dropped echo response packets by the server. This count is incremented if a valid echo request packet is received at a UDP EchoPlus server but for some reason cannot be responded to (e.g. due to local buffer overflow, CPU utilization, etc…). If PacketSuccess is false, TestRespReplyFailureCount SHOULD be 0. - 2.9
Device.IP.Diagnostics.ServerSelectionDiagnostics. object R This object provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out. - 2.9
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error_CannotResolveHostName (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 Completed (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

Active Notification requests for this parameter MAY be denied.

 - 2.9
Interface string(:256) W The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. If the referenced object is deleted, the parameter value MUST be set to an empty string. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.9
ProtocolVersion string W

Indicates the IP protocol version to be used.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)

The factory default value MUST be Any.

 - 2.9
Protocol string W

The protocol over which the test is to be performed.

Enumeration of:

  • ICMP
  • UDP Echo
 - 2.9
HostList string(:256)[:10]() W Comma-separated list (up to 10 items) (length ) of strings (maximum number of characters per item 256). Each entry is a Host name or address of a host to ping. - 2.9
NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform for each HostList entry before reporting the results. - 2.9
Timeout unsignedInt(1:) W Timeout in milliseconds for each iteration of the ping test where the total number of iterations is the value of NumberOfRepetitions times the number of entities in the HostList Parameter. - 2.9
FastestHost string R

Result parameter indicating the Host (one of the items within the HostList Parameter) with the smallest average response time.

Active Notification requests for this parameter MAY be denied.

 - 2.9
MinimumResponseTime unsignedInt R

Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

 - 2.9
AverageResponseTime unsignedInt R

Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

 - 2.9
MaximumResponseTime unsignedInt R

Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero.

Active Notification requests for this parameter MAY be denied.

 - 2.9
IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request to the host identified in FastestHost. - 2.9
Device.LLDP. object R This object contains Link Layer Discovery Protocol (LLDP) [802.1AB-2009] related objects and parameters. - 2.8
Device.LLDP.Discovery. object R This object is used for managing the discovery of LLDP devices. The CPE MAY, but need not, retain some or all of the information in this object across reboot. - 2.8
DeviceNumberOfEntries unsignedInt R The number of entries in the Device table. - 2.8
Device.LLDP.Discovery.Device.{i}. object(0:) R

This table contains information about discovered LLDP devices.

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

 - 2.8
Interface string R The value MUST be the Path Name of the interface via which the LLDP device was discovered. - 2.8
ChassisIDSubtype unsignedInt(:255) R The chassis identifier subtype, which is included in the value of the LLDPDU’s Chassis ID TLV (TLV Type = 1). The following subtype values are defined:
  • 0 (Reserved)
  • 1 (Chassis component)
  • 2 (Interface alias)
  • 3 (Port component)
  • 4 (MAC address)
  • 5 (Network address)
  • 6 (Interface name)
  • 7 (Locally assigned)
  • 8-255 (Reserved) Note: It is assumed that this integer might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the Chassis ID is set to the representative MAC address (chassis ID subtype = 4) for HTIP-Ethernet Bridge.
 - 2.8
ChassisID string(1:255) R The chassis identifier, which is included in the value of the LLDPDU’s Chassis ID TLV (TLV Type = 1). Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the Chassis ID is set to the representative MAC address. If LLDPDUs are sent and received from two or more LLDP agents of the same HTIP-Ethernet Bridge, this value is same in all LLDPDUs. - 2.8
Host string(:256)[](:1024) R 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. Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256).Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this device. When the entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 2.8
PortNumberOfEntries unsignedInt R The number of entries in the Port table. - 2.8
Device.LLDP.Discovery.Device.{i}.Port.{i}. object(0:) R

This table contains information about ports on discovered LLDP devices.

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

 - 2.8
PortIDSubtype unsignedInt(:255) R The port identifier subtype, which is included in the value of the LLDPDU’s Port ID TLV (TLV Type = 2). The following subtype values are defined:
  • 0 (Reserved)
  • 1 (Interface alias)
  • 2 (Port component)
  • 3 (MAC address)
  • 4 (Network address)
  • 5 (Interface name)
  • 6 (Agent circuit ID)
  • 7 (Locally assigned)
  • 8-255 (Reserved)
 - 2.8
PortID string(1:255) R The port identifier, which is included in the value of the LLDPDU’s Port ID TLV (TLV Type = 2). - 2.8
TTL unsignedInt(:65535) R The LLDPDU lifetime (in seconds), which is the value of the latest TimeToLive TLV (TLV Type = 3). If this value is 0, it means that the LLDP agent or the MAC service function of the port is stopped. - 2.8
PortDescription string(:255) R The port description, which is the value of the latest Port Description TLV (TLV Type = 4), or an empty string if no Port Description TLV has been received. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the parameter value is likely to be one of the names defined in [Appendix A (List of Interface Standard Names)/JJ-300.00]. - 2.8
MACAddressList string(:17)[:255]() R [MACAddress] Comma-separated list (up to 255 items) (length ) of MAC Addresses. The device’s MAC addresses, which are included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127), or an empty string if no list of MAC addresses has been received. The parameter is relevant when there is a LLDP device which has a MAC copy function and has two or more MAC addresses. Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 3 (MAC Address List). - 2.8
LastUpdate dateTime R The date and time at which the last LLDPDU was received for this (Device,Port). - 2.8
Device.LLDP.Discovery.Device.{i}.Port.{i}.LinkInformation. object R The port’s link information, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 2 (Link Information). - 2.8
InterfaceType unsignedInt R The port’s interface type, or 0 if no interface type has been received. Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, it’s an IANA interface type [IANAifType]. For example, IANAifType defines the following interface types for wired line (UTP cable), wireless line, power line, and coaxial cable:
  • 6 (Wired line)
  • 71 (Wireless)
  • 174 (PLC)
  • 236 (Coaxial cable)
 - 2.8
MACForwardingTable string(:17)[:255]() R [MACAddress] Comma-separated list (up to 255 items) (length ) of MAC Addresses. The port’s MAC forwarding table, or the value is an empty string if no forwarding table was supplied. - 2.8
Device.LLDP.Discovery.Device.{i}.DeviceInformation. object R The device information, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 1 (Device Information). - 2.8
DeviceCategory string[] R Comma-separated list of strings. Each list item indicates a device category (e.g.“AV_TV” and “AV_Recorder”), or the value is an empty string if no device categories were provided. Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories. - 2.8
ManufacturerOUI string(0:6) R

The manufacturer OUI, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127), or an empty string if no manufacturer OUI was provided. Possible patterns:

  • <Empty> (An empty string)
  • [0-9A-F]{6}
 - 2.8
ModelName string(:31) R The model name, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127), or an empty string if no model name was provided. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. - 2.8
ModelNumber string(:31) R The model number, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127), or an empty string if no model number was provided. Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. - 2.8
VendorSpecificNumberOfEntries unsignedInt R The number of entries in the VendorSpecific table. - 2.8
Device.LLDP.Discovery.Device.{i}.DeviceInformation.VendorSpecific.{i}. object(0:) R The vendor-specific device information, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127). At most one entry in this table can exist with the same values for both OrganizationCode and InformationType. Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, this table contains the Organizationally Specific TLV (TLV Type = 127) of LLDPDU, in which the [OUI] in the third octet is E0271A (TTC-OUI), the organizationally defined subtype in the sixth octet is 1 (Device Information), and the device information ID in the seventh octet is 255 (Vendor-specific extension field). - 2.8
OrganizationCode string(6) R

The vendor-specific organization code, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127).

Possible patterns:

  • [0-9A-F]{6}
 - 2.8
InformationType unsignedInt(:255) R The vendor-specific device information type, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127). - 2.8
Information string(:248) R The vendor-specific device information, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127). - 2.8
Device.IPsec. object R IPsec [RFC4301] object that supports the configuration of Encapsulating Security Payload (ESP) [RFC4303] and Authentication Header (AH) [RFC4302] in tunnel mode [Section 3.2/RFC4301]. Use of IKEv2 [RFC5996] is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). See the IPsec Theory of Operation [Appendix IX/TR-181i2a5] for a description of the working of this IPsec data model. - 2.5
Enable boolean W Enables or disables IPsec. - 2.5
Status string R

IPsec status. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.5
AHSupported boolean R Indicates whether or not Authentication Header (AH) [RFC4302] is supported. - 2.5
IKEv2SupportedEncryptionAlgorithms string[] R

Comma-separated list of strings. Supported IKEv2 encryption algorithms [Transform Type 1/IKEv2-params].

Each list item is an enumeration of:

  • DES
  • 3DES
  • RC5
  • IDEA
  • CAST
  • BLOWFISH
  • 3IDEA
  • AES-CBC
  • AES-CTR
  • AES-CCM-8
  • AES-CCM-12
  • AES-CCM-16
  • AES-GCM-8
  • AES-GCM-12
  • AES-GCM-16
  • CAMELLIA-CBC Note that these are the names from the above reference, transformed as follows:
  • Leading ENCR_ (when present) discarded because they are all encryption algorithms so it’s not needed.
  • Underscores changed to hyphens to preserve names used in existing data models (and because of inconsistent conventions).
  • Phrases collapsed where unambiguous, e.g. “with a(n) NN octet ICV” -> “-NN”. As additional algorithms are added to the above reference, this data model will be extended according to the above conventions.
 - 2.5
ESPSupportedEncryptionAlgorithms string[] R

Comma-separated list of strings. Supported ESP encryption algorithms [Transform Type 1/IKEv2-params] [Section 3.1.1/RFC4835].

Each list item is an enumeration of:

  • NULL
  • DES-IV64
  • DES
  • 3DES
  • RC5
  • IDEA
  • CAST
  • BLOWFISH
  • 3IDEA
  • DES-IV32
  • AES-CBC
  • AES-CTR
  • AES-CCM-8
  • AES-CCM-12
  • AES-CCM-16
  • AES-GCM-8
  • AES-GCM-12
  • AES-GCM-16
  • NULL-AUTH-AES-GMAC
  • CAMELLIA-CBC
  • CAMELLIA-CTR
  • CAMELLIA-CCM-8
  • CAMELLIA-CCM-12
  • CAMELLIA-CCM-16 Note that these are the names from the above reference, transformed as follows:
  • Leading ENCR_ (when present) discarded because they are all encryption algorithms so it’s not needed.
  • Underscores changed to hyphens to preserve names used in existing data models (and because of inconsistent conventions).
  • Phrases collapsed where unambiguous, e.g. “with a(n) NN octet ICV” -> “-NN”.
  • Some algorithms with apparently rather specialised application are omitted, e.g. ENCR_NULL_AUTH_AES_GMAC. As additional algorithms are added to the above reference, this data model will be extended according to the above conventions.
 - 2.5
IKEv2SupportedPseudoRandomFunctions string[] R

Comma-separated list of strings. Supported IKEv2 pseudo-random functions [Transform Type 2/IKEv2-params].

Each list item is an enumeration of:

  • HMAC-MD5
  • HMAC-SHA1
  • HMAC-TIGER
  • AES-128-XCBC
  • HMAC-SHA2-256
  • HMAC-SHA2-384
  • HMAC-SHA2-512
  • AES-128-CMAC Note that these are the names from the above reference, transformed as follows:
  • Leading PRF_ (when present) discarded because they all pseudo-random functions so it’s not needed.
  • Underscores changed to hyphens to preserve names used in existing data models.
  • Hyphen inserted after AES (or other acronym) when immediately followed by a key length. As additional functions are added to the above reference, this data model will be extended according to the above conventions.
 - 2.5
SupportedIntegrityAlgorithms string[] R

Comma-separated list of strings. Supported integrity algorithms [Transform Type 3/IKEv2-params].

Each list item is an enumeration of:

  • NONE
  • HMAC-MD5-96
  • HMAC-SHA1-96
  • DES-MAC
  • KPDK-MD5
  • AES-XCBC-96
  • HMAC-MD5-128
  • HMAC-SHA1-160
  • AES-CMAC-96
  • AES-128-GMAC
  • AES-192-GMAC
  • AES-256-GMAC
  • HMAC-SHA2-256-128
  • HMAC-SHA2-256-192
  • HMAC-SHA2-256-256 Note that these are the names from the above reference, transformed as follows:
  • Leading AUTH_ (when present) discarded because they all authentication (integrity) algorithms so it’s not needed.
  • Underscores changed to hyphens to preserve names used in existing data models. As additional algorithms are added to the above reference, this data model will be extended according to the above conventions.
 - 2.5
SupportedDiffieHellmanGroupTransforms string[] R

Comma-separated list of strings. Supported Diffie-Hellman group transforms [Transform Type 4/IKEv2-params].

Each list item is an enumeration of:

  • NONE
  • MODP-768
  • MODP-1024
  • MODP-1536
  • MODP-2048
  • MODP-3072
  • MODP-4096
  • MODP-6144
  • MODP-8192
  • ECP-256
  • ECP-384
  • ECP-521
  • MODP-1024-PRIME-160
  • MODP-2048-PRIME-224
  • MODP-2048-PRIME-256
  • ECP-192
  • ECP-224 Note that these are the names from the above reference, transformed as follows:
  • Name (other than NONE) always starts with the type of group, currently MODP or ECP (implies ECP random).
  • This is followed by -NN, where NN is the group length in bits.
  • this is followed by -PRIME-NN for groups with prime order subgroups, where NN is the subgroup length in bits. As additional algorithms are added to the above reference, this data model will be extended according to the above conventions.
 - 2.5
MaxFilterEntries unsignedInt R The maximum number of entries in the Filter table. A value of 0 means no specific limit. - 2.5
MaxProfileEntries unsignedInt R The maximum number of entries in the Profile table. A value of 0 means no specific limit. - 2.5
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.5
ProfileNumberOfEntries unsignedInt R The number of entries in the Profile table. - 2.5
TunnelNumberOfEntries unsignedInt R The number of entries in the Tunnel table. - 2.5
IKEv2SANumberOfEntries unsignedInt R The number of entries in the IKEv2SA table. - 2.5
Device.IPsec.Stats. object R Global IPsec statistics. These statistics include all IPsec traffic, i.e. all IKEv2 negotiation, IKEv2 SAs and child SAs. The CPE MUST reset global IPsec Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when IPsec is disabled (IPsec.Enable is set to false) or when IPsec is enabled (IPsec.Enable is set to true). - 2.5
NegotiationFailures unsignedInt R [StatsCounter32] The total number of times an IPsec negotiation failure has occurred. - 2.5
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by IPsec. - 2.5
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by IPsec. - 2.5
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by IPsec. - 2.5
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by IPsec. - 2.5
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.5
UnknownSPIErrors unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to an unknown SPI (Security Parameter Index). - 2.5
DecryptionErrors unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to ESP decryption errors. - 2.5
IntegrityErrors unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to integrity errors. - 2.5
ReplayErrors unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to replay errors. - 2.5
PolicyErrors unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to policy errors. - 2.5
OtherReceiveErrors unsignedInt R [StatsCounter32] The total number of packets discarded by IPsec due to errors other than unknown SPI, decryption, integrity, replay or policy errors. This can include packets dropped due to a lack of receive buffers. - 2.5
Device.IPsec.Filter.{i}. object(0:) W

Filter table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] selection criteria. Each (ordered) entry defines a set of selection criteria and references a Profile table entry that specifies how matching packets will be processed. SPD filtering is performed for all packets that might need to cross the IPsec boundary [Section 3.1/RFC4301]. Given that IPsec operates at the IP level, this means that SPD filtering conceptually occurs after bridging and before routing. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.5
Enable boolean W Enables or disables this IPsec Filter table entry. false 2.5
Status string R

The status of this IPsec Filter table 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.5
Order unsignedInt(1:) W Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.5
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.5
Interface string(:256) W SPD selection criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface. However, the types of interfaces for which filters can be instantiated is a local matter to the CPE. <Empty> 2.5
AllInterfaces boolean W SPD selection criterion. This specifies that all ingress interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress interfaces are indicated. false 2.5
DestIP string(:45) W [IPAddress] SPD selection criterion. Destination IP address. An empty string indicates this criterion is not used, i.e. is ANY. <Empty> 2.5
DestMask string(:45) W [IPAddress] SPD selection criterion. Destination IP address mask. If not an empty string, only the indicated network portion of the DestIP address is to be used for selection. An empty string indicates that the full DestIP address is to be used for selection. <Empty> 2.5
DestIPExclude boolean W If false, the rule matches only those packets that match the (masked) DestIP entry, if specified. If true, the rule matches all packets except those that match the (masked) DestIP entry, if specified. false 2.5
SourceIP string(:45) W [IPAddress] SPD selection criterion. Source IP address. An empty string indicates this criterion is not used, i.e. is ANY. <Empty> 2.5
SourceMask string(:45) W [IPAddress] SPD selection criterion. Source IP address mask. If not an empty string, only the indicated network portion of the SourceIP address is to be used for selection. An empty string indicates that the full SourceIP address is to be used for selection. <Empty> 2.5
SourceIPExclude boolean W If false, the rule matches only those packets that match the (masked) SourceIP entry, if specified. If true, the rule matches all packets except those that match the (masked) SourceIP entry, if specified. false 2.5
Protocol int(-1:255) W SPD selection criterion. Protocol number. A value of -1 indicates this criterion is not used, i.e. is ANY. Note that [RFC4301] refers to this as the Next Layer Protocol. It is obtained from the IPv4 Protocol or the IPv6 Next Header fields. -1 2.5
ProtocolExclude boolean W If false, the rule matches only those packets that match Protocol, if specified. If true, the rule matches all packets except those that match Protocol, if specified. false 2.5
DestPort int(-1:65535) W SPD selection criterion. Destination port number. A value of -1 indicates this criterion is not used, i.e. is ANY. The value of this parameter is ignored for protocols that do not use ports, e.g. ICMP (1). -1 2.5
DestPortRangeMax int(-1:65535) W SPD selection criterion. If specified, indicates a destination port address range from DestPort through DestPortRangeMax (inclusive), in which case DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no destination port range is specified. -1 2.5
DestPortExclude boolean W If false, the rule matches only those packets that match DestPort (or port range), if specified. If true, the rule matches all packets except those that match DestPort (or port range), if specified. false 2.5
SourcePort int(-1:65535) W SPD selection criterion. Source port number. A value of -1 indicates this criterion is not used, i.e. is ANY. The value of this parameter is ignored for protocols that do not use ports, e.g. ICMP (1). -1 2.5
SourcePortRangeMax int(-1:65535) W SPD selection criterion. If specified, indicates a source port address range from SourcePort through SourcePortRangeMax (inclusive), in which case SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no source port range is specified. -1 2.5
SourcePortExclude boolean W If false, the rule matches only those packets that match SourcePort (or port range), if specified. If true, the rule matches all packets except those that match SourcePort (or port range), if specified. false 2.5
ProcessingChoice string W

Indicates how packets that match this rule will be processed [Section 4.4.1/RFC4301].

Enumeration of:

  • Discard (Packet is not allowed to traverse the IPsec boundary; packet will be discarded)
  • Bypass (Packet is allowed to bypass traverse the IPsec boundary without protection)
  • Protect (Packet is afforded protection as specified by Profile)
 Bypass 2.5
Profile string W The profile that defines the IPsec treatment for matching packets. 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. If ProcessingChoice is Protect, Profile MUST NOT be an empty string. In this case, if it ever becomes an empty string, e.g. because the referenced profile is deleted, this IPsec Filter table entry is invalid and Status MUST be set to Error_Misconfigured. If ProcessingChoice is not Protect, Profile is ignored. Any changes to the referenced profile will have an immediate effect on any established IPsec tunnels. Such changes will often force IKEv2 sessions and child SAs to be re-established. - 2.5
Device.IPsec.Profile.{i}. object(0:) W

Profile table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] processing info. Each entry defines the IPsec treatment for packets that match the Filter entries that reference the entry.

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

 - 2.5
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.5
MaxChildSAs unsignedInt W Controls the maximum number of child Security Association (SA) pairs that can be negotiated by a single IKEv2 session. If a new child SA pair is needed, but the current IKEv2 session already has MaxChildSAs child SA pairs, an additional IKEv2 session (and therefore an additional IPsec tunnel) will be established. A value of 0 means no specific limit. Note that support for more than one child SA pair per IKEv2 session is OPTIONAL [Section 1.3/RFC5996]. - 2.5
RemoteEndpoints string(:64)[:4]() W Comma-separated list (up to 4 items) (length ) of strings (maximum number of characters per item 64). The host name or IP address of the remote IPsec tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.5
ForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic that is associated with this profile. The forwarding policy can be referenced by entries in the Routing.Router.{i}.IPv4Forwarding and Routing.Router.{i}.IPv6Forwarding tables, and therefore allows SPD selection criteria to influence the forwarding decision. 0 2.5
Protocol string W

The “child” security protocol. This is not to be confused with Filter.Filter.{i}.Protocol, which is an SPD selector that can select packets that already have AH or ESP headers. Profile.Protocol selects whether AH or ESP will be used when encapsulating a packet.

Enumeration of:

  • AH (Authentication Header [RFC4302]; can only be selected if AHSupported is true)
  • ESP (Encapsulating Security Payload [RFC4303])
 ESP 2.5
IKEv2AuthenticationMethod string W IKEv2 CPE authentication method [Section 2.15/RFC5996]. The value MUST be the Path Name of an enabled row in the Security.Certificate table or in another table that contains appropriate CPE credentials. If an empty string, or the referenced row is disabled or deleted, the CPE chooses the authentication method based on local policy. <Empty> 2.5
IKEv2AllowedEncryptionAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.IKEv2SupportedEncryptionAlgorithms parameter. Allowed IKEv2 encryption algorithms. - 2.5
ESPAllowedEncryptionAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.ESPSupportedEncryptionAlgorithms parameter. Allowed ESP encryption algorithms. - 2.5
IKEv2AllowedPseudoRandomFunctions string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.IKEv2SupportedPseudoRandomFunctions parameter. Allowed IKEv2 pseudo-random functions. - 2.5
IKEv2AllowedIntegrityAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.SupportedIntegrityAlgorithms parameter. Allowed IKEv2 integrity algorithms. - 2.5
AHAllowedIntegrityAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.SupportedIntegrityAlgorithms parameter. Allowed AH integrity algorithms [Transform Type 3/IKEv2-params] [Section 3.2/RFC4835]. <Empty> 2.5
ESPAllowedIntegrityAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.SupportedIntegrityAlgorithms parameter. Allowed ESP integrity algorithms [Transform Type 3/IKEv2-params] [Section 3.1.1/RFC4835]. <Empty> 2.5
IKEv2AllowedDiffieHellmanGroupTransforms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.SupportedDiffieHellmanGroupTransforms parameter. Allowed IKEv2 Diffie-Hellman group transforms. - 2.5
IKEv2DeadPeerDetectionTimeout unsignedInt W IKEv2 Dead Peer Detection (DPD) timeout in seconds. [Section 2.4/RFC5996] - 2.5
IKEv2NATTKeepaliveTimeout unsignedInt W IKEv2 NAT traversal (NAT-T) keepalive timeout in seconds. [Section 4/RFC3948] - 2.5
AntiReplayWindowSize unsignedInt W The size of the AH or ESP Anti-Replay Window. [Section B.2/RFC4302] [Section A2/RFC4303] A value of 0 means that Sequence Number Verification is disabled. 0 2.5
DoNotFragment string W

Controls the value of the Do Not Fragment (DF) bit. [Section 8.1/RFC4301]

Enumeration of:

  • Set
  • Clear
  • Copy (Copy from inner header; applies only when both inner and outer headers are IPv4)
 - 2.5
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with this IPsec channel. A value of -1 indicates copy from the incoming packet. A value of -2 indicates automatic marking of DSCP. De-tunneled packets are never re-marked. Automatic DSCP marking behavior is a local matter to the CPE, possibly influenced by other Broadband Forum standards that it supports. - 2.5
IKEv2SATrafficLimit unsignedLong W IKEv2 SA lifetime in bytes, or zero if there is no traffic constraint on its expiration. If both IKEv2SATrafficLimit and IKEv2SATimeLimit are non-zero, the IKEv2 SA is deleted when the first limit is reached. - 2.5
IKEv2SATimeLimit unsignedInt W IKEv2 SA lifetime in seconds, or zero if there is no time constraint on its expiration. If both IKEv2SATimeLimit and IKEv2SATrafficLimit are non-zero, the IKEv2 SA is deleted when the first limit is reached. - 2.5
IKEv2SAExpiryAction string W

Action to take when an IKEv2 SA expires, whether as a result of hitting a traffic limit or a time limit.

Enumeration of:

  • Renegotiate
  • Delete
 - 2.5
ChildSATrafficLimit unsignedLong W Child SA lifetime in bytes, or zero if there is no traffic constraint on its expiration. If both ChildSATrafficLimit and ChildSATimeLimit are non-zero, the child SA is deleted when the first limit is reached. - 2.5
ChildSATimeLimit unsignedInt W Child SA lifetime in seconds, or zero if there is no time constraint on its expiration. If both ChildSATimeLimit and ChildSATrafficLimit are non-zero, the child SA is deleted when the first limit is reached. - 2.5
ChildSAExpiryAction string W

Action to take when a Child SA expires, whether as a result of hitting a traffic limit or a time limit.

Enumeration of:

  • Renegotiate
  • Delete
 - 2.5
SentCPAttrNumberOfEntries unsignedInt R The number of entries in the SentCPAttr table. - 2.5
Device.IPsec.Profile.{i}.SentCPAttr.{i}. object(0:) W

Each instance of this object represents an IKEv2 Configuration Payload (CP) [Section 3.15/RFC5996] Attribute that MUST, if enabled, be sent in IKEv2 CP CFG_REQUEST messages. All such Attributes MUST be listed.

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

 - 2.5
Enable boolean W Enables or disables this SentCPAttr entry. - 2.5
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.5
Type unsignedInt(0:32767) W CP Attribute Type as described in [Section 3.15.1/RFC5996] and defined in [IKEv2 Configuration Payload Attribute Types/IKEv2-params]. - 2.5
Value hexBinary(:65535) W A hexbinary encoded CP Attribute Value as described in [Section 3.15.1/RFC5996] and defined in [IKEv2 Configuration Payload Attribute Types/IKEv2-params]. - 2.5
Device.IPsec.Tunnel.{i}. object(0:) R

Represents an IPsec tunnel, i.e. a virtual IP interface that models an IPsec tunnel entry point and exit point. A Tunnel instance always references (and has the same lifetime as) a (Tunnel,Tunneled) IP.Interface pair. The Tunnel instance models the IPsec-specific concepts, the Tunnel IP.Interface instance models the generic concepts, and the Tunneled IP.Interface instance exists only so it can be referenced by forwarding or filter rules. Tunnel instances are automatically created (as needed) when Filter instances are enabled and disabled. Each instance’s Filters parameter references the Filter instances that require the Tunnel instance to exist. If this list ever becomes an empty string, e.g. because all the referenced Filter instances have been disabled or deleted, the CPE MAY choose not to delete the Tunnel instance (and its associated (Tunnel,Tunneled) IP.Interface pair). This can be desirable, because QoS.Classification, Routing.Router.{i}.IPv4Forwarding, Routing.Router.{i}.IPv6Forwarding etc instances might be referencing the IP.Interface instances.

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

 - 2.5
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.5
TunnelInterface string R The corresponding auto-created Tunnel IP.Interface instance. The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string). - 2.5
TunneledInterface string R The corresponding auto-created Tunneled IP.Interface instance. The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string). - 2.5
Filters string[] R Comma-separated list of strings. The Filter instances that require this Tunnel instance to exist. Each list item MUST be the Path Name of a row in the IPsec.Filter. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.5
Device.IPsec.Tunnel.{i}.Stats. object R Statistics for this IPsec tunnel, i.e. all traffic that has passed through the tunnel, including IKEv2 negotiation, IKEv2 SA and ChildSA traffic. The CPE MUST reset the tunnel’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e. its associated IP.Interface.{i}.Status parameter transitions to a down state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. its associated IP.Interface.{i}.Enable parameter transition from false to true). Note that this object does not include generic statistics that are available in the associated IP.Interface.{i}.Stats object. - 2.5
DecryptionErrors unsignedInt R [StatsCounter32] The total number of inbound packets discarded due to ESP decryption errors. - 2.5
IntegrityErrors unsignedInt R [StatsCounter32] The total number of inbound packets discarded due to integrity errors. - 2.5
ReplayErrors unsignedInt R [StatsCounter32] The total number of inbound packets discarded due to replay errors. - 2.5
PolicyErrors unsignedInt R [StatsCounter32] The total number of inbound packets discarded due to policy errors. - 2.5
OtherReceiveErrors unsignedInt R [StatsCounter32] The total number of inbound packets discarded due to errors other than decryption, integrity, replay or policy errors. This can include packets dropped due to a lack of receive buffers. - 2.5
Device.IPsec.IKEv2SA.{i}. object(0:) R

Represents an IKEv2 Security Association (SA), corresponding to an IKEv2 session. Instances are automatically created and deleted as IKEv2 SAs are created and deleted.

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

 - 2.5
Status string R

The current operational state of the IKEv2 SA.

Enumeration of:

  • Up
  • Down
  • Unknown
  • Dormant
  • Error (OPTIONAL)
 - 2.5
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.5
Tunnel string R The associated Tunnel instance. The value MUST be the Path Name of a row in the Tunnel. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Note that Tunnel is a unique key, i.e only one IKEv2SA instance is associated with a given Tunnel instance. During rekeying [Section 2.8/RFC5996], a new IKEv2 SA is created and inherits the existing IKEv2 SA’s child SAs, then the old IKEv2 SA is deleted. From the management point of view the new and old IKEv2 SAs are the same SA and MUST be modeled using the same IKEv2SA instance. - 2.5
LocalAddress string(:45) R [IPAddress] The local IP address that this IKEv2 SA was negotiated with. This is assigned via IKEv2 and will also be available via the associated Tunnel’s Tunnel.{i}.TunnelInterface IP.Interface.{i}.IPv4Address or IP.Interface.{i}.IPv6Address table (as appropriate). - 2.5
RemoteAddress string(:45) R [IPAddress] The IP address of the peer that this IKEv2 SA was negotiated with. This will be the IP address of one of the security gateways configured via Profile.{i}.RemoteEndpoints. - 2.5
EncryptionAlgorithm string(:64) R The encryption algorithm applied to traffic carried by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedEncryptionAlgorithms from the Profile instance via which this IKEv2 SA was created. - 2.5
EncryptionKeyLength unsignedInt R The length of the encryption key in bits used for the algorithm specified in the EncryptionAlgorithm parameter. The value is 0 if the key length is implicit in the specified algorithm or there is no encryption applied. - 2.5
PseudoRandomFunction string(:64) R The pseudo-random function used by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedPseudoRandomFunctions from the Profile instance via which this IKEv2 SA was created. - 2.5
IntegrityAlgorithm string(:64) R The integrity algorithm applied to the traffic carried by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedIntegrityAlgorithms from the Profile instance via which this IKEv2 SA was created. - 2.5
DiffieHellmanGroupTransform string(:64) R The Diffie-Hellman Group used by this IKEv2 SA. This will be one of the Profile.{i}.IKEv2AllowedDiffieHellmanGroupTransforms from the Profile instance via which this IKEv2 SA was created. - 2.5
CreationTime dateTime R When this IKEv2 SA was set up. - 2.5
NATDetected string R

Whether NAT traversal is supported by the device and, if so, whether a NAT was detected.

Enumeration of:

  • None
  • Local
  • Remote
  • Unsupported
 - 2.5
ReceivedCPAttrNumberOfEntries unsignedInt R The number of entries in the ReceivedCPAttr table. - 2.5
ChildSANumberOfEntries unsignedInt R The number of entries in the ChildSA table. - 2.5
Device.IPsec.IKEv2SA.{i}.Stats. object R Statistics for this IKEv2 Security Association (SA). The CPE MUST reset the IKEv2 SA’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the associated Tunnel instance’s Stats parameters are reset. - 2.5
BytesSent unsignedLong R [StatsCounter64] The total number of bytes handled in the outbound direction by the IKEv2 SA. - 2.5
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes handled in the inbound direction by the IKEv2 SA. - 2.5
PacketsSent unsignedLong R [StatsCounter64] The total number of packets handled in the outbound direction by the IKEv2 SA. - 2.5
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets handled in the inbound direction by the IKEv2 SA. - 2.5
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound packets from this IKEv2 SA discarded for any reason. This can include packets dropped due to a lack of transmit buffer space. Note that this refers to IKE protocol packets, and not to packets carried by other SAs. - 2.5
DecryptionErrors unsignedInt R [StatsCounter32] The total number of inbound packets to this IKEv2 SA discarded due to decryption errors. Note that this refers to IKEv2 protocol packets, and not to {units carried by other SAs.}} - 2.5
IntegrityErrors unsignedInt R [StatsCounter32] The total number of inbound packets to this IKEv2 SA discarded due to integrity errors. Note that this refers to IKEv2 protocol packets, and not to packets carried by other SAs. - 2.5
OtherReceiveErrors unsignedInt R [StatsCounter32] The total number of inbound packets to this IKEv2 SA discarded for reasons other than decryption or integrity errors. This can include packets dropped due to a lack of receive buffer space. Note that this refers to IKEv2 protocol packets, and not to packets carried by other SAs. - 2.5
Device.IPsec.IKEv2SA.{i}.ReceivedCPAttr.{i}. object(0:) W This is a transitory table that lists all the IKEv2 Configuration Payload (CP) [Section 3.15/RFC5996] Attributes that have been received via CFG_REPLY messages. Table entries are automatically created to correspond with received Attributes. However, it is a local matter to the CPE when to delete old table entries. If the same Attribute is received multiple times, it is up to the CPE to decide which entries to include (i.e. whether the same Attribute will be present multiple times). In order to allow for the same Attribute to be present multiple times within the table, this table has no unique key defined. - 2.5
Type unsignedInt(0:32767) R CP Attribute Type as described in [Section 3.15.1/RFC5996] and defined in [IKEv2 Configuration Payload Attribute Types/IKEv2-params]. - 2.5
Value hexBinary(:65535) R A hexbinary encoded CP Attribute Value as described in [Section 3.15.1/RFC5996] and defined in [IKEv2 Configuration Payload Attribute Types/IKEv2-params]. - 2.5
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}. object(0:) R

Represents a child Security Association (SA) pair, i.e. an inbound child SA and an outbound child SA.

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

 - 2.5
Status string R

The current operational state of the child SA pair.

Enumeration of:

  • Up
  • Down
  • Unknown
  • Dormant
  • Error (OPTIONAL)
 - 2.5
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.5
InboundSPI unsignedInt R The inbound child SA’s Security Parameter Index (SPI). - 2.5
OutboundSPI unsignedInt R The outbound child SA’s Security Parameter Index (SPI). - 2.5
CreationTime dateTime R The date and time when the child SA was created. - 2.5
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}.Stats. object R Statistics for this child Security Association (SA). The CPE MUST reset the child SA’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the parent ChildSA instance’s Stats parameters are reset. - 2.5
BytesSent unsignedLong R [StatsCounter64] The number of bytes handled by the outbound child SA. - 2.5
BytesReceived unsignedLong R [StatsCounter64] The number of bytes handled by the inbound child SA. - 2.5
PacketsSent unsignedLong R [StatsCounter64] The number of packets handled by the outbound child SA. - 2.5
PacketsReceived unsignedLong R [StatsCounter64] The number of packets handled by the inbound child SA. - 2.5
ErrorsSent unsignedInt R [StatsCounter32] The number of packets discarded by the outbound child SA due to any error. This can include compression errors or errors due to a lack of transmit buffers. - 2.5
DecryptionErrors unsignedInt R [StatsCounter32] The number of packets discarded by the inbound child SA due to decryption errors. - 2.5
IntegrityErrors unsignedInt R [StatsCounter32] The number of packets discarded by the inbound child SA due to integrity errors. - 2.5
ReplayErrors unsignedInt R [StatsCounter32] The number of packets discarded by the inbound child SA due to replay errors. - 2.5
PolicyErrors unsignedInt R [StatsCounter32] The number of packets discarded by the inbound child SA due to policy errors. - 2.5
OtherReceiveErrors unsignedInt R [StatsCounter32] The number of packets discarded by the inbound child SA due to errors other than decryption, integrity, replay or policy errors. This can include decompression errors or errors due to a lack of receive buffers. - 2.5
Device.GRE. object R This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. - 2.8
TunnelNumberOfEntries unsignedInt R The number of entries in the Tunnel table. - 2.8
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.8
Device.GRE.Tunnel.{i}. object(0:) W

GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

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

 - 2.8
Enable boolean W Enables or disables the tunnel. - 2.8
Status string R

The current operational state of the tunnel.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL)
 - 2.8
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.8
RemoteEndpoints string(:256)[:4]() W Comma-separated list (up to 4 items) (length ) of strings (maximum number of characters per item 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote GRE tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.8
KeepAlivePolicy string W

The mechanism used to keep the tunnel from timing out at the ConnectedRemoteEndpoint.

Enumeration of:

  • ICMP
  • None
 None 2.8
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.8
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.8
DeliveryHeaderProtocol string W

The protocol used for the delivery header.

Enumeration of:

  • IPv4
  • IPv6
 - 2.8
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.8
ConnectedRemoteEndpoint string(:256) R The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote GRE tunnel endpoint. - 2.8
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.8
Device.GRE.Tunnel.{i}.Stats. object R Statistics for this GRE tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.8
KeepAliveSent unsignedInt R [StatsCounter32] The total number of KeepAlive messages sent out the tunnel. - 2.8
KeepAliveReceived unsignedInt R [StatsCounter32] The total number of KeepAlive messages received by the tunnel. - 2.8
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by the tunnel. - 2.8
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by the tunnel. - 2.8
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by the tunnel. - 2.8
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by the tunnel. - 2.8
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.8
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
Device.GRE.Tunnel.{i}.Interface.{i}. object(0:) W

GRE Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the GRE Header as defined in [RFC2784] and extensions to the GRE Header as defined in [RFC2890]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of [RFC2890] is supported there is only one instance of this Interface object per tunnel.

At most one entry in this table 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.8
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.8
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.8
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.8
Name string(:64) R

The textual name of the interface as assigned by the CPE.

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

 - 2.8
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.8
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.8
ProtocolIdOverride unsignedInt W The Protocol ID assigned to this Interface. The Protocol Id is the EtherType value used to identify the encapsulated payload. When set to 0 the CPE determines the Protocol Id. 0 2.8
UseChecksum boolean W When true, includes the “Checksum” field in the GRE header as defined in [RFC2784]. false 2.8
KeyIdentifierGenerationPolicy string W

The method used to generate the Key Identifier extension as defined in.[RFC2890].

Enumeration of:

  • Disabled
  • Provisioned
  • CPE_Generated (The generation of the Key field is CPE specific implementation, OPTIONAL)
 Disabled 2.8
KeyIdentifier unsignedInt W When the value of KeyIdentifierGenerationPolicy is Provisioned this KeyIdentifier parameter is used to identify an individual traffic flow within a GRE tunnel, as defined in [RFC2890]. 0 2.8
UseSequenceNumber boolean W When true, includes the “SequenceNumber” field in the GRE header as defined in [RFC2890] false 2.8
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. object R Statistics for this GRE tunnel interface, i.e. all traffic that has passed through the interface. The device 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 has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.8
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by this interface. - 2.8
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by this interface. - 2.8
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by this interface. - 2.8
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by this interface. - 2.8
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.8
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
DiscardChecksumReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Checksum errors. - 2.8
DiscardSequenceNumberReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors. - 2.8
Device.GRE.Filter.{i}. object(0:) W

GRE Filter table. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions:

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.8
Enable boolean W Enables or disables this filter. false 2.8
Status string R

The status of this filter. 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.8
Order unsignedInt(1:) W Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.8
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.8
Interface string(:256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel. or Tunnel.{i}.Interface. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.8
AllInterfaces boolean W Filter criterion. This specifies that all ingress GRE tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress GRE tunnel interfaces are indicated. false 2.8
VLANIDCheck int(-1:) W Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering. -1 2.8
VLANIDExclude boolean W If false, the filter includes only those packets that match the VLANIDCheck entry, if specified. If true, the filter includes all packets except those that match the VLANIDCheck entry, if specified. false 2.8
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
  • A value of -1 indicates copy from the upstream packet.
  • A value of -2 indicates automatic marking of DSCP.
 - 2.8
Device.L2TPv3. object R This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Layer Two Tunneling Protocol version 3 (L2TPv3) ([RFC3931]). This object also provides a means to treat packets that are encapsulated within a L2TPv3 Tunnel by using a set of Filter objects to determine the treatment of the packet. - 2.12
TunnelNumberOfEntries unsignedInt R The number of entries in the Tunnel table. - 2.12
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.12
Device.L2TPv3.Tunnel.{i}. object(0:) W

L2TPv3 Tunnel table, models the L2TPv3 Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

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

 - 2.12
Enable boolean W Enables or disables the tunnel. - 2.12
Status string R

The current operational state of the tunnel.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL)
 - 2.12
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.12
RemoteEndpoints string(:256)[:4] W Comma-separated list (up to 4 items) of strings (maximum number of characters per item 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote L2TPv3 tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.12
KeepAlivePolicy string W

The mechanism used to keep the tunnel from timing out at the ConnectedRemoteEndpoint.

Enumeration of:

 None 2.12
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.12
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.12
DeliveryHeaderProtocol string W

The protocol used for the delivery header.

Enumeration of:

  • IPv4
  • IPv6
 - 2.12
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.12
TunnelEncapsulation string W

The protocol that this Tunnel will be encapsulated

Enumeration of:

  • IP
  • UDP
 IP 2.12
ConnectedRemoteEndpoint string(:256) R The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote L2TPv3 tunnel endpoint. - 2.12
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.12
Device.L2TPv3.Tunnel.{i}.UDP. object R This UDP provides the parameters when the value of the Tunnel.{i}.TunnelEncapsulation parameter is UDP. - 2.12
SourcePort unsignedInt(:65535) W The source (local) port used to transmit PDUs. A value of 0 indicates that the port selection is performed by the device. 1701 2.12
RemotePort unsignedInt(:65535) W The remote port used to by the remote endpoint to transmit PDUs. 1701 2.12
EnableChecksum boolean W Enables or disables checksum processing. false 2.12
Device.L2TPv3.Tunnel.{i}.Stats. object R Statistics for this L2TPv3 tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
KeepAliveSent unsignedInt R [StatsCounter32] The total number of KeepAlive messages sent out the tunnel. - 2.12
KeepAliveReceived unsignedInt R [StatsCounter32] The total number of KeepAlive messages received by the tunnel. - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by the tunnel. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by the tunnel. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by the tunnel. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by the tunnel. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
Device.L2TPv3.Tunnel.{i}.Interface.{i}. object(0:) W

L2TPv3 Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the L2TPv3 Header as defined in [RFC3931] and the transport of L2 frames across over L2TPv3 as defined in [RFC4719]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the L2TPv3 Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface.

At most one entry in this table 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.12
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
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.12
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.12
Name string(:64) R

The textual name of the interface as assigned by the CPE.

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

 - 2.12
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.12
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.12
SessionID int(-1,1:65535) W The unique Session ID to be used in the L2TPv3 header of the tunnel. A Session ID with a value of -1 indicates that he CPE is to generate the session ids for this Interface instance. 1 2.12
CookiePolicy string W

The policy that defines how the Cookie is handled in this Interface instance.

Enumeration of:

  • Disabled (The device does not perform Cooking processing)
  • Configured (The value of the Cookie parameter is transmitted in the L2TPv3 header)
  • Generated (The device generates the value of the Cookie transmitted in the L2TPv3 header)
 Configured 2.12
Cookie unsignedLong W The Cookie transmitted in the L2TPv3 header. The default is to set the Cookie to the device’s MAC address that is encoded in the low order 6 bytes. - 2.12
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. object R Statistics for this L2TPv3 tunnel interface, i.e. all traffic that has passed through the interface. The device 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 has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by this interface. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by this interface. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by this interface. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by this interface. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
DiscardChecksumReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Checksum errors. - 2.12
DiscardSequenceNumberReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors. - 2.12
Device.L2TPv3.Filter.{i}. object(0:) W

L2TPv3 Filter table. Entries in this table are applied against the packets that are to be encapsulated within the L2TPv3 Tunnel based on the following conditions:

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.12
Enable boolean W Enables or disables this filter. false 2.12
Status string R

The status of this filter. 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.12
Order unsignedInt(1:) W Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.12
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.12
Interface string(:256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel. or Tunnel.{i}.Interface. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.12
AllInterfaces boolean W Filter criterion. This specifies that all ingress L2TPv3 tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress L2TPv3 tunnel interfaces are indicated. false 2.12
VLANIDCheck int(-1:) W Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering. -1 2.12
VLANIDExclude boolean W If false, the filter includes only those packets that match the VLANIDCheck entry, if specified. If true, the filter includes all packets except those that match the VLANIDCheck entry, if specified. false 2.12
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
  • A value of -1 indicates copy from the upstream packet.
  • A value of -2 indicates automatic marking of DSCP.
 - 2.12
Device.VXLAN. object R This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Virtual eXtensible Local Area Network (VXLAN) ([RFC7348]). This object also provides a means to treat packets that are encapsulated within a VXLAN Tunnel by using a set of Filter objects to determine the treatment of the packet. - 2.12
TunnelNumberOfEntries unsignedInt R The number of entries in the Tunnel table. - 2.12
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.12
Device.VXLAN.Tunnel.{i}. object(0:) W

VXLAN Tunnel table, models the VXLAN Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

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

 - 2.12
Enable boolean W Enables or disables the tunnel. - 2.12
Status string R

The current operational state of the tunnel.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL)
 - 2.12
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.12
RemoteEndpoints string(:256)[:4] W Comma-separated list (up to 4 items) of strings (maximum number of characters per item 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote VXLAN tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.12
KeepAlivePolicy string W

The mechanism used to keep the tunnel from timing out at the ConnectedRemoteEndpoint.

Enumeration of:

 None 2.12
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.12
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.12
DeliveryHeaderProtocol string W

The protocol used for the delivery header.

Enumeration of:

  • IPv4
  • IPv6
 - 2.12
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.12
ConnectedRemoteEndpoint string(:256) R The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote VXLAN tunnel endpoint. - 2.12
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.12
SourcePort unsignedInt(:65535) W The source (local) port used to transmit PDUs. A value of 0 indicates that the port selection is performed by the device. In such case, it is recommended that the UDP source port number be calculated using a hash of fields from the inner packet and that it is in the dynamic/private port range 49152-65535. 0 2.12
RemotePort unsignedInt(:65535) W The remote port used to by the remote endpoint to transmit PDUs. The well-known port allocated by IANA is 4789, but it should be configurable. 4789 2.12
Device.VXLAN.Tunnel.{i}.Stats. object R Statistics for this VXLAN tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
KeepAliveSent unsignedInt R [StatsCounter32] The total number of KeepAlive messages sent out the tunnel. - 2.12
KeepAliveReceived unsignedInt R [StatsCounter32] The total number of KeepAlive messages received by the tunnel. - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by the tunnel. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by the tunnel. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by the tunnel. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by the tunnel. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
Device.VXLAN.Tunnel.{i}.Interface.{i}. object(0:) W

VXLAN Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the VXLAN Header as defined in [RFC7348] for the transport of L2 frames across over VXLAN. The Interface object provides a way to discriminate how multiple LAN segments are encapsulated within the VXLAN Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface.

At most one entry in this table 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.12
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
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.12
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.12
Name string(:64) R

The textual name of the interface as assigned by the CPE.

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

 - 2.12
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.12
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.12
VNI int(-1:16777215,0:16777215) W The unique Virtual Network Identifier (VNI) to be used in the VXLAN header of the tunnel. A VNI with a value of -1 indicates that the CPE is to generate the VNI for this Interface instance. 1 2.12
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. object R Statistics for this VXLAN tunnel interface, i.e. all traffic that has passed through the interface. The device 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 has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by this interface. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by this interface. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by this interface. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by this interface. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
DiscardChecksumReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Checksum errors. - 2.12
DiscardSequenceNumberReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors. - 2.12
Device.VXLAN.Filter.{i}. object(0:) W

VXLAN Filter table. Entries in this table are applied against the packets that are to be encapsulated within the VXLAN Tunnel based on the following conditions:

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.12
Enable boolean W Enables or disables this filter. false 2.12
Status string R

The status of this filter. 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.12
Order unsignedInt(1:) W Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.12
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.12
Interface string(:256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel. or Tunnel.{i}.Interface. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.12
AllInterfaces boolean W Filter criterion. This specifies that all ingress VXLAN tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress VXLAN tunnel interfaces are indicated. false 2.12
VLANIDCheck int(-1:) W Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering. -1 2.12
VLANIDExclude boolean W If false, the filter includes only those packets that match the VLANIDCheck entry, if specified. If true, the filter includes all packets except those that match the VLANIDCheck entry, if specified. false 2.12
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
  • A value of -1 indicates copy from the upstream packet.
  • A value of -2 indicates automatic marking of DSCP.
 - 2.12
Device.MAP. object R The Mapping of Address and Port (MAP) object [RFC7597] [RFC7599] [RFC7598]. This object applies only to gateway devices that support IPv4 on the LAN side, include a NAT, and typically have only IPv6 connectivity on the WAN side. See the MAP Theory of Operation [Appendix XV/TR-181i2a8] for a description of the working of this MAP data model. - 2.8
Enable boolean W Enables or disables MAP. - 2.8
DomainNumberOfEntries unsignedInt R The number of entries in the Domain table. - 2.8
Device.MAP.Domain.{i}. object(0:) W

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

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

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

 - 2.8
Enable boolean W Enables or disables the MAP domain. false 2.8
Status string R

The current operational state of the MAP domain. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured (OPTIONAL)
  • Error (OPTIONAL)
 - 2.8
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.8
TransportMode string W

The transport mode to use. Corresponds to the [RFC7598] S46_CONT_MAPE and S46_CONT_MAPT container options.

Enumeration of:

 Translation 2.8
WANInterface string W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP interface with which this MAP domain is associated. This will always be a NAT-ted upstream (WAN) interface. The End-user IPv6 prefix IPv6Prefix is one of this IP interface’s prefixes. The MAP IPv6 address is derived from the End-user IPv6 prefix and is one of this IP interface’s IP addresses, with an IP.Interface.{i}.IPv6Address.{i}.Origin of MAP. - 2.8
IPv6Prefix string W The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The MAP domain’s End-user IPv6 prefix. This MUST reference one of WANInterface’s prefixes. If the ACS configures this prefix directly, the CPE MUST use the ACS-configured prefix. Otherwise, the CPE MUST select one of WANInterface’s prefixes; the selected prefix will typically have IP.Interface.{i}.IPv6Prefix.{i}.Origin = PrefixDelegation. - 2.8
BRIPv6Prefix string(:49) W [IPv6Prefix] The MAP Border Relay (BR) address or prefix.
  • For MAP-E this is the BR address and therefore MUST be a /128 [RFC7597]. Note this address can be an IPv6 anycast address. This address corresponds to the [RFC7598] OPTION_S46_BR (Border Relay) option.
  • For MAP-T this is the BR prefix [RFC7599]. This address prefix corresponds to the [RFC7598] OPTION_S46_DMR (Default Mapping Rule) option. Note: There will be a corresponding Routing.Router.{i}.IPv4Forwarding default rule.
 - 2.8
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with this MAP domain. Downstream packets are never re-marked. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
  • A value of -1 indicates copy from the incoming packet.
  • A value of -2 indicates automatic marking of DSCP.
 - 2.8
PSIDOffset unsignedInt(0:15) W Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field. This parameter is DEPRECATED because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. 6 2.8
PSIDLength unsignedInt(0:16) W The length in bits of the Port-set id (PSID) configured in the PSID parameter. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID-len field. This parameter is DEPRECATED because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. 0 2.8
PSID unsignedInt(0:65535) W Port-set ID (PSID) to use in preference to the value extracted from the Embedded Address (EA) bits. Only the high order PSIDLength bits of the PSID value are used, so the parameter is ignored when PSIDLength is zero. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID field. This parameter is DEPRECATED because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object. 0 2.8
IncludeSystemPorts boolean W Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range [0:2^(16-{{param: reference to deprecated parameter Device.MAP.Domain.{i}.PSIDOffset}})-1] are excluded, e.g. for the default {{param: reference to deprecated parameter Device.MAP.Domain.{i}.PSIDOffset}} value of 4, ports [0:4095] are not included in the Port-sets. This parameter is related to [RFC7597]’s N, which is defined as the number of ports (e.g., 1024) excluded from the lower end of the range. The parameter is relevant only when {{param: reference to deprecated parameter Device.MAP.Domain.{i}.PSIDOffset}} is 0; false corresponds to N=1024 and true corresponds to N=0. false 2.8
RuleNumberOfEntries unsignedInt R The number of entries in the Rule table. - 2.8
Device.MAP.Domain.{i}.Rule.{i}. object(0:) W

The MAP domain’s Mapping Rules [RFC7597]. The rule with the longest match between its IPv6Prefix and the end-user IPv6Prefix is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule.

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

 - 2.8
Enable boolean W Enable or disable this Rule instance. false 2.8
Status string R

The status of this Rule instance. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.8
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.8
Origin string R

The mechanism via which the Rule was created. If the CPE supports MAP configuration via both DHCPv6 and CWMP, it is up to the implementation to determine how the two mechanisms will interact.

Enumeration of:

  • DHCPv6 (Created via a [RFC7598] S46_RULE option)
  • Static (Present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
 Static 2.8
IPv6Prefix string(:49) W [IPv6Prefix] The Rule IPv6 prefix. The Rule IPv6 prefix is a leading part of the end-user IPv6Prefix, i.e. its length MUST be less than or equal to the length of the end-user IPv6Prefix, and it MUST match the end-user IPv6Prefix. Corresponds to the [RFC7598] S46_RULE option’s ipv6-prefix field. /0 2.8
IPv4Prefix string(:49) W [IPv4Prefix] The Rule IPv4 prefix. Corresponds to the [RFC7598] S46_RULE option’s ipv4-prefix field. /0 2.8
EABitsLength unsignedInt(0:48) W The length in bits of the Embedded Address (EA) bits in the end-user IPv6Prefix. Corresponds to the [RFC7598] S46_RULE option’s ea-len field. 0 2.8
IsFMR boolean W Indicates whether this rule is a Forwarding Mapping Rule (FMR), i.e. can be used for forwarding. Corresponds to the [RFC7598] S46_RULE option’s flags field’s F-Flag. false 2.8
PSIDOffset unsignedInt(0:15) W Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field. 6 2.12
PSIDLength unsignedInt(0:16) W The length in bits of the Port-set id (PSID) configured in the PSID parameter. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID-len field. 0 2.12
PSID unsignedInt(0:65535) W Port-set ID (PSID) to use in preference to the value extracted from the Embedded Address (EA) bits. Only the high order PSIDLength bits of the PSID value are used, so the parameter is ignored when PSIDLength is zero. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID field. 0 2.12
Device.MAP.Domain.{i}.Interface. object R MAP interface (a stackable interface object as described in [Section 4.2/TR-181i2]). This models the LAN side MAP domain interface. - 2.8
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. false 2.8
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.8
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.8
Name string(:64) R The textual name of the interface as assigned by the CPE. - 2.8
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.8
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 this interface object is a MAP domain interface, it is expected that LowerLayers will not be used. - 2.8
Device.MAP.Domain.{i}.Interface.Stats. object R Throughput statistics for this MAP domain 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.8
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.8
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.8
PacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
PacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
ErrorsSent unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
ErrorsReceived unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
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.8
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.8
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.

Active Notification requests for this parameter MAY be denied.

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

Active Notification requests for this parameter MAY be denied.

 - 2.8
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.8
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.8
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. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. - 2.8
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. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. - 2.8
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] 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.8
Device.CaptivePortal. object R This object contains parameters relating to the captive portal configuration on the CPE. The captive portal configuration defines the CPE’s upstream HTTP (port 80) traffic redirect behavior. When the captive portal is disabled, upstream HTTP (port 80) traffic MUST be permitted to all destinations. When the captive portal is enabled, upstream HTTP (port 80) traffic MUST be permitted only to destinations listed in the AllowedList; traffic to all other destinations MUST be redirected to the URL. - 2.0
Enable boolean W Enables or disables the captive portal. - 2.0
Status string R

Indicates the status of the captive portal. Enumeration of:

  • Disabled
  • Enabled
  • Error_URLEmpty (URL is an empty string)
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.0
AllowedList string[](:10000) W Comma-separated list (maximum number of characters 10000) of strings. List items represent IP addresses to which HTTP (port 80) traffic MUST always be permitted, regardless of whether the captive portal is enabled. Each entry in the list MUST be either an IP address, or an IP prefix specified using Classless Inter-Domain Routing (CIDR) notation [RFC4632]. An IP prefix is specified as an IP address followed (with no intervening white space) by “/n”, 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 prefix. IPv4 example:
  • 1.2.3.4 specifies a single IPv4 address, and 1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0.
  • 1.2.0.0/22 represents the 1024 IPv4 addresses from 1.2.0.0 to 1.2.3.255. IPv6 example:
  • fec0::220:edff:fe6a:f76 specifies a single IPv6 address.
  • 2001:edff:fe6a:f76::/64 represents the IPv6 addresses from 2001:edff:fe6a:f76:0:0:0:0 to 2001:edff:fe6a:f76:ffff:ffff:ffff:ffff.
 - 2.0
URL string(:2000) W Captive portal URL to which upstream HTTP (port 80) traffic to destinations not listed in the AllowedList will be redirected. The captive portal URL MUST be an HTTP (not HTTPS) URL. The CPE MUST permit the captive portal URL to be set to an empty string, which has the effect of disabling the captive portal (if Enable is true and the captive portal URL is an empty string, Status MUST be Error_URLEmpty). - 2.0
Device.Routing. object R Routing object that contains the Router table and RIP protocol object. - 2.0
RouterNumberOfEntries unsignedInt R The number of entries in the Router table. - 2.0
Device.Routing.Router.{i}. object(0:) W

This object allows the handling of the routing and forwarding configuration of the device.

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

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

The status of this Router entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
IPv4ForwardingNumberOfEntries unsignedInt R The number of entries in the IPv4Forwarding table. - 2.0
IPv6ForwardingNumberOfEntries unsignedInt R The number of entries in the IPv6Forwarding table. - 2.2
Device.Routing.Router.{i}.IPv4Forwarding.{i}. object(0:) W

Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination address/mask are considered, and the matching entry with the longest prefix is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero. For enabled table entries, if Interface is not a valid reference to an IPv4-capable interface (that is attached to the IPv4 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The IPv4Forwarding 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 IPv4Forwarding row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending IPv4Forwarding 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 DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric.

 - 2.0
Enable boolean W Enables or disables the forwarding entry. On creation, an entry is disabled by default. false 2.0
Status string R

Indicates the status of the forwarding entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.
 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
StaticRoute boolean R If true, this route is a Static route. true 2.0
DestIPAddress string(:45) W [IPv4Address] Destination IPv4 address. An empty string indicates no destination address is specified. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string is a default route. <Empty> 2.0
DestSubnetMask string(:45) W [IPv4Address] Destination subnet mask. An empty string indicates no destination subnet mask is specified. If a destination subnet mask is specified, the DestSubnetMask is ANDed with the destination address before comparing with the DestIPAddress. Otherwise, the full destination address is used as is. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string is a default route. <Empty> 2.0
ForwardingPolicy int(-1:) W Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the Device.QoS object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows. -1 2.0
GatewayIPAddress string(:45) W [IPv4Address] IPv4 address of the gateway. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. <Empty> 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the egress layer 3 interface associated with this entry. Example: Device.IP.Interface.1. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. For a route that was configured by setting GatewayIPAddress but not Interface, read access to Interface MUST return the full hierarchical parameter name for the routes egress interface. <Empty> 2.0
Origin string R

Protocol via which the IPv4 forwarding rule was learned. Enumeration of:

  • DHCPv4
  • OSPF
  • IPCP
  • RIP
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
 Static 2.2
ForwardingMetric int(-1:) W Forwarding metric. A value of -1 indicates this metric is not used. -1 2.0
Device.Routing.Router.{i}.IPv6Forwarding.{i}. object(0:) W

Layer 3 IPv6 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, and RA. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination prefix are considered, and the matching entry with the longest prefix length is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. This object is based on inetCidrRouteTable from [RFC4292].

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 DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric.

 - 2.2
Enable boolean W Enables or disables this IPv6Forwarding entry. false 2.2
Status string R

Indicates the status of the forwarding 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.2
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.2
DestIPPrefix string(:49) W [IPv6Prefix] Destination IPv6 prefix. An empty string indicates that it matches all destination prefixes (i.e. equivalent to “::/0”). All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 destination, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128. <Empty> 2.2
ForwardingPolicy int(-1:) W Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the QoS object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows. -1 2.2
NextHop string(:45) W [IPv6Address] IPv6 address of the next hop. Only one of NextHop and Interface SHOULD be configured for a route. An empty string indicates no NextHop is specified. If both are configured, NextHop and Interface MUST be consistent with each other. <Empty> 2.2
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the egress layer 3 interface associated with this entry. Example: Device.IP.Interface.1. Only one of NextHop and Interface SHOULD be configured for a route. An empty string indicates no Interface is specified. If both are configured, NextHop and Interface MUST be consistent with each other. For a route that was configured by setting NextHop but not Interface, read access to Interface MUST return the full hierarchical parameter name for the route’s egress interface. <Empty> 2.2
Origin string R

Protocol via which the IPv6 forwarding rule was learned. Enumeration of:

  • DHCPv6
  • OSPF
  • RA (Router Advertisement Route Information Option [RFC4191])
  • RIPng (RIPng for IPv6 [RFC2080])
  • Static (For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI))
 Static 2.2
ForwardingMetric int(-1:) W Forwarding metric. A value of -1 indicates this metric is not used. -1 2.2
ExpirationTime dateTime R The time at which the route will expire, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. ExpirationTime is provided by an underlying dynamic routing protocol, e.g. by an [RFC4191] route information option. 9999-12-31T23:59:59Z 2.2
Device.Routing.RIP. object R Routing Information Protocol (RIP) object. - 2.0
Enable boolean W Enables or disables RIP on the device. - 2.0
SupportedModes string R

The supported RIP protocol modes. Enumeration of:

  • Send
  • Receive
  • Both
 - 2.0
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.0
Device.Routing.RIP.InterfaceSetting.{i}. object(0:) W

IP Interface RIP configuration table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting 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 InterfaceSetting 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 InterfaceSetting row. Note: This object only applies to RIP2; i.e. version 2 of the RIP protocol is used to accept or send over the specified Interface.

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

 - 2.0
Enable boolean W Enables or disables this 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
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the IP interface associated with this InterfaceSetting entry. <Empty> 2.0
AcceptRA boolean W When set to true, RIP route advertisements received over Interface are accepted. When set to false, RIP route advertisements received over Interface are rejected. - 2.0
SendRA boolean W When set to true, RIP route advertisements are to be sent over Interface. When set to false, no RIP route advertisements will be sent over Interface. - 2.0
Device.Routing.RouteInformation. object R Received Router Advertisement (RA) route information [RFC4191]. - 2.2
Enable boolean W Enables or disables receiving route information from the RA. - 2.2
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.2
Device.Routing.RouteInformation.InterfaceSetting.{i}. object(0:) R

IP Interface RA route information table. Contains received RA route information [RFC4191]. As such, the data in this table cannot be modified.

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

 - 2.2
Status string R

The status of this entry. Enumeration of:

  • ForwardingEntryCreated
  • NoForwardingEntry
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.2
Interface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the IP interface associated with this InterfaceSetting entry. - 2.2
SourceRouter string(:45) R [IPv6Address] IPv6 Address of the router that sent the RA that included this route info. - 2.2
PreferredRouteFlag string R

Flag included in a specific Route Information Option within an RA message (Prf flag), as defined in [Section 2.3/RFC4191]. Enumeration of:

  • High
  • Medium
  • Low Note that this is not the Prf flag included in the base RA message. Also see [Section 2.1/RFC4191] which discusses how this flag is encoded on the wire.
 - 2.2
Prefix string(:49) R [IPv6Prefix] IPv6 address prefix, as received in an instance of the Route Information Option of a RA message. - 2.2
RouteLifetime dateTime R The time at which Prefix will cease to be usable for use as a forwarding entry, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. RouteLifetime is received in an instance of the Route Information Option of a RA message. - 2.2
Device.NeighborDiscovery. object R The Neighbor Discovery Protocol (NDP) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. - 2.2
Enable boolean W Enables or disables Neighbor Discovery. - 2.2
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.2
Device.NeighborDiscovery.InterfaceSetting.{i}. object(0:) W

Per-interface Neighbor Discovery Protocol (NDP) configuration [RFC4861]. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting 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 InterfaceSetting 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 InterfaceSetting 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 Interface.

 - 2.2
Enable boolean W Enables or disables this InterfaceSetting entry. false 2.2
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.2
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.2
Interface string W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the IP interface associated with this InterfaceSetting entry. <Empty> 2.2
RetransTimer unsignedInt W Retransmission interval in milliseconds, as defined in [RFC4861]. For auto-configuration purposes, RetransTimer specifies the delay between consecutive Neighbor Solicitation transmissions performed during Duplicate Address Detection (DAD) [Section 5.4/RFC4862], as well as the time a node waits after sending the last Neighbor Solicitation before ending the DAD process. 1000 2.2
RtrSolicitationInterval unsignedInt W Retransmission interval in milliseconds, as defined in [RFC4861]. For auto-configuration purposes, RtrSolicitationInterval specifies the delay between consecutive Router Solicitation transmissions. 4 2.2
MaxRtrSolicitations unsignedInt W Maximum Number of Router Solicitation Transmission messages, as defined in [RFC4861]. For auto-configuration purposes MaxRtrSolicitations specifies the Maximum Number of Router Solicitation Transmission messages to help the host to conclude that there are no routers on the link. 3 2.2
NUDEnable boolean W Enables or disables Neighbor Unreachability Detection (NUD) [Section 7/RFC4861]. - 2.2
RSEnable boolean W Enables or disables Router Solicitation (RS) on Interface [Section 4.1/RFC4861]. - 2.2
Device.RouterAdvertisement. object R The Router Advertisement (RA) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the RA configuration for individual IP interfaces. Information received via router advertisement messages is automatically propagated to the relevant IP.Interface sub-objects, e.g. to the IP.Interface.{i}.IPv6Address and IP.Interface.{i}.IPv6Prefix tables. - 2.2
Enable boolean W Enables or disables Router Advertisement. - 2.2
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.2
Device.RouterAdvertisement.InterfaceSetting.{i}. object(0:) W

Per-interface Router Advertisement (RA) configuration [RFC4861]. Table entries are created for use in sending Router Advertisements. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting 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 InterfaceSetting 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 InterfaceSetting 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 Interface.

 - 2.2
Enable boolean W Enables or disables this InterfaceSetting entry. Defines the value of the IsRouter and AdvSendAdvertisements flags from [Section 4.2/RFC4861] false 2.2
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.2
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.2
Interface string W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the IP interface associated with this InterfaceSetting entry. <Empty> 2.2
ManualPrefixes string[:8]() W Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes that will be sent in Router Advertisement messages. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. Router Advertisement messages MUST include Prefix Information Options [RFC4861] for all Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) prefixes in this list. Prefixes MUST be associated with the interface instance referenced by Interface. <Empty> 2.2
Prefixes string[:8]() R Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes that will be included in Router Advertisement (RA) messages sent out this interface. This list can include: - 2.2
MaxRtrAdvInterval unsignedInt(4:1800) W The maximum time allowed between sending unsolicited multicast Router Advertisements from the interface, in seconds (see [Section 4.2/RFC4861]). 600 2.2
MinRtrAdvInterval unsignedInt(3:1350) W The minimum time allowed between sending unsolicited multicast Router Advertisements from the interface, in seconds (see [Section 4.2/RFC4861]). The value MUST be no greater than 3/4 * MaxRtrAdvInterval. Note: The 1350 maximum was derived from the RFC, based on 3/4 times the maximum value of MaxRtrAdvInterval. Similarly, the 200 default was derived from the RFC, based on 1/3 times the default value of MaxRtrAdvInterval. 200 2.2
AdvDefaultLifetime unsignedInt(:65535) W The value placed in the “Router Lifetime” field of Router Advertisement messages on this interface, in seconds (see [Section 4.2/RFC4861]). The value can be zero or between MaxRtrAdvInterval and 9000 seconds, but these limits can be overridden by specific documents that describe how IPv6 operates over different link layers. A value of zero indicates that the router is not to be used as a default router. Note: The 1800 default was derived from the RFC, based on 3 times the default value of MaxRtrAdvInterval. 1800 2.2
AdvManagedFlag boolean W The value placed in the “Managed address configuration” (M) flag field of Router Advertisement messages on this interafce (see [Section 4.2/RFC4861], and [RFC4862]). false 2.2
AdvOtherConfigFlag boolean W The value placed in the “Other configuration” (O) flag field of Router Advertisement messages on this interface (see [Section 4.2/RFC4861], and [RFC4862]). false 2.2
AdvMobileAgentFlag boolean W The value placed in the “Home agent” (H) flag field of Router Advertisement messages on this interface (see [Section 7.1/RFC3775]). false 2.2
AdvPreferredRouterFlag string W

The value placed in the “Default Router Preference” (Prf) field of Router Advertisement messages on this interface, as defined in [Section 2.2/RFC4191]. Enumeration of:

  • High
  • Medium
  • Low Also see [Section 2.1/RFC4191] which discusses how this flag is encoded on the wire.
 Medium 2.2
AdvNDProxyFlag boolean W The value placed in the “Proxy” (P) flag field of Router Advertisement messages on this interface (see [Section 4.1.3.3/RFC4389]). false 2.2
AdvLinkMTU unsignedInt W The value placed in MTU options of Router Advertisement messages on this interface. A value of zero indicates that no MTU options are included (see [Section 4.6.4/RFC4861]). 0 2.2
AdvReachableTime unsignedInt(:3600000) W The value placed in the “Reachable Time” field of Router Advertisement messages on this interface, in milliseconds (see [Section 4.2/RFC4861]). The value zero means unspecified (by the router). 0 2.2
AdvRetransTimer unsignedInt W The value placed in the “Retrans Timer” field of Router Advertisement messages on this interface (see [Section 4.2/RFC4861]). The value zero means unspecified (by the router). 0 2.2
AdvCurHopLimit unsignedInt(:255) W The value placed in the “Cur Hop Limit” field of Router Advertisement messages on this interface (see [Section 4.2/RFC4861]). The value zero means unspecified (by the router). Note: The default can be overridden with the value specified in [RFC3232] that was in effect at the time of implementation. 0 2.2
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.2
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}. object(0:) W

This object specifies the options in a Router Advertisement (RA) message [Section 4.6/RFC4861]. Option entries are created for use in sending Router Advertisements (enabled options MUST be included in RA messages sent). This includes support for sending DNS information in the RA message as described in [RFC6106]. This table is intended only for options that are not modeled elsewhere. For example, it is not appropriate for the MTU option (which is modeled via AdvLinkMTU).

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

 - 2.2
Enable boolean W Enables or disables this Option entry. false 2.2
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.2
Tag unsignedInt(0:65535) W Option tag (type) [Section 4.6/RFC4861]. - 2.2
Value hexBinary(0:65535) W A hexbinary encoded option value [Section 4.6/RFC4861]. - 2.2
Device.IPv6rd. object R Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in [RFC5969]. The 6rd mechanism is intended to be implemented only on what [RFC5969] refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. See the 6rd Theory of Operation [Appendix VI/TR-181i2a2] for a description of the working of this 6rd data model. - 2.2
Enable boolean W Enables or disables IPv6rd. - 2.2
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.2
Device.IPv6rd.InterfaceSetting.{i}. object(0:) R

6rd [RFC5969] settings. A 6rd delegated prefix is expected to be of maximum length 64 bits, and is the concatenation of the following two items:

  • Service provider IPv6 prefix: specified via the SPIPv6Prefix parameter
  • IPv4 address suffix: the IPv4 address with the first IPv4MaskLength bits removed This object definition is derived from [RFC5969] with some minor nomenclature changes.

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

 - 2.2
Enable boolean W Enable or disable this InterfaceSetting instance. - 2.2
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.2
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.2
BorderRelayIPv4Addresses string(:45)[:4]() W [IPv4Address] Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items are the IPv4 addresses (possibly anycast) of the 6rd Relay(s). - 2.2
AllTrafficToBorderRelay boolean W If true, the destination address for all 6rd traffic will be set (IPv4 destination address) to one of the BorderRelayIPv4Addresses. If false, traffic whose destination address begins with the same prefix as SPIPv6Prefix will be sent directly to the destination IPv4 address of the endpoint, which is in the same 6rd domain. See 6rd Theory of Operation for further explanation [Appendix VI/TR-181i2a2]. - 2.2
SPIPv6Prefix string(:49) W [IPv6Prefix] The Service Provider’s 6rd IPv6 prefix for this deployment and this 6rd RG. - 2.2
IPv4MaskLength unsignedInt(0:32) W The number of high-order bits that are identical across all IPv4 addresses within a given 6rd domain. This number of bits MUST be removed from the start of the IPv4 address when generating the 6rd delegated prefix. For example, if this value is 8, only the final 24 bits of the subscriber IPv4 prefix will be used when creating the IPv6 delegated prefix, determining the destination IPv4 encapsulation address, etc. If the value is 0, then the whole 32 bits of the IPv4 address are used in the encoding. - 2.2
AddressSource string(:256) W The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv4Address. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the IPv4 address that is the source of the IPv4 address embedded in the IPv6 6rd prefix, and used as the source encapsulating IPv4 address. If the value is an empty string or this parameter is not present, the device will use internal logic to determine which IPv4 source address to use. - 2.2
TunnelInterface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunnel that is logically the tunnel entry point for upstream IPv6 traffic and is also logically the tunnel exit point for downstream IPv6 traffic (i.e. the entry point for non-tunneled upstream IPv6 traffic to enter a tunnel and become tunneled, or conversely, the exit point for downstream IPv6 traffic leaving a tunnel after being un-tunneled). IPv6 traffic that enters TunnelInterface from the LAN is expected to continue on through TunneledInterface, and traffic from the WAN is expected to come from TunneledInterface into TunnelInterface. TunnelInterface is a logical interface that can allow for classification, marking (of IPv6 headers), and policing of IPv6 traffic that will be going over a 6rd tunnel. These functions are modeled in the QoS. object. TunnelInterface can be used also to represent the 6rd virtual interface defined in [RFC5969]. Note: In 6rd, IPv6 packets arriving over one or more device LAN IP interfaces are logically fed into this TunnelInterface. Likewise, 6rd traffic from the WAN gets logically sent from this TunnelInterface to LAN IP interfaces. - 2.2
TunneledInterface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunneled that provides information about the IPv4 headers used to encapsulate the IPv6 packets. Encapsulated IPv6 traffic that enters TunneledInterface from the WAN is expected to continue on through TunnelInterface, and traffic from the LAN is expected to come from TunnelInterface into TunneledInterface. TunneledInterface is a logical interface that can allow for classification, marking (of IPv4 headers and VLAN tags), and policing of IPv4 packets that encapsulate IPv6 packets in 6rd traffic. These functions are modeled in the QoS. object. Note: In 6rd, TunneledInterface traffic originating from the LAN logically feeds into a WAN-side IPv4 capable IP interface that the “IPv6 6rd tunnel” goes over. 6rd traffic that enters over this IPv4 WAN interface gets logically sent to this TunneledInterface. - 2.2
Device.DSLite. object R Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in [DSLite]. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. See the Dual-Stack Lite Theory of Operation [Appendix VII/TR-181i2a2] for a description of the working of this DS-Lite data model. - 2.2
Enable boolean W Enables or disables DSLite. - 2.2
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.2
Device.DSLite.InterfaceSetting.{i}. object(0:) R

DSLite [DSLite] settings.

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

 - 2.2
Enable boolean W Enable or disable this InterfaceSetting instance. - 2.2
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.2
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.2
EndpointAssignmentPrecedence string W

Indicates the preferred method to be used in assigning values to EndpointName when both static and dynamic values are available. See EndpointName for further clarification.

Enumeration of:

  • DHCPv6
  • Static

The factory default value MUST be DHCPv6.

 - 2.2
EndpointAddressTypePrecedence string W

Indicates the preferred method to be used to assign the address of the DS-Lite Endpoint when both EndpointName and EndpointAddress values are available and the Static method is used. See EndpointName and EndpointAddress for further clarification.

Enumeration of:

 - 2.5
EndpointAddressInUse string(:45) R [IPv6Address] Indicates the address currently in use for the tunnel concentrator (remote endpoint). It is derived from the values of the EndpointAssignmentPrecedence, EndpointAddressTypePrecedence, EndpointName and EndpointAddress parameters. It is an empty string if no endpoint address is currently known. - 2.5
EndpointName string(:256) W The Fully Qualified Domain Name (FQDN) of the tunnel concentrator (remote endpoint). This parameter is based on OPTION_DS_LITE_NAME from [Section 4/DSLite-options] and can be assigned statically (e.g. present in the factory default configuration or set by the ACS) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then EndpointAssignmentPrecedence indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to EndpointName. Note: EndpointName is only writable when EndpointAssignmentPrecedence is Static; otherwise, EndpointName is automatically configured via the DHCPv6 received option. - 2.2
EndpointAddress string(:45) W [IPv6Address] The address of the tunnel concentrator (remote endpoint). This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the ACS). - 2.2
Origin string R

Method used to assign EndpointAddressInUse.

Enumeration of:

  • DHCPv6 (Assigned by DHCPv6 [RFC3315])
  • Static (For example, present in the factory default configuration, set by the ACS, or set by some other management entity (e.g. via a GUI))
 - 2.2
TunnelInterface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunnel that is logically the tunnel entry point for upstream IPv4 traffic and is also logically the tunnel exit point for downstream IPv4 traffic (i.e. the entry point for non-tunneled upstream IPv4 traffic to enter a tunnel and become tunneled, or conversely, the exit point for downstream IPv4 traffic leaving a tunnel after being un-tunneled). IPv4 traffic that enters TunnelInterface is expected to continue on through TunneledInterface from the LAN, and traffic from the WAN is expected to come from TunneledInterface into TunnelInterface. TunnelInterface is a logical interface that can allow for classification, marking (of IPv4 headers), and policing of IPv4 traffic that will be going over a DS-Lite tunnel. These functions are modeled in the Device.QoS object. Note: In DS-Lite, IPv4 packets arriving over one or more device LAN IP interfaces are logically fed into this TunnelInterface. Likewise, DS-Lite traffic from the WAN gets logically sent from this TunnelInterface to LAN IP interfaces. - 2.2
TunneledInterface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is an IP interface of Type Tunneled that provides information about the IPv6 headers used to encapsulate the IPv4 packets. Encapsulated IPv4 traffic that enters TunneledInterface from the WAN is expected to continue on through TunnelInterface, and traffic from the LAN is expected to come from TunnelInterface into TunneledInterface. TunneledInterface is a logical interface that can allow for classification, marking (of IPv6 headers and VLAN tags), and policing of IPv6 packets that encapsulate IPv4 packets in DS-Lite traffic. These functions are modeled in the QoS. object. Note: In DS-Lite, TunneledInterface traffic originating from the LAN logically feeds into a WAN-side IPv6 capable IP interface that the “DSLite IPv4-in-IPv6 tunnel” goes over. DS-Lite traffic that enters over this IPv6 WAN interface gets logically sent to this TunneledInterface. - 2.2
Device.QoS. object R Queue management configuration object. - 2.0
MaxClassificationEntries unsignedInt R

The maximum number of entries available in the Classification table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ClassificationNumberOfEntries unsignedInt R The number of entries in the Classification table. - 2.0
MaxAppEntries unsignedInt R

The maximum number of entries available in the App table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
AppNumberOfEntries unsignedInt R The number of entries in the App table. - 2.0
MaxFlowEntries unsignedInt R

The maximum number of entries available in the Flow table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
FlowNumberOfEntries unsignedInt R The number of entries in the Flow table. - 2.0
MaxPolicerEntries unsignedInt R

The maximum number of entries available in the Policer table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
PolicerNumberOfEntries unsignedInt R The number of entries in the Policer table. - 2.0
MaxQueueEntries unsignedInt R

The maximum number of entries available in the Queue table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
QueueNumberOfEntries unsignedInt R The number of entries in the Queue table. - 2.0
QueueStatsNumberOfEntries unsignedInt R The number of entries in the QueueStats table. - 2.0
MaxShaperEntries unsignedInt R

The maximum number of entries available in the Shaper table.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ShaperNumberOfEntries unsignedInt R The number of entries in the Shaper table. - 2.0
DefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic not associated with any specified classifier. - 2.0
DefaultTrafficClass unsignedInt W Identifier of the traffic class associated with traffic not associated with any specified classifier. - 2.0
DefaultPolicer string(:256) W The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic not associated with any specified classifier. An empty string indicates a null policer. - 2.0
DefaultQueue string(:256) W The value MUST be the Path Name of a row in the Queue. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Queue table entry for traffic not associated with any specified classifier. Note: The interpretation of an empty string value is implementation specific. - 2.0
DefaultDSCPMark int(-2:) W DSCP to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. - 2.0
DefaultEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2a5]. - 2.0
DefaultInnerEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic of the inner VLAN Tag as defined in 802.1Q, when the PDU is not associated with any specified classifier. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. - 2.7
AvailableAppList string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. List items represent URNs, each indicating a protocol supported for use as a ProtocolIdentifier in the App table. This list MAY include any of the URNs defined in [Annex A/TR-181i2] as well as other URNs defined elsewhere. - 2.0
Device.QoS.Classification.{i}. object(0:) W

Classification table. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Several of this object’s parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as classification criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType 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 this classifier. false 2.0
Status string R

The status of this classifier. 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
Order unsignedInt(1:) W Position of the Classification entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the classification criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Classification table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 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
DHCPType string W

The DHCP protocol associated with the Classification instance. Affects only parameters that specify DHCP option values as classification criteria (all such parameter descriptions note this fact). Enumeration of:

 DHCPv4 2.2
Interface string(:256) W Classification criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Classifications can be instantiated is a local matter to the CPE. Note that this parameter is permitted to reference Tunnel instances in order to classify upstream packets that have just been encapsulated (such packets are conceptually similar to locally-generated traffic). For example, this parameter might reference a GRE.Tunnel or a MAP.Domain instance. <Empty> 2.0
AllInterfaces boolean W Classification criterion. This specifies that all ingress interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress interfaces are indicated. false 2.0
DestIP string(:45) W [IPAddress] Classification criterion. Destination IP address. An empty string indicates this criterion is not used for classification. <Empty> 2.0
DestMask string(:49) W [IPPrefix] Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.0
DestIPExclude boolean W If false, the class includes only those packets that match the (masked) DestIP entry, if specified. If true, the class includes all packets except those that match the (masked) DestIP entry, if specified. false 2.0
SourceIP string(:45) W [IPAddress] Classification criterion. Source IP address. An empty string indicates this criterion is not used for classification. <Empty> 2.0
SourceMask string(:49) W [IPPrefix] Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.0
SourceIPExclude boolean W If false, the class includes only those packets that match the (masked) SourceIP entry, if specified. If true, the class includes all packets except those that match the (masked) SourceIP entry, if specified. false 2.0
Protocol int(-1:255) W Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. -1 2.0
ProtocolExclude boolean W If false, the class includes only those packets that match the Protocol entry, if specified. If true, the class includes all packets except those that match the Protocol entry, if specified. false 2.0
DestPort int(-1:65535) W Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. -1 2.0
DestPortRangeMax int(-1:65535) W Classification criterion. If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. -1 2.0
DestPortExclude boolean W If false, the class includes only those packets that match the DestPort entry (or port range), if specified. If true, the class includes all packets except those that match the DestPort entry (or port range), if specified. false 2.0
SourcePort int(-1:65535) W Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. -1 2.0
SourcePortRangeMax int(-1:65535) W Classification criterion. If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. -1 2.0
SourcePortExclude boolean W If false, the class includes only those packets that match the SourcePort entry (or port range), if specified. If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified. false 2.0
SourceMACAddress string(:17) W [MACAddress] Classification criterion. Source MAC Address. An empty string indicates this criterion is not used for classification. <Empty> 2.0
SourceMACMask string(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the SourceMACAddress is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the SourceMACAddress are to be used for classification. <Empty> 2.0
SourceMACExclude boolean W If false, the class includes only those packets that match the (masked) SourceMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) SourceMACAddress entry, if specified. false 2.0
DestMACAddress string(:17) W [MACAddress] Classification criterion. Destination MAC Address. An empty string indicates this criterion is not used for classification. The use of destination MAC address as a classification criterion is primarily useful only for bridged traffic. <Empty> 2.0
DestMACMask string(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the DestMACAddress is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the DestMACAddress are to be used for classification. <Empty> 2.0
DestMACExclude boolean W If false, the class includes only those packets that match the (masked) DestMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) DestMACAddress entry, if specified. false 2.0
Ethertype int(-1:) W Classification criterion. Ethertype as indicated in either the Ethernet or SNAP Type header. A value of -1 indicates this criterion is not used for classification. -1 2.0
EthertypeExclude boolean W If false, the class includes only those packets that match the Ethertype entry, if specified. If true, the class includes all packets except those that match the Ethertype entry, if specified. false 2.0
SSAP int(-1:) W Classification criterion. SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. -1 2.0
SSAPExclude boolean W If false, the class includes only those packets that match the SSAP entry, if specified. If true, the class includes all packets except those that match the SSAP entry, if specified. false 2.0
DSAP int(-1:) W Classification criterion. DSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. -1 2.0
DSAPExclude boolean W If false, the class includes only those packets that match the DSAP entry, if specified. If true, the class includes all packets except those that match the DSAP entry, if specified. false 2.0
LLCControl int(-1:) W Classification criterion. Control element in the LLC header. A value of -1 indicates this criterion is not used for classification. -1 2.0
LLCControlExclude boolean W If false, the class includes only those packets that match the LLCControl entry, if specified. If true, the class includes all packets except those that match the LLCControl entry, if specified. false 2.0
SNAPOUI int(-1:) W Classification criterion. OUI element in the SNAP header. A value of -1 indicates this criterion is not used for classification. -1 2.0
SNAPOUIExclude boolean W If false, the class includes only those packets that match the SNAPOUI entry, if specified. If true, the class includes all packets except those that match the SNAPOUI entry, if specified. false 2.0
SourceVendorClassID string(:255) W Classification criterion. Used to identify one or more LAN devices, value of the DHCPv4 Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in SourceVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. <Empty> 2.0
SourceVendorClassIDv6 hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in [RFC3315]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. <Empty> 2.2
SourceVendorClassIDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceVendorClassID entry (for DHCPv4) or the SourceVendorClassIDv6 entry (for DHCPv6), if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorClassID entry (for DHCPv4) or the SourceVendorClassIDv6 entry (for DHCPv6), if specified. false 2.0
SourceVendorClassIDMode string W

SourceVendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if SourceVendorClassID is “Example” then an Option 60 value of “Example device” will match with SourceVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
 Exact 2.0
DestVendorClassID string(:255) W Classification criterion. Used to identify one or more LAN devices, value of the DHCPv4 Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in DestVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv4-specific. It only applies when DHCPType is DHCPv4. <Empty> 2.0
DestVendorClassIDv6 hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in [RFC3315]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. <Empty> 2.2
DestVendorClassIDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestVendorClassID entry (for DHCPv4) or the DestVendorClassIDv6 entry (for DHCPv6), if specified. If true, the class includes all packets except those destined for LAN devices that match the DestVendorClassID entry (for DHCPv4) or the DestVendorClassIDv6 entry (for DHCPv6), if specified. false 2.0
DestVendorClassIDMode string W

DestVendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if DestVendorClassID is “Example” then an Option 60 value of “Example device” will match with DestVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
 Exact 2.0
SourceClientID hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. <Empty> 2.0
SourceClientIDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceClientID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceClientID entry, if specified. false 2.0
DestClientID hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. <Empty> 2.0
DestClientIDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestClientID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestClientID entry, if specified. false 2.0
SourceUserClassID hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. <Empty> 2.0
SourceUserClassIDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceUserClassID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceUserClassID entry, if specified. false 2.0
DestUserClassID hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC3315]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. <Empty> 2.0
DestUserClassIDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestUserClassID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestUserClassID entry, if specified. false 2.0
SourceVendorSpecificInfo hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in SourceVendorSpecificInfoEnterprise and SourceVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in [RFC3315]) for DHCPv6. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. <Empty> 2.0
SourceVendorSpecificInfoExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. false 2.0
SourceVendorSpecificInfoEnterprise unsignedInt W SourceVendorSpecificInfo Enterprise Number as defined in [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. 0 2.0
SourceVendorSpecificInfoSubOption int(0:255) W SourceVendorSpecificInfo Sub Option Code as defined in [RFC3925]. 0 2.0
DestVendorSpecificInfo hexBinary(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in DestVendorSpecificInfoEnterprise and DestVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in [RFC3315]) for DHCPv6. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. <Empty> 2.0
DestVendorSpecificInfoExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. false 2.0
DestVendorSpecificInfoEnterprise unsignedInt W DestVendorSpecificInfo Enterprise Number as defined in [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. 0 2.0
DestVendorSpecificInfoSubOption int(0:255) W DestVendorSpecificInfo Sub Option Code as defined in [RFC3925]. 0 2.0
TCPACK boolean W Classification criterion. If false, this criterion is not used for classification. If true, this criterion matches with all TCP segments that have the ACK control bit set. false 2.0
TCPACKExclude boolean W If false, the class includes only those packets that match the TCPACK entry, if specified. If true, the class includes all packets except those that match the TCPACK entry, if specified. false 2.0
IPLengthMin unsignedInt W Classification criterion. Minimum IP Packet Length (including header) in bytes. 0 2.0
IPLengthMax unsignedInt W Classification criterion. Maximum IP Packet Length (including header) in bytes. A value of zero indicates that no maximum is specified (an umlimited maximum length). 0 2.0
IPLengthExclude boolean W If false, the class includes only those packets whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. A value of zero for both IPLengthMin and IPLengthMax allows any length packet. An equal non-zero value of IPLengthMin and IPLengthMax allows only a packet with the exact length specified. If true, the class includes all packets except those whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. false 2.0
DSCPCheck int(-1:63) W Classification criterion. DiffServ codepoint (defined in [RFC2474]). If set to a Class Selector Codepoint (defined in [RFC2474]), all DSCP values that match the first 3 bits will be considered a valid match. A value of -1 indicates this criterion is not used for classification. -1 2.0
DSCPExclude boolean W If false, the class includes only those packets that match the DSCPCheck entry, if specified. If true, the class includes all packets except those that match the DSCPCheck entry, if specified. false 2.0
DSCPMark int(-2:) W Classification result. DSCP to mark traffic with that falls into this classification entry. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. -1 2.0
EthernetPriorityCheck int(-1:) W Classification criterion. Current Ethernet priority of a VLAN Tag as defined in [802.1Q-2011] or Ethernet Priority field as defined in 802.1D. If more than 1 VLAN tag is present, then this parameter represents the outer VLAN Tag. A value of -1 indicates this criterion is not used for classification. -1 2.0
EthernetPriorityExclude boolean W If false, the class includes only those packets that match the EthernetPriorityCheck entry, if specified. If true, the class includes all packets except those that match the EthernetPriorityCheck entry, if specified. false 2.0
EthernetPriorityMark int(-2:) W Classification result. Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic with that falls into this classification entry associated with the EthernetPriorityCheck. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. -1 2.0
InnerEthernetPriorityCheck int(-1:) W Classification criterion. Current Ethernet priority of the inner VLAN Tag as defined in 802.1Q. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates this criterion is not used for classification. -1 2.7
InnerEthernetPriorityExclude boolean W If false, the class includes only those packets that match the InnerEthernetPriorityCheck entry, if specified. If true, the class includes all packets except those that match the InnerEthernetPriorityCheck entry, if specified. false 2.7
InnerEthernetPriorityMark int(-2:) W Classification result. Ethernet priority code to mark traffic with that falls into this classification entry associated with the InnerEthernetPriorityCheck. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. -1 2.7
EthernetDEICheck int(-1:) W Classification criterion. Current Ethernet Drop eligible Indication (DEI) of the VLAN tag as defined in 802.1Q. If 2 VLAN Tags are present, then this parameter represents the outer VLAN tag. A value of -1 indicates this criterion is not used for classification. -1 2.7
EthernetDEIExclude boolean W If false, the class includes only those packets that match the EthernetDEICheck entry, if specified. If true, the class includes all packets except those that match the EthernetDEICheck entry, if specified. false 2.7
VLANIDCheck int(-1:) W Classification criterion. Current Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for classification. -1 2.0
VLANIDExclude boolean W If false, the class includes only those packets that match the VLANIDCheck entry, if specified. If true, the class includes all packets except those that match the VLANIDCheck entry, if specified. false 2.0
OutOfBandInfo int(-1:) W Classification criterion. Allows traffic to be distinguished based on out-of-band information such as physical port or application ID. Primarily intended for, but not restricted to, locally sourced traffic. If specified, this entry applies to traffic with matching out-of-band information. A value of -1 indicates this criterion is not used for classification. -1 2.0
ForwardingPolicy unsignedInt W Classification result. Identifier of the forwarding policy associated with traffic that falls in this classification. 0 2.0
TrafficClass int(-1:) W Classification result. Identifier of the traffic class associated with traffic that falls in this classification. If specified, at least one Queue table entry MUST include this traffic class in its Queue.{i}.TrafficClasses parameter (which is a comma-separated list). A value of -1 indicates a null traffic class. TrafficClass and App are mutually exclusive and one of the two MUST be specified. If TrafficClass is -1, App MUST be specified, and vice versa. -1 2.0
Policer string(:256) W Classification result. The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic that falls in this classification. An empty string indicates a null policer. Policer MAY optionally be specified in conjunction with TrafficClass. Policer and App are mutually exclusive. <Empty> 2.0
App string(:256) W Classification result. The value MUST be the Path Name of a row in the App. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the App table entry for traffic that falls in this classification. An empty string indicates a null App. TrafficClass and App are mutually exclusive and one of the two MUST be specified. If TrafficClass is null, App MUST be specified, and vice versa. <Empty> 2.0
Device.QoS.App.{i}. object(0:) W

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

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

The status of this App table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
ProtocolIdentifier string(:256) W URN identifying the protocol associated with the given application. A set of defined URNs is given in [Annex A/TR-181i2]. <Empty> 2.0
Name string(:64) W Human-readable name associated with this entry in the App table. <Empty> 2.0
DefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic associated with this App table entry, but not associated with any specified flow. 0 2.0
DefaultTrafficClass unsignedInt W Identifier of the traffic class associated with traffic associated with this App table entry, but not associated with any specified flow. 0 2.0
DefaultPolicer string(:256) W The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic associated with this App table entry, but not associated with any specified flow. An empty string indicates a null policer. <Empty> 2.0
DefaultDSCPMark int(-2:) W DSCP to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. -1 2.0
DefaultEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2a5]. -1 2.0
DefaultInnerEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark the inner VLAN Tags as defined in 802.1Q with this App table entry where the packet is not associated with any specified flow. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. - 2.7
Device.QoS.Flow.{i}. object(0:) W

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

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

The status of this Flow table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
Type string(:256) W URN identifying the type of flow to be associated with the specified policer. A set of defined URNs is given in [Annex A/TR-181i2]. <Empty> 2.0
TypeParameters string(:256) W List of name-value pairs representing additional criteria to identify the flow type. The use and interpretation is specific to the particular FlowType URN.Encoded using the “x-www-form-urlencoded” content type defined in [HTML4.01]. <Empty> 2.0
Name string(:64) W Human-readable name associated with this entry in the Flow table. <Empty> 2.0
App string(:256) W The value MUST be the Path Name of a row in the App. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the App table entry associated with this flow. An empty string indicates the flow table is not associated with any App table entry. <Empty> 2.0
ForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with this flow. 0 2.0
TrafficClass unsignedInt W Identifier of the traffic class associated with this flow. 0 2.0
Policer string(:256) W The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic that falls in this flow. An empty string indicates a null policer. <Empty> 2.0
DSCPMark int(-2:) W DSCP to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. -1 2.0
EthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2a5]. -1 2.0
InnerEthernetPriorityMark int(-2:) W Ethernet priority code (as defined in [802.1Q-2011]) to mark the inner VLAN Tags with for traffic that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2]. -1 2.7
Device.QoS.Policer.{i}. object(0:) W

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

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

The status of this policer. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
CommittedRate unsignedInt W Committed rate allowed for this policer in bits per second. 0 2.0
CommittedBurstSize unsignedInt W Committed Burstsize in bytes. 0 2.0
ExcessBurstSize unsignedInt W Excess Burstsize in bytes. Applied for a SingleRateThreeColor meter. 0 2.0
PeakRate unsignedInt W Peak rate allowed for this Meter in bits per second. Applied for TwoRateThreeColor meters. 0 2.0
PeakBurstSize unsignedInt W Peak Burstsize in bytes. Applied for TwoRateThreeColor meters. 0 2.0
MeterType string W

The value MUST be a member of the list reported by the PossibleMeterTypes parameter. Identifies the method of traffic measurement to be used for this policer. Each list item is an enumeration of:

 SimpleTokenBucket 2.0
PossibleMeterTypes string[] R

Comma-separated list of strings. Indicates supported meter types.

Each list item is an enumeration of:

  • SimpleTokenBucket
  • SingleRateThreeColor
  • TwoRateThreeColor

Active Notification requests for this parameter MAY be denied.

 - 2.0
ConformingAction string W

Instructions for how to handle traffic that is conforming. Possible patterns:

  • Null
  • Drop
  • [0-9]|[1-5][0-9]|6[0-3] ()
  • :[0-7] ()
  • ([0-9]|[1-5][0-9]|6[0-3]):[0-7] () Null corresponds with no action. is an unsigned integer that corresponds with a mark action overwriting the traffic’s DSCP with the configured DSCP. <:Ethernet Priority> is a colon (“:”) followed by an unsigned integer (no white space). It corresponds with a mark action overwriting the traffic’s Ethernet Priority with the configured Ethernet Priority. is an unsigned integer followed by a colon (“:”) and a second unsigned integer (no white space). It corresponds with a mark action overwriting the traffic’s DSCP and Ethernet Priority with the configured values. For example, “24” specifies a DSCP value of 24, “:3” specifies an Ethernet Priority of 3, and “24:3” specifies both.
 Null 2.0
PartialConformingAction string W

Instructions for how to handle traffic that is partially conforming (colored yellow). Possible patterns:

  • Null
  • Drop
  • [0-9]|[1-5][0-9]|6[0-3] ()
  • :[0-7] ()
  • ([0-9]|[1-5][0-9]|6[0-3]):[0-7] () Null corresponds with no action. is an unsigned integer that corresponds with a mark action overwriting the traffic’s DSCP with the configured DSCP.Only applies for three-color meters. <:Ethernet Priority> is a colon (“:”) followed by an unsigned integer (no white space). It corresponds with a mark action overwriting the traffic’s Ethernet Priority with the configured Ethernet Priority. is an unsigned integer followed by a colon (“:”) and a second unsigned integer (no white space). It corresponds with a mark action overwriting the traffic’s DSCP and Ethernet Priority with the configured values. For example, “24” specifies a DSCP value of 24, “:3” specifies an Ethernet Priority of 3, and “24:3” specifies both.
 Drop 2.0
NonConformingAction string W

Instructions for how to handle traffic that is non-conforming. Possible patterns:

  • Null
  • Drop
  • [0-9]|[1-5][0-9]|6[0-3] ()
  • :[0-7] ()
  • ([0-9]|[1-5][0-9]|6[0-3]):[0-7] () Null corresponds with no action. is an unsigned integer that corresponds with a mark action overwriting the traffic’s DSCP with the configured DSCP. <:Ethernet Priority> is a colon (“:”) followed by an unsigned integer (no white space). It corresponds with a mark action overwriting the traffic’s Ethernet Priority with the configured Ethernet Priority. is an unsigned integer followed by a colon (“:”) and a second unsigned integer (no white space). It corresponds with a mark action overwriting the traffic’s DSCP and Ethernet Priority with the configured values. For example, “24” specifies a DSCP value of 24, “:3” specifies an Ethernet Priority of 3, and “24:3” specifies both.
 Drop 2.0
TotalCountedPackets unsignedInt R

Total number of Packets counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
TotalCountedBytes unsignedInt R

Total number of Bytes counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
ConformingCountedPackets unsignedInt R

Number of conforming Packets counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
ConformingCountedBytes unsignedInt R

Number of conforming Bytes counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
PartiallyConformingCountedPackets unsignedInt R

Number of partially conforming Packets counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
PartiallyConformingCountedBytes unsignedInt R

Number of partially conforming Bytes counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
NonConformingCountedPackets unsignedInt R

Number of non-conforming Packets counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
NonConformingCountedBytes unsignedInt R

Number of non-conforming Bytes counted by this policer, regardless of meter action.

Active Notification requests for this parameter MAY be denied.

 0 2.0
Device.QoS.Queue.{i}. object(0:) W

Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

The status of this queue. 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. Each list item identifies the set of traffic classes associated with this queue. Traffic is sent to this queue if a Classification, App or Flow table entry specifies a traffic class, e.g. via the Classification.{i}.TrafficClass parameter. If more than one queue on a given egress interface is associated with a given traffic class, the implementation will choose which queue to send traffic of this class to. <Empty> 2.0
Interface string(:256) W The value MUST be the Path Name of a table row. Specifies the egress interface for which the specified queue MUST exist. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Queues can be instantiated is a local matter to the CPE. <Empty> 2.0
AllInterfaces boolean W Indicates that the specified queue MUST exist for all egress interfaces (i.e. this queue entry is to apply to all egress interfaces). If true, the value of Interface is ignored since all egress interfaces are indicated. false 2.0
HardwareAssisted boolean R Indicates whether all the queues corresponding to this table entry are hardware assisted. If any of the queues corresponding to this table entry are not hardware assisted, the parameter value MUST be false. false 2.0
BufferLength unsignedInt R Number of bytes in the buffer. Queue buffer size for all egress interfaces for which this queue exists. If the buffer size is not the same for all such egress interfaces, this parameter MUST be 0. - 2.0
Weight unsignedInt W Weight of this queue in case of WFQ or WRR, but only used for queues of equal precedence. 0 2.0
Precedence unsignedInt(1:) W Precedence of this queue relative to others. Lower numbers imply greater precedence. 1 2.0
REDThreshold unsignedInt(:100) W Random Early Detection threshold, used only when DropAlgorithm is RED. This is the minimum threshold (min_th) and is measured as a percentage of the queue size. If the value is set to zero, the CPE MUST choose a sensible value, e.g. 5 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the maximum threshold (max_th). The CPE MUST choose a sensible value, e.g. three times the minimum threshold. In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. 0 2.0
REDPercentage unsignedInt(:100) W Random Early Detection percentage, used only when DropAlgorithm is RED. This is the maximum value of the packet marking probability (max_p). If the value is set to zero, the CPE MUST choose a sensible value, e.g. 10 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. 0 2.0
DropAlgorithm string W

Dropping algorithm used for this queue if congested.

Enumeration of:

  • RED (Random Early Detection [RED])
  • DT (Drop Tail)
  • WRED (Weighted RED)
  • BLUE ([BLUE])
 DT 2.0
SchedulerAlgorithm string W

Scheduling Algorithm used by scheduler.

Enumeration of:

  • WFQ (Weighted Fair Queueing)
  • WRR (Weighted Round Robin)
  • SP (Strict Priority)
 SP 2.0
ShapingRate int(-1:) W Rate to shape this queue’s traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the egress will be on a PPP or IP link with a specified ShapingRate, the percentage is calculated relative to this rate. Otherwise, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. -1 2.0
ShapingBurstSize unsignedInt W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. - 2.0
Device.QoS.QueueStats.{i}. object(0:) W

Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The QueueStats 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 QueueStats row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending QueueStats row.

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

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

The status of this object.

Enumeration of:

  • Disabled
  • Enabled (Enabled and {Queue,Interface} is valid)
  • Error (Enabled but {Queue,Interface} is invalid)
 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
Queue string(:256) W The value MUST be the Path Name of a row in the Queue. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates Queue entry with which this object is associated. <Empty> 2.0
Interface string(:256) W The value MUST be the Path Name of a table row. Specifies the egress interface for which this object contains statistics. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which QueueStats can be instantiated is a local matter to the CPE. <Empty> 2.0
OutputPackets unsignedInt R

Number of packets output through the queue.

Active Notification requests for this parameter MAY be denied.

 0 2.0
OutputBytes unsignedInt R

Number of bytes output through the queue.

Active Notification requests for this parameter MAY be denied.

 0 2.0
DroppedPackets unsignedInt R

Number of packets dropped by the queue.

Active Notification requests for this parameter MAY be denied.

 0 2.0
DroppedBytes unsignedInt R

Number of bytes dropped by the queue.

Active Notification requests for this parameter MAY be denied.

 0 2.0
QueueOccupancyPackets unsignedInt R

Queue occupancy in packets (gives a measure of queue latency).

Active Notification requests for this parameter MAY be denied.

 0 2.0
QueueOccupancyPercentage unsignedInt(0:100) R

Queue occupancy measured as a percent, i.e. 100 * queue occupancy in bytes / queue size in bytes (gives a measure of queue usage).

Active Notification requests for this parameter MAY be denied.

 0 2.0
Device.QoS.Shaper.{i}. object(0:) W

Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Shaper 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 Shaper 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 Shaper 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 Interface.

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

The status of this shaper. 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
Interface string(:256) W The value MUST be the Path Name of a table row.The interface object associated with this Shaper entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Shapers can be instantiated is a local matter to the CPE. <Empty> 2.0
ShapingRate int(-1:) W Rate to shape the associated interface connection’s egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. -1 2.0
ShapingBurstSize unsignedInt W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. - 2.0
Device.LANConfigSecurity. object R This object contains generic device configuration information. - 2.0
ConfigPassword string(:64) W

A password to allow LAN access to protected auto-configuration services. If the CPE supports TR-064 (LAN-side DSL CPE Configuration Protocol), this parameter is to be used as the dslf-config password (as defined in TR-064). If the CPE has a user interface with password protection enabled, this parameter is also to be used as the user password for password-protected operations. However, this parameter MUST NOT be used to set the user password if the parameter UserInterface.PasswordUserSelectable is true.

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

 - 2.0
Device.Hosts. object R This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. - 2.0
HostNumberOfEntries unsignedInt R The number of entries in the Host table. - 2.0
Device.Hosts.Host.{i}. object(0:) R

Host table.

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

 - 2.0
Alias string(:64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value. This parameter is DEPRECATED because Host is a transient object.
 - 2.0
PhysAddress string(:64) R Unique physical identifier of the host. For many layer 2 technologies this is typically a MAC address. - 2.0
IPAddress string(:45) R [IPAddress] Current IP Address of the host. An empty string if no address is available. If more than one IP address for this host is known, the CPE will choose a primary address. All known IP addresses can be listed in the IPv4Address and IPv6Address tables. - 2.0
AddressSource string R

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

  • DHCP
  • Static
  • AutoIP
  • None This parameter is DEPRECATED because only None and DHCP made sense (the CPE doesn’t know whether the address is Static or AutoIP). The DHCP case is now handled via the DHCPClient reference.
 - 2.0
DHCPClient string[:2]() R Comma-separated list (up to 2 items) (length ) of strings. Each list item MUST be the Path Name of a row in the DHCPv4.Server.Pool.{i}.Client. or DHCPv6.Server.Pool.{i}.Client. tables. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each list item is the DHCPv4 or DHCPv6 server’s client entry that corresponds to the host. - 2.2
LeaseTimeRemaining int(-1:) R DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease. The value MUST be 0 (zero) if the AddressSource is not DHCP. This parameter is DEPRECATED because DHCP lease/lifetime information can be accessed via the DHCPClient reference. - 2.0
AssociatedDevice string(:256) R The value MUST the path name of the AssociatedDevice (or equivalent) table row that models the host, or an empty string if there is no such table. For example: Device.WiFi.AccessPoint.1.AssociatedDevice.2 - 2.2
Layer1Interface string(:256) R The value MUST be the path name of a row in a layer 1 interface table. If the layer 1 device isn’t known, then Layer1Interface will be an empty string. For example: Device.Ethernet.Interface.2 - 2.0
Layer3Interface string(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the entry represents a non-IP device, then Layer3Interface will be an empty string. - 2.0
VendorClassID string(:255) R Vendor Class Identifier DHCP option (Option 60) of the host. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter is DEPRECATED because host-supplied DHCP options can be accessed via the DHCPClient reference. - 2.0
ClientID hexBinary(:65535) R A hexbinary string, Client Identifier DHCP option (Option 61) for the specific IP connection of the client. The option value is binary, so an exact match is REQUIRED. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter is DEPRECATED because host-supplied DHCP options can be accessed via the DHCPClient reference. - 2.0
UserClassID hexBinary(:65535) R A hexbinary string, User Class Identifier DHCP option (Option 77) of the host. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. This parameter is DEPRECATED because host-supplied DHCP options can be accessed via the DHCPClient reference. - 2.0
HostName string(:64) R The device’s host name or an empty string if unknown. - 2.0
Active boolean R Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, Active MUST be set to false for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days. - 2.0
ActiveLastChange dateTime R The datetime when Active last changed from true to false or from false to true. The initial detection of a host SHOULD be treated as a transition from false to true, showing the datetime when the host was first detected. The ability to list inactive hosts is OPTIONAL. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days. - 2.10
IPv4AddressNumberOfEntries unsignedInt R The number of entries in the IPv4Address table. - 2.2
IPv6AddressNumberOfEntries unsignedInt R The number of entries in the IPv6Address table. - 2.2
Device.Hosts.Host.{i}.IPv4Address.{i}. object(0:) R

The host’s known IPv4 addresses. This includes any addresses assigned via DHCP, which can also be accessed via the DHCPClient reference.

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

 - 2.2
IPAddress string(:45) R [IPv4Address] IPv4 address. - 2.2
Device.Hosts.Host.{i}.IPv6Address.{i}. object(0:) R

The host’s known IPv6 addresses. This includes any addresses assigned via DHCP, which can also be accessed via the DHCPClient reference.

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

 - 2.2
IPAddress string(:45) R [IPv6Address] IPv6 address. - 2.2
Device.Hosts.Host.{i}.WANStats. object R These count bytes or packets at the IP layer sent to the WAN, or received from the WAN. - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the WAN from the Host device at the IP layer. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the WAN and sent to the Host device at the IP layer. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of IP packets transmitted to the WAN from the Host device. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of IP packets received from the WAN and sent to the Host device. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound IP packets to the WAN from the Host device that could not be transmitted because of errors. These may be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.12
RetransCount unsignedInt R [StatsCounter32] The total number of transmitted IP packets to the WAN from the Host device which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.12
DiscardPacketsSent unsignedInt R

[StatsCounter32] The total number of outbound IP 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.12
Device.DNS. object R Properties for Domain Name Service (DNS). - 2.0
SupportedRecordTypes string[] R

Comma-separated list of strings. The DNS record types that are supported by the device. Each list item is an enumeration of:

 - 2.2
Device.DNS.Client. object R Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. - 2.0
Enable boolean W Enables or disables the DNS client. - 2.0
Status string R

The status of the DNS client. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.0
ServerNumberOfEntries unsignedInt R The number of entries in the Server table. - 2.0
Device.DNS.Client.Server.{i}. object(0:) W

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

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
DNSServer string(:45) W [IPAddress] DNS server IP addresses. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information. - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter specifies the IP interface over which the DNS query is sent. If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP, IPCP, or RA received DNS server information. <Empty> 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

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

The status of the DNS relay. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.0
ForwardNumberOfEntries unsignedInt R The number of entries in the Forwarding table. - 2.0
Device.DNS.Relay.Forwarding.{i}. object(0:) W

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

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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
DNSServer string(:45) W [IPAddress] DNS server IP addresses. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, or RA received DNS server information. - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the IP interface over which the DNS query is sent. If an empty string is specified, the CPE MUST use its routing policy (IP Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP, IPCP, or RA received DNS server information. <Empty> 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

  • DHCP (Replaced by DHCPv4, DEPRECATED)
  • DHCPv4
  • DHCPv6
  • RouterAdvertisement
  • IPCP
  • Static Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entires will have their Type set to Static.
 Static 2.0
Device.DNS.Diagnostics. object R The DNS Diagnostics object containing the NSLookupDiagnostics test. - 2.0
Device.DNS.Diagnostics.NSLookupDiagnostics. object R This object defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated. - 2.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_DNSServerNotResolved (Unable to resolve DNSServer Name, 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) 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 table row. This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. - 2.0
HostName string(:256) W Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name. - 2.0
DNSServer string(:256) W Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If an empty string is specified, the device’s default DNS server will be used. - 2.0
Timeout unsignedInt W Timeout in milliseconds that indicates that a request has failed. - 2.0
NumberOfRepetitions unsignedInt W The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data. - 2.0
SuccessCount unsignedInt R

Number of successfully executed repetitions.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ResultNumberOfEntries unsignedInt R

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

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.DNS.Diagnostics.NSLookupDiagnostics.Result.{i}. object(0:) R Results from the most recent invocation of the test, one instance per repetition. - 2.0
Status string R

Result Parameter to represent whether the NS Lookup was successful or not. Errors for individual Result instances do not get bubbled up to DiagnosticsState. A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that DiagnosticsState SHOULD be Error_Other.

Enumeration of:

  • Success
  • Error_DNSServerNotAvailable
  • Error_HostNameNotResolved
  • Error_Timeout
  • Error_Other

Active Notification requests for this parameter MAY be denied.

 - 2.0
AnswerType string R

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

Enumeration of:

  • None (Indicates that the NS Lookup failed to find the host)
  • Authoritative
  • NonAuthoritative

Active Notification requests for this parameter MAY be denied.

 - 2.0
HostNameReturned string(:256) R

Result parameter to represent the fully qualified name for the Host Name in the calling parameter (e.g. HostName.DomainName); if no response was provided, then this parameter is an empty string.

Active Notification requests for this parameter MAY be denied.

 - 2.0
IPAddresses string(:45)[:10]() R

[IPAddress] Comma-separated list (up to 10 items) (length ) of IP Addresses. Indicates the IP Address results returned by the NS Lookup; if no response was provided, then this parameter is an empty string.

Active Notification requests for this parameter MAY be denied.

 - 2.0
DNSServerIP string(:45) R

[IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ResponseTime unsignedInt R

Response time (for the first response packet) in milliseconds, or 0 if no response was received.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.DNS.SD. object R This object contains the DNS Service Discovery [DNS-SD] object and parameters necessary to discover services and their associated devices. Upon reboot the the contents of the service table are repopulated. When the DNS.SD service is disabled, the contents of the service table is implementation specific. - 2.6
Enable boolean W The parameter, when true, enables the discovery of DNS-SD services hosted by other devices. - 2.6
ServiceNumberOfEntries unsignedInt R The number of entries in the Service table. - 2.6
AdvertisedInterfaces string[] W Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance from which DNS-SD services are advertised. If the referenced object is deleted, the corresponding item MUST be removed from the list. If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces. - 2.12
Device.DNS.SD.Service.{i}. object(0:) R

The Service table contains discovered DNS-SD services. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form: Service Instance Name = . . = _ . _ RFC2782 Service field will always be equal to . RFC2782 Name field will always be equal to For example, an SSH service might have: *InstanceName = “Secure Shell (SSH))” *ApplicationProtocol = “ssh” *TransportProtocol = “TCP” *Domain = “example.com” *Port = 22 *Target = “ssh.example.com.”

At most one entry in this table can exist with the same values for all of InstanceName, ApplicationProtocol, TransportProtocol and Domain.

 - 2.6
InstanceName string(:63) R Human-readable instance name [Section 4.1.1 Instance Names/DNS-SD] (i.e. The “<InstanceName>” portion of the ‘“Service Instance Name’“). - 2.6
ApplicationProtocol string(:15) R The Application Protocol, without the leading underscore, associated with the service (e.g., daap) as defined by the DNS-SD service [Section 7 Application Protocol Names/DNS-SD]. - 2.6
TransportProtocol string R

The Transport Protocol associated with the service as defined by the DNS-SD service [Section 4.1.2 Service Names/DNS-SD].

Enumeration of:

  • TCP
  • UDP
 - 2.6
Domain string(:256) R The value extracted from the Name field of the DNS SRV record [RFC2782] which represents the fully qualified domain name (FQDN) associated with the service as defined by the DNS-SD service [Section 4.1.3 Domain Names/DNS-SD]. - 2.6
Port unsignedInt(:65535) R The value extracted from the Port field of the DNS SRV record [RFC2782] that is used to contact the service. - 2.6
Target string(:256) R The fully qualified domain name (FQDN) with the trailing dot “.” of the target host implementing the service as in the DNS SRV record [RFC2782]. - 2.6
Status string R

The status of the discovered Service at LastUpdate time. Enumeration of:

  • LeaseActive (The Service has received a response record with TTL > 0 and the Service.{i}.TimeToLive has not expired yet. The Service is considered active)
  • GoodbyeReceived (The device has received a response record containing TTL=0 indicating a goodbye message and the Service.{i}.TimeToLive has not expired yet. The Service is considered inactive)
  • LeaseExpired (The Service.{i}.TimeToLive has expired. The Service is considered inactive) The ability to instantiate an inactive Service is OPTIONAL. The time an inactive Service remains listed in this table is a local matter to the device.
 - 2.6
LastUpdate dateTime R The date and time at which the last advertisement for this Service was received. - 2.6
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of all Host table entries, active or inactive, that correspond to this discovered DNS.SD service. As such, when entries are added or removed from the Host tables the value of this parameter MUST be updated accordingly. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.6
TimeToLive unsignedInt(:2147483647) R The value extracted from the TTL field of the DNS SRV record [RFC2782]. - 2.6
Priority unsignedInt(:65535) R The value extracted from the Priority field of the DNS SRV record [RFC2782]. - 2.6
Weight unsignedInt(:65535) R A server selection mechanism. The value extracted from the Weight field of the DNS SRV record [RFC2782] that specifies the relative weight for entries with the same Priority. - 2.6
TextRecordNumberOfEntries unsignedInt R The number of entries in the TextRecord table. - 2.6
Device.DNS.SD.Service.{i}.TextRecord.{i}. object(0:) R This object maintains an instance of a (key/value pairs) of the service. The information is extracted from DNS TXT records [RFC1035] of the discovered service. When multiple instances of the TextRecord table have the same value for the Key parameter, the implementation is CPE specific. - 2.6
Key string(:255) R The key that identifies the text record - 2.6
Value string(:255) R The value of the text record. - 2.6
Device.NAT. object R Properties for Network Address Translation (NAT). The entire NAT object only applies to IPv4. - 2.0
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.0
PortMappingNumberOfEntries unsignedInt R The number of entries in the PortMapping table. - 2.0
Device.NAT.InterfaceSetting.{i}. object(0:) W

NAT settings for an associated IP Interface on which NAT is enabled. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting 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 InterfaceSetting 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 InterfaceSetting 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 Interface.

 - 2.0
Enable boolean W Enables or disables the InterfaceSetting entry, indicating if NAT is enabled for the referenced IP Interface instance. On creation, an InterfaceSetting entry is disabled by default. false 2.0
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Enabled_NATForcedDisabled (NAT enabled but forced by a third party to be operationally disabled, e.g. because a MAP.Domain is enabled but there is no Basic Mapping Rule [RFC7597])
  • Enabled_PortMappingDisabled (NAT enabled but port mapping has been operationally disabled by a third party, e.g. because this is REQUIRED by the current Firewall level)
  • Error_Misconfigured
  • Error 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
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The associated IP interface on which NAT is to be enabled. <Empty> 2.0
Device.NAT.PortMapping.{i}. object(0:) W

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

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

 - 2.0
Enable boolean W Enables or disables the port mapping instance. On creation, an entry is disabled by default. 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. Note: There is no guarantee that the Alias value on automatically-created PortMapping instances will be retained. This is because automatically-created PortMapping instances can be transitory.

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
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the IP interface to which this port mapping applies. <Empty> 2.0
AllInterfaces boolean W Indicates whether this port mapping applies to all IP interfaces that support port mappings. If true, the value of Interface is ignored since all supported IP interfaces are indicated. false 2.0
LeaseDuration unsignedInt W

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

Active Notification requests for this parameter MAY be denied.

 - 2.0
RemoteHost string W This parameter is the IP address of the source of inbound packets. An empty string indicates a “wildcard”, i.e. any IP address (this will be an empty string in most cases). CPE are REQUIRED only to support an empty string. When RemoteHost is an empty string, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the IP.Interface associated with the InternalClient on the InternalPort. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped. If a CPE supports non-empty values for RemoteHost, it MAY additionally support the ability to have more than one port mapping with the same ExternalPort and Protocol, but with differing values of RemoteHost. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, zero ExternalPort
  3. Empty RemoteHost, explicit ExternalPort
  4. Empty RemoteHost, zero ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry.
 <Empty> 2.0
ExternalPort unsignedInt(0:65535) W The external port (or the first port of a range of external ports) that the NAT gateway would listen on for traffic to a corresponding InternalPort. Inbound packets to this external port on the WAN interface SHOULD be forwarded to the IP.Interface associated with the InternalClient on the InternalPort. A value of zero (0) represents a “wildcard”, i.e. any port number. If this value is 0, traffic on all external ports (that are not otherwise mapped) will be forwarded to InternalClient, and the value(s) of InternalPort on InternalClient are ignored. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, zero ExternalPort
  3. Empty RemoteHost, explicit ExternalPort
  4. Empty RemoteHost, zero ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry.
 - 2.0
ExternalPortEndRange unsignedInt(0:65535) W Indicates the last port of the external port range that starts with ExternalPort. If an external port range is specified, then the behavior described for ExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of ExternalPort. If ExternalPort is zero (wildcard), the value of this parameter MUST be ignored. If specified, the value of this parameter MUST be greater than or equal to the value of ExternalPort. 0 2.0
InternalPort unsignedInt(0:65535) W The port on InternalClient that the gateway SHOULD forward traffic to. - 2.0
Protocol string W

The protocol of the port mapping. Enumeration of:

  • TCP
  • UDP
 - 2.0
InternalClient string(:256) W The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACS can learn the host name associated with a given LAN device via the Hosts.Host. table. Read access to this parameter MUST always return the exact value that was last set by the ACS. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. <Empty> 2.0
Description string(:256) W User-readable description of this port mapping. <Empty> 2.0
Device.PCP. object R Properties for Port Control Protocol (PCP) [RFC6887]. See the PCP Theory of Operation [Appendix XIV/TR-181i2a8] for a description of the working of this PCP data model. - 2.8
SupportedVersions unsignedInt(0:65535)[] R Comma-separated list of unsigned integers (0 to 65535). Each list item denotes a PCP version supported by the PCP Client. Currently known versions are 0, 1 and 2. This parameter is based on Version from [RFC6887]. - 2.8
PreferredVersion unsignedInt(0:65535) W This is the version to be used in the first exchange with a new PCP Server. The factory default MUST be the highest supported version, as described in [Section 9/RFC6887]. - 2.8
OptionList unsignedInt(0:254)[] R Comma-separated list of unsigned integers (0 to 254). The list of the PCP Options supported by the PCP Client. - 2.8
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.8
Device.PCP.Client.{i}. object(0:) W

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

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

 - 2.8
Enable boolean W Enables or disables the PCP Client. - 2.8
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.8
WANInterface string R The value MUST be the Path Name of the interface stack instance representing the WAN interface this client operates on. If the referenced object is deleted, the parameter value MUST be set to an empty string. See InterfaceStack. - 2.8
Status string R

The status of the PCP Client. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.8
MAPEnable boolean W Enables or disables the MAP OpCode. - 2.8
PEEREnable boolean W Enables or disables the PEER OpCode. - 2.8
ANNOUNCEEnable boolean W Enables or disables the ANNOUNCE OpCode. When false the PCP Client does not support unsolicited ANNOUNCE messages. - 2.8
THIRDPARTYEnable boolean W Enables or disables the THIRD_PARTY Option. - 2.8
THIRDPARTYStatus string R

Indicates whether THIRD_PARTY Option is enabled or not. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.8
FILTEREnable boolean W Enables or disables the FILTER option. - 2.8
ServerNumberOfEntries unsignedInt R The number of entries in the Server table. - 2.8
Device.PCP.Client.{i}.PCPProxy. object R Properties for the Port Control Protocol (PCP) Proxy, as specified in [PCPProxy]. - 2.8
Enable boolean W Enables or disables the PCP Proxy for this PCP Client. - 2.8
HighestVersion unsignedInt(0:65535) R A string identifying the highest version of PCP that the proxy supports. This parameter is based on Version from [RFC6887]. - 2.8
Status string R

The status of the PCP Proxy for this PCP Client. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.8
Device.PCP.Client.{i}.UPnPIWF. object R Properties for the interworking function between UPnP IGD (Internet Gateway Device) and PCP, as specified in [RFC6970]. - 2.8
Enable boolean W Enables or disables the UPnP IGD-PCP Interworking Function for this PCP Client. - 2.8
Status string R

The status of the UPnP IGD-PCP Interworking Function for this PCP Client. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.8
Device.PCP.Client.{i}.Server.{i}. object(0:) W

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

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

 - 2.8
Enable boolean W Enables or disables this PCP Server. true 2.8
Status string R

The status of the PCP Server. Enumeration of:

  • Disabled
  • Enabled
  • Connecting
  • Error_Timeout
  • Error_HostNameNotResolved
  • Error_NetworkFailure
  • Error_NotAuthorized
  • Error_Unsupported
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.8
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.8
Origin string R

Method used to assign ServerNameOrAddress and create this table entry. Enumeration of:

  • DHCPv4 (ServerNameOrAddress is an IPv4 address that was received via OPTION_V4_PCP_SERVER)
  • DHCPv6 (ServerNameOrAddress is an IPv6 address that was received via OPTION_V6_PCP_SERVER)
  • Static (ServerNameOrAddress is an FQDN, IPv4 address or IPv6 address that was created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration) Note: In the DHCPv4 and DHCPv6 cases, if more than one IP address is received ServerNameOrAddress will be the first address and AdditionalServerAddresses will be the remaining addresses.
 Static 2.8
ServerNameOrAddress string(:256) W The FQDN or IP address of the PCP Server, assigned as described under Origin. - 2.8
ServerAddressInUse string(:45) R [IPAddress] The IP address currently in use for the PCP Server, derived from the value of ServerNameOrAddress. An empty string indicates that no PCP Server address is currently known. - 2.8
AdditionalServerAddresses string(:45)[] R [IPAddress] Comma-separated list of IP Addresses. PCP Server addresses in addition to ServerNameOrAddress. This can be non-empty only if Origin is DHCPv4 or DHCPv6 and if more than one PCP Server address was received. - 2.8
ExternalIPAddress string(:45) R [IPAddress] The external IP address of the PCP-controlled device hosting this server. - 2.8
CurrentVersion unsignedInt(0:65535) R This is the version of PCP resulting from client-server Version Negotiation. This parameter is based on Version from [RFC6887]. - 2.8
MaximumFilters unsignedInt W Indicates the maximum number of inbound filters allowed to be associated with a mapping entry on this server. - 2.8
PortQuota unsignedInt(:65535) W Indicates the maximum number of ports allocated to this PCP Client on this server. A value of 0 means that there is no limitation. 0 2.8
PreferredLifetime unsignedInt W Indicates the preferred lifetime (in seconds) to be used for mappings with this server when no preference is selected by an application/user. - 2.8
Capabilities string[] R

Comma-separated list of strings. Indicates the capabilities supported by the PCP Server. Each list item is an enumeration of:

  • NAT44
  • StatelessNAT64
  • StatefulNAT64
  • A+PPortRangeRouter
  • SupportsPORTSETOption
  • IPv4Firewall
  • IPv6Firewall
  • NPTv6
  • DSCPReMarkingFunction
  • FLOWDATAAwareFunction
  • ILNPTranslator
 - 2.8
InboundMappingNumberOfEntries unsignedInt R The number of entries in the InboundMapping table. - 2.8
OutboundMappingNumberOfEntries unsignedInt R The number of entries in the OutboundMapping table. - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. object(0:) W

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

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_PCPErrorCodeReceived
  • Error (OPTIONAL) The Error_PCPErrorCodeReceived value indicates that the PCP Client received an error code from the PCP Server. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.8
ErrorCode unsignedInt(1:255) R Provides the PCP error code when Status is Error_PCPErrorCodeReceived. Error code values are defined in [Section 7.4/RFC6887]. - 2.8
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.8
Origin string R

Mechanism via which the mapping was requested. Enumeration of:

  • Internal (Requested via internal device application)
  • UPnP_IWF (Requested via UPnP IGD interworking function)
  • PCP_Proxy (Requested via PCP proxy)
  • Static (Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)
 - 2.8
Lifetime unsignedInt W

Determines the time to live, in seconds, of this Inbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]). When a dynamic Inbound Mapping lease expires, the CPE MUST automatically delete the corresponding InboundMapping table entry.

Active Notification requests for this parameter MAY be denied.

 - 2.8
SuggestedExternalIPAddress string(:45) W [IPAddress] The external IPv4 or IPv6 Address that the PCP-controlled device will listen on for incoming packets to be forwarded to the PCP Client. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP client does not know the external address, or does not have a preference, it MUST use an empty string. <Empty> 2.8
SuggestedExternalPort unsignedInt(0:65535) W The external port (or the first port of a range of external ports) that the PCP-controlled device will listen on for incoming packets. Those inbound packets will be forwarded to InternalPort. If the PCP client does not know the external port, or does not have a preference, it MUST use 0. This is useful for refreshing an Inbound Mapping, especially after the PCP Server loses state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0. 0 2.8
SuggestedExternalPortEndRange unsignedInt(0:65535) W Indicates the last port of the external port range that starts with SuggestedExternalPort. If an external port range is specified, then the behavior described for SuggestedExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of SuggestedExternalPort. If SuggestedExternalPort is zero (wildcard), the value of SuggestedExternalPortEndRange MUST be ignored. If specified, the value of this parameter MUST be zero or be greater than or equal to the value of SuggestedExternalPort. 0 2.8
InternalPort unsignedInt(1:65535) W The port on this PCP Client’s WANInterface that the PCP-controlled device forwards incoming packets to. - 2.8
ProtocolNumber int(-1:255) W The protocol number of the InboundMapping. Values are taken from [IANA-protocolnumbers]. The value -1 means all protocols. - 2.8
ThirdPartyAddress string(:45) W [IPAddress] Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in [Section 7.3/RFC6887]. In that case, ThirdPartyAddress is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, ThirdPartyAddress SHOULD be an empty string. - 2.8
Description string(:256) W User-readable description of this InboundMapping. <Empty> 2.8
AssignedExternalIPAddress string(:45) R [IPAddress] The external IPAddress returned by the PCP Server. The IP address that the PCP-controlled device is listening on for incoming packets to a corresponding PCP Client. <Empty> 2.8
AssignedExternalPort unsignedInt(0:65535) R The external port returned by the PCP Server. The external port (or the first port of a range of external ports) that the PCP-controlled device is listening on for incoming packets to a corresponding InternalPort. Inbound packets to this external port on the External interface of the PCP-controlled device is forwarded to the on the InternalPort. - 2.8
AssignedExternalPortEndRange unsignedInt(0:65535) R Indicates the last port of the external port range that starts with AssignedExternalPort. If an external port range is specified, then the behavior described for AssignedExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of AssignedExternalPort. 0 2.8
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.Filter.{i}. object(0:) W

Filter table. This table contains all Filters restricting this Inbound Mapping, as defined in [RFC6887].

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

 - 2.8
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.8
RemoteHostIPAddress string(:45) W [IPAddress] Permitted remote peer IP address for this filter. <Empty> 2.8
PrefixLength unsignedInt(1:128) W Indicates how many bits of RemoteHostIPAddress are relevant for this filter. 128 2.8
RemotePort unsignedInt(0:65535) W Permitted remote peer port number for this filter. The value 0 indicates all ports. - 2.8
RemotePortEndRange unsignedInt(0:65535) R Indicates the last port of the remote port range that starts with RemotePort. If an external port range is specified, then the behavior described for RemotePort applies to all ports within the range. A value of zero (0) indicates that no remote port range is specified, i.e. that the range consists only of RemotePort. 0 2.8
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. object(0:) W

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

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_PCPErrorCodeReceived
  • Error (OPTIONAL) The Error_PCPErrorCodeReceived value indicates that the PCP Client received an error code from the PCP Server. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.8
ErrorCode unsignedInt(1:255) R Provides the PCP Error code when Status is Error_PCPErrorCodeReceived. Error code values are defined in [Section 7.4/RFC6887]. - 2.8
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.8
Origin string R

Mechanism via which the mapping was requested. Enumeration of:

  • Internal (Requested via internal device application)
  • UPnP_IWF (Requested via UPnP IGD interworking function)
  • PCP_Proxy (Requested via PCP proxy)
  • Static (Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration)
 - 2.8
Lifetime unsignedInt W Determines the time to live, in seconds, of this Outbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]). When a dynamic Outbound Mapping lease expires, the CPE MUST automatically delete the corresponding OutboundMapping table entry. - 2.8
SuggestedExternalIPAddress string(:45) W [IPAddress] The external IPv4 or IPv6 Address that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external address, or does not have a preference, it MUST use an empty string. <Empty> 2.8
SuggestedExternalPort unsignedInt(0:65535) W The external port that the PCP-controlled device will use to send outgoing packets covered by this mapping. This is useful for refreshing a mapping, especially after the PCP Server has lost state. If the PCP Client does not know the external port, or does not have a preference, it MUST use 0. 0 2.8
RemoteHostIPAddress string(:45) W [IPAddress] The remote peer’s IP address, as seen from the PCP Client, for this Outbound Mapping. - 2.8
InternalPort unsignedInt(1:65535) W The port on PCP Client WAN Interface that the PCP-controlled device SHOULD listen to for this mapping. - 2.8
RemotePort unsignedInt(1:65535) W The remote peer’s port, as seen from the PCP Client, for this Outbound Mapping. - 2.8
ProtocolNumber int(-1:255) W The protocol number of the OutboundMapping. Values are taken from the [IANA-protocolnumbers]. The value -1 means all protocols. - 2.8
ThirdPartyAddress string(:45) W [IPAddress] Under certain conditions, the PCP Client can create a PCP mapping on behalf of another device, by using the THIRD_PARTY option, as specified in [Section 7.3/RFC6887]. In that case, ThirdPartyAddress is the IP address of the device for which the PCP operation is requested. For non-third-party mappings, ThirdPartyAddress SHOULD be an empty string. - 2.8
Description string(:256) W User-readable description of this OutboundMapping. <Empty> 2.8
AssignedExternalIPAddress string(:45) R [IPAddress] The external IP address returned by the PCP Server. The IP address that the PCP-controlled device uses to send outgoing packets corresponding to this mapping. <Empty> 2.8
AssignedExternalPort unsignedInt(0:65535) R The external port returned by the PCP Server. The port that the PCP-controlled device uses to send outgoing packets corresponding to this mapping. - 2.8
Device.DHCPv4. object R The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.0
Device.DHCPv4.Client.{i}. object(1:) W

This object contains DHCP client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Client 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 Client 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 Client row.

This table MUST contain at least 1 entry.

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

 - 2.0
Enable boolean W Enables or disables the DHCP Client 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
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Client entry. <Empty> 2.0
Status string R

The status of this table 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
DHCPStatus string R

The DHCP Client status as defined in [RFC2131]. Enumeration of:

  • Init
  • Selecting
  • Requesting
  • Rebinding
  • Bound
  • Renewing Note: This value is only relevant when the DHCP Client is operationally enabled (i.e. when Status is Enabled).
 - 2.0
Renew boolean W When set to true, the DHCP client will renew its DHCP lease. false 2.0
IPAddress string(:45) R [IPv4Address] IPv4 Address option received from the DHCP Server. An empty string when Status is not equal to Bound. <Empty> 2.0
SubnetMask string(:45) R [IPv4Address] Subnet mask option received from the DHCP Server. An empty string when Status is not equal to Bound. Value is information received via DHCP Option 1. <Empty> 2.0
IPRouters string(:45)[](:256) R [IPv4Address] Comma-separated list (maximum number of characters 256) of IPv4Addresses. Items represent IP Router IPv4 Address(es) received from the DHCP server. An empty string when Status is not equal to Bound. Value is information received via DHCP Options 3, 33 or 121. <Empty> 2.0
DNSServers string(:45)[](:256) R [IPv4Address] Comma-separated list (maximum number of characters 256) of IPv4Addresses. Items represent DNS Server IPv4 Address(es) received from the DHCP server. An empty string when Status is not equal to Bound. Value is information received via DHCP Option 6. <Empty> 2.0
LeaseTimeRemaining int(-1:) R

DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease.

Active Notification requests for this parameter MAY be denied.

 0 2.0
DHCPServer string(:45) R [IPv4Address] The IPv4 address of the current DHCP server. <Empty> 2.0
PassthroughEnable boolean W If false, the DHCP Client retrieved IP address information is configured on the referenced Interface object. If true, the DHCP Client retrieved information is propagated to the parameters in the referenced PassthroughDHCPPool object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers). false 2.0
PassthroughDHCPPool string(:256) W The value MUST be the Path Name of a row in the Server.Pool. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.When PassthroughDHCPPool is set to an empty string, PassthroughEnable MUST be set to false (i.e. passthrough can not be enabled without a pool reference specified). <Empty> 2.0
SentOptionNumberOfEntries unsignedInt R The number of entries in the SentOption table. - 2.0
ReqOptionNumberOfEntries unsignedInt R The number of entries in the ReqOption table. - 2.0
Device.DHCPv4.Client.{i}.SentOption.{i}. object(0:) W

Each instance of this object represents a DHCP option that MUST, if enabled, be sent in DHCP client requests. All sent DHCP options MUST be listed.

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

 - 2.0
Enable boolean W Enables or disables this SentOption table 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
Tag unsignedInt(1:254) W Option tag as defined in [RFC2132]. - 2.0
Value hexBinary(0:255) W A hexbinary encoded option value. <Empty> 2.0
Device.DHCPv4.Client.{i}.ReqOption.{i}. object(0:) W

Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed.

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

 - 2.0
Enable boolean W Enables or disables this ReqOption table entry. false 2.0
Order unsignedInt(1:) W Position of the option in the DHCP client request. A value of 1 indicates the first entry. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a ReqOption table entry MUST be one greater than the largest current value. - 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
Tag unsignedInt(1:254) W Option tag as defined in [RFC2132]. - 2.0
Value hexBinary(0:255) R A hexbinary encoded, most recently received DHCP option value. If no option value has been received, then the value MUST represent an empty string. Received DHCP option values MAY, but need not, persist across CPE reboots. <Empty> 2.0
Device.DHCPv4.Server. object R DHCP server configuration. - 2.0
Enable boolean W Enables or disables the DHCP server. - 2.0
PoolNumberOfEntries unsignedInt R The number of entries in the Pool table. - 2.0
Device.DHCPv4.Server.Pool.{i}. object(0:) W

DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, 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 Pool 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
Order unsignedInt(1:) W Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Pool table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Pool entry. <Empty> 2.0
VendorClassID string(:255) W Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for conditional serving. <Empty> 2.0
VendorClassIDExclude boolean W If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. false 2.0
VendorClassIDMode string W

VendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if VendorClassID is “Example” then an Option 60 value of “Example device” will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
 Exact 2.0
ClientID hexBinary(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for conditional serving. <Empty> 2.0
ClientIDExclude boolean W If false, matching packets are those that match the ClientID entry, if specified. If true, matching packets are those that do not match the ClientID entry, if specified. false 2.0
UserClassID hexBinary(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. An empty string indicates this criterion is not used for conditional serving. <Empty> 2.0
UserClassIDExclude boolean W If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. false 2.0
Chaddr string(:17) W [MACAddress] Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. An empty string indicates this criterion is not used for conditional serving. <Empty> 2.0
ChaddrMask string(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the Chaddr is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the Chaddr are to be used for conditional serving classification. <Empty> 2.0
ChaddrExclude boolean W If false, matching packets are those that match the (masked) Chaddr entry, if specified. If true, matching packets are those that do not match the (masked) Chaddr entry, if specified. false 2.0
MinAddress string(:45) W [IPv4Address] Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
MaxAddress string(:45) W [IPv4Address] Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
ReservedAddresses string(:45)[:32]() W [IPv4Address] Comma-separated list (up to 32 items) (length ) of IPv4Addresses. List items represent addresses marked reserved from the address allocation pool. <Empty> 2.0
SubnetMask string(:45) W [IPv4Address] Specifies the client’s network subnet mask. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
DNSServers string(:45)[:4]() W [IPv4Address] Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
DomainName string(:64) W Sets the domain name to provide to clients on the LAN interface. - 2.0
IPRouters string(:45)[:4]() W [IPv4Address] Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
LeaseTime int(-1:) W Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease. 86400 2.0
StaticAddressNumberOfEntries unsignedInt R The number of entries in the StaticAddress table. 0 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. 0 2.0
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.2
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}. object(0:) W

DHCP static address table. Entries in this table correspond to what [RFC2131] calls “manual allocation”, where a client’s IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client. Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client. Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client.

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

 - 2.0
Enable boolean W Enables or disables the StaticAddress table entry. Disabling an entry does not return the IP address to the pool. 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
Chaddr string(:17) W [MACAddress] Hardware address (MAC address) of the physical interface of the DHCP client. <Empty> 2.0
Yiaddr string(:45) W [IPv4Address] IPv4 address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address). <Empty> 2.0
Device.DHCPv4.Server.Pool.{i}.Option.{i}. object(0:) W

This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests are associated with this pool.

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

 - 2.0
Enable boolean W Enables or disables this Option table 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
Tag unsignedInt(1:254) W Option tag as defined in [RFC2132]. - 2.0
Value hexBinary(0:255) W A hexbinary encoded option value. <Empty> 2.0
Device.DHCPv4.Server.Pool.{i}.Client.{i}. object(0:) R

DHCPv4 client table. This table lists details of DHCPv4 clients that matched the filter criteria of this Pool entry.

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

 - 2.2
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. Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory.

Active Notification requests for this parameter MAY be denied.

 - 2.2
Chaddr string(:17) R [MACAddress] MAC address of the DHCPv4 client. - 2.2
Active boolean R Whether or not the DHCPv4 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv4 clients is OPTIONAL. If the CPE includes inactive DHCPv4 clients in this table, Active MUST be set to false for each inactive DHCPv4 client. The length of time an inactive DHCPv4 client remains listed in this table is a local matter to the CPE. - 2.2
IPv4AddressNumberOfEntries unsignedInt R The number of entries in the IPv4Address table. - 2.2
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.2
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}. object(0:) R

IPv4 addresses assigned to this client.

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

 - 2.2
IPAddress string(:45) R [IPv4Address] IPv4 address. - 2.2
LeaseTimeRemaining dateTime R The time at which the DHCP lease will expire or 0001-01-01T00:00:00Z if not known. For an infinite lease, the parameter value MUST be 9999-12-31T23:59:59Z. - 2.2
Device.DHCPv4.Server.Pool.{i}.Client.{i}.Option.{i}. object(0:) R DHCPv4 options supplied by this client, e.g. VendorClassID (Option 60), ClientID (option 61) or UserClassID (Option 77). - 2.2
Tag unsignedInt(0:255) R Option tag as defined in [RFC2132]. - 2.2
Value hexBinary(0:255) R A hexbinary encoded option value. - 2.2
Device.DHCPv4.Relay. object R DHCP Relay Agent (conditional relaying). - 2.0
Enable boolean W Enables or disables the DHCP Relay Agent function. - 2.0
Status string R

The status of the DHCP relay. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.0
ForwardingNumberOfEntries unsignedInt R The number of entries in the Forwarding table. - 2.0
Device.DHCPv4.Relay.Forwarding.{i}. object(0:) W

DHCP Relay Agent Forwarding table. For enabled table entries, if Interface is not a valid reference 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 Forwarding 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
Order unsignedInt(1:) W Position of the Forwarding entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Forwarding table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Forwarding entry. <Empty> 2.0
VendorClassID string(:255) W Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used as a relay classification criterion. <Empty> 2.0
VendorClassIDExclude boolean W If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. false 2.0
VendorClassIDMode string W

VendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if VendorClassID is “Example” then an Option 60 value of “Example device” will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
 Exact 2.0
ClientID hexBinary(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used as a relay classification criterion. <Empty> 2.0
ClientIDExclude boolean W If false, matching packets are those that match the ClientID entry, if specified. If true, matching packets are those that do not match the ClientID entry, if specified. false 2.0
UserClassID hexBinary(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. An empty string indicates this criterion is not used as a relay classification criterion. <Empty> 2.0
UserClassIDExclude boolean W If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. false 2.0
Chaddr string(:17) W [MACAddress] Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. An empty string indicates this criterion is not used as a relay classification criterion. <Empty> 2.0
ChaddrMask string(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the Chaddr is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the Chaddr are to be used for relay classification. <Empty> 2.0
ChaddrExclude boolean W If false, matching packets are those that match the (masked) Chaddr entry, if specified. If true, matching packets are those that do not match the (masked) Chaddr entry, if specified. false 2.0
LocallyServed boolean W If true, incoming DHCP requests will be forwarded to the CPE DHCP Server. If false, incoming DHCP requests will be forwarded to the DHCPServerIPAddress configured for this forwarding entry. false 2.0
DHCPServerIPAddress string(:45) W [IPv4Address] IPv4 address of the DHCP server, where the request has to be sent to when there is a conditional match with this forwarding entry and LocallyServed is false. If LocallyServed is false and this parameter is not configured, then the DHCP request is dropped. - 2.0
Device.DHCPv6. object R The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC3315]. This entire object applies to IPv6 only. It contains the Client and Server objects. - 2.2
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.2
Device.DHCPv6.Client.{i}. object(1:) W

This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Client 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 Client 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 Client row.

This table MUST contain at least 1 entry.

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

 - 2.2
Enable boolean W Enables or disables this Client entry. false 2.2
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.2
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Client entry. This will reference an IPv6-capable interface (that is attached to the IPv6 stack), otherwise the table entry will be inoperable. <Empty> 2.2
Status string R

The status of this table 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.2
DUID hexBinary(:130) R The client’s DHCP Unique Identifier (DUID) [Section 9/RFC3315]. DUID is set by the CPE. - 2.2
RequestAddresses boolean W Enables or disables inclusion of the Identity Association (IA) for Non-Temporary Address option OPTION_IA_NA(3) [Section 22.4/RFC3315] in Solicit messages. true 2.2
RequestPrefixes boolean W Enables or disables inclusion of the Identity Association (IA) for Prefix Delegation option OPTION_IA_PD(25) [Section 10/RFC3633] in Solicit messages. Note that this is only appropriate for an upstream interface on a requesting router, e.g. for an RG WAN interface. false 2.2
RapidCommit boolean W Enables or disables inclusion of the Rapid Commit option OPTION_RAPID_COMMIT(14) [Section 22.14/RFC3315] in Solicit messages. false 2.2
Renew boolean W When set to true, the Client will renew its DHCPv6-supplied information (i.e. the CPE will do a renew or information request as needed, updating both stateful and stateless parameter values discovered by this Client instance). false 2.2
SuggestedT1 int(-1:) W T1 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA [Section 22.4/RFC3315] and OPTION_IA_PD [Section 10/RFC3633]. A value of -1 indicates that no T1 value is specified. - 2.2
SuggestedT2 int(-1:) W T2 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA [Section 22.4/RFC3315] and OPTION_IA_PD [Section 10/RFC3633]. A value of -1 indicates that no T2 value is specified. - 2.2
SupportedOptions unsignedInt[] R Comma-separated list of unsigned integers. The options that the client is able to process in server responses. This list MUST include both top-level and encapsulated options, e.g. if the client is able to process OPTION_IA_NA (3) with an encapsulated OPTION_IAADDR (5), the list would be expected to include both 3 and 5. - 2.2
RequestedOptions unsignedInt[] W Comma-separated list of unsigned integers. An ordered list of the top-level options (i.e. not encapsulated options) that the client will explicitly request from the server. This parameter is intended only for options that are not necessary for the basic operation of the protocol, and are not modeled elsewhere. For example, it is appropriate for OPTION_DNS_SERVERS [RFC3646] but is not appropriate for OPTION_SERVERID (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_IA_PD (which is modeled via RequestPrefixes). However, the CPE MUST NOT reject an attempt to set this parameter to a value that includes options that it regards as inappropriate; instead, it MUST accept the requested options and handle them as best it can. Loosely speaking, these are the options that the client will include in OPTION_ORO [RFC3315] but the client is free to decide (in accordance with [RFC3315]) in which messages to request which option, whether also to request additional options, whether not to request inappropriate options, and in which order to request any options that are also in SupportedOptions. - 2.2
ServerNumberOfEntries unsignedInt R The number of entries in the Server table. - 2.2
SentOptionNumberOfEntries unsignedInt R The number of entries in the SentOption table. - 2.2
ReceivedOptionNumberOfEntries unsignedInt R The number of entries in the ReceivedOption table. - 2.2
Device.DHCPv6.Client.{i}.Server.{i}. object(0:) R

This is a transitory table that lists the discovered DHCPv6 servers (it does not model a local DHCP server). Table entries are automatically created to correspond with these servers. However, it is a local matter to the CPE when to delete old table entries.

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

 - 2.2
SourceAddress string(:45) R [IPv6Address] The IP address from which the message most recently received from this server was sent. - 2.2
DUID hexBinary(:130) R The server’s DHCP Unique Identifier (DUID) [Section 9/RFC3315] as received via OPTION_SERVERID. - 2.2
InformationRefreshTime dateTime R The OPTION_INFORMATION_REFRESH_TIME value [RFC4242] that was most recently received from this server, converted to the dateTime at which the associated information will expire. If no such option has been received, the parameter value MUST be the “Unknown Time” 0001-01-01T00:00:00Z. If the information will never expire, the parameter value MUST be infinite time 9999-12-31T23:59:59Z. - 2.2
Device.DHCPv6.Client.{i}.SentOption.{i}. object(0:) W

The top-level options and option values (including any encapsulated options) that the client will send to the server. This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit).

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

 - 2.2
Enable boolean W Enables or disables this SentOption entry. false 2.2
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.2
Tag unsignedInt(0:65535) W Option tag (code) [Section 22.1/RFC3315]. - 2.2
Value hexBinary(0:65535) W A hexbinary encoded option data [Section 22.1/RFC3315]. Note: The length of the option data is option-len octets, as specified in [Section 22.1/RFC3315]. <Empty> 2.2
Device.DHCPv6.Client.{i}.ReceivedOption.{i}. object(0:) R This is a transitory table that lists all the options received from all servers. Table entries are automatically created to correspond with received options. However, it is a local matter to the CPE when to delete old table entries. If the same option is received multiple times, whether from one or more servers, it is up to the CPE to decide which entries to include (i.e. whether the same option will be present multiple times). In order to allow for the same option to be present multiple times within the table, this table has no unique key defined. - 2.2
Tag unsignedInt(0:65535) R Option tag (code) [Section 22.1/RFC3315]. - 2.2
Value hexBinary(0:65535) R A hexbinary encoded option data [Section 22.1/RFC3315]. - 2.2
Server string R The value MUST be the Path Name of a row in the Server. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the server that sent the option to the client. Each ReceivedOption entry MUST have an associated server. - 2.2
Device.DHCPv6.Server. object R DHCPv6 server configuration. - 2.2
Enable boolean W Enables or disables the DHCPv6 server function. - 2.2
PoolNumberOfEntries unsignedInt R The number of entries in the Pool table. - 2.2
Device.DHCPv6.Server.Pool.{i}. object(0:) W

DHCPv6 server pool table. Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.2
Enable boolean W Enables or disables this Pool entry. false 2.2
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.2
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.2
Order unsignedInt(1:) W Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCPv6 request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Pool table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.2
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Pool entry. <Empty> 2.2
DUID hexBinary(:130) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Client Identifier (Option 1) [Section 22.2/RFC3315]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used. Note: DHCPv6 Option 1 (DUID) is sometimes referred to as Client Identifier. <Empty> 2.2
DUIDExclude boolean W If false, matching packets are those that match the DUID entry, if specified. If true, matching packets are those that do not match the DUID entry, if specified. false 2.2
VendorClassID hexBinary(:65535) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) [Section 22.16/RFC3315]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used. <Empty> 2.2
VendorClassIDExclude boolean W If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. false 2.2
UserClassID hexBinary(:65535) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 User Class Identifier (Option 15) [Section 22.15/RFC3315]. An empty string indicates this criterion is not used. <Empty> 2.2
UserClassIDExclude boolean W If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. false 2.2
SourceAddress string(:45) W [IPv6Address] Pool association criterion. Source address (link-layer address) of DHCPv6 messages sent from the DHCPv6 client. This criterion is only likely to be useful if this is a link-layer address. An empty string indicates this criterion is not used for serving. <Empty> 2.2
SourceAddressMask string(:45) W [IPv6Address] Bit-mask for the source address, where matching of a packet’s source address with the SourceAddress is only to be done for bit positions set to one in the mask. A mask of an empty string indicates all bits of the SourceAddress are to be used. <Empty> 2.2
SourceAddressExclude boolean W If false, matching packets are those that match the (masked) SourceAddress entry, if specified. If true, matching packets are those that do not match the (masked) SourceAddress entry, if specified. false 2.2
IANAEnable boolean W Enables or disables IANA offers. - 2.2
IANAManualPrefixes string[:8]() W Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes from which IA_NA addresses will be assigned. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. All clients that request IA_NA and match filter criteria on this Interface MUST be offered IA_NA addresses from all of the Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) /64 prefixes in this list. Prefixes MUST be associated with the interface instance referenced by Interface. <Empty> 2.2
IANAPrefixes string[:8]() R Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes from which IA_NA addresses will be assigned. This list can include: - 2.2
IAPDEnable boolean W Enables or disables IAPD offers. - 2.2
IAPDManualPrefixes string[:8]() W Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes from which IA_PD prefixes will be derived. This list can include: <Empty> 2.2
IAPDPrefixes string[:8]() R Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes for which IA_PD prefixes will be assigned. This list can include: - 2.2
IAPDAddLength unsignedInt(:64) W The RECOMMENDED minimum number of bits to add to IAPDManualPrefixes or IAPDPrefixes in order to determine the length of prefixes that are offered in an IA_PD. The device is responsible for ensuring that it does not delegate a prefix longer than /64. The device can have additional logic that is used (in conjunction with this parameter) to determine the actual length of prefixes offered in an IA_PD. - 2.2
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. 0 2.2
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. 0 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}. object(0:) R

DHCPv6 client table. This table lists details of DHCPv6 clients that matched the filter criteria of this Pool entry.

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

 - 2.2
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. Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory.

Active Notification requests for this parameter MAY be denied.

 - 2.2
SourceAddress string(:45) R [IPv6Address] Source address of the DHCPv6 client. - 2.2
Active boolean R Whether or not the DHCPv6 client is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive DHCPv6 clients is OPTIONAL. If the CPE includes inactive DHCPv6 clients in this table, Active MUST be set to false for each inactive DHCPv6 client. The length of time an inactive DHCPv6 client remains listed in this table is a local matter to the CPE. - 2.2
IPv6AddressNumberOfEntries unsignedInt R The number of entries in the IPv6Address table. - 2.2
IPv6PrefixNumberOfEntries unsignedInt R The number of entries in the IPv6Prefix table. - 2.2
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}.IPv6Address.{i}. object(0:) R

IPv6 addresses assigned to this client via IA_NA.

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

 - 2.2
IPAddress string(:45) R [IPv6Address] IPv6 address. - 2.2
PreferredLifetime dateTime R The time at which this address will cease to be preferred (i.e. will become deprecated), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. - 2.2
ValidLifetime dateTime R The time at which this address will cease to be valid (i.e. will become invalid), or 0001-01-01T00:00:00Z if unknown. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. - 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}.IPv6Prefix.{i}. object(0:) R

IPv6 prefixes delegated to this client via IA_PD.

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

 - 2.2
Prefix string(:49) R [IPv6Prefix] IPv6 address prefix. - 2.2
PreferredLifetime dateTime R The time at which this prefix will cease to be preferred (i.e. will become deprecated), or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. - 2.2
ValidLifetime dateTime R The time at which this prefix will cease to be valid (i.e. will become invalid), or 0001-01-01T00:00:00Z if unknown. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. - 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}.Option.{i}. object(0:) R DHCPv6 options supplied by this client, e.g. DUID (Option 1), UserClassID (Option 15) or VendorClassID (option 16). - 2.2
Tag unsignedInt(0:65535) R Option tag (code) [Section 22.1/RFC3315]. - 2.2
Value hexBinary(0:65535) R A hexbinary encoded option value. - 2.2
Device.DHCPv6.Server.Pool.{i}.Option.{i}. object(0:) W

This object specifies the DHCPv6 options that MUST, if enabled, be offered to clients whose DHCPv6 requests are associated with this pool. If PassthroughClient is specified, and the referenced client has a value for a given option then the PassthroughClient option value will be sent instead of Value. Otherwise, Value will be sent.

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

 - 2.2
Enable boolean W Enables or disables this Option entry. false 2.2
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.2
Tag unsignedInt(0:65535) W Option tag (code) [Section 22.1/RFC3315]. - 2.2
Value hexBinary(0:65535) W A hexbinary encoded option value. <Empty> 2.2
PassthroughClient string(:256) W The value MUST be the Path Name of a row in the Client. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates whether this Option entry is configured for passthrough. If PassthroughClient is specified, and the referenced client (since boot) has received a value from an associated upstream DHCPv6 server for the given Tag option, then the referenced client’s option value will be sent instead of Value. Otherwise, Value will be sent. An empty string indicates that passthrough is not configured for this Option entry. <Empty> 2.2
Device.IEEE8021x. object R IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. - 2.0
SupplicantNumberOfEntries unsignedInt R The number of entries in the Supplicant table. - 2.0
Device.IEEE8021x.Supplicant.{i}. object(1:) W

802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance). For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Supplicant 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 Supplicant 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 Supplicant row.

This table MUST contain at least 1 entry.

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

 - 2.0
Enable boolean W This parameter controls whether this resource will utilize the 802.1x protocol as a supplicant for device authentication purposes. false 2.0
Status string R

The current operational status of this 802.1x supplicant. 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
Interface string(:256) W The value MUST be the Path Name of a table row. The interface on which authentication is to be performed. Example: Device.Ethernet.Link.1 <Empty> 2.0
PAEState string R

The current supplicant state machine as defined in [Section 9.5.1/802.1x-2004], Supplicant PAE (Port Access Entity) State. Enumeration of:

  • Disconnected
  • Logoff
  • Connecting
  • Authenticating
  • Authenticated
  • Held
  • Restart
  • ForceAuth
  • ForceUnauth
 - 2.0
EAPIdentity string(:256) W The identity to be exchanged between the supplicant and authenticator. - 2.0
MaxStart unsignedInt(1:10) W The maximum number of times the device will attempt to send an EAP start message before authentication fails as defined in [Section 9.5.1/802.1x-2004], maxStart. This is in support of [Section 8.4.6/802.1x-2004], Migration Considerations. - 2.0
StartPeriod unsignedInt(1:) W The period in seconds a supplicant will wait before the device will attempt to re-send an EAP start message as defined in [Section 9.5.1/802.1x-2004], startPeriod. - 2.0
HeldPeriod unsignedInt(1:) W The hold-off period in seconds a supplicant will wait before re-attempting authentication as defined in [Section 9.5.1/802.1x-2004], heldPeriod. - 2.0
AuthPeriod unsignedInt W The period in seconds after which a request will be considered timed out as defined in [Section 9.5.1/802.1x-2004], authPeriod. - 2.0
AuthenticationCapabilities string[] R

Comma-separated list of strings. Indicates the authentication methods supported by the device. Each list item is an enumeration of:

  • EAP-TLS
  • EAP-MD5
 - 2.0
StartFailurePolicy string W

The action to be taken when authentication has failed, when the network fails to respond to the supplicant’s start message, and the retries have been exceeded (since network does not yet support 802.1x). Enumeration of:

 - 2.0
AuthenticationSuccessPolicy string W

The action to be taken when authentication succeeds and a connection has already received an address and/or policy settings. Enumeration of:

  • NoAction
  • RenewConnection
 - 2.0
Reset boolean W When set to true, the device MUST reset the session by performing an initial authentication attempt as defined in [Section 9.6.1.3/802.1x-2004], Initialize Port by sending out the EAP start message. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call. - 2.0
Disconnect boolean W When set to true, the device MUST disconnect (forced unauthentication) the resource. The device MUST initiate the disconnect after completion of the current CWMP session. The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call. - 2.0
Device.IEEE8021x.Supplicant.{i}.Stats. object R 802.1x Authentication Supplicant EAP statistics information for this resource. - 2.0
ReceivedFrames unsignedInt R The number of EAPOL frames of any type that have been received by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL frames received. 0 2.0
TransmittedFrames unsignedInt R The number of EAPOL frames of any type that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL frames transmitted. 0 2.0
TransmittedStartFrames unsignedInt R The number of EAPOL Start frames that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL Start frames transmitted. 0 2.0
TransmittedLogoffFrames unsignedInt R The number of EAPOL Logoff frames that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL Logoff frames transmitted. 0 2.0
TransmittedResponseIdFrames unsignedInt R The number of EAP Resp/Id frames that have been transmitted; [Section 9.5.2/802.1x-2004], EAP Resp/Id frames transmitted. 0 2.0
TransmittedResponseFrames unsignedInt R The number of valid EAP Response frames (other than Resp/Id frames) that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAP Resp frames transmitted. 0 2.0
ReceivedRequestIdFrames unsignedInt R The number of EAP Req/Id frames that have been received by this Supplicant; [Section 9.5.2/802.1x-2004], EAP Req/Id frames received. 0 2.0
ReceivedRequestFrames unsignedInt R The number of EAP Request frames (other than Rq/Id frames) that have been received by this Supplicant; [Section 9.5.2/802.1x-2004], EAP Req frames received. 0 2.0
ReceivedInvalidFrames unsignedInt R The number of EAPOL frames that have been received by this Supplicant in which the frame type is not recognized; [Section 9.5.2/802.1x-2004], EAP Req frames received. 0 2.0
ReceivedLengthErrorFrames unsignedInt R The number of EAPOL frames that have been received by this Supplicant in which the Packet Body Length field is invalid; [Section 9.5.2/802.1x-2004], EAP length error frames received. 0 2.0
LastFrameVersion unsignedInt R The protocol version number carried in the most recently received EAPOL frame; [Section 9.5.2/802.1x-2004], Last EAPOL frame version - 2.0
LastFrameSourceMACAddress string(:17) R [MACAddress] The source MAC address carried in the most recently received EAPOL frame; [Section 9.5.2/802.1x-2004], Last EAPOL frame source. - 2.0
Device.IEEE8021x.Supplicant.{i}.EAPMD5. object R 802.1x Authentication Supplicant provisioning information used for MD5 shared secret exchange. This object will not exist if EAP-MD5 is not a supported authentication type. - 2.0
Enable boolean W This parameter enables or disables the supplicant’s support for EAP-MD5. - 2.0
SharedSecret string(:256) W

The shared secret to be exchanged between the supplicant and authenticator.

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

 - 2.0
Device.IEEE8021x.Supplicant.{i}.EAPTLS. object R 802.1x Authentication Supplicant provisioning information used for TLS certificate authentication. This object will not exist if the EAP-TLS is not a supported authentication type. - 2.0
Enable boolean W This parameter enables or disables the supplicant’s support for EAP-TLS. - 2.0
MutualAuthenticationEnable boolean W The parameter controls if the supplicant will authenticate the authenticator. - 2.0
Device.Users. object R Users object that contains the User table. - 2.0
UserNumberOfEntries unsignedInt R The number of entries in the User table. - 2.0
Device.Users.User.{i}. object(0:) W

This object contains parameters relating to the user characteristics.

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

 - 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.3
Enable boolean W Enables/disables this user object instance. If the User being configured is currently accessing the device then a disable MUST apply to the next user session and the current user session MUST NOT be abruptly terminated. false 2.0
RemoteAccessCapable boolean W Allows this user to remotely access the UserInterface via the mechanism defined in UserInterface.RemoteAccess. false 2.0
Username string(:64) W Name of the current user. MUST NOT be an empty string for an enabled entry. <Empty> 2.0
Password string(:64) W

The user’s password.

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

 - 2.0
Language string(:16) W String describing the default language for the local configuration interface, specified according to [RFC3066]. If an empty string, UserInterface.CurrentLanguage is used. <Empty> 2.0
Device.SmartCardReaders. object R SmartCardReaders object that contains the SmartCardReader table. - 2.0
SmartCardReaderNumberOfEntries unsignedInt R The number of entries in the SmartCardReader table. - 2.0
Device.SmartCardReaders.SmartCardReader.{i}. object(0:) R

This object describes the characteristics of the smart card reader.

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

 - 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.3
Enable boolean W Enables or disables this smart card reader. - 2.0
Status string R

Indicates the status of this smart card reader.

Enumeration of:

  • Disabled
  • Enabled (Indicates the smart card reader is enabled and functioning properly)
  • Error (Indicates the smart card reader is enabled and not functioning properly)
 - 2.0
Name string(:256) R Human-readable name associated with this smart card reader. - 2.0
Reset boolean W When set to true, resets the SmartCard Reader and the associated SmartCard. - 2.0
ResetTime dateTime R The time at which this SmartCard Reader was reset. Reset can be caused by:
  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the SmartCard Reader (including a reboot of the device). Unknown Time value indicates that this SmartCard Reader has never been reset, which can only happen if it has never been enabled.
 - 2.0
DecryptionFailedCounter unsignedInt R

Counter incremented once each time decryption cannot be carried out. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed.

Active Notification requests for this parameter MAY be denied.

 - 2.0
DecryptionFailedNoKeyCounter unsignedInt R

Counter incremented once each time the key is not available to decrypt it. This is a subset of the more general DecryptionFailedCounter within the same object and thus will always be less than that parameter. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.SmartCardReaders.SmartCardReader.{i}.SmartCard. object R Status of currently associated smart card. - 2.0
Status string R

Status of the Smart Card.

Enumeration of:

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

Smart Card Type. Enumeration of:

  • CA
  • DRM
  • UICC Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
 - 2.0
Application string[] R

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

  • SIM
  • USIM
  • ISIM Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
 - 2.0
SerialNumber string(:256) R The Smart Card Serial Number or an empty string if the Smart Card serial Number is not available, e.g. in the case of IPTV due to restrictions of the Service Delivery Platform. - 2.0
ATR string(:1024) R The Smart Card answer to a reset action. Issued by the Smart Card upon reset. - 2.0
Device.UPnP. object R This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 2.0
Device.UPnP.Device. object R This object defines the UPnP devices and UPnP services that are implemented by the CPE. - 2.0
Enable boolean W Enables/Disables UPnP support. - 2.0
UPnPMediaServer boolean W Enables/Disables UPnP Media Server. - 2.0
UPnPMediaRenderer boolean W Enables/Disables UPnP Media Renderer. - 2.0
UPnPWLANAccessPoint boolean W Enables/Disables UPnP Wireless Access Point. - 2.0
UPnPQoSDevice boolean W Enables/Disables UPnP QoS Device. - 2.0
UPnPQoSPolicyHolder boolean W Enables/Disables UPnP QoS Policy Holder. - 2.0
UPnPIGD boolean W Enables/Disables UPnP IGD. - 2.0
UPnPDMBasicMgmt boolean W Enables/Disables UPnP-DM Basic Management. - 2.0
UPnPDMConfigurationMgmt boolean W Enables/Disables UPnP-DM Configuration Management. - 2.0
UPnPDMSoftwareMgmt boolean W Enables/Disables UPnP-DM Software Management. - 2.0
Device.UPnP.Device.Capabilities. object R This object defines what UPnP capabilities this device has. - 2.0
UPnPArchitecture unsignedInt R Numeric value indicating the major version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 2. A value of 0 indicates no UPnP support. - 2.0
UPnPArchitectureMinorVer unsignedInt R Numeric value indicating the minor version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 0. If UPnPArchitecture is 0 then this parameter SHOULD be ignored. - 2.0
UPnPMediaServer unsignedInt R Numeric value indicating the supported revision for UPnP Media Server. A value of 0 indicates no support. - 2.0
UPnPMediaRenderer unsignedInt R Numeric value indicating the supported revision for UPnP Media Renderer. A value of 0 indicates no support. - 2.0
UPnPWLANAccessPoint unsignedInt R Numeric value indicating the supported revision for UPnP Wireless Access Point. A value of 0 indicates no support. - 2.0
UPnPBasicDevice unsignedInt R Numeric value indicating the supported revision for UPnP Basic Device. A value of 0 indicates no support. - 2.0
UPnPQoSDevice unsignedInt R Numeric value indicating the supported revision for UPnP Qos Device. A value of 0 indicates no support. - 2.0
UPnPQoSPolicyHolder unsignedInt R Numeric value indicating the supported revision for UPnP Qos Policy Holder. A value of 0 indicates no support. - 2.0
UPnPIGD unsignedInt R Numeric value indicating the supported revision for UPnP IGD. A value of 0 indicates no support. - 2.0
UPnPDMBasicMgmt unsignedInt R Numeric value indicating the supported revision for UPnP-DM Basic Management. A value of 0 indicates no support. - 2.0
UPnPDMConfigurationMgmt unsignedInt R Numeric value indicating the supported revision for UPnP-DM Configuration Management. A value of 0 indicates no support. - 2.0
UPnPDMSoftwareMgmt unsignedInt R Numeric value indicating the supported revision for UPnP-DM Software Management. A value of 0 indicates no support. - 2.0
Device.UPnP.Discovery. object R UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services. The CPE MAY, but need not, retain some or all of the information in this object across reboots. - 2.0
RootDeviceNumberOfEntries unsignedInt R The number of entries in the RootDevice table. - 2.0
DeviceNumberOfEntries unsignedInt R The number of entries in the Device table. - 2.0
ServiceNumberOfEntries unsignedInt R The number of entries in the Service table. - 2.0
Device.UPnP.Discovery.RootDevice.{i}. object(0:) R

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

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

 - 2.0
Status string R

The status of the UPnP root device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received) The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.
 - 2.0
UUID string(:36) R

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

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

Possible patterns:

  • [0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}
 - 2.0
USN string(:256) R

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

uuid:device-UUID::urn:domain-name:device:deviceType:v SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, one of the other two forms MAY be used:
uuid:device-UUID::upnp:rootdevice
uuid:device-UUID (for root device UUID)
 - 2.0
LeaseTime unsignedInt R The UPnP root device lease time in seconds, extracted from the CACHE-CONTROL header. - 2.0
Location string(:256) R The value of the LOCATION header for this UPnP root device, which is the URL of the root device’s DDD (Device Description Document). - 2.0
Server string(:256) R

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

OS/version UPnP/udaversion product/version where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.
 - 2.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 2.0
LastUpdate dateTime R The date and time at which the last advertisement from this RootDevice was received. - 2.6
Device.UPnP.Discovery.Device.{i}. object(0:) R

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

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

 - 2.0
Status string R

The status of the UPnP embedded device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received) The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.
 - 2.0
UUID string(:36) R

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

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

Possible patterns:

  • [0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}
 - 2.0
USN string(:256) R

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

uuid:device-UUID::urn:domain-name:device:deviceType:v SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, the other form MAY be used:
uuid:device-UUID
 - 2.0
LeaseTime unsignedInt R The UPnP embedded device lease time in seconds, extracted from the CACHE-CONTROL header. - 2.0
Location string(:256) R The value of the LOCATION header for this UPnP embedded device, which is the URL of the root device’s DDD (Device Description Document). - 2.0
Server string(:256) R

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

OS/version UPnP/udaversion product/version where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.
 - 2.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 2.0
LastUpdate dateTime R The date and time at which the last advertisement from this Device was received. - 2.6
Device.UPnP.Discovery.Service.{i}. object(0:) R

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

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

 - 2.0
Status string R

The status of the UPnP embedded service. Enumeration of:

  • LeaseActive (Service is active and UPnP lease has not expired)
  • LeaseExpired (Service is inactive because UPnP lease has expired)
  • ByebyeReceived (Service is inactive because byebye message was received) The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.
 - 2.0
USN string(:256) R

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

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

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

OS/version UPnP/udaversion product/version where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.
 - 2.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 2.0
LastUpdate dateTime R The date and time at which the last advertisement from this Service was received. - 2.6
ParentDevice string(:256) R The value MUST be the Path Name of the RootDevice or Device table entries that embeds this Service. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter is populated by extracting the “device-UUID” from the service’s USN and matching the value against the root device or embedded device UUID value. - 2.6
Device.UPnP.Description. object R This object contains information from the Description Document discovered from the UPnP Devices and Services. - 2.6
DeviceDescriptionNumberOfEntries unsignedInt R The number of entries in the DeviceDescription table. - 2.6
DeviceInstanceNumberOfEntries unsignedInt R The number of entries in the DeviceInstance table. - 2.6
ServiceInstanceNumberOfEntries unsignedInt R The number of entries in the ServiceInstance table. - 2.6
Device.UPnP.Description.DeviceDescription.{i}. object(0:) R

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

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

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

The UPnP Device Architecture version extracted from the specVersion element in the Device Description Document of the discovered root device. The SpecVersion is encoded as “major revison.minor revision”. Possible patterns:

  • \d+\.\d+
 - 2.6
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of the Host table entries associated with the root device from which the device description was retrieved. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.6
Device.UPnP.Description.DeviceInstance.{i}. object(0:) R

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

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

 - 2.6
UDN string(36) R [UUID] Unique Device Name of this device represented as a UUID for the device. This value is extracted from the UDN element in the Device Description Document with the leading uuid: removed. - 2.6
ParentDevice string(:256) R The value MUST be the Path Name of a DeviceInstance table entry (if this is an embedded device) or an empty string (if this is a root device). If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6
DiscoveryDevice string(:256) R The value MUST be the Path Name of a Discovery.RootDevice table entry (if this is a root device) or a Discovery.Device table entry (if this is an embedded device). If the referenced object is deleted, the parameter value MUST be set to an empty string. This DiscoveryDevice value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this DeviceInstance or use an empty string is implementation specific. - 2.6
DeviceType string(:256) R The value of the UPnP deviceType element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
FriendlyName string(:128) R The value of the UPnP friendlyName element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
DeviceCategory string[] R Comma-separated list of strings. Each list item is the value of an element in the Device Description Document for this DeviceInstance that indicates a device category (e.g. “AV_TV” and “AV_Recorder”), or the value is an empty string if no such element is provided by the device. Note: It is assumed that the htip:X_DeviceCategory Device Description Document element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories. Note: DeviceCategory is different from DeviceType and is included here for the purpose of HTIP usage. - 2.8
Manufacturer string(:128) R The value of the UPnP manufacturer element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ManufacturerOUI string(0:6) R

The value of an element in the Device Description Document for this DeviceInstance that indicates the manufacturer OUI if this value is provided by the device; or an empty string if this value is not provided by the device. Possible patterns:

  • <Empty> (an empty string)
  • [0-9A-F]{6} Note: It is assumed that the htip:X_ManufacturerOUI element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973].
 - 2.8
ManufacturerURL string(:256) R The value of the UPnP manufacturerURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelDescription string(:256) R The value of the UPnP modelDescription element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelName string(:64) R The value of the UPnP modelName element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelNumber string(:64) R The value of the UPnP modelNumber element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelURL string(:256) R The value of the UPnP modelURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
SerialNumber string(:128) R The value of the UPnP serialNumber element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
UPC string(:12) R The value of the UPnP UPC element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
PresentationURL string(:256) R The value of the UPnP presentationURL element in the Device Description Document for this DeviceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the presentationURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the presentationURL is not provided by the device then this value MUST be an empty string. - 2.6
Device.UPnP.Description.ServiceInstance.{i}. object(0:) R

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

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

 - 2.6
ParentDevice string(:256) R The value MUST be the Path Name of a DeviceInstance table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6
ServiceId string(:256) R The value of the UPnP serviceId element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service. If the UPnP serviceId is not provided by the UPnP service, this ServiceInstance MUST be deleted. - 2.6
ServiceDiscovery string(:256) R The value MUST be the Path Name of a Discovery.Service table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. This ServiceDiscovery value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this ServiceInstance or use an empty string is implementation specific. - 2.6
ServiceType string(:256) R The value of the UPnP serviceType element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service. - 2.6
SCPDURL string R The value of the UPnP SCPDURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the SCPDURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the SCPDURL is not provided by the device then this value MUST be an empty string. - 2.6
ControlURL string R The value of the UPnP controlURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the controlURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the controlURL is not provided by the device then this value MUST be an empty string - 2.6
EventSubURL string R The value of the UPnP eventSubURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the eventSubURLL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the eventSubURL is not provided by the device then this value MUST be an empty string - 2.6
Device.DLNA. object R This object contains all DLNA related objects and parameters. - 2.0
Device.DLNA.Capabilities. object R DLNA capabilities. - 2.0
HNDDeviceClass string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Network Device Classes [Table 4-1/DLNA-NDIG]. - 2.0
DeviceCapability string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Device Capabilities [Table 4-2/DLNA-NDIG]. - 2.0
HIDDeviceClass string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Infrastructure Device Classes [Table 4-4/DLNA-NDIG]. - 2.0
ImageClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Image Class Profile IDs supported by this device, from Tables 5-2 and 5-3 of [DLNA-NDIG]. - 2.0
AudioClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Audio Class Profile IDs supported by this device, from Tables 5-4 through 5-10 of [DLNA-NDIG]. - 2.0
AVClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA AV Class Profile IDs supported by this device, from Tables 5-11 through 5-15 of [DLNA-NDIG]. - 2.0
MediaCollectionProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Media Collection Profile IDs supported by this device [Table 5-16/DLNA-NDIG]. - 2.0
PrinterClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Printer Class Profile IDs supported by this device [Table 5-17/DLNA-NDIG]. - 2.0
Device.Firewall. object R Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. See [Appendix VIII/TR-181i2a2] for an example Advanced configuration. - 2.0
Enable boolean W Enables or disables the Firewall. Firewalls often implement additional Denial of Service and other vulnerability protections, such as those described in [ICSA-Baseline]. If a Stateful Firewall is enabled, then it is assumed that all implemented stateful protections are enabled, unless they are overridden by some other part of the data model. - 2.2
Config string W

How this firewall is configured. Enumeration of:

  • High (The firewall implements the “Traffic Denied Inbound” and “Minimally Permit Common Services Outbound” components of the ICSA residential certification’s Required Services Security Policy [ICSA-Residential]. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Low (All Outbound traffic and pinhole-defined Inbound traffic is allowed. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Off (All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings (if supported and enabled). If DoS and vulnerability protections are implemented [ICSA-Baseline], these are disabled. This value is DEPRECATED because it is the same as setting Enable to false, DEPRECATED)
  • Advanced (Advanced firewall configuration applies, as specified by AdvancedLevel, OPTIONAL) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
 - 2.0
AdvancedLevel string W The value MUST be the Path Name of a row in the Firewall.Level. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Selects the currently active Firewall Level. AdvancedLevel only applies when Config is Advanced. - 2.2
Type string R

Firewall Type. Enumeration of:

  • Stateless (The Firewall only implements stateless packet inspection)
  • Stateful (The Firewall implements stateful packet inspection) A Stateless Firewall treats each packet individually and thus has no concept of sessions. Therefore a Stateless Firewall cannot distinguish between unsolicited downstream traffic and downstream traffic in response to outbound messages. This means that it has to accept all incoming downstream traffic. Furthermore, because a Stateless Firewall treats each packet individually, it does not provide any DoS or vulnerability protections. A Stateful Firewall maintains state about previous packets and thus supports sessions. Therefore a Stateful Firewall can distinguish between solicited and unsolicited downstream traffic. In a Stateful Firewall, explicitly configured rules only apply to unsolicited traffic, and can not cause packets received in response to an upstream request to be dropped. Furthermore, because a Stateful Firewall maintains state, it can provide DoS and vulnerability protections. A device that has a Stateless Firewall depends on the NAT to provide protection against unsolicited downstream IPv4 traffic. This is because, as noted above, a Stateless Firewall has to be configured to accept all incoming downstream traffic. For IPv6 there is no NAT, so a Stateless Firewall can not provide simple security protections against unsolicited downstream IPv6 traffic.
 - 2.2
Version string(:16) R A string identifying the firewall settings version currently used in the CPE, or an empty string if the firewall settings are not associated with a version. - 2.0
LastChange dateTime R The time at which the firewall settings most recently changed. - 2.0
LevelNumberOfEntries unsignedInt R The number of entries in the Level table. - 2.2
ChainNumberOfEntries unsignedInt R The number of entries in the Chain table. - 2.2
Device.Firewall.Level.{i}. object(0:) W

Firewall Level table. When an Advanced configuration is selected, AdvancedLevel selects the currently active entry in this table. Each Level table entry references the Chain that contains the rules for this level.

At most one entry in this table 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.2
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.2
Name string(:64) W

Human-readable name associated with this Level entry.

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

 - 2.2
Description string(:256) W Human-readable description associated with this Level entry. - 2.2
Order unsignedInt(1:) W Position of the Level entry for user interface display; levels can be presented according to an increasing or decreasing level of security. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all greater-valued Order entries is incremented to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Level table entry MUST be one greater than the largest current value. - 2.2
Chain string R The value MUST be the Path Name of a row in the Firewall.Chain. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Chain containing Firewall Level Rules associated with this Level entry. On creation of a new Level entry, the device will automatically create a new Chain table entry that this Chain parameter will reference. - 2.2
PortMappingEnabled boolean W Indicates whether NAT port mapping is enabled or disabled when this is the active Level. For a Stateless Firewall this can be set to false to force any port mappings to be operationally disabled (for a Stateful Firewall this is not necessary because the same effect can be achieved via Firewall rules). This parameter affects all the interfaces on which NAT is enabled. It operationally enables or disables port mapping functionality and therefore does not affect the individual NAT.PortMapping.{i}.Enable settings. Note that the current NAT status and NAT port mapping status are indicated by the NAT.InterfaceSetting.{i}.Status parameter. true 2.2
DefaultPolicy string W

Default action for packets not matching any of the level rules. Enumeration of:

  • Drop (The firewall discards packets matching this rule)
  • Accept (The firewall forwards packets matching this rule)
  • Reject (The firewall discards packets matching this rule, and sends an ICMP message to the originating host, OPTIONAL)
 Drop 2.2
DefaultLogPolicy boolean W Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets not matching any of the level rules. false 2.2
Device.Firewall.Chain.{i}. object(0:) W

Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other Chain instances. A hierarchy of rules can therefore be created. A given Firewall Chain’s rules are all created by the same entity, as indicated by the Creator parameter.

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.2
Enable boolean W Enables or disables this Chain entry. false 2.2
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.2
Name string(:64) W

Human-readable name associated with this Chain entry.

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

 - 2.2
Creator string R

Creator of this Chain entry and of its Rules. Enumeration of:

  • Defaults (The Chain entry is present in the factory default configuration)
  • PortMapping (The Chain entry was created as a side-effect of a [UPnP-IGD:1] or [TR-064] port mapping)
  • WANIPv6FirewallControl (The Chain entry was created by [UPnP-IGD:2] WANIPv6FirewallControl)
  • ACS (The Chain entry was created by the Auto Configuration Server)
  • UserInterface (The Chain entry was created by device user interface or command line interface)
  • Other (The Chain entry was created by another entity) Note that this is the entity that originally created the Chain entry. The value of this parameter does not change if the Chain entry or one of its rules is subsequently changed by another entity.
 ACS 2.2
RuleNumberOfEntries unsignedInt R The number of entries in the Rule table. - 2.2
Device.Firewall.Chain.{i}.Rule.{i}. object(0:) W

Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain. This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions. All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE. Some of this object’s parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified. For enabled table entries, if SourceInterface is not a valid reference and SourceAllInterfaces is false, or if DestInterface is not a valid reference and DestAllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.2
Enable boolean W Enables or disables this Rule entry. false 2.2
Status string R

The status of this Rule 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.2
Order unsignedInt(1:) W Position of the Rule entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the rule criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Rule table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.2
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.2
Description string(:256) W Human-readable description associated with this Rule entry. - 2.2
Target string W

Action to perform for traffic matching this Rule entry. Enumeration of:

  • Drop (The firewall discards packets matching this rule)
  • Accept (The firewall forwards packets matching this rule)
  • Reject (The firewall discards packets matching this rule, and sends an ICMP message to the originating host, OPTIONAL)
  • Return (The firewall doesn’t consider the remaining rules (if any) in the current chain, OPTIONAL)
  • TargetChain (The rules in the chain referenced by the TargetChain parameter are matched, OPTIONAL) This parameter can only be modified if the Rule is Static (as explained in the object description).
 Drop 2.2
TargetChain string W The value MUST be the Path Name of a row in the Firewall.Chain. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the chain to process when Target equals TargetChain. If there are no matching rules in the referenced chain, processing continues with the next rule in this chain (if any). In other words, TargetChain behaves like a subroutine call. An empty string indicates no TargetChain is specified. This parameter can only be modified if the Rule is Static (as explained in the object description). <Empty> 2.2
Log boolean W Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Rule. If the Rule is not Static (as explained in the object description), whether changes to this parameter persist across re-boot is a local matter to the CPE. false 2.2
CreationDate dateTime R Date and time when this Rule entry was created. - 2.2
ExpiryDate dateTime W The time at which this Rule entry will expire, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. The only value that MUST be supported is 9999-12-31T23:59:59Z (i.e. support for rules that expire is OPTIONAL). When a rule expires, the CPE MUST automatically terminate that rule and MUST automatically delete the corresponding Rule table entry. This parameter can only be modified if the Rule is Static (as explained in the object description). 9999-12-31T23:59:59Z 2.2
SourceInterface string(:256) W Rule criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Rules can be instantiated is a local matter to the CPE. This parameter can only be modified if the Rule is Static (as explained in the object description). <Empty> 2.2
SourceInterfaceExclude boolean W If false, the rule matches only those packets that match the SourceInterface entry, if specified. If true, the rule matches all packets except those that match the SourceInterface entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
SourceAllInterfaces boolean W Rule criterion. This specifies that all ingress interfaces are associated with the entry. If true, the values of SourceInterface and SourceInterfaceExclude are ignored since all ingress interfaces are indicated. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
DestInterface string(:256) W Rule criterion. The value MUST be the Path Name of a table row. This specifies the egress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Rules can be instantiated is a local matter to the CPE. This parameter can only be modified if the Rule is Static (as explained in the object description). <Empty> 2.2
DestInterfaceExclude boolean W If false, the rule matches only those packets that match the DestInterface entry, if specified. If true, the rule matches all packets except those that match the DestInterface entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
DestAllInterfaces boolean W Rule criterion. This specifies that all egress interfaces are associated with the entry. If true, the values of DestInterface and DestInterfaceExclude are ignored since all ingress interfaces are indicated. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
IPVersion int(-1:15) W Rule criterion. IP Protocol Version (e.g. 4 for IPv4 and 6 for IPv6). A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
DestIP string(:45) W [IPAddress] Rule criterion. Destination IP address. An empty string indicates this criterion is not used for matching. Note that Firewall rules are applied after any NAT processing, so if NAT is enabled on the source interface this is always the translated address. This parameter can only be modified if the Rule is Static (as explained in the object description). <Empty> 2.2
DestMask string(:49) W [IPPrefix] Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.2
DestIPExclude boolean W If false, the rule matches only those packets that match the (masked) DestIP entry, if specified. If true, the rule matches all packets except those that match the (masked) DestIP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
SourceIP string(:45) W [IPAddress] Rule criterion. Source IP address. An empty string indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). <Empty> 2.2
SourceMask string(:49) W [IPPrefix] Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.2
SourceIPExclude boolean W If false, the rule matches only those packets that match the (masked) SourceIP entry, if specified. If true, the rule matches all packets except those that match the (masked) SourceIP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
Protocol int(-1:255) W Rule criterion. Protocol number. A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
ProtocolExclude boolean W If false, the rule matches only those packets that match the Protocol entry, if specified. If true, the rule matches all packets except those that match the Protocol entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
DestPort int(-1:65535) W Rule criterion. Destination port number. A value of -1 indicates this criterion is not used for matching. Note that Firewall rules are applied after any NAT processing, so if NAT is enabled on the source interface this is always the translated port number. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
DestPortRangeMax int(-1:65535) W Rule criterion. If specified, indicates the Rule criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. Note that Firewall rules are applied after any NAT processing, so if NAT is enabled on the source interface this is always the translated port number. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
DestPortExclude boolean W If false, the rule matches only those packets that match the DestPort entry (or port range), if specified. If true, the rule matches all packets except those that match the DestPort entry (or port range), if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
SourcePort int(-1:65535) W Rule criterion. Source port number. A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
SourcePortRangeMax int(-1:65535) W Rule criterion. If specified, indicates the Rule criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
SourcePortExclude boolean W If false, the rule matches only those packets that match the SourcePort entry (or port range), if specified. If true, the rule matches all packets except those that match the SourcePort entry (or port range), if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
DSCP int(-1:63) W Rule criterion. DiffServ codepoint (defined in [RFC2474]). If set to a Class Selector Codepoint (defined in [RFC2474]), all DSCP values that match the first 3 bits will be considered a valid match. A value of -1 indicates this criterion is not used for matching. This parameter can only be modified if the Rule is Static (as explained in the object description). -1 2.2
DSCPExclude boolean W If false, the rule matches only those packets that match the DSCP entry, if specified. If true, the rule matchess all packets except those that match the DSCP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). false 2.2
Device.PeriodicStatistics. object R This object configures collection of periodic statistics for the device. Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent samples. This object provides a single set of global settings that affect the entire device unless overridden locally. - 2.0
MinSampleInterval unsignedInt R Minimum sample interval in seconds that the CPE is able to support. A value of 0 indicates no specific minimum sample interval. - 2.0
MaxReportSamples unsignedInt R Maximum number of samples of each statistic that the CPE is able to store and report. A value of 0 indicates no specific maximum number of samples. - 2.0
SampleSetNumberOfEntries unsignedInt R The number of entries in the SampleSet table. - 2.0
Device.PeriodicStatistics.SampleSet.{i}. object(0:) W

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

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

 - 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.3
Enable boolean W Enables or disables collection of periodic statistics for this sample set. When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. false 2.0
Status string R

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the ACS SHOULD now fetch the collected data) The Trigger value is only used for triggering the ACS to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples]. The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.
 Disabled 2.0
Name string(:128) W The name of this sample set, which uniquely distinguishes each sample set. <Empty> 2.0
SampleInterval unsignedInt(1:) W The sample interval in seconds. Each statistic is measured over this sample interval. The CPE MAY reject a request to set SampleInterval to less than PeriodicStatistics.MinSampleInterval. Sample intervals MUST begin every SampleInterval seconds, with no delay between samples. If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day’s worth of samples for each statistic. 3600 2.0
ReportSamples unsignedInt(1:) W The number of samples that the CPE will store and report for each statistic. The CPE MUST permit ReportSamples to be set to at least PeriodicStatistics.MaxReportSamples. If ReportSamples is changed while collection of periodic statistics is enabled, the CPE will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day’s worth of samples for each statistic. 24 2.0
TimeReference dateTime W An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval. TimeReference is used only to set the “phase” of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future. This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval). If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. The Unknown Time value defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight. Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start. 0001-01-01T00:00:00Z 2.0
FetchSamples unsignedInt W The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled. If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur. For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also ForceSample). To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples. 0 2.0
ForceSample boolean W When set to true, forces statistics for the current sample to be calculated and updated in the data model. Setting it to false has no effect. When read, this parameter returns false, regardless of the actual value. If this is the first time that ForceSample has been set to true during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly. If this is not the first time that ForceSample has been set to true during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly. Note that ForceSample just provides a “sneak preview” of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule. At the end of each sample interval, if ForceSample was set to true during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample was set to true will be updated one last time at the end of the sample interval. false 2.0
ReportStartTime dateTime R The absolute time at which the sample interval for the first stored sample (for each statistic) started. <Empty> 2.0
ReportEndTime dateTime R The absolute time at which the sample interval for the last stored sample (for each statistic) ended. If ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected. <Empty> 2.0
SampleSeconds unsignedInt[] R

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval. Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:

TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.

Active Notification requests for this parameter MAY be denied.

 <Empty> 2.0
ParameterNumberOfEntries unsignedInt R The number of entries in the Parameter table. 0 2.0
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object(0:) W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled. Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a “sneak preview” of the current sample), or (c) at the end of the sample interval.

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

 - 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.3
Enable boolean W Enables or disables this object instance. false 2.0
Reference string(:256) W The value MUST be the Path Name of a parameter. This is the parameter being monitored by the Periodic Statistics mechanism. <Empty> 2.0
SampleMode string W

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

  • Current (Sampled value is current value)
  • Change (Sampled value is change in value since start of sample interval) Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters.
 Current 2.0
CalculationMode string W

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

  • Latest (Statistic is sampled value at end of sample interval)
  • Minimum (Statistic is minimum sampled value during sample interval)
  • Maximum (Statistic is maximum sampled value during sample interval)
  • Average (Statistic is average (mean) sampled value during sample interval) Parameters of non-numeric types can only support Latest. The value of the CalculationMode MUST be ignored for such parameters. SampleMode MUST be applied before CalculationMode, i.e. the inputs to the calculation will have already accounted for SampleMode.
 Latest 2.0
LowThreshold int W The low threshold value that controls the calculation of Failures. A value equal to HighThreshold disables the threshold/failure mechanism. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. 0 2.0
HighThreshold int W The high threshold value that controls the calculation of Failures. A value equal to LowThreshold disables the threshold/failure mechanism. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. 0 2.0
SampleSeconds unsignedInt[] R

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval. Individual SampleSeconds values can be less than PeriodicStatistics.SampleSet.{i}.SampleInterval, for several reasons, including:

Any of the reasons for which PeriodicStatistics.SampleSet.{i}.SampleSeconds values might be less than PeriodicStatistics.SampleSet.{i}.SampleInterval.
The parameter doesn’t exist, or was created or deleted during a sample interval.

Active Notification requests for this parameter MAY be denied.

 <Empty> 2.0
SuspectData unsignedInt(:1)[] R

Comma-separated list of unsigned integers (up to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval. For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1.

Active Notification requests for this parameter MAY be denied.

 <Empty> 2.0
Values string[] R

Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval. The statistics values in this comma-separated lists MUST be in time order, with the oldest one first and the most recent one last. If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.

Active Notification requests for this parameter MAY be denied.

 <Empty> 2.0
Failures unsignedInt R Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the “in range” state to the “out of range” state, or between the “out of range (low)” and “out of range (high)” states. The states are defined as follows:
  • “in range” : current value is greater than LowThreshold and less than HighThreshold.
  • “out of range” : current value is less than or equal to LowThreshold, or greater than or equal to HighThreshold.
  • “out of range (low)” : current value is less than or equal to LowThreshold.
  • “out of range (high)” : current value is greater than or equal to HighThreshold. Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment. This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in [Section 3.2.1/TR-069a2]. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.
 0 2.0
Device.FaultMgmt. object R This object contains parameters relating to Fault/Alarm Management. - 2.4
SupportedAlarmNumberOfEntries unsignedInt R The number of entries in the SupportedAlarm table. - 2.4
MaxCurrentAlarmEntries unsignedInt R The maximum number of entries allowed in the FaultMgmt.CurrentAlarm.{i}. table. - 2.4
CurrentAlarmNumberOfEntries unsignedInt R The number of entries in the CurrentAlarm table. - 2.4
HistoryEventNumberOfEntries unsignedInt R The number of entries in the HistoryEvent table. - 2.4
ExpeditedEventNumberOfEntries unsignedInt R The number of entries in the ExpeditedEvent table. - 2.4
QueuedEventNumberOfEntries unsignedInt R The number of entries in the QueuedEvent table. - 2.4
Device.FaultMgmt.SupportedAlarm.{i}. object(0:) R

Supported Alarm Entries which can be raised by the device. The instance numbers for this table SHOULD be maintained across firmware upgrades of the device.

At most one entry in this table can exist with the same values for all of EventType, ProbableCause, SpecificProblem and PerceivedSeverity.

 - 2.4
EventType string(:64) R Indicates the type of event. - 2.4
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support unique indexing of the table using SpecificProblem. The string can be set to “*” to indicate the default case if only a subset of SpecificProblem are to be contained within the table. - 2.4
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • <Empty> (An empty string)
  • ***
  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate This will be an empty string if the device doesn’t support unique indexing of the table using PerceivedSeverity. The string can be set to “*” to indicate the default case if only a subset of PerceivedSeverity are to be contained within the table.
 - 2.4
ReportingMechanism string W

Indicates the reporting mechanism setting of the alarm. Enumeration of:

 - 2.4
Device.FaultMgmt.CurrentAlarm.{i}. object(0:) R

Contains all currently active alarms (whose FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity is not Cleared). Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table. If maximum entries as indicated by FaultMgmt.MaxCurrentAlarmEntries is reached, the next event overrides the object with the oldest AlarmChangedTime. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier, or with the same values for all of EventType, ProbableCause and SpecificProblem.

 - 2.4
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 2.4
AlarmRaisedTime dateTime R Indicates the date and time when the alarm was first raised by the device. - 2.4
AlarmChangedTime dateTime R Indicates the date and time when the alarm was last changed by the device. - 2.4
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this CurrentAlarm. - 2.4
EventType string(:64) R Indicates the type of event. - 2.4
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 2.4
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
 - 2.4
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 2.4
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 2.4
Device.FaultMgmt.HistoryEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table. This table also contains alarm clearing events. Active alarms at the time of a power failure or reboot might not get an alarm clearing event. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.HistoryEventNumberOfEntries. If maximum instance number FaultMgmt.HistoryEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records.

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

 - 2.4
EventTime dateTime R Indicates the date and time when the alarm event occurs. - 2.4
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 2.4
NotificationType string R

Indicates the reason for the specific alarm notification event. Enumeration of:

  • NewAlarm
  • ChangedAlarm
  • ClearedAlarm
 - 2.4
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this HistoryEvent. - 2.4
EventType string(:64) R Indicates the type of event. - 2.4
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 2.4
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
 - 2.4
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 2.4
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 2.4
Device.FaultMgmt.ExpeditedEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 0 Expedited. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.ExpeditedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4]. If maximum instance number FaultMgmt.ExpeditedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

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

 - 2.4
EventTime dateTime R Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4]. - 2.4
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is an empty string. - 2.4
NotificationType string R

Indicates the reason for the specific alarm notification event. Enumeration of:

  • NewAlarm
  • ChangedAlarm
  • ClearedAlarm
 - 2.4
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this ExpeditedEvent. - 2.4
EventType string(:64) R Indicates the type of event. - 2.4
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 2.4
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
 - 2.4
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 2.4
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 2.4
Device.FaultMgmt.QueuedEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 1 Queued. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.QueuedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4]. If maximum instance number FaultMgmt.QueuedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

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

 - 2.4
EventTime dateTime R Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4]. - 2.4
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is an empty string. - 2.4
NotificationType string R

Indicates the reason for the specific alarm notification event. Enumeration of:

  • NewAlarm
  • ChangedAlarm
  • ClearedAlarm
 - 2.4
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this QueuedEvent. - 2.4
EventType string(:64) R Indicates the type of event. - 2.4
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 2.4
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 2.4
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
 - 2.4
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 2.4
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 2.4
Device.Security. object R This object contains general information related to managing security features on the device. - 2.4
CertificateNumberOfEntries unsignedInt R The number of entries in the Certificate table. - 2.4
Device.Security.Certificate.{i}. object(0:) R

This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280].

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

 - 2.4
Enable boolean W Enables or disables this certificate. - 2.4
LastModif dateTime R The last modification time of this certificate. - 2.4
SerialNumber string(:64) R The Serial Number field in an X.509 certificate, see [RFC5280]. - 2.4
Issuer string(:256) R The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 2.4
NotBefore dateTime R The beginning of the certificate validity period; i.e. the Not Before field in an X.509 certificate, see [RFC5280]. - 2.4
NotAfter dateTime R The end of the certificate validity period; i.e., the Not After field in an X.509 certificate, see [RFC5280]. - 2.4
Subject string(:256) R The Distinguished Name (DN) of the entity associated with the Public Key; i.e., the Subject field in an X.509 certificate, see [RFC5280]. - 2.4
SubjectAlt string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Each item is a DNS Name. The Subject Alternative Names extension field in an X.509 certificate, see [RFC5280]. - 2.4
SignatureAlgorithm string(:256) R The algorithm used in signing the certificate; i.e. the Signature Algorithm field in an X.509 certificate, see [RFC5280]. - 2.4
Device.FAP. object R This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 2.4
Device.FAP.GPS. object R This object contains the parameters relating to the GPS scan. - 2.4
ScanOnBoot boolean W

Enables or disables GPS scans during the device start up.

The factory default value MUST be true.

 - 2.4
ScanPeriodically boolean W

Enables or disables periodic GPS scans.

The factory default value MUST be false.

 - 2.4
PeriodicInterval unsignedInt W When ScanPeriodically is true, this value indicates the interval in seconds which GPS scan is performed. - 2.4
PeriodicTime dateTime W An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the PeriodicInterval. PeriodicTime is used only to set the “phase” of the GPS scan. The actual value of PeriodicTime can be arbitrarily far into the past or future. For example, if PeriodicInterval is 86400 (a day) and if PeriodicTime is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106a4] 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 GPS scan behavior MUST be the same as if PeriodicTime parameter was set to the Unknown Time value. - 2.4
ContinuousGPS boolean W Whether or not the device SHOULD maintain a continuous GPS lock (e.g. as a frequency stability source). - 2.4
ScanTimeout unsignedInt W Specifies the time-out value in seconds since the scan started after which the scan will time out. A timed out scan is to be reported as Error_TIMEOUT with ErrorDetails indicating “Timed out” - 2.4
ScanStatus string R

Indicates the current status of this scan.

Enumeration of:

  • Indeterminate (The scan has not been executed and there are no valid scan results available)
  • InProgress
  • Success
  • Error
  • Error_TIMEOUT
 - 2.4
ErrorDetails string(:256) R Provides more detail when the ScanStatus is either Error or Error_TIMEOUT. - 2.4
LastScanTime dateTime R

The date and time when the last GPS scan completed.

Active Notification MUST by default be enabled for this parameter.

 - 2.4
LastSuccessfulScanTime dateTime R

Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboot and is only reset after another scan completes successfully or GPSReset is set to true. The values for LockedLatitude, LockedLongitude and NumberOfSatellites correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in [Section 3.2/TR-106a4].

Active Notification requests for this parameter MAY be denied.

 - 2.4
LockedLatitude int(-90000000:90000000) R

This parameter specifies the latitude of the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90d00.00’ South (-90,000,000) to 90d00.00’ North (90,000,000). Example: A latitude of 13d19.43’ N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00’ S would be represented as value -50,000,000. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported.

Active Notification requests for this parameter MAY be denied.

 - 2.4
LockedLongitude int(-180000000:180000000) R

This parameter specifies the longitude of the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00’ West (-180,000,000) to 180d00.00’ East (180,000,000). Example: A longitude of 13d19.43’ E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00.00’ W would be represented as value -50,000,000. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported.

Active Notification requests for this parameter MAY be denied.

 - 2.4
NumberOfSatellites unsignedInt R

The number of satellites that were locked during the test execution. The greater the number of satellites the better the precision of the results. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported.

Active Notification requests for this parameter MAY be denied.

 - 2.4
GPSReset boolean W Setting this to true will cause a reset on the GPS Hardware. Setting this to false has no effect. - 2.4
Device.FAP.GPS.ContinuousGPSStatus. object R When ContinuousGPS is true, the parameters in this object contain the GPS status as it is continuously monitored. When ContinuousGPS is false, the parameters in this object are not being updated and their values are not accurate. - 2.4
CurrentFix boolean R

The value is true if the location fix is currently valid (i.e. GPS receiver is currently tracking satellite signals), otherwise it is false. After a reboot the value is false until the GPS receivers has a valid current position.

Active Notification requests for this parameter MAY be denied.

 - 2.4
GotFix boolean R

The value is true if CurrentFix has transitioned to true at least once since ContinuousGPS was enabled, otherwise it is false. After a reboot the value is false until CurrentFix has transitioned to true again. The GPS coordinates (Latitude, Longitude, and Elevation) are not valid until GotFix has a value of true.

Active Notification requests for this parameter MAY be denied.

 - 2.4
TimingGood boolean R

The value is true if the timing synchronization is good, otherwise it is false. After a reboot the value is false until the timing is synchronized again.

Active Notification requests for this parameter MAY be denied.

 - 2.4
Latitude int(-90000000:90000000) R

This parameter represents the most recent latitude reading for the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90 deg 00.00’ South (-90,000,000) to 90 deg 00.00’ North (90,000,000). Example: A latitude of 13 deg 19.43’ N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50 deg 00.00’ S would be represented as value -50,000,000. Latitude is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot.

Active Notification requests for this parameter MAY be denied.

 - 2.4
Longitude int(-180000000:180000000) R

This parameter represents the most recent longitude reading for the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00’ West (-180,000,000) to 180d00.00’ East (180,000,000). Example: A longitude of 13d19.43’ E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00.00’ W would be represented as value -50,000,000. Longitude is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot.

Active Notification requests for this parameter MAY be denied.

 - 2.4
Elevation int(-5000000:25000000) R

This parameter represents the most recent elevation reading for the device’s position in millimeters, relative to the WGS84 ellipsoid. The positive value signifies the direction, above sea level. The negative value signifies the direction, below sea level. Range is from: 5,000.000 meters below sea level (-5,000,000) to 25,000.000 meters above sea level (25,000,000). Elevation is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot.

Active Notification requests for this parameter MAY be denied.

 - 2.4
LastFixTime dateTime R

Represents the date and time when the last GPS Fix was acquired. The Unknown Time value defined in [Section 3.2/TR-106a4] is used when GotFix is false. This applies too after a reboot of the device until a valid location is determined and GotFix transsitions to true.

Active Notification requests for this parameter MAY be denied.

 - 2.4
LastFixDuration unsignedInt R

Number of seconds of continuous GPS fix time. After a reboot this value is reset to 0.

Active Notification requests for this parameter MAY be denied.

 - 2.4
FirstFixTimeout int(-1:) W Number of seconds to wait for first GPS fix before declaring a GPS fault. A value of -1 means that there is no timeout and no fault logging. - 2.4
SatellitesTracked unsignedInt R

The number of satellites the receiver is tracking.

Active Notification requests for this parameter MAY be denied.

 - 2.4
SatelliteTrackingInterval unsignedInt(60:3600) W The interval in seconds at which the GPS tracking information gets reported. - 2.4
ReceiverStatus string(:256) R

The output of the GPS receiver’s status.

Active Notification requests for this parameter MAY be denied.

 - 2.4
LocationType string R

Indicates whether the Latitude, Longitude, and Elevation values are determined via a GPS Fix (where the value of this parameter would be Real) or via some other means (where the value of this parameter would be Reference).

Enumeration of:

  • Real
  • Reference

Active Notification requests for this parameter MAY be denied.

 - 2.4
LockTimeOutDuration unsignedInt(120:86400) W The timer duration, in seconds, for which the device waits for GPS to acquire lock. - 2.4
Device.FAP.GPS.AGPSServerConfig. object R This object contains parameters for the configuration of the Assisted Global Positioning System (A-GPS) server. See also [Section 3.2/3GPP-TS.25.171] - 2.4
Enable boolean W Enables or disables the AGPSServerConfig entry. - 2.4
ServerURL string(:256) W A-GPS server host name or IP address. - 2.4
ServerPort unsignedInt(:65535) W The port to use when communicating to the A-GPS Server. - 2.4
Username string(:64) W Username to be used by the device to authenticate with the A-GPS server. This string is set to an empty string if no authentication is used. - 2.4
Password string(:64) W

Password to be used by the device to authenticate with the A-GPS server. This string is set to an empty string if no authentication is used.

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

 - 2.4
ReferenceLatitude int(-90000000:90000000) W This parameter specifies the reference latitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90d00.00’ South (-90,000,000) to 90d00.00’ North (90,000,000). Example: A latitude of 13d19.43’ N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00’ S would be represented as value -50,000,000. - 2.4
ReferenceLongitude int(-180000000:180000000) W This parameter specifies the reference longitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00’ West (-180,000,000) to 180d00.00’ East (180,000,000). Example: A longitude of 13d19.43’ E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00’00* W would be represented as value -50,000,000. - 2.4
ServerInUse boolean R The value is true if the device has successfully contacted and received A-GPS info from the A-GPS server, otherwise the value is false. After a reboot the value is false until the server could be contacted again. - 2.4
Device.FAP.PerfMgmt. object R This object contains parameters relating to Performance Management in a Femto-related environment. - 2.4
ConfigNumberOfEntries unsignedInt R The number of entries in the Config table. - 2.4
Device.FAP.PerfMgmt.Config.{i}. object(0:) W

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

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

 - 2.4
Enable boolean W Enables or disables this entry. If this entry is disabled then its periodic uploads are not performed. - 2.4
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.4
URL string(:256) W URL specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. - 2.4
Username string(:256) W Username to be used by the device to authenticate with the file server. This string is set to an empty string if no authentication is used. - 2.4
Password string(:256) W

Password to be used by the device to authenticate with the file server. This string is set to an empty string if no authentication is used.

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

 - 2.4
PeriodicUploadInterval unsignedInt(1:) W The duration in seconds of the interval for which the device MUST create a Performance File and attempt to upload the file to URL if Enable is true. - 2.4
PeriodicUploadTime dateTime W An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the PeriodicUploadInterval. PeriodicUploadTime is used only to set the “phase” of the periodic uploads. The actual value of PeriodicUploadTime can be arbitrarily far into the past or future. For example, if PeriodicUploadInterval is 86400 (a day) and if PeriodicUploadTime is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicUploadTime refers to a day in the future. The Unknown Time value as defined in [Section 3.2/TR-106a4] indicates that no particular time reference is specified. That is, the device MAY locally choose the time reference, and is REQUIRED only to adhere to the specified PeriodicUploadInterval. If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the PeriodicUploadTime parameter was set to the Unknown Time value. - 2.4
Device.FAP.ApplicationPlatform. object R This object defines the data model for the following Femtozone APIs.
  • Femto Awareness
  • SMS
  • MMS
  • Terminal Location Femto Awareness, SMS, MMS, and Terminal Location APIs are defined in the Release 1 API Specifications of the Service SIG in the Femto Forum (non public document). [Appendix I/TR-262] provides the “Theory of Operation” for the usage of this object.
 - 2.4
Version string(:64) R Version of Femto Application Platform running on this device - 2.4
Enable boolean W Enable or disable the Femto ApplicationPlatform - 2.4
Status string R

Current state of the Femto Application Platform.

Enumeration of:

  • Disabled (The Femto Application Platform is not available)
  • Enabled (The Femto Application Platform is available)
  • Reset (The FemtoApplicationPlatform is in the process of being reset and will transition to the Disabled state when the reset operation is completed)
  • Initializing (The FemtoApplicationPlatform is being initialized and will transition to the Enabled state once the initialization is completed)
 - 2.4
MaxNumberOfApplications unsignedInt R Determines how many Femtozone Applications can be supported by the Femto Application Platform simultaneously. - 2.4
CurrentNumberofApplications unsignedInt R Specifies how many Femtozone Applications are currently communicating with the Femto Application Platform. - 2.4
Device.FAP.ApplicationPlatform.Capabilities. object R This object contains parameters related to the capabilities of the Femtozone Application Platform and the Femtozone APIs. - 2.4
PresenceApplicationSupport boolean R Specifies whether the Femto Application Platform supports Presence-Based Femtozone Applications - 2.4
FemtoAwarenessAPISupport boolean R Specifies whether the Femto Awareness API is supported on this device. - 2.4
SMSAPISupport boolean R Specifies whether the SMS API is supported on this device. - 2.4
SubscribeToNotificationsOfSMSSentToApplicationSupport boolean R Specifies whether the SubscribeToNotificationsOfSMSSentToApplication functionality is supported by the FAP SMS API. - 2.4
QuerySMSDeliveryStatusSupport boolean R Specifies whether the QuerySMSDeliveryStatus functionality is supported by the FAP SMS API. - 2.4
MMSAPISupport boolean R Specifies whether the MMS API is supported on this device. - 2.4
QueryMMSDeliveryStatusSupport boolean R Specifies whether the QueryMMSDeliveryStatus functionality is supported by the FAP MMS API. - 2.4
SubscribeToNotificationsOfMMSSentToApplicationSupport boolean R Specifies whether the SubscribeToNotificationsOfMMSSentToApplication functionality is supported by the FAP MMS API. - 2.4
TerminalLocationAPISupport boolean R Specifies whether the Terminal Location API is supported on this device. - 2.4
AuthenticationMethodsSupported string[] R

Comma-separated list of strings. Specifies the supported methods that 3rd Party Applications can use to authenticate with the Femto Application Platform at initialization. Comma separated list of strings.

Each list item is an enumeration of:

  • Basic
  • Digest
  • DigitalSignature
 - 2.4
AccessLevelsSupported string[] R

Comma-separated list of strings. Specifies the supported access levels that 3rd Party Applications can request when authenticating with the Femto Application Platform at initialization. This access level is with respect to resources within the Femto Application Platform only (not to be confused with Access Mode parameter in .FAPService.{i}.AccessMgmt).

Each list item is an enumeration of:

  • Guest
  • Standard
  • Restricted
  • Administrator
  • Debug
 - 2.4
SendSMSTargetAddressType string[] R

Comma-separated list of strings. Specifies the supported types of addresses SMSs can be sent to.

Each list item is an enumeration of:

  • TelUri
  • AnonymousReference
  • All
 - 2.4
SendMMSTargetAddressType string[] R

Comma-separated list of strings. Specifies the supported types of addresses MMSs can be sent to.

Each list item is an enumeration of:

  • TelUri
  • AnonymousReference
  • All
 - 2.4
Device.FAP.ApplicationPlatform.Control. object R This object contains parameters related to the operation of the Femtozone APIs. - 2.4
AuthenticationMethod string(:256) W Specifies how 3rd Party Applications have to authenticate against Femto APIs in order to use it. The value MUST be a member of the list reported by the Capabilities.AuthenticationMethodsSupported parameter. Note: The credentials are not part of the data model and have to be supplied externally. - 2.4
TunnelInst string(:256) W This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic. If InternetGatewayDevice:1 [TR-098] or Device:1 [TR-181i1]) is used as root data model the TunnelInst MUST point to a row in the .FAP.Tunnel.IKESA.{i}. table. If the root data model used is Device:2 [TR-181i2] than the TunnelInst MUST point to an tunnel instance defined in this data model. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.4
Device.FAP.ApplicationPlatform.Control.FemtoAwareness. object R This object contains parameters related to the Femto Awareness API. - 2.4
APIEnable boolean W Enable or disable FemtoAwareness API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

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

Enumeration of:

  • FiFo
  • Priority
 - 2.4
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to Femto Awareness API. - 2.4
FemtozoneID string(:256) W Specifies Identifier of the Femtozone. - 2.4
NotificationsUserIdentifierMSISDN boolean W Specifies whether the Mobile Station International Subscriber Directory Number (MSISDN) has to be used as UserIdentifier in Femto Awareness Notifications. A value of true means that the MSISDN is send as user identifier, a value of false means that an anonymous reference is used. - 2.4
SubscribeToNotificationsResponseCallbackData boolean W Specifies whether the OPTIONAL Argument “Callback Data” has to be used in Responses to Requests to “Subscribe To Femto Awareness Notifications”. - 2.4
QueryFemtocellResponseTimezone boolean W Specifies whether the OPTIONAL Argument “Timezone” has to be used in Responses to Requests to “Query Femtocell Status”. - 2.4
Device.FAP.ApplicationPlatform.Control.SMS. object R This object contains parameters related to the SMS API. - 2.4
APIEnable boolean W Enable or disable SMS API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

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

Enumeration of:

  • FiFo
  • Priority
 - 2.4
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to SMS API. - 2.4
MinSendSMSTimeInterval unsignedInt(0:3599) W Determines the Minimum Time Interval in seconds between two consecutive Send SMS Requests by the same Application. - 2.4
EnableQuerySMSDeliveryStatus boolean W Enable or disable “QuerySMSDeliveryStatus” Operation on SMS API. When disabled, QuerySMSDeliveryStatus Requests to SMS API are ignored. - 2.4
EnableSubscribeToNotificationsOfMessageSentToApplication boolean W Enable or disable “SubscribeToNotificationsOfMessageSentToApplication” Operation on SMS API. When disabled, SubscribeTo NotificationsOfMessageSentToApplication Requests to SMS API are ignored. - 2.4
Device.FAP.ApplicationPlatform.Control.MMS. object R This object contains parameters related to the MMS API. - 2.4
APIEnable boolean W Enable or disable MMS API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

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

Enumeration of:

  • FiFo
  • Priority
 - 2.4
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to MMS API. - 2.4
MinSendMMSTimeInterval unsignedInt(0:3599) W Determines the Minimum Time Interval in seconds between two consecutive Send MMS Requests by the same Application. - 2.4
EnableQueryMMSDeliveryStatus boolean W Enable or disable “QuerySMSDeliveryStatus” Operation on MMS API. When disabled, QuerySMSDeliveryStatus Requests to MMS API are ignored. - 2.4
EnableSubscribeToNotificationsOfMessageSentToApplication boolean W Enable or disable “SubscribeTo NotificationsOfMessageSentToApplication” Operation on MMS API. When disabled, SubscribeTo NotificationsOfMessageSentToApplication Requests to MMS API are ignored. - 2.4
Device.FAP.ApplicationPlatform.Control.TerminalLocation. object R This object contains parameters related to the TerminalLocation API. - 2.4
APIEnable boolean W Enable or disable TerminalLocation API exposure on FAP - 2.4
QueueEnable boolean W Enable or disable Request queueing for the API - 2.4
Queueing string W

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

Enumeration of:

  • FiFo
  • Priority
 - 2.4
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to TerminalLocation API. - 2.4
QueryMobileLocationResponseAddress string W

Specifies Terminal Address Format to be used in QueryMobileLocation Responses.

Enumeration of:

  • TelUri
  • AnonymousReference
 - 2.4
QueryMobileLocationResponseLongitudeLatitude boolean W Include or exclude FAP Longitude and Latitude arguments in Responses to QueryMobileLocation Requests. - 2.4
QueryMobileLocationResponseAltitude boolean W Include or exclude FAP Altitude argument in Responses to QueryMobileLocation Requests . - 2.4
QueryMobileLocationResponseTimestamp unsignedInt(0:86399) W Specifies Response Timestamp in seconds. - 2.4
Device.FAP.ApplicationPlatform.Monitoring. object R This object contains parameters related to the monitoring of the Femtozone Application Platform and the Femtozone APIs. - 2.4
Enable boolean W Enables and disables this entry. - 2.4
MonitoringInterval unsignedInt W Specifies the interval in seconds used to collect the monitoring measurements. - 2.4
AuthenticationRequestsReceived unsignedInt R Specifies the total number of authentication requests received by the Femto Application Platform. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
AuthenticationRequestsRejected unsignedInt R Specifies the number of authentication requests received by the Femto Application Platform that were rejected. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.FemtoAwareness. object R This object contains parameters related to the Monitoring of the FemtoAwareness API. - 2.4
APIAvailable boolean R Specifies whether the FemtoAwareness API is currently available on this device (the API could be disabled or could have exhausted its resources) - 2.4
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the Femto Awareness API. - 2.4
QueueState string R

Specifies the state of the Femto Awareness API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 2.4
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the Femto Awareness API Queue. - 2.4
QueueReceived unsignedInt R Specifies the number of requests in the Femto Awareness API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt R Specifies the number of requests in the Femto Awareness API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.SMS. object R This object contains parameters related to the Monitoring of the SMS API. - 2.4
APIAvailable boolean R Specifies whether the SMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 2.4
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the SMS API. - 2.4
QueueState string R

Specifies the state of the SMS API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 2.4
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the SMS API Queue. - 2.4
QueueReceived unsignedInt R Specifies the number of requests in the SMS API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt R Specifies the number of requests in the SMS API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.MMS. object R This object contains parameters related to the Monitoring of the MMS API. - 2.4
APIAvailable boolean R Specifies whether the MMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 2.4
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the MMS API. - 2.4
QueueState string R

Specifies the state of the MMS API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 2.4
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the MMS API Queue. - 2.4
QueueReceived unsignedInt R Specifies the number of requests in the MMS API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt R Specifies the number of requests in the MMS API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.FAP.ApplicationPlatform.Monitoring.TerminalLocation. object R This object contains parameters related to the Monitoring of the TerminalLocation API. - 2.4
APIAvailable boolean R Specifies whether the TerminalLocation API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 2.4
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the Terminal Location API. - 2.4
QueueState string R

Specifies the state of the Terminal Location API Queue.

Enumeration of:

  • Disabled
  • Ready
  • Flushed
 - 2.4
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the Terminal Location API Queue. - 2.4
QueueReceived unsignedInt R Specifies the number of requests in the Terminal Location API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
QueueDiscarded unsignedInt R Specifies the number of requests in the Terminal Location API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 2.4
Device.BulkData. object R This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in [TR-232]. The HTTP solution is based on transfer mechanisms described in [Annex A/TR-157a10]. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. - 2.5
Enable boolean W Enables or disables all collection profiles. If false, bulk data will not be collected or reported. - 2.5
Status string R

Indicates the status of the Bulk Data Collection mechanism.

Enumeration of:

  • Enabled (Bulk Data Collection is enabled and working as intended)
  • Disabled (Bulk Data Collection is disabled)
  • Error (Bulk Data Collection is enabled, but there is an error condition preventing the successful collection of bulk data, OPTIONAL)
 - 2.5
MinReportingInterval unsignedInt R Minimum reporting interval in seconds that the CPE is capable of supporting. A value of 0 indicates no minimum reporting interval. - 2.5
Protocols string[] R

Comma-separated list of strings. Represents the IPDR and transport protocols that this device is capable of supporting.

Each list item is an enumeration of:

  • Streaming (IPDR Streaming Protocol [IPDR-SP])
  • File (IPDR File Transfer Protocol [IPDR-FTP])
  • HTTP (Hypertext Transfer Protocol [RFC2616])
 - 2.5
EncodingTypes string[] R

Comma-separated list of strings. Represents the Encoding Types for the protocols that this device is capable of supporting.

Each list item is an enumeration of:

  • XML (Used with the IPDR Streaming and File Protocols. [IPDR-XML])
  • XDR (Used with the IPDR Streaming and File Protocols. [IPDR-XDR])
  • CSV (Comma Separated Values. Used with the HTTP Protocol. [RFC4180])
  • JSON (JavaScript Object Notation. Used with the HTTP Protocol [RFC7159])
 - 2.5
ParameterWildCardSupported boolean R When true, the Device supports the use of wildcards to determine the parameters that are reported using a Profile. - 2.10
MaxNumberOfProfiles int(-1:) R The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the ACS can create. If the value of this parameter is -1, then it means that the CPE doesn’t have a limit to the number of profiles that can exist. - 2.5
MaxNumberOfParameterReferences int(-1:) R The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via Profile.{i}.Parameter.{i}.Reference across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter). If the value of this parameter is -1, then it means that the CPE doesn’t have a limit to the number of parameter that can be referenced via the bulk data collection mechanism. - 2.5
ProfileNumberOfEntries unsignedInt R The number of entries in the Profile table. - 2.5
Device.BulkData.Profile.{i}. object(0:) W

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

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

 - 2.5
Enable boolean W Enables or disables this specific bulk data profile. If false, this profile will not be collected or reported. false 2.5
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.5
Name string(:255) W The name of the profile. - 2.10
NumberOfRetainedFailedReports int(-1:) W The number of failed reports to be retained and transmitted (in addition to the current report) at the end of the current reporting interval. If the value of the EncodingType parameter is modified any outstanding failed reports are deleted. If the CPE cannot retain the number of failed reports from previous reporting intervals while transmitting the report of the current reporting interval, then the oldest failed reports are deleted until the CPE is able to transmit the report from the current reporting interval. A value of 0 indicates that failed reports are not to be retained for transmission in the next reporting interval. A value of -1 indicates that the CPE will retain as many failed reports as possible. 0 2.10
Protocol string W The value MUST be a member of the list reported by the Protocols parameter. The Bulk Data Protocol being used for this collection profile. - 2.5
EncodingType string W The value MUST be a member of the list reported by the EncodingTypes parameter. The Bulk Data encoding type being used for this collection profile. - 2.5
ReportingInterval unsignedInt(1:) W The reporting interval in seconds. Each report is generated based on this interval and TimeReference. The CPE MAY reject a request to set ReportingInterval to less than MinReportingInterval. Reporting intervals MUST begin every ReportingInterval seconds. If ReportingInterval is changed while collection is enabled, the first reporting interval begins immediately. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if the Protocol parameter is set to Streaming) its report at midnight every 24 hours. 86400 2.5
TimeReference dateTime W An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations. TimeReference is used only to set the “phase” of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future. If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately. The Unknown Time value as defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a “ITPush” mode) its report at midnight every 24 hours. Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start. 0001-01-01T00:00:00Z 2.5
StreamingHost string(:256) W This is the host name or IP Address of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). - 2.5
StreamingPort unsignedInt(0:65535) W This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). 4737 2.5
StreamingSessionID unsignedInt(48:57,65:90) W This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single ‘char’, but we are restricting the range even further (ASCII values of ‘0’ - ‘9’ and ‘A’ - ‘Z’. - 2.5
FileTransferURL string(:256) W This is the URL within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). - 2.5
FileTransferUsername string(:64) W Username used for authentication of the FileTransferURL. This is the FileTransferUsername that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). - 2.5
FileTransferPassword string(:64) W

Password used for authentication of the FileTransferURL. This is the FileTransferPassword that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

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

 - 2.5
ControlFileFormat string(:128) W

If this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File) then the control file names will be of the following format:

_. Where the following rules apply:
  • ControlFilePrefix MUST NOT contain an underscore ‘_’ or any other character not suitable for a file name.
  • ControlFilePolicy MUST contain one or more ‘N’ characters, where the number of ‘N’ characters denotes the number of digits in the sequence number, including leading zeros as necessary to match the number of ‘N’ characters.
  • ControlFileSuffix is a file extension. For example, BulkData_NNNN.log where “BulkData” would be the prefix, “NNNN” would be the policy, and “log” would be the suffix. Files adhering to this file format would look like: BulkData_0000.log, BulkData_0001.log, etc.
 - 2.5
ParameterNumberOfEntries unsignedInt R The number of entries in the Parameter table. - 2.5
Device.BulkData.Profile.{i}.Parameter.{i}. object(0:) W Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported. - 2.5
Name string(:64) W Name of the parameter in the report body. If the value of this parameter is an empty string, then the value of the Reference parameter is used as the name. When the value Reference parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in [Annex A.3.2.1/TR-157a10]. - 2.10
Reference string(:256) W The value MUST be the Path Name of a parameter or object. Represents the parameter(s) that are part of this Bulk Data collection profile. The value MUST be a path name of a parameter or an object. When the ParameterWildCardSupported parameter has a value of true, patterns for instance identifiers are permitted with wildcards (an “*” character) in place of instance identifiers; any attempt to set the value otherwise MUST be rejected by the CPE. In the case where a partial parameter path is specified, the sub-objects of the resolved pattern and contained parameters will be part of the bulk data collected and reported. If the path name refers to an object then it MUST end with a ‘.’. <Empty> 2.5
Device.BulkData.Profile.{i}.CSVEncoding. object R This object defines the properties to be used when the Profile object’s EncodingType parameter value is CSV. - 2.10
FieldSeparator string W Field separator to use when encoding CSV data. , 2.10
RowSeparator string W Row separator to use when encoding CSV data. <Empty> 2.10
EscapeCharacter string W Escape character to use when encoding CSV data. “ 2.10
ReportFormat string W

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

Enumeration of:

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

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

Enumeration of:

  • Unix-Epoch (Timestamp is inserted using the UNIX epoch time (milliseconds since Jan 1, 1970 UTC) timestamp format. If the CPE is unable to acquire a time, then the time that has elapsed since the last reboot of the device is used)
  • ISO-8601 (Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in [Table 12/TR-069] is followed)
  • None (Timestamp is not inserted in the row)
 Unix-Epoch 2.10
Device.BulkData.Profile.{i}.JSONEncoding. object R This object defines the properties to be used when the Profile object’s EncodingType parameter value is JSON. - 2.10
ReportFormat string W

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

Enumeration of:

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

The format of timestamp to use for the JSON Object named “CollectionTime” as described in [TR-157a10].

Enumeration of:

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

Password used to authenticate the CPE when making a connection to the collection server.

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

 - 2.10
CompressionsSupported string[] R

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE for the purposes of transferring bulk data.

Each list item is an enumeration of:

 - 2.10
Compression string W The value MUST be a member of the list reported by the CompressionsSupported parameter, or else be None. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when transferring data to the collection server. None 2.10
MethodsSupported string[] R

Comma-separated list of strings. Indicates the HTTP method(s) supported by this CPE for the purposes of transferring bulk data.

Each list item is an enumeration of:

 - 2.10
Method string W The value MUST be a member of the list reported by the MethodsSupported parameter. The value of this parameter represents the HTTP method to be used by the CPE when transferring data to the collection server. POST 2.10
UseDateHeader boolean W When true, the CPE encodes the HTTP Date Header [Section 14.18/RFC2616] in the HTTP client request. true 2.10
RetryEnable boolean W When true, the CPE retries unsuccessful attempts to transfer data. false 2.10
RetryMinimumWaitInterval unsignedInt(1:65535) W Configures the data transfer retry wait interval, in seconds, as specified in [Annex A.2.2.1/TR-157a10]. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 5 2.10
RetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in [Annex A.2.2.1/TR-157a10]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 2000 2.10
RequestURIParameterNumberOfEntries unsignedInt R The number of entries in the RequestURIParameter table. - 2.10
PersistAcrossReboot boolean W Determines whether or not data transfers that have failed are required to be persisted across reboots. If PersistAcrossReboot is true, then failed data transfers MUST be persisted across reboots. If PersistAcrossReboot is false, then failed data transfers are not required to be persisted across reboots. false 2.12
Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. object(0:) W This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by [Annex A.2.1/TR-157a10]. - 2.10
Name string(:64) W Name of the Request-URI parameter. If Name is an empty string, the name of the Request-URI parameter is the value of Reference. - 2.10
Reference string(:256) W The value MUST be the path name of a parameter to be used as the Request-URI parameter. If the value of this parameter is empty, then this object is not encoded in the report header. <Empty> 2.10
Device.XMPP. object R The XMPP represents the XMPP capabilities of the device as described in [Appendix III/TR-069a5]. - 2.7
ConnectionNumberOfEntries unsignedInt R The number of entries in the Connection table. - 2.7
SupportedServerConnectAlgorithms string[] R

Comma-separated list of strings. The algorithms supported by the CPE for resolving XMPP server addresses and ports. Each list item is an enumeration of:

 - 2.11
Device.XMPP.Connection.{i}. object(0:) W

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

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

 - 2.7
Enable boolean W Enables or disables this Connection. This parameter is based on ifAdminStatus from [RFC2863]. false 2.7
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.7
Username string(:256) W The proposed local-part of the Jabber ID of this Connection, and the value to be used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. - 2.7
Password string(:256) W

Password used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

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

 - 2.7
Domain string(:64) W The proposed domain-part of the Jabber ID of this Connection. - 2.7
Resource string(:64) W The proposed resource-part of the Jabber ID of this Connection. - 2.7
JabberID string R The complete Jabber ID as determined by the first-hop XMPP server at time of connection establishment. This Jabber ID will usually be the standard concatentation of the local-part (Username), domain-part (Domain), and resource-part (Resource) as defined in [Section 2.1/RFC6120] (local-part@domain-part/resource-part), but since the Jabber ID is owned by the first-hop XMPP Server there are cases where the value will be different. - 2.7
Status string R

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

  • Enabled
  • Disabled
  • Unknown
  • Dormant
  • Connecting
  • ServerNotPresent
  • Error_Misconfigured
  • Error_AuthenticationFailure
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Disabled or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; 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 Enabled if still operable when the expected actions have completed); it SHOULD change to Unknown if the state of the interface can not be determined for some reason.
 - 2.7
LastChangeDate dateTime R The date and time at which this Connection entered into its current operational state. - 2.7
ServerConnectAlgorithm string W The value MUST be a member of the list reported by the SupportedServerConnectAlgorithms parameter. The algorithm the Connection uses when connecting with the associated lists of servers. DNS-SRV 2.7
KeepAliveInterval long(-1:) W The number of seconds that keep alive events as specified in [Section 4.6.1/RFC6120] are sent by this Connection. A value of 0 disables the keep alive functionality. A value of -1 indicates that the keep alive interval is a vendor specific implementation. [Section 4.6.4/RFC6120] recommends not checking more frequently than every 5 minutes (or 300 seconds). -1 2.7
ServerConnectAttempts unsignedInt W The number of times that this Connection attempts to connect to a given IP address before moving on to the current server’s next IP address, or to the next server if the current server has no more IP addresses. If ServerConnectAttempts, ServerRetryInitialInterval, ServerRetryIntervalMultiplier and ServerRetryMaxInterval all have their default values, the maximum reconnection wait intervals, in minutes, will be {1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, 512, 512, 512, 512}. After the initial attempt there are 15 further attempts, making a total of 16. The maximum reconnection wait interval is reached on the 10th retry, i.e. the 11th attempt. NOTE: If this Connection fails to connect to any of the servers’ IP addresses, fallback behavior SHOULD be as specified in [Section 3.2/RFC6120]. NOTE: If the value of this parameter is 0, server connection and reconnection behavior is implementation-dependent. 16 2.7
ServerRetryInitialInterval unsignedInt(1:65535) W The maximum first reconnection wait interval, in seconds, as specified in [Annex K XMPP Connection Request/TR-069a5]. The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval. NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 60 2.7
ServerRetryIntervalMultiplier unsignedInt(1000:65535) W The reconnection interval multiplier as specified in [Annex K XMPP Connection Request/TR-069a5]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1). NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 2000 2.7
ServerRetryMaxInterval unsignedInt(1:) W The maximum reconnection wait interval, in seconds. If the nth reconnection wait interval calculated from ServerRetryInitialInterval and ServerRetryIntervalMultiplier exceeds the value of this parameter, then the Device MUST use the value of this parameter as the next reconnection wait interval. NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored. 30720 2.7
UseTLS boolean W This parameter allows an ACS to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS “mandatory-to-negotiate”. If the value of UseTLS is true then the CPE will initiate TLS negotiation if not required to by the XMPP Server. If the value of UseTLS is false then the CPE will not initiate TLS negotiation if not required to by the XMPP Server. false 2.7
TLSEstablished boolean R This parameter represents the TLS state of this XMPP Connection. If this XMPP Connection is established and is secured by TLS then the value of this parameter is true. If this XMPP Connection is either not established or established but not secured by TLS then the value of this parameter is false. - 2.7
ServerNumberOfEntries unsignedInt R The number of entries in the Server table. - 2.7
Device.XMPP.Connection.{i}.Server.{i}. object(0:) W

The Server represents an XMPP server to be used for a Connection. This table is only relevant when Connection.{i}.ServerConnectAlgorithm is set to ServerTable. If Connection.{i}.ServerConnectAlgorithm is set to DNS-SRV then any instances of this table are ignored by this Connection.

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

 - 2.7
Enable boolean W Enables or disables this Server. This parameter is based on ifAdminStatus from [RFC2863]. false 2.7
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.7
Priority unsignedInt(0:65535) W The priority of this Server that is used by the Connection when determining the Server to connect. The Connection MUST contact the Server with the lowest-numbered priority that the Connection can reach as defined in [RFC2782]. The selection of Servers with the same Priority value utilizes the Weight parameter to determine which Server is selected by the Connection. - 2.7
Weight long(-1:65535) W This parameter specifies a relative weight for entries with the same Priority. The mechanism is defined in [RFC2782]. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. - 2.7
ServerAddress string(:256) W Fully Qualified Domain Name (FQDN) or IP address of the XMPP server for this Connection. If the value of this Parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attemtped (in an implemnetation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on Priority and Weight) SHOULD be used. - 2.7
Port unsignedInt(0:65535) W Port number of the XMPP server for this Connection. 5222 2.7
Device.XMPP.Connection.{i}.Stats. object R XMPP Connection statistics information for this resource. - 2.7
ReceivedMessages unsignedInt R The number of XMPP stanzas (iq, presence, or message) that have been received on this Connection. 0 2.7
TransmittedMessages unsignedInt R The number of XMPP stanzas (iq, presence, or message) that have been transmitted by this Connection. 0 2.7
ReceivedErrorMessages unsignedInt R The number of XMPP stanzas (iq, presence, or message) that have been received on this Connection where the type attribute had a value of “error”. 0 2.7
TransmittedErrorMessages unsignedInt R The number of XMPP stanzas (iq, presence, or message) that have been transmitted by this Connection where the type attribute had a value of “error”. 0 2.7
Device.IEEE1905. object R This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. - 2.9
Version string R

1905 profile version number of the AL as would be sent in a Higher Layer response message as defined in [Table 6-37: 1905 profile version TLV/IEEE1905.1a].

Enumeration of:

  • 1905.1
  • 1905.1a
 - 2.9
Device.IEEE1905.AL. object R This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. - 2.9
IEEE1905Id string(:17) R [MACAddress] 1905 AL MAC Address. - 2.9
Status string R

The current operational state of the 1905 Abstraction Layer. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Up (NOT RECOMMENDED for use; if used it means Enabled)
  • Down (NOT RECOMMENDED for use; if used it means Disabled)
  • Unknown (NOT RECOMMENDED for use; if used it means Error)
  • Dormant (NOT RECOMMENDED for use; if used it means Error)
  • NotPresent (NOT RECOMMENDED for use; if used it means Error)
  • LowerLayerDown (NOT RECOMMENDED for use; if used it means Error)
  • 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.
 - 2.9
LastChange unsignedInt R

This parameter is NOT RECOMMENDED to be used because IEEE1905 is not an interface. The accumulated time in seconds since the 1905 Abstraction Layer entered its current operational state.

Active Notification requests for this parameter MAY be denied.

 - 2.9
LowerLayers string[](:1024) R This parameter is NOT RECOMMENDED to be used because IEEE1905 is not an interface. Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the AL.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.9
RegistrarFreqBand string[](:1024) R

Comma-separated list (maximum number of characters 1024) of strings. See [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a]. Each list item is an enumeration of:

  • 802.11 2.4 GHz
  • 802.11 5 GHz
  • 802.11 60 GHz
 - 2.9
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.9
Device.IEEE1905.AL.Interface.{i}. object(0:) R

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

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

 - 2.9
InterfaceId string(:17) R [MACAddress] MAC Address of this interface. This is the value of the intfAddress parameter defined in [Table 5-2: intfDescriptor elements/IEEE1905.1a] - 2.9
Status string R

This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) It SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD normally be Down when the interface cannot 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.9
LastChange unsignedInt R

This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. The accumulated time in seconds since the interface entered its current operational state.

Active Notification requests for this parameter MAY be denied.

 - 2.9
LowerLayers string[](:1024) R This parameter is NOT RECOMMENDED to be used because it is not a parameter defined in a 1905 ALME primitive or protocol TLV. 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.9
InterfaceStackReference string(:256) R

Path name of an interface object described by this 1905 Interface. Referenced interface object MUST have a MACAddress and the InterfaceId MUST be the same as the interface object MACAddress.

Active Notification requests for this parameter MAY be denied.

 - 2.9
MediaType string R

Media type of this Interface. This is derived from the value of the intfType parameter defined in [Tables 5.2: intfDescriptor elements/IEEE1905.1a]. Enumeration of:

  • IEEE 802.3u (IEEE 802.3u Fast Ethernet)
  • IEEE 802.3ab (IEEE 802.3ab Gigabit Ethernet)
  • IEEE 802.11b (IEEE 802.11b (2.4GHz))
  • IEEE 802.11g (IEEE 802.11g (2.4GHz))
  • IEEE 802.11a (IEEE 802.11a (5GHz))
  • IEEE 802.11n 2.4 (IEEE 802.11n (2.4GHz))
  • IEEE 802.11n 5.0 (IEEE 802.11n (5GHz))
  • IEEE 802.11ac (IEEE 802.11ac (5GHz))
  • IEEE 802.11ad (IEEE 802.11ad (60GHz))
  • IEEE 802.11af (IEEE 802.11af)
  • IEEE 1901 Wavelet (IEEE 1901 Wavelet)
  • IEEE 1901 FFT (IEEE 1901 FFT)
  • MoCAv1.1 (MoCAv1.1)
  • Generic PHY
 - 2.9
GenericPhyOUI string(6) R

OUI of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a].

Possible patterns:

  • [0-9A-F]{6}
 - 2.9
GenericPhyVariant hexBinary(1) R Variant Index of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. - 2.9
GenericPhyURL string(:1024) R URL to Generic Phy XML Description of the Generic Phy networking technology of the local interface that would be included in a Generic Phy Device Information Type TLV defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
SetIntfPowerStateEnabled boolean W Enables or disables the Abstraction Layer’s ability to set the power state for the interface. Boolean can be true for “enabled” and false for “disabled”. - 2.9
PowerState string W

The Power State of this Interface. This is derived from the value of the powerState parameter as defined in [Tables 5.3: ALME-SET-INTF-PWR-STATE.request parameters and Table 5.7: ALME-GET-INTF-PWR-STATE.response parameters/IEEE1905.1a]. Enumeration of:

  • On
  • Power_Save (not used when written)
  • Off
  • Unsupported (not used when written)
 - 2.9
VendorPropertiesNumberOfEntries unsignedInt R The number of entries in the VendorProperties table. - 2.9
LinkNumberOfEntries unsignedInt R The number of entries in the Link table. - 2.9
Device.IEEE1905.AL.Interface.{i}.VendorProperties.{i}. object(0:) R This object defines the vendor specific properties (vendorSpecificInfo field) of this Interface as defined in [Table 5-2: intfDescriptor elements/IEEE1905.1a]. - 2.9
OUI string(6) R

Organizationally unique identifier of a manufacturer of this Interface. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros according to [Table 5-20: VendorSpecificInfo information element/IEEE1905.1a]. Possible patterns:

  • [0-9A-F]{6}
 - 2.9
Information hexBinary(:65535) R A hexbinary string used to to provide vendor specific information about this Interface. This is the value of the vendorSpecificInfo parameter defined in [Table 5-20: VendorSpecificInfo information element/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.Interface.{i}.Link.{i}. object(0:) R

This object defines the 1905 neighbors and link properties.

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

 - 2.9
InterfaceId string(:17) R [MACAddress] MAC Address of the interface of the Neighbor for this Link. This value comes from the neighbor’s Topology discovery message as defined in [Table 6-9: MAC address typeTLV/IEEE1905.1a]. - 2.9
IEEE1905Id string(:17) R [MACAddress] MAC Address of the 1905 AL entity of the Neighbor device on this Link. This value comes from the neighbor’s Topology discovery message as defined in [Table 6-8: AL MAC address type TLV/IEEE1905.1a]. - 2.9
MediaType string R

Media type of this Link. This value is derived from the neighbor’s Topology response message 1905 device information type TLV Media Type field as defined in [Table 6-12: Media type/IEEE1905.1a]. Enumeration of:

  • IEEE 802.3u (IEEE 802.3u Fast Ethernet)
  • IEEE 802.3ab (IEEE 802.3ab Gigabit Ethernet)
  • IEEE 802.11b (IEEE 802.11b (2.4GHz))
  • IEEE 802.11g (IEEE 802.11g (2.4GHz))
  • IEEE 802.11a (IEEE 802.11a (5GHz))
  • IEEE 802.11n 2.4 (IEEE 802.11n (2.4GHz))
  • IEEE 802.11n 5.0 (IEEE 802.11n (5GHz))
  • IEEE 802.11ac (IEEE 802.11ac (5GHz))
  • IEEE 802.11ad (IEEE 802.11ad (60GHz))
  • IEEE 802.11af (IEEE 802.11af)
  • IEEE 1901 Wavelet (IEEE 1901 Wavelet)
  • IEEE 1901 FFT (IEEE 1901 FFT)
  • MoCAv1.1 (MoCAv1.1)
  • Generic PHY
 - 2.9
GenericPhyOUI string(6) R

OUI of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message field as defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a].

Possible patterns:

  • [0-9A-F]{6}
 - 2.9
GenericPhyVariant hexBinary(1) R Variant Index of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message variant index field as defined in [Tables 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. - 2.9
GenericPhyURL string(:1024) R URL to Generic Phy XML Description of the Generic Phy networking technology of the interface of the Neighbor for this Link. This value is from a Generic Phy response message URL to Generic Phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.Interface.{i}.Link.{i}.Metric. object R This object represents the metrics for this Link as defined in [Tables 6-18: 1905 transmitter link metrics and Table 6-20: 1905 receiver link metrics/IEEE1905.1a]. - 2.9
IEEE802dot1Bridge boolean R Indicates whether or not the 1905 link includes one or more IEEE 802.1 bridges. If false, the 1905 link does not include an IEEE 802.1 bridge. If true, the 1905 link does include one or more IEEE 802.1 bridges. - 2.9
PacketErrors unsignedInt R

[StatsCounter32] Estimated number of lost Packets on the transmit side of the link [Table 6-18: 1905 transmitter link metrics/IEEE1905.1a] during a measurement period.

Active Notification requests for this parameter MAY be denied.

 - 2.9
PacketErrorsReceived unsignedInt R

[StatsCounter32] Estimated number of lost Packets on the receive side of the link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] during a measurement period.

Active Notification requests for this parameter MAY be denied.

 - 2.9
TransmittedPackets unsignedInt R

[StatsCounter32] Estimated number of Packets sent to the Neighbor on this Link, in the same measurement period used to estimate PacketErrors.

Active Notification requests for this parameter MAY be denied.

 - 2.9
PacketsReceived unsignedInt R

[StatsCounter32] Estimated number of Packets received from this Neighbor on this Link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a], in the same measurement period used to estimate PacketErrors.

Active Notification requests for this parameter MAY be denied.

 - 2.9
MACThroughputCapacity unsignedInt R

The maximum MAC throughput in Mb/s between this Interface and the Neighbor on this Link that is estimated at this Interface.

Active Notification requests for this parameter MAY be denied.

 - 2.9
LinkAvailability unsignedInt(0:100) R

The estimated average percent of time that the Link is available for data transmissions.

Active Notification requests for this parameter MAY be denied.

 - 2.9
PHYRate unsignedInt R

The Physical Layer (PHY) rate in Mb/s between this Interface and the Neighbor on this Link that is estimated at this Interface.

Active Notification requests for this parameter MAY be denied.

 - 2.9
RSSI unsignedInt(0:255) R

The estimated Received Signal Strength Indicator (RSSI) ratio in dB between this Interface and the Neighbor on this Link that is estimated at the receive side of this Interface.

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IEEE1905.AL.ForwardingTable. object R This object represents the rules to forward PDUs between interfaces within the 1905 Abstraction Layer. - 2.9
SetForwardingEnabled boolean W Abstraction Layer ability to set, modify, and remove ForwardingRule entries for interfaces. Boolean can be true for “enabled” and false for “disabled”. - 2.9
ForwardingRuleNumberOfEntries unsignedInt R The number of entries in the ForwardingRule table. - 2.9
Device.IEEE1905.AL.ForwardingTable.ForwardingRule.{i}. object(0:) W The 1905 fowarding rule for the ALME-SET-FWD-RULE.request and ALME-GET-FWD-RULES.response with classification criteria as defined in [Table 5-9: ClassificationSet elements/IEEE1905.1a]. - 2.9
InterfaceList string(:256)[] W The list of interfaces to which a frame satisfying the following classification criteria should be forwarded (intfAddressList parameter as defined in [Table 5-8: ALME-SET-FWD-RULE.request parameters and Table 5-12: fwdRuleList elements/IEEE1905.1a]). Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the path name of an object, which MUST be a row of an Interface object. If the referenced item is deleted, the corresponding item MUST be removed from the list. <Empty> 2.9
MACDestinationAddress string(:17) W [MACAddress] Classification criterion. The destination MAC address. - 2.9
MACDestinationAddressFlag boolean W If false, the classification criterion MACDestinationAddress is ignored. If true, the classification criterion MACDestinationAddress is used. false 2.9
MACSourceAddress string(:17) W [MACAddress] Classification criterion. The source MAC address. - 2.9
MACSourceAddressFlag boolean W If false, the classification criterion MACSourceAddress is ignored. If true, the classification criterion MACSourceAddress is used. false 2.9
EtherType unsignedInt W Classification criterion. Ether Type Field in a frame. - 2.9
EtherTypeFlag boolean W If false, the classification criterion EtherType is ignored. If true, the classification EtherType is used. false 2.9
Vid unsignedInt(0:4095) W Classification criterion. IEEE 802.1Q VLAN ID in a frame. - 2.9
VidFlag boolean W If false, the classification criterion Vid is ignored. If true, the classification Vid is used. false 2.9
PCP unsignedInt(0:7) W Classification criterion. IEEE 802.1Q Priority Code Point field. - 2.9
PCPFlag boolean W If false, the classification criterion PCP is ignored. If true, the classification PCP is used. false 2.9
Device.IEEE1905.AL.NetworkTopology. object R This object represents the 1905 Network Topology capabilities of this device. - 2.9
Enable boolean W Enables or disables the 1905 Network Topology reporting (via TR-069). When true, the device clears and (re)populates the IEEE1905Device and ChangeLog tables. When false, the contents of the IEEE1905Device and ChangeLog tables have no meaning. - 2.9
Status string R

When Enable is set to true, this parameter indicates the transient phase of the discovery of the NetworkTopology. Enumeration of:

  • Incomplete (Indicates that the device is populating the topology object during the transient phase)
  • Available (Indicates that the transient phase is over and the device is maintaining and updating the topology object as changes occur)
  • Error_Misconfigured (NOT RECOMMENDED for use; if used, indicates that a necessary configuration value is undefined or invalid)
 - 2.9
MaxChangeLogEntries unsignedInt(1:) W The maximum number of entries allowed in the ChangeLog table. - 2.9
LastChange string(:256) R The value MUST be the Path Name of a row in the ChangeLog. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the ChangeLog is modified the parameter is modified to reflect the last entry added to the ChangeLog. - 2.9
IEEE1905DeviceNumberOfEntries unsignedInt R The number of entries in the IEEE1905Device table. - 2.9
ChangeLogNumberOfEntries unsignedInt R The number of entries in the ChangeLog table. - 2.9
Device.IEEE1905.AL.NetworkTopology.ChangeLog.{i}. object(0:) R This object represents log entries for changes in the 1905 Network Topology. The Change Log is a First In First Out queue where the oldest entries (defined by values of the TimeStamp parameter) are deleted once the log is full. - 2.9
TimeStamp dateTime R Date and Time at which the entry was added to the ChangeLog table. - 2.9
EventType string R

Type of event for this entry. Enumeration of:

  • NewNeighbor (Entry represents a discovery of a Neighbor)
  • LostNeighbor (Entry represents the loss of a Neighbor)
 - 2.9
ReporterDeviceId string(:17) R [MACAddress] 1905 AL MAC Address of device which reported the change. - 2.9
ReporterInterfaceId string(:17) R [MACAddress] MAC Address of the interface of the reporting device on which the change has been detected. - 2.9
NeighborType string R

Type of Neighbor for this event. Enumeration of:

  • IEEE1905
  • Non-IEEE1905
 - 2.9
NeighborId string(:17) R [MACAddress] MAC Address of the Neighbor of this event. If the value of the EventType parameter is NewNeighbor, then the value of this parameter represents the MAC Address of the new Neighbor that joined the network; if the value of the EventType parameter is LostNeighbor, then the value of this parameter represents the MAC Address of the Neighbor that left the network. If value of the NeighborType parameter is IEEE1905, then the value of this parameter is the 1905 AL MAC Address of the Neighbor. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. object(0:) R

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

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

 - 2.9
IEEE1905Id string(:17) R [MACAddress] 1905 AL MAC Address. - 2.9
Version string R

1905 profile version number in Higher Layer Response message as defined in [Table 6-37: 1905 profile version TLV/IEEE1905.1a].

Enumeration of:

  • 1905.1
  • 1905.1a
 - 2.9
RegistrarFreqBand string[](:1024) R

Comma-separated list (maximum number of characters 1024) of strings. of frequency bands identified as supported for a registrar role in an AP-autoconfiguration response message as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] Each list item is an enumeration of:

  • 802.11 2.4 GHz
  • 802.11 5 GHz
  • 802.11 60 GHz .
 - 2.9
FriendlyName string(:128) R Friendly Name String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. - 2.9
ManufacturerName string(:128) R Manufacturer Name String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. - 2.9
ManufacturerModel string(:128) R Manufacturer Model String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. - 2.9
ControlURL string(:1024) R Control URL received in Higher Layer response message as defined in defined in [Table 6-31: Control URL Type TLV/IEEE1905.1a]. - 2.9
VendorPropertiesNumberOfEntries unsignedInt R The number of entries in the VendorProperties table. - 2.9
IPv4AddressNumberOfEntries unsignedInt R The number of entries in the IPv4Address table. - 2.9
IPv6AddressNumberOfEntries unsignedInt R The number of entries in the IPv6Address table. - 2.9
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.9
NonIEEE1905NeighborNumberOfEntries unsignedInt R The number of entries in the NonIEEE1905Neighbor table. - 2.9
IEEE1905NeighborNumberOfEntries unsignedInt R The number of entries in the IEEE1905Neighbor table. - 2.9
L2NeighborNumberOfEntries unsignedInt R The number of entries in the L2Neighbor table. - 2.9
BridgingTupleNumberOfEntries unsignedInt R The number of entries in the BridgingTuple table. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv4Address.{i}. object(0:) R

This object represents represents all IPv4 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-32: IPv4 type TLV/IEEE1905.1a].

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

 - 2.9
MACAddress string(:17) R [MACAddress] MAC Address. - 2.9
IPv4Address string(:45) R [IPv4Address] IPv4 Address. - 2.9
IPv4AddressType string R

The IPv4 Address Type of this IPv4Address. Enumeration of:

  • Unknown
  • DHCP
  • Static
  • Auto-IP
 - 2.9
DHCPServer string(:45) R [IPAddress] Either IPv4 address of DHCPv4 server or IPv6 address of DHCPv6 server. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv6Address.{i}. object(0:) R

This object represents represents all IPv6 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-34: IPv6 type TLV/IEEE1905.1a].

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

 - 2.9
MACAddress string(:17) R [MACAddress] MAC Address. - 2.9
IPv6Address string(:45) R [IPv6Address] IPv6 Address. - 2.9
IPv6AddressType string R

The IPv6 Address Type of this IPv6Address. Enumeration of:

  • Unknown
  • LinkLocal
  • DHCP
  • Static
  • SLAAC
 - 2.9
IPv6AddressOrigin string(:45) R [IPv6Address] “::” or the IPv6 address of the origin of this IPv6 address. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.VendorProperties.{i}. object(0:) R This object represents vendor specific information received in a message with a Vendor specific TLV (as defined in in [Table 6-7: Vendor specific TLV/IEEE1905.1a]). - 2.9
MessageType hexBinary(1) R The Message type of a message received from this IEEE1905Device that contained a Vendor specific TLV, as defined in [Table 6-4: Message type/IEEE1905.1a]. - 2.9
OUI string(6) R

This is the value of the Vendor specific OUI defined in [Table 6-7: Vendor specific TLV/IEEE1905.1a]. Possible patterns:

  • [0-9A-F]{6}
 - 2.9
Information hexBinary(0:65535) R A hexbinary string used to provide vendor specific information. This is the value of the Vendor specific information parameter defined in [Table 6-7: Vendor specific TLV/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.Interface.{i}. object(0:) R

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

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

 - 2.9
InterfaceId string(:17) R [MACAddress] MAC Address of the interface. This comes from the Topology response message as defined in [Table 6-10: 1905 device information type TLV/IEEE1905.1a]. - 2.9
MediaType string R

Media type of this Interface. This comes from the Topology response message as defined in [Table 6-10: 1905 device information type TLV/IEEE1905.1a]. Enumeration of:

  • IEEE 802.3u (IEEE 802.3u Fast Ethernet)
  • IEEE 802.3ab (IEEE 802.3ab Gigabit Ethernet)
  • IEEE 802.11b (IEEE 802.11b (2.4GHz))
  • IEEE 802.11g (IEEE 802.11g (2.4GHz))
  • IEEE 802.11a (IEEE 802.11a (5GHz))
  • IEEE 802.11n 2.4 (IEEE 802.11n (2.4GHz))
  • IEEE 802.11n 5.0 (IEEE 802.11n (5GHz))
  • IEEE 802.11ac (IEEE 802.11ac (5GHz))
  • IEEE 802.11ad (IEEE 802.11ad (60GHz))
  • IEEE 802.11af (IEEE 802.11af)
  • IEEE 1901 Wavelet (IEEE 1901 Wavelet)
  • IEEE 1901 FFT (IEEE 1901 FFT)
  • MoCAv1.1 (MoCAv1.1)
  • Generic PHY
 - 2.9
PowerState string R

The Power State of this Interface. “Off” is used for interfaces identified in a Power Off Interface TLV as defined in [Table 6-38/IEEE1905.1a]. “On” is used for all other interfaces. “Power_Save” and “Unsupported” are not used at this time. Updated as a result of a received Interface Power Change response with “request completed” or “alternate change made” Interface Power Change status as defined in [Table 6-40: Interface Power Change status TLV/IEEE1905.1a]. Enumeration of:

  • On
  • Power_Save
  • Off
  • Unsupported
 - 2.9
GenericPhyOUI string(6) R

GenericPhyOUI of this Interface. Possible patterns:

  • [0-9A-F]{6}
 - 2.9
GenericPhyVariant hexBinary(1) R Variant Index of the Generic Phy networking technology of this Interface. This value is from a Generic Phy response message variant index field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
GenericPhyURL string(:1024) R URL to Generic Phy XML Description of the Generic Phy networking technology of this Interface. This value is from a Generic Phy response message URL to generic phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. - 2.9
NetworkMembership string(:17) R [MACAddress] MACAddress Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a]. - 2.9
Role string R

Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a]. Enumeration of:

  • AP
  • non-AP/non-PCP STA
  • Wi-Fi P2P Client
  • Wi-Fi P2P Group Owner
  • 802.11adPCP
 - 2.9
APChannelBand hexBinary(1) R Hexadecimal digit. Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] - 2.9
FrequencyIndex1 hexBinary(1) R Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] - 2.9
FrequencyIndex2 hexBinary(1) R Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.NonIEEE1905Neighbor.{i}. object(0:) R

This object represents an instance of a Non-IEEE1905 Neighbor for the IEEE1905Device. These fields come from a Topology response message as defined in [Table 6-14: Non-1905 neighbor device TLV/IEEE1905.1a].

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

 - 2.9
LocalInterface string(:256) R The value MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.9
NeighborInterfaceId string(:17) R [MACAddress] MAC Address of the interface for the NonIEEE1905Neighbor. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.L2Neighbor.{i}. object(0:) R

This object represents an instance of an L2 Neighbor for the IEEE1905Device. These fields come from a Topology response message as defined in [Table 6-41: L2 neighbor device TLV/IEEE1905.1a].

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

 - 2.9
LocalInterface string(:256) R The value MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.9
NeighborInterfaceId string(:17) R [MACAddress] MAC Address of the L2Neighbor. - 2.9
BehindInterfaceIds string(:17)[](:1024) R [MACAddress] Comma-separated list (maximum number of characters 1024) of MAC Addresses. Behind MAC Addresses of the L2Neighbor. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. object(0:) R

This object represents an instance of an IEEE1905Neighbor for the IEEE1905Device. These values are from the Topology response message as defined in [Table 6-15: 1905 neighbor device TLV/IEEE1905.1a].

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

 - 2.9
LocalInterface string(:256) R The value MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.9
NeighborDeviceId string(:17) R [MACAddress] 1905 AL MAC Address of the Neighbor. - 2.9
MetricNumberOfEntries unsignedInt R The number of entries in the Metric table. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}.Metric.{i}. object(0:) R

This object represents the metrics included in a Link metric response from the IEEE1905Device where LocalInterface is the MAC address of an interface in the receiving 1905 AL as defined in [Table 6-17: 1905 transmitter link metric TLV/IEEE1905.1a].

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

 - 2.9
NeighborMACAddress string(:17) R [MACAddress] The MAC address of an interface in a neighbor 1905 device as defined in [Table 6-17: 1905 transmitter link metric TLV or Table 6-19: 1905 receiver link metric TLV/IEEE1905.1a]. - 2.9
IEEE802dot1Bridge boolean R Indicates whether or not the 1905 link includes one or more IEEE 802.1 bridges. If false, the 1905 link does not include an IEEE 802.1 bridge. If true, the 1905 link does include one or more IEEE 802.1 bridges. - 2.9
PacketErrors unsignedInt R [StatsCounter32] Estimated number of lost Packets on the transmit side of the link [Table 6-18: 1905 transmitter link metrics/IEEE1905.1a] during a measurement period. - 2.9
PacketErrorsReceived unsignedInt R [StatsCounter32] Estimated number of lost Packets on the receive side of the link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] during a measurement period. - 2.9
TransmittedPackets unsignedInt R [StatsCounter32] Estimated number of Packets sent to the Neighbor on this link, in the same measurement period used to estimate PacketErrors. - 2.9
PacketsReceived unsignedInt R [StatsCounter32] Estimated number of Packets received from this Neighbor [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] on this link, in the same measurement period used to estimate PacketErrors. - 2.9
MACThroughputCapacity unsignedInt R The maximum MAC throughput in Mb/s between this Interface and the Neighbor on this link that is estimated at this Interface. - 2.9
LinkAvailability unsignedInt(0:100) R The estimated average percent of time that this link is idle. - 2.9
PHYRate unsignedInt R The Physical Layer (PHY) rate in Mb/s between this Interface and the Neighbor on this link that is estimated at this Interface. - 2.9
RSSI unsignedInt(0:255) R The estimated Received Signal Strength Indicator (RSSI) ratio in dB between this Interface and the Neighbor on this link that is estimated at the receive side of this Interface. Note: This parameter is valid only for IEEE 802.11 Neighbors. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.BridgingTuple.{i}. object(0:) R This object represents an instance of an BridgingTuple for the IEEE1905Device. These values come from the 1905 Device’s Topology response message as defined in [Table 6-11: Device bridging capability TLV/IEEE1905.1a]. - 2.9
InterfaceList string(:256)[] R 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 IEEE1905Device.{i}.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.9
Device.IEEE1905.AL.Security. object R This object represents the Security configuration for the 1905 device as defined in [Section 9.2 Security Setup Methods/IEEE1905.1a]. - 2.9
SetupMethod string[](:1024) W

Comma-separated list (maximum number of characters 1024) of strings. Supported security setup method(s) for the network. Each list item is an enumeration of:

  • UCPK (User Configured Passphrase or Key)
  • PBC (Push Button Configuration)
  • NFCNK (Near-field Communication Network Key)
 - 2.9
Password string W

1905 network passphrase for generating security keys.

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

 - 2.9
Device.IEEE1905.AL.NetworkingRegistrar. object R This object represents the detected Network Registrars detection function for the IEEE 1905 network. They are determined by received AP-autoconfiguration response messages with Registrar role, with supported band as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] - 2.9
Registrar2dot4 string(:17)[](:1024) R [MACAddress] Comma-separated list (maximum number of characters 1024) of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 2.4 GHz. - 2.9
Registrar5 string(:17)[](:1024) R [MACAddress] Comma-separated list (maximum number of characters 1024) of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 5 GHz. - 2.9
Registrar60 string(:17)[](:1024) R [MACAddress] Comma-separated list (maximum number of characters 1024) of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 60 GHz. - 2.9
Device.MQTT. object R MQTT Base object describing all MQTT related parameters and objects [MQTT31], - 2.10
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.10
BrokerNumberOfEntries unsignedInt R The number of entries in the Broker table. - 2.10
Device.MQTT.Capabilities. object R Indicates the MQTT capabilities of the device. - 2.10
ProtocolVersionsSupported string[] R

Comma-separated list of strings. Indicates the supported protocol versions. Each list item is an enumeration of:

  • 3.1 (Protocol according to [MQTT31])
  • 3.1.1 (Protocol according to [MQTT311])
 - 2.10
TransportProtocolSupported string[] R

Comma-separated list of strings. Indicates the supported transport protocols. Each list item is an enumeration of:

  • TCP/IP
  • TLS
  • WebSocket
 - 2.10
MaxNumberOfClientSubscriptions unsignedInt R Indicates the maximum number of subscriptions per MQTT client, which can be stored in the Client.{i}.Subscription table. A value of 0 means no limit. - 2.10
MaxNumberOfBrokerBridges unsignedInt R Indicates the maximum number of bridges, which can be configured in the Broker.{i}.Bridge table. A value of 0 means no limit. - 2.10
MaxNumberOfBrokerBridgeSubscriptions unsignedInt R Indicates the maximum number of subscriptions, which can be stored per bridge instance in the Broker.{i}.Bridge.{i}.Subscription table. A value of 0 means no limit. - 2.10
Device.MQTT.Client.{i}. object(0:) W

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

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

 - 2.10
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.10
Name string(:64) W

The textual name of the MQTT client.

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

 - 2.10
Enable boolean W Allows to enable or disable the MQTT client. If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the Subscription. table. In case the CleanSession is set to false a subscription MUST only be sent for topics which haven’t been subscribed before (see [Section 3.1.2.4/MQTT311]). If a connected MQTT client gets disabled (Status is either Connecting or Connected) then the MQTT client has to send a MQTT DISCONNECT message to disconnect from the MQTT broker ([Section 3.14/MQTT31] or [Section 3.14/MQTT311]), before setting the Status to Disabled. - 2.10
Status string R

Indicates the status of this MQTT client. Enumeration of:

  • Disabled
  • Connecting
  • Connected
  • Error_Misconfigured
  • Error_BrokerUnreachable
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid (e.g. The MQTT client can not use the defined port, because it is blocked) The Error_BrokerUnreachable value indicates that the connection to the MQTT broker could not be established. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 - 2.10
ClientID string(1:23) W The MQTT client identifier used in the CONNECT message (see [Section 3.1/MQTT31] and [Section 3.1.3.1/MQTT311]). This parameter MUST NOT be an empty string, the CPE has to provide a default value for the parameter, which can be changed by the ACS. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. - 2.10
Username string(:256) W Username used to authenticate the CPE when making a connection to the MQTT broker. [Section 3.1/MQTT31] recommends that the username has 12 characters or fewer, but this is not required. If this parameter is an empty string no authentication parameters are sent in the MQTT CONNECT message. - 2.10
Password string(:256) W

Password used to authenticate the CPE when making a connection to the MQTT broker (see [Section 3.1/MQTT31] and [Section 3.1.3.4/MQTT311]). This password is only sent in the MQTT CONNECT message if Username is not an empty string.

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

 - 2.10
TransportProtocol string W The value MUST be a member of the list reported by the Capabilities.TransportProtocolSupported parameter. Indicates the transport protocol to be used for the MQTT broker connection. TCP/IP 2.10
ProtocolVersion string W The value MUST be a member of the list reported by the Capabilities.ProtocolVersionsSupported parameter. Specifies the MQTT protocol version used in the communication with the MQTT broker. - 2.10
CleanSession boolean W The value of the MQTT clean session flag in the MQTT CONNECT message (see [Section 3.1/MQTT31] and [Section 3.1.2.4/MQTT311]). If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. true 2.10
MessageRetryTime unsignedInt(1:) W Message retry time in seconds defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see [Section 4.2/MQTT31] and [Section 4.4/MQTT311]). 5 2.10
ConnectRetryTime unsignedInt(1:) W Connect retry time in seconds defines the wait time before a failed MQTT broker connection is retried. A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent. 30 2.10
KeepAliveTime unsignedInt(:65535) W Keep Alive Time in seconds defines the maximum wait time after which a message has to be sent to the MQTT broker (see [Section 3.1/MQTT31] and [Section 3.1.2.10/MQTT311]). If no regular messages can be sent a MQTT PINGREQ is sent. A value of zero (0) means no keep alive message are sent and the MQTT client is not disconnected by the server. A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. 60 2.10
ForceReconnect boolean W Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter Status is Connected). If the MQTT client is in a different state, the parameter has no effect. This action parameter may be used to immediately apply changes in the MQTT connection settings. - 2.10
BrokerAddress string(:256) W Host name or IP address of the MQTT Broker. - 2.10
BrokerPort unsignedInt(1:65535) W Port number of the MQTT broker. 1883 2.10
WillEnable boolean W Enables or disables the will handling (see [Section 3.1/MQTT31] and [Section 3.1.2.5/MQTT311]).. Changing this parameter while the MQTT client is connected will cause the client to disconnect and reconnect. If the connection gets enabled and this parameter is set to true and either the parameter WillTopic or WillValue are an empty string, the CPE MUST set the Status to Error_Misconfigured (see [Section 3.1.2.5/MQTT311]). - 2.10
WillTopic string W The Topic sent in the Will Message (see [Section 3.1/MQTT31] and [Section 3.1.2.5/MQTT311]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. - 2.10
WillValue string W The value sent in the Will Message (see [Section 3.1/MQTT31] and [Section 3.1.2.5/MQTT311]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. - 2.10
WillQoS unsignedInt(0:2) W The MQTT QoS level assigned with the will message (see [Section 3.1/MQTT31] and [Section 3.1.2.6/MQTT311]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. - 2.10
WillRetain boolean W Indicate to the MQTT broker to retain the Will over a Disconnect (see [Section 3.1/MQTT31] and [Section 3.1.2.7/MQTT311]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. - 2.10
SubscriptionNumberOfEntries unsignedInt R The number of entries in the Subscription table. - 2.10
Device.MQTT.Client.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled by the MQTT client. The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter Enable is set to true, when it establishes a new connection to the MQTT broker. Disabled subscription instances with Enable set to false will be ignored during connection establishment.

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

 - 2.10
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.10
Enable boolean W Setting Enable to true means the topic is subscribed at the MQTT broker with a MQTT SUBSCRIBE message, setting it to false will unsubscribe the topic from the MQTT broker with a MQTT UNSUBSCRIBE message. If the MQTT client is already connected with the Broker (Status is Connected), the MQTT SUBSCRIBE or UNSUBSCRIBE message is sent directly, otherwise it is sent after the next successful connect. The actual status of the subscription is indicated with Status. - 2.10
Status string R

Indicates the status of this subscription. Enumeration of:

  • Unsubscribed
  • Subscribed
  • Subscribing (OPTIONAL)
  • Unsubscribing (OPTIONAL)
  • Error The Subscribed value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server. The Subscribing value MAY be used by the CPE to indicate that the a SUBSCRIBE message for this topic was sent, and the CPE is waiting for a SUBACK message. The Unsubscribed value indicates that the topic is not reqistered with the MQTT broker. The Unsubscribing value MAY be used by the CPE to indicate that the an UNSUBSCRIBE message for this topic was sent, and the CPE is waiting for an UNSUBACK message. If the Enable is set to false the status MUST be either Unsubscribed or if the unsubscription failed Error.
 - 2.10
Topic string(:65535) W Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in [Appendix A/MQTT31] and [Section 4.7/MQTT311]. - 2.10
QoS unsignedInt(0:2) W The MQTT QoS level assigned with the subscription (see [Section 4.1/MQTT31] and [Section 4.3/MQTT311]). - 2.10
Device.MQTT.Client.{i}.Stats. object R Contains the MQTT client statistics and usage information. The CPE MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. BrokerAddress has changed). The CPE MAY retain the values across a reboot if it reconnects with the same MQTT broker. - 2.10
BrokerConnectionEstablished dateTime R

Time when the MQTT broker connection was established.

Active Notification requests for this parameter MAY be denied.

 - 2.10
LastPublishMessageSent dateTime R

Time when the last publish message was sent to the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
LastPublishMessageReceived dateTime R

Time when the last publish message was received from the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
PublishSent unsignedLong R

[StatsCounter64] Number of publish messages sent to the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
PublishReceived unsignedLong R

[StatsCounter64] Number of publish messages received from to the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
SubscribeSent unsignedLong R

[StatsCounter64] Number of subscribe messages sent to the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
UnSubscribeSent unsignedLong R

[StatsCounter64] Number of unsubscribe messages sent to the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
MQTTMessagesSent unsignedLong R

[StatsCounter64] Total number of MQTT messages sent to the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
MQTTMessagesReceived unsignedLong R

[StatsCounter64] Total number of MQTT messages received from the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
ConnectionErrors unsignedInt R

[StatsCounter32] Number of connection errors.

Active Notification requests for this parameter MAY be denied.

 - 2.10
PublishErrors unsignedInt R [StatsCounter32] Number of errors which prevented sending publish messages. - 2.10
Device.MQTT.Broker.{i}. object(0:) W

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

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

 - 2.10
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.10
Name string(:64) W

The textual name of the MQTT broker.

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

 - 2.10
Enable boolean W Allows to enable or disable the MQTT broker. - 2.10
Status string R

Indicates the status of the MQTT broker. 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.
 - 2.10
Port unsignedInt(1:65535) W Port used by the MQTT Broker. 1883 2.10
Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If an empty string is specified, the CPE MUST bind the MQTT broker to all available interfaces. - 2.10
Username string(:256) W Username used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is an empty string no authentication is used. - 2.10
Password string(:256) W

Password used used to authenticate the MQTT clients, which connect to the MQTT broker. This password is only used if Username is not an empty string.

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

 - 2.10
BridgeNumberOfEntries unsignedInt R The number of entries in the Bridge table. - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object(0:) W

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

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

 - 2.10
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.10
Name string(:64) W

The textual name of the MQTT bridge used for identification.

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

 - 2.10
Enable boolean W Allows to enable or disable the MQTT Bridge. - 2.10
Status string R

Indicates the status of this MQTT Bridge. Enumeration of:

  • Disabled
  • Connecting
  • Connected
  • Enabled (DELETED)
  • Error_Misconfigured
  • Error_BrokerUnreachable
  • Error (OPTIONAL) The Disabled value indicates that the MQTT bridge is not in service; parameter Enable is set to false. The Connecting value indicates that the MQTT bridge is currently established. The Connected value indicates that the MQTT bridge is currently active. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid (e.g. No active Server entry, the MQTT broker can not use the defined bridge port, because it is blocked) The Error_BrokerUnreachable value indicates that the MQTT bridge connection to the remote MQTT broker could not be established. The Error value MAY be used to indicate a locally defined error condition.
 - 2.10
ClientID string(1:23) W The MQTT client identifier used in the CONNECT message (see [Section 3.1/MQTT31] and [Section 3.1.3.1/MQTT311]). This parameter MUST NOT be an empty string, the CPE has to provide a default value for the parameter, which may be changed by the ACS. A change of this parameter is only communicated to the remote MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. - 2.10
Username string(:256) W Username used to authenticate the MQTT broker when making a connection over the MQTT bridge (see [Section 3.1/MQTT31] and [Section 3.1.3.4/MQTT311]). [Section 3.1/MQTT31] recommends that the username has 12 characters or fewer, but this is not required. If this parameter is an empty string no authentication parameters are sent in the MQTT CONNECT message. - 2.10
Password string(:256) W

Password used to authenticate the MQTT broker when making a connection over the MQTT bridge (see [Section 3.1/MQTT31] and [Section 3.1.3.4/MQTT311]). The password is only sent if Username is not an empty string.

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

 - 2.10
TransportProtocol string W The value MUST be a member of the list reported by the Capabilities.TransportProtocolSupported parameter. Indicates the transport protocol to be used for the MQTT bridge connection. TCP/IP 2.10
ProtocolVersion string W The value MUST be a member of the list reported by the Capabilities.ProtocolVersionsSupported parameter. Specifies the MQTT protocol version used in the MQTT bridge connection. - 2.10
CleanSession boolean W The value of the MQTT clean session flag in the MQTT bridge connection (see [Section 3.1/MQTT31] and [Section 3.1.2.4/MQTT311]). If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect. A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. true 2.10
MessageRetryTime unsignedInt(1:) W Message retry time in seconds defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see [Section 4.2/MQTT31] and [Section 4.4/MQTT311]). 5 2.10
ConnectRetryTime unsignedInt(1:) W Connect retry time in seconds defines the wait time before a failed bridge connection is retried. A failure can either be on the connection level (e.g. the TCP/IP or TLS conection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent. 30 2.10
KeepAliveTime unsignedInt(:65535) W Keep Alive Time in seconds defines the maximum wait time after which a message has to be sent to the remote MQTT broker (see [Section 3.1/MQTT31] and [Section 3.1.2.10/MQTT311]). If no regular messages can be sent a MQTT PINGREQ is sent. A value of zero (0) means no keep alive message are sent and the bridge is not disconnected by the server. A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. 60 2.10
ForceReconnect boolean W Disconnects the MQTT bridge to the remote MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT bridge is currently connected to the remote MQTT broker (Parameter Status is Connected). If the MQTT bridge is in a different state, the parameter has no effect. This action parameter may be used to immediately apply changes in the MQTT connection settings. - 2.10
ServerSelectionAlgorithm string W

The algorithm used to select a server entry from the Server table

Enumeration of:

  • Priority (Select the server from the Server. table according to the sequence defined with the Server.{i}.Priority and Server.{i}.Weight values)
  • RoundRobin (Select the servers round robin)
  • Random (Select the servers randomly)
 - 2.10
ServerConnection string R The value MUST be the Path Name of the Server. instance that is used for this Bridge, while the Status is Connecting or Connected. If the MQTT bridge is not connected the value MUST be an empty string. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.10
ServerNumberOfEntries unsignedInt R The number of entries in the Server table. - 2.10
SubscriptionNumberOfEntries unsignedInt R The number of entries in the Subscription table. - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}.Server.{i}. object(0:) W

Each Server instance represents a MQTT bridge server to be used for a Bridge. A remote MQTT broker, which is connected by a MQTT bridge can be reachable via several host addresses each represented by its own Server table entry. For an active MQTT bridge at least one enabled entry has to exist. If a MQTT bridge gets enabled by setting the parameter Bridge.{i}.Enable to true, which either has an empty Server table or the Server table only contains instances whose Enable is set to false, the Bridge.{i}.Status has to be set to Error_Misconfigured. Any attempt to delete an instance, which is currently in use (Bridge.{i}.ServerConnection refers to the instance to be deleted), has to be rejected.

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

 - 2.10
Enable boolean W Enables or disables this Server. false 2.10
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.10
Priority unsignedInt(0:65535) W The priority of this Server that is used by the Bridge when determining the Server to connect to. The Bridge MUST contact the Server with the lowest-numbered priority that the Bridge can reach as defined in [RFC2782]. The selection of Servers with the same Priority value utilizes the Weight parameter to determine which Server is selected by the Bridge. This value is only used if Bridge.{i}.ServerSelectionAlgorithm is set to Priority. - 2.10
Weight long(-1:65535) W This parameter specifies a relative weight for entries with the same Priority. The mechanism is defined in [RFC2782]. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. This value is only used if Bridge.{i}.ServerSelectionAlgorithm is set to Priority. - 2.10
Address string(:256) W Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this Bridge connects to. If the value of this parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attempted (in an implementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on rules defined over the selected Bridge.{i}.ServerSelectionAlgorithm) SHOULD be used. - 2.10
Port unsignedInt(1:65535) W Port number of the MQTT broker server this Bridge connects to. 1883 2.10
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled over the bridge.

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

 - 2.10
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.10
Enable boolean W Setting Enable to true activates the handling of this subscription instance. In case of incoming directions (Direction is either in or both) the topic is subscribed over the bridge at the remote MQTT broker with a MQTT SUBSCRIBE message if Enable is set to true or unsubscribed from the remote MQTT broker with a MQTT UNSUBSCRIBE message if the value is set to false. The actual status of the subscription is indicated with Status. - 2.10
Status string R

Indicates the status of this subscription. Enumeration of:

  • Enabled
  • Disabled
  • Error The Enabled value indicates that the this subscription is active. In case of incoming directions (Direction is either in or both) the topic was successfully subscribed with the remote MQTT broker. The Disabled value indicates that this subscription is not used. The Error value indicates that an error occured (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use.
 - 2.10
Topic string(:65535) W Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in [Appendix A/MQTT31] and [Section 4.7/MQTT311]. - 2.10
Direction string W

The direction of the subscription. Enumeration of:

  • out (Indicates that all matching topics will be sent over the bridge to the next MQTT broker)
  • in (Indicates that all matching topics will be received over the bridge from the next MQTT broker)
  • both (Indicates that all matching topics will be sent and received over the bridge) .
 - 2.10
QoS unsignedInt(0:2) W The MQTT QoS level assigned with the subscription (see [Section 4.1/MQTT31] and [Section 4.3/MQTT311]). - 2.10
LocalPrefix string W

The local prefix is used for remapping received topics to the local topics of the MQTT broker and to select the topics to be sent over bridge to the remote MQTT broker.

For remote topics received over the bridge the MQTT broker adds the LocalPrefix in front of the received topic, before processing it.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, Direction is “in”
MQTT broker receives message with topic “/bus/tr181” over bridge => MQTT broker uses topic “/local/bus/tr181” for internal processing
For selection of the topics to be sent over the bridge the MQTT broker uses the combination of LocalPrefix and Topic to match the topics to be sent over bridge, and removes the LocalPrefix from the selected topic before sending it over the bridge.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, Direction is “out”
MQTT broker receives message with topic “/local/bus/tr181” from a MQTT client => MQTT broker sends topic “/bus/tr181” to remote MQTT broker
 - 2.10
RemotePrefix string W

The remote prefix is used for remapping topics to the remote MQTT broker topic lists.

For remote topics received over the bridge the MQTT broker removes the remote prefix topic from the received topic (before handling the LocalPrefix), before processing it.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, RemotePrefix is “/remote”, Direction is “in”
MQTT broker receives message with topic “/remote/bus/tr181” over bridge => MQTT broker uses topic “/local/bus/tr181” for internal processing
During activation of the bridge, the MQTT broker prepends the Topic with RemotePrefix topic and subscribes to the remote MQTT broker with it, in order to receive all applicable remote topics.
Example:
Topic is “/bus/+”, RemotePrefix is “/remote”, Direction is “in”
MQTT broker sends a subscription to the remote MQTT broker with the topic “/remote/bus/+”.
For all topics to be sent over the bridge (Direction is either out or both), the RemotePrefix will be prepended to the topic after the LocalPrefix has been processed and before sending the message over the bridge.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, RemotePrefix is “/remote” Direction is “out”
MQTT broker receives message with topic “/local/bus/tr181” from a MQTT client => MQTT broker sends topic “/remote/bus/tr181” to remote MQTT broker
 - 2.10
Device.MQTT.Broker.{i}.Stats. object R The MQTT broker statistics values. These will reset with each MQTT broker start, either after reboot or if the MQTT broker gets (re-)enabled. - 2.10
TotalNumberOfClients unsignedInt R Total number of MQTT clients registered with the MQTT broker. - 2.10
NumberOfActiveClients unsignedInt R Number of MQTT clients, which have a connection with the MQTT broker established. - 2.10
NumberOfInactiveClients unsignedInt R Number of MQTT clients, which have no connection with the MQTT broker established. - 2.10
Subscriptions unsignedInt R

Number of subscriptions held by the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
PublishSent unsignedLong R

[StatsCounter64] Number of publish messages sent by the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
PublishReceived unsignedLong R

[StatsCounter64] Number of publish messages received by the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
MQTTMessagesSent unsignedLong R

[StatsCounter64] Total number of MQTT messages sent by the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
MQTTMessagesReceived unsignedLong R

[StatsCounter64] Total number of MQTT messages received by the MQTT broker.

Active Notification requests for this parameter MAY be denied.

 - 2.10
ConnectionErrors unsignedInt R

[StatsCounter32] Number of connection errors.

Active Notification requests for this parameter MAY be denied.

 - 2.10
PublishErrors unsignedInt R [StatsCounter32] Number of errors which prevented sending publish messages - 2.10
Device.DynamicDNS. object R Properties for Dynamic DNS. - 2.10
ClientNumberOfEntries unsignedInt R The number of entries in the Client table. - 2.10
ServerNumberOfEntries unsignedInt R The number of entries in the Server table. - 2.10
SupportedServices string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. List of Dynamic DNS service names that are supported by the CPE. - 2.10
Device.DynamicDNS.Client.{i}. object(0:) W

Client properties for Dynamic DNS. A dynamic DNS client is responsible for verifying IP address changes and updating information from a subscribed account on a Dynamic DNS Server. For enabled table entries, if Server is not a valid reference then the table entry is inoperable and the CPE MUST set the Status to Error_Misconfigured.

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

 - 2.10
Enable boolean W Enables or disables this Dynamic DNS Client. - 2.10
Status string R

Status of this Dynamic DNS Client.

Enumeration of:

  • Connecting (The Dynamic DNS Client is trying to connect to the Server)
  • Authenticating (The Dynamic DNS Client is in the authentication phase)
  • Updated (The Dynamic DNS Client has performed an update request since the last IP address change)
  • Error_Misconfigured (Error due to configuration)
  • Error (An error has occurred during the communication with the Server. The LastError parameter is updated with the detail of this error)
  • Disabled (The Client is disabled)
 - 2.10
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.10
LastError string R

The last error this Dynamic DNS Client has encountered. The parameter MAY instead indicate a vendor-specific cause, which MUST use the format defined in [TR-106].

Enumeration of:

  • NO_ERROR
  • MISCONFIGURATION_ERROR
  • DNS_ERROR
  • CONNECTION_ERROR
  • AUTHENTICATION_ERROR
  • TIMEOUT_ERROR
  • PROTOCOL_ERROR
 - 2.10
Server string(:256) W The DynamicDNS server associated with this Dynamic DNS Client. The value MUST be the Path Name of a row in the Device.DynamicDNS.Server. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.10
Interface string(:256) W The IP interface over which update queries to the server are sent. The value MUST be the Path Name of a row in the Device.IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), to determine the appropriate interface. - 2.10
Username string(:256) W Username used by this Dynamic DNS Client to authenticate with the Server. - 2.10
Password string(:256) W

Password used by this Dynamic DNS Client to authenticate with the Server.

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

 - 2.10
HostnameNumberOfEntries unsignedInt R The number of entries in the Hostname table. - 2.10
Device.DynamicDNS.Client.{i}.Hostname.{i}. object(0:) W

Each table entry represents a fully qualified domain name updated by this Dynamic DNS Client.

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

 - 2.10
Enable boolean W Enables or disables this Hostname. - 2.10
Status string R

Status of this Hostname.

Enumeration of:

  • Registered (The Hostname has been updated with the current IP address)
  • UpdateNeeded (The IP address has changed since last update)
  • Updating (The Client is trying to update this Hostname)
  • Error (The Hostname doesn’t exist for this Dynamic DNS account)
  • Disabled (The Hostname is disabled)
 - 2.10
Name string(:256) W Fully qualified domain name that has to be updated with the IP address. If the name is set to another value, the Client MUST immediately send an update request to the Server. - 2.10
LastUpdate dateTime R The date time of the last successful update of this name to the Dynamic DNS Server. - 2.10
Device.DynamicDNS.Server.{i}. object(0:) W

Table of Dynamic DNS servers available for this CPE.

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

 - 2.10
Enable string(:64) W Enables or disables Dynamic DNS Server. - 2.10
Name string(:64) W The textual name of the Dynamic DNS Server. - 2.10
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.10
ServiceName string(:256) W Dynamic DNS service used to contact this server. The value MUST be a member of the list reported by the Device.DynamicDNS.SupportedServices parameter. - 2.10
ServerAddress string(:256) W Host name or IP address of the Dynamic DNS server. - 2.10
ServerPort unsignedInt(0:65535) W Port number of the Dynamic DNS server. - 2.10
SupportedProtocols string[] R

Indicates the protocols that are supported by the CPE for sending requests to the Dynamic DNS server. Comma-separated list of strings. This list depends on the Dynamic DNS service defined by the ServiceName parameter.

Each list item is an enumeration of:

 - 2.10
Protocol string W The value MUST be a member of the list reported by the SupportedProtocols parameter. Indicates the protocol used to send requests to the Dynamic DNS server. - 2.10
CheckInterval unsignedInt W Interval (in seconds) between two checks for IP change. A value of zero indicates that the CPE knows when IP changes and doesn’t need to check it periodically. - 2.10
RetryInterval unsignedInt W Initial retry interval (in seconds) after a failed request. This parameter can be used as a fixed value or as part of a retry interval calculation. - 2.10
MaxRetries unsignedInt W Maximum number of retries after a failed request. When the maximum number is reached, no further requests are sent until the context changes. A value of 0 means that there are no retries after a failed request. - 2.10
Device.LEDs. object R This object describes the LEDs on the device. - 2.11
LEDNumberOfEntries unsignedInt R The number of entries in the LED table. - 2.11
Device.LEDs.LED.{i}. object(0:) R

Each instance of this object describes an LED on the device. The default illumination characteristics (e.g., Color, Brightness) of an in use LED is vendor specific. When a cycle completes (i.e., CyclePeriodRepetitions = 0), the LED reverts back to its default illumination characteristics. When the value of the Status parameter is Controlled, then the value of CycleElementNumberOfEntries and CycleElementNumberOfEntries parameters SHOULD be 0. When the value of the RelativeXPosition and RelativeYPosition parameters are 0, this indicates that the position of the LED is unknown.

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

 - 2.11
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.11
Name string W The internal name used to identify this LED. - 2.11
Status string R

The status of the LED.

Enumeration of:

  • Disabled (The LED is currently not in use)
  • InUse (The LED is currently being used by the CPE)
  • Controlled (Indicates that the LED is controlled from an electronic circuit which cannot be monitored)
  • Error (The LED status cannot be determined by the CPE)
 - 2.11
Reason string R

The textual purpose that represents the visual display of the LED (e.g., Broadband Down).

Active Notification requests for this parameter MAY be denied.

 - 2.11
CyclePeriodRepetitions int(-1:) R

The number of cycle periods left for this LED. As each cycle period is completed this parameter is reduced by 1. A value of -1 indicates an infinite number of cycle period repetitions.

Active Notification requests for this parameter MAY be denied.

 - 2.11
Location string R

The location of the LED as the user looks at the front of the device in its typical orientation (e.g., on-end, flat).

Enumeration of:

  • Front
  • Back
  • Left
  • Right
  • Top
  • Bottom
 - 2.11
RelativeXPosition unsignedInt R The relative x position of the LED from left to right (x) and top to bottom (y) as the user looks at the device from the orientation identified in the Location parameter in its typical orientation (e.g., on-end, flat). - 2.11
RelativeYPosition unsignedInt R The relative y position of the LED from left to right (x) and top to bottom (y) as the user looks at the device from the orientation identified in the Location parameter in its typical orientation (e.g., on-end, flat). - 2.11
CycleElementNumberOfEntries unsignedInt R The number of entries in the CycleElement table. - 2.11
Device.LEDs.LED.{i}.CycleElement.{i}. object(0:) W

Each instance of this object describes the LED characteristics for a portion of the LED cycle period. The pattern of lighting for the LED corresponding to this table (i.e., the LED cycle period) is defined by the illumination of the LED according to the entries in this table, taken sequentially in the order specified by the Order parameter, with the duration for the portion of the LED illumination corresponding to a given instance specified by the Duration parameter. The other parameters of the instance of this object (e.g., Color, Brightness) describes the illumination characteristics applied to the LED for this CycleElement instance. The length of the complete LED cycle is the sum of the Duration parameters for all of the entries in this 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 a given value for Order.

 - 2.11
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.11
Enable boolean W Enables or disables this CycleElement instance. - 2.11
Order unsignedInt(1:) W The relative order of this CycleElement in the LED’s cycle period. - 2.11
Color hexBinary(3) W The color being displayed by the LED RGB hexadecimal notation (e.g., FF0088). Note: If the parameter is set to an unsupported color the CPE MUST NOT infer a different color. - 2.11
Duration unsignedInt W The duration, in milliseconds, for this element of the cycle period. - 2.11
FadeInterval unsignedInt W The interval corresponding to this CycleElement instance, in milliseconds, from the starting from the target illumination characteristics of the previous CycleElement instance to the target illumination characteristics of this CycleElement instance. The transition to the target illumination characteristics is uniformly interpolated “perceptually” over the value of this FadeInterval parameter. - 2.11
Device.LEDs.LED.{i}.CurrentCycleElement. object R This object describes the status of the current cycle element for this LED. - 2.11
CycleElementReference string R

This object describes the current properties of the CycleElement.{i} object instance that is currently active. The value MUST be the Path Name of a row in the CycleElement. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the LED instances does not have a current cycle element active, this parameter MUST be set to an empty string.

Active Notification requests for this parameter MAY be denied.

 - 2.11
Color hexBinary(3) R

The color, formatted as RGB hexadecimal notation (e.g., FF0088), that is currently being displayed by the LED.

Active Notification requests for this parameter MAY be denied.

 - 2.11
Duration unsignedInt R

The remaining duration, in milliseconds, for this element of the cycle period.

Active Notification requests for this parameter MAY be denied.

 - 2.11
Device.BASAPM. object R This object represents the objects necessary to manage and control the functionality for tests that utilize the Broadband Access Service Attributes and Performance Metrics measurement test framework as defined in by [TR-304]. - 2.12
MeasurementEndpointNumberOfEntries unsignedInt R The number of entries in the MeasurementEndpoint table. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}. object(0:) W

This object represents the measurement endpoint that provides additional contextual information regarding the measurement agent.

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

 - 2.12
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.12
Enable boolean W Enables or disables this MeasurementEndpoint instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
MeasurementAgent string W The value MUST be the Path Name of a LMAP.MeasurementAgent object that is associated with this measurement endpoint.. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
DeviceOwnership string W

This parameter describes the ownership of the device that hosts the measurement endpoint. Enumeration of:

  • ISP (ISP Owned Device)
  • Customer (Customer Owned Device)
 - 2.12
OperationalDomain string(:256) W This parameter describes the operational domain for this measurement endpoint - 2.12
InternetDomain string(:64) W The top level Internet domain used to identify this measurement endpoint. - 2.12
UseMeasurementEndpointInReports boolean W If the value of this parameter is false then the Measurement Endpoint MUST not be included in measurement reports. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}.ISPDevice. object R This object represents the information necessary to utilize an ISP owned device within the measurement endpoint. - 2.12
ReferencePoint string W

This parameter describes the measurement reference point of the measurement endpoint. Enumeration of:

  • STP (Internet Source Test Point)
  • IDTP (Internet Drain Test Point)
  • RNTP (Regional Network Test Point)
  • IRTP (Internal Regional Test Point)
  • MTP (Metro Test Point)
  • IATP (Internal Access Test Point)
  • UNITP (User Network Interface Test Point)
  • CEDTP (Customer End Device Test Point)
 - 2.12
GeographicalLocation string W The value MUST be the Path Name of a DeviceInfo.Location object that describes the geographic location of the measurement endpoint. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}.CustomerDevice. object R This object represents the information necessary to utilize customer owned device within the measurement endpoint. - 2.12
EquipmentIdentifier string(:64) W This parameter describes the customer equipment identifier of the measurement endpoint. - 2.12
CustomerIdentifier string(:256) W The unique customer identifier within the operational domain for this measurement endpoint. - 2.12
Device.LMAP. object R This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. - 2.0
MeasurementAgentNumberOfEntries unsignedInt R The number of entries in the MeasurementAgent table. - 2.0
ReportNumberOfEntries unsignedInt R The number of entries in the Report table. - 2.0
EventNumberOfEntries unsignedInt R The number of entries in the Event table. - 2.0
Device.LMAP.MeasurementAgent.{i}. object(0:) W

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

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

 - 2.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 Enables or disables this MeasurementAgent instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Version string R Version of the measurement agent. - 2.0
LastStarted dateTime R Date and time, based on [RFC3339], in UTC that the measurement agent was successfully started. - 2.0
CapabilityTags string[] R Comma-separated list of strings. Capabilities of the measurement agent that cannot be expressed elsewhere in the data model. - 2.0
Identifier string(36) W [UUID] Identifier of the MeasurementAgent instance. - 2.0
GroupIdentifier string(:256) W Identifier of the measurement group of interest to which the measurement agent belongs. - 2.0
MeasurementPoint string(:256) W Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [bibref|RFC7398.}} - 2.0
UseAgentIdentifierInReports boolean W If the value of the Identifier parameter is not an empty string and the value of this parameter is false then the value of the Identifier parameter MUST not be included in measurement reports. true 2.0
UseGroupIdentifierInReports boolean W If the value of the GroupIdentifier parameter is not an empty string and the value of this parameter is false then the value of the GroupIdentifier parameter MUST not be included in measurement reports. false 2.0
UseMeasurementPointInReports boolean W If the value of the MeasurementPoint parameter is not an empty string and the value of this parameter is false then the value of the MeasurementPoint parameter MUST not be included in measurement reports. false 2.0
PublicCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to identify this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
PrivateCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to contain the private keys for this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
EventLog string R The value MUST be the Path Name of a DeviceInfo.VendorLogFile object that is used to record events for this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
TaskCapabilityNumberOfEntries unsignedInt R The number of entries in the TaskCapability table. - 2.0
ScheduleNumberOfEntries unsignedInt R The number of entries in the Schedule table. - 2.0
TaskNumberOfEntries unsignedInt R The number of entries in the Task table. - 2.0
CommunicationChannelNumberOfEntries unsignedInt R The number of entries in the CommunicationChannel table. - 2.0
InstructionNumberOfEntries unsignedInt R The number of entries in the Instruction table. - 2.0
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}. object(0:) R

This object represents a capabilities, in the context of a task, that are supported by the measurement agent. Types of capabilities include: Report tasks, Configuration Tasks and Instruction Tasks.

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

 - 2.0
Name string(:256) R Name of the supported task. - 2.0
Version string(:256) R Version of the task. - 2.0
TaskCapabilityRegistryNumberOfEntries unsignedInt R The number of entries in the Registry table. - 2.0
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}.Registry.{i}. object(0:) R

This object represents a registry function and an associated list of roles supported by this measurement agent

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

 - 2.0
RegistryEntry string R A URI ([RFC3986]) that is the value of the task registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.0
Roles string(:256)[] R Comma-separated list of strings (maximum number of characters per item 256), representing the roles of the function. - 2.0
Device.LMAP.MeasurementAgent.{i}.Controller. object R This objects represents the measurement controller that is assigned to a measurement agent. - 2.0
ControllerTimeout int(0:) W The timer, in seconds, that is started after each successful contact with a measurement controller. When the timer reaches the timeout en event is raised indicating that connectivity to the controller has been lost. - 2.0
ControlSchedules string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available control schedules for invoking control tasks by the measurement agent. - 2.0
ControlTasks string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Task object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available control tasks that can be invoked by the measurement agent. - 2.0
ControlChannels string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list. The measurement agent to measurement controller channel is used for conveying results of communication sessions with the configuration, instruction status and logging information elements defined in defined in [LMAPIFM]. - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. object(0:) W

This object represents a schedule that is associated with a set of scheduled actions to be performed by a measurement agent. Note: Actions of an occurrence of this Schedule are gracefully terminated by the defining either the End or Duration parameters. Only one of these parameters may be defined at a time.

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

 - 2.0
Enable boolean W Enables or disables this Schedule instance. This parameter is based on ifAdminStatus 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.

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(:256) W Name of the schedule. - 2.0
State string R

The current operational state of the Schedule. Only one instance of the schedule is active. An active schedule is defined where the State parameter has a value of Running. Enumeration of:

  • Enabled
  • Suppressed
  • Disabled
  • Running
 - 2.0
Start string W The value MUST be the Path Name of a Event object that is used define the event to start an occurrence of this Schedule. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
End string W The value MUST be the Path Name of a Event object that is used define the event to gracefully terminate all actions associated with an occurrence of this Schedule. If the referenced object is deleted, the parameter value MUST be set to an empty string.. <Empty> 2.0
Duration unsignedInt W When the Duration value is not 0, this parameter is used define the duration, in seconds, where after this duration all actions associated with an occurrence of this Schedule are gracefully terminated. 0 2.0
Tags string[] W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.0
SuppressionTags string[] W Comma-separated list of strings, representing the suppression tags to be matched. - 2.0
ExecutionMode string W

This parameter describes the execution method to apply to this schedule for the associated Actions. Enumeration of:

  • Sequential ( Actions are executed in sequence as defined by the value of the Action.{i}.Order parameter. The first Scheduled Action of the DestinationOutput is provided the input)
  • Parallel (Actions are executed in parallel. The all Scheduled Actions of the DestinationOutput are provided the input)
  • Pipelined (Actions are executed in sequence where the output of one Action is used as the input of subsequent Action. The first Scheduled Action of the DestinationOutput is provided the input)
 Pipelined 2.0
LastInvocation dateTime R Date and time, based on [RFC3339], in UTC that the Schedule was invoked by the measurement agent. - 2.0
Storage unsignedLong R

The amount of secondary storage, in bytes, allocated to an instance of this Schedule. The value of this parameter reflects the amount of allocated physical storage and not the storage used by logical data records. For example the secondary storage can be the storage allocated in a file system holding temporary data.

Active Notification requests for this parameter MAY be denied.

 - 2.0
ActionNumberOfEntries unsignedInt R The number of entries in the Action table. - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats. object R This object represents the statistics associated with this object. - 2.0
Invocations unsignedLong R

Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Suppressions unsignedLong R

Number of suppressed executions of this schedule.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Overlaps unsignedLong R

Number of executions prevented due to overlaps with a previous invocation of this schedule.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Failures unsignedLong R

Number of failed executions of this schedule. A failed execution is an execution where at least one action failed.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. object(0:) W

This object represents an action that is associated with the this Schedule object.

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

 - 2.0
Enable boolean W Enables or disables this Schedule.{i}.Action object. This parameter is based on ifAdminStatus 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.

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

The current operational state of the Action. Enumeration of:

  • Enabled
  • Suppressed
  • Disabled
  • Running
 - 2.0
Order unsignedInt W The order of the scheduled action. - 2.0
Task string W The value MUST be the Path Name of a Task object used in this scheduled action. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
OutputDestination string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object used to receive the output(s) of this scheduled action. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.0
SuppressionTags string[] W Comma-separated list of strings, representing the suppression tags to be matched. - 2.0
Tags string[] W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.0
Storage unsignedLong R

The amount of secondary storage, in bytes, allocated to an instance of this Action. The value of this parameter reflects the amount of allocated physical storage and not the storage used by logical data records. For example the secondary storage can be the storage allocated in a file system holding temporary data.

Active Notification requests for this parameter MAY be denied.

 - 2.0
LastInvocation dateTime R Date and time, based on [RFC3339], in UTC that the Action was invoked by the measurement agent. - 2.0
LastSuccessfulCompletion dateTime R Date and time, based on [RFC3339], in UTC of a successful completion of the Action. - 2.0
LastSuccessfulStatusCode int R The status code returned by successful execution of the Action. A value of 0 indicates successful completion. - 2.0
LastSuccessfulMessage string R The message associated with the successful completion of the Action. - 2.0
LastFailedCompletion dateTime R Date and time, based on [RFC3339], in UTC of a failure to complete the Action. - 2.0
LastFailedStatusCode int R The status code returned by failed execution of the Action. A value of 0 indicates successful completion. - 2.0
LastFailedMessage string R The message associated with the failure to complete the task. - 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Stats. object R This object represents the statistics associated with this object. - 2.0
Invocations unsignedLong R

Number of invocations of this action. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Suppressions unsignedLong R

Number of suppressed executions of this action.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Overlaps unsignedLong R

Number of executions prevented due to overlaps with a previous invocation of this action.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Failures unsignedLong R

Number of failed executions of this action. A failed execution is an execution where at least one action failed.

Active Notification requests for this parameter MAY be denied.

 - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}. object(0:) W

This object represents an option associated with the Scheduled Action. When an option with the same Name exists between the Seheduled Action’s Option and The Task’s option, the option of the Scheduled Action takes precedence over the option associated with the Task.

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

 - 2.0
Enable boolean W Enables or disables this Option instance. This parameter is based on ifAdminStatus 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.

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
Order unsignedInt W The order of the Option. - 2.0
Name int W The name of the option. When the value of this parameter is equal to “channel”, the option value specifies the Communication Channel used for this scheduled task. - 2.0
Value string W The value associated with the Option. - 2.0
Device.LMAP.MeasurementAgent.{i}.Task.{i}. object(0:) W

The Task object defines the configuration for a task that can be performed by MeasurementAgent objects. Tasks are performed by MeasurementAgent objects when a Schedule object invokes the Task.

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

 - 2.0
Enable boolean W Enables or disables this Task instance. This parameter is based on ifAdminStatus 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.

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(:256) W Name of the task. - 2.0
Tags string[] W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.0
RegistryNumberOfEntries unsignedInt R The number of entries in the Registry table. - 2.0
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}. object(0:) W

This object represents a registry function and an associated list of roles for this task

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

 - 2.0
Enable boolean W Enables or disables this Registry instance. This parameter is based on ifAdminStatus 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.

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
RegistryEntry string W A URI ([RFC3986]) that is the value of the task registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.0
Roles string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256), representing the roles of the function. - 2.0
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}. object(0:) W

This object represents an option associated with the task.

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

 - 2.0
Enable boolean W Enables or disables this Option instance. This parameter is based on ifAdminStatus 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.

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
Order unsignedInt W The order of the Option. - 2.0
Name int W The name of the option. When the value of this parameter is equal to “channel”, the option value specifies the Communication Channel used for this task. - 2.0
Value string W The value associated with the Option. - 2.0
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}. object(0:) W

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

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

 - 2.0
Enable boolean W Enables or disables this CommunicationChannel instance. This parameter is based on ifAdminStatus 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.

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(:256) W Name of the channel. - 2.0
UseBulkDataProfile boolean W Enables or disables the ability to use a bulk data profile for this communication channel - 2.0
BulkDataProfile string W The value MUST be the Path Name of a BulkData.Profile object that is used to represent communication channel. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
Target string(:256) W The URL of the LMAP component that is the target of this communication channel. - 2.0
TargetPublicCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to identify the target of this channel. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
Interface string W The value MUST be the Path Name of an interface object used to restrict the data transmitted or received using this channel to a specific interface. If the value of this parameter is an empty string the data that is transmitted or received using this channel is able to use any available interface. - 2.0
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}. object(0:) W

The Instruction object defines the instruction to the measurement agent by the measurement controller. At most one Instruction object for the MeasurementAgent instance is enabled at a time. .

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 this Instruction instance. This parameter is based on ifAdminStatus 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.

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
LastChange dateTime R Date and time, based on [RFC3339], in UTC that the Instruction object or its sub-object’s configuration was changed by a measurement agent’s controller. - 2.0
InstructionSchedules string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available instruction schedules for invoking control tasks by the measurement agent. - 2.0
InstructionTasks string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Task object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available instruction tasks that can be invoked by the measurement agent. - 2.0
ReportChannels string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter defines the corresponding report channels to be used when reporting results of tasks to a measurement collector. - 2.0
MeasurementSuppressionNumberOfEntries unsignedInt R The number of entries in the MeasurementSuppression table. - 2.0
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}. object(0:) W

This object defines the schedules and actions that are suppressed based on criteria defined in the SuppressionMatch 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. At most one enabled entry in this table can exist with a given value for Name.

 - 2.0
Enable boolean W Enables or disables this MeasurementSuppression instance. This parameter is based on ifAdminStatus 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.

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(:256) W Name of the suppression object. - 2.0
State string R

The current operational state of the MeasurementSuppression. Enumeration of:

  • Enabled
  • Active
  • Disabled
 - 2.0
StopRunning boolean W When true, the measurement agent is instructed to stop running schedules or actions that have been matched by this object. false 2.0
Start string W The value MUST be the Path Name of a Event object that is used define the event that to start an occurrence of this MeasurementSuppression. If the referenced object is deleted, the parameter value MUST be set to an empty string. When an empty string the default behavior is to perform the suspension event immediately. <Empty> 2.0
End string W The value MUST be the Path Name of a Event object that is used define the event to gracefully suspend all actions associated with an occurrence of this MeasurementSuppression. If the referenced object is deleted, the parameter value MUST be set to an empty string. When an empty string the default behavior is for the suspension period to be indefinite. <Empty> 2.0
SuppressionMatch string[] W Comma-separated list of strings, representing the match patterns to be used for applying suppression to Schedule.{i} (and their actions) and all Schedule.{i}.Action.{i} object instances that have a matched using their SuppressionTags parameters. The match pattern syntax is defined in [LMAPIFM]. - 2.0
Device.LMAP.Report.{i}. object(0:) R This Report object instance represents a report that is generated by a reporting task where the reporting task is defined as a MeasurementAgent.{i}.Task.{i} and executed as a scheduled action (MeasurementAgent.{i}.Schedule.{i}.Action.{i}). The Report replicates the MeasurementAgent.{i} object instance’s data at the time of the action exection. When a BulkData.Profile.{i} object instance is used to communicate a Report instance, the CPE adds a BulkData.Profile.{i}.Parameter.{i} object instance referring to this Report object instance. - 2.0
ReportDate dateTime R The report date and time, based on [RFC3339], that the report was sent to the collector. - 2.0
AgentIdentifier string(36) R [UUID] Identifier of the measurement agent at the time the measurement was run. - 2.0
GroupIdentifier string R Identifier of the measurement group of interest to which the MA belongs. - 2.0
MeasurementPoint string(:256) R Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [RFC7398]. - 2.0
ResultNumberOfEntries unsignedInt R The number of entries in the Result table. - 2.0
Device.LMAP.Report.{i}.Result.{i}. object(0:) R

The Result object provides the meta-data of the result report of a single executed action that produced the result.

At most one entry in this table can exist with the same values for all of ScheduleName, ActionName and StartTime.

 - 2.0
TaskName string(:256) R Name of the task that produced the result. - 2.0
ScheduleName string(:256) R Name of the schedule that produced the result. - 2.0
ActionName string(:256) R Name of the action that produced the result. - 2.0
EventTime dateTime R The date and time, based on [RFC3339], that the event that triggered the schedule of the action that produced the reported result values in UTC. - 2.0
StartTime dateTime R The date and time, based on [RFC3339], that the action started in UTC. - 2.0
EndTime dateTime R The date and time, based on [RFC3339], that the action was completed in UTC. - 2.0
CycleNumber string R

The cycle number derived from the EventTime. The cycle number is the time, in UTC, closest to the EventTime that is a multiple of the cycle interval of the event that triggered the execution of the schedule. The value is valid if the event that triggered the execution of the schedule has a defined cycle interval. An an empty string value represent an invalid CycleNumber. Possible patterns:

  • YYYYMMDD.HHMMSS
 - 2.0
Status int R The status code returned by the execution of the action. - 2.0
Tags string[] R Comma-separated list of strings, each entry represents tags defined for the schedule, task and action objects that produced this result. - 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.0
ResultConflictNumberOfEntries unsignedInt R The number of entries in the Conflict table. - 2.0
ResultReportTableNumberOfEntries unsignedInt R The number of entries in the ReportTable table. - 2.0
Device.LMAP.Report.{i}.Result.{i}.Option.{i}. object(0:) R

This object represents an option associated with the task or action object that produced the result.

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

 - 2.0
Order unsignedInt R The order of the Option. - 2.0
Name int R The name of the Option. When the value of this parameter is equal to “channel”, the option value specifies the Communication Channel used for this task. - 2.0
Value string R The value associated with the Option. - 2.0
Device.LMAP.Report.{i}.Result.{i}.Conflict.{i}. object(0:) R

This object represents actions that might have impacted the results being reported.

At most one entry in this table can exist with the same values for all of ScheduleName, ActionName and TaskName.

 - 2.0
TaskName string(:256) R Name of the task. - 2.0
ScheduleName string(:256) R Name of the schedule. - 2.0
ActionName string(:256) R Name of the action. - 2.0
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}. object(0:) R This ReportTable object instances represents a row of results. - 2.0
ColumnLabels string[] R Comma-separated list of strings. This parameter contains the column labels used for the result. The column labels are ordered with the corresponding entries in the ResultRow table. - 2.0
ResultReportRowNumberOfEntries unsignedInt R The number of entries in the ResultRow table. - 2.0
RegistryNumberOfEntries unsignedInt R The number of entries in the Registry table. - 2.0
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.ResultRow.{i}. object(0:) R This ResultRow object instances represents a row of results for the report. - 2.0
Values string[] R Comma-separated list of strings. This parameter contains an ordered set of values that align to the columns defined in the ColumnLabels parameter. - 2.0
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.Registry.{i}. object(0:) R

This object represents a registry function and an associated list of roles for this result report.

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

 - 2.0
RegistryEntry string R A URI ([RFC3986]) that is the value of the registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.0
Roles string(:256)[] R Comma-separated list of strings (maximum number of characters per item 256), representing the roles of the function. - 2.0
Device.LMAP.Event.{i}. object(0:) W

This object defines the information associated with an event used within the measurement agent. Event instances may be referenced by various objects within the LMAP model.

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

 - 2.0
Enable boolean W Enables or disables this Event instance. This parameter is based on ifAdminStatus 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.

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(:256) W Name of the Event. - 2.0
Type string W

This parameter describes the type of Event for this object instance. The timing of the event occurrence is adjusted based on the value of the RandomnessSpread parameter. Enumeration of:

  • PeriodicTiming (Periodic Timing Event. When selected one or more event occurrences are emitted based on the parameters defined in the PeriodicTimer object)
  • CalendarTiming (Calendar Timing Event. When selected one or more event occurrences are emitted based on the parameters defined in the CalendarTimer object)
  • OneOffTiming (One-off Timing Event. When selected a single event occurrence is emitted based on the parameters defined in the OneOff object)
  • Immediate (Immediate Timing Event. When selected a single event occurrence is emitted as soon as possible)
  • Startup (Startup Timing Event. When selected a single event occurrence is emitted when the corresponding measurement agent starts up)
  • ControllerLost (Controller Lost Event. When selected a single event occurrence is emitted when the connectivity to the controller is lost)
  • ControllerConnected (Controller Connected Event. When selected a single event occurrence is emitted when the connectivity to the controller is established)
 Immediate 2.0
RandomnessSpread int W The spread, in seconds, of the Uniform Discrete random distribution algorithm. A value of 0 means that the random algorithm is not applied. - 2.0
CycleInterval int W The duration of the time interval, in seconds, that used to calculate cycle numbers. - 2.0
Device.LMAP.Event.{i}.PeriodicTimer. object R This object defines a periodic timer instance. The periodic timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the interval to use. - 2.0
StartTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to begin operation. - 2.0
EndTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to end operation. - 2.0
Interval unsignedInt W The tolerable duration, in seconds, of the interval for this PeriodicTimer instance. - 2.0
Device.LMAP.Event.{i}.CalendarTimer. object R This object defines a calendar timer instance. The calendar timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the schedule of the recurrence. The algrorithm that defines how the schedule elements are evaluated is defined in [LMAPIFM]. If the value of any of the ScheduleMonths, ScheduleDaysOfMonth, ScheduleDaysOfWeek, ScheduleHoursOfDay, ScheduleMinutesOfHour or ScheduleSecondsOfMinute is an empty string then any actions that use this object will not be invoked. - 2.0
StartTime dateTime W Date and time that the CalendarTimer instance is to begin this operation. - 2.0
EndTime dateTime W Date and time that the CalendarTimer instance is to end this operation. - 2.0
ScheduleMonths string W This parameter represents either a list of the months of year that are applied to the schedule or an asterisk (*) that represents all the elements of the list. Each entry in the months of the year list can be a numeric value or the name of the month (january (1), february (2), march (3), april (4), may (5), june (6), july (7), august (8), september (9), october (10), november (11), december (12)). - 2.0
ScheduleDaysOfMonth string W This parameter represents either a list of the days of the month (1-31) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
ScheduleDaysOfWeek string W This parameter represents either a list of the days of the week that are applied to the schedule or an asterisk (*) that represents all the elements of the list. Each entry in the days of the week list can be a numeric value or the name of the day (sunday (1), monday (2), tuesday (3), wednesday (4), thursday (5), friday (6), saturday (7)). - 2.0
ScheduleHoursOfDay string W This parameter represents either a list of the hours of the day (0-23) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
ScheduleMinutesOfHour string W This parameter represents either a list of the minutes of the hour (0-59) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
ScheduleSecondsOfMinute string W This parameter represents either a list of the minutes of the hour (0-59) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
EnableScheduleTimezoneOffset boolean W When true, the value of the ScheduleTimezoneOffset parameter is applied to the schedule elements. When false, the device’s system timezone offset is applied to the schedule elements. - 2.0
ScheduleTimezoneOffset int(-23:23) W The timezone offset, in hours, to be applied to the schedule elements. - 2.0
Device.LMAP.Event.{i}.OneOff. object R This object defines a one off timer instance. - 2.0
StartTime dateTime W Date and time, based on [RFC3339], that the OneOff instance is to begin operation. - 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.SoftwareModules. object R Top level object for dynamically managed software applications. - 2.1
ExecEnvNumberOfEntries unsignedInt R The number of entries in the ExecEnv table. - 2.1
DeploymentUnitNumberOfEntries unsignedInt R The number of entries in the DeploymentUnit table. - 2.1
ExecutionUnitNumberOfEntries unsignedInt R The number of entries in the ExecutionUnit table. - 2.1
Device.SoftwareModules.ExecEnv.{i}. object(0:) R

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

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

 - 2.1
Enable boolean W Indicates whether or not this ExecEnv is enabled. Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it. When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to Idle. If a ChangeDUState is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that ChangeDUState operation fails and the associated DUStateChangeComplete RPC will contain a FaultStruct for that operation. If a SetParameterValues is attempted against the ExecutionUnit.{i}.RequestedState for an ExecutionUnit that is associated with a disabled ExecEnv a CWMP Fault will be issued in response. Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and the ACS disabled it, the CWMP management agent might be terminated leaving the device unmanageable. - 2.1
Status string R

Indicates the status of this ExecEnv.

Enumeration of:

  • Up
  • Error (OPTIONAL)
  • Disabled
 - 2.1
Reset boolean W Setting this parameter to true causes this ExecEnv to revert back to the state it was in when the device last issued a “0 BOOTSTRAP” Inform event. The following requirements dictate what MUST happen for the reset to be complete:
  1. All Deployment Units that were installed after the last “0 BOOTSTRAP” Inform event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last “0 BOOTSTRAP” Inform event was issued
  4. Any Deployment Unit that was present when the last “0 BOOTSTRAP” Inform event was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last “0 BOOTSTRAP” Inform event was issued
  5. The Execution Environment MUST be restored to the version and configuration present when the last “0 BOOTSTRAP” Inform event was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met
 - 2.1
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.1
Name string(:32) R A Name provided by the CPE that adequately distinguishes this ExecEnv from all other ExecEnv instances. - 2.1
Type string(:64) R Indicates the complete type and specification version of this ExecEnv. - 2.1
InitialRunLevel unsignedInt(:65535) W The run level that this ExecEnv will be in upon startup (whether that is caused by a CPE Boot or the Execution Environment starting). Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this ExecEnv. - 2.1
RequestedRunLevel int(-1:65535) W Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this parameter’s value will change the value of the CurrentRunLevel. Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this ExecEnv. - 2.1
CurrentRunLevel int(-1:65535) R The run level that this ExecEnv is currently operating in. This value is altered by changing the RequestedRunLevel parameter. Upon startup (whether that is caused by a CPE Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1. Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or RequestedRunLevel will not impact the Run Level of this ExecEnv. - 2.1
InitialExecutionUnitRunLevel int(-1:65535) W Indicates the initial value on creation for ExecutionUnit.{i}.RunLevel for all Execution Unit instances associated with this ExecEnv. If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit. - 2.4
Vendor string(:128) R The vendor that produced this ExecEnv. - 2.1
Version string(:32) R The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification. - 2.1
ParentExecEnv string R The value MUST be the Path Name of a row in the ExecEnv. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the parent ExecEnv of this ExecEnv. If this value is an empty string then this is the Primary Execution Environment. - 2.1
AllocatedDiskSpace int(-1:) R The amount of disk space measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.1
AvailableDiskSpace int(-1:) R

The amount of disk space measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes disk space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable.

Active Notification requests for this parameter MAY be denied.

 - 2.1
AllocatedMemory int(-1:) R The amount of physical RAM measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.1
AvailableMemory int(-1:) R

The amount of physical RAM measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv are started/stopped and consume the physical RAM. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable.

Active Notification requests for this parameter MAY be denied.

 - 2.1
ActiveExecutionUnits string[] R

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances currently running on this ExecEnv. This parameter only contains ExecutionUnit instances that currently have a ExecutionUnit.{i}.Status of Active.

Active Notification requests for this parameter MAY be denied.

 - 2.1
ProcessorRefList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it. - 2.1
Device.SoftwareModules.DeploymentUnit.{i}. object(0:) R

This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit. A new instance of this table gets created during the installation of a Software Module.

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

 - 2.1
UUID string(:36) R A Universally Unique Identifier either provided by the ACS, or generated by the CPE, at the time of Deployment Unit Installation. The format of this value is defined by [RFC4122] Version 3 (Name-Based) and [Annex H/TR-069a3]. This value MUST NOT be altered when the DeploymentUnit is updated. - 2.1
DUID string(:64) R Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific. - 2.1
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.1
Name string(:64) R Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit. The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3]. - 2.1
Status string R

Indicates the status of this DeploymentUnit.

Enumeration of:

  • Installing (This instance is in the process of being Installed and SHOULD transition to the Installed state)
  • Installed (This instance has been successfully Installed. The Resolved flag SHOULD also be referenced for dependency resolution)
  • Updating (This instance is in the process of being Updated and SHOULD transition to the Installed state)
  • Uninstalling (This instance is in the process of being Uninstalled and SHOULD transition to the Uninstalled state)
  • Uninstalled (This instance has been successfully Uninstalled. This status will typically not be seen within a DeploymentUnit instance)

Active Notification requests for this parameter MAY be denied.

 - 2.1
Resolved boolean R Indicates whether or not this DeploymentUnit has resolved all of its dependencies. - 2.1
URL string(:1024) R Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit. - 2.1
Description string(:256) R Textual description of this DeploymentUnit. The format of this value is Execution Environment specific. - 2.1
Vendor string(:128) R The author of this DeploymentUnit formatted as a domain name. The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3]. - 2.1
Version string(:32) R Version of this DeploymentUnit. The format of this value is Execution Environment specific. - 2.1
VendorLogList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this DeploymentUnit. This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit. When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the CPE. Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string. - 2.1
VendorConfigList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this DeploymentUnit. This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit. When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the CPE. Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string. - 2.1
ExecutionUnitList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances that are associated with this DeploymentUnit instance. - 2.1
ExecutionEnvRef string R The value MUST be the Path Name of a row in the ExecEnv. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv instance where this DeploymentUnit instance is installed. - 2.1
Device.SoftwareModules.ExecutionUnit.{i}. object(0:) R

This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

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

 - 2.1
EUID string(:64) R Execution Unit Identifier chosen by the ExecEnv during installation of the associated DeploymentUnit. The format of this value is Execution Environment specific, but it MUST be unique across ExecEnv instances. Thus, it is recommended that this be a combination of the ExecEnv.{i}.Name and an Execution Environment local unique value. - 2.1
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.1
Name string(:32) R The name of this ExecutionUnit as it pertains to its associated DeploymentUnit, which SHOULD be unique across all ExecutionUnit instances contained within its associated DeploymentUnit. - 2.1
ExecEnvLabel string(:64) R The name of this ExecutionUnit as provided by the ExecEnv, which SHOULD be unique across all ExecutionUnit instances contained within a specific ExecEnv. - 2.1
Status string R

Indicates the status of this ExecutionUnit.

Enumeration of:

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

Active Notification MUST by default be enabled for this parameter.

 - 2.1
RequestedState string W

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

  • Idle (If this ExecutionUnit is currently in Starting or Active the CPE will attempt to Stop the Execution Unit; otherwise this requested state is ignored)
  • Active (If this ExecutionUnit is currently in Idle the CPE will attempt to Start the Execution Unit. If this ExecutionUnit is in Stopping the request is rejected and a fault raised. Otherwise this requested state is ignored) If this ExecutionUnit is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a CWMP Fault MUST be generated.
 - 2.1
ExecutionFaultCode string R

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

  • NoFault
  • FailureOnStart
  • FailureOnAutoStart
  • FailureOnStop
  • FailureWhileActive
  • DependencyFailure
  • UnStartable For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].
 - 2.1
ExecutionFaultMessage string(:256) R If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem. If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the ACS. - 2.1
AutoStart boolean W If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted. If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the ACS or another Execution Unit. - 2.1
RunLevel unsignedInt(:65535) W Determines when this ExecutionUnit will be started. If AutoStart is true and ExecEnv.{i}.CurrentRunLevel is greater than or equal to RunLevel, then this ExecutionUnit will be started. If the value of ExecEnv.{i}.CurrentRunLevel is -1, then the associated ExecEnv. doesn’t support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this ExecutionUnit. - 2.1
Vendor string(:128) R Vendor of this ExecutionUnit. - 2.1
Version string(:32) R Version of the ExecutionUnit. The format of this value is Execution Environment specific. - 2.1
Description string(:256) R Textual description of this ExecutionUnit. The format of this value is Execution Environment specific. - 2.1
DiskSpaceInUse int(-1:) R

The amount of disk space measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable.

Active Notification requests for this parameter MAY be denied.

 - 2.1
MemoryInUse int(-1:) R

The amount of physical RAM measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable.

Active Notification requests for this parameter MAY be denied.

 - 2.1
References string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a table row, or an empty string. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit. See [Appendix II.3.2/TR-157a3] for more description and some examples. NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the DeviceInfo.SupportedDataModel.{i}. table. - 2.1
AssociatedProcessList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.ProcessStatus.Process. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the system processes that are active in the system because of this ExecutionUnit. If Status is not Active it is expected that this list will be an empty string. Some ExecutionUnit instances MIGHT NOT have any system processes irrespective of the value of Status. - 2.1
VendorLogList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this ExecutionUnit. When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the CPE. Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string. - 2.1
VendorConfigList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this ExecutionUnit. When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the CPE. Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string. - 2.1
SupportedDataModelList 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 instances that have been introduced to this device because of the existence of this ExecutionUnit. - 2.1
ExecutionEnvRef string R The value MUST be the Path Name of a row in the ExecEnv. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv that this ExecutionUnit is associated with. - 2.1
Device.SoftwareModules.ExecutionUnit.{i}.Extensions. object R This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit. It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of References and SupportedDataModelList will be used to determine their locations. See [Appendix II.3.2/TR-157a3] for more description and some examples. - 2.1
Device.ETSIM2M. object R The ETSIM2M object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture [ETSIM2MFA]. - 2.6
SCLNumberOfEntries unsignedInt R The number of entries in the SCL table. - 2.6
Device.ETSIM2M.SCL.{i}. object(0:) W This object represents an instance of a Service Capability Layer (SCL) for a M2M device or gateway. The SCL MAY be maintained by the ACS or by the CPE. When the SCL provides the administration of an SCL that is represented as a SoftwareModules.ExecutionUnit the SCL is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter. Section 5.1.2 of the M2M Functional Architecture [ETSIM2MFA] describes the high level event flows for SCL registration. Section 9.3.2.6.2 of the M2M Functional Architecture [ETSIM2MFA] describes the creation/registration of SCLs. Section 9.3.2.6.4 of the M2M Functional Architecture [ETSIM2MFA] describes the update/re-registration of SCLs. Section 9.3.2.6.5 of the M2M Functional Architecture [ETSIM2MFA] describes the deletion/deregistration of SCLs. 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.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
AnnouncedToSCLList string[] W Comma-separated list of strings. The list represents an unordered set of URIs [RFC3986]. A list item is a URI string that represents a SCL to which the this SCL will announce original (local) resources. The AnnouncedToSCL has an interest in the discovery of the local resource. Section 9.2.1.14 Announced Resource of the M2M Functional Architecture [ETSIM2MFA] provides a description of this behavior of an Announced Resource. Section 9.3.2.28 of the M2M Functional Architecture [ETSIM2MFA] and Section 10.3.2.7 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] describes the process of announcing and deannouncing of resources within a SCL. - 2.6
SAFPolicySetNumberOfEntries unsignedInt R The number of entries in the SAFPolicySet table. - 2.6
AreaNwkInstanceNumberOfEntries unsignedInt R The number of entries in the AreaNwkInstance table. - 2.6
AreaNwkDeviceInfoInstanceNumberOfEntries unsignedInt R The number of entries in the AreaNwkDeviceInfoInstance table. - 2.6
Device.ETSIM2M.SCL.{i}.Discovery. object R This object is represents the administration properties used when a NSCL requests discovery of resources within this SCL instance. Section 9.3.2.27 of the M2M Functional Architecture [ETSIM2MFA] describes the process of discovery of resources within a SCL. - 2.6
MaxNumberOfDiscovRecords unsignedInt W The maximum number of URIs [RFC3986] for discovered resources contained in a discovery result. This parameter and the MaxSizeOfDiscovAnswer parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter. A value of 0 indicates that the SCL does not have a limit for this parameter. - 2.6
MaxSizeOfDiscovAnswer unsignedInt W The maximum size in bytes of the Discovery Answer. This parameter and the MaxNumberOfDiscovRecords parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter. A value of 0 indicates that the SCL does not have a limit for this parameter. - 2.6
Device.ETSIM2M.SCL.{i}.Reregistration. object R This object represents the properties and status necessary for a SCL to reregister with one or more NSCLs. - 2.6
RegTargetNSCLList string[] W Comma-separated list of strings. The list represents a priority ordered set of URIs [RFC3986]. The item that is first in the list has the highest priority. A list item is a URI [RFC3986] string that represents a NSCL that this SCL instance can use in order to attempt registration. When modified the contents of this parameter replace the RegTargetNSCLList received during the bootstrap procedure. - 2.6
RegSearchStrings string[] W Comma-separated list of strings. The list represents the string tokens used as keys when searching for this SCL instance. Sections 9.2.3.6.2 and 9.2.3.6.4 of the M2M Functional Architecture [ETSIM2MFA] describe the usage for this parameter. - 2.6
RegAccessRightID string W URI [RFC3986] that represents the identifier of the access right resource. The value of this parameter is maintained by the NSCL and used by the SCL as a default access right identifier for re-registration to NSCLs. - 2.6
RegExpirationDuration int W The duration, in seconds, that the SCL will use in its next re-registration attempt. Any negative value represents an infinite duration. -1 2.6
Reregistration boolean W The value of this parameter is not part of the device configuration and is always false when read. When set to true, triggers an immediate re-registration action where the SCL re-registers with the SCLs in the RegTargetNSCLList . - 2.6
Device.ETSIM2M.SCL.{i}.Reregistration.ActionStatus. object R This object represents the status of the Reregistration action. - 2.6
Progress unsignedInt(0:100) R

The progress, in percent, of the Reregistration action. The progress is measured from 0-100%. A value of 0 indicates that the action has not started. A value of 100 indicates that the action has completed.

Active Notification requests for this parameter MAY be denied.

 - 2.6
FinalStatus string R

The completion status of the Reregistration operation. Enumeration of: Enumeration of:

  • SUCCESS
  • FAILURE
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}. object(0:) W

This object describes the parameters necessary to administer the store-and-forward (SAF) handling policies applied to requests to access remotely hosted resources. Policies are described by instances of SAFPolicySet. Which instances of SAFPolicySet are used by the SCL is determined by the PolicyScope parameter. Section 9.3.1.5 of the M2M Functional Architecture [ETSIM2MFA] and Section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] describe the behavior for SAF processing. There is at most one SAFPolicySet instance with the PolicyScope containing a specific application id (APP-ID) URI value within the list. There is exactly one SAFPolicySet instance with a PolicyScope value of “default”.

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.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
PolicyScope string[] W Comma-separated list of strings. The parameter defines the scope of the policies contained in this instance of a SAFPolicySet. The parameter value is: *a list of unordered set of URIs [RFC3986] that represents an M2M application id (APP-ID) *the value of “default” *an empty string When this parameter is set to a list of application id (APP-ID) URIs [RFC3986], the scope indicates that the policies are applicable to requests coming from any specific application on that list. When this parameter is set to a string with the value “default”, the scope indicates that the policies are the default policies for this SCL instance. When this parameter is set to an empty string, the value represents an unknown SAFPolicySet and the SAFPolicySet is not to be used. <Empty> 2.6
ANPPolicyNumberOfEntries unsignedInt R The number of entries in the ANPPolicy table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}. object(0:) W This table contains the SAF-handling policies which are controlled by the Access Network Provider(s). 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 ANName. - 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
ANName string W This parameter is the name of the access network provider and used to determine for which access network the policies defined in the ANPPolicy table will apply. <Empty> 2.6
BlockPeriodNumberOfEntries unsignedInt R The number of entries in the BlockPeriod table. - 2.6
RequestCategoryNumberOfEntries unsignedInt R The number of entries in the RequestCategory table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.BlockPeriod.{i}. object(0:) W

This table contains a list of block periods for a ANPPolicy. A block period defines how long the device will wait before re-trying to establish connectivity via the access network after the previous attempt has failed.

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

 - 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
FailedAttempts unsignedInt W Number of consecutively failed access attempts for which the BlockDuration will be used to block the next access attempt. The SCL will apply the BlockPeriod entry with the largest number of consecutive failed attempts that is smaller or equal to the actual number of consecutive failed attempts. 0 2.6
BlockDuration int W The duration, in seconds, to which to block further access attempts. 0 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}. object(0:) W

This table contains the Request Category (RCAT) policy items for defining when it is appropriate to use the access network for processing requests.

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

 - 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
RCAT string W An RCAT is a string that represents a request category used for policy enforcement. - 2.6
ScheduleNumberOfEntries unsignedInt R The number of entries in the Schedule table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}. object(0:) W

This table contains the schedules that define when it is appropriate to use the access network for processing requests for the specified value of the RCAT. The combination of all instances of the AbsTimeSpan along with the Schedules parameter makes up the complete schedule for this instance of a Schedule. The Schedules parameter defines a recurrence of the schedule. If instances of AbsTimeSpan exist, these instances places constraints on the schedule recurrence. If the value of the Schedules parameter is an empty string, at least one enabled instance of AbsTimeSpan MUST exist. Processing behavior for the use of RCAT Schedules is defined in section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] document.

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.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
Schedules string[] W Comma-separated list of strings. The list is a set of schedule strings. A schedule string is formatted according to the date and time fields defined CRONTAB input file definition in [POSIXBase]. The Schedules parameter is used to set the recurrence of the schedule. The timezone used for this parameter is dependent upon the existence of instances of AbsTimeSpan for this Schedule. If instances of AbsTimeSpan exist, then the timezone of the AbsTimeSpan is used otherwise the UTC timezone is used for this Schedules parameter. Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in [Section 3.2.3/TR-106a5] Example of CRONTAB string: “ 0-6 * * 1-5“ would mean every minute for the period from 0:00h to 6:00h (inclusive) on any week day (Monday through Friday) and would be represented as “%200-6%20%20*%201-5” “/15 22-23,0-4 * * 1-5“ would mean every 15 minutes for the period from 22:00h to 04:00h on any week day (Monday through Friday) and would be represented as “/15%2022-23%2C0-4%20%20*%201-5” <Empty> 2.6
AbsTimeSpanNumberOfEntries unsignedInt R The number of entries in the AbsTimeSpan table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}.AbsTimeSpan.{i}. object(0:) W

This object defines an instance of a time span used for determining an RCAT schedule. An instance of the AbsTimeSpan represents the time span in which the schedule recurrence defined in Schedules is constrained. AbsTimeSpan instances with unknown values for the StartTime or EndTime are ignored. All instances of the AbsTimeSpan within this Schedule MUST utilize the same time zone.

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.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
StartTime dateTime W Date and time that represents the start of the time span. The value 0001-01-01T00:00:00Z represents an unknown value. The device MUST reject requests to set the StartTime value greater than the EndTime value. 0001-01-01T00:00:00Z 2.6
EndTime dateTime W Date and time that represents the end of the time span. The value 9999-12-31T23:59:59Z represents an infinite time span from the start time. The value 0001-01-01T00:00:00Z represents an unknown value. The device MUST reject requests to set the EndTime value less than or equal the StartTime value. 0001-01-01T00:00:00Z 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy. object R This object maintains the SAF handling policies’ properties that are controlled by the M2M service provider for a request. - 2.6
DefaultRCATValue string W The default RCAT value to use for requests to remotely hosted resources during SAF-handling when no RCAT value was specified in the request. <Empty> 2.6
RequestCategoryNumberOfEntries unsignedInt R The number of entries in the RequestCategory table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy.RequestCategory.{i}. object(0:) W

This object maintains a list of properties to be used for forwarding requests with a specified RCAT. Processing behavior for the use of M2M Service Provider policies is defined in section 10.3.1.2.2.1 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] document.

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

 - 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
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.6
RCAT string W An RCAT is a string that represents a request category used for policy enforcement. - 2.6
TolerableDelay int(-1:) W The tolerable duration, in seconds, that a request of the given RCAT category can be pending in SAF handling when a request from an M2M Application does not specify a tolerable delay. A value of -1 represents an infinite duration. 0 2.6
Thresh unsignedInt W The threshold of maximum number of pending requests permitted to be held for a specified RCAT. A value of 0 indicates that the request should be transmitted immediately. 0 2.6
Mem string W

This parameter defines the maximum size of the request queue for pending requests permitted to be held for a specified RCAT. The format of the string is an integer with an appended memory unit (B - Bytes, K - 1024 Bytes, M - 1048576 Bytes, G -1073741824, T - 1099511627776 Bytes). When the value is an empty string the memory threshold criteria for the associated RCATList will be ignored in SAF handling. Possible patterns:

  • ([0-9]{1,15}?[BKMGT])
  • <Empty> (An empty string)
 - 2.6
RankedANList string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ANPPolicy. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The list is a prioritized set of Access Networks where the preference of using an Access Network is based on order of the list items with the lowest order list item as the most preferred Access Network. <Empty> 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkInstance.{i}. object(0:) R

The M2M Area Network information provides administration capabilities for remote management (REM) of M2M Devices (D’, d) that are attached to this SCL instance. This object provides the administration of the properties needed by the SCL to remotely manage M2M Devices within a specific type of M2M Area network as defined by AreaNwkType. Multiple instances of AreaNwkInstance with the same AreaNwkType is permitted. Section 5.3.5 of the M2M Functional Architecture [ETSIM2MFA] describes the REM functionality expected of a SCL for an M2M Device.

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

 - 2.6
ID string R URI [RFC3986] that represents the identifier of the instance. - 2.6
AreaNwkType string R Devices (D’ and d) that connect to an SCL are said to be “attached devices” and are organized by M2M Area Networks within the SCL instance. The AreaNwkType is an implementation-chosen string that indicates the type of M2M Area Network. - 2.6
ListOfDevices string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the AreaNwkDeviceInfoInstance. table, or an empty string. The list represents the M2M Devices (D’, d) that are attached to this SCL instance that are within this AreaNwkInstance instance. The list does not contain an instance for this CPE. - 2.6
PropertyNumberOfEntries unsignedInt R The number of entries in the Property table. - 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkInstance.{i}.Property.{i}. object(0:) R This object contains an instance of a property extension (name value pair) for this AreaNwkInstance instance. For example, if the AreaNwkType is ZigBee the AreaNwkInstance will contain ZigBee specific parameters that have not been modeled for the M2M Area network. At a minimum, a property instance MUST exist that defines an attribute that describes the IP layer address type (e.g., IPv4, IPv6, non-IP) of this M2M Area Network. - 2.6
Name string R The name of the property - 2.6
Value string R The value of the property. - 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.{i}. object(0:) R The M2M Area Network Device Information provides the administration capability to the SCL for maintenance of M2M Devices (D’, d) that are attached to this SCL instance. While discovery and identification of devices by the M2M Gateway or Device (CPE) is implementation specific, each device is represented by an instance of the Hosts.Host table. When the M2M Device is managed by the CWMP endpoint of the CPE, the AreaNwkDeviceInfoInstance is expected to be referenced by an instance of one of the following tables: *ManagementServer.EmbeddedDevice *ManagementServer.VirtualDevice Section 5.3.5 of the M2M Functional Architecture [ETSIM2MFA] describes the REM functionality expected of a SCL to a M2M Device. This object instance provides the administration properties required by a SCL to remotely manage an instance of a M2M Device within a M2M area network. A M2M Device is associated with an instance of a AreaNwkInstance. This table contains parameters and information of the M2M Device related to each AreaNwkInstance instance. Instances of this table are created and deleted by the CPE. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device. - 2.6
AreaNwkInstance string R The value MUST be the Path Name of a row in the AreaNwkInstance. table. - 2.6
Host string[] R Comma-separated list of strings. Each list item MUST be the Path Name of the Hosts.Host table entry that represents an active or inactive M2M Device. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.6
ListOfDeviceNeighbors string[] R Comma-separated list 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 represent the reachable neighbors of this M2M Device (D’ or d). - 2.6
ListOfDeviceApplications string[] R Comma-separated list of strings. The list is an unordered set of URIs [RFC3986]. A list item is an URI string that represents an application id (APP-ID) for the M2M D’A applications residing on the M2M Device for the associated AreaNwkInstance. Table B.58 of the M2M Functional Architecture [ETSIM2MFA] describes this parameter. - 2.6
SleepInterval unsignedInt W The interval, in seconds, between sleep periods for the device. A value of 0 represents a device that does not sleep. Note: When this value is modified, the CPE could modify the SleepInterval for this M2M Device in other Area Networks. - 2.6
SleepDuration unsignedInt W The duration, in seconds, of a sleep period. The value 0 represents an unknown value. Note: When this value is modified, the CPE could modify the SleepDuration for this M2M Device in other Area Networks. - 2.6
Status string R

The sleep status of the device. Enumeration of: Enumeration of:

  • ASLEEP
  • AWAKE
 - 2.6
Active boolean R Whether or not this M2M Device is currently attached to this SCL instance. The ability to list inactive M2M Devices is OPTIONAL. If the CPE includes inactive M2MDevices in this table, Active is set to false for each inactive M2M Device. The length of time an inactive M2M Device remains listed in this table is a local matter to the CPE. - 2.6
PropertyNumberOfEntries unsignedInt R The number of entries in the Property table. - 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.{i}.Property.{i}. object(0:) R This object contains an instance of a property extension (name value pair) for this AreaNwkDeviceInfoInstance instance. For example, if the AreaNwkInstance.{i}.AreaNwkType value is ZigBee, this AreaNwkDeviceInfoInstance contains ZigBee-specific parameters that are not formally modeled for this AreaNwkDeviceInfoInstance instance. - 2.6
Name string R The name of the property - 2.6
Value string R The value of the property. - 2.6
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. object(0:) R

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

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

 - 2.7
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.7
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.7
BSSID string(:17) R [MACAddress] The BSSID used for the neighboring WiFi SSID. - 2.7
Mode string R

The mode the neighboring WiFi radio is operating in.

Enumeration of:

  • AdHoc
  • Infrastructure
 - 2.7
Channel unsignedInt(1:255) R The current radio channel used by the neighboring WiFi radio. - 2.7
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.7
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.7
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.7
OperatingFrequencyBand string R

Indicates the frequency band at which the radio this SSID instance is operating.

Enumeration of:

  • 2.4GHz
  • 5GHz
 - 2.7
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.7
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.7
OperatingChannelBandwidth string R

Indicates the bandwidth at which the channel is operating.

Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
  • Auto
 - 2.7
BeaconPeriod unsignedInt R Time interval (in ms) between transmitting beacons. - 2.7
Noise int(-200:0) R Indicator of average noise strength (in dBm) received from the neighboring WiFi radio. - 2.7
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.7
SupportedDataTransferRates string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is “1,2,5.5”, this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.7
DTIMPeriod unsignedInt R The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2012] - 2.7
Device.SelfTestDiagnostics. object R This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 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) 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
Results string(:1024) R

Results of self-test (vendor specific).

Active Notification requests for this parameter MAY be denied.

 - 2.0

Inform and Notification Requirements

Forced Inform Parameters

Parameter
Device.RootDataModelVersion
Device.DeviceInfo.HardwareVersion
Device.DeviceInfo.SoftwareVersion
Device.DeviceInfo.ProvisioningCode
Device.ManagementServer.ParameterKey
Device.ManagementServer.ConnectionRequestURL
Device.ManagementServer.AliasBasedAddressing

Forced Active Notification Parameters

Parameter
Device.DeviceInfo.SoftwareVersion
Device.DeviceInfo.ProvisioningCode

Default Active Notification Parameters

Parameter
Device.ZigBee.Interface.{i}.IEEEAddress
Device.FAP.GPS.LastScanTime
Device.GatewayInfo.ManufacturerOUI
Device.GatewayInfo.ProductClass
Device.GatewayInfo.SerialNumber
Device.ManagementServer.ConnectionRequestURL
Device.ManagementServer.ConnReqJabberID
Device.SoftwareModules.ExecutionUnit.{i}.Status

Parameters for which Active Notification MAY be Denied

Parameter
Device.DeviceInfo.
ModelName
Description
UpTime
FirstUseDate
Device.DeviceInfo.VendorConfigFile.{i}.
Alias
Device.DeviceInfo.MemoryStatus.
Free
Device.DeviceInfo.ProcessStatus.
CPUUsage
Device.DeviceInfo.ProcessStatus.Process.{i}.
Size
CPUTime
State
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.
Alias
Value
LastUpdate
Device.DeviceInfo.Processor.{i}.
Alias
Device.DeviceInfo.VendorLogFile.{i}.
Alias
Device.DeviceInfo.DeviceImageFile.{i}.
Alias
Device.Time.
CurrentLocalTime
Device.UserInterface.LocalDisplay.
PosX
PosY
Width
Height
Device.InterfaceStack.{i}.
Alias
Device.DSL.Line.{i}.
Alias
LastChange
UpstreamMaxBitRate
DownstreamMaxBitRate
UpstreamNoiseMargin
DownstreamNoiseMargin
UpstreamAttenuation
DownstreamAttenuation
UpstreamPower
DownstreamPower
Device.DSL.Line.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
DiscardPacketsSent
DiscardPacketsReceived
TotalStart
ShowtimeStart
LastShowtimeStart
CurrentDayStart
QuarterHourStart
Device.DSL.Line.{i}.Stats.Total.
ErroredSecs
SeverelyErroredSecs
Device.DSL.Line.{i}.Stats.Showtime.
ErroredSecs
SeverelyErroredSecs
Device.DSL.Line.{i}.Stats.LastShowtime.
ErroredSecs
SeverelyErroredSecs
Device.DSL.Line.{i}.Stats.CurrentDay.
ErroredSecs
SeverelyErroredSecs
Device.DSL.Line.{i}.Stats.QuarterHour.
ErroredSecs
SeverelyErroredSecs
Device.DSL.Line.{i}.TestParams.
HLOGGds
HLOGGus
HLOGpsds
HLOGpsus
HLOGMTds
HLOGMTus
QLNGds
QLNGus
QLNpsds
QLNpsus
QLNMTds
QLNMTus
SNRGds
SNRGus
SNRpsds
SNRpsus
SNRMTds
SNRMTus
LATNds
LATNus
SATNds
SATNus
Device.DSL.Channel.{i}.
Alias
LastChange
UpstreamCurrRate
DownstreamCurrRate
Device.DSL.Channel.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
DiscardPacketsSent
DiscardPacketsReceived
TotalStart
ShowtimeStart
LastShowtimeStart
CurrentDayStart
QuarterHourStart
Device.DSL.Channel.{i}.Stats.Total.
XTURFECErrors
XTUCFECErrors
XTURHECErrors
XTUCHECErrors
XTURCRCErrors
XTUCCRCErrors
Device.DSL.Channel.{i}.Stats.Showtime.
XTURFECErrors
XTUCFECErrors
XTURHECErrors
XTUCHECErrors
XTURCRCErrors
XTUCCRCErrors
Device.DSL.Channel.{i}.Stats.LastShowtime.
XTURFECErrors
XTUCFECErrors
XTURHECErrors
XTUCHECErrors
XTURCRCErrors
XTUCCRCErrors
Device.DSL.Channel.{i}.Stats.CurrentDay.
XTURFECErrors
XTUCFECErrors
XTURHECErrors
XTUCHECErrors
XTURCRCErrors
XTUCCRCErrors
Device.DSL.Channel.{i}.Stats.QuarterHour.
XTURFECErrors
XTUCFECErrors
XTURHECErrors
XTUCHECErrors
XTURCRCErrors
XTUCCRCErrors
Device.DSL.BondingGroup.{i}.
Alias
LastChange
RunningTime
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.
Alias
Device.DSL.BondingGroup.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
TotalStart
CurrentDayStart
QuarterHourStart
Device.FAST.Line.{i}.
Alias
LastChange
UpstreamMaxBitRate
DownstreamMaxBitRate
UpstreamNoiseMargin
DownstreamNoiseMargin
UpstreamAttenuation
DownstreamAttenuation
UpstreamPower
DownstreamPower
SNRMRMCds
SNRMRMCus
BITSRMCpsds
BITSRMCpsus
ETRds
ETRus
ATTETRds
ATTETRus
MINEFTR
Device.FAST.Line.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
DiscardPacketsSent
DiscardPacketsReceived
TotalStart
ShowtimeStart
LastShowtimeStart
CurrentDayStart
QuarterHourStart
Device.FAST.Line.{i}.Stats.Total.
ErroredSecs
SeverelyErroredSecs
LOSS
LORS
UAS
RTXUC
RTXTX
SuccessBSW
SuccessSRA
SuccessFRA
SuccessRPA
SuccessTIGA
Device.FAST.Line.{i}.Stats.Showtime.
ErroredSecs
SeverelyErroredSecs
LOSS
LORS
UAS
RTXUC
RTXTX
SuccessBSW
SuccessSRA
SuccessFRA
SuccessRPA
SuccessTIGA
Device.FAST.Line.{i}.Stats.LastShowtime.
ErroredSecs
SeverelyErroredSecs
LOSS
LORS
UAS
RTXUC
RTXTX
SuccessBSW
SuccessSRA
SuccessFRA
SuccessRPA
SuccessTIGA
Device.FAST.Line.{i}.Stats.CurrentDay.
ErroredSecs
SeverelyErroredSecs
LOSS
LORS
UAS
RTXUC
RTXTX
SuccessBSW
SuccessSRA
SuccessFRA
SuccessRPA
SuccessTIGA
Device.FAST.Line.{i}.Stats.QuarterHour.
ErroredSecs
SeverelyErroredSecs
LOSS
LORS
UAS
RTXUC
RTXTX
SuccessBSW
SuccessSRA
SuccessFRA
SuccessRPA
SuccessTIGA
Device.FAST.Line.{i}.TestParams.
SNRGds
SNRGus
SNRpsds
SNRpsus
SNRMTds
SNRMTus
ACTINP
NFEC
RFEC
UpstreamCurrRate
DownstreamCurrRate
ACTINPREIN
Device.Optical.Interface.{i}.
LastChange
Device.Optical.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
DiscardPacketsSent
DiscardPacketsReceived
Device.Cellular.Interface.{i}.
Status
LastChange
AvailableNetworks
RSSI
Device.Cellular.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.ATM.Link.{i}.
Alias
LastChange
Device.ATM.Link.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
TransmittedBlocks
ReceivedBlocks
CRCErrors
HECErrors
Device.PTM.Link.{i}.
Alias
LastChange
Device.PTM.Link.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Ethernet.Interface.{i}.
Alias
LastChange
CurrentBitRate
Device.Ethernet.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Ethernet.Link.{i}.
Alias
LastChange
Device.Ethernet.Link.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Ethernet.VLANTermination.{i}.
Alias
LastChange
Device.Ethernet.VLANTermination.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Ethernet.RMONStats.{i}.
DropEvents
Bytes
Packets
BroadcastPackets
MulticastPackets
CRCErroredPackets
UndersizePackets
OversizePackets
Packets64Bytes
Packets65to127Bytes
Packets128to255Bytes
Packets256to511Bytes
Packets512to1023Bytes
Packets1024to1518Bytes
Device.Ethernet.LAG.{i}.
LastChange
Device.Ethernet.LAG.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.USB.Interface.{i}.
Alias
LastChange
Device.USB.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.USB.Port.{i}.
Alias
Device.USB.USBHosts.Host.{i}.
Alias
Device.HPNA.Interface.{i}.
Alias
LastChange
TotalSyncTime
Device.HPNA.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}.
Alias
Device.HPNA.Interface.{i}.AssociatedDevice.{i}.
TotalSyncTime
Device.MoCA.Interface.{i}.
Alias
LastChange
Device.MoCA.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.MoCA.Interface.{i}.QoS.FlowStats.{i}.
LeaseTimeLeft
FlowPackets
Device.MoCA.Interface.{i}.AssociatedDevice.{i}.
RxPowerLevel
RxBcastPowerLevel
TxPackets
RxPackets
Device.Ghn.Interface.{i}.
LastChange
Device.Ghn.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
MgmtBytesSent
MgmtBytesReceived
MgmtPacketsSent
MgmtPacketsReceived
BlocksSent
BlocksReceived
BlocksResent
BlocksErrorsReceived
Device.Ghn.Interface.{i}.AssociatedDevice.{i}.
TxPhyRate
RxPhyRate
Device.HomePlug.Interface.{i}.
Alias
LastChange
Device.HomePlug.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.UPA.Interface.{i}.
Alias
LastChange
Device.UPA.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.UPA.Interface.{i}.ActiveNotch.{i}.
Alias
Device.UPA.Interface.{i}.BridgeFor.{i}.
Alias
Device.WiFi.Radio.{i}.
Alias
LastChange
ChannelsInUse
ChannelLastChange
Device.WiFi.Radio.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
DiscardPacketsSent
DiscardPacketsReceived
Device.WiFi.SSID.{i}.
Alias
LastChange
Device.WiFi.SSID.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.WiFi.AccessPoint.{i}.
Alias
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.
MACAddress
AuthenticationState
LastDataDownlinkRate
LastDataUplinkRate
Device.WiFi.EndPoint.{i}.
Alias
Device.WiFi.EndPoint.{i}.Stats.
LastDataDownlinkRate
LastDataUplinkRate
Device.WiFi.EndPoint.{i}.Profile.{i}.
Alias
Device.ZigBee.Interface.{i}.
Alias
LastChange
Device.ZigBee.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownPacketsReceived
Device.ZigBee.ZDO.{i}.
Alias
Device.ZigBee.ZDO.{i}.Network.Neighbor.{i}.
LQI
Device.ZigBee.ZDO.{i}.NodeManager.RoutingTable.{i}.
NextHopAddress
Status
Device.ZigBee.ZDO.{i}.Binding.{i}.
Alias
Device.ZigBee.ZDO.{i}.Group.{i}.
Alias
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}.
Alias
Device.ZigBee.Discovery.AreaNetwork.{i}.
Alias
Device.Bridging.
MaxFilterEntries
Device.Bridging.Bridge.{i}.
Alias
Device.Bridging.Bridge.{i}.Port.{i}.
Alias
LastChange
Device.Bridging.Bridge.{i}.Port.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.Bridging.Bridge.{i}.VLAN.{i}.
Alias
Device.Bridging.Bridge.{i}.VLANPort.{i}.
Alias
Device.Bridging.Filter.{i}.
Alias
Device.PPP.Interface.{i}.
Alias
LastChange
CurrentMRUSize
Device.PPP.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
Device.IP.Interface.{i}.
Alias
LastChange
Device.IP.Interface.{i}.IPv4Address.{i}.
Alias
Device.IP.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
UnknownProtoPacketsReceived
Device.IP.Interface.{i}.TWAMPReflector.{i}.
Alias
Device.IP.Interface.{i}.IPv6Address.{i}.
Alias
Device.IP.Interface.{i}.IPv6Prefix.{i}.
Alias
Device.IP.Diagnostics.UDPEchoConfig.
PacketsReceived
PacketsResponded
BytesReceived
BytesResponded
TimeFirstPacketReceived
TimeLastPacketReceived
Device.GRE.Tunnel.{i}.
Alias
Device.GRE.Tunnel.{i}.Interface.{i}.
Alias
LastChange
Device.L2TPv3.Tunnel.{i}.
Alias
Device.L2TPv3.Tunnel.{i}.Interface.{i}.
Alias
LastChange
Device.VXLAN.Tunnel.{i}.
Alias
Device.VXLAN.Tunnel.{i}.Interface.{i}.
Alias
LastChange
Device.MAP.Domain.{i}.
Alias
Device.MAP.Domain.{i}.Rule.{i}.
Alias
Device.MAP.Domain.{i}.Interface.
Alias
LastChange
Device.MAP.Domain.{i}.Interface.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
UnknownProtoPacketsReceived
Device.Routing.Router.{i}.
Alias
Device.Routing.Router.{i}.IPv4Forwarding.{i}.
Alias
Device.Routing.Router.{i}.IPv6Forwarding.{i}.
Alias
Device.Routing.RIP.InterfaceSetting.{i}.
Alias
Device.NeighborDiscovery.InterfaceSetting.{i}.
Alias
Device.RouterAdvertisement.InterfaceSetting.{i}.
Alias
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}.
Alias
Device.IPv6rd.InterfaceSetting.{i}.
Alias
Device.DSLite.InterfaceSetting.{i}.
Alias
Device.QoS.
MaxClassificationEntries
MaxAppEntries
MaxFlowEntries
MaxPolicerEntries
MaxQueueEntries
MaxShaperEntries
Device.QoS.Classification.{i}.
Alias
Device.QoS.App.{i}.
Alias
Device.QoS.Flow.{i}.
Alias
Device.QoS.Policer.{i}.
Alias
PossibleMeterTypes
TotalCountedPackets
TotalCountedBytes
ConformingCountedPackets
ConformingCountedBytes
PartiallyConformingCountedPackets
PartiallyConformingCountedBytes
NonConformingCountedPackets
NonConformingCountedBytes
Device.QoS.Queue.{i}.
Alias
Device.QoS.QueueStats.{i}.
Alias
OutputPackets
OutputBytes
DroppedPackets
DroppedBytes
QueueOccupancyPackets
QueueOccupancyPercentage
Device.QoS.Shaper.{i}.
Alias
Device.Hosts.Host.{i}.WANStats.
DiscardPacketsSent
Device.DNS.Client.Server.{i}.
Alias
Device.DNS.Relay.Forwarding.{i}.
Alias
Device.NAT.InterfaceSetting.{i}.
Alias
Device.NAT.PortMapping.{i}.
Alias
LeaseDuration
Device.PCP.Client.{i}.
Alias
Device.PCP.Client.{i}.Server.{i}.
Alias
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.
Alias
Lifetime
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.Filter.{i}.
Alias
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}.
Alias
Device.DHCPv4.Client.{i}.
Alias
LeaseTimeRemaining
Device.DHCPv4.Client.{i}.SentOption.{i}.
Alias
Device.DHCPv4.Client.{i}.ReqOption.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.Option.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.Client.{i}.
Alias
Device.DHCPv4.Relay.Forwarding.{i}.
Alias
Device.DHCPv6.Client.{i}.
Alias
Device.DHCPv6.Client.{i}.SentOption.{i}.
Alias
Device.DHCPv6.Server.Pool.{i}.
Alias
Device.DHCPv6.Server.Pool.{i}.Client.{i}.
Alias
Device.DHCPv6.Server.Pool.{i}.Option.{i}.
Alias
Device.IEEE8021x.Supplicant.{i}.
Alias
Device.Users.User.{i}.
Alias
Device.SmartCardReaders.SmartCardReader.{i}.
Alias
DecryptionFailedCounter
DecryptionFailedNoKeyCounter
Device.Firewall.Level.{i}.
Alias
Device.Firewall.Chain.{i}.
Alias
Device.Firewall.Chain.{i}.Rule.{i}.
Alias
Device.PeriodicStatistics.SampleSet.{i}.
Alias
SampleSeconds
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Alias
SampleSeconds
SuspectData
Values
Device.FAP.GPS.
LastSuccessfulScanTime
LockedLatitude
LockedLongitude
NumberOfSatellites
Device.FAP.GPS.ContinuousGPSStatus.
CurrentFix
GotFix
TimingGood
Latitude
Longitude
Elevation
LastFixTime
LastFixDuration
SatellitesTracked
ReceiverStatus
LocationType
Device.IEEE1905.AL.
LastChange
Device.IEEE1905.AL.Interface.{i}.
LastChange
InterfaceStackReference
Device.IEEE1905.AL.Interface.{i}.Link.{i}.Metric.
PacketErrors
PacketErrorsReceived
TransmittedPackets
PacketsReceived
MACThroughputCapacity
LinkAvailability
PHYRate
RSSI
Device.MQTT.Client.{i}.
Alias
Device.MQTT.Client.{i}.Subscription.{i}.
Alias
Device.MQTT.Client.{i}.Stats.
BrokerConnectionEstablished
LastPublishMessageSent
LastPublishMessageReceived
PublishSent
PublishReceived
SubscribeSent
UnSubscribeSent
MQTTMessagesSent
MQTTMessagesReceived
ConnectionErrors
Device.MQTT.Broker.{i}.
Alias
Device.MQTT.Broker.{i}.Bridge.{i}.
Alias
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}.
Alias
Device.MQTT.Broker.{i}.Stats.
Subscriptions
PublishSent
PublishReceived
MQTTMessagesSent
MQTTMessagesReceived
ConnectionErrors
Device.DynamicDNS.Client.{i}.
Alias
Device.DynamicDNS.Server.{i}.
Alias
Device.LEDs.LED.{i}.
Alias
Reason
CyclePeriodRepetitions
Device.LEDs.LED.{i}.CycleElement.{i}.
Alias
Device.LEDs.LED.{i}.CurrentCycleElement.
CycleElementReference
Color
Duration
Device.BASAPM.MeasurementEndpoint.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.
Alias
Storage
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats.
Invocations
Suppressions
Overlaps
Failures
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.
Alias
Storage
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Stats.
Invocations
Suppressions
Overlaps
Failures
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Task.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}.
Alias
Device.LMAP.Event.{i}.
Alias
Device.DeviceInfo.SupportedDataModel.{i}.
Alias
Device.ManagementServer.
ParameterKey
Device.ManagementServer.ManageableDevice.{i}.
ManufacturerOUI
SerialNumber
ProductClass
Device.ManagementServer.DownloadAvailability.Announcement.Group.{i}.
Alias
Device.SoftwareModules.ExecEnv.{i}.
Alias
AvailableDiskSpace
AvailableMemory
ActiveExecutionUnits
Device.SoftwareModules.DeploymentUnit.{i}.
Alias
Status
Device.SoftwareModules.ExecutionUnit.{i}.
Alias
DiskSpaceInUse
MemoryInUse
Device.ETSIM2M.SCL.{i}.Reregistration.ActionStatus.
Progress
Device.DSL.Diagnostics.ADSLLineTest.
ACTPSDds
ACTPSDus
ACTATPds
ACTATPus
HLINSCds
HLINSCus
HLINGds
HLINGus
HLOGGds
HLOGGus
HLOGpsds
HLOGpsus
HLOGMTds
HLOGMTus
LATNpbds
LATNpbus
SATNds
SATNus
HLINpsds
HLINpsus
QLNGds
QLNGus
QLNpsds
QLNpsus
QLNMTds
QLNMTus
SNRGds
SNRGus
SNRpsds
SNRpsus
SNRMTds
SNRMTus
BITSpsds
BITSpsus
Device.ATM.Diagnostics.F5Loopback.
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
Device.Ghn.Diagnostics.PHYThroughput.Result.{i}.
TxPhyRate
RxPhyRate
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
MgmtBytesSent
MgmtBytesReceived
MgmtPacketsSent
MgmtPacketsReceived
BlocksSent
BlocksReceived
BlocksResent
BlocksErrorsReceived
Device.IP.Diagnostics.IPPing.
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
AverageResponseTimeDetailed
MinimumResponseTimeDetailed
MaximumResponseTimeDetailed
Device.IP.Diagnostics.TraceRoute.
ResponseTime
RouteHopsNumberOfEntries
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}.
Host
HostAddress
ErrorCode
Device.IP.Diagnostics.DownloadDiagnostics.
IPAddressUsed
ROMTime
BOMTime
EOMTime
TCPOpenRequestTime
TCPOpenResponseTime
EnablePerConnectionResults
Device.IP.Diagnostics.DownloadDiagnostics.PerConnectionResult.{i}.
ROMTime
BOMTime
EOMTime
TestBytesReceived
TotalBytesReceived
TotalBytesSent
TCPOpenRequestTime
TCPOpenResponseTime
Device.IP.Diagnostics.DownloadDiagnostics.IncrementalResult.{i}.
TestBytesReceived
StartTime
EndTime
Device.IP.Diagnostics.UploadDiagnostics.
ROMTime
BOMTime
EOMTime
TCPOpenRequestTime
TCPOpenResponseTime
EnablePerConnectionResults
Device.IP.Diagnostics.UploadDiagnostics.PerConnectionResult.{i}.
ROMTime
BOMTime
EOMTime
TestBytesSent
TotalBytesReceived
TotalBytesSent
TCPOpenRequestTime
TCPOpenResponseTime
Device.IP.Diagnostics.UploadDiagnostics.IncrementalResult.{i}.
TestBytesSent
StartTime
EndTime
Device.IP.Diagnostics.UDPEchoDiagnostics.
DiagnosticsState
Host
Port
NumberOfRepetitions
Timeout
DataBlockSize
DSCP
InterTransmissionTime
EnableIndividualPacketResults
UDPEchoDiagnosticsMaxResults
Device.IP.Diagnostics.ServerSelectionDiagnostics.
DiagnosticsState
FastestHost
MinimumResponseTime
AverageResponseTime
MaximumResponseTime
Device.DNS.Diagnostics.NSLookupDiagnostics.
DiagnosticsState
SuccessCount
ResultNumberOfEntries
Device.DNS.Diagnostics.NSLookupDiagnostics.Result.{i}.
Status
AnswerType
HostNameReturned
IPAddresses
DNSServerIP
ResponseTime
Device.SelfTestDiagnostics.
DiagnosticsState
Results

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

UDPEcho:1 Profile

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

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

UDPEchoPlus:1 Profile

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

Name Requirement
Device.IP.Diagnostics.UDPEchoConfig. P
EchoPlusEnabled W

MemoryStatus:1 Profile

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

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

ProcessStatus:1 Profile

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

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

TempStatus:1 Profile

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

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

User:1 Profile

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

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

UPnPDev:1 Profile

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

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

UPnPDiscBasic:1 Profile

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

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

UPnPDiscAdv:1 Profile

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

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

UPnPDiscAdv:2 Profile

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

Name Requirement
Device.UPnP.Discovery.Device.{i}. P
LastUpdate R
Host R
Device.UPnP.Discovery.Service.{i}. P
LastUpdate R
Host R
ParentDevice R

SimpleFirewall:1 Profile

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

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

AdvancedFirewall:1 Profile

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

Name Requirement
Device.Firewall. P
AdvancedLevel W
Type R
LevelNumberOfEntries R
ChainNumberOfEntries R
Device.Firewall.Level.{i}. C
Alias W
Name R
Order W
Chain R
DefaultPolicy W
DefaultLogPolicy W
Device.Firewall.Chain.{i}. C
Enable W
Alias W
Name W
Creator R
RuleNumberOfEntries R
Device.Firewall.Chain.{i}.Rule.{i}. C
Enable W
Status R
Order W
Alias W
Target W
TargetChain W
SourceInterface W
SourceInterfaceExclude W
SourceAllInterfaces W
DestInterface W
DestInterfaceExclude W
DestAllInterfaces W
IPVersion W
DestIP W
DestMask W
DestIPExclude W
SourceIP W
SourceMask W
SourceIPExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortRangeMax W
DestPortExclude W
SourcePort W
SourcePortRangeMax W
SourcePortExclude W

USBHostsBasic:1 Profile

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

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

PeriodicStatsBase:1 Profile

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

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

Optical:1 Profile

This table defines the Optical:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.Optical. P
InterfaceNumberOfEntries R
Device.Optical.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
OpticalSignalLevel R
TransmitOpticalLevel R
Device.Optical.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

EthernetRMONStats:1 Profile

This table defines the EthernetRMONStats:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.Ethernet. P
RMONStatsNumberOfEntries R
Device.Ethernet.RMONStats.{i}. P
Enable W
Status R
Interface R
Bytes R
Packets R
CRCErroredPackets R

Ghn:1 Profile

This table defines the Ghn:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.Ghn. P
InterfaceNumberOfEntries R
Device.Ghn.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
FirmwareVersion R
TargetDomainNames W
DomainName R
DomainNameIdentifier R
DomainId R
DeviceId R
MaxBitRate R
NodeTypeDMCapable R
NodeTypeSCCapable R
NodeTypeDMConfig R
NodeTypeDMStatus R
NodeTypeSCStatus R
AssociatedDeviceNumberOfEntries R
Device.Ghn.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
Device.Ghn.Interface.{i}.AssociatedDevice.{i}. P
MACAddress R
DeviceId R
TxPhyRate R
RxPhyRate R
Active R

DNSRelay:1 Profile

This table defines the DNSRelay:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DNS. P
Device.DNS.Relay. P
Enable W
Status R
ForwardNumberOfEntries R
Device.DNS.Relay.Forwarding.{i}. C
Enable W
Status R
DNSServer W
Interface W
Type R

Routing:1 Profile

This table defines the Routing:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Routing. P
RouterNumberOfEntries R
Device.Routing.RIP. P
Enable W
SupportedModes R
InterfaceSettingNumberOfEntries R
Device.Routing.RIP.InterfaceSetting.{i}. C
Enable W
Status R
Interface W
AcceptRA W
SendRA W
Device.Routing.Router.{i}. C
Enable W
Status R
IPv4ForwardingNumberOfEntries R
Device.Routing.Router.{i}.IPv4Forwarding.{i}. C
Enable W
Status R
DestIPAddress W
DestSubnetMask W
GatewayIPAddress W
Interface W
ForwardingMetric W
StaticRoute R

Routing:2 Profile

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

Name Requirement
Device.Routing.Router.{i}.IPv4Forwarding.{i}. C
Origin R

IPv6Routing:1 Profile

This table defines the IPv6Routing:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.Routing. P
RouterNumberOfEntries R
Device.Routing.RIP. P
Enable W
SupportedModes R
InterfaceSettingNumberOfEntries R
Device.Routing.RIP.InterfaceSetting.{i}. C
Enable W
Status R
Interface W
AcceptRA W
SendRA W
Device.Routing.RouteInformation. P
Enable W
InterfaceSettingNumberOfEntries R
Device.Routing.RouteInformation.InterfaceSetting.{i}. P
Status R
Interface R
SourceRouter R
PreferredRouteFlag R
Prefix R
RouteLifetime R
Device.Routing.Router.{i}. C
Enable W
Status R
IPv6ForwardingNumberOfEntries R
Device.Routing.Router.{i}.IPv6Forwarding.{i}. C
Enable W
Status R
DestIPPrefix W
NextHop W
Interface W
ForwardingMetric W
Origin R

VLANTermination:1 Profile

This table defines the VLANTermination:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Ethernet. P
VLANTerminationNumberOfEntries R
Device.Ethernet.VLANTermination.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
VLANID W
Device.Ethernet.VLANTermination.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

EthernetLink:1 Profile

This table defines the EthernetLink:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Ethernet. P
LinkNumberOfEntries R
Device.Ethernet.Link.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
MACAddress R
Device.Ethernet.Link.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

Bridge:1 Profile

This table defines the Bridge:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Bridging. P
MaxBridgeEntries R
MaxDBridgeEntries R
BridgeNumberOfEntries R
Device.Bridging.Bridge.{i}. P
Enable W
Status R
PortNumberOfEntries R
Device.Bridging.Bridge.{i}.Port.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
ManagementPort W
PortState R
Device.Bridging.Bridge.{i}.Port.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

VLANBridge:1 Profile

This table defines the VLANBridge:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Bridging. P
MaxBridgeEntries R
MaxDBridgeEntries R
MaxQBridgeEntries R
MaxVLANEntries R
BridgeNumberOfEntries R
Device.Bridging.Bridge.{i}. C
Enable W
Status R
Standard W
PortNumberOfEntries R
VLANNumberOfEntries R
VLANPortNumberOfEntries R
Device.Bridging.Bridge.{i}.Port.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
ManagementPort W
DefaultUserPriority W
PriorityRegeneration W
PortState R
PVID W
AcceptableFrameTypes W
IngressFiltering W
PriorityTagging W
Device.Bridging.Bridge.{i}.Port.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R
Device.Bridging.Bridge.{i}.VLAN.{i}. C
Enable W
Name W
VLANID W
Device.Bridging.Bridge.{i}.VLANPort.{i}. C
Enable W
VLAN W
Port W
Untagged W

BridgeFilter:1 Profile

This table defines the BridgeFilter:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Bridging. P
MaxFilterEntries R
FilterNumberOfEntries R
Device.Bridging.Filter.{i}. C
Enable W
Status R
Bridge W
Order W
Interface W
VLANIDFilter W
EthertypeFilterList W
EthertypeFilterExclude W
SourceMACAddressFilterList W
SourceMACAddressFilterExclude W
DestMACAddressFilterList W
DestMACAddressFilterExclude W
SourceMACFromVendorClassIDFilter W
SourceMACFromVendorClassIDFilterExclude W
SourceMACFromVendorClassIDMode W
DestMACFromVendorClassIDFilter W
DestMACFromVendorClassIDFilterExclude W
DestMACFromVendorClassIDMode W
SourceMACFromClientIDFilter W
SourceMACFromClientIDFilterExclude W
DestMACFromClientIDFilter W
DestMACFromClientIDFilterExclude W
SourceMACFromUserClassIDFilter W
SourceMACFromUserClassIDFilterExclude W
DestMACFromUserClassIDFilter W
DestMACFromUserClassIDFilterExclude W

BridgeFilter:2 Profile

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

Name Requirement
Device.Bridging.Filter.{i}. C
DHCPType W

BridgeL3L4Filter:1 Profile

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

Name Requirement
Device.Bridging.Filter.{i}. C
DestIP W
DestMask W
DestIPExclude W
SourcePort W
SourcePortRangeMax W
SourceIP W
SourceMask W
SourceIPExclude W
SourcePortExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortExclude W

ATMLink:1 Profile

This table defines the ATMLink:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.ATM. P
LinkNumberOfEntries R
Device.ATM.Link.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
LinkType W
DestinationAddress W
Encapsulation W
FCSPreserved W
VCSearchList W
AAL R
Device.ATM.Link.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R
TransmittedBlocks R
ReceivedBlocks R
CRCErrors R
HECErrors R

PTMLink:1 Profile

This table defines the PTMLink:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.PTM. P
LinkNumberOfEntries R
Device.PTM.Link.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
MACAddress R
Device.PTM.Link.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

EthernetInterface:1 Profile

This table defines the EthernetInterface:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Ethernet. P
InterfaceNumberOfEntries R
Device.Ethernet.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
MaxBitRate W
DuplexMode W
Device.Ethernet.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

EthernetInterface:2 Profile

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

Name Requirement
Device.Ethernet.Interface.{i}. P
CurrentBitRate R

ProviderBridge:1 Profile

This table defines the ProviderBridge:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.Bridging. P
MaxProviderBridgeEntries R
ProviderBridgeNumberOfEntries R
Device.Bridging.Bridge.{i}.Port.{i}. C
ServiceAccessPrioritySelection W
ServiceAccessPriorityTranslation W
Type W
TPID W
Device.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. P
PCPSelection W
UseDEI W
RequireDropEncoding W
PCPEncoding W
PCPDecoding W
Device.Bridging.ProviderBridge.{i}. C
Enable W
Status R
Type W
SVLANcomponent W
CVLANcomponents W
Device.Ethernet.VLANTermination.{i}. C
TPID W

ProviderBridgeQoS:1 Profile

This table defines the ProviderBridgeQoS:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.QoS. P
DefaultInnerEthernetPriorityMark W
Device.QoS.Classification.{i}. C
InnerEthernetPriorityCheck W
InnerEthernetPriorityExclude W
InnerEthernetPriorityMark W
EthernetDEICheck W
EthernetDEIExclude W

ADSL:1 Profile

This table defines the ADSL:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL. P
LineNumberOfEntries R
ChannelNumberOfEntries R
Device.DSL.Line.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
UpstreamMaxBitRate R
DownstreamMaxBitRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamAttenuation R
DownstreamAttenuation R
UpstreamPower R
DownstreamPower R
XTURVendor R
XTURCountry R
XTUCVendor R
XTUCCountry R
Device.DSL.Line.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
TotalStart R
ShowtimeStart R
Device.DSL.Line.{i}.Stats.Total. P
ErroredSecs R
SeverelyErroredSecs R
Device.DSL.Line.{i}.Stats.Showtime. P
ErroredSecs R
SeverelyErroredSecs R
Device.DSL.Channel.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
UpstreamCurrRate R
DownstreamCurrRate R
Device.DSL.Channel.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
TotalStart R
ShowtimeStart R
Device.DSL.Channel.{i}.Stats.Total. P
XTURFECErrors R
XTUCFECErrors R
XTURHECErrors R
XTUCHECErrors R
XTURCRCErrors R
XTUCCRCErrors R
Device.DSL.Channel.{i}.Stats.Showtime. P
XTURFECErrors R
XTUCFECErrors R
XTURHECErrors R
XTUCHECErrors R
XTURCRCErrors R
XTUCCRCErrors R

ADSL2:1 Profile

This table defines the ADSL2:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL. P
LineNumberOfEntries R
ChannelNumberOfEntries R
Device.DSL.Line.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
StandardsSupported R
StandardUsed R
UpstreamMaxBitRate R
DownstreamMaxBitRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamPower R
DownstreamPower R
Device.DSL.Line.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.DSL.Line.{i}.TestParams. P
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNds R
LATNus R
SATNds R
SATNus R
Device.DSL.Channel.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
LinkEncapsulationSupported R
LinkEncapsulationUsed R
Device.DSL.Channel.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
TotalStart R
ShowtimeStart R

ADSL2:2 Profile

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

Name Requirement
Device.DSL.Line.{i}. P
XTSE R
XTSUsed R
Device.DSL.Channel.{i}. P
ACTNDR R

VDSL2:1 Profile

This table defines the VDSL2:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL. P
LineNumberOfEntries R
ChannelNumberOfEntries R
Device.DSL.Line.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
StandardsSupported R
StandardUsed R
AllowedProfiles R
CurrentProfile R
UPBOKLE R
UpstreamMaxBitRate R
DownstreamMaxBitRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamAttenuation R
DownstreamAttenuation R
UpstreamPower R
DownstreamPower R
TRELLISds R
TRELLISus R
ACTSNRMODEds R
ACTSNRMODEus R
ACTUALCE R
SNRMpbds R
SNRMpbus R
Device.DSL.Line.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.DSL.Line.{i}.TestParams. P
HLOGGds R
HLOGGus R
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNGds R
QLNGus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRGds R
SNRGus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNds R
LATNus R
SATNds R
SATNus R
Device.DSL.Channel.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
LinkEncapsulationSupported R
LinkEncapsulationUsed R
Device.DSL.Channel.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
TotalStart R
ShowtimeStart R

VDSL2:2 Profile

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

Name Requirement
Device.DSL.Line.{i}. P
XTSE R
XTSUsed R
UPBOKLEPb R
UPBOKLERPb R
ACTRAMODEds R
ACTRAMODEus R
ACTINPROCds R
ACTINPROCus R
SNRMROCds R
SNRMROCus R
Device.DSL.Channel.{i}. P
ACTNDR R

VDSL2:3 Profile

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

Name Requirement
Device.DSL.Line.{i}. P
UpstreamAttenuation R1
DownstreamAttenuation R2

1 This parameter is DELETED.
2 This parameter is DELETED.

CellularInterfaceBase:1 Profile

This table defines the CellularInterfaceBase:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.Cellular. P
InterfaceNumberOfEntries R
AccessPointNumberOfEntries R
Device.Cellular.Interface.{i}. P
Enable W
Status R
NetworkInUse R
CurrentAccessTechnology R
Device.Cellular.Interface.{i}.USIM. P
Status R
MSISDN R
Device.Cellular.AccessPoint.{i}. C
Enable W
Interface W
APN W

CellularInterfaceExtended:1 Profile

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

Name Requirement
Device.Cellular. P
RoamingEnabled W
RoamingStatus R
Device.Cellular.Interface.{i}. P
Alias W
Name R
LastChange R
IMEI R
SupportedAccessTechnologies R
PreferredAccessTechnology W
NetworkRequested R
AvailableNetworks R
Device.Cellular.Interface.{i}.USIM. P
IMSI R
ICCID R

CellularInterfaceStats:1 Profile

This table defines the CellularInterfaceStats:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.Cellular.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

LLDPBaseline:1 Profile

This table defines the LLDPBaseline:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.LLDP. P
Device.LLDP.Discovery. P
DeviceNumberOfEntries R
Device.LLDP.Discovery.Device.{i}. P
Interface R
ChassisIDSubtype R
ChassisID R
Host R
PortNumberOfEntries R
Device.LLDP.Discovery.Device.{i}.Port.{i}. P
PortIDSubtype R
PortID R
TTL R
PortDescription R
LastUpdate R
MACAddressList R

LLDPRemOrgDefInfo:1 Profile

This table defines the LLDPRemOrgDefInfo:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.LLDP.Discovery.Device.{i}.Port.{i}.LinkInformation. P
InterfaceType R
MACForwardingTable R
Device.LLDP.Discovery.Device.{i}.DeviceInformation. P
DeviceCategory R
ManufacturerOUI R
ModelName R
ModelNumber R
VendorSpecificNumberOfEntries R
Device.LLDP.Discovery.Device.{i}.DeviceInformation.VendorSpecific.{i}. P
OrganizationCode R
InformationType R
Information R

GREBasic:1 Profile

This table defines the GREBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.GRE. P
TunnelNumberOfEntries R
Device.GRE.Tunnel.{i}. C
Enable W
Status R
RemoteEndpoints W
KeepAlivePolicy W
KeepAliveTimeout W
KeepAliveThreshold W
DeliveryHeaderProtocol W
ConnectedRemoteEndpoint R
InterfaceNumberOfEntries R
Device.GRE.Tunnel.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.GRE.Tunnel.{i}.Interface.{i}. C
Enable W
Status R
Name R
LastChange R
LowerLayers R
ProtocolIdOverride W
UseChecksum W
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

GREAdv:1 Profile

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

Name Requirement
Device.GRE. P
FilterNumberOfEntries R
Device.GRE.Tunnel.{i}.Stats. P
KeepAliveSent R
KeepAliveReceived R
Device.GRE.Tunnel.{i}.Interface.{i}. C
KeyIdentifierGenerationPolicy W
KeyIdentifier W
UseSequenceNumber W
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. P
DiscardChecksumReceived R
DiscardSequenceNumberReceived R
Device.GRE.Filter.{i}. C
Enable W
Status R
Order W
Interface W
AllInterfaces W
VLANIDCheck W
VLANIDExclude W
DSCPMarkPolicy W

MAPBasic:1 Profile

This table defines the MAPBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.MAP. P
Enable W
DomainNumberOfEntries R
Device.MAP.Domain.{i}. P
Enable W
Status R
TransportMode R
WANInterface R
IPv6Prefix W
BRIPv6Prefix W
RuleNumberOfEntries R
Device.MAP.Domain.{i}.Rule.{i}. C
Enable W
Status R
IPv6Prefix W
IPv4Prefix W
IsFMR W
Device.MAP.Domain.{i}.Interface. P

MAPAdv:1 Profile

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

Name Requirement
Device.MAP.Domain.{i}. P
PSIDOffset W
PSIDLength W
PSID W
IncludeSystemPorts W
Device.MAP.Domain.{i}.Rule.{i}. C
EABitsLength W

BondedDSL:1 Profile

This table defines the BondedDSL:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL. P
BondingGroupNumberOfEntries R
Device.DSL.BondingGroup.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers R
GroupStatus R
BondScheme R
GroupCapacity R
RunningTime R
BondedChannelNumberOfEntries R
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. P
Channel R
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet. P
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet.Stats. P
UnderflowErrorsSent R
CRCErrorsReceived R
AlignmentErrorsReceived R
ShortPacketsReceived R
LongPacketsReceived R
OverflowErrorsReceived R
PauseFramesReceived R
FramesDropped R
Device.DSL.BondingGroup.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
TotalStart R
CurrentDayStart R
QuarterHourStart R
Device.DSL.BondingGroup.{i}.Stats.Total. P
FailureReasons R
UpstreamRate R
DownstreamRate R
UpstreamPacketLoss R
DownstreamPacketLoss R
FailureCount R
ErroredSeconds R
SeverelyErroredSeconds R
UnavailableSeconds R
Device.DSL.BondingGroup.{i}.Stats.CurrentDay. P
FailureReasons R
UpstreamRate R
DownstreamRate R
UpstreamPacketLoss R
DownstreamPacketLoss R
FailureCount R
ErroredSeconds R
SeverelyErroredSeconds R
UnavailableSeconds R
Device.DSL.BondingGroup.{i}.Stats.QuarterHour. P
FailureReasons R
UpstreamRate R
DownstreamRate R
UpstreamPacketLoss R
DownstreamPacketLoss R
FailureCount R
ErroredSeconds R
SeverelyErroredSeconds R
UnavailableSeconds R
Device.DSL.BondingGroup.{i}.Ethernet. P
Device.DSL.BondingGroup.{i}.Ethernet.Stats. P
PAFErrors R
PAFSmallFragments R
PAFLargeFragments R
PAFBadFragments R
PAFLostFragments R
PAFLateFragments R
PAFLostStarts R
PAFLostEnds R
PAFOverflows R
PauseFramesSent R
CRCErrorsReceived R
AlignmentErrorsReceived R
ShortPacketsReceived R
LongPacketsReceived R
OverflowErrorsReceived R
FramesDropped R

HPNA:1 Profile

This table defines the HPNA:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.HPNA. P
InterfaceNumberOfEntries R
Device.HPNA.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
FirmwareVersion R
MaxBitRate R
NetworkUtilization R
PossibleConnectionTypes R
ConnectionType R
PossibleSpectralModes R
SpectralMode R
MTU R
NoiseMargin R
MinMulticastRate R
NegMulticastRate R
MasterSelectionMode R
AssociatedDeviceNumberOfEntries R
Device.HPNA.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
Device.HPNA.Interface.{i}.AssociatedDevice.{i}. P
MACAddress R
NodeID R
IsMaster R
Synced R
TotalSyncTime R
Active R
MaxBitRate R
PHYDiagnosticsEnable W

HomePlug:1 Profile

This table defines the HomePlug:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.HomePlug. P
InterfaceNumberOfEntries R
Device.HomePlug.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
LogicalNetwork W
Version R
FirmwareVersion R
ForceCCo W
NetworkPassword W
OtherNetworksPresent R
MaxBitRate R
AssociatedDeviceNumberOfEntries R
Device.HomePlug.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
MPDUTxAck R
MPDUTxCol R
MPDUTxFailed R
MPDURxAck R
MPDURxFailed R
Device.HomePlug.Interface.{i}.AssociatedDevice.{i}. P
MACAddress R
TxPhyRate R
RxPhyRate R
SNRPerTone R
AvgAttenuation R
EndStationMACs R
Active R

MoCA:1 Profile

This table defines the MoCA:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.MoCA. P
InterfaceNumberOfEntries R
Device.MoCA.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
FirmwareVersion R
MaxBitRate R
HighestVersion R
CurrentVersion R
NetworkCoordinator R
PrivacyEnabledSetting W
PrivacyEnabled R
FreqCapabilityMask R
FreqCurrentMaskSetting W
FreqCurrentMask R
CurrentOperFreq R
KeyPassphrase W
NodeID R
AssociatedDeviceNumberOfEntries R
Device.MoCA.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R

UPA:1 Profile

This table defines the UPA:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.UPA. P
InterfaceNumberOfEntries R
Device.UPA.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
FirmwareVersion R
MaxBitRate R
NodeType W
LogicalNetwork W
EncryptionMethod W
EncryptionKey W
EstApplicationThroughput R
ActiveNotchEnable W
ActiveNotchNumberOfEntries R
AssociatedDeviceNumberOfEntries R
Device.UPA.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
Device.UPA.Interface.{i}.ActiveNotch.{i}. C
Enable W
StartFreq W
StopFreq W
Depth W
Device.UPA.Interface.{i}.AssociatedDevice.{i}. P
MACAddress R
Port R
LogicalNetwork R
PhyTxThroughput R
PhyRxThroughput R
RealPhyRxThroughput R
EstimatedPLR R
MeanEstimatedAtt R
Active R

WiFiRadio:1 Profile

This table defines the WiFiRadio:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.WiFi. P
RadioNumberOfEntries R
Device.WiFi.Radio.{i}. P
Enable W
Status R
Alias W
Name R
Upstream R
MaxBitRate R
SupportedFrequencyBands R
OperatingFrequencyBand W
SupportedStandards R
OperatingStandards W
RegulatoryDomain W
PossibleChannels R
Channel W
AutoChannelSupported R
AutoChannelEnable W
TransmitPowerSupported R
TransmitPower W
ExtensionChannel W
GuardInterval W
MCS W
IEEE80211hSupported R
IEEE80211hEnabled W
ChannelsInUse R
Device.WiFi.Radio.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

WiFiSSID:1 Profile

This table defines the WiFiSSID:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.WiFi. P
SSIDNumberOfEntries R
Device.WiFi.SSID.{i}. C
Enable W
Status R
Alias W
Name R
LowerLayers W
BSSID R
MACAddress R
SSID W
Device.WiFi.SSID.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

WiFiAccessPoint:1 Profile

This table defines the WiFiAccessPoint:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.WiFi. P
AccessPointNumberOfEntries R
Device.WiFi.AccessPoint.{i}. C
Enable W
Status R
SSIDReference W
SSIDAdvertisementEnabled W
WMMCapability R
UAPSDCapability R
WMMEnable W
UAPSDEnable W
AssociatedDeviceNumberOfEntries R
Device.WiFi.AccessPoint.{i}.Security. P
ModesSupported R
ModeEnabled W
WEPKey W
PreSharedKey W
KeyPassphrase W
RekeyingInterval W
RadiusServerIPAddr W
RadiusServerPort W
RadiusSecret W
Device.WiFi.AccessPoint.{i}.WPS. P
Enable W
ConfigMethodsSupported R
ConfigMethodsEnabled W
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. C
MACAddress R
AuthenticationState R
LastDataDownlinkRate R
LastDataUplinkRate R

WiFiAccessPoint:2 Profile

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

Name Requirement
Device.WiFi.AccessPoint.{i}. P
MACAddressControlEnabled W
AllowedMACAddress W

WiFiEndPoint:1 Profile

This table defines the WiFiEndPoint:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.WiFi. P
EndPointNumberOfEntries R
Device.WiFi.EndPoint.{i}. C
Enable W
Status R
ProfileReference W
SSIDReference R
ProfileNumberOfEntries R
Device.WiFi.EndPoint.{i}.Stats. P
LastDataDownlinkRate R
LastDataUplinkRate R
Device.WiFi.EndPoint.{i}.Security. P
ModesSupported R
Device.WiFi.EndPoint.{i}.Profile.{i}. C
Enable W
Status R
SSID W
Location W
Priority W
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. P
ModeEnabled W
WEPKey W
PreSharedKey W
KeyPassphrase W
Device.WiFi.EndPoint.{i}.WPS. P
Enable W
ConfigMethodsSupported R
ConfigMethodsEnabled W

USBInterface:1 Profile

This table defines the USBInterface:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.USB. P
InterfaceNumberOfEntries R
Device.USB.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
MACAddress R
MaxBitRate R
Port R
Device.USB.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

USBPort:1 Profile

This table defines the USBPort:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.USB. P
PortNumberOfEntries R
Device.USB.Port.{i}. P
Name R
Standard R
Type R
Receptacle R
Rate R
Power R

NAT:1 Profile

This table defines the NAT:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.NAT. C
InterfaceSettingNumberOfEntries R
PortMappingNumberOfEntries R
Device.NAT.InterfaceSetting.{i}. C
Enable W
Status R
Interface W
Device.NAT.PortMapping.{i}. C
Enable W
Interface W
AllInterfaces W
LeaseDuration R
RemoteHost W
ExternalPort W
InternalPort W
Protocol W
InternalClient W
Description W

QoS:1 Profile

This table defines the QoS:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.QoS. P
MaxClassificationEntries R
ClassificationNumberOfEntries R
MaxAppEntries R
AppNumberOfEntries R
MaxFlowEntries R
FlowNumberOfEntries R
MaxPolicerEntries R
PolicerNumberOfEntries R
MaxQueueEntries R
QueueNumberOfEntries R
ShaperNumberOfEntries R
DefaultForwardingPolicy W
DefaultPolicer W
DefaultQueue W
DefaultDSCPMark W
DefaultEthernetPriorityMark W
AvailableAppList R
DefaultTrafficClass W
Device.QoS.Classification.{i}. C
Enable W
Status R
Order W
Interface W
AllInterfaces W
DestIP W
DestMask W
DestIPExclude W
SourceIP W
SourceMask W
SourceIPExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortRangeMax W
DestPortExclude W
SourcePort W
SourcePortRangeMax W
SourcePortExclude W
SourceMACAddress W
SourceMACExclude W
DestMACAddress W
DestMACExclude W
DSCPCheck W
DSCPExclude W
DSCPMark W
EthernetPriorityCheck W
EthernetPriorityExclude W
EthernetPriorityMark W
VLANIDCheck W
VLANIDExclude W
ForwardingPolicy W
Policer W
TrafficClass W
Device.QoS.Policer.{i}. C
Enable W
Status R
CommittedRate W
CommittedBurstSize W
MeterType W
PossibleMeterTypes R
ConformingAction W
NonConformingAction W
TotalCountedPackets R
TotalCountedBytes R
ExcessBurstSize W
PeakRate W
PeakBurstSize W
PartialConformingAction W
Device.QoS.Queue.{i}. C
Enable W
Status R
Interface W
AllInterfaces W
BufferLength R
Weight W
Precedence W
REDThreshold W
REDPercentage W
DropAlgorithm W
SchedulerAlgorithm W
ShapingRate W
ShapingBurstSize W
TrafficClasses W
Device.QoS.Shaper.{i}. C
Enable W
Status R
Interface W
ShapingRate W
ShapingBurstSize W
Device.Routing.Router.{i}.IPv4Forwarding.{i}. -
ForwardingPolicy W

QoS:2 Profile

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

Name Requirement
ForwardingPolicy W

QoSDynamicFlow:1 Profile

This table defines the QoSDynamicFlow:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.QoS.App.{i}. C
Enable W
Status R
ProtocolIdentifier W
Name W
DefaultForwardingPolicy W
DefaultPolicer W
DefaultDSCPMark W
DefaultEthernetPriorityMark W
DefaultTrafficClass W
Device.QoS.Flow.{i}. C
Enable W
Status R
Type W
TypeParameters W
Name W
App W
ForwardingPolicy W
Policer W
DSCPMark W
EthernetPriorityMark W
TrafficClass W
Device.QoS.Classification.{i}. -
App W

QoSStats:1 Profile

This table defines the QoSStats:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.QoS. P
QueueStatsNumberOfEntries R
Device.QoS.Policer.{i}. -
TotalCountedPackets R
TotalCountedBytes R
ConformingCountedPackets R
ConformingCountedBytes R
NonConformingCountedPackets R
NonConformingCountedBytes R
Device.QoS.QueueStats.{i}. C
Enable W
Status R
Queue W
Interface W
OutputPackets R
OutputBytes R
DroppedPackets R
DroppedBytes R
QueueOccupancyPackets R
QueueOccupancyPercentage R

NeighborDiscovery:1 Profile

This table defines the NeighborDiscovery:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.NeighborDiscovery. P
Enable W
InterfaceSettingNumberOfEntries R
Device.NeighborDiscovery.InterfaceSetting.{i}. C
Enable W
Status R
Interface W
RetransTimer W
RtrSolicitationInterval W
MaxRtrSolicitations W
NUDEnable W
RSEnable W

RouterAdvertisement:1 Profile

This table defines the RouterAdvertisement:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.RouterAdvertisement. P
Enable W
InterfaceSettingNumberOfEntries R
Device.RouterAdvertisement.InterfaceSetting.{i}. C
Enable W
Status R
Interface W
MaxRtrAdvInterval W
MinRtrAdvInterval W
AdvDefaultLifetime W
AdvManagedFlag W
AdvOtherConfigFlag W
AdvMobileAgentFlag W
AdvPreferredRouterFlag W
AdvNDProxyFlag W
AdvLinkMTU W
AdvReachableTime W
AdvRetransTimer W
AdvCurHopLimit W
OptionNumberOfEntries R
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}. C
Enable W
Tag W
Value W

IPv6rd:1 Profile

This table defines the IPv6rd:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.IPv6rd. P
Enable W
InterfaceSettingNumberOfEntries R
Device.IPv6rd.InterfaceSetting.{i}. P
Enable W
Status R
BorderRelayIPv4Addresses W
AllTrafficToBorderRelay W
SPIPv6Prefix W
IPv4MaskLength W
AddressSource W
TunnelInterface R
TunneledInterface R

DSLite:1 Profile

This table defines the DSLite:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.DSLite. P
Enable W
InterfaceSettingNumberOfEntries R
Device.DSLite.InterfaceSetting.{i}. P
Enable W
Status R
EndpointAssignmentPrecedence W
EndpointName W
EndpointAddress W
Origin R
TunnelInterface R
TunneledInterface R

DSLite:2 Profile

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

Name Requirement
Device.DSLite.InterfaceSetting.{i}. P
EndpointAddressTypePrecedence W
EndpointAddressInUse R

Hosts:1 Profile

This table defines the Hosts:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Hosts. P
HostNumberOfEntries R
Device.Hosts.Host.{i}. P
IPAddress R
AddressSource R
LeaseTimeRemaining R
PhysAddress R
HostName R
Active R
Layer1Interface R
Layer3Interface R

Hosts:2 Profile

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

Name Requirement
Device.Hosts.Host.{i}. P
DHCPClient R
AssociatedDevice R
IPAddress R
IPAddress R

CaptivePortal:1 Profile

This table defines the CaptivePortal:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.CaptivePortal. P
Enable W
Status R
AllowedList W
URL W

Time:1 Profile

This table defines the Time:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.Time. P
Enable W
Status R
NTPServer1 W
NTPServer2 W
CurrentLocalTime R
LocalTimeZone W

IEEE8021xAuthentication:1 Profile

This table defines the IEEE8021xAuthentication:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.IEEE8021x. P
SupplicantNumberOfEntries R
Device.IEEE8021x.Supplicant.{i}. C
Enable W
Status R
PAEState R
EAPIdentity W
MaxStart W
StartPeriod W
HeldPeriod W
AuthPeriod W
AuthenticationCapabilities R
Device.IEEE8021x.Supplicant.{i}.Stats. P
ReceivedFrames R
TransmittedFrames R
TransmittedStartFrames R
TransmittedLogoffFrames R
TransmittedResponseIdFrames R
TransmittedResponseFrames R
ReceivedRequestIdFrames R
ReceivedRequestFrames R
ReceivedInvalidFrames R
ReceivedLengthErrorFrames R
LastFrameVersion R
LastFrameSourceMACAddress R
Enable W
SharedSecret W
Enable W
MutualAuthenticationEnable W

IEEE8021xAuthentication:2 Profile

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

Name Requirement
Device.IEEE8021x.Supplicant.{i}. P
Interface W

DHCPv4Server:1 Profile

This table defines the DHCPv4Server:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DHCPv4. P
Device.DHCPv4.Server. P
Enable W
PoolNumberOfEntries R
Device.DHCPv4.Server.Pool.{i}. C
Enable W
Order W
Interface W
MinAddress W
MaxAddress W
ReservedAddresses W
SubnetMask W
DNSServers W
DomainName W
IPRouters W
LeaseTime W
OptionNumberOfEntries R
Device.DHCPv4.Server.Pool.{i}.Option.{i}. C
Enable W
Tag W
Value W

DHCPv4CondServing:1 Profile

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

Name Requirement
Device.DHCPv4.Server.Pool.{i}. C
VendorClassID W
ClientID W
UserClassID W
Chaddr W
ChaddrMask W

DHCPv4Relay:1 Profile

This table defines the DHCPv4Relay:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DHCPv4. P
Device.DHCPv4.Relay. P
Enable W
ForwardingNumberOfEntries R
Device.DHCPv4.Relay.Forwarding.{i}. C
Enable W
Order W
Interface W
LocallyServed W
DHCPServerIPAddress W
VendorClassID W
ClientID W
UserClassID W
Chaddr W
ChaddrMask W

DHCPv4ServerClientInfo:1 Profile

This table defines the DHCPv4ServerClientInfo:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.DHCPv4.Server.Pool.{i}. C
ClientNumberOfEntries R
Device.DHCPv4.Server.Pool.{i}.Client.{i}. P
Alias W
Chaddr R
Active R
IPv4AddressNumberOfEntries R
OptionNumberOfEntries R
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}. P
IPAddress R
LeaseTimeRemaining R
Device.DHCPv4.Server.Pool.{i}.Client.{i}.Option.{i}. P
Tag R
Value R

DHCPv6Server:1 Profile

This table defines the DHCPv6Server:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.DHCPv6. P
Device.DHCPv6.Server. P
Enable W
PoolNumberOfEntries R
Device.DHCPv6.Server.Pool.{i}. C
Enable W
Status R
Order W
Interface W
IANAEnable W
IAPDEnable W
IANAPrefixes R
IAPDAddLength W
OptionNumberOfEntries R
Device.DHCPv6.Server.Pool.{i}.Option.{i}. C
Enable W
Tag W
Value W

DHCPv6ServerAdv:1 Profile

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

Name Requirement
Device.DHCPv6.Server.Pool.{i}. C
DUID W
VendorClassID W
UserClassID W
SourceAddress W
SourceAddressMask W

DHCPv6ServerClientInfo:1 Profile

This table defines the DHCPv6ServerClientInfo:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.DHCPv6.Server.Pool.{i}. C
ClientNumberOfEntries R
Device.DHCPv6.Server.Pool.{i}.Client.{i}. P
SourceAddress R
Active R
IPv6AddressNumberOfEntries R
IPv6PrefixNumberOfEntries R
OptionNumberOfEntries R
Device.DHCPv6.Server.Pool.{i}.Client.{i}.IPv6Address.{i}. P
IPAddress R
PreferredLifetime R
ValidLifetime R
Device.DHCPv6.Server.Pool.{i}.Client.{i}.IPv6Prefix.{i}. P
Prefix R
PreferredLifetime R
ValidLifetime R
Device.DHCPv6.Server.Pool.{i}.Client.{i}.Option.{i}. P
Tag R
Value R

Processors:1 Profile

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

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

VendorLogFiles:1 Profile

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

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

Location:1 Profile

This table defines the Location:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.DeviceInfo. P
LocationNumberOfEntries R
Device.DeviceInfo.Location.{i}. C
Source R
AcquiredTime R
ExternalSource R
ExternalProtocol R
DataObject W

FaultMgmtSupportedAlarms:1 Profile

This table defines the FaultMgmtSupportedAlarms:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FaultMgmt. P
SupportedAlarmNumberOfEntries R
Device.FaultMgmt.SupportedAlarm.{i}. P
EventType R
ProbableCause R
SpecificProblem R
PerceivedSeverity R
ReportingMechanism W

FaultMgmtActive:1 Profile

This table defines the *FaultMgmtActive:1 * profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FaultMgmt. P
CurrentAlarmNumberOfEntries R
Device.FaultMgmt.CurrentAlarm.{i}. P
AlarmIdentifier R
AlarmRaisedTime R
AlarmChangedTime R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtHistory:1 Profile

This table defines the FaultMgmtHistory:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FaultMgmt. P
HistoryEventNumberOfEntries R
Device.FaultMgmt.HistoryEvent.{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtExpedited:1 Profile

This table defines the FaultMgmtExpedited:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FaultMgmt. P
ExpeditedEventNumberOfEntries R
Device.FaultMgmt.ExpeditedEvent.{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtQueued:1 Profile

This table defines the FaultMgmtQueued:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FaultMgmt. P
QueuedEventNumberOfEntries R
Device.FaultMgmt.QueuedEvent.{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FAP_GPS:1 Profile

This table defines the FAP_GPS:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FAP.GPS. P
ScanOnBoot W
ScanPeriodically W
PeriodicInterval W
PeriodicTime W
ContinuousGPS W
ScanTimeout W
ScanStatus R
ErrorDetails R
LastScanTime R
LastSuccessfulScanTime R
LockedLatitude R
LockedLongitude R
NumberOfSatellites R

FAP_PerfMgmt:1 Profile

This table defines the FAP_PerfMgmt:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FAP.PerfMgmt. P
ConfigNumberOfEntries R
Device.FAP.PerfMgmt.Config.{i}. P
Enable W
URL W
Username W
Password W
PeriodicUploadInterval W
PeriodicUploadTime W

FAP_ApplicationPlatform:1 Profile

This table defines the FAP_ApplicationPlatform:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.4.

Name Requirement
Device.FAP.ApplicationPlatform. P
Version R
Enable W
MaxNumberOfApplications R
Device.FAP.ApplicationPlatform.Control. P
AuthenticationMethod W
Device.FAP.ApplicationPlatform.Control.FemtoAwareness. P
APIEnable W
MaxAPIUsersNumber W
FemtozoneID W
Device.FAP.ApplicationPlatform.Control.SMS. P
APIEnable W
MaxAPIUsersNumber W
MinSendSMSTimeInterval W
Device.FAP.ApplicationPlatform.Control.MMS. P
APIEnable W
MaxAPIUsersNumber W
MinSendMMSTimeInterval W
Device.FAP.ApplicationPlatform.Control.TerminalLocation. P
APIEnable W
MaxAPIUsersNumber W
QueryMobileLocationResponseAddress W
QueryMobileLocationResponseLongitudeLatitude W

BulkDataColl:1 Profile

This table defines the BulkDataColl:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.5.

Name Requirement
Device.BulkData. P
Enable W
Status R
MinReportingInterval R
Protocols R
EncodingTypes R
ProfileNumberOfEntries R
Device.BulkData.Profile.{i}. C
Enable W
Alias W
Protocol W
EncodingType W
ReportingInterval W
TimeReference W
ParameterNumberOfEntries R
Device.BulkData.Profile.{i}.Parameter.{i}. C
Reference W

BulkDataReports:1 Profile

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

Name Requirement
Device.BulkData. P
ParameterWildCardSupported R
Device.BulkData.Profile.{i}. C
Name W
NumberOfRetainedFailedReports W
Device.BulkData.Profile.{i}.Parameter.{i}. C
Name W

BulkDataJSONEncoding:1 Profile

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

Name Requirement
Device.BulkData.Profile.{i}.JSONEncoding. P
ReportFormat W
ReportTimestamp W

BulkDataCSVEncoding:1 Profile

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

Name Requirement
Device.BulkData.Profile.{i}.CSVEncoding. P
FieldSeparator W
RowSeparator W
EscapeCharacter W
ReportFormat W
RowTimestamp W

BulkDataHTTP:1 Profile

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

Name Requirement
Device.BulkData.Profile.{i}.HTTP. P
URL W
Username W
Password W
CompressionsSupported R
Compression W
MethodsSupported R
Method W
UseDateHeader W
RetryEnable W
RetryMinimumWaitInterval W
RetryIntervalMultiplier W
RequestURIParameterNumberOfEntries R
Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. C
Name W
Reference W

BulkDataFileTransfer:1 Profile

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

Name Requirement
Device.BulkData.Profile.{i}. C
FileTransferURL W
FileTransferUsername W
FileTransferPassword W
ControlFileFormat W

BulkDataStreaming:1 Profile

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

Name Requirement
Device.BulkData.Profile.{i}. C
StreamingHost W
StreamingPort W
StreamingSessionID W

IPsec:1 Profile

This table defines the IPsec:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.5.

Name Requirement
Device.IPsec. P
AHSupported R
IKEv2SupportedEncryptionAlgorithms R
ESPSupportedEncryptionAlgorithms R
IKEv2SupportedPseudoRandomFunctions R
SupportedIntegrityAlgorithms R
SupportedDiffieHellmanGroupTransforms R
MaxFilterEntries R
MaxProfileEntries R
FilterNumberOfEntries R
ProfileNumberOfEntries R
TunnelNumberOfEntries R
Device.IPsec.Stats. P
NegotiationFailures R
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
UnknownSPIErrors R
DecryptionErrors R
IntegrityErrors R
OtherReceiveErrors R
Device.IPsec.Filter.{i}. C
Enable W
Status R
Order W
Interface W
AllInterfaces W
DestIP W
DestMask W
DestIPExclude W
SourceIP W
SourceMask W
SourceIPExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortRangeMax W
DestPortExclude W
SourcePort W
SourcePortRangeMax W
SourcePortExclude W
ProcessingChoice W
Profile W
Device.IPsec.Profile.{i}. C
MaxChildSAs W
RemoteEndpoints W
ForwardingPolicy W
Protocol W
IKEv2AuthenticationMethod W
IKEv2AllowedEncryptionAlgorithms W
ESPAllowedEncryptionAlgorithms W
IKEv2AllowedPseudoRandomFunctions W
IKEv2AllowedIntegrityAlgorithms W
ESPAllowedIntegrityAlgorithms W
IKEv2AllowedDiffieHellmanGroupTransforms W
Device.IPsec.Tunnel.{i}. P
TunnelInterface R
TunneledInterface R
Device.IPsec.Tunnel.{i}.Stats. P
DecryptionErrors R
IntegrityErrors R
OtherReceiveErrors R

IPsecAdv:1 Profile

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

Name Requirement
Device.IPsec. P
IKEv2SANumberOfEntries R
Device.IPsec.IKEv2SA.{i}. P
Tunnel R
LocalAddress R
RemoteAddress R
CreationTime R
ChildSANumberOfEntries R
Device.IPsec.IKEv2SA.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
DecryptionErrors R
IntegrityErrors R
OtherReceiveErrors R
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}. P
InboundSPI R
OutboundSPI R
CreationTime R
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
DecryptionErrors R
IntegrityErrors R
OtherReceiveErrors R

DNS_SD:1 Profile

This table defines the DNS_SD:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.6.

Name Requirement
Device.DNS.SD. P
Enable W
ServiceNumberOfEntries R
Device.DNS.SD.Service.{i}. P
InstanceName R
ApplicationProtocol R
TransportProtocol R
Domain R
Port R
Target R
Priority R
Weight R
TimeToLive R
Status R
LastUpdate R
Host R
TextRecordNumberOfEntries R
Device.DNS.SD.Service.{i}.TextRecord.{i}. P
Key R
Value R

XMPPBasic:1 Profile

This table defines the XMPPBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.XMPP. P
ConnectionNumberOfEntries R
Device.XMPP.Connection.{i}. C
Enable W
Username W
Password W
Domain W
Resource W
JabberID R
Status R
LastChangeDate R

XMPPAdvanced:1 Profile

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

Name Requirement
Device.XMPP.Connection.{i}. C
ServerConnectAlgorithm W
KeepAliveInterval W
ServerNumberOfEntries R
UseTLS W
TLSEstablished R
Device.XMPP.Connection.{i}.Server.{i}. C
Enable W
Priority W
Weight W
ServerAddress W
Port W
Device.XMPP.Connection.{i}.Stats. P
ReceivedMessages R
TransmittedMessages R
ReceivedErrorMessages R
TransmittedErrorMessages R

XMPPReconnect:1 Profile

This table defines the XMPPReconnect:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.XMPP.Connection.{i}. C
ServerConnectAttempts W
ServerRetryInitialInterval W
ServerRetryIntervalMultiplier W
ServerRetryMaxInterval W

IEEE1905Device:1 Profile

This table defines the IEEE1905Device:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.IEEE1905. P
Version R
Device.IEEE1905.AL. P
IEEE1905Id R
Status R
InterfaceNumberOfEntries R
Device.IEEE1905.AL.Interface.{i}. P
InterfaceId R
MediaType R
GenericPhyOUI R
GenericPhyVariant R
GenericPhyURL R
Device.IEEE1905.AL.Security. P
SetupMethod W
Password W

IEEE1905TopologyMetric:1 Profile

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

Name Requirement
Device.IEEE1905.AL.NetworkTopology. P
Enable W
Status R
IEEE1905DeviceNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. P
IEEE1905Id R
InterfaceNumberOfEntries R
IEEE1905NeighborNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. P
LocalInterface R
NeighborDeviceId R
MetricNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}.Metric.{i}. P
NeighborMACAddress R
IEEE802dot1Bridge R
PacketErrors R
PacketErrorsReceived R
TransmittedPackets R
PacketsReceived R
MACThroughputCapacity R
LinkAvailability R
PHYRate R
RSSI R

IEEE1905TopologyNeighbor:1 Profile

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

Name Requirement
Device.IEEE1905.AL.NetworkTopology. P
Enable W
Status R
IEEE1905DeviceNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. P
IEEE1905Id R
Version R
InterfaceNumberOfEntries R
NonIEEE1905NeighborNumberOfEntries R
IEEE1905NeighborNumberOfEntries R
L2NeighborNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. P
LocalInterface R
NeighborDeviceId R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.Interface.{i}. P
InterfaceId R
MediaType R
PowerState R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.NonIEEE1905Neighbor.{i}. P
LocalInterface R
NeighborInterfaceId R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.L2Neighbor.{i}. P
LocalInterface R
NeighborInterfaceId R
BehindInterfaceIds R

IEEE1905TopologyHigherLayer:1 Profile

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

Name Requirement
Device.IEEE1905.AL.NetworkTopology. P
Enable W
Status R
IEEE1905DeviceNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. P
IEEE1905Id R
Version R
FriendlyName R
ManufacturerName R
ManufacturerModel R
ControlURL R
IPv4AddressNumberOfEntries R
IPv6AddressNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv4Address.{i}. P
MACAddress R
IPv4Address R
IPv4AddressType R
DHCPServer R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv6Address.{i}. P
MACAddress R
IPv6Address R
IPv6AddressType R
IPv6AddressOrigin R

IEEE1905Power:1 Profile

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

Name Requirement
Device.IEEE1905.AL.Interface.{i}. P
SetIntfPowerStateEnabled W
PowerState W
VendorPropertiesNumberOfEntries R
Device.IEEE1905.AL.Interface.{i}.VendorProperties.{i}. P
OUI R
Information R

IEEE1905InterfaceSelection:1 Profile

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

Name Requirement
Device.IEEE1905.AL.Interface.{i}. P
SetIntfPowerStateEnabled W
PowerState W
VendorPropertiesNumberOfEntries R
Device.IEEE1905.AL.Interface.{i}.VendorProperties.{i}. P
OUI R
Information R
Device.IEEE1905.AL.ForwardingTable. P
SetForwardingEnabled R
ForwardingRuleNumberOfEntries R
Device.IEEE1905.AL.ForwardingTable.ForwardingRule.{i}. C
InterfaceList W
MACDestinationAddress W
MACDestinationAddressFlag W
MACSourceAddress W
MACSourceAddressFlag W
EtherType W
EtherTypeFlag W
Vid W
VidFlag W
PCP W
PCPFlag W

IEEE1905LinkMetric:1 Profile

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

Name Requirement
Device.IEEE1905.AL.Interface.{i}. P
SetIntfPowerStateEnabled W
PowerState W
LinkNumberOfEntries R
VendorPropertiesNumberOfEntries R
Device.IEEE1905.AL.Interface.{i}.VendorProperties.{i}. P
OUI R
Information R
Device.IEEE1905.AL.Interface.{i}.Link.{i}. P
InterfaceId R
IEEE1905Id R
MediaType R
Device.IEEE1905.AL.Interface.{i}.Link.{i}.Metric. P
PacketErrors R
PacketErrorsReceived R
TransmittedPackets R
PacketsReceived R
MACThroughputCapacity R
LinkAvailability R
PHYRate R
RSSI R

IEEE1905NetworkTopology:1 Profile

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

Name Requirement
Device.IEEE1905.AL.NetworkTopology. P
Enable W
Status R
MaxChangeLogEntries W
LastChange R
IEEE1905DeviceNumberOfEntries R
ChangeLogNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.ChangeLog.{i}. P
TimeStamp R
EventType R
ReporterDeviceId R
ReporterInterfaceId R
NeighborType R
NeighborId R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. P
IEEE1905Id R
Version R
InterfaceNumberOfEntries R
NonIEEE1905NeighborNumberOfEntries R
IEEE1905NeighborNumberOfEntries R
BridgingTupleNumberOfEntries R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.BridgingTuple.{i}. P
InterfaceList R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. P
LocalInterface R
NeighborDeviceId R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.Interface.{i}. P
InterfaceId R
MediaType R
PowerState R
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.NonIEEE1905Neighbor.{i}. P
LocalInterface R
NeighborInterfaceId R

MQTTClientBase:1 Profile

This table defines the MQTTClientBase:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.10.

Name Requirement
Device.MQTT. P
ClientNumberOfEntries R
Device.MQTT.Client.{i}. P
Enable W
Status R
BrokerAddress W
BrokerPort W
CleanSession W
KeepAliveTime W
SubscriptionNumberOfEntries R
Device.MQTT.Client.{i}.Stats. P
BrokerConnectionEstablished R
MQTTMessagesSent R
MQTTMessagesReceived R
ConnectionErrors R

MQTTClientSubscribe:1 Profile

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

Name Requirement
Device.MQTT.Client.{i}.Subscription.{i}. P
Topic W
QoS R
Enable W

MQTTBrokerBase:1 Profile

This table defines the MQTTBrokerBase:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.10.

Name Requirement
Device.MQTT. P
BrokerNumberOfEntries R
Device.MQTT.Broker.{i}. P
Name W
Enable W
Status R
Interface W
Port W
Device.MQTT.Broker.{i}.Stats. P
TotalNumberOfClients R
NumberOfActiveClients R
MQTTMessagesSent R
MQTTMessagesReceived R
ConnectionErrors R

MQTTBrokerBridgeBase:1 Profile

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

Name Requirement
Device.MQTT.Broker.{i}. P
BridgeNumberOfEntries R
Device.MQTT.Broker.{i}.Bridge.{i}. P
Name W
Enable W
Status R
ServerConnection R
ServerNumberOfEntries R
SubscriptionNumberOfEntries R
Device.MQTT.Broker.{i}.Bridge.{i}.Server.{i}. P
Enable W
Priority W
Address W
Port W
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}. P
Topic W
Direction W
Enable W
QoS W

MQTTBrokerExtended:1 Profile

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

Name Requirement
Device.MQTT.Broker.{i}. P
Username W
Password W
Device.MQTT.Broker.{i}.Stats. P
NumberOfInactiveClients R
PublishSent R
PublishReceived R
PublishErrors R

ZigBeeInterface:1 Profile

This table defines the ZigBeeInterface:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.10.

Name Requirement
Device.ZigBee. P
InterfaceNumberOfEntries R
Device.ZigBee.Interface.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
IEEEAddress R
NetworkAddress R
ZDOReference R

ZigBeeAssociatedDevices:1 Profile

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

Name Requirement
Device.ZigBee.Interface.{i}. P
AssociatedDeviceNumberOfEntries R
Device.ZigBee.Interface.{i}.AssociatedDevice.{i}. P
IEEEAddress R
NetworkAddress R
Active R
ZDOReference R

ZigBeeDisc:1 Profile

This table defines the ZigBeeDisc:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.10.

Name Requirement
Device.ZigBee.Discovery. P
AreaNetworkNumberOfEntries R
Device.ZigBee.Discovery.AreaNetwork.{i}. C
Enable W
LastUpdate R
Status R
Coordinator W
ZDOReference R
ZDOList R

ZDOBasic:1 Profile

This table defines the ZDOBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.10.

Name Requirement
Device.ZigBee. P
ZDONumberOfEntries R
Device.ZigBee.ZDO.{i}. P
IEEEAddress R
NetworkAddress R
Device.ZigBee.ZDO.{i}.NodeDescriptor. P
LogicalType R
ComplexDescriptorSupported R
UserDescriptorSupported R
FrequencyBand R
MACCapability R
ManufactureCode R
MaximumBufferSize R
MaximumIncomingTransferSize R
MaximumOutgoingTransferSize R
ServerMask R
DescriptorCapability R
Device.ZigBee.ZDO.{i}.PowerDescriptor. P
CurrentPowerMode R
AvailablePowerSource R
CurrentPowerSource R
CurrentPowerSourceLevel R

ZDOAdv:1 Profile

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

Name Requirement
Device.ZigBee.ZDO.{i}. P
BindingTableNumberOfEntries R
GroupNumberOfEntries R
ApplicationEndpointNumberOfEntries R
Device.ZigBee.ZDO.{i}.UserDescriptor. P
DescriptorAvailable R
Description R
Device.ZigBee.ZDO.{i}.ComplexDescriptor. P
DescriptorAvailable R
Language R
CharacterSet R
ManufacturerName R
ModelName R
SerialNumber R
DeviceURL R
Icon R
IconURL R
Device.ZigBee.ZDO.{i}.Security. P
TrustCenterAddress R
SecurityLevel R
TimeOutPeriod R
Device.ZigBee.ZDO.{i}.Network. P
NeighborNumberOfEntries R
Device.ZigBee.ZDO.{i}.Network.Neighbor.{i}. P
Neighbor R
LQI R
Relationship R
PermitJoin R
Depth R
Device.ZigBee.ZDO.{i}.NodeManager. P
RoutingTableNumberOfEntries R
Device.ZigBee.ZDO.{i}.NodeManager.RoutingTable.{i}. P
DestinationAddress R
NextHopAddress R
Status R
MemoryConstrained R
ManyToOne R
RouteRecordRequired R
Device.ZigBee.ZDO.{i}.Binding.{i}. C
Enable W
SourceEndpoint W
SourceAddress W
ClusterId W
DestinationAddressMode W
DestinationEndpoint W
IEEEDestinationAddress W
GroupDestinationAddress W
Device.ZigBee.ZDO.{i}.Group.{i}. C
Enable W
GroupId W
EndpointList W
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}. C
Enable W
EndpointId W
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}.SimpleDescriptor. P
ProfileId W
DeviceId R
DeviceVersion R
InputClusterList W
OutputClusterList W

ZigBeeStats:1 Profile

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

Name Requirement
Device.ZigBee.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownPacketsReceived R

LEDBasic:1 Profile

This table defines the LEDBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.11.

Name Requirement
Device.LEDs. P
LEDNumberOfEntries R
Device.LEDs.LED.{i}. P
Name R
Status R
Reason R
CyclePeriodRepetitions R
Location R
RelativeXPosition R
RelativeYPosition R
CycleElementNumberOfEntries R
Device.LEDs.LED.{i}.CycleElement.{i}. P
Order R
Color R
Duration R
FadeInterval R
Device.LEDs.LED.{i}.CurrentCycleElement. P
CycleElementReference R
Color R
Duration R

LEDAdv:1 Profile

This table defines the LEDAdv:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.11.

Name Requirement
Device.LEDs. P
LEDNumberOfEntries R
Device.LEDs.LED.{i}. P
Name W
Status R
Reason R
CyclePeriodRepetitions R
Location R
RelativeXPosition R
RelativeYPosition R
CycleElementNumberOfEntries R
Device.LEDs.LED.{i}.CycleElement.{i}. C
Enable W
Order W
Color W
Duration W
FadeInterval W
Device.LEDs.LED.{i}.CurrentCycleElement. P
CycleElementReference R
Color R
Duration R

DeviceImage:1 Profile

This table defines the DeviceImage:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.11.

Name Requirement
Device.DeviceInfo. P
DeviceImageNumberOfEntries R
Device.DeviceInfo.DeviceImageFile.{i}. P
Location R
Image R

FAST:1 Profile

This table defines the FAST:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.11.

Name Requirement
Device.FAST. P
LineNumberOfEntries R
Device.FAST.Line.{i}. P
Enable W
Status R
Alias W
Name R
LastChange R
Upstream R
AllowedProfiles R
CurrentProfile R
UPBOKLE R
UpstreamMaxBitRate R
DownstreamMaxBitRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamAttenuation R
DownstreamAttenuation R
UpstreamPower R
DownstreamPower R
SNRMRMCds R
SNRMRMCus R
FEXTCANCELds R
FEXTCANCELus R
ETRds R
ETRus R
ATTETRds R
ATTETRus R
MINEFTR R
Device.FAST.Line.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.FAST.Line.{i}.TestParams. P
SNRGds R
SNRGus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R

UserInformationBasic:1 Profile

This table defines the UserInformationBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.11.

Name Requirement
Device.UserInterface.Messages. P
Title W
SubTitle W
Text W

UserInformationExtended:1 Profile

This table defines the UserInformationExtended:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.11.

Name Requirement
Device.UserInterface.Messages. P
Title W
SubTitle W
Text W
IconType W
MessageColor W
BackgroundColor W
TitleColor W
SubTitleColor W
RequestedNumberOfRepetitions W
ExecutedNumberOfRepetitions R

L2TPv3Basic:1 Profile

This table defines the L2TPv3Basic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.L2TPv3. P
TunnelNumberOfEntries R
Device.L2TPv3.Tunnel.{i}. C
Enable W
Status R
RemoteEndpoints W
KeepAlivePolicy W
KeepAliveTimeout W
KeepAliveThreshold W
DeliveryHeaderProtocol W
TunnelEncapsulation W
ConnectedRemoteEndpoint R
InterfaceNumberOfEntries R
Device.L2TPv3.Tunnel.{i}.UDP. P
SourcePort W
RemotePort W
EnableChecksum W
Device.L2TPv3.Tunnel.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.L2TPv3.Tunnel.{i}.Interface.{i}. C
Enable W
Status R
Name R
LastChange R
LowerLayers R
SessionID W
CookiePolicy W
Cookie W
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

L2TPv3Adv:1 Profile

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

Name Requirement
Device.L2TPv3. P
FilterNumberOfEntries R
Device.L2TPv3.Tunnel.{i}. C
DefaultDSCPMark W
Device.L2TPv3.Tunnel.{i}.Stats. P
KeepAliveSent R
KeepAliveReceived R
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. P
DiscardChecksumReceived R
DiscardSequenceNumberReceived R
Device.L2TPv3.Filter.{i}. C
Enable W
Status R
Order W
Interface W
AllInterfaces W
VLANIDCheck W
VLANIDExclude W
DSCPMarkPolicy W

VXLANBasic:1 Profile

This table defines the VXLANBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.VXLAN. P
TunnelNumberOfEntries R
Device.VXLAN.Tunnel.{i}. C
Enable W
Status R
RemoteEndpoints W
KeepAlivePolicy W
KeepAliveTimeout W
KeepAliveThreshold W
DeliveryHeaderProtocol W
ConnectedRemoteEndpoint R
InterfaceNumberOfEntries R
SourcePort W
RemotePort W
Device.VXLAN.Tunnel.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
Device.VXLAN.Tunnel.{i}.Interface.{i}. C
Enable W
Status R
Name R
LastChange R
LowerLayers R
VNI W
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R

VXLANAdv:1 Profile

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

Name Requirement
Device.VXLAN. P
FilterNumberOfEntries R
Device.VXLAN.Tunnel.{i}. C
DefaultDSCPMark W
Device.VXLAN.Tunnel.{i}.Stats. P
KeepAliveSent R
KeepAliveReceived R
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. P
DiscardChecksumReceived R
DiscardSequenceNumberReceived R
Device.VXLAN.Filter.{i}. C
Enable W
Status R
Order W
Interface W
AllInterfaces W
VLANIDCheck W
VLANIDExclude W
DSCPMarkPolicy W

LMAPPreconfiguration:1 Profile

This table defines the LMAPPreconfiguration:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.LMAP. P
MeasurementAgentNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}. C
Alias W
Enable W
Version R
CapabilityTags R
Identifier W
PublicCredential W
PrivateCredential W
EventLog R
TaskCapabilityNumberOfEntries R
ScheduleNumberOfEntries R
TaskNumberOfEntries R
CommunicationChannelNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}.Controller. P
ControllerTimeout W
ControlSchedules W
ControlTasks W
ControlChannels W
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}. P
Name R
Version R
TaskCapabilityRegistryNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}.Registry.{i}. P
RegistryEntry R
Roles R
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. C
Alias W
Enable W
Name W
Start W
End W
Duration W
Tags W
SuppressionTags W
ExecutionMode W
ActionNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. C
Alias W
Enable W
Order W
Task W
SuppressionTags W
Tags W
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}. C
Alias W
Enable W
Order W
Name W
Value R
Device.LMAP.MeasurementAgent.{i}.Task.{i}. C
Alias W
Enable W
Name W
Tags W
OptionNumberOfEntries R
RegistryNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}. C
Alias W
Enable W
RegistryEntry W
Roles W
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}. C
Alias W
Enable W
Order W
Name W
Value R
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}. C
Alias W
Enable W
Name W
UseBulkDataProfile W
Target W
TargetPublicCredential W
Interface W
Device.LMAP.Event.{i}. C
Alias W
Enable W
Name W
Type W
RandomnessSpread W
Device.LMAP.Event.{i}.PeriodicTimer. P
StartTime W
EndTime W
Interval W
Device.LMAP.Event.{i}.CalendarTimer. P
StartTime W
EndTime W
ScheduleMonths W
ScheduleDaysOfMonth W
ScheduleDaysOfWeek W
ScheduleHoursOfDay W
ScheduleMinutesOfHour W
ScheduleSecondsOfMinute W
EnableScheduleTimezoneOffset W
ScheduleTimezoneOffset W
Device.LMAP.Event.{i}.OneOff. P
StartTime W

LMAPController:1 Profile

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

Name Requirement
Device.LMAP.MeasurementAgent.{i}. C
LastStarted R
GroupIdentifier W
MeasurementPoint W
UseAgentIdentifierInReports W
UseGroupIdentifierInReports W
UseMeasurementPointInReports W
InstructionNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}.Controller. P
ControllerTimeout W
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. C
State R
LastInvocation R
Storage R
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats. P
Invocations R
Suppressions R
Overlaps R
Failures R
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. C
State R
LastInvocation R
Storage R
LastSuccessfulCompletion R
LastSuccessfulStatusCode R
LastSuccessfulMessage R
LastFailedCompletion R
LastFailedStatusCode R
LastFailedMessage R
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Stats. P
Invocations R
Suppressions R
Overlaps R
Failures R
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}. C
Alias W
Enable W
LastChange R
InstructionSchedules W
InstructionTasks W
ReportChannels W
MeasurementSuppressionNumberOfEntries R
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}. C
Alias W
Enable W
Name W
State R
StopRunning W
Start W
End W
SuppressionMatch W
Device.LMAP.Event.{i}. C
CycleInterval W

LMAPCollector:1 Profile

This table defines the LMAPCollector:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.LMAP.Report.{i}. P
ReportDate R
AgentIdentifier R
GroupIdentifier R
MeasurementPoint R
ResultNumberOfEntries R
Device.LMAP.Report.{i}.Result.{i}. P
TaskName R
ScheduleName R
ActionName R
EventTime R
CycleNumber R
Status R
Tags R
OptionNumberOfEntries R
ResultConflictNumberOfEntries R
ResultReportTableNumberOfEntries R
Device.LMAP.Report.{i}.Result.{i}.Option.{i}. P
Order R
Name R
Value R
Device.LMAP.Report.{i}.Result.{i}.Conflict.{i}. P
TaskName R
ScheduleName R
ActionName R
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}. P
ColumnLabels R
ResultReportRowNumberOfEntries R
RegistryNumberOfEntries R
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.ResultRow.{i}. P
Values R
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.Registry.{i}. P
RegistryEntry R
Roles R

BASAPM:1 Profile

This table defines the BASAPM:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.BASAPM. P
MeasurementEndpointNumberOfEntries R
Device.BASAPM.MeasurementEndpoint.{i}. C
Alias W
MeasurementAgent W
DeviceOwnership W
OperationalDomain W
InternetDomain W
UseMeasurementEndpointInReports W
Device.BASAPM.MeasurementEndpoint.{i}.ISPDevice. P
ReferencePoint W
GeographicalLocation W
Device.BASAPM.MeasurementEndpoint.{i}.CustomerDevice. P
EquipmentIdentifier W
CustomerIdentifier W

TWAMPReflectorBasic:1 Profile

This table defines the TWAMPReflectorBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.IP.Interface.{i}. C
TWAMPReflectorNumberOfEntries R
Device.IP.Interface.{i}.TWAMPReflector.{i}. C
Enable W
Status R
Port W
MaximumTTL W
IPAllowedList W
PortAllowedList W

Download:1 Profile

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

Name Requirement
Device.IP.Diagnostics. P
IPv4DownloadDiagnosticsSupported R
IPv6DownloadDiagnosticsSupported R
Device.IP.Diagnostics.DownloadDiagnostics. P
DiagnosticsState W
Interface W
DownloadURL W
DownloadTransports R
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestBytesReceived R
TotalBytesReceived R

DownloadTCP:1 Profile

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

Name Requirement
Device.IP.Diagnostics.DownloadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

Upload:1 Profile

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

Name Requirement
Device.IP.Diagnostics. P
IPv4UploadDiagnosticsSupported R
IPv6UploadDiagnosticsSupported R
Device.IP.Diagnostics.UploadDiagnostics. P
DiagnosticsState W
Interface W
UploadURL W
UploadTransports R
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestFileLength R
TotalBytesSent R

UploadTCP:1 Profile

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

Name Requirement
Device.IP.Diagnostics.UploadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

SelfTestDiag:1 Profile

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

Name Requirement
Device.SelfTestDiagnostics. P
DiagnosticsState W
Results R

NSLookupDiag:1 Profile

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

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

AutonXferComplPolicy:1 Profile

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

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

DownloadAnnounce:1 Profile

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

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

DownloadQuery:1 Profile

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

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

Baseline:1 Profile

This table defines the Baseline:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device. P
InterfaceStackNumberOfEntries R
Device.DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
ProvisioningCode W
UpTime R
Device.LANConfigSecurity. P
ConfigPassword W
Device.DNS. P
Device.DNS.Client. P
Enable W
Status R
ServerNumberOfEntries R
Device.DNS.Client.Server.{i}. C
Enable W
Status R
DNSServer W
Interface W
Type R
Device.ManagementServer. P
URL W
Username W
Password W
PeriodicInformEnable W
PeriodicInformInterval W
PeriodicInformTime W
ParameterKey R
ConnectionRequestURL R
ConnectionRequestUsername W
ConnectionRequestPassword W
UpgradesManaged W

Baseline:2 Profile

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

Name Requirement
Device. P
InterfaceStackNumberOfEntries R
Device.DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
ProvisioningCode W
UpTime R
Device.LANConfigSecurity. P
ConfigPassword W
Device.DNS. P
Device.DNS.Client. P
Enable W
Status R
ServerNumberOfEntries R
Device.DNS.Client.Server.{i}. C
Enable W
Status R
DNSServer W
Interface W
Type R
Device.InterfaceStack.{i}. P
HigherLayer R
LowerLayer R
SupportedRecordTypes R

Baseline:3 Profile

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

Name Requirement
Device. P
InterfaceStackNumberOfEntries R
Device.DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
ProvisioningCode W
UpTime R
Device.LANConfigSecurity. P
ConfigPassword W
Device.DNS. P
Device.DNS.Client. P
Enable W
Status R
ServerNumberOfEntries R
Device.DNS.Client.Server.{i}. C
Enable W
Status R
DNSServer W
Interface W
Type R
Device.InterfaceStack.{i}. P
HigherLayer R
LowerLayer R
SupportedRecordTypes R
RootDataModelVersion R

DeviceAssociation:1 Profile

This table defines the DeviceAssociation:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.ManagementServer. -
ManageableDeviceNumberOfEntries R
Device.ManagementServer.ManageableDevice.{i}. P
ManufacturerOUI R
SerialNumber R
ProductClass R
Host R

IPPingDetailed:1 Profile

This table defines the IPPingDetailed:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.IP.Diagnostics.IPPing. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
Timeout W
DataBlockSize W
DSCP W
SuccessCount R
FailureCount R
AverageResponseTimeDetailed R
MinimumResponseTimeDetailed R
MaximumResponseTimeDetailed R

IPPing:1 Profile

This table defines the IPPing:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.IP.Diagnostics.IPPing. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
Timeout W
DataBlockSize W
DSCP W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

TraceRoute:1 Profile

This table defines the TraceRoute:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.IP.Diagnostics.TraceRoute. P
DiagnosticsState W
Interface W
Host W
NumberOfTries W
Timeout W
DataBlockSize W
DSCP W
MaxHopCount W
ResponseTime R
RouteHopsNumberOfEntries R
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}. P
Host R
HostAddress R
ErrorCode R
RTTimes R

ATMLoopback:1 Profile

This table defines the ATMLoopback:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.ATM.Diagnostics.F5Loopback. P
DiagnosticsState W
Interface W
NumberOfRepetitions W
Timeout W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

DSLDiagnostics:1 Profile

This table defines the DSLDiagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL.Diagnostics.ADSLLineTest. P
DiagnosticsState W
Interface W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINpsds R
QLNpsds R
SNRpsds R
BITSpsds R

ADSL2Diagnostics:1 Profile

This table defines the ADSL2Diagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL.Diagnostics.ADSLLineTest. P
DiagnosticsState W
Interface W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINSCus R
HLINpsds R
HLINpsus R
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNpbds R
LATNpbus R
SATNds R
SATNus R

VDSL2Diagnostics:1 Profile

This table defines the VDSL2Diagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DSL.Diagnostics.ADSLLineTest. P
DiagnosticsState W
Interface W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINSCus R
HLINGds R
HLINGus R
HLINpsds R
HLINpsus R
HLOGGds R
HLOGGus R
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNGds R
QLNGus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRGds R
SNRGus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNpbds R
LATNpbus R
SATNds R
SATNus R

HPNADiagnostics:1 Profile

This table defines the HPNADiagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.HPNA.Diagnostics.PerformanceMonitoring. P
DiagnosticsState W
Interface W
SampleInterval R
Device.HPNA.Diagnostics.PerformanceMonitoring.Nodes. P
CurrentStart R
CurrentEnd R
NodeNumberOfEntries R
Device.HPNA.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}. P
MACAddress R
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
PacketsCrcErrored R
PacketsCrcErroredHost R
PacketsShortErrored R
PacketsShortErroredHost R
RxPacketsDropped R
TxPacketsDropped R
ControlRequestLocal R
ControlReplyLocal R
ControlRequestRemote R
Device.HPNA.Diagnostics.PerformanceMonitoring.Channels. P
TimeStamp R
ChannelNumberOfEntries R
Device.HPNA.Diagnostics.PerformanceMonitoring.Channels.Channel.{i}. P
HPNASrcMACAddress R
HPNADestMACAddress R
HostSrcMACAddress R
HostDestMACAddress R
PHYRate R
BaudRate R
SNR R
PacketsSent R
PacketsReceived R
Device.HPNA.Diagnostics.PHYThroughput. P
DiagnosticsState W
Interface W
NumPacketsInBurst W
BurstInterval W
TestPacketPayloadLength W
PayloadEncoding W
PayloadDataGen W
PayloadType W
PriorityLevel W
ResultNumberOfEntries R
Device.HPNA.Diagnostics.PHYThroughput.Result.{i}. P
SrcMACAddress R
DestMACAddress R
PHYRate R
BaudRate R
SNR R
PacketsReceived R

UPADiagnostics:1 Profile

This table defines the UPADiagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.UPA.Diagnostics.InterfaceMeasurement. P
DiagnosticsState W
Type W
Interface W
Port W
Measurements R
RxGain R

UDPConnReq:1 Profile

This table defines the UDPConnReq:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

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

DUStateChngComplPolicy:1 Profile

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

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

StandbyPolicy:1 Profile

This table defines the StandbyPolicy:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.ManagementServer.StandbyPolicy. P
CRUnawarenessMaxDuration W
MaxMissedPeriodic W
NotifyMissedScheduled W
NetworkAwarenessCapable R
SelfTimerCapable R
CRAwarenessRequested W
PeriodicAwarenessRequested W
ScheduledAwarenessRequested W

XMPPConnReq:1 Profile

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

Name Requirement
Device.ManagementServer. P
SupportedConnReqMethods R
ConnReqXMPPConnection W
ConnReqAllowedJabberIDs W
ConnReqJabberID R

InformParameters:1 Profile

This table defines the InformParameters:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.8.

Name Requirement
Device.ManagementServer. P
InformParameterNumberOfEntries R
Device.ManagementServer.InformParameter.{i}. C
Enable W
ParameterName W
EventList W

UDPEchoDiag:1 Profile

This table defines the UDPEchoDiag:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.IP.Diagnostics.UDPEchoDiagnostics. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
EnableIndividualPacketResults W
Timeout W
DataBlockSize W
DSCP W
InterTransmissionTime W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R
IndividualPacketResultNumberOfEntries R
Device.IP.Diagnostics.UDPEchoDiagnostics.IndividualPacketResult.{i}. P
PacketSuccess R
PacketSendTime R
PacketReceiveTime R
TestGenSN R
TestRespSN R
TestRespRcvTimeStamp R
TestRespReplyTimeStamp R
TestRespReplyFailureCount R

ServerSelectionDiag:1 Profile

This table defines the ServerSelectionDiag:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.9.

Name Requirement
Device.IP.Diagnostics.ServerSelectionDiagnostics. P
DiagnosticsState W
Interface W
HostList W
NumberOfRepetitions W
Timeout W
FastestHost R
AverageResponseTime R

GatewayInfo:1 Profile

This table defines the GatewayInfo:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.GatewayInfo. P
ManufacturerOUI R
ProductClass R
SerialNumber R

SupportedDataModel:1 Profile

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

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

SupportedDataModel:2 Profile

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

Name Requirement
Device.DeviceInfo.SupportedDataModel.{i}. P
UUID R

SM_ExecEnvs:1 Profile

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

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

SM_DeployAndExecUnits:1 Profile

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

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

SM_Baseline:1 Profile

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

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

ETSIM2MSCLBaseline:1 Profile

This table defines the ETSIM2MSCLBaseline:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.6.

Name Requirement
Device.ETSIM2M.SCL.{i}. C
Enable W
AnnouncedToSCLList W
SAFPolicySetNumberOfEntries R
AreaNwkInstanceNumberOfEntries R
AreaNwkDeviceInfoInstanceNumberOfEntries R
Device.ETSIM2M.SCL.{i}.Discovery. P
MaxNumberOfDiscovRecords W
MaxSizeOfDiscovAnswer W
Device.ETSIM2M.SCL.{i}.Reregistration. P
RegTargetNSCLList W
RegSearchStrings W
RegAccessRightID W
RegExpirationDuration W
Device.ETSIM2M.SCL.{i}.Reregistration.ActionStatus. P
Progress R
FinalStatus R
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}. C
Enable W
PolicyScope W
ANPPolicyNumberOfEntries R
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}. C
Enable W
ANName W
BlockPeriodNumberOfEntries R
RequestCategoryNumberOfEntries R
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.BlockPeriod.{i}. C
Enable W
FailedAttempts W
BlockDuration W
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}. C
Enable W
RCAT W
ScheduleNumberOfEntries R
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}. C
Enable W
Schedules W
AbsTimeSpanNumberOfEntries R
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}.AbsTimeSpan.{i}. C
Enable W
StartTime W
EndTime W
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy. P
DefaultRCATValue W
RequestCategoryNumberOfEntries R
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy.RequestCategory.{i}. C
Enable W
RCAT W
TolerableDelay W
Thresh W
Mem W
RankedANList W
Device.ETSIM2M.SCL.{i}.AreaNwkInstance.{i}. P
ID R
AreaNwkType R
ListOfDevices R
Device.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.{i}. P
AreaNwkInstance R
Host R
ListOfDeviceNeighbors R
ListOfDeviceApplications R
SleepInterval W
SleepDuration W
Status R
Active R

TempStatusAdv:1 Profile

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

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

TempStatusAdv:2 Profile

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

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

USBHostsAdv:1 Profile

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

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

PeriodicStatsAdv:1 Profile

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

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

IPInterface:1 Profile

This table defines the IPInterface:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.IP. P
InterfaceNumberOfEntries R
Device.IP.Interface.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
Type R
Reset W
IPv4AddressNumberOfEntries R
Device.IP.Interface.{i}.IPv4Address.{i}. C
Enable W
IPAddress W
SubnetMask W
AddressingType R
Device.IP.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

IPInterface:2 Profile

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

Name Requirement
Device.IP. P
IPv4Enable W
IPv4Status R
Device.IP.Interface.{i}. C
IPv4Enable W
Device.IP.Interface.{i}.IPv4Address.{i}. C
Status R

IPv6Interface:1 Profile

This table defines the IPv6Interface:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.IP. P
IPv6Capable R
IPv6Enable W
IPv6Status R
ULAPrefix W
InterfaceNumberOfEntries R
Device.IP.Interface.{i}. C
Enable W
IPv6Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
Type R
ULAEnable W
Reset W
IPv6AddressNumberOfEntries R
IPv6PrefixNumberOfEntries R

PPPInterface:1 Profile

This table defines the PPPInterface:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.PPP. P
InterfaceNumberOfEntries R
Device.PPP.Interface.{i}. C
Enable W
Status R
Alias W
Name R
LastChange R
LowerLayers W
Reset W
Username W
Password W
ConnectionTrigger W
Device.PPP.Interface.{i}.PPPoE. P
SessionID R
ACName W
ServiceName W
Device.PPP.Interface.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

PPPInterface:2 Profile

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

Name Requirement
Device.PPP. P
SupportedNCPs R
Device.PPP.Interface.{i}. C
LocalInterfaceIdentifier R
RemoteInterfaceIdentifier R

DHCPv4Client:1 Profile

This table defines the DHCPv4Client:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.DHCPv4. P
ClientNumberOfEntries R
Device.DHCPv4.Client.{i}. C
Enable W
Interface W
Status R
Renew W
IPAddress R
SubnetMask R
IPRouters R
DNSServers R
LeaseTimeRemaining R
DHCPServer R
SentOptionNumberOfEntries R
ReqOptionNumberOfEntries R
Enable W
Tag W
Value W
Enable W
Order W
Tag W
Value R

DHCPv6Client:1 Profile

This table defines the DHCPv6Client:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.2.

Name Requirement
Device.DHCPv6. P
ClientNumberOfEntries R
Device.DHCPv6.Client.{i}. C
Enable W
Status R
Interface W
DUID R
RequestAddresses W
RequestPrefixes W
RapidCommit W
Renew W
SuggestedT1 W
SuggestedT2 W
SupportedOptions R
RequestedOptions W
SentOptionNumberOfEntries R
ReceivedOptionNumberOfEntries R
Device.DHCPv6.Client.{i}.SentOption.{i}. C
Enable W
Tag W
Value W
Device.DHCPv6.Client.{i}.ReceivedOption.{i}. P
Tag R
Value R

DHCPv6ClientServerIdentity:1 Profile

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

Name Requirement
Device.DHCPv6.Client.{i}. C
ServerNumberOfEntries R
Device.DHCPv6.Client.{i}.Server.{i}. P
SourceAddress R
DUID R
InformationRefreshTime R
Device.DHCPv6.Client.{i}.ReceivedOption.{i}. P
Server R

MQTTClientExtended:1 Profile

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

Name Requirement
Device.MQTT.Client.{i}. P
Name W
ClientID W
Username W
Password W
TransportProtocol W
MessageRetryTime W
ConnectRetryTime W
ForceReconnect W
WillEnable W
WillTopic W
WillValue W
WillQoS W
WillRetain W
Device.MQTT.Client.{i}.Stats. P
LastPublishMessageSent R
LastPublishMessageReceived R
PublishSent R
PublishReceived R
SubscribeSent R
UnSubscribeSent R
PublishErrors R

HPNAQoS:1 Profile

This table defines the HPNAQoS:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.0.

Name Requirement
Device.HPNA.Interface.{i}.QoS. P
FlowSpecNumberOfEntries R
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. C
FlowType W
Priority W
Latency W
Jitter W
PacketSize W
MinRate W
AvgRate W
MaxRate W
PER W
Timeout W
Device.HPNA.Diagnostics.PerformanceMonitoring.Channels.Channel.{i}. P
FlowSpec R

HeartbeatPolicy:1 Profile

This table defines the HeartbeatPolicy:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.12.

Name Requirement
Device.ManagementServer.HeartbeatPolicy. P
Enable W
ReportingInterval W
InitiationTime W

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:30:47 UTC.
report.py –output –format markdown tr-181-2-12-0-cwmp.xml

Table of Contents